vagrant-windows-hyperv 1.0.2 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5c543d48b0bf549e9a16af50a1220ab9772d56bc
-  data.tar.gz: 49b974b06708790c44b75fe1ea0f4e0e17b94746
+  metadata.gz: 3ec3d21bd91cb656dd09945f257732260efef0eb
+  data.tar.gz: c82d9db8c20462cbd51aac9344c997b1dc27bd06
 SHA512:
-  metadata.gz: 7dc2347aa090830468f2c728cb6eb829d92082bdcde0e3b988905234b2fbf0ed1b41c051e14c3dbe35be7c87278d113f3f5338500cdcd332f7eb2916bc72493e
-  data.tar.gz: 6fea9e4d12c07edf17c55b759481f4d62dbb1960973b2872000ac18184da0278bdb8750c9368b01b63ecc3bed737524c316ffe913e20a48873fe13caf0221aaf
+  metadata.gz: 8a7437d5ef7f8d44cb1dbf11e0cb761936cc663379e3dc17b0e5753e2eaacad80a29c89aaf0e6c123d779236faf33fc0ef073c81d254267dd38cd94bf229f3a3
+  data.tar.gz: 24e275ff6272b99b6f34f27b88277230963e9f40a8c6e76591e269423d389f7f079ba679228531c1c1713e41d0130258bc5082e748d5515380a15ffcbdfc3e02

data/CHANGELOG.md

@@ -0,0 +1,34 @@
+## 1.0.3 (13 May 2014)
+
+FEATURES
+
+#### Customization for Virtual Switch
+  - Add customization for adding virtual switch. User can choose either External or
+    Internal switch which will be attached to the VM on `vagrant up` or `vagrant reload`
+    - **NOTE:** Vagrant works best with External switch, if you are using an Internal switch
+    make sure the switch is properly configured for vagrant to communicate with the VM and
+    the VM back to the host.
+    - Example for configuration
+      NOTE:
+      If the adapter part if left blank, a list of available adapters will be displayed
+      and the desired adapter can be selected.
+
+      ```ruby
+      config.vm.provider "hyperv" do |hv|
+        hv.customize  ["virtual_switch", { type: "External", name: "External Switch", :adapter => "Ethernet" }]
+      end
+      ```
+
+IMPROVEMENTS
+
+  - Better error messages for PowerShell communication fails.
+  - Better exception handling for PowerShell sessions.
+
+BUGFIXES
+
+  - Fix module path for Puppet manifests.
+  - Fix race condition while enabling Guest Services [GH-61]
+
+## Previous
+
+See git commit

data/README.md

@@ -6,15 +6,15 @@ Hyper-V provider is available by default in Vagrant with version 1.5 and up. Thi
 
 
 ## Installation
-Install Vagrant 1.5 (or higher)
+Install Vagrant 1.5.4
 http://www.vagrantup.com/downloads.html
 
 
-Install plugin like so: 
+Install plugin like so:
 vagrant plugin install vagrant-windows-hyperv
 
 
-## Configuration settings 
+## Configuration settings
 For more information on general configuration settings please visit the Vagrant Documentation.
 http://docs.vagrantup.com/v2/
 
@@ -29,17 +29,17 @@ implementation for the providers.
 You can even specify the following options
 
  :smb_id   Specify a unique share name, with which the network share will be available. By default vagrant will generate a smb_id if not specified.
- 
+
 
 
 
 ```ruby
    # Mounts the host/path to guest/path and will have realtime sync
-    config.vm.synced_folder 'C:/test_sync_2', "C:/Users/vagrant/test_sync_2" 
+    config.vm.synced_folder 'C:/test_sync_2', "C:/Users/vagrant/test_sync_2"
 
 ```
 ### VM Type
-* Set the VM guest type 
+* Set the VM guest type
 
 ```ruby
 config.vm.guest = :windows
@@ -57,11 +57,22 @@ end
 * A new command vagrant rdp is introduced to connect to the Windows VM
 ` vagrant rdp `
 
-
-### Provision Command
-* Provision command works for Vagrant hyper-v with this plugin installed
-` vagrant provision `
-
+### Customization
+* Add customization for adding virtual switch. User can choose either External or
+  Internal switch which will be attached to the VM on `vagrant up` or `vagrant reload`
+  - **NOTE:** Vagrant works best with External switch, if you are using an Internal switch
+  make sure the switch is properly configured for vagrant to communicate with the VM and
+  the VM back to the host.
+  - Example for configuration
+
+    **NOTE:** If the adapter part if left blank, a list of available adapters will be displayed
+    and the desired adapter can be selected.
+
+    ```ruby
+    config.vm.provider "hyperv" do |hv|
+      hv.customize  ["virtual_switch", { type: "External", name: "External Switch", :adapter => "Ethernet" }]
+    end
+    ```
 
 ## Troubleshooting
 

data/lib/vagrant-windows-hyperv.rb

@@ -25,8 +25,11 @@ module VagrantPlugins
     # Monkey Patch the core Hyper-V vagrant with the following
     require monkey_patch.join("plugins/synced_folders/smb/synced_folders")
     require monkey_patch.join("action/provision")
+    require monkey_patch.join("action/import")
     require monkey_patch.join("machine")
-    require monkey_patch.join("util/powershell")
+    require monkey_patch.join("config")
+    require monkey_patch.join("action")
+    require monkey_patch.join("driver")
 
     # This returns the path to the source of this plugin.
     #

data/lib/vagrant-windows-hyperv/action.rb

@@ -52,25 +52,6 @@ module VagrantPlugins
         end
       end
 
-      def self.action_provision
-        Vagrant::Action::Builder.new.tap do |b|
-          b.use ConfigValidate
-          b.use Call, IsState, :not_created do |env1, b1|
-            if env1[:result]
-              b1.use Message, I18n.t("vagrant_hyperv.message_not_created")
-              next
-            end
-            b1.use Call, IsState, :running do |env2, b2|
-              if !env2[:result]
-                b2.use Message, I18n.t("vagrant_hyperv.message_not_running")
-              else
-                b2.use Provision
-              end
-            end
-          end
-        end
-      end
-
       # The autoload farm
       action_root = Pathname.new(File.expand_path("../action", __FILE__))
       autoload :Export, action_root.join("export")

data/lib/vagrant-windows-hyperv/communication/powershell.rb

@@ -20,10 +20,14 @@ module VagrantPlugins
           # In this case we can try any remote PowerShell commands to see if
           # further vagrant can be carried out using this communication
           if !@winrm_status
-            status = false
+            @winrm_status = false
             response = @machine.provider.driver.check_winrm
-            @winrm_status = response["message"] == "Running"
-            raise Errors::WinRMNotReady if !@winrm_status
+            message = nil
+            if response && response["message"]
+              message = response["message"]
+              @winrm_status = message == "Running"
+            end
+            raise Errors::WinRMNotReady, message: message if !@winrm_status
           end
           @winrm_status
         end

data/lib/vagrant-windows-hyperv/errors.rb

@@ -26,6 +26,26 @@ module VagrantPlugins
         error_key(:win_rm_not_available)
       end
 
+      class NoNetworkAdapter < VagrantHyperVError
+        error_key(:no_network_adapter)
+      end
+
+      class NoSwitches < VagrantHyperVError
+        error_key(:no_switches)
+      end
+
+      class NetworkDown < VagrantHyperVError
+        error_key(:network_down)
+      end
+
+      class NoSwitchFound < VagrantHyperVError
+        error_key(:switch_not_found)
+      end
+
+      class ExternalSwitchExist < VagrantHyperVError
+        error_key(:external_switch_exist)
+      end
+
     end
   end
 end

data/lib/vagrant-windows-hyperv/monkey_patch/action.rb

@@ -0,0 +1,45 @@
+#-------------------------------------------------------------------------
+# Copyright (c) Microsoft Open Technologies, Inc.
+# All Rights Reserved. Licensed under the Apache 2.0 License.
+#--------------------------------------------------------------------------
+
+module VagrantPlugins
+  module HyperV
+    module Action
+
+      def self.action_up
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use CheckEnabled
+          b.use HandleBox
+          b.use ConfigValidate
+          b.use Call, IsState, :not_created do |env1, b1|
+            if env1[:result]
+              b1.use Import
+            end
+            b1.use Customize, "pre-boot"
+            b1.use action_start
+          end
+        end
+      end
+
+      def self.action_reload
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use ConfigValidate
+          b.use Call, IsState, :not_created do |env, b2|
+            if env[:result]
+              b2.use Message, I18n.t("vagrant_hyperv.message_not_created")
+              next
+            end
+
+            b2.use action_halt
+            b2.use Customize, "pre-boot"
+            b2.use action_start
+          end
+        end
+      end
+      action_root = Pathname.new(File.expand_path("../action", __FILE__))
+      autoload :Customize, action_root.join("customize")
+
+    end
+  end
+end

data/lib/vagrant-windows-hyperv/monkey_patch/action/customize.rb

@@ -0,0 +1,167 @@
+#-------------------------------------------------------------------------
+# Copyright (c) Microsoft Open Technologies, Inc.
+# All Rights Reserved. Licensed under the MIT License.
+#--------------------------------------------------------------------------
+
+require "log4r"
+
+module VagrantPlugins
+  module HyperV
+    module Action
+      class Customize
+
+        def initialize(app, env, event)
+          @app    = app
+          @logger = Log4r::Logger.new("vagrant::hyperv::connection")
+          @event  = event
+        end
+
+        def call(env)
+          customizations = []
+          @env = env
+          # FIXME:
+          # Currently we are unable to set a default value for the customizations
+          # to the vagrant core Config initialization. This check should be removed
+          # when this code becomes a part of vagrant core.
+          custom_config = env[:machine].provider_config.customizations
+          if custom_config
+            custom_config.each do |event, command|
+              if event == @event
+                customizations << command
+              end
+            end
+          end
+
+          if !customizations.empty?
+            env[:ui].info I18n.t("vagrant.actions.vm.customize.running", event: @event)
+            customizations.each do |query|
+              command = query[0]
+              params = query[1]
+              if self.respond_to?("custom_action_#{command}")
+                self.send("custom_action_#{command}", params)
+              end
+            end
+          end
+
+          validate_virtual_switch
+          @app.call(env)
+        end
+
+        def custom_action_virtual_switch(params)
+          options = { vm_id: @env[:machine].id,
+                      type: (params[:type] || "").downcase  || "external",
+                      name: params[:name],
+                      adapter: (params[:bridge] || "").downcase
+                    }
+
+          if options[:type] == "private"
+            @env[:ui].detail I18n.t("vagrant_win_hyperv.private_switch_not_allowed")
+            return
+          end
+
+          response = @env[:machine].provider.driver.switch_exist({ name: options[:name],
+                                              type: options[:type]})
+
+          if options[:type] == "internal"
+            @env[:ui].detail(" ")
+            @env[:ui].detail I18n.t("vagrant_win_hyperv.internal_switch_warn")
+            @env[:ui].detail(" ")
+            if response["message"] == "switch exist"
+              add_swith_to_vm(options)
+              return
+            else
+              raise VagrantPlugins::VagrantHyperV::Errors::NoSwitchFound,
+                type: options[:type], name: options[:name]
+            end
+          end
+
+          if options[:type] == "external"
+            if response["message"] == "switch exist"
+              if (response["switch_name"].casecmp(options[:name]) == 0)
+                add_swith_to_vm(options)
+                return
+              else
+                raise VagrantPlugins::VagrantHyperV::Errors::ExternalSwitchExist, name: response["switch_name"]
+              end
+            end
+
+            adapters = @env[:machine].provider.driver.list_net_adapters
+            available_adapters = adapters.map { |a| a["Name"].downcase }
+
+            unless available_adapters.include? (options[:adapter])
+              @env[:ui].detail I18n.t("vagrant_win_hyperv.net_adapter_warn")
+              selected_adapter = choose_option_from(adapters, "adapter")
+              options[:adapter] = selected_adapter["Name"]
+            end
+
+            @env[:ui].info I18n.t("vagrant_win_hyperv.creating_switch",
+              { type: options[:type], name: options[:name] })
+            response = @env[:machine].provider.driver.create_network_switch(options)
+            case response["message"]
+              when "Network down"
+                # TODO:  Create a error class in core vagrant when merged.
+                raise VagrantPlugins::VagrantHyperV::Errors::NetworkDown
+              when "Success"
+                add_swith_to_vm(options)
+            end
+          end
+        end
+
+        def add_swith_to_vm(options)
+          current_vm_switch = @env[:machine].provider.driver.find_vm_switch_name
+          if current_vm_switch["network_adapter"].nil?
+            raise VagrantPlugins::VagrantHyperV::Errors::NoNetworkAdapter
+          end
+          @env[:machine].provider.driver.add_swith_to_vm(options)
+        end
+
+        def validate_virtual_switch
+          @env[:ui].info "Validating Virtual Switch"
+          current_vm_switch = @env[:machine].provider.driver.find_vm_switch_name
+
+          if current_vm_switch["switch_name"].nil?
+            switches = @env[:machine].provider.driver.execute("get_switches.ps1", {})
+            raise VagrantPlugins::VagrantHyperV::Errors::NoSwitches if switches.empty?
+
+            switch = choose_option_from(switches, "switch")
+            switch_type = nil
+            case switch["SwitchType"]
+            when 1
+              switch_type = "Internal"
+            when 2
+              switch_type = "External"
+            end
+
+            options = { vm_id: @env[:machine].id,
+                        type: switch_type.downcase,
+                        name: switch["Name"]
+                      }
+            @env[:ui].info I18n.t("vagrant_win_hyperv.add_switch_to_vm",
+              { type: options[:type], name: options[:name] })
+
+            add_swith_to_vm(options)
+          end
+        end
+
+        private
+        def choose_option_from(options, key)
+          @env[:ui].detail(I18n.t("vagrant_win_hyperv.choose_#{key}") + "\n ")
+          options.each_index do |i|
+            option = options[i]
+            @env[:ui].detail("#{i+1}) #{option["Name"]}")
+          end
+          @env[:ui].detail(" ")
+
+          selected = nil
+          while !selected
+            selected = @env[:ui].ask("What #{key} would you like to use? ")
+            next if !selected
+            selected = selected.to_i - 1
+            selected = nil if selected < 0 || selected >= options.length
+          end
+          options[selected]
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-windows-hyperv/monkey_patch/action/import.rb

@@ -0,0 +1,72 @@
+#-------------------------------------------------------------------------
+# Copyright (c) Microsoft Open Technologies, Inc.
+# All Rights Reserved. Licensed under the Apache 2.0 License.
+#--------------------------------------------------------------------------
+
+require "fileutils"
+
+require "log4r"
+
+module VagrantPlugins
+  module HyperV
+    module Action
+      class Import
+        def initialize(app, env)
+          @app    = app
+          @logger = Log4r::Logger.new("vagrant::hyperv::import")
+        end
+
+        def call(env)
+          vm_dir = env[:machine].box.directory.join("Virtual Machines")
+          hd_dir = env[:machine].box.directory.join("Virtual Hard Disks")
+
+          if !vm_dir.directory? || !hd_dir.directory?
+            raise Errors::BoxInvalid
+          end
+
+          config_path = nil
+          vm_dir.each_child do |f|
+            if f.extname.downcase == ".xml"
+              config_path = f
+              break
+            end
+          end
+
+          vhdx_path = nil
+          hd_dir.each_child do |f|
+            if f.extname.downcase == ".vhdx"
+              vhdx_path = f
+              break
+            end
+          end
+
+          if !config_path || !vhdx_path
+            raise Errors::BoxInvalid
+          end
+
+          env[:ui].output("Importing a Hyper-V instance")
+
+          env[:ui].detail("Cloning virtual hard drive...")
+          source_path = vhdx_path.to_s
+          dest_path   = env[:machine].data_dir.join("disk.vhdx").to_s
+          FileUtils.cp(source_path, dest_path)
+          vhdx_path = dest_path
+
+          # We have to normalize the paths to be Windows paths since
+          # we're executing PowerShell.
+          options = {
+            vm_xml_config:  config_path.to_s.gsub("/", "\\"),
+            vhdx_path:      vhdx_path.to_s.gsub("/", "\\")
+          }
+
+          env[:ui].detail("Creating and registering the VM...")
+          server = env[:machine].provider.driver.import(options)
+          env[:ui].detail("Successfully imported a VM with name: #{server['name']}")
+          env[:machine].id = server["id"]
+          @app.call(env)
+        end
+
+      end
+    end
+  end
+end