test-kitchen 1.19.2 → 1.20.0

data/lib/kitchen/state_file.rb

@@ -16,7 +16,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require "safe_yaml/load"
+require "yaml"
 
 module Kitchen
   # Exception class for any exceptions raised when reading and parsing a state
@@ -96,8 +96,8 @@ module Kitchen
     # @raise [StateFileLoadError] if the string document cannot be parsed
     # @api private
     def deserialize_string(string)
-      SafeYAML.load(string)
-    rescue SyntaxError, Psych::SyntaxError => ex
+      YAML.safe_load(string)
+    rescue SyntaxError, Psych::SyntaxError, Psych::DisallowedClass => ex
       raise StateFileLoadError, "Error parsing #{file_name} (#{ex.message})"
     end
 

data/lib/kitchen/transport/base.rb

@@ -140,7 +140,7 @@ module Kitchen
         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)
+            retryable_exit_codes.flatten.include?(exit_code)
         end
 
         # Builds a LoginCommand which can be used to open an interactive
@@ -163,6 +163,18 @@ module Kitchen
           raise ClientError, "#{self.class}#upload must be implemented"
         end
 
+        # Download remote files or directories to local host.
+        #
+        # @param remotes [Array<String>] paths to remote files or directories
+        # @param local [String] path to local destination. If `local` is an
+        #   existing directory, `remote` will be downloaded into the directory
+        #   using its original name
+        # @raise [TransportFailed] if the files could not all be downloaded
+        #   successfully, which may vary by implementation
+        def download(remotes, local) # rubocop:disable Lint/UnusedMethodArgument
+          raise ClientError, "#{self.class}#download must be implemented"
+        end
+
         # Block and return only when the remote host is prepared and ready to
         # execute command and upload files. The semantics and details will
         # vary by implementation, but a round trip through the hosted

data/lib/kitchen/transport/dummy.rb

@@ -51,6 +51,10 @@ module Kitchen
           report(:upload, "#{locals.inspect} => #{remote}")
         end
 
+        def download(remotes, local)
+          report(:download, "#{remotes.inspect} => #{local}")
+        end
+
         private
 
         # Report what action is taking place, sleeping if so configured, and

data/lib/kitchen/transport/ssh.rb

@@ -18,8 +18,10 @@
 
 require "kitchen"
 
+require "fileutils"
 require "net/ssh"
 require "net/ssh/gateway"
+require "net/ssh/proxy/http"
 require "net/scp"
 require "timeout"
 require "benchmark"
@@ -54,6 +56,11 @@ module Kitchen
       default_config :ssh_gateway, nil
       default_config :ssh_gateway_username, nil
 
+      default_config :ssh_http_proxy, nil
+      default_config :ssh_http_proxy_port, nil
+      default_config :ssh_http_proxy_user, nil
+      default_config :ssh_http_proxy_password, nil
+
       default_config :ssh_key, nil
       expand_path_for :ssh_key
 
@@ -181,6 +188,30 @@ module Kitchen
           raise SshFailed, "SCP upload failed (#{ex.message})"
         end
 
+        # (see Base::Connection#download)
+        def download(remotes, local)
+          # ensure the parent dir of the local target exists
+          FileUtils.mkdir_p(File.dirname(local))
+
+          Array(remotes).each do |file|
+            begin
+              logger.debug("Attempting to download '#{file}' as file")
+              session.scp.download!(file, local)
+            rescue Net::SCP::Error
+              begin
+                logger.debug("Attempting to download '#{file}' as directory")
+                session.scp.download!(file, local, recursive: true)
+              rescue Net::SCP::Error
+                logger.warn(
+                  "SCP download failed for file or directory '#{file}', perhaps it does not exist?"
+                )
+              end
+            end
+          end
+        rescue Net::SSH::Exception => ex
+          raise SshFailed, "SCP download failed (#{ex.message})"
+        end
+
         # (see Base::Connection#wait_until_ready)
         def wait_until_ready
           delay = 3
@@ -246,6 +277,26 @@ module Kitchen
         # @api private
         attr_reader :ssh_gateway_username
 
+        # @return [String] The kitchen ssh proxy to use when connecting to the
+        #   remote SSH host via http proxy
+        # @api private
+        attr_reader :ssh_http_proxy
+
+        # @return [Integer] The port to use when using an kitchen ssh proxy
+        #   remote SSH host via http proxy
+        # @api private
+        attr_reader :ssh_http_proxy_port
+
+        # @return [String] The username to use when using an kitchen ssh proxy
+        #   remote SSH host via http proxy
+        # @api private
+        attr_reader :ssh_http_proxy_user
+
+        # @return [String] The password to use when using an kitchen ssh proxy
+        #   remote SSH host via http proxy
+        # @api private
+        attr_reader :ssh_http_proxy_password
+
         # Establish an SSH session on the remote host using a gateway host.
         #
         # @param opts [Hash] retry options
@@ -346,15 +397,19 @@ module Kitchen
         # (see Base::Connection#init_options)
         def init_options(options)
           super
-          @username               = @options.delete(:username)
-          @hostname               = @options.delete(:hostname)
-          @port                   = @options[:port] # don't delete from options
-          @connection_retries     = @options.delete(:connection_retries)
-          @connection_retry_sleep = @options.delete(:connection_retry_sleep)
-          @max_ssh_sessions       = @options.delete(:max_ssh_sessions)
-          @max_wait_until_ready   = @options.delete(:max_wait_until_ready)
-          @ssh_gateway            = @options.delete(:ssh_gateway)
-          @ssh_gateway_username   = @options.delete(:ssh_gateway_username)
+          @username                = @options.delete(:username)
+          @hostname                = @options.delete(:hostname)
+          @port                    = @options[:port] # don't delete from options
+          @connection_retries      = @options.delete(:connection_retries)
+          @connection_retry_sleep  = @options.delete(:connection_retry_sleep)
+          @max_ssh_sessions        = @options.delete(:max_ssh_sessions)
+          @max_wait_until_ready    = @options.delete(:max_wait_until_ready)
+          @ssh_gateway             = @options.delete(:ssh_gateway)
+          @ssh_gateway_username    = @options.delete(:ssh_gateway_username)
+          @ssh_http_proxy          = @options.delete(:ssh_http_proxy)
+          @ssh_http_proxy_user     = @options.delete(:ssh_http_proxy_user)
+          @ssh_http_proxy_password = @options.delete(:ssh_http_proxy_password)
+          @ssh_http_proxy_port     = @options.delete(:ssh_http_proxy_port)
         end
 
         # Returns a connection session, or establishes one when invoked the
@@ -421,6 +476,13 @@ module Kitchen
           opts[:auth_methods] = ["publickey"]
         end
 
+        if data[:ssh_http_proxy]
+          options_http_proxy = {}
+          options_http_proxy[:user] = data[:ssh_http_proxy_user]
+          options_http_proxy[:password] = data[:ssh_http_proxy_password]
+          opts[:proxy] = Net::SSH::Proxy::HTTP.new(data[:ssh_http_proxy], data[:ssh_http_proxy_port], options_http_proxy)
+        end
+
         if data[:ssh_key_only]
           opts[:auth_methods] = ["publickey"]
         end

data/lib/kitchen/transport/winrm.rb

@@ -137,6 +137,22 @@ module Kitchen
           file_transporter.upload(locals, remote)
         end
 
+        # (see Base::Connection#download)
+        def download(remotes, local)
+          # ensure the parent dir of the local target exists
+          FileUtils.mkdir_p(File.dirname(local))
+
+          Array(remotes).each do |remote|
+            file_manager.download(remote, local)
+          end
+        end
+
+        # @return [Winrm::FileManager] a file transporter
+        # @api private
+        def file_manager
+          @file_manager ||= WinRM::FS::FileManager.new(connection)
+        end
+
         # (see Base::Connection#wait_until_ready)
         def wait_until_ready
           delay = 3

data/lib/kitchen/version.rb

@@ -17,5 +17,5 @@
 # limitations under the License.
 
 module Kitchen
-  VERSION = "1.19.2".freeze
+  VERSION = "1.20.0".freeze
 end

data/spec/kitchen/driver/ssh_base_spec.rb

@@ -270,12 +270,16 @@ describe Kitchen::Driver::SSHBase do
 
   describe "#converge" do
     let(:cmd)         { driver.converge(state) }
-    let(:connection)  { stub(execute: true, upload: true) }
+    let(:connection)  { stub(execute: true, upload: true, download: true) }
 
     before do
       state[:hostname] = "fizzy"
       state[:username] = "bork"
       provisioner.stubs(:[]).with(:root_path).returns("/rooty")
+      provisioner.stubs(:[]).with(:downloads).returns(
+        ["/tmp/kitchen/nodes", "/tmp/kitchen/data_bags"] => "./test/fixtures",
+        "/remote" => "/local"
+      )
       FakeFS.activate!
       FileUtils.mkdir_p("/tmp")
       @original_env = ENV.to_hash
@@ -471,6 +475,43 @@ describe Kitchen::Driver::SSHBase do
       end
     end
 
+    describe "downloading files" do
+      before do
+        transport.stubs(:connection).yields(connection)
+        connection.stubs(:download)
+      end
+
+      it "downloads files" do
+        connection.expects(:download).with(
+          ["/tmp/kitchen/nodes", "/tmp/kitchen/data_bags"],
+          "./test/fixtures"
+        )
+        connection.expects(:download).with("/remote", "/local")
+
+        cmd
+      end
+
+      it "logs to info" do
+        cmd
+
+        logged_output.string.must_match(
+          /INFO -- : Downloading files from instance$/
+        )
+      end
+
+      it "logs to debug" do
+        cmd
+
+        logged_output.string.must_match(
+          %r{DEBUG -- : Downloading /tmp/kitchen/nodes, /tmp/kitchen/data_bags to ./test/fixtures$}
+        )
+        logged_output.string.must_match(
+          %r{DEBUG -- : Downloading /remote to /local$}
+        )
+        logged_output.string.must_match(/DEBUG -- : Download complete$/)
+      end
+    end
+
     it "raises an ActionFailed on execute when SshFailed is raised" do
       transport.stubs(:connection).yields(connection)
       connection.stubs(:execute).raises(Kitchen::Transport::SshFailed.new("dang"))

data/spec/kitchen/loader/yaml_spec.rb

@@ -344,9 +344,7 @@ describe Kitchen::Loader::YAML do
         YAML
       end
 
-      loader.read.class.wont_equal Yamled
-      loader.read.class.must_equal Hash
-      loader.read.must_equal(foo: "bar")
+      proc { loader.read }.must_raise Kitchen::UserError
     end
 
     it "arbitrary objects aren't deserialized in kitchen.local.yml" do
@@ -359,9 +357,7 @@ describe Kitchen::Loader::YAML do
       end
       stub_yaml!({})
 
-      loader.read.class.wont_equal Yamled
-      loader.read.class.must_equal Hash
-      loader.read.must_equal(wakka: "boop")
+      proc { loader.read }.must_raise Kitchen::UserError
     end
 
     it "raises a UserError if kitchen.yml cannot be parsed" do

data/spec/kitchen/provisioner/base_spec.rb

@@ -151,6 +151,11 @@ describe Kitchen::Provisioner::Base do
       connection.stubs(:execute)
       connection.stubs(:execute_with_retry)
       connection.stubs(:upload)
+      connection.stubs(:download)
+      config[:downloads] = {
+        ["/tmp/kitchen/nodes", "/tmp/kitchen/data_bags"] => "./test/fixtures",
+        "/remote" => "/local",
+      }
     end
 
     after do
@@ -196,6 +201,8 @@ describe Kitchen::Provisioner::Base do
 
       logged_output.string
                    .must_match(/INFO -- : Transferring files to instance$/)
+      logged_output.string
+                   .must_match(/INFO -- : Downloading files from instance$/)
     end
 
     it "uploads sandbox files" do
@@ -208,6 +215,24 @@ describe Kitchen::Provisioner::Base do
       cmd
 
       logged_output.string.must_match(/DEBUG -- : Transfer complete$/)
+      logged_output.string.must_match(
+        %r{DEBUG -- : Downloading /tmp/kitchen/nodes, /tmp/kitchen/data_bags to ./test/fixtures$}
+      )
+      logged_output.string.must_match(
+        %r{DEBUG -- : Downloading /remote to /local$}
+      )
+      logged_output.string.must_match(/DEBUG -- : Download complete$/)
+    end
+
+    it "downloads files" do
+      connection.expects(:download).with(
+        ["/tmp/kitchen/nodes", "/tmp/kitchen/data_bags"],
+        "./test/fixtures"
+      )
+
+      connection.expects(:download).with("/remote", "/local")
+
+      cmd
     end
 
     it "raises an ActionFailed on transfer when TransportFailed is raised" do

data/spec/kitchen/provisioner/chef_base_spec.rb

@@ -519,6 +519,34 @@ describe Kitchen::Provisioner::ChefBase do
         end.returns(installer)
         cmd
       end
+
+      describe "when driver implements the cache_directory" do
+
+        describe "for windows" do
+          before { driver.stubs(:cache_directory).returns('$env:TEMP\\dummy\\place') }
+
+          it "will have the set behavior on windows" do
+            platform.stubs(:shell_type).returns("powershell")
+            platform.stubs(:os_type).returns("windows")
+
+            Mixlib::Install.expects(:new).with do |opts|
+              opts[:install_command_options][:download_directory].must_equal '$env:TEMP\\dummy\\place'
+            end.returns(installer)
+            cmd
+          end
+        end
+
+        describe "for shell" do
+          before { driver.stubs(:cache_directory).returns("/tmp") }
+
+          it "will have the set behavior on non-windows" do
+            Mixlib::Install.expects(:new).with do |opts|
+              opts[:install_command_options][:cmdline_dl_dir].must_equal "/tmp"
+            end.returns(installer)
+            cmd
+          end
+        end
+      end
     end
 
     describe "when install_strategy is skipped" do