test-kitchen 1.4.2 → 1.5.0

data/lib/kitchen/configurable.rb

@@ -295,15 +295,36 @@ module Kitchen
     # @param code [String] the shell code to be wrapped
     # @return [String] wrapped shell code
     # @api private
+    # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+    # rubocop:disable Metrics/PerceivedComplexity, Metrics/CyclomaticComplexity
     def wrap_shell_code(code)
       env = []
       if config[:http_proxy]
         env << shell_env_var("http_proxy", config[:http_proxy])
         env << shell_env_var("HTTP_PROXY", config[:http_proxy])
+      else
+        export_proxy(env, "http")
       end
       if config[:https_proxy]
         env << shell_env_var("https_proxy", config[:https_proxy])
         env << shell_env_var("HTTPS_PROXY", config[:https_proxy])
+      else
+        export_proxy(env, "https")
+      end
+      if config[:ftp_proxy]
+        env << shell_env_var("ftp_proxy", config[:ftp_proxy])
+        env << shell_env_var("FTP_PROXY", config[:ftp_proxy])
+      else
+        export_proxy(env, "ftp")
+      end
+      # if http_proxy was set from environment variable or https_proxy was set
+      # from environment variable, or ftp_proxy was set from environment
+      # variable, include no_proxy environment variable, if set.
+      if (!config[:http_proxy] && (ENV["http_proxy"] || ENV["HTTP_PROXY"])) ||
+          (!config[:https_proxy] && (ENV["https_proxy"] || ENV["HTTPS_PROXY"])) ||
+          (!config[:ftp_proxy] && (ENV["ftp_proxy"] || ENV["FTP_PROXY"]))
+        env << shell_env_var("no_proxy", ENV["no_proxy"]) if ENV["no_proxy"]
+        env << shell_env_var("NO_PROXY", ENV["NO_PROXY"]) if ENV["NO_PROXY"]
       end
       if powershell_shell?
         env.join("\n").concat("\n").concat(code)
@@ -312,6 +333,17 @@ module Kitchen
       end
     end
 
+    # Helper method to export
+    #
+    # @param env [Array] the environment to modify
+    # @param code [String] the type of proxy to export, one of 'http', 'https' or 'ftp'
+    # @api private
+    def export_proxy(env, type)
+      env << shell_env_var("#{type}_proxy", ENV["#{type}_proxy"]) if ENV["#{type}_proxy"]
+      env << shell_env_var("#{type.upcase}_PROXY", ENV["#{type.upcase}_PROXY"]) if
+        ENV["#{type.upcase}_PROXY"]
+    end
+
     # Class methods which will be mixed in on inclusion of Configurable module.
     module ClassMethods
 

data/lib/kitchen/driver/ssh_base.rb

@@ -233,17 +233,31 @@ module Kitchen
         [combined[:hostname], combined[:username], opts]
       end
 
-      # Adds http and https proxy environment variables to a command, if set
-      # in configuration data.
+      # Adds http, https and ftp proxy environment variables to a command, if
+      # set in configuration data or on local workstation.
       #
       # @param cmd [String] command string
       # @return [String] command string
       # @api private
+      # rubocop:disable Metrics/PerceivedComplexity, Metrics/CyclomaticComplexity, Metrics/AbcSize
       def env_cmd(cmd)
         return if cmd.nil?
         env = "env"
-        env << " http_proxy=#{config[:http_proxy]}"   if config[:http_proxy]
-        env << " https_proxy=#{config[:https_proxy]}" if config[:https_proxy]
+        http_proxy = config[:http_proxy] || ENV["http_proxy"] ||
+          ENV["HTTP_PROXY"]
+        https_proxy = config[:https_proxy] || ENV["https_proxy"] ||
+          ENV["HTTPS_PROXY"]
+        ftp_proxy = config[:ftp_proxy] || ENV["ftp_proxy"] ||
+          ENV["FTP_PROXY"]
+        no_proxy = if (!config[:http_proxy] && http_proxy) ||
+            (!config[:https_proxy] && https_proxy) ||
+            (!config[:ftp_proxy] && ftp_proxy)
+          ENV["no_proxy"] || ENV["NO_PROXY"]
+        end
+        env << " http_proxy=#{http_proxy}"   if http_proxy
+        env << " https_proxy=#{https_proxy}" if https_proxy
+        env << " ftp_proxy=#{ftp_proxy}"     if ftp_proxy
+        env << " no_proxy=#{no_proxy}"       if no_proxy
 
         env == "env" ? cmd : "#{env} #{cmd}"
       end

data/lib/kitchen/generator/driver_create.rb

@@ -87,8 +87,8 @@ module Kitchen
       # @api private
       def initialize_git
         inside(target_dir) do
-          run("git init")
-          run("git add .")
+          run("git init", :capture => true)
+          run("git add .", :capture => true)
         end
       end
 

data/lib/kitchen/generator/init.rb

@@ -143,10 +143,10 @@ module Kitchen
         rakedoc = <<-RAKE.gsub(/^ {10}/, "")
 
           begin
-            require "kitchen/rake_tasks"
+            require 'kitchen/rake_tasks'
             Kitchen::RakeTasks.new
           rescue LoadError
-            puts ">>>>> Kitchen gem not loaded, omitting tasks" unless ENV["CI"]
+            puts '>>>>> Kitchen gem not loaded, omitting tasks' unless ENV['CI']
           end
         RAKE
         append_to_file(File.join(destination_root, "Rakefile"), rakedoc)
@@ -161,10 +161,10 @@ module Kitchen
         thordoc = <<-THOR.gsub(/^ {10}/, "")
 
           begin
-            require "kitchen/thor_tasks"
+            require 'kitchen/thor_tasks'
             Kitchen::ThorTasks.new
           rescue LoadError
-            puts ">>>>> Kitchen gem not loaded, omitting tasks" unless ENV["CI"]
+            puts '>>>>> Kitchen gem not loaded, omitting tasks' unless ENV['CI']
           end
         THOR
         append_to_file(File.join(destination_root, "Thorfile"), thordoc)

data/lib/kitchen/instance.rb

@@ -267,6 +267,13 @@ module Kitchen
       state_file.read[:last_action]
     end
 
+    # Clean up any per-instance resources before exiting.
+    #
+    # @return [void]
+    def cleanup!
+      @transport.cleanup! if @transport
+    end
+
     private
 
     # @return [StateFile] a state file object that can be read from or written

data/lib/kitchen/lazy_hash.rb

@@ -53,6 +53,7 @@ module Kitchen
   #
   # @author Fletcher Nichol <fnichol@nichol.ca>
   class LazyHash < SimpleDelegator
+    include Enumerable
 
     # Creates a new LazyHash using a Hash-like object to populate itself and
     # an object that can be used as context in value-callable blocks. The
@@ -105,6 +106,25 @@ module Kitchen
       hash
     end
 
+    # Yields each key/value pair to the provided block.  Returns a new
+    # Hash with only the keys and rendered values for which the block
+    # returns true.
+    #
+    # @return [Hash] a new hash
+    def select(&block)
+      to_hash.select(&block)
+    end
+
+    # If no block provided, returns an enumerator over the keys and
+    # rendered values in the underlying object.  If a block is
+    # provided, calls the block once for each [key, rendered_value]
+    # pair in the underlying object.
+    #
+    # @return [Enumerator, Array]
+    def each(&block)
+      to_hash.each(&block)
+    end
+
     private
 
     # Returns an object or invokes call with context if object is callable.

data/lib/kitchen/logger.rb

@@ -343,13 +343,10 @@ module Kitchen
       # @param msg [String] a message
       def <<(msg)
         @buffer ||= ""
-        lines, _, remainder = msg.rpartition("\n")
-        if lines.empty?
-          @buffer << remainder
-        else
-          lines.insert(0, @buffer)
-          lines.split("\n").each { |l| format_line(l.chomp) }
-          @buffer = ""
+        @buffer += msg
+        while i = @buffer.index("\n")
+          format_line(@buffer[0, i].chomp)
+          @buffer[0, i + 1] = ""
         end
       end
 

data/lib/kitchen/provisioner/base.rb

@@ -29,8 +29,8 @@ module Kitchen
       include Logging
 
       default_config :http_proxy, nil
-
       default_config :https_proxy, nil
+      default_config :ftp_proxy, nil
 
       default_config :root_path do |provisioner|
         provisioner.windows_os? ? "$env:TEMP\\kitchen" : "/tmp/kitchen"
@@ -44,6 +44,8 @@ module Kitchen
         provisioner.windows_os? ? nil : "sudo -E"
       end
 
+      default_config :command_prefix, nil
+
       expand_path_for :test_base_path
 
       # Constructs a new provisioner by providing a configuration hash.
@@ -208,6 +210,19 @@ module Kitchen
       def sudo(script)
         config[:sudo] ? "#{config[:sudo_command]} #{script}" : script
       end
+
+      # Conditionally prefixes a command with a command prefix.
+      # This should generally be done after a command has been
+      # conditionally prefixed by #sudo as certain platforms, such as
+      # Cisco Nexus, require all commands to be run with a prefix to
+      # obtain outbound network access.
+      #
+      # @param command [String] command to be prefixed
+      # @return [String] the command, conditionally prefixed with the configured prefix
+      # @api private
+      def prefix_command(script)
+        config[:command_prefix] ? "#{config[:command_prefix]} #{script}" : script
+      end
     end
   end
 end

data/lib/kitchen/provisioner/chef_base.rb

@@ -25,6 +25,9 @@ require "kitchen/provisioner/chef/berkshelf"
 require "kitchen/provisioner/chef/common_sandbox"
 require "kitchen/provisioner/chef/librarian"
 require "kitchen/util"
+require "mixlib/install"
+require "chef-config/config"
+require "chef-config/workstation_config_loader"
 
 module Kitchen
 
@@ -40,25 +43,15 @@ module Kitchen
       default_config :chef_omnibus_install_options, nil
       default_config :run_list, []
       default_config :attributes, {}
+      default_config :config_path, nil
       default_config :log_file, nil
+      default_config :profile_ruby, false
       default_config :cookbook_files_glob, %w[
         README.* metadata.{json,rb}
         attributes/**/* definitions/**/* files/**/* libraries/**/*
         providers/**/* recipes/**/* resources/**/* templates/**/*
       ].join(",")
 
-      default_config :chef_metadata_url do |provisioner|
-        provisioner.default_windows_chef_metadata_url if provisioner.windows_os?
-      end
-
-      default_config :chef_omnibus_root do |provisioner|
-        if provisioner.windows_os?
-          "$env:systemdrive\\opscode\\chef"
-        else
-          "/opt/chef"
-        end
-      end
-
       default_config :data_path do |provisioner|
         provisioner.calculate_path("data")
       end
@@ -94,29 +87,27 @@ module Kitchen
       end
       expand_path_for :encrypted_data_bag_secret_key_path
 
+      # Reads the local Chef::Config object (if present).  We do this because
+      # we want to start bring Chef config and ChefDK tool config closer
+      # together.  For example, we want to configure proxy settings in 1
+      # location instead of 3 configuration files.
+      #
+      # @param config [Hash] initial provided configuration
+      def initialize(config = {})
+        super(config)
+
+        ChefConfig::WorkstationConfigLoader.new(config[:config_path]).load
+        # This exports any proxy config present in the Chef config to
+        # appropriate environment variables, which Test Kitchen respects
+        ChefConfig::Config.export_proxies
+      end
+
       # (see Base#create_sandbox)
       def create_sandbox
         super
         Chef::CommonSandbox.new(config, sandbox_path, instance).populate
       end
 
-      # @return [String] a metadata URL for the Chef Omnitruck API suitable
-      #   for installing a Windows MSI package
-      def default_windows_chef_metadata_url
-        version = config[:require_chef_omnibus]
-        version = "latest" if version == true
-        base = if config[:chef_omnibus_url] =~ %r{/install.sh$}
-          "#{File.dirname(config[:chef_omnibus_url])}/"
-        else
-          "https://www.chef.io/chef/"
-        end
-
-        url = "#{base}#{metadata_project_from_options}"
-        url << "?p=windows&m=x86_64&pv=2008r2" # same pacakge for all versions
-        url << "&v=#{CGI.escape(version.to_s.downcase)}"
-        url
-      end
-
       # (see Base#init_command)
       def init_command
         dirs = %w[
@@ -130,7 +121,7 @@ module Kitchen
           init_command_vars_for_bourne(dirs)
         end
 
-        shell_code_from_file(vars, "chef_base_init_command")
+        prefix_command(shell_code_from_file(vars, "chef_base_init_command"))
       end
 
       # (see Base#install_command)
@@ -139,17 +130,33 @@ module Kitchen
 
         version = config[:require_chef_omnibus].to_s.downcase
 
-        vars = if powershell_shell?
-          install_command_vars_for_powershell(version)
-        else
-          install_command_vars_for_bourne(version)
-        end
+        # Passing "true" to mixlib-install currently breaks the windows metadata_url
+        # TODO: remove this line once https://github.com/chef/mixlib-install/pull/22
+        # is accepted and released
+        version = "" if version == "true" && powershell_shell?
 
-        shell_code_from_file(vars, "chef_base_install_command")
+        installer = Mixlib::Install.new(version, powershell_shell?, install_options)
+        config[:chef_omnibus_root] = installer.root
+        prefix_command(sudo(installer.install_command))
       end
 
       private
 
+      # @return [Hash] an option hash for the install commands
+      # @api private
+      def install_options
+        project = /\s*-P (\w+)\s*/.match(config[:chef_omnibus_install_options])
+        {
+          :omnibus_url => config[:chef_omnibus_url],
+          :project => project.nil? ? nil : project[1],
+          :install_flags => config[:chef_omnibus_install_options]
+        }.tap do |opts|
+          opts[:root] = config[:chef_omnibus_root] if config.key? :chef_omnibus_root
+          opts[:http_proxy] = config[:http_proxy] if config.key? :http_proxy
+          opts[:https_proxy] = config[:https_proxy] if config.key? :https_proxy
+        end
+      end
+
       # @return [String] an absolute path to a Berksfile, relative to the
       #   kitchen root
       # @api private
@@ -251,43 +258,6 @@ module Kitchen
         ].join("\n")
       end
 
-      # Generates the install command variables for Bourne shell-based
-      # platforms.
-      #
-      # @param version [String] version string
-      # @return [String] shell variable lines
-      # @api private
-      def install_command_vars_for_bourne(version)
-        install_flags = %w[latest true].include?(version) ? "" : "-v #{CGI.escape(version)}"
-        if config[:chef_omnibus_install_options]
-          install_flags << " " << config[:chef_omnibus_install_options]
-        end
-
-        [
-          shell_var("chef_omnibus_root", config[:chef_omnibus_root]),
-          shell_var("chef_omnibus_url", config[:chef_omnibus_url]),
-          shell_var("install_flags", install_flags.strip),
-          shell_var("pretty_version", pretty_version(version)),
-          shell_var("sudo_sh", sudo("sh")),
-          shell_var("version", version)
-        ].join("\n")
-      end
-
-      # Generates the install command variables for PowerShell-based platforms.
-      #
-      # @param version [String] version string
-      # @return [String] shell variable lines
-      # @api private
-      def install_command_vars_for_powershell(version)
-        [
-          shell_var("chef_metadata_url", config[:chef_metadata_url]),
-          shell_var("chef_omnibus_root", config[:chef_omnibus_root]),
-          shell_var("msi", "$env:TEMP\\chef-#{version}.msi"),
-          shell_var("pretty_version", pretty_version(version)),
-          shell_var("version", version)
-        ].join("\n")
-      end
-
       # Load cookbook dependency resolver code, if required.
       #
       # (see Base#load_needed_dependencies!)
@@ -302,31 +272,6 @@ module Kitchen
         end
       end
 
-      # @return the correct Chef Omnitruck API metadata endpoint, based on
-      #   project type which could live in
-      #   `config[:chef_omnibus_install_options]`
-      # @api private
-      def metadata_project_from_options
-        match = /\s*-P (\w+)\s*/.match(config[:chef_omnibus_install_options])
-
-        if match.nil? || match[1].downcase == "chef"
-          "metadata"
-        else
-          "metadata-#{match[1].downcase}"
-        end
-      end
-
-      # @return [String] a pretty/helpful representation of a Chef Omnibus
-      #   package version
-      # @api private
-      def pretty_version(version)
-        case version
-        when "true" then "install only if missing"
-        when "latest" then "always install latest version"
-        else version
-        end
-      end
-
       # @return [String] a powershell command to reload the `PATH` environment
       #   variable, only to be used to support old Omnibus Chef packages that
       #   require `PATH` to find the `ruby.exe` binary

data/lib/kitchen/provisioner/chef_solo.rb

@@ -46,7 +46,7 @@ module Kitchen
       end
 
       # (see Base#run_command)
-      def run_command
+      def run_command # rubocop:disable Metrics/AbcSize
         level = config[:log_level] == :info ? :auto : config[:log_level]
 
         cmd = sudo(config[:chef_solo_path]).dup.
@@ -59,11 +59,14 @@ module Kitchen
           "--json-attributes #{remote_path_join(config[:root_path], "dna.json")}"
         ]
         args << "--logfile #{config[:log_file]}" if config[:log_file]
+        args << "--profile-ruby" if config[:profile_ruby]
 
-        wrap_shell_code(
-          [cmd, *args].join(" ").
-          tap { |str| str.insert(0, reload_ps1_path) if windows_os? }
+        prefix_command(
+          wrap_shell_code(
+            [cmd, *args].join(" ").
+            tap { |str| str.insert(0, reload_ps1_path) if windows_os? }
         )
+      )
       end
 
       private

data/lib/kitchen/provisioner/chef_zero.rb

@@ -66,16 +66,18 @@ module Kitchen
           shell_var("gem", sudo(gem_bin))
         ].join("\n").concat("\n")
 
-        shell_code_from_file(vars, "chef_zero_prepare_command_legacy")
+        prefix_command(shell_code_from_file(vars, "chef_zero_prepare_command_legacy"))
       end
 
       # (see Base#run_command)
       def run_command
         cmd = modern? ? local_mode_command : shim_command
 
-        wrap_shell_code(
-          [cmd, *chef_client_args].join(" ").
-          tap { |str| str.insert(0, reload_ps1_path) if windows_os? }
+        prefix_command(
+          wrap_shell_code(
+            [cmd, *chef_client_args].join(" ").
+            tap { |str| str.insert(0, reload_ps1_path) if windows_os? }
+          )
         )
       end
 
@@ -86,6 +88,7 @@ module Kitchen
       #
       # @param args [Array<String>] array of flags
       # @api private
+      # rubocop:disable Metrics/CyclomaticComplexity
       def add_optional_chef_client_args!(args)
         if config[:json_attributes]
           json = remote_path_join(config[:root_path], "dna.json")
@@ -104,14 +107,18 @@ module Kitchen
         if config[:chef_zero_port]
           args << "--chef-zero-port #{config[:chef_zero_port]}"
         end
+        if config[:profile_ruby]
+          args << "--profile-ruby"
+        end
       end
+      # rubocop:enable Metrics/CyclomaticComplexity
 
       # Returns an Array of command line arguments for the chef client.
       #
       # @return [Array<String>] an array of command line arguments
       # @api private
       def chef_client_args
-        level = config[:log_level] == :info ? :auto : config[:log_level]
+        level = config[:log_level] == :info ? :warn : config[:log_level]
         args = [
           "--config #{remote_path_join(config[:root_path], "client.rb")}",
           "--log_level #{level}",

data/lib/kitchen/ssh.rb

@@ -192,7 +192,7 @@ module Kitchen
       rescue_exceptions = [
         Errno::EACCES, Errno::EADDRINUSE, Errno::ECONNREFUSED,
         Errno::ECONNRESET, Errno::ENETUNREACH, Errno::EHOSTUNREACH,
-        Net::SSH::Disconnect, Net::SSH::AuthenticationFailed
+        Net::SSH::Disconnect, Net::SSH::AuthenticationFailed, Net::SSH::ConnectionTimeout
       ]
       retries = options[:ssh_retries] || 3
 

data/lib/kitchen/transport/base.rb

@@ -58,6 +58,13 @@ module Kitchen
         raise ClientError, "#{self.class}#connection must be implemented"
       end
 
+      # Closes the connection, if it is still active.
+      #
+      # @return [void]
+      def cleanup!
+        # This method may be left unimplemented if that is applicable
+      end
+
       # A Connection instance can be generated and re-generated, given new
       # connection details such as connection port, hostname, credentials, etc.
       # This object is responsible for carrying out the actions on the remote

data/lib/kitchen/transport/ssh.rb

@@ -20,6 +20,7 @@ require "kitchen"
 
 require "net/ssh"
 require "net/scp"
+require "timeout"
 
 module Kitchen
 
@@ -85,6 +86,15 @@ module Kitchen
         end
       end
 
+      # (see Base#cleanup!)
+      def cleanup!
+        if @connection
+          logger.debug("[SSH] shutting previous connection #{@connection}")
+          @connection.close
+          @connection = @connection_options = nil
+        end
+      end
+
       # A Connection instance can be generated and re-generated, given new
       # connection details such as connection port, hostname, credentials, etc.
       # This object is responsible for carrying out the actions on the remote
@@ -165,7 +175,8 @@ module Kitchen
         RESCUE_EXCEPTIONS_ON_ESTABLISH = [
           Errno::EACCES, Errno::EADDRINUSE, Errno::ECONNREFUSED, Errno::ETIMEDOUT,
           Errno::ECONNRESET, Errno::ENETUNREACH, Errno::EHOSTUNREACH,
-          Net::SSH::Disconnect, Net::SSH::AuthenticationFailed, Timeout::Error
+          Net::SSH::Disconnect, Net::SSH::AuthenticationFailed, Net::SSH::ConnectionTimeout,
+          Timeout::Error
         ].freeze
 
         # @return [Integer] how many times to retry when failing to execute
@@ -334,11 +345,7 @@ module Kitchen
       # @return [Ssh::Connection] an SSH Connection instance
       # @api private
       def create_new_connection(options, &block)
-        if @connection
-          logger.debug("[SSH] shutting previous connection #{@connection}")
-          @connection.close
-        end
-
+        cleanup!
         @connection_options = options
         @connection = Kitchen::Transport::Ssh::Connection.new(options, &block)
       end