feat: add websocket graphics config (#1672)

This adds websocket functionality for VNC. The websocket attribute may 
be used to specify the port to listen on (with -1 meaning 
auto-allocation and autoport having no effect due to security reasons).

spec/support/environment_helper.rb

@@ -20,7 +20,7 @@ class EnvironmentHelper
     1024
   end
 
-  %w(cpus cpu_mode loader nvram boot_order machine_type disk_bus disk_device nested volume_cache kernel cmd_line initrd graphics_type graphics_autoport graphics_port graphics_ip graphics_passwd video_type video_vram keymap storage_pool_name disks cdroms floppies driver).each do |name|
+  %w(cpus cpu_mode loader nvram boot_order machine_type disk_bus disk_device nested volume_cache kernel cmd_line initrd graphics_type graphics_autoport graphics_port graphics_websocket graphics_ip graphics_passwd video_type video_vram keymap storage_pool_name disks cdroms floppies driver).each do |name|
     define_method(name.to_sym) do
       nil
     end

spec/unit/action/create_domain_spec.rb

@@ -66,13 +66,15 @@ describe VagrantPlugins::ProviderLibvirt::Action::CreateDomain do
         let(:vagrantfile_providerconfig) do
           <<-EOF
           libvirt.graphics_port = 5900
+          libvirt.graphics_websocket = 5700
           EOF
         end
 
-        it 'should emit the graphics port' do
+        it 'should emit the graphics port and websocket' do
           expect(servers).to receive(:create).and_return(machine)
           expect(volumes).to_not receive(:create) # additional disks only
           expect(ui).to receive(:info).with(' -- Graphics Port:     5900')
+          expect(ui).to receive(:info).with(' -- Graphics Websocket: 5700')
 
           expect(subject.call(env)).to be_nil
         end

spec/unit/action/create_domain_spec/additional_disks_domain.xml

@@ -43,7 +43,7 @@
     </console>
     <input type='mouse' bus='ps2'>
     </input>
-    <graphics type='vnc' port='-1' autoport='yes' listen='127.0.0.1' keymap='en-us'/>
+    <graphics type='vnc' port='-1' autoport='yes' websocket='-1' listen='127.0.0.1' keymap='en-us'/>
     <video>
       <model type='cirrus' vram='16384' heads='1'/>
     </video>

spec/unit/action/create_domain_spec/custom_disk_settings.xml

@@ -37,7 +37,7 @@
     </console>
     <input type='mouse' bus='ps2'>
     </input>
-    <graphics type='vnc' port='-1' autoport='yes' listen='127.0.0.1' keymap='en-us'/>
+    <graphics type='vnc' port='-1' autoport='yes' websocket='-1' listen='127.0.0.1' keymap='en-us'/>
     <video>
       <model type='cirrus' vram='16384' heads='1'/>
     </video>

spec/unit/action/create_domain_spec/default_domain.xml

@@ -37,7 +37,7 @@
     </console>
     <input type='mouse' bus='ps2'>
     </input>
-    <graphics type='vnc' port='-1' autoport='yes' listen='127.0.0.1' keymap='en-us'/>
+    <graphics type='vnc' port='-1' autoport='yes' websocket='-1' listen='127.0.0.1' keymap='en-us'/>
     <video>
       <model type='cirrus' vram='16384' heads='1'/>
     </video>

spec/unit/action/create_domain_spec/sysinfo.xml

@@ -60,7 +60,7 @@
     </console>
     <input type='mouse' bus='ps2'>
     </input>
-    <graphics type='vnc' port='-1' autoport='yes' listen='127.0.0.1' keymap='en-us'/>
+    <graphics type='vnc' port='-1' autoport='yes' websocket='-1' listen='127.0.0.1' keymap='en-us'/>
     <video>
       <model type='cirrus' vram='16384' heads='1'/>
     </video>

spec/unit/action/create_domain_spec/sysinfo_only_required.xml

@@ -43,7 +43,7 @@
     </console>
     <input type='mouse' bus='ps2'>
     </input>
-    <graphics type='vnc' port='-1' autoport='yes' listen='127.0.0.1' keymap='en-us'/>
+    <graphics type='vnc' port='-1' autoport='yes' websocket='-1' listen='127.0.0.1' keymap='en-us'/>
     <video>
       <model type='cirrus' vram='16384' heads='1'/>
     </video>

spec/unit/action/create_domain_spec/two_disk_settings.xml

@@ -43,7 +43,7 @@
     </console>
     <input type='mouse' bus='ps2'>
     </input>
-    <graphics type='vnc' port='-1' autoport='yes' listen='127.0.0.1' keymap='en-us'/>
+    <graphics type='vnc' port='-1' autoport='yes' websocket='-1' listen='127.0.0.1' keymap='en-us'/>
     <video>
       <model type='cirrus' vram='16384' heads='1'/>
     </video>

spec/unit/action/start_domain_spec.rb

@@ -344,7 +344,7 @@ describe VagrantPlugins::ProviderLibvirt::Action::StartDomain do
           expect(libvirt_domain).to receive(:xml_desc).and_return(domain_xml, launched_domain_xml)
           expect(libvirt_domain).to receive(:autostart=)
           expect(domain).to receive(:start)
-          expect(ui).to receive(:info).with(' -- Graphics Port:     5900')
+          expect(ui).to receive(:info).with(' -- Graphics Port:      5900')
 
           expect(subject.call(env)).to be_nil
         end

spec/unit/action/start_domain_spec/clock_timer_removed.xml

@@ -30,7 +30,7 @@
       <target port='0'/>
     </console>
     <input bus='ps2' type='mouse'/>
-    <graphics autoport='yes' keymap='en-us' listen='127.0.0.1' port='-1' type='vnc'/>
+    <graphics autoport='yes' keymap='en-us' listen='127.0.0.1' port='-1' type='vnc' websocket='-1'/>
     <video>
       <model heads='1' type='cirrus' vram='16384'/>
     </video>

spec/unit/action/start_domain_spec/clock_timer_rtc.xml

@@ -30,7 +30,7 @@
       <target port='0'/>
     </console>
     <input bus='ps2' type='mouse'/>
-    <graphics autoport='yes' keymap='en-us' listen='127.0.0.1' port='-1' type='vnc'/>
+    <graphics autoport='yes' keymap='en-us' listen='127.0.0.1' port='-1' type='vnc' websocket='-1'/>
     <video>
       <model heads='1' type='cirrus' vram='16384'/>
     </video>

spec/unit/action/start_domain_spec/clock_timer_rtc_tsc.xml

@@ -31,7 +31,7 @@
       <target port='0'/>
     </console>
     <input bus='ps2' type='mouse'/>
-    <graphics autoport='yes' keymap='en-us' listen='127.0.0.1' port='-1' type='vnc'/>
+    <graphics autoport='yes' keymap='en-us' listen='127.0.0.1' port='-1' type='vnc' websocket='-1'/>
     <video>
       <model heads='1' type='cirrus' vram='16384'/>
     </video>

spec/unit/action/start_domain_spec/default.xml

@@ -28,7 +28,7 @@
       <target port='0'/>
     </console>
     <input bus='ps2' type='mouse'/>
-    <graphics autoport='yes' keymap='en-us' listen='127.0.0.1' port='-1' type='vnc'/>
+    <graphics autoport='yes' keymap='en-us' listen='127.0.0.1' port='-1' type='vnc' websocket='-1'/>
     <video>
       <model heads='1' type='cirrus' vram='16384'/>
     </video>

spec/unit/action/start_domain_spec/default_added_tpm_path.xml

@@ -28,7 +28,7 @@
       <target port='0'/>
     </console>
     <input bus='ps2' type='mouse'/>
-    <graphics autoport='yes' keymap='en-us' listen='127.0.0.1' port='-1' type='vnc'/>
+    <graphics autoport='yes' keymap='en-us' listen='127.0.0.1' port='-1' type='vnc' websocket='-1'/>
     <video>
       <model heads='1' type='cirrus' vram='16384'/>
     </video>

spec/unit/action/start_domain_spec/default_added_tpm_version.xml

@@ -28,7 +28,7 @@
       <target port='0'/>
     </console>
     <input bus='ps2' type='mouse'/>
-    <graphics autoport='yes' keymap='en-us' listen='127.0.0.1' port='-1' type='vnc'/>
+    <graphics autoport='yes' keymap='en-us' listen='127.0.0.1' port='-1' type='vnc' websocket='-1'/>
     <video>
       <model heads='1' type='cirrus' vram='16384'/>
     </video>

spec/unit/action/start_domain_spec/default_with_different_formatting.xml

@@ -29,7 +29,7 @@
       <target port='0'/>
     </console>
     <input bus='ps2' type='mouse'/>
-    <graphics autoport='yes' keymap='en-us' listen='127.0.0.1' port='-1' type='vnc'/>
+    <graphics autoport='yes' keymap='en-us' listen='127.0.0.1' port='-1' type='vnc' websocket='-1'/>
     <video>
       <model heads='1' type='cirrus' vram='16384'/>
     </video>

spec/unit/action/start_domain_spec/existing.xml

@@ -48,7 +48,7 @@
     </console>
     <input type='mouse' bus='ps2'/>
     <input type='keyboard' bus='ps2'/>
-    <graphics type='vnc' port='-1' autoport='yes' listen='127.0.0.1' keymap='en-us'>
+    <graphics type='vnc' port='-1' autoport='yes' listen='127.0.0.1' keymap='en-us' websocket='-1'>
       <listen type='address' address='127.0.0.1'/>
     </graphics>
     <audio id='1' type='none'/>

spec/unit/action/start_domain_spec/existing_added_nvram.xml

@@ -48,7 +48,7 @@
     </console>
     <input bus='ps2' type='mouse'/>
     <input bus='ps2' type='keyboard'/>
-    <graphics autoport='yes' keymap='en-us' listen='127.0.0.1' port='-1' type='vnc'>
+    <graphics autoport='yes' keymap='en-us' listen='127.0.0.1' port='-1' type='vnc' websocket='-1'>
       <listen address='127.0.0.1' type='address'/>
     </graphics>
     <audio id='1' type='none'/>

spec/unit/action/start_domain_spec/existing_reordered.xml

@@ -48,7 +48,7 @@
     </console>
     <input bus='ps2' type='mouse'/>
     <input bus='ps2' type='keyboard'/>
-    <graphics autoport='yes' keymap='en-us' listen='127.0.0.1' port='-1' type='vnc'>
+    <graphics autoport='yes' keymap='en-us' listen='127.0.0.1' port='-1' type='vnc' websocket="-1">
       <listen address='127.0.0.1' type='address'/>
     </graphics>
     <audio id='1' type='none'/>

spec/unit/action/start_domain_spec/nvram_domain_other_setting.xml

@@ -50,7 +50,7 @@
     </console>
     <input bus='ps2' type='mouse'/>
     <input bus='ps2' type='keyboard'/>
-    <graphics autoport='yes' keymap='en-us' listen='127.0.0.1' port='-1' type='vnc'>
+    <graphics autoport='yes' keymap='en-us' listen='127.0.0.1' port='-1' type='vnc' websocket='-1'>
       <listen address='127.0.0.1' type='address'/>
     </graphics>
     <audio id='1' type='none'/>

spec/unit/action/start_domain_spec/nvram_domain_removed.xml

@@ -50,7 +50,7 @@
     </console>
     <input bus='ps2' type='mouse'/>
     <input bus='ps2' type='keyboard'/>
-    <graphics autoport='yes' keymap='en-us' listen='127.0.0.1' port='-1' type='vnc'>
+    <graphics autoport='yes' keymap='en-us' listen='127.0.0.1' port='-1' type='vnc' websocket='-1'>
       <listen address='127.0.0.1' type='address'/>
     </graphics>
     <audio id='1' type='none'/>

spec/unit/config_spec.rb

@@ -660,6 +660,7 @@ describe VagrantPlugins::ProviderLibvirt::Config do
 
         expect(subject.graphics_type).to eq('vnc')
         expect(subject.graphics_port).to eq(-1)
+        expect(subject.graphics_websocket).to eq(-1)
         expect(subject.graphics_ip).to eq('127.0.0.1')
         expect(subject.graphics_autoport).to eq('yes')
         expect(subject.channels).to be_empty
@@ -670,6 +671,7 @@ describe VagrantPlugins::ProviderLibvirt::Config do
         subject.finalize!
 
         expect(subject.graphics_port).to eq(nil)
+        expect(subject.graphics_websocket).to eq(nil)
         expect(subject.graphics_ip).to eq(nil)
         expect(subject.graphics_autoport).to eq(nil)
         expect(subject.channels).to match([a_hash_including({:target_name => 'com.redhat.spice.0'})])

spec/unit/templates/domain_all_settings.xml

@@ -124,7 +124,7 @@
     </channel>
     <input type='mouse' bus='ps2'>
     </input>
-    <graphics type='vnc' port='-1' autoport='yes' listen='127.0.0.1' keymap='en-us'>
+    <graphics type='vnc' port='-1' autoport='yes' websocket='-1' listen='127.0.0.1' keymap='en-us'>
       <gl enable='yes'/>
     </graphics>
     <video>

spec/unit/templates/domain_cpu_mode_passthrough.xml

@@ -33,7 +33,7 @@
     </console>
     <input type='mouse' bus='ps2'>
     </input>
-    <graphics type='vnc' port='-1' autoport='yes' listen='127.0.0.1' keymap='en-us'/>
+    <graphics type='vnc' port='-1' autoport='yes' websocket='-1' listen='127.0.0.1' keymap='en-us'/>
     <video>
       <model type='cirrus' vram='16384' heads='1'/>
     </video>

spec/unit/templates/domain_custom_cpu_model.xml

@@ -31,7 +31,7 @@
     </console>
     <input type='mouse' bus='ps2'>
     </input>
-    <graphics type='vnc' port='-1' autoport='yes' listen='127.0.0.1' keymap='en-us'/>
+    <graphics type='vnc' port='-1' autoport='yes' websocket='-1' listen='127.0.0.1' keymap='en-us'/>
     <video>
       <model type='cirrus' vram='16384' heads='1'/>
     </video>

spec/unit/templates/domain_defaults.xml

@@ -31,7 +31,7 @@
     </console>
     <input type='mouse' bus='ps2'>
     </input>
-    <graphics type='vnc' port='-1' autoport='yes' listen='127.0.0.1' keymap='en-us'/>
+    <graphics type='vnc' port='-1' autoport='yes' websocket='-1' listen='127.0.0.1' keymap='en-us'/>
     <video>
       <model type='cirrus' vram='16384' heads='1'/>
     </video>

spec/unit/templates/domain_scsi_bus_storage.xml

@@ -38,7 +38,7 @@
     </console>
     <input type='mouse' bus='ps2'>
     </input>
-    <graphics type='vnc' port='-1' autoport='yes' listen='127.0.0.1' keymap='en-us'/>
+    <graphics type='vnc' port='-1' autoport='yes' websocket='-1' listen='127.0.0.1' keymap='en-us'/>
     <video>
       <model type='cirrus' vram='16384' heads='1'/>
     </video>

spec/unit/templates/domain_scsi_device_storage.xml

@@ -38,7 +38,7 @@
     </console>
     <input type='mouse' bus='ps2'>
     </input>
-    <graphics type='vnc' port='-1' autoport='yes' listen='127.0.0.1' keymap='en-us'/>
+    <graphics type='vnc' port='-1' autoport='yes' websocket='-1' listen='127.0.0.1' keymap='en-us'/>
     <video>
       <model type='cirrus' vram='16384' heads='1'/>
     </video>

spec/unit/templates/domain_scsi_multiple_controllers_storage.xml

@@ -124,7 +124,7 @@
     </console>
     <input type='mouse' bus='ps2'>
     </input>
-    <graphics type='vnc' port='-1' autoport='yes' listen='127.0.0.1' keymap='en-us'/>
+    <graphics type='vnc' port='-1' autoport='yes' websocket='-1' listen='127.0.0.1' keymap='en-us'/>
     <video>
       <model type='cirrus' vram='16384' heads='1'/>
     </video>

spec/unit/templates/tpm/version_1.2.xml

@@ -31,7 +31,7 @@
     </console>
     <input type='mouse' bus='ps2'>
     </input>
-    <graphics type='vnc' port='-1' autoport='yes' listen='127.0.0.1' keymap='en-us'/>
+    <graphics type='vnc' port='-1' autoport='yes' websocket='-1' listen='127.0.0.1' keymap='en-us'/>
     <video>
       <model type='cirrus' vram='16384' heads='1'/>
     </video>

spec/unit/templates/tpm/version_2.0.xml

@@ -31,7 +31,7 @@
     </console>
     <input type='mouse' bus='ps2'>
     </input>
-    <graphics type='vnc' port='-1' autoport='yes' listen='127.0.0.1' keymap='en-us'/>
+    <graphics type='vnc' port='-1' autoport='yes' websocket='-1' listen='127.0.0.1' keymap='en-us'/>
     <video>
       <model type='cirrus' vram='16384' heads='1'/>
     </video>