test-kitchen 1.9.2 → 1.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 81027eb8109e1f18afe8ab86a7868a6904a85143
-  data.tar.gz: 0d3f2807d8ed919ab730c5ca015751b465cdf97c
+  metadata.gz: 0bc5575233f5ed2155fa31c3bb7465a277263d51
+  data.tar.gz: 52412155a99cc874b7cb7c9293117ea22d900945
 SHA512:
-  metadata.gz: d3814e745b4d08b7cb20b28fa1dad5d1503ee7a49c17cea73c6f96300bb559c37eceba74b415fd7855a13b4514b198587f45bfab9ae9bc5a4e362b4202db91f2
-  data.tar.gz: d904f5626be65776e138aaa4ed7d38365a6d30339e608dd003f2582a9ae2e35c0178103e3bb43b33ed2b971d4ac7ad70d57f54d00ac7141044e21efa9f102c00
+  metadata.gz: d096151c56581d3aeb407c30dfb42f2fd419c608d1f29ddc623bc3e62c025c03b988e1a99b9a26945e6325c5863b5e42b440f356f91703c3fa448084500723da
+  data.tar.gz: b76320028f75a9e9786462437cfbce9354181b9ca49cb6ae79ad0ea4a9cc4e379cfd64e0c8fed7d051b6f703a4b769a341a7ee4f3952806c9e90f83a5d76e613

data/.kitchen.ci.yml

@@ -23,4 +23,4 @@ verifier:
 suites:
   - name: default
     run_list:
-      - recipe[mercurial]
+      - recipe[filezilla]

data/Berksfile

@@ -1,3 +1,3 @@
 source "https://supermarket.chef.io"
 
-cookbook "mercurial"
+cookbook "filezilla"

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Change Log
 
+## [v1.10.0](https://github.com/test-kitchen/test-kitchen/tree/v1.10.0) (2016-06-16)
+[Full Changelog](https://github.com/test-kitchen/test-kitchen/compare/v1.9.2...v1.10.0)
+
+**Implemented enhancements:**
+
+- Retry `Kitchen::Provisioner\#run\_command` after allowed exit codes [\#1055](https://github.com/test-kitchen/test-kitchen/pull/1055) ([smurawski](https://github.com/smurawski))
+- Add fallback support for `policyfile` for compat with the older policyfile\_zero [\#1053](https://github.com/test-kitchen/test-kitchen/pull/1053) ([coderanger](https://github.com/coderanger))
+
 ## [v1.9.2](https://github.com/test-kitchen/test-kitchen/tree/v1.9.2) (2016-06-09)
 [Full Changelog](https://github.com/test-kitchen/test-kitchen/compare/v1.9.1...v1.9.2)
 

data/appveyor.yml

@@ -26,9 +26,11 @@ install:
   - ps: net user /add $env:machine_user $env:machine_pass
   - ps: net localgroup administrators $env:machine_user /add
   - ps: $env:PATH="C:\Ruby$env:ruby_version\bin;$env:PATH"
-  - ps: gem install bundler --quiet --no-ri --no-rdoc
   - ps: Invoke-WebRequest -Uri http://curl.haxx.se/ca/cacert.pem -OutFile c:\projects\test_kitchen\certs.pem
   - ps: Write-Host $env:path
+  - gem update --system || gem update --system || gem update --system
+  - gem install bundler --quiet --no-ri --no-rdoc || gem install bundler --quiet --no-ri --no-rdoc || gem install bundler --quiet --no-ri --no-rdoc
+  - update_rubygems
   - ruby --version
   - gem --version
   - bundler --version

data/lib/kitchen/command.rb

@@ -175,12 +175,19 @@ module Kitchen
           end
         end
         threads.map(&:join)
+        report_errors
+      end
+
+      # private
+
+      def report_errors
         unless @action_errors.empty?
-          raise ActionFailed.new("#{@action_errors.length} actions failed.", @action_errors)
+          msg = ["#{@action_errors.length} actions failed.",
+                 @action_errors.map { |e| ">>>>>>     #{e.message}" }].join("\n")
+          raise ActionFailed.new(msg, @action_errors)
         end
       end
 
-      # private
       def concurrency_setting(instances)
         concurrency = 1
         if options[:concurrency]
@@ -192,6 +199,8 @@ module Kitchen
 
       def run_action_in_thread(action, instance, *args)
         instance.public_send(action, *args)
+      rescue Kitchen::InstanceFailure => e
+        @action_errors << e
       rescue Kitchen::ActionFailed => e
         new_error = Kitchen::ActionFailed.new("#{e.message} on #{instance.name}")
         new_error.set_backtrace(e.backtrace)

data/lib/kitchen/provisioner/base.rb

@@ -32,6 +32,10 @@ module Kitchen
       default_config :https_proxy, nil
       default_config :ftp_proxy, nil
 
+      default_config :retry_on_exit_code, []
+      default_config :max_retries, 1
+      default_config :wait_for_retry, 30
+
       default_config :root_path do |provisioner|
         provisioner.windows_os? ? "$env:TEMP\\kitchen" : "/tmp/kitchen"
       end
@@ -59,6 +63,7 @@ module Kitchen
       #
       # @param state [Hash] mutable instance state
       # @raise [ActionFailed] if the action could not be completed
+      # rubocop:disable Metrics/AbcSize
       def call(state)
         create_sandbox
         sandbox_dirs = Dir.glob(File.join(sandbox_path, "*"))
@@ -70,7 +75,12 @@ module Kitchen
           conn.upload(sandbox_dirs, config[:root_path])
           debug("Transfer complete")
           conn.execute(prepare_command)
-          conn.execute(run_command)
+          conn.execute_with_retry(
+            run_command,
+            config[:retry_on_exit_code],
+            config[:max_retries],
+            config[:wait_for_retry]
+          )
         end
       rescue Kitchen::Transport::TransportFailed => ex
         raise ActionFailed, ex.message

data/lib/kitchen/provisioner/chef/common_sandbox.rb

@@ -92,7 +92,7 @@ module Kitchen
         #   kitchen root
         # @api private
         def policyfile
-          basename = config[:policyfile_path] || "Policyfile.rb"
+          basename = config[:policyfile_path] || config[:policyfile] || "Policyfile.rb"
           File.join(config[:kitchen_root], basename)
         end
 

data/lib/kitchen/provisioner/chef_base.rb

@@ -54,6 +54,8 @@ module Kitchen
       default_config :log_file, nil
       default_config :log_level, "auto"
       default_config :profile_ruby, false
+      # The older policyfile_zero used `policyfile` so support it for compat.
+      default_config :policyfile, nil
       # Will try to autodetect by searching for `Policyfile.rb` if not set.
       # If set, will error if the file doesn't exist.
       default_config :policyfile_path, nil
@@ -167,7 +169,7 @@ module Kitchen
       #   kitchen root
       # @api private
       def policyfile
-        policyfile_basename = config[:policyfile_path] || "Policyfile.rb"
+        policyfile_basename = config[:policyfile_path] || config[:policyfile] || "Policyfile.rb"
         File.join(config[:kitchen_root], policyfile_basename)
       end
 
@@ -350,7 +352,7 @@ module Kitchen
       # @raise [UserError]
       # @api private
       def sanity_check_sandbox_options!
-        if config[:policyfile_path] && !File.exist?(policyfile)
+        if (config[:policyfile_path] || config[:policyfile]) && !File.exist?(policyfile)
           raise UserError, "policyfile_path set in config "\
             "(#{config[:policyfile_path]} could not be found. " \
             "Expected to find it at full path #{policyfile} " \

data/lib/kitchen/provisioner/chef_zero.rb

@@ -76,7 +76,7 @@ module Kitchen
 
         prefix_command(
           wrap_shell_code(
-            [cmd, *chef_client_args].join(" ").
+            [cmd, *chef_client_args, last_exit_code].join(" ").
             tap { |str| str.insert(0, reload_ps1_path) if windows_os? }
           )
         )
@@ -84,6 +84,10 @@ module Kitchen
 
       private
 
+      def last_exit_code
+        "; exit $LastExitCode" if powershell_shell?
+      end
+
       # Adds optional flags to a chef-client command, depending on
       # configuration data. Note that this method mutates the incoming Array.
       #

data/lib/kitchen/transport/base.rb

@@ -28,7 +28,14 @@ module Kitchen
     # Wrapped exception for any internally raised Transport errors.
     #
     # @author Salim Afiune <salim@afiunemaya.com.mx>
-    class TransportFailed < TransientFailure; end
+    class TransportFailed < TransientFailure
+      attr_reader :exit_code
+
+      def initialize(message, exit_code = nil)
+        @exit_code = exit_code
+        super(message)
+      end
+    end
 
     # Base class for a transport.
     #
@@ -54,7 +61,8 @@ module Kitchen
       # @param state [Hash] mutable instance state
       # @return [Connection] a connection for this transport
       # @raise [TransportFailed] if a connection could not be returned
-      def connection(state) # rubocop:disable Lint/UnusedMethodArgument
+      # rubocop:disable Lint/UnusedMethodArgument
+      def connection(state)
         raise ClientError, "#{self.class}#connection must be implemented"
       end
 
@@ -97,10 +105,41 @@ module Kitchen
         # @param command [String] command string to execute
         # @raise [TransportFailed] if the command does not exit successfully,
         #   which may vary by implementation
-        def execute(command) # rubocop:disable Lint/UnusedMethodArgument
+        def execute(command)
           raise ClientError, "#{self.class}#execute must be implemented"
         end
 
+        # Execute a command on the remote host and retry
+        #
+        # @param command [String] command string to execute
+        # @param retryable_exit_codes [Array] Array of exit codes to retry against
+        # @param max_retries [Fixnum] maximum number of retry attempts
+        # @param wait_time [Fixnum] number of seconds to wait before retrying command
+        # @raise [TransportFailed] if the command does not exit successfully,
+        #   which may vary by implementation
+        def execute_with_retry(command, retryable_exit_codes = [], max_retries = 1, wait_time = 30)
+          tries = 0
+          begin
+            tries += 1
+            debug("Attempting to execute command - try #{tries} of #{max_retries}.")
+            execute(command)
+          rescue Kitchen::Transport::TransportFailed => e
+            if retry?(tries, max_retries, retryable_exit_codes, e.exit_code)
+              close
+              sleep wait_time
+              retry
+            else
+              raise e
+            end
+          end
+        end
+
+        def retry?(current_try, max_retries, retryable_exit_codes, exit_code)
+          current_try <= max_retries &&
+            !retryable_exit_codes.nil? &&
+            retryable_exit_codes.include?(exit_code)
+        end
+
         # Builds a LoginCommand which can be used to open an interactive
         # session on the remote host.
         #

data/lib/kitchen/transport/ssh.rb

@@ -124,8 +124,10 @@ module Kitchen
           exit_code = execute_with_exit_code(command)
 
           if exit_code != 0
-            raise Transport::SshFailed,
-              "SSH exited (#{exit_code}) for command: [#{command}]"
+            raise Transport::SshFailed.new(
+              "SSH exited (#{exit_code}) for command: [#{command}]",
+              exit_code
+            )
           end
         rescue Net::SSH::Exception => ex
           raise SshFailed, "SSH command failed (#{ex.message})"

data/lib/kitchen/transport/winrm.rb

@@ -105,8 +105,10 @@ module Kitchen
             log_stderr_on_warn(stderr)
           elsif exit_code != 0
             log_stderr_on_warn(stderr)
-            raise Transport::WinrmFailed,
-              "WinRM exited (#{exit_code}) for command: [#{command}]"
+            raise Transport::WinrmFailed.new(
+              "WinRM exited (#{exit_code}) for command: [#{command}]",
+              exit_code
+            )
           end
         end
 

data/lib/kitchen/version.rb

@@ -17,5 +17,5 @@
 # limitations under the License.
 
 module Kitchen
-  VERSION = "1.9.2"
+  VERSION = "1.10.0"
 end

data/spec/kitchen/provisioner/base_spec.rb

@@ -157,6 +157,7 @@ describe Kitchen::Provisioner::Base do
       FileUtils.mkdir_p(File.join(provisioner.sandbox_path, "stuff"))
       transport.stubs(:connection).yields(connection)
       connection.stubs(:execute)
+      connection.stubs(:execute_with_retry)
       connection.stubs(:upload)
     end
 
@@ -193,7 +194,7 @@ describe Kitchen::Provisioner::Base do
       connection.expects(:execute).with("install").in_sequence(order)
       connection.expects(:execute).with("init").in_sequence(order)
       connection.expects(:execute).with("prepare").in_sequence(order)
-      connection.expects(:execute).with("run").in_sequence(order)
+      connection.expects(:execute_with_retry).with("run", [], 1, 30).in_sequence(order)
 
       cmd
     end

data/spec/kitchen/provisioner/chef_base_spec.rb

@@ -1055,6 +1055,71 @@ POLICYFILE
             end
           end
         end
+        describe "with a fallback policyfile" do
+
+          let(:config) do
+            {
+              :policyfile => "foo-policy.rb",
+              :test_base_path => "/basist",
+              :kitchen_root => "/rooty"
+            }
+          end
+
+          before do
+            Kitchen::Provisioner::Chef::Policyfile.stubs(:load!)
+            Kitchen::Provisioner::Chef::Policyfile.stubs(:new).returns(resolver)
+            provisioner.stubs(:supports_policyfile?).returns(true)
+          end
+
+          describe "when the policyfile exists" do
+
+            let(:policyfile_path) { "#{kitchen_root}/foo-policy.rb" }
+            let(:policyfile_lock_path) { "#{kitchen_root}/foo-policy.lock.json" }
+
+            before do
+              File.open(policyfile_path, "wb") do |file|
+                file.write(<<-POLICYFILE)
+name 'wat'
+run_list 'wat'
+cookbook 'wat'
+POLICYFILE
+              end
+              File.open(policyfile_lock_path, "wb") do |file|
+                file.write(<<-POLICYFILE)
+{
+  "name": "wat"
+}
+POLICYFILE
+              end
+            end
+
+            it "uses uses the policyfile to resolve dependencies" do
+              Kitchen::Provisioner::Chef::Policyfile.stubs(:load!)
+              resolver.expects(:resolve)
+
+              provisioner.create_sandbox
+            end
+
+            it "passes the correct path to the policyfile resolver" do
+              Kitchen::Provisioner::Chef::Policyfile.
+                expects(:new).
+                with(policyfile_path, instance_of(String), anything).
+                returns(resolver)
+
+              Kitchen::Provisioner::Chef::Policyfile.stubs(:load!)
+              resolver.expects(:resolve)
+
+              provisioner.create_sandbox
+            end
+          end
+          describe "when the policyfile doesn't exist" do
+
+            it "raises a UserError" do
+              proc { provisioner.create_sandbox }.must_raise Kitchen::UserError
+            end
+
+          end
+        end
       end
 
       describe "with a Berksfile under kitchen_root" do

data/spec/kitchen/transport/base_spec.rb

@@ -54,6 +54,27 @@ describe Kitchen::Transport::Base do
       transport.send(:logger).must_equal Kitchen.logger
     end
   end
+
+  describe Kitchen::Transport::TransportFailed do
+
+    let(:failure_with_no_exit_code) { Kitchen::Transport::TransportFailed.new("Boom") }
+    let(:failure_with_exit_code) { Kitchen::Transport::TransportFailed.new("Boom", 123) }
+
+    describe "when no exit code is provided" do
+
+      it "#exit_code is nil" do
+        failure_with_no_exit_code.exit_code.must_be_nil
+      end
+    end
+
+    describe "when an exit code is provided" do
+
+      it "#exit_code returns the supplied exit code" do
+        failure_with_exit_code.exit_code.must_equal 123
+      end
+    end
+  end
+
 end
 
 describe Kitchen::Transport::Base::Connection do
@@ -86,4 +107,25 @@ describe Kitchen::Transport::Base::Connection do
   it "has a #wait_until_ready method that does nothing" do
     connection.wait_until_ready.must_be_nil
   end
+
+  describe "#execute_with_retry" do
+
+    let(:failure_with_exit_code) { Kitchen::Transport::TransportFailed.new("Boom", 123) }
+
+    it "raises ClientError with no retries" do
+      proc { connection.execute_with_retry("hi", [], nil, nil) }.
+        must_raise Kitchen::ClientError
+    end
+
+    it "retries three times" do
+      connection.expects(:execute).with("Hi").returns("Hello")
+      connection.expects(:debug).with("Attempting to execute command - try 3 of 3.")
+      connection.expects(:execute).with("Hi").raises(failure_with_exit_code)
+      connection.expects(:debug).with("Attempting to execute command - try 2 of 3.")
+      connection.expects(:execute).with("Hi").raises(failure_with_exit_code)
+      connection.expects(:debug).with("Attempting to execute command - try 1 of 3.")
+
+      connection.execute_with_retry("Hi", [123], 3, 1).must_equal "Hello"
+    end
+  end
 end

data/spec/kitchen/transport/ssh_spec.rb

@@ -900,6 +900,14 @@ describe Kitchen::Transport::Ssh::Connection do
         }.must_raise Kitchen::Transport::SshFailed
         err.message.must_equal "SSH exited (42) for command: [doit]"
       end
+
+      it "returns the exit code with an SshFailed exception" do
+        begin
+          connection.execute("doit")
+        rescue Kitchen::Transport::SshFailed => e
+          e.exit_code.must_equal 42
+        end
+      end
     end
 
     describe "for an interrupted command" do

data/spec/kitchen/transport/winrm_spec.rb

@@ -935,6 +935,14 @@ MSG
           }.must_raise Kitchen::Transport::WinrmFailed
           err.message.must_equal "WinRM exited (1) for command: [doit]"
         end
+
+        it "raises WinrmFailed exception with the exit code of the failure" do
+          begin
+            connection.execute("doit")
+          rescue Kitchen::Transport::WinrmFailed => e
+            e.exit_code.must_equal 1
+          end
+        end
       end
     end
 

data/test-kitchen.gemspec

@@ -34,6 +34,7 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency "pry-byebug"
   gem.add_development_dependency "pry-stack_explorer"
   gem.add_development_dependency "rb-readline"
+  gem.add_development_dependency "overcommit", "= 0.33.0"
   gem.add_development_dependency "winrm", "~> 1.6"
   gem.add_development_dependency "winrm-elevated", "~> 0.4.0"
   gem.add_development_dependency "winrm-fs", "~> 0.4.1"

data/test/integration/default/default_spec.rb

@@ -1,3 +1,3 @@
-describe command("hg") do
-  it { should exist }
+describe oneget("FileZilla Client 3.14.1") do
+  it { should be_installed }
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: test-kitchen
 version: !ruby/object:Gem::Version
-  version: 1.9.2
+  version: 1.10.0
 platform: ruby
 authors:
 - Fletcher Nichol
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-09 00:00:00.000000000 Z
+date: 2016-06-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mixlib-shellout
@@ -168,6 +168,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: overcommit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.33.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.33.0
 - !ruby/object:Gem::Dependency
   name: winrm
   requirement: !ruby/object:Gem::Requirement