test-kitchen 1.14.1 → 1.14.2

data/lib/kitchen/provisioner/dummy.rb

@@ -19,9 +19,7 @@
 require "kitchen"
 
 module Kitchen
-
   module Provisioner
-
     # Dummy provisioner for Kitchen. This driver does nothing but report what
     # would happen if this provisioner did anything of consequence. As a result
     # it may be a useful provisioner to use when debugging or developing new
@@ -29,7 +27,6 @@ module Kitchen
     #
     # @author Fletcher Nichol <fnichol@nichol.ca>
     class Dummy < Kitchen::Provisioner::Base
-
       kitchen_provisioner_api_version 2
 
       plugin_version Kitchen::VERSION

data/lib/kitchen/provisioner/shell.rb

@@ -20,21 +20,18 @@ require "kitchen/provisioner/base"
 require "kitchen/version"
 
 module Kitchen
-
   module Provisioner
-
     # Basic shell provisioner.
     #
     # @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)
+        provisioner.calculate_path(src, type: :file)
       end
       expand_path_for :script
 
@@ -56,7 +53,7 @@ module Kitchen
         data = remote_path_join(root, "data")
 
         code = if powershell_shell?
-          Util.outdent!(<<-POWERSHELL)
+                 Util.outdent!(<<-POWERSHELL)
             if (Test-Path "#{data}") {
               Remove-Item "#{data}" -Recurse -Force
             }
@@ -64,9 +61,9 @@ module Kitchen
               New-Item "#{root}" -ItemType directory | Out-Null
             }
           POWERSHELL
-        else
-          "#{sudo("rm")} -rf #{data} ; mkdir -p #{root}"
-        end
+               else
+                 "#{sudo('rm')} -rf #{data} ; mkdir -p #{root}"
+               end
 
         wrap_shell_code(code)
       end
@@ -114,7 +111,7 @@ module Kitchen
         end
 
         FileUtils.chmod(0755,
-          File.join(sandbox_path, File.basename(config[:script])))
+                        File.join(sandbox_path, File.basename(config[:script])))
       end
 
       # Creates a minimal, no-op script in the sandbox path.

data/lib/kitchen/rake_tasks.rb

@@ -21,23 +21,21 @@ require "rake/tasklib"
 require "kitchen"
 
 module Kitchen
-
   # Kitchen Rake task generator.
   #
   # @author Fletcher Nichol <fnichol@nichol.ca>
   class RakeTasks < ::Rake::TaskLib
-
     # Creates Kitchen Rake tasks and allows the callee to configure it.
     #
     # @yield [self] gives itself to the block
     def initialize(cfg = {})
       @loader = Kitchen::Loader::YAML.new(
-        :project_config => ENV["KITCHEN_YAML"],
-        :local_config => ENV["KITCHEN_LOCAL_YAML"],
-        :global_config => ENV["KITCHEN_GLOBAL_YAML"]
+        project_config: ENV["KITCHEN_YAML"],
+        local_config: ENV["KITCHEN_LOCAL_YAML"],
+        global_config: ENV["KITCHEN_GLOBAL_YAML"]
       )
       @config = Kitchen::Config.new(
-        { :loader => @loader }.merge(cfg)
+        { loader: @loader }.merge(cfg)
       )
       Kitchen.logger = Kitchen.default_file_logger(nil, false)
       yield self if block_given?

data/lib/kitchen/shell_out.rb

@@ -19,13 +19,11 @@
 require "mixlib/shellout"
 
 module Kitchen
-
   # Mixin that wraps a command shell out invocation, providing a #run_command
   # method.
   #
   # @author Fletcher Nichol <fnichol@nichol.ca>
   module ShellOut
-
     # Wrapped exception for any interally raised shell out commands.
     class ShellCommandFailed < TransientFailure; end
 
@@ -59,9 +57,9 @@ module Kitchen
     # @raise [Error] for all other unexpected exceptions
     def run_command(cmd, options = {})
       if options.fetch(:use_sudo, false)
-        cmd = "#{options.fetch(:sudo_command, "sudo -E")} #{cmd}"
+        cmd = "#{options.fetch(:sudo_command, 'sudo -E')} #{cmd}"
       end
-      subject = "[#{options.fetch(:log_subject, "local")} command]"
+      subject = "[#{options.fetch(:log_subject, 'local')} command]"
 
       debug("#{subject} BEGIN (#{cmd})")
       sh = Mixlib::ShellOut.new(cmd, shell_opts(options))
@@ -87,7 +85,7 @@ module Kitchen
       filtered_opts = options.reject do |key, _value|
         [:use_sudo, :sudo_command, :log_subject, :quiet].include?(key)
       end
-      { :live_stream => logger, :timeout => 60000 }.merge(filtered_opts)
+      { live_stream: logger, timeout: 60_000 }.merge(filtered_opts)
     end
   end
 end

data/lib/kitchen/ssh.rb

@@ -25,7 +25,6 @@ require "kitchen/errors"
 require "kitchen/login_command"
 
 module Kitchen
-
   # Wrapped exception for any internally raised SSH-related errors.
   #
   # @author Fletcher Nichol <fnichol@nichol.ca>
@@ -36,7 +35,6 @@ module Kitchen
   #
   # @author Fletcher Nichol <fnichol@nichol.ca>
   class SSH
-
     # Constructs a new SSH object.
     #
     # @example basic usage
@@ -94,11 +92,9 @@ module Kitchen
     # @see http://net-ssh.github.io/net-scp/classes/Net/SCP.html#method-i-upload
     def upload!(local, remote, options = {}, &progress)
       if progress.nil?
-        progress = lambda { |_ch, name, sent, total|
-          if sent == total
-            logger.debug("Uploaded #{name} (#{total} bytes)")
-          end
-        }
+        progress = lambda do |_ch, name, sent, total|
+          logger.debug("Uploaded #{name} (#{total} bytes)") if sent == total
+        end
       end
 
       session.scp.upload!(local, remote, options, &progress)
@@ -106,11 +102,11 @@ module Kitchen
 
     def upload(local, remote, options = {}, &progress)
       if progress.nil?
-        progress = lambda { |_ch, name, sent, total|
+        progress = lambda do |_ch, name, sent, total|
           if sent == total
             logger.debug("Async Uploaded #{name} (#{total} bytes)")
           end
-        }
+        end
       end
 
       session.scp.upload(local, remote, options, &progress)
@@ -125,13 +121,13 @@ module Kitchen
     # @option options [true,false] :recursive recursive copy (default: `true`)
     # @see http://net-ssh.github.io/net-scp/classes/Net/SCP.html#method-i-upload
     def upload_path!(local, remote, options = {}, &progress)
-      options = { :recursive => true }.merge(options)
+      options = { recursive: true }.merge(options)
 
       upload!(local, remote, options, &progress)
     end
 
     def upload_path(local, remote, options = {}, &progress)
-      options = { :recursive => true }.merge(options)
+      options = { recursive: true }.merge(options)
       upload(local, remote, options, &progress)
     end
 
@@ -155,16 +151,16 @@ module Kitchen
     #
     # @return [LoginCommand] the login command
     def login_command
-      args  = %W[ -o UserKnownHostsFile=/dev/null ]
-      args += %W[ -o StrictHostKeyChecking=no ]
-      args += %W[ -o IdentitiesOnly=yes ] if options[:keys]
-      args += %W[ -o LogLevel=#{logger.debug? ? "VERBOSE" : "ERROR"} ]
+      args  = %w{ -o UserKnownHostsFile=/dev/null }
+      args += %w{ -o StrictHostKeyChecking=no }
+      args += %w{ -o IdentitiesOnly=yes } if options[:keys]
+      args += %W{ -o LogLevel=#{logger.debug? ? 'VERBOSE' : 'ERROR'} }
       if options.key?(:forward_agent)
-        args += %W[ -o ForwardAgent=#{options[:forward_agent] ? "yes" : "no"} ]
+        args += %W{ -o ForwardAgent=#{options[:forward_agent] ? 'yes' : 'no'} }
       end
-      Array(options[:keys]).each { |ssh_key| args += %W[ -i #{ssh_key} ] }
-      args += %W[ -p #{port} ]
-      args += %W[ #{username}@#{hostname} ]
+      Array(options[:keys]).each { |ssh_key| args += %W{ -i #{ssh_key} } }
+      args += %W{ -p #{port} }
+      args += %W{ #{username}@#{hostname} }
 
       LoginCommand.new("ssh", args)
     end
@@ -175,7 +171,7 @@ module Kitchen
     SOCKET_EXCEPTIONS = [
       SocketError, Errno::ECONNREFUSED, Errno::EHOSTUNREACH,
       Errno::ENETUNREACH, IOError
-    ]
+    ].freeze
 
     # @return [String] the remote hostname
     # @api private
@@ -251,11 +247,9 @@ module Kitchen
     def exec_with_exit(cmd)
       exit_code = nil
       session.open_channel do |channel|
-
         channel.request_pty
 
         channel.exec(cmd) do |_ch, _success|
-
           channel.on_data do |_ch, data|
             logger << data
           end

data/lib/kitchen/state_file.rb

@@ -24,7 +24,6 @@ end
 require "safe_yaml/load"
 
 module Kitchen
-
   # Exception class for any exceptions raised when reading and parsing a state
   # file from disk
   class StateFileLoadError < StandardError; end
@@ -33,7 +32,6 @@ module Kitchen
   #
   # @author Fletcher Nichol <fnichol@nichol.ca>
   class StateFile
-
     # Constructs an new instance taking the kitchen root and instance name.
     #
     # @param kitchen_root [String] path to the Kitchen project's root directory
@@ -54,7 +52,7 @@ module Kitchen
       if File.exist?(file_name) && !File.zero?(file_name)
         Util.symbolized_hash(deserialize_string(read_file))
       else
-        Hash.new
+        {}
       end
     end
 
@@ -65,7 +63,7 @@ module Kitchen
       dir = File.dirname(file_name)
       serialized_string = serialize_hash(Util.stringified_hash(state))
 
-      FileUtils.mkdir_p(dir) if !File.directory?(dir)
+      FileUtils.mkdir_p(dir) unless File.directory?(dir)
       File.open(file_name, "wb") { |f| f.write(serialized_string) }
     end
 
@@ -79,7 +77,7 @@ module Kitchen
     # @return [Hash] a diagnostic hash
     def diagnose
       raw = read
-      result = Hash.new
+      result = {}
       raw.keys.sort.each { |k| result[k] = raw[k] }
       result
     end

data/lib/kitchen/suite.rb

@@ -17,13 +17,11 @@
 # limitations under the License.
 
 module Kitchen
-
   # A logical configuration representing a test case or fixture that will be
   # executed on a platform.
   #
   # @author Fletcher Nichol <fnichol@nichol.ca>
   class Suite
-
     # @return [String] logical name of this suite
     attr_reader :name
 

data/lib/kitchen/thor_tasks.rb

@@ -21,12 +21,10 @@ require "thor"
 require "kitchen"
 
 module Kitchen
-
   # Kitchen Thor task generator.
   #
   # @author Fletcher Nichol <fnichol@nichol.ca>
   class ThorTasks < Thor
-
     namespace :kitchen
 
     # Creates Kitchen Thor tasks and allows the callee to configure it.
@@ -52,14 +50,14 @@ module Kitchen
     def define
       config.instances.each do |instance|
         self.class.desc instance.name, "Run #{instance.name} test instance"
-        self.class.send(:define_method, instance.name.gsub(/-/, "_")) do
+        self.class.send(:define_method, instance.name.tr("-", "_")) do
           instance.test(:always)
         end
       end
 
       self.class.desc "all", "Run all test instances"
       self.class.send(:define_method, :all) do
-        config.instances.each { |i| invoke i.name.gsub(/-/, "_") }
+        config.instances.each { |i| invoke i.name.tr("-", "_") }
       end
     end
   end

data/lib/kitchen/transport.rb

@@ -19,14 +19,12 @@
 require "thor/util"
 
 module Kitchen
-
   # A transport is responsible for the communication with an instance,
   # that is remote comands and other actions such as file transfer,
   # login, etc.
   #
   # @author Salim Afiune <salim@afiunemaya.com.mx>
   module Transport
-
     # Default transport to use
     DEFAULT_PLUGIN = "ssh".freeze
 
@@ -46,9 +44,9 @@ module Kitchen
       object
     rescue LoadError, NameError
       raise ClientError,
-        "Could not load the '#{plugin}' transport from the load path." \
-          " Please ensure that your transport is installed as a gem or" \
-          " included in your Gemfile if using Bundler."
+            "Could not load the '#{plugin}' transport from the load path." \
+              " Please ensure that your transport is installed as a gem or" \
+              " included in your Gemfile if using Bundler."
     end
   end
 end

data/lib/kitchen/transport/base.rb

@@ -22,9 +22,7 @@ require "kitchen/lazy_hash"
 require "kitchen/login_command"
 
 module Kitchen
-
   module Transport
-
     # Wrapped exception for any internally raised Transport errors.
     #
     # @author Salim Afiune <salim@afiunemaya.com.mx>
@@ -42,7 +40,6 @@ module Kitchen
     # @author Salim Afiune <salim@afiunemaya.com.mx>
     # @author Fletcher Nichol <fnichol@nichol.ca>
     class Base
-
       include Configurable
       include Logging
 
@@ -80,7 +77,6 @@ module Kitchen
       #
       # @author Fletcher Nichol <fnichol@nichol.ca>
       class Connection
-
         include Logging
 
         # Create a new Connection instance.
@@ -90,9 +86,7 @@ module Kitchen
         def initialize(options = {})
           init_options(options)
 
-          if block_given?
-            yield self
-          end
+          yield self if block_given?
         end
 
         # Closes the session connection, if it is still active.

data/lib/kitchen/transport/dummy.rb

@@ -19,15 +19,12 @@
 require "kitchen"
 
 module Kitchen
-
   module Transport
-
     # Dummy transport for Kitchen. This transport does nothing but report what would
     # happen if this transport did anything of consequence. As a result it may
     # be a useful transport to use when debugging or developing new features or
     # plugins.
     class Dummy < Kitchen::Transport::Base
-
       kitchen_transport_api_version 1
 
       plugin_version Kitchen::VERSION
@@ -42,7 +39,6 @@ module Kitchen
 
       # TODO: comment
       class Connection < Kitchen::Transport::Base::Connection
-
         # (see Base#execute)
         def execute(command)
           report(:execute, command)

data/lib/kitchen/transport/ssh.rb

@@ -25,9 +25,7 @@ require "timeout"
 require "benchmark"
 
 module Kitchen
-
   module Transport
-
     # Wrapped exception for any internally raised SSH-related errors.
     #
     # @author Fletcher Nichol <fnichol@nichol.ca>
@@ -38,7 +36,6 @@ module Kitchen
     #
     # @author Fletcher Nichol <fnichol@nichol.ca>
     class Ssh < Kitchen::Transport::Base
-
       kitchen_transport_api_version 1
 
       plugin_version Kitchen::VERSION
@@ -110,7 +107,6 @@ module Kitchen
       #
       # @author Fletcher Nichol <fnichol@nichol.ca>
       class Connection < Kitchen::Transport::Base::Connection
-
         # (see Base::Connection#close)
         def close
           return if @session.nil?
@@ -139,21 +135,21 @@ module Kitchen
 
         # (see Base::Connection#login_command)
         def login_command
-          args  = %W[ -o UserKnownHostsFile=/dev/null ]
-          args += %W[ -o StrictHostKeyChecking=no ]
-          args += %W[ -o IdentitiesOnly=yes ] if options[:keys]
-          args += %W[ -o LogLevel=#{logger.debug? ? "VERBOSE" : "ERROR"} ]
+          args  = %w{ -o UserKnownHostsFile=/dev/null }
+          args += %w{ -o StrictHostKeyChecking=no }
+          args += %w{ -o IdentitiesOnly=yes } if options[:keys]
+          args += %W{ -o LogLevel=#{logger.debug? ? 'VERBOSE' : 'ERROR'} }
           if options.key?(:forward_agent)
-            args += %W[ -o ForwardAgent=#{options[:forward_agent] ? "yes" : "no"} ]
+            args += %W{ -o ForwardAgent=#{options[:forward_agent] ? 'yes' : 'no'} }
           end
           if ssh_gateway
             gateway_command = "ssh -q #{ssh_gateway_username}@#{ssh_gateway} nc #{hostname} #{port}"
             # Should support other ports than 22 for ssh gateways
-            args += %W[ -o ProxyCommand=#{gateway_command} -p 22 ]
+            args += %W{ -o ProxyCommand=#{gateway_command} -p 22 }
           end
-          Array(options[:keys]).each { |ssh_key| args += %W[ -i #{ssh_key} ] }
-          args += %W[ -p #{port} ]
-          args += %W[ #{username}@#{hostname} ]
+          Array(options[:keys]).each { |ssh_key| args += %W{ -i #{ssh_key} } }
+          args += %W{ -p #{port} }
+          args += %W{ #{username}@#{hostname} }
 
           LoginCommand.new("ssh", args)
         end
@@ -164,7 +160,7 @@ module Kitchen
           elapsed = Benchmark.measure do
             waits = []
             Array(locals).map do |local|
-              opts = File.directory?(local) ? { :recursive => true } : {}
+              opts = File.directory?(local) ? { recursive: true } : {}
 
               waits.push session.scp.upload(local, remote, opts) do |_ch, name, sent, total|
                 logger.debug("Async Uploaded #{name} (#{total} bytes)") if sent == total
@@ -183,9 +179,9 @@ module Kitchen
         def wait_until_ready
           delay = 3
           session(
-            :retries  => max_wait_until_ready / delay,
-            :delay    => delay,
-            :message  => "Waiting for SSH service on #{hostname}:#{port}, " \
+            retries: max_wait_until_ready / delay,
+            delay: delay,
+            message: "Waiting for SSH service on #{hostname}:#{port}, " \
               "retrying in #{delay} seconds"
           )
           execute(PING_COMMAND.dup)
@@ -258,7 +254,7 @@ module Kitchen
         def establish_connection_via_gateway(opts)
           retry_connection(opts) do
             Net::SSH::Gateway.new(ssh_gateway,
-              ssh_gateway_username, options).ssh(hostname, username, options)
+                                  ssh_gateway_username, options).ssh(hostname, username, options)
           end
         end
 
@@ -298,12 +294,12 @@ module Kitchen
         rescue *RESCUE_EXCEPTIONS_ON_ESTABLISH => e
           if (opts[:retries] -= 1) > 0
             message = if opts[:message]
-              logger.debug("[SSH] connection failed (#{e.inspect})")
-              opts[:message]
-            else
-              "[SSH] connection failed, retrying in #{opts[:delay]} seconds " \
-                "(#{e.inspect})"
-            end
+                        logger.debug("[SSH] connection failed (#{e.inspect})")
+                        opts[:message]
+                      else
+                        "[SSH] connection failed, retrying in #{opts[:delay]} seconds " \
+                          "(#{e.inspect})"
+                      end
             logger.info(message)
             sleep(opts[:delay])
             retry
@@ -321,11 +317,9 @@ module Kitchen
         def execute_with_exit_code(command)
           exit_code = nil
           session.open_channel do |channel|
-
             channel.request_pty
 
             channel.exec(command) do |_ch, _success|
-
               channel.on_data do |_ch, data|
                 logger << data
               end
@@ -366,13 +360,13 @@ module Kitchen
         def session(retry_options = {})
           if ssh_gateway
             @session ||= establish_connection_via_gateway({
-              :retries => connection_retries.to_i,
-              :delay   => connection_retry_sleep.to_i
+              retries: connection_retries.to_i,
+              delay: connection_retry_sleep.to_i,
             }.merge(retry_options))
           else
             @session ||= establish_connection({
-              :retries => connection_retries.to_i,
-              :delay   => connection_retry_sleep.to_i
+              retries: connection_retries.to_i,
+              delay: connection_retry_sleep.to_i,
             }.merge(retry_options))
           end
         end
@@ -397,23 +391,23 @@ module Kitchen
       # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
       def connection_options(data)
         opts = {
-          :logger                 => logger,
-          :user_known_hosts_file  => "/dev/null",
-          :paranoid               => false,
-          :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],
-          :connection_retries     => data[:connection_retries],
-          :connection_retry_sleep => data[:connection_retry_sleep],
-          :max_ssh_sessions       => data[:max_ssh_sessions],
-          :max_wait_until_ready   => data[:max_wait_until_ready],
-          :ssh_gateway            => data[:ssh_gateway],
-          :ssh_gateway_username   => data[:ssh_gateway_username]
+          logger: logger,
+          user_known_hosts_file: "/dev/null",
+          paranoid: false,
+          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],
+          connection_retries: data[:connection_retries],
+          connection_retry_sleep: data[:connection_retry_sleep],
+          max_ssh_sessions: data[:max_ssh_sessions],
+          max_wait_until_ready: data[:max_wait_until_ready],
+          ssh_gateway: data[:ssh_gateway],
+          ssh_gateway_username: data[:ssh_gateway_username],
         }
 
         if data[:ssh_key] && !data[:password]