test-kitchen 1.14.1 → 1.14.2

data/lib/kitchen/driver/base.rb

@@ -19,14 +19,11 @@
 require "kitchen/lazy_hash"
 
 module Kitchen
-
   module Driver
-
     # Base class for a driver.
     #
     # @author Fletcher Nichol <fnichol@nichol.ca>
     class Base
-
       include Configurable
       include Logging
 

data/lib/kitchen/driver/dummy.rb

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

data/lib/kitchen/driver/proxy.rb

@@ -22,9 +22,7 @@ require "kitchen"
 require "kitchen/version"
 
 module Kitchen
-
   module Driver
-
     # Simple driver that proxies commands through to a test instance whose
     # lifecycle is not managed by Test Kitchen. This driver is useful for long-
     # lived non-ephemeral test instances that are simply "reset" between test
@@ -33,7 +31,6 @@ module Kitchen
     #
     # @author Seth Chisamore <schisamo@opscode.com>
     class Proxy < Kitchen::Driver::SSHBase
-
       plugin_version Kitchen::VERSION
 
       required_config :host

data/lib/kitchen/driver/ssh_base.rb

@@ -22,9 +22,7 @@ require "kitchen/lazy_hash"
 require "benchmark"
 
 module Kitchen
-
   module Driver
-
     # Legacy base class for a driver that uses SSH to communication with an
     # instance. This class has been updated to use the Instance's Transport to
     # issue commands and transfer files and no longer uses the `Kitchen:SSH`
@@ -46,7 +44,6 @@ module Kitchen
     #   Drivers. When legacy Driver::SSHBase support is removed, this class
     #   will no longer be available.
     class SSHBase
-
       include ShellOut
       include Configurable
       include Logging
@@ -138,8 +135,8 @@ module Kitchen
 
       # (see Base#login_command)
       def login_command(state)
-        instance.transport.connection(backcompat_merged_state(state)).
-          login_command
+        instance.transport.connection(backcompat_merged_state(state))
+                .login_command
       end
 
       # Executes an arbitrary command on an instance over an SSH connection.
@@ -160,7 +157,7 @@ module Kitchen
       # @deprecated This method should no longer be called directly and exists
       #   to support very old drivers. This will be removed in the future.
       def ssh(ssh_args, command)
-        pseudo_state = { :hostname => ssh_args[0], :username => ssh_args[1] }
+        pseudo_state = { hostname: ssh_args[0], username: ssh_args[1] }
         pseudo_state.merge!(ssh_args[2])
         connection_state = backcompat_merged_state(pseudo_state)
 
@@ -226,9 +223,9 @@ module Kitchen
       private
 
       def backcompat_merged_state(state)
-        driver_ssh_keys = %w[
+        driver_ssh_keys = %w{
           forward_agent hostname password port ssh_key username
-        ].map(&:to_sym)
+        }.map(&:to_sym)
         config.select { |key, _| driver_ssh_keys.include?(key) }.rmerge(state)
       end
 
@@ -240,7 +237,7 @@ module Kitchen
       def build_ssh_args(state)
         combined = config.to_hash.merge(state)
 
-        opts = Hash.new
+        opts = {}
         opts[:user_known_hosts_file] = "/dev/null"
         opts[:paranoid] = false
         opts[:keys_only] = true if combined[:ssh_key]
@@ -272,8 +269,8 @@ module Kitchen
         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["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
@@ -335,12 +332,12 @@ module Kitchen
       # @param options [Hash] configuration hash (default: `{}`)
       # @api private
       def wait_for_sshd(hostname, username = nil, options = {})
-        pseudo_state = { :hostname => hostname }
+        pseudo_state = { hostname: hostname }
         pseudo_state[:username] = username if username
         pseudo_state.merge!(options)
 
-        instance.transport.connection(backcompat_merged_state(pseudo_state)).
-          wait_until_ready
+        instance.transport.connection(backcompat_merged_state(pseudo_state))
+                .wait_until_ready
       end
 
       # Intercepts any bare #puts calls in subclasses and issues an INFO log
@@ -370,8 +367,8 @@ module Kitchen
       # @see ShellOut#run_command
       def run_command(cmd, options = {})
         base_options = {
-          :use_sudo => config[:use_sudo],
-          :log_subject => Thor::Util.snake_case(self.class.to_s)
+          use_sudo: config[:use_sudo],
+          log_subject: Thor::Util.snake_case(self.class.to_s),
         }.merge(options)
         super(cmd, base_options)
       end

data/lib/kitchen/errors.rb

@@ -19,12 +19,10 @@
 require "English"
 
 module Kitchen
-
   # All Kitchen errors and exceptions.
   #
   # @author Fletcher Nichol <fnichol@nichol.ca>
   module Error
-
     # Creates an array of strings, representing a formatted exception,
     # containing backtrace and nested exception info as necessary, that can
     # be viewed by a human.
@@ -49,15 +47,15 @@ module Kitchen
 
       if exception.respond_to?(:original) && exception.original
         arr += if exception.original.is_a? Array
-          exception.original.map do |composite_exception|
-            formatted_trace(composite_exception, "Composite Exception").flatten
-          end
-        else
-          [
-            formatted_exception(exception.original, "Nested Exception"),
-            formatted_backtrace(exception)
-          ].flatten
-        end
+                 exception.original.map do |composite_exception|
+                   formatted_trace(composite_exception, "Composite Exception").flatten
+                 end
+               else
+                 [
+                   formatted_exception(exception.original, "Nested Exception"),
+                   formatted_backtrace(exception),
+                 ].flatten
+               end
       end
       arr.flatten
     end
@@ -69,7 +67,7 @@ module Kitchen
         [
           "Backtrace".center(22, "-"),
           exception.backtrace,
-          "End Backtrace".center(22, "-")
+          "End Backtrace".center(22, "-"),
         ]
       end
     end
@@ -94,7 +92,7 @@ module Kitchen
         title.center(22, "-"),
         "Class: #{exception.class}",
         "Message: #{exception.message}",
-        "".center(22, "-")
+        "".center(22, "-"),
       ]
     end
   end
@@ -102,7 +100,6 @@ module Kitchen
   # Base exception class from which all Kitchen exceptions derive. This class
   # nests an exception when this class is re-raised from a rescue block.
   class StandardError < ::StandardError
-
     include Error
 
     # @return [::StandardError] the original (wrapped) exception
@@ -184,8 +181,6 @@ module Kitchen
     exit 20
   end
 
-  private
-
   # Writes an array of lines to the common Kitchen logger's file device at the
   # given severity level. If the Kitchen logger is set to debug severity, then
   # the array of lines will also be written to the console output.

data/lib/kitchen/generator/driver_create.rb

@@ -20,22 +20,19 @@ require "thor/group"
 require "thor/util"
 
 module Kitchen
-
   module Generator
-
     # A generator to create a new Kitchen Driver gem project.
     #
     # @author Fletcher Nichol <fnichol@nichol.ca>
     class DriverCreate < Thor::Group
-
       include Thor::Actions
 
-      argument :name, :type => :string
+      argument :name, type: :string
 
       class_option :license,
-        :aliases => "-l",
-        :default => "apachev2",
-        :desc => "License type for gem (apachev2, mit, lgplv3, reserved)"
+                   aliases: "-l",
+                   default: "apachev2",
+                   desc: "License type for gem (apachev2, mit, lgplv3, reserved)"
 
       # Invoke the command.
       def create
@@ -87,8 +84,8 @@ module Kitchen
       # @api private
       def initialize_git
         inside(target_dir) do
-          run("git init", :capture => true)
-          run("git add .", :capture => true)
+          run("git init", capture: true)
+          run("git add .", capture: true)
         end
       end
 
@@ -112,16 +109,16 @@ module Kitchen
       # @api private
       def config
         @config ||= {
-          :name => name,
-          :gem_name => "kitchen-#{name}",
-          :gemspec => "kitchen-#{name}.gemspec",
-          :klass_name => ::Thor::Util.camel_case(name),
-          :constant_name => ::Thor::Util.snake_case(name).upcase,
-          :author => author,
-          :email => email,
-          :license => options[:license],
-          :license_string => license_string,
-          :year => Time.now.year
+          name: name,
+          gem_name: "kitchen-#{name}",
+          gemspec: "kitchen-#{name}.gemspec",
+          klass_name: ::Thor::Util.camel_case(name),
+          constant_name: ::Thor::Util.snake_case(name).upcase,
+          author: author,
+          email: email,
+          license: options[:license],
+          license_string: license_string,
+          year: Time.now.year,
         }
       end
 
@@ -169,8 +166,8 @@ module Kitchen
       # @return [String] the license comment/preamble
       # @api private
       def license_comment
-        @license_comment ||= IO.read(File.join(target_dir, license_filename)).
-          gsub(/^/, "# ").gsub(/\s+$/, "")
+        @license_comment ||= IO.read(File.join(target_dir, license_filename))
+                               .gsub(/^/, "# ").gsub(/\s+$/, "")
       end
     end
   end

data/lib/kitchen/generator/init.rb

@@ -20,38 +20,35 @@ require "rubygems/gem_runner"
 require "thor/group"
 
 module Kitchen
-
   module Generator
-
     # A project initialization generator, to help prepare a cookbook project
     # for testing with Kitchen.
     #
     # @author Fletcher Nichol <fnichol@nichol.ca>
     class Init < Thor::Group
-
       include Thor::Actions
 
       class_option :driver,
-        :type => :array,
-        :aliases => "-D",
-        :default => %w[kitchen-vagrant],
-        :desc => <<-D.gsub(/^\s+/, "").gsub(/\n/, " ")
+                   type: :array,
+                   aliases: "-D",
+                   default: %w{kitchen-vagrant},
+                   desc: <<-D.gsub(/^\s+/, "").tr("\n", " ")
           One or more Kitchen Driver gems to be installed or added to a
           Gemfile
         D
 
       class_option :provisioner,
-        :type => :string,
-        :aliases => "-P",
-        :default => "chef_solo",
-        :desc => <<-D.gsub(/^\s+/, "").gsub(/\n/, " ")
+                   type: :string,
+                   aliases: "-P",
+                   default: "chef_solo",
+                   desc: <<-D.gsub(/^\s+/, "").tr("\n", " ")
           The default Kitchen Provisioner to use
         D
 
       class_option :create_gemfile,
-        :type => :boolean,
-        :default => false,
-        :desc => <<-D.gsub(/^\s+/, "").gsub(/\n/, " ")
+                   type: :boolean,
+                   default: false,
+                   desc: <<-D.gsub(/^\s+/, "").tr("\n", " ")
           Whether or not to create a Gemfile if one does not exist.
           Default: false
         D
@@ -78,18 +75,16 @@ module Kitchen
       # @api private
       def create_kitchen_yaml
         cookbook_name = if File.exist?(File.expand_path("metadata.rb"))
-          MetadataChopper.extract("metadata.rb").first
-        else
-          nil
-        end
+                          MetadataChopper.extract("metadata.rb").first
+                        end
         run_list = cookbook_name ? "recipe[#{cookbook_name}::default]" : nil
         driver_plugin = Array(options[:driver]).first || "dummy"
 
         template("kitchen.yml.erb", ".kitchen.yml",
-          :driver_plugin => driver_plugin.sub(/^kitchen-/, ""),
-          :provisioner => options[:provisioner],
-          :run_list => Array(run_list)
-        )
+                 driver_plugin: driver_plugin.sub(/^kitchen-/, ""),
+                 provisioner: options[:provisioner],
+                 run_list: Array(run_list)
+                )
       end
 
       # Creates the `chefignore` file.
@@ -193,7 +188,7 @@ module Kitchen
       def append_to_gitignore(line)
         create_file(".gitignore") unless File.exist?(File.join(destination_root, ".gitignore"))
 
-        if IO.readlines(File.join(destination_root, ".gitignore")).grep(%r{^#{line}}).empty?
+        if IO.readlines(File.join(destination_root, ".gitignore")).grep(/^#{line}/).empty?
           append_to_file(".gitignore", "#{line}\n")
         end
       end
@@ -221,7 +216,7 @@ module Kitchen
       #
       # @api private
       def add_gem_to_gemfile
-        if not_in_file?("Gemfile", %r{gem ('|")test-kitchen('|")})
+        if not_in_file?("Gemfile", /gem ('|")test-kitchen('|")/)
           append_to_file("Gemfile", %{gem "test-kitchen"\n})
           @display_bundle_msg = true
         end
@@ -246,7 +241,7 @@ module Kitchen
       #
       # @api private
       def add_driver_to_gemfile(driver_gem)
-        if not_in_file?("Gemfile", %r{gem ('|")#{driver_gem}('|")})
+        if not_in_file?("Gemfile", /gem ('|")#{driver_gem}('|")/)
           append_to_file("Gemfile", %{gem "#{driver_gem}"\n})
           @display_bundle_msg = true
         end
@@ -285,7 +280,7 @@ module Kitchen
       #
       # @api private
       def unbundlerize
-        keys = ENV.keys.select { |key| key =~ /^BUNDLER?_/ } + %w[RUBYOPT]
+        keys = ENV.keys.select { |key| key =~ /^BUNDLER?_/ } + %w{RUBYOPT}
 
         keys.each { |key| ENV["__#{key}"] = ENV[key]; ENV.delete(key) }
         yield

data/lib/kitchen/instance.rb

@@ -20,18 +20,15 @@ require "benchmark"
 require "fileutils"
 
 module Kitchen
-
   # An instance of a suite running on a platform. A created instance may be a
   # local virtual machine, cloud instance, container, or even a bare metal
   # server, which is determined by the platform's driver.
   #
   # @author Fletcher Nichol <fnichol@nichol.ca>
   class Instance
-
     include Logging
 
     class << self
-
       # @return [Hash] a hash of mutxes, arranged by Driver class names
       # @api private
       attr_accessor :mutexes
@@ -42,7 +39,7 @@ module Kitchen
       # @param platform [Platform,#name] a Platform
       # @return [String] a normalized, consistent name for an instance
       def name_for(suite, platform)
-        "#{suite.name}-#{platform.name}".gsub(%r{[_,/]}, "-").gsub(/\./, "")
+        "#{suite.name}-#{platform.name}".gsub(%r{[_,/]}, "-").delete(".")
       end
     end
 
@@ -210,12 +207,12 @@ module Kitchen
       end
 
       lc = if legacy_ssh_base_driver?
-        legacy_ssh_base_login(state)
-      else
-        transport.connection(state).login_command
-      end
+             legacy_ssh_base_login(state)
+           else
+             transport.connection(state).login_command
+           end
 
-      debug(%{Login command: #{lc.command} #{lc.arguments.join(" ")} } \
+      debug(%{Login command: #{lc.command} #{lc.arguments.join(' ')} } \
         "(Options: #{lc.options})")
       Kernel.exec(*lc.exec_args)
     end
@@ -240,7 +237,7 @@ module Kitchen
     #
     # @return [Hash] a diagnostic hash
     def diagnose
-      result = Hash.new
+      result = {}
       [
         :platform, :state_file, :driver, :provisioner, :transport, :verifier
       ].each do |sym|
@@ -255,14 +252,14 @@ module Kitchen
     #
     # @return [Hash] a diagnostic hash
     def diagnose_plugins
-      result = Hash.new
+      result = {}
       [:driver, :provisioner, :verifier, :transport].each do |sym|
         obj = send(sym)
         result[sym] = if obj.respond_to?(:diagnose_plugin)
-          obj.diagnose_plugin
-        else
-          :unknown
-        end
+                        obj.diagnose_plugin
+                      else
+                        :unknown
+                      end
       end
       result
     end
@@ -321,7 +318,7 @@ module Kitchen
 
       if driver.class.serial_actions
         Kitchen.mutex.synchronize do
-          self.class.mutexes ||= Hash.new
+          self.class.mutexes ||= {}
           self.class.mutexes[driver.class] = Mutex.new
         end
       end
@@ -499,12 +496,12 @@ module Kitchen
       state[:last_error] = e.class.name
       raise(InstanceFailure, failure_message(what) +
         "  Please see .kitchen/logs/#{name}.log for more details",
-        e.backtrace)
+            e.backtrace)
     rescue Exception => e # rubocop:disable Lint/RescueException
       log_failure(what, e)
       state[:last_error] = e.class.name
       raise ActionFailed,
-        "Failed to complete ##{what} action: [#{e.message}]", e.backtrace
+            "Failed to complete ##{what} action: [#{e.message}]", e.backtrace
     ensure
       state_file.write(state)
     end
@@ -519,15 +516,15 @@ module Kitchen
     # @param state [Hash] a mutable state hash for this instance
     # @param block [Proc] a block to be called
     # @api private
-    def synchronize_or_call(what, state, &block)
+    def synchronize_or_call(what, state)
       if Array(driver.class.serial_actions).include?(what)
         debug("#{to_str} is synchronizing on #{driver.class}##{what}")
         self.class.mutexes[driver.class].synchronize do
           debug("#{to_str} is messaging #{driver.class}##{what}")
-          block.call(state)
+          yield(state)
         end
       else
-        block.call(state)
+        yield(state)
       end
     end
 
@@ -639,7 +636,6 @@ module Kitchen
     # @api private
     # @author Fletcher Nichol <fnichol@nichol.ca>
     class FSM
-
       # Returns an Array of all transitions to bring an Instance from its last
       # reported transistioned state into the desired transitioned state.
       #
@@ -660,7 +656,7 @@ module Kitchen
         end
       end
 
-      TRANSITIONS = [:destroy, :create, :converge, :setup, :verify]
+      TRANSITIONS = [:destroy, :create, :converge, :setup, :verify].freeze
 
       # Determines the index of a state in the state lifecycle vector. Woah.
       #