test-kitchen 1.4.2 → 1.5.0.rc.1

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,6 +43,7 @@ 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 :cookbook_files_glob, %w[
         README.* metadata.{json,rb}
@@ -47,18 +51,6 @@ module Kitchen
         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 +86,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 +120,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 +129,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"
 
-        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 +257,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 +271,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.
@@ -60,10 +60,12 @@ module Kitchen
         ]
         args << "--logfile #{config[:log_file]}" if config[:log_file]
 
-        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
 
@@ -111,7 +113,7 @@ module Kitchen
       # @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/transport/winrm.rb

@@ -87,6 +87,10 @@ module Kitchen
         def execute(command)
           return if command.nil?
           logger.debug("[WinRM] #{self} (#{command})")
+
+          if command.length > MAX_COMMAND_SIZE
+            command = run_from_file_command(command)
+          end
           exit_code, stderr = execute_with_exit_code(command)
 
           if logger.debug? && exit_code == 0
@@ -134,6 +138,11 @@ module Kitchen
 
         PING_COMMAND = "Write-Host '[WinRM] Established\n'".freeze
 
+        # Maximum string to send to the transport to execute. WinRM has an 8000 character
+        # command line limit. The original command string is coverted to a base 64 encoded
+        # UTF-16 string which will double the string size.
+        MAX_COMMAND_SIZE = 3000
+
         RESCUE_EXCEPTIONS_ON_ESTABLISH = lambda do
           [
             Errno::EACCES, Errno::EADDRINUSE, Errno::ECONNREFUSED,
@@ -375,11 +384,36 @@ module Kitchen
         def to_s
           "#{winrm_transport}::#{endpoint}<#{options.inspect}>"
         end
+
+        # takes a long (greater than 3000 characters) command and saves it to a
+        # file and uploads it to the test instance.
+        #
+        # @param command [String] a long command to be saved and uploaded
+        # @return [String] a command that executes the uploaded script
+        # @api private
+        def run_from_file_command(command)
+          temp_dir = Dir.mktmpdir("kitchen-long-script")
+          begin
+            script_name = "#{instance_name}-long_script.ps1"
+            script_path = File.join(temp_dir, script_name)
+
+            File.open(script_path, "wb") do |file|
+              file.write(command)
+            end
+
+            target_path = File.join("$env:TEMP", "kitchen")
+            upload(script_path, target_path)
+
+            %{& "#{File.join(target_path, script_name)}"}
+          ensure
+            FileUtils.rmtree(temp_dir)
+          end
+        end
       end
 
       private
 
-      WINRM_TRANSPORT_SPEC_VERSION = "~> 1.0".freeze
+      WINRM_TRANSPORT_SPEC_VERSION = ["~> 1.0", ">= 1.0.3"].freeze
 
       # Builds the hash of options needed by the Connection object on
       # construction.
@@ -429,7 +463,7 @@ module Kitchen
         spec_version = WINRM_TRANSPORT_SPEC_VERSION.dup
         logger.debug("Winrm Transport requested," \
           " loading WinRM::Transport gem (#{spec_version})")
-        gem "winrm-transport", spec_version
+        gem "winrm-transport", *spec_version
         first_load = require "winrm/transport/version"
         load_winrm_transport!
 

data/lib/kitchen/verifier/base.rb

@@ -33,8 +33,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 |verifier|
         verifier.windows_os? ? "$env:TEMP\\verifier" : "/tmp/verifier"
@@ -44,10 +44,14 @@ module Kitchen
         verifier.windows_os? ? nil : true
       end
 
+      default_config :chef_omnibus_root, "/opt/chef"
+
       default_config :sudo_command do |verifier|
         verifier.windows_os? ? nil : "sudo -E"
       end
 
+      default_config :command_prefix, nil
+
       default_config(:suite_name) { |busser| busser.instance.suite.name }
 
       # Creates a new Verifier object using the provided configuration data
@@ -213,6 +217,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/verifier/busser.rb

@@ -46,7 +46,7 @@ module Kitchen
         if verifier.windows_os?
           "$env:systemdrive\\opscode\\chef\\embedded\\bin"
         else
-          "/opt/chef/embedded/bin"
+          verifier.remote_path_join(%W[#{verifier[:chef_omnibus_root]} embedded bin])
         end
       end
 
@@ -76,7 +76,7 @@ module Kitchen
         cmd = sudo(config[:busser_bin]).dup.
           tap { |str| str.insert(0, "& ") if powershell_shell? }
 
-        wrap_shell_code(Util.outdent!(<<-CMD))
+        prefix_command(wrap_shell_code(Util.outdent!(<<-CMD)))
           #{busser_env}
 
           #{cmd} suite cleanup
@@ -89,7 +89,7 @@ module Kitchen
 
         vars = install_command_vars
 
-        shell_code_from_file(vars, "busser_install_command")
+        prefix_command(shell_code_from_file(vars, "busser_install_command"))
       end
 
       # (see Base#run_command)
@@ -99,7 +99,7 @@ module Kitchen
         cmd = sudo(config[:busser_bin]).dup.
           tap { |str| str.insert(0, "& ") if powershell_shell? }
 
-        wrap_shell_code(Util.outdent!(<<-CMD))
+        prefix_command(wrap_shell_code(Util.outdent!(<<-CMD)))
           #{busser_env}
 
           #{cmd} test
@@ -173,9 +173,16 @@ module Kitchen
         gem, version = config[:version].split("@")
         gem, version = "busser", gem if gem =~ /^\d+\.\d+\.\d+/
 
+        root = config[:root_path]
+        gem_bin = remote_path_join(root, "bin")
+
+        # We don't want the gems to be installed in the home directory,
+        # this will force the bindir and the gem install location both
+        # to be under /tmp/verifier
         args = gem
         args += " --version #{version}" if version
-        args += " --no-rdoc --no-ri"
+        args += " --no-rdoc --no-ri --no-format-executable -n #{gem_bin}"
+        args += " --no-user-install"
         args
       end