kitchen-vagrant 0.17.0.beta.2 → 0.17.0.beta.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 94df56b1e97663dab0a57aa0812552ada2bc8900
-  data.tar.gz: fe7c6c58c021e59c06b3a85e28f3074dd9ac1aee
+  metadata.gz: 7ad9a608e086a9198d09b3f11ff112b925c2b1f1
+  data.tar.gz: 2c72bf47c1513c8e85ca0d96464702134275917e
 SHA512:
-  metadata.gz: 4950c2d33adadb78b39ae87189afa41b67225d642089df69e1186a9ca70175593f6cdfc87713a928921973525ddc5f3cc0a144d0b56e946a129cf669a8c2deac
-  data.tar.gz: ee13d4bcd95b387f8d3ca2e9572897ca4e5663d22fcafa77cb1f89b7eb33ebfbeab02ec3b046a7b32717c209b1ff11f7651de9fda42b09fb305f2d0df62457a5
+  metadata.gz: 9c3e8457a349aa2c1544f3ae4cb423a3f1194f1fa933493b156b964e3eca44349c00c67c76b6e519f838ac271618eca764e243ed759d600165aece74c6fa0a06
+  data.tar.gz: 43f71f7c083f9d735f38a3c0c064f69b87f665b299d90315e38aaa2ae411b62636d2b46ac79f750bbcbd57421638c63f3d919ae22d49262a35521f3d363ac8e7

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## 0.17.0.beta.3 / 2015-03-25
+
+* Pull request [#155][]: Use the vagrant-winrm Vagrant plugin to resolve VM IP address. See PR for details. ([@fnichol][])
+
+
 ## 0.17.0.beta.2 / 2015-03-25
 
 * Relax version constraint on Test Kitchen. ([@fnichol][])
@@ -252,6 +257,7 @@ The initial release.
 [#148]: https://github.com/test-kitchen/kitchen-vagrant/issues/148
 [#151]: https://github.com/test-kitchen/kitchen-vagrant/issues/151
 [#154]: https://github.com/test-kitchen/kitchen-vagrant/issues/154
+[#155]: https://github.com/test-kitchen/kitchen-vagrant/issues/155
 [@Annih]: https://github.com/Annih
 [@Igorshp]: https://github.com/Igorshp
 [@RobertRehberg]: https://github.com/RobertRehberg

data/README.md

@@ -29,6 +29,10 @@ consider the [vagrant-wrapper][vagrant_wrapper] gem which helps manage both
 styles of Vagrant installations
 ([background details][vagrant_wrapper_background]).
 
+If you are creating Windows VMs over a WinRM Transport, then the
+[vagrant-winrm][vagrant_winrm] Vagrant plugin must be installed. As a
+consequence, the minimum version of Vagrant required is 1.6 or higher.
+
 ### <a name="dependencies-virtualization"></a> Virtualbox and/or VMware Fusion/Workstation
 
 Currently this driver supports VirtualBox and VMware Fusion/Workstation.
@@ -442,6 +446,7 @@ Apache 2.0 (see [LICENSE][license])
 [vagrant_config_vmware]:    http://docs.vagrantup.com/v2/vmware/configuration.html
 [vagrant_providers]:        http://docs.vagrantup.com/v2/providers/index.html
 [vagrant_versioning]:       https://docs.vagrantup.com/v2/boxes/versioning.html
+[vagrant_winrm]:            https://github.com/criteo/vagrant-winrm
 [vagrant_wrapper]:          https://github.com/org-binbab/gem-vagrant-wrapper
 [vagrant_wrapper_background]: https://github.com/org-binbab/gem-vagrant-wrapper#background---aka-the-vagrant-gem-enigma
 [vmware_plugin]:            http://www.vagrantup.com/vmware

data/lib/kitchen/driver/vagrant.rb

@@ -48,10 +48,6 @@ module Kitchen
 
       default_config :network, []
 
-      default_config :password do |driver|
-        "vagrant" if driver.winrm_transport?
-      end
-
       default_config :pre_create_command, nil
 
       default_config :provision, false
@@ -64,10 +60,6 @@ module Kitchen
 
       default_config :synced_folders, []
 
-      default_config :username do |driver|
-        "vagrant" if driver.winrm_transport?
-      end
-
       default_config :vagrantfile_erb,
         File.join(File.dirname(__FILE__), "../../../templates/Vagrantfile.erb")
       expand_path_for :vagrantfile_erb
@@ -176,6 +168,18 @@ module Kitchen
       WEBSITE = "http://www.vagrantup.com/downloads.html".freeze
       MIN_VER = "1.1.0".freeze
 
+      class << self
+
+        # @return [true,false] whether or not the vagrant-winrm plugin is
+        #   installed
+        # @api private
+        attr_accessor :winrm_plugin_passed
+
+        # @return [String] the version of Vagrant installed on the workstation
+        # @api private
+        attr_accessor :vagrant_version
+      end
+
       # Retuns a list of Vagrant base boxes produced by the Bento project
       # (https://github.com/chef/bento).
       #
@@ -254,6 +258,19 @@ module Kitchen
         end
       end
 
+      # Loads any required third party Ruby libraries or runs any shell out
+      # commands to prepare the plugin. This method will be called in the
+      # context of the main thread of execution and so does not necessarily
+      # have to be thread safe.
+      #
+      # @raise [ClientError] if any library loading fails or any of the
+      #   dependency requirements cannot be satisfied
+      # @api private
+      def load_needed_dependencies!
+        super
+        verify_winrm_plugin if winrm_transport?
+      end
+
       # Renders the Vagrantfile ERb template.
       #
       # @return [String] the contents for a Vagrantfile
@@ -332,19 +349,14 @@ module Kitchen
       # @param state [Hash] mutable instance state
       # @api private
       def update_state(state)
-        hash = vagrant_ssh_config
+        hash = winrm_transport? ? vagrant_config(:winrm) : vagrant_config(:ssh)
 
         state[:hostname] = hash["HostName"]
-
-        if winrm_transport?
-          state[:username] = config[:username]
-          state[:password] = config[:password]
-        else
-          state[:username] = hash["User"]
-          state[:ssh_key] = hash["IdentityFile"]
-          state[:port] = hash["Port"]
-          state[:proxy_command] = hash["ProxyCommand"] if hash["ProxyCommand"]
-        end
+        state[:port] = hash["Port"]
+        state[:username] = hash["User"]
+        state[:password] = hash["Password"] if hash["Password"]
+        state[:ssh_key] = hash["IdentityFile"] if hash["IdentityFile"]
+        state[:proxy_command] = hash["ProxyCommand"] if hash["ProxyCommand"]
       end
 
       # @return [String] full local path to the directory containing the
@@ -357,11 +369,13 @@ module Kitchen
         )
       end
 
+      # @param type [Symbol] either `:ssh` or `:winrm`
       # @return [Hash] key/value pairs resulting from parsing a
-      #   `vagrant ssh-config` local command invocation
+      #   `vagrant ssh-config` or `vagrant winrm-config` local command
+      #   invocation
       # @api private
-      def vagrant_ssh_config
-        lines = run_silently("vagrant ssh-config").split("\n").map do |line|
+      def vagrant_config(type)
+        lines = run_silently("vagrant #{type}-config").split("\n").map do |line|
           tokens = line.strip.partition(" ")
           [tokens.first, tokens.last.gsub(/"/, "")]
         end
@@ -372,12 +386,43 @@ module Kitchen
       # @raise [UserError] if the `vagrant` command can not be found locally
       # @api private
       def vagrant_version
-        @version ||= run_silently("vagrant --version", :cwd => Dir.pwd).
-          chomp.split(" ").last
+        self.class.vagrant_version ||= run_silently(
+          "vagrant --version", :cwd => Dir.pwd).chomp.split(" ").last
       rescue Errno::ENOENT
         raise UserError, "Vagrant #{MIN_VER} or higher is not installed." \
           " Please download a package from #{WEBSITE}."
       end
+
+      # Verify that the vagrant-winrm plugin is installed and a suitable
+      #   version of Vagrant is installed
+      #
+      # @api private
+      def verify_winrm_plugin
+        if Gem::Version.new(vagrant_version) < Gem::Version.new("1.6")
+          raise UserError, "Detected an old version of Vagrant " \
+            "(#{vagrant_version}) that cannot support the vagrant-winrm " \
+            "Vagrant plugin." \
+            " Please upgrade to version 1.6 or higher from #{WEBSITE}."
+        end
+
+        if !winrm_plugin_installed?
+          raise UserError, "WinRM Transport requires the vagrant-winrm " \
+            "Vagrant plugin to properly communicate with this Vagrant VM. " \
+            "Please install this plugin with: " \
+            "`vagrant plugin install vagrant-winrm' and try again."
+        end
+      end
+
+      # @return [true,false] whether or not the vagrant-winrm plugin is
+      #   installed
+      # @api private
+      def winrm_plugin_installed?
+        return true if self.class.winrm_plugin_passed
+
+        self.class.winrm_plugin_passed = run_silently(
+          "vagrant plugin list", :cwd => Dir.pwd).
+          split("\n").find { |line| line =~ /^vagrant-winrm\s+/ }
+      end
     end
   end
 end

data/lib/kitchen/driver/vagrant_version.rb

@@ -21,6 +21,6 @@ module Kitchen
   module Driver
 
     # Version string for Vagrant Kitchen driver
-    VAGRANT_VERSION = "0.17.0.beta.2"
+    VAGRANT_VERSION = "0.17.0.beta.3"
   end
 end

data/spec/kitchen/driver/vagrant_spec.rb

@@ -63,6 +63,11 @@ describe Kitchen::Driver::Vagrant do
 
   before { stub_const("ENV", env) }
 
+  after do
+    driver_object.class.send(:winrm_plugin_passed=, nil)
+    driver_object.class.send(:vagrant_version=, nil)
+  end
+
   describe "configuration" do
 
     context "for known bento platform names" do
@@ -328,32 +333,6 @@ describe Kitchen::Driver::Vagrant do
         expect(driver[:vm_hostname]).to eq("this-is-a--k")
       end
     end
-
-    context "for non-WinRM-based transports" do
-
-      before { allow(transport).to receive(:name).and_return("Coolness") }
-
-      it "sets :username to nil by default" do
-        expect(driver[:username]).to eq(nil)
-      end
-
-      it "sets :password to nil by default" do
-        expect(driver[:password]).to eq(nil)
-      end
-    end
-
-    context "for WinRM-based transports" do
-
-      before { allow(transport).to receive(:name).and_return("WinRM") }
-
-      it "sets :username to vagrant by default" do
-        expect(driver[:username]).to eq("vagrant")
-      end
-
-      it "sets :password to vagrant by default" do
-        expect(driver[:password]).to eq("vagrant")
-      end
-    end
   end
 
   describe "#verify_dependencies" do
@@ -373,7 +352,7 @@ describe Kitchen::Driver::Vagrant do
     end
 
     it "raises a UserError for a missing Vagrant command" do
-      allow(driver).to receive(:run_command).
+      allow(driver_object).to receive(:run_command).
         with("vagrant --version", any_args).and_raise(Errno::ENOENT)
 
       expect { driver.verify_dependencies }.to raise_error(
@@ -382,6 +361,69 @@ describe Kitchen::Driver::Vagrant do
     end
   end
 
+  describe "#load_needed_dependencies!" do
+
+    describe "with winrm transport" do
+
+      before { allow(transport).to receive(:name).and_return("WinRM") }
+
+      it "old version of Vagrant raises UserError" do
+        with_vagrant("1.5.0")
+
+        expect { instance }.to raise_error(
+          Kitchen::Error, /Please upgrade to version 1.6 or higher/
+        )
+      end
+
+      it "modern vagrant without plugin installed raises UserError" do
+        with_modern_vagrant
+        allow(driver_object).to receive(:run_command).
+          with("vagrant plugin list", any_args).and_return("nope (1.2.3)")
+
+        expect { instance }.to raise_error(
+          Kitchen::Error, /vagrant plugin install vagrant-winrm/
+        )
+      end
+
+      it "modern vagrant with plugin installed succeeds" do
+        with_modern_vagrant
+        allow(driver_object).to receive(:run_command).
+          with("vagrant plugin list", any_args).
+          and_return("vagrant-winrm (1.2.3)")
+
+        instance
+      end
+    end
+
+    describe "without winrm transport" do
+
+      before { allow(transport).to receive(:name).and_return("Anything") }
+
+      it "old version of Vagrant succeeds" do
+        with_vagrant("1.5.0")
+
+        instance
+      end
+
+      it "modern vagrant without plugin installed succeeds" do
+        with_modern_vagrant
+        allow(driver_object).to receive(:run_command).
+          with("vagrant plugin list", any_args).and_return("nope (1.2.3)")
+
+        instance
+      end
+
+      it "modern vagrant with plugin installed succeeds" do
+        with_modern_vagrant
+        allow(driver_object).to receive(:run_command).
+          with("vagrant plugin list", any_args).
+          and_return("vagrant-winrm (1.2.3)")
+
+        instance
+      end
+    end
+  end
+
   describe "#create" do
 
     let(:cmd) { driver.create(state) }
@@ -480,35 +522,40 @@ describe Kitchen::Driver::Vagrant do
 
     describe "for state" do
 
-      let(:output) do
-        <<-OUTPUT.gsub(/^ {10}/, "")
-          Host hehe
-            HostName 192.168.32.64
-            User vagrant
-            Port 2022
-            UserKnownHostsFile /dev/null
-            StrictHostKeyChecking no
-            PasswordAuthentication no
-            IdentityFile /path/to/private_key
-            IdentitiesOnly yes
-            LogLevel FATAL
-        OUTPUT
-      end
+      context "for non-WinRM-based transports" do
 
-      before do
-        allow(driver).to receive(:run_command).
-          with("vagrant ssh-config", any_args).and_return(output)
-      end
+        let(:output) do
+          <<-OUTPUT.gsub(/^ {10}/, "")
+            Host hehe
+              HostName 192.168.32.64
+              User vagrant
+              Port 2022
+              UserKnownHostsFile /dev/null
+              StrictHostKeyChecking no
+              PasswordAuthentication no
+              IdentityFile /path/to/private_key
+              IdentitiesOnly yes
+              LogLevel FATAL
+          OUTPUT
+        end
 
-      it "sets :hostname from ssh-config" do
-        cmd
+        before do
+          allow(transport).to receive(:name).and_return("Coolness")
+          allow(driver).to receive(:run_command).
+            with("vagrant ssh-config", any_args).and_return(output)
+        end
 
-        expect(state).to include(:hostname => "192.168.32.64")
-      end
+        it "sets :hostname from ssh-config" do
+          cmd
 
-      context "for non-WinRM-based transports" do
+          expect(state).to include(:hostname => "192.168.32.64")
+        end
+
+        it "sets :port from ssh-config" do
+          cmd
 
-        before { allow(transport).to receive(:name).and_return("Coolness") }
+          expect(state).to include(:port => "2022")
+        end
 
         it "sets :username from ssh-config" do
           cmd
@@ -516,16 +563,23 @@ describe Kitchen::Driver::Vagrant do
           expect(state).to include(:username => "vagrant")
         end
 
-        it "sets :ssh_key from ssh-config" do
+        it "does not set :password by default" do
           cmd
 
-          expect(state).to include(:ssh_key => "/path/to/private_key")
+          expect(state.keys).to_not include(:password)
         end
 
-        it "sets :port from ssh-config" do
+        it "sets :password if Password is in ssh-config" do
+          output.concat("  Password yep\n")
           cmd
 
-          expect(state).to include(:port => "2022")
+          expect(state).to include(:password => "yep")
+        end
+
+        it "sets :ssh_key from ssh-config" do
+          cmd
+
+          expect(state).to include(:ssh_key => "/path/to/private_key")
         end
 
         it "does not set :proxy_command by default" do
@@ -544,20 +598,44 @@ describe Kitchen::Driver::Vagrant do
 
       context "for WinRM-based transports" do
 
-        before { allow(transport).to receive(:name).and_return("WinRM") }
+        let(:output) do
+          <<-OUTPUT.gsub(/^ {10}/, "")
+            Host hehe
+              HostName 192.168.32.64
+              User vagrant
+              Password yep
+              Port 9999
+          OUTPUT
+        end
 
-        it "sets :username from config" do
-          config[:username] = "winuser"
+        before do
+          allow(transport).to receive(:name).and_return("WinRM")
+          allow(driver).to receive(:run_command).
+            with("vagrant winrm-config", any_args).and_return(output)
+        end
+
+        it "sets :hostname from winrm-config" do
           cmd
 
-          expect(state).to include(:username => "winuser")
+          expect(state).to include(:hostname => "192.168.32.64")
         end
 
-        it "sets :password from config" do
-          config[:password] = "mysecret"
+        it "sets :port from winrm-config" do
           cmd
 
-          expect(state).to include(:password => "mysecret")
+          expect(state).to include(:port => "9999")
+        end
+
+        it "sets :username from winrm-config" do
+          cmd
+
+          expect(state).to include(:username => "vagrant")
+        end
+
+        it "sets :password from winrm-config" do
+          cmd
+
+          expect(state).to include(:password => "yep")
         end
       end
     end
@@ -1226,13 +1304,16 @@ describe Kitchen::Driver::Vagrant do
   end
 
   def with_modern_vagrant
-    allow(driver).to receive(:run_command).
-      with("vagrant --version", any_args).and_return("Vagrant 1.7.2")
+    with_vagrant("1.7.2")
   end
 
   def with_unsupported_vagrant
-    allow(driver).to receive(:run_command).
-      with("vagrant --version", any_args).and_return("Vagrant 1.0.5")
+    with_vagrant("1.0.5")
+  end
+
+  def with_vagrant(version)
+    allow(driver_object).to receive(:run_command).
+      with("vagrant --version", any_args).and_return("Vagrant #{version}")
   end
 
   def regexify(str, line = :whole_line)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kitchen-vagrant
 version: !ruby/object:Gem::Version
-  version: 0.17.0.beta.2
+  version: 0.17.0.beta.3
 platform: ruby
 authors:
 - Fletcher Nichol
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-25 00:00:00.000000000 Z
+date: 2015-03-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: test-kitchen