Hyperv: moving session transport type config from string to boolean for enhanced mode aka HvSocker

plugins/providers/hyperv/action/configure.rb

@@ -97,9 +97,9 @@ module VagrantPlugins
               env[:machine].provider_config.vm_integration_services)
           end
 
-          if !env[:machine].provider_config.enhanced_session_transport_type.empty?
+          if env[:machine].provider_config.enable_enhanced_session_mode
             env[:ui].detail("Setting VM Enhanced session transport type")
-            env[:machine].provider.driver.set_enhanced_session_transport_type(env[:machine].provider_config.enhanced_session_transport_type)
+            env[:machine].provider.driver.set_enhanced_session_transport_type("HvSocket")
           end
 
           @app.call(env)

plugins/providers/hyperv/config.rb

@@ -48,8 +48,8 @@ module VagrantPlugins
       attr_accessor :enable_virtualization_extensions
       # @return [Hash] Options for VMServiceIntegration
       attr_accessor :vm_integration_services
-      # @return [String] Set Enhanced session transport type
-      attr_accessor :enhanced_session_transport_type
+      # @return [Boolean] Enable Enhanced session mode
+      attr_accessor :enable_enhanced_session_mode
 
       def initialize
         @ip_address_timeout = UNSET_VALUE
@@ -67,7 +67,7 @@ module VagrantPlugins
         @enable_automatic_checkpoints = UNSET_VALUE
         @enable_checkpoints = UNSET_VALUE
         @vm_integration_services = {}
-        @enhanced_session_transport_type = UNSET_VALUE
+        @enable_enhanced_session_mode = UNSET_VALUE
       end
 
       def finalize!
@@ -106,7 +106,7 @@ module VagrantPlugins
         # If automatic checkpoints are enabled, checkpoints will automatically be enabled
         @enable_checkpoints ||= @enable_automatic_checkpoints
 
-        @enhanced_session_transport_type = nil if @enhanced_session_transport_type == UNSET_VALUE
+        @enable_enhanced_session_mode = false if @enable_enhanced_session_mode == UNSET_VALUE
       end
 
       def validate(machine)

test/unit/plugins/providers/hyperv/action/configure_test.rb

@@ -29,10 +29,11 @@ describe VagrantPlugins::HyperV::Action::Configure do
       enable_automatic_checkpoints: true,
       enable_virtualization_extensions: false,
       vm_integration_services: vm_integration_services,
-      enhanced_session_transport_type: "HvSocket"
+      enable_enhanced_session_mode: enable_enhanced_session_mode
     )
   }
   let(:vm_integration_services){ {} }
+  let(:enable_enhanced_session_mode){ false }
 
   let(:subject){ described_class.new(app, env) }
 
@@ -117,6 +118,22 @@ describe VagrantPlugins::HyperV::Action::Configure do
     end
   end
 
+  context "without enhanced session transport type" do
+    it "should not call the driver to set enhanced session transport type" do
+      expect(driver).not_to receive(:set_enhanced_session_transport_type)
+      subject.call(env)
+    end
+  end
+
+  context "with enhanced session transport type" do    
+    let(:enable_enhanced_session_mode) { true }
+
+    it "should call the driver to set enhanced session transport type" do
+      expect(driver).to receive(:set_enhanced_session_transport_type)
+      subject.call(env)
+    end
+  end
+
   context "without available switches" do
     let(:switches){ [] }
 

test/unit/plugins/providers/hyperv/config_test.rb

@@ -241,4 +241,18 @@ describe VagrantPlugins::HyperV::Config do
       expect(result["Hyper-V"]).not_to be_empty
     end
   end
+  
+
+  describe "#enable_enhanced_session_mode" do
+    it "is false by default" do
+      subject.finalize!
+      expect(subject.enable_enhanced_session_mode).to eq(false)
+    end
+
+    it "can be set" do
+      subject.enable_enhanced_session_mode = true
+      subject.finalize!
+      expect(subject.enable_enhanced_session_mode).to eq(true)
+    end
+  end
 end

website/source/docs/hyperv/configuration.html.md

@@ -19,7 +19,7 @@ you may set. A complete reference is shown below:
 * `enable_virtualization_extensions` (boolean) - Enable virtualization extensions for the virtual CPUs. Default: false
 * `enable_checkpoints` (boolean) Enable checkpoints of the VM. Default: false
 * `enable_automatic_checkpoints` (boolean) Enable automatic checkpoints of the VM. Default: false
-* `enhanced_session_transport_type` (VMBus, HvSocket) - Enhanced session transport type for the VM. Default: Hyper-V Default (currently VMBus).
+* `enable_enhanced_session_mode` (boolean) - Enable enhanced session transport type for the VM. Default: false
 * `ip_address_timeout` (integer) - Number of seconds to wait for the VM to report an IP address. Default: 120.
 * `linked_clone` (boolean) - Use differencing disk instead of cloning entire VHD. Default: false
 * `mac` (string) - MAC address for the guest network interface