test-kitchen 1.4.0.beta.2 → 1.4.0.rc.1

data/lib/kitchen/provisioner/chef_solo.rb

@@ -27,6 +27,10 @@ module Kitchen
     # @author Fletcher Nichol <fnichol@nichol.ca>
     class ChefSolo < ChefBase
 
+      kitchen_provisioner_api_version 2
+
+      plugin_version Kitchen::VERSION
+
       default_config :solo_rb, {}
 
       default_config :chef_solo_path do |provisioner|

data/lib/kitchen/provisioner/chef_zero.rb

@@ -27,6 +27,10 @@ module Kitchen
     # @author Fletcher Nichol <fnichol@nichol.ca>
     class ChefZero < ChefBase
 
+      kitchen_provisioner_api_version 2
+
+      plugin_version Kitchen::VERSION
+
       default_config :client_rb, {}
       default_config :json_attributes, true
       default_config :chef_zero_host, nil
@@ -162,7 +166,7 @@ module Kitchen
         version = config[:require_chef_omnibus]
 
         case version
-        when nil, false, true, "latest"
+        when nil, false, true, 11, "11", "latest"
           true
         else
           Gem::Version.new(version) >= Gem::Version.new("11.8.0") ? true : false

data/lib/kitchen/provisioner/dummy.rb

@@ -30,6 +30,10 @@ module Kitchen
     # @author Fletcher Nichol <fnichol@nichol.ca>
     class Dummy < Kitchen::Provisioner::Base
 
+      kitchen_provisioner_api_version 2
+
+      plugin_version Kitchen::VERSION
+
       default_config :sleep, 0
       default_config :random_failure, false
 

data/lib/kitchen/provisioner/shell.rb

@@ -17,6 +17,7 @@
 # limitations under the License.
 
 require "kitchen/provisioner/base"
+require "kitchen/version"
 
 module Kitchen
 
@@ -27,6 +28,10 @@ module Kitchen
     # @author Chris Lundquist (<chris.ludnquist@github.com>)
     class Shell < Base
 
+      kitchen_provisioner_api_version 2
+
+      plugin_version Kitchen::VERSION
+
       default_config :script do |provisioner|
         src = provisioner.powershell_shell? ? "bootstrap.ps1" : "bootstrap.sh"
         provisioner.calculate_path(src, :type => :file)

data/lib/kitchen/shell_out.rb

@@ -35,6 +35,8 @@ module Kitchen
     # @param options [Hash] additional configuration of command
     # @option options [TrueClass, FalseClass] :use_sudo whether or not to use
     #   sudo
+    # @option options [String] :sudo_command custom sudo command to use.
+    #   Default is "sudo -E".
     # @option options [String] :log_subject used in the output or log header
     #   for clarity and context. Default is "local".
     # @option options [String] :cwd the directory to chdir to before running
@@ -56,7 +58,9 @@ module Kitchen
     # @raise [ShellCommandFailed] if the command fails
     # @raise [Error] for all other unexpected exceptions
     def run_command(cmd, options = {})
-      cmd = "sudo -E #{cmd}" if options.fetch(:use_sudo, false)
+      if options.fetch(:use_sudo, false)
+        cmd = "#{options.fetch(:sudo_command, "sudo -E")} #{cmd}"
+      end
       subject = "[#{options.fetch(:log_subject, "local")} command]"
 
       debug("#{subject} BEGIN (#{cmd})")
@@ -81,7 +85,7 @@ module Kitchen
     # @api private
     def shell_opts(options)
       filtered_opts = options.reject do |key, _value|
-        [:use_sudo, :log_subject, :quiet].include?(key)
+        [:use_sudo, :sudo_command, :log_subject, :quiet].include?(key)
       end
       { :live_stream => logger, :timeout => 60000 }.merge(filtered_opts)
     end

data/lib/kitchen/transport/base.rb

@@ -141,6 +141,31 @@ module Kitchen
           @logger = @options.delete(:logger) || Kitchen.logger
         end
       end
+
+      # Sets the API version for this transport. If the transport does not set
+      # this value, then `nil` will be used and reported.
+      #
+      # Sets the API version for this transport
+      #
+      # @example setting an API version
+      #
+      #   module Kitchen
+      #     module Transport
+      #       class NewTransport < Kitchen::Transport::Base
+      #
+      #         kitchen_transport_api_version 2
+      #
+      #       end
+      #     end
+      #   end
+      #
+      # @param version [Integer,String] a version number
+      #
+      # rubocop:disable Style/TrivialAccessors
+      def self.kitchen_transport_api_version(version)
+        @api_version = version
+      end
+      # rubocop:enable Style/TrivialAccessors
     end
   end
 end

data/lib/kitchen/transport/dummy.rb

@@ -28,6 +28,10 @@ module Kitchen
     # plugins.
     class Dummy < Kitchen::Transport::Base
 
+      kitchen_transport_api_version 1
+
+      plugin_version Kitchen::VERSION
+
       default_config :sleep, 1
       default_config :random_exit_code, 0
 

data/lib/kitchen/transport/ssh.rb

@@ -36,6 +36,10 @@ module Kitchen
     # @author Fletcher Nichol <fnichol@nichol.ca>
     class Ssh < Kitchen::Transport::Base
 
+      kitchen_transport_api_version 1
+
+      plugin_version Kitchen::VERSION
+
       default_config :port, 22
       default_config :username, "root"
       default_config :keepalive, true
@@ -45,6 +49,21 @@ module Kitchen
       default_config :connection_retry_sleep, 1
       default_config :max_wait_until_ready, 600
 
+      default_config :ssh_key, nil
+      expand_path_for :ssh_key
+
+      default_config :compression, "zlib"
+      required_config :compression do |attr, value, transport|
+        if !%W[zlib none].include?(value)
+          raise UserError, "#{transport} :#{attr} value may only " \
+            "be set to `none' or `zlib'."
+        end
+      end
+
+      default_config :compression_level do |transport|
+        transport[:compression] == "none" ? 0 : 6
+      end
+
       # (see Base#connection)
       def connection(state, &block)
         options = connection_options(config.to_hash.merge(state))
@@ -271,7 +290,7 @@ module Kitchen
       # @param data [Hash] merged configuration and mutable state data
       # @return [Hash] hash of connection options
       # @api private
-      def connection_options(data)
+      def connection_options(data) # rubocop:disable Metrics/MethodLength
         opts = {
           :logger                 => logger,
           :user_known_hosts_file  => "/dev/null",
@@ -279,6 +298,8 @@ module Kitchen
           :hostname               => data[:hostname],
           :port                   => data[:port],
           :username               => data[:username],
+          :compression            => data[:compression],
+          :compression_level      => data[:compression_level],
           :keepalive              => data[:keepalive],
           :keepalive_interval     => data[:keepalive_interval],
           :timeout                => data[:connection_timeout],

data/lib/kitchen/transport/winrm.rb

@@ -18,21 +18,10 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-def silence_warnings
-  old_verbose, $VERBOSE = $VERBOSE, nil
-  yield
-ensure
-  $VERBOSE = old_verbose
-end
-
-silence_warnings { require "winrm" }
-
 require "rbconfig"
 require "uri"
 
 require "kitchen"
-require "kitchen/transport/winrm/command_executor"
-require "kitchen/transport/winrm/file_transporter"
 
 module Kitchen
 
@@ -50,6 +39,10 @@ module Kitchen
     # @author Fletcher Nichol <fnichol@nichol.ca>
     class Winrm < Kitchen::Transport::Base
 
+      kitchen_transport_api_version 1
+
+      plugin_version Kitchen::VERSION
+
       default_config :port, 5985
       default_config :username, ".\\administrator"
       default_config :password, nil
@@ -86,7 +79,6 @@ module Kitchen
           logger.debug("[WinRM] closing remote shell #{shell_id} on #{self}")
           session.close
           logger.debug("[WinRM] remote shell #{shell_id} closed")
-          remove_finalizer
         ensure
           @session = nil
         end
@@ -142,12 +134,14 @@ module Kitchen
 
         PING_COMMAND = "Write-Host '[WinRM] Established\n'".freeze
 
-        RESCUE_EXCEPTIONS_ON_ESTABLISH = [
-          Errno::EACCES, Errno::EADDRINUSE, Errno::ECONNREFUSED,
-          Errno::ECONNRESET, Errno::ENETUNREACH, Errno::EHOSTUNREACH,
-          ::WinRM::WinRMHTTPTransportError, ::WinRM::WinRMAuthorizationError,
-          HTTPClient::KeepAliveDisconnected
-        ].freeze
+        RESCUE_EXCEPTIONS_ON_ESTABLISH = lambda do
+          [
+            Errno::EACCES, Errno::EADDRINUSE, Errno::ECONNREFUSED,
+            Errno::ECONNRESET, Errno::ENETUNREACH, Errno::EHOSTUNREACH,
+            ::WinRM::WinRMHTTPTransportError, ::WinRM::WinRMAuthorizationError,
+            HTTPClient::KeepAliveDisconnected
+          ].freeze
+        end
 
         # @return [Integer] how many times to retry when failing to execute
         #   a command or transfer files
@@ -186,26 +180,6 @@ module Kitchen
         # @api private
         attr_reader :winrm_transport
 
-        # Creates a finalizer for this connection which will close the open
-        # remote shell session when the object is garabage collected or on
-        # Ruby VM shutdown.
-        #
-        # @param shell_id [String] the remote shell identifier
-        # @api private
-        def add_finalizer(shell_id)
-          ObjectSpace.define_finalizer(
-            self,
-            ShellCloser.new(
-              logger.debug?,
-              shell_id,
-              "#{self}",
-              endpoint,
-              winrm_transport,
-              options
-            )
-          )
-        end
-
         # Writes an RDP document to the local file system.
         #
         # @param opts [Hash] file options
@@ -242,15 +216,15 @@ module Kitchen
         # @return [Winrm::CommandExecutor] the command executor session
         # @api private
         def establish_shell(opts)
-          @service = ::WinRM::WinRMWebService.new(
-            endpoint, winrm_transport, options)
+          service_args = [endpoint, winrm_transport, options]
+          @service = ::WinRM::WinRMWebService.new(*service_args)
+          closer = WinRM::Transport::ShellCloser.new("#{self}", logger.debug?, service_args)
 
-          executor = Winrm::CommandExecutor.new(@service, logger)
+          executor = WinRM::Transport::CommandExecutor.new(@service, logger, closer)
           retryable(opts) do
             logger.debug("[WinRM] opening remote shell on #{self}")
             shell_id = executor.open
             logger.debug("[WinRM] remote shell #{shell_id} is open on #{self}")
-            add_finalizer(shell_id)
           end
           executor
         end
@@ -273,7 +247,7 @@ module Kitchen
         # @return [Winrm::FileTransporter] a file transporter
         # @api private
         def file_transporter
-          @file_transporter ||= Winrm::FileTransporter.new(session, logger)
+          @file_transporter ||= WinRM::Transport::FileTransporter.new(session, logger)
         end
 
         # (see Base#init_options)
@@ -348,13 +322,6 @@ module Kitchen
           File.join(kitchen_root, ".kitchen", "#{instance_name}.rdp")
         end
 
-        # Removes any finalizers for this connection.
-        #
-        # @api private
-        def remove_finalizer
-          ObjectSpace.undefine_finalizer(self)
-        end
-
         # Yields to a block and reties the block if certain rescuable
         # exceptions are raised.
         #
@@ -369,7 +336,7 @@ module Kitchen
         # @api private
         def retryable(opts)
           yield
-        rescue *RESCUE_EXCEPTIONS_ON_ESTABLISH => e
+        rescue *RESCUE_EXCEPTIONS_ON_ESTABLISH.call => e
           if (opts[:retries] -= 1) > 0
             message = if opts[:message]
               logger.debug("[WinRM] connection failed (#{e.inspect})")
@@ -411,6 +378,8 @@ module Kitchen
 
       private
 
+      WINRM_TRANSPORT_SPEC_VERSION = "~> 1.0".freeze
+
       # Builds the hash of options needed by the Connection object on
       # construction.
       #
@@ -453,6 +422,42 @@ module Kitchen
         @connection = Kitchen::Transport::Winrm::Connection.new(options, &block)
       end
 
+      # (see Base#load_needed_dependencies!)
+      def load_needed_dependencies! # rubocop:disable Metrics/MethodLength
+        super
+        spec_version = WINRM_TRANSPORT_SPEC_VERSION.dup
+        logger.debug("Winrm Transport requested," \
+          " loading WinRM::Transport gem (#{spec_version})")
+        gem "winrm-transport", spec_version
+        first_load = require "winrm/transport/version"
+        load_winrm_transport!
+
+        version = ::WinRM::Transport::VERSION
+        if first_load
+          logger.debug("WinRM::Transport #{version} library loaded")
+        else
+          logger.debug("WinRM::Transport #{version} previously loaded")
+        end
+      rescue LoadError => e
+        logger.fatal("The `winrm-transport' gem is missing and must" \
+          " be installed or cannot be properly activated. Run" \
+          " `gem install winrm-transport --version '#{spec_version}'`" \
+          " or add the following to your Gemfile if you are using Bundler:" \
+          " `gem 'winrm-transport', '#{spec_version}'`.")
+        raise UserError,
+          "Could not load or activate WinRM::Transport (#{e.message})"
+      end
+
+      # Load WinRM::Transport code.
+      #
+      # @api private
+      def load_winrm_transport!
+        silence_warnings { require "winrm" }
+        require "winrm/transport/shell_closer"
+        require "winrm/transport/command_executor"
+        require "winrm/transport/file_transporter"
+      end
+
       # Return the last saved WinRM connection instance.
       #
       # @return [Winrm::Connection] a WinRM Connection instance
@@ -463,45 +468,11 @@ module Kitchen
         @connection
       end
 
-      # An object that can close a remote shell session over WinRM.
-      #
-      # @author Fletcher Nichol <fnichol@nichol.ca>
-      # @api private
-      class ShellCloser
-
-        # Constructs a new ShellCloser.
-        #
-        # @param debug [true,false] whether or not debug messages should be
-        #   output
-        # @param shell_id [String] the indentifier for the current open remote
-        #   shell session
-        # @param info [String] a string representation of the connection
-        # @param args [Array] arguments to construct a `WinRM::WinRMWebService`
-        def initialize(debug, shell_id, info, *args)
-          @debug = debug
-          @shell_id = shell_id
-          @info = info
-          @args = args
-        end
-
-        # Closes the remote shell session.
-        def call(*)
-          debug("[WinRM] closing remote shell #{@shell_id} on #{@info}")
-          ::WinRM::WinRMWebService.new(*@args).close_shell(@shell_id)
-          debug("[WinRM] remote shell #{@shell_id} closed")
-        rescue => e
-          debug("Exception: #{e.inspect}")
-        end
-
-        private
-
-        # Writes a debug message, if debug mode is enabled.
-        #
-        # @param message [String] a message
-        # @api private
-        def debug(message)
-          $stdout.puts "D      #{message}" if @debug
-        end
+      def silence_warnings
+        old_verbose, $VERBOSE = $VERBOSE, nil
+        yield
+      ensure
+        $VERBOSE = old_verbose
       end
     end
   end

data/lib/kitchen/verifier/base.rb

@@ -44,6 +44,10 @@ module Kitchen
         verifier.windows_os? ? nil : true
       end
 
+      default_config :sudo_command do |verifier|
+        verifier.windows_os? ? nil : "sudo -E"
+      end
+
       default_config(:suite_name) { |busser| busser.instance.suite.name }
 
       # Creates a new Verifier object using the provided configuration data
@@ -158,6 +162,31 @@ module Kitchen
           "trying to access the path.")
       end
 
+      # Sets the API version for this verifier. If the verifier does not set
+      # this value, then `nil` will be used and reported.
+      #
+      # Sets the API version for this verifier
+      #
+      # @example setting an API version
+      #
+      #   module Kitchen
+      #     module Verifier
+      #       class NewVerifier < Kitchen::Verifier::Base
+      #
+      #         kitchen_verifier_api_version 2
+      #
+      #       end
+      #     end
+      #   end
+      #
+      # @param version [Integer,String] a version number
+      #
+      # rubocop:disable Style/TrivialAccessors
+      def self.kitchen_verifier_api_version(version)
+        @api_version = version
+      end
+      # rubocop:enable Style/TrivialAccessors
+
       private
 
       # Builds a complete command given a variables String preamble and a file
@@ -184,7 +213,7 @@ module Kitchen
       # @return [String] the command, conditionaly prefixed with sudo
       # @api private
       def sudo(script)
-        config[:sudo] ? "sudo -E #{script}" : script
+        config[:sudo] ? "#{config[:sudo_command]} #{script}" : script
       end
     end
   end