test-kitchen 1.14.1 → 1.14.2

data/lib/kitchen/provisioner/chef/librarian.rb

@@ -20,17 +20,13 @@ require "kitchen/errors"
 require "kitchen/logging"
 
 module Kitchen
-
   module Provisioner
-
     module Chef
-
       # Chef cookbook resolver that uses Librarian-Chef and a Cheffile to
       # calculate dependencies.
       #
       # @author Fletcher Nichol <fnichol@nichol.ca>
       class Librarian
-
         include Logging
 
         # Creates a new cookbook resolver.
@@ -62,7 +58,7 @@ module Kitchen
           debug("Using Cheffile from #{cheffile}")
 
           env = ::Librarian::Chef::Environment.new(
-            :project_path => File.dirname(cheffile))
+            project_path: File.dirname(cheffile))
           env.config_db.local["path"] = path
           ::Librarian::Action::Resolve.new(env).run
           ::Librarian::Action::Install.new(env).run
@@ -104,7 +100,7 @@ module Kitchen
             " `gem install librarian-chef` or add the following to your" \
             " Gemfile if you are using Bundler: `gem 'librarian-chef'`.")
           raise UserError,
-            "Could not load or activate Librarian-Chef (#{e.message})"
+                "Could not load or activate Librarian-Chef (#{e.message})"
         end
       end
     end

data/lib/kitchen/provisioner/chef/policyfile.rb

@@ -24,16 +24,12 @@ require "kitchen/logging"
 require "kitchen/shell_out"
 
 module Kitchen
-
   module Provisioner
-
     module Chef
-
       # Chef cookbook resolver that uses Policyfiles to calculate dependencies.
       #
       # @author Fletcher Nichol <fnichol@nichol.ca>
       class Policyfile
-
         include Logging
         include ShellOut
 
@@ -113,15 +109,15 @@ module Kitchen
         # @raise [UserError] if the `chef` command is not in the PATH
         # @api private
         def self.detect_chef_command!(logger)
-          unless ENV["PATH"].split(File::PATH_SEPARATOR).any? { |p|
+          unless ENV["PATH"].split(File::PATH_SEPARATOR).any? do |p|
             File.exist?(File.join(p, "chef"))
-          }
+          end
             logger.fatal("The `chef` executable cannot be found in your " \
                          "PATH. Ensure you have installed ChefDK from " \
                          "https://downloads.chef.io and that your PATH " \
                          "setting includes the path to the `chef` comand.")
             raise UserError,
-              "Could not find the chef executable in your PATH."
+                  "Could not find the chef executable in your PATH."
           end
         end
 
@@ -139,7 +135,7 @@ module Kitchen
             # Windows command line parsing libraries. This covers the 99% case of
             # spaces in the path without breaking other stuff.
             if path =~ /[ \t\n\v"]/
-              "\"#{path.gsub(/[ \t\n\v\"\\]/) { |m| "\\" + m[0] }}\""
+              "\"#{path.gsub(/[ \t\n\v\"\\]/) { |m| '\\' + m[0] }}\""
             else
               path
             end

data/lib/kitchen/provisioner/chef_apply.rb

@@ -48,22 +48,19 @@
 require "kitchen/provisioner/chef_base"
 
 module Kitchen
-
   module Provisioner
-
     # Chef Apply provisioner.
     #
     # @author SAWANOBORI Yukihiko <sawanoboriyu@higanworks.com>)
     class ChefApply < ChefBase
-
       kitchen_provisioner_api_version 2
 
       plugin_version Kitchen::VERSION
 
       default_config :chef_apply_path do |provisioner|
-        provisioner.
-          remote_path_join(%W[#{provisioner[:chef_omnibus_root]} bin chef-apply]).
-          tap { |path| path.concat(".bat") if provisioner.windows_os? }
+        provisioner
+          .remote_path_join(%W{#{provisioner[:chef_omnibus_root]} bin chef-apply})
+          .tap { |path| path.concat(".bat") if provisioner.windows_os? }
       end
 
       default_config :apply_path do |provisioner|
@@ -84,15 +81,15 @@ module Kitchen
 
       # (see ChefBase#init_command)
       def init_command
-        dirs = %w[
+        dirs = %w{
           apply
-        ].sort.map { |dir| remote_path_join(config[:root_path], dir) }
+        }.sort.map { |dir| remote_path_join(config[:root_path], dir) }
 
         vars = if powershell_shell?
-          init_command_vars_for_powershell(dirs)
-        else
-          init_command_vars_for_bourne(dirs)
-        end
+                 init_command_vars_for_powershell(dirs)
+               else
+                 init_command_vars_for_bourne(dirs)
+               end
 
         prefix_command(shell_code_from_file(vars, "chef_base_init_command"))
       end
@@ -102,18 +99,18 @@ module Kitchen
         level = config[:log_level]
         lines = []
         config[:run_list].map do |recipe|
-          cmd = sudo(config[:chef_apply_path]).dup.
-            tap { |str| str.insert(0, "& ") if powershell_shell? }
+          cmd = sudo(config[:chef_apply_path]).dup
+                                              .tap { |str| str.insert(0, "& ") if powershell_shell? }
           args = [
             "apply/#{recipe}.rb",
             "--log_level #{level}",
-            "--no-color"
+            "--no-color",
           ]
           args << "--logfile #{config[:log_file]}" if config[:log_file]
 
           lines << wrap_shell_code(
-            [cmd, *args].join(" ").
-            tap { |str| str.insert(0, reload_ps1_path) if windows_os? }
+            [cmd, *args].join(" ")
+            .tap { |str| str.insert(0, reload_ps1_path) if windows_os? }
           )
         end
 

data/lib/kitchen/provisioner/chef_base.rb

@@ -37,14 +37,11 @@ rescue LoadError # rubocop:disable Lint/HandleExceptions
 end
 
 module Kitchen
-
   module Provisioner
-
     # Common implementation details for Chef-related provisioners.
     #
     # @author Fletcher Nichol <fnichol@nichol.ca>
     class ChefBase < Base
-
       default_config :require_chef_omnibus, true
       default_config :chef_omnibus_url, "https://omnitruck.chef.io/install.sh"
       default_config :chef_omnibus_install_options, nil
@@ -62,11 +59,11 @@ module Kitchen
       # If set to true (which is the default from `chef generate`), try to update
       # backend cookbook downloader on every kitchen run.
       default_config :always_update_cookbooks, false
-      default_config :cookbook_files_glob, %w[
+      default_config :cookbook_files_glob, %w(
         README.* metadata.{json,rb}
         attributes/**/* definitions/**/* files/**/* libraries/**/*
         providers/**/* recipes/**/* resources/**/* templates/**/*
-      ].join(",")
+      ).join(",")
       # to ease upgrades, allow the user to turn deprecation warnings into errors
       default_config :deprecations_as_errors, false
 
@@ -101,7 +98,7 @@ module Kitchen
       expand_path_for :clients_path
 
       default_config :encrypted_data_bag_secret_key_path do |provisioner|
-        provisioner.calculate_path("encrypted_data_bag_secret_key", :type => :file)
+        provisioner.calculate_path("encrypted_data_bag_secret_key", type: :file)
       end
       expand_path_for :encrypted_data_bag_secret_key_path
 
@@ -131,16 +128,16 @@ module Kitchen
 
       # (see Base#init_command)
       def init_command
-        dirs = %w[
+        dirs = %w{
           cookbooks data data_bags environments roles clients
           encrypted_data_bag_secret
-        ].sort.map { |dir| remote_path_join(config[:root_path], dir) }
+        }.sort.map { |dir| remote_path_join(config[:root_path], dir) }
 
         vars = if powershell_shell?
-          init_command_vars_for_powershell(dirs)
-        else
-          init_command_vars_for_bourne(dirs)
-        end
+                 init_command_vars_for_powershell(dirs)
+               else
+                 init_command_vars_for_bourne(dirs)
+               end
 
         prefix_command(shell_code_from_file(vars, "chef_base_init_command"))
       end
@@ -159,10 +156,10 @@ module Kitchen
         add_omnibus_directory_option if instance.driver.cache_directory
         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],
-          :sudo_command => sudo_command
+          omnibus_url: config[:chef_omnibus_url],
+          project: project.nil? ? nil : project[1],
+          install_flags: config[:chef_omnibus_install_options],
+          sudo_command: sudo_command,
         }.tap do |opts|
           opts[:root] = config[:chef_omnibus_root] if config.key? :chef_omnibus_root
           [:install_msi_url, :http_proxy, :https_proxy].each do |key|
@@ -215,27 +212,27 @@ module Kitchen
         root = config[:root_path].gsub("$env:TEMP", "\#{ENV['TEMP']\}")
 
         {
-          :node_name        => instance.name,
-          :checksum_path    => remote_path_join(root, "checksums"),
-          :file_cache_path  => remote_path_join(root, "cache"),
-          :file_backup_path => remote_path_join(root, "backup"),
-          :cookbook_path    => [
+          node_name: instance.name,
+          checksum_path: remote_path_join(root, "checksums"),
+          file_cache_path: remote_path_join(root, "cache"),
+          file_backup_path: remote_path_join(root, "backup"),
+          cookbook_path: [
             remote_path_join(root, "cookbooks"),
-            remote_path_join(root, "site-cookbooks")
+            remote_path_join(root, "site-cookbooks"),
           ],
-          :data_bag_path    => remote_path_join(root, "data_bags"),
-          :environment_path => remote_path_join(root, "environments"),
-          :node_path        => remote_path_join(root, "nodes"),
-          :role_path        => remote_path_join(root, "roles"),
-          :client_path      => remote_path_join(root, "clients"),
-          :user_path        => remote_path_join(root, "users"),
-          :validation_key   => remote_path_join(root, "validation.pem"),
-          :client_key       => remote_path_join(root, "client.pem"),
-          :chef_server_url  => "http://127.0.0.1:8889",
-          :encrypted_data_bag_secret => remote_path_join(
+          data_bag_path: remote_path_join(root, "data_bags"),
+          environment_path: remote_path_join(root, "environments"),
+          node_path: remote_path_join(root, "nodes"),
+          role_path: remote_path_join(root, "roles"),
+          client_path: remote_path_join(root, "clients"),
+          user_path: remote_path_join(root, "users"),
+          validation_key: remote_path_join(root, "validation.pem"),
+          client_key: remote_path_join(root, "client.pem"),
+          chef_server_url: "http://127.0.0.1:8889",
+          encrypted_data_bag_secret: remote_path_join(
             root, "encrypted_data_bag_secret"
           ),
-          :treat_deprecation_warnings_as_errors => config[:deprecations_as_errors]
+          treat_deprecation_warnings_as_errors: config[:deprecations_as_errors],
         }
       end
 
@@ -246,9 +243,9 @@ module Kitchen
       # @return [String] a rendered Chef config file as a String
       # @api private
       def format_config_file(data)
-        data.each.map { |attr, value|
+        data.each.map do |attr, value|
           [attr, format_value(value)].join(" ")
-        }.join("\n")
+        end.join("\n")
       end
 
       # Converts a Ruby object to a String interpretation suitable for writing
@@ -261,9 +258,9 @@ module Kitchen
         if obj.is_a?(String) && obj =~ /^:/
           obj
         elsif obj.is_a?(String)
-          %{"#{obj.gsub(/\\/, "\\\\\\\\")}"}
+          %{"#{obj.gsub(/\\/, '\\\\\\\\')}"}
         elsif obj.is_a?(Array)
-          %{[#{obj.map { |i| format_value(i) }.join(", ")}]}
+          %{[#{obj.map { |i| format_value(i) }.join(', ')}]}
         else
           obj.inspect
         end
@@ -278,7 +275,7 @@ module Kitchen
         [
           shell_var("sudo_rm", sudo("rm")),
           shell_var("dirs", dirs.join(" ")),
-          shell_var("root_path", config[:root_path])
+          shell_var("root_path", config[:root_path]),
         ].join("\n")
       end
 
@@ -289,8 +286,8 @@ module Kitchen
       # @api private
       def init_command_vars_for_powershell(dirs)
         [
-          %{$dirs = @(#{dirs.map { |d| %{"#{d}"} }.join(", ")})},
-          shell_var("root_path", config[:root_path])
+          %{$dirs = @(#{dirs.map { |d| %{"#{d}"} }.join(', ')})},
+          shell_var("root_path", config[:root_path]),
         ].join("\n")
       end
 
@@ -301,13 +298,13 @@ module Kitchen
         super
         if File.exist?(policyfile)
           debug("Policyfile found at #{policyfile}, using Policyfile to resolve dependencies")
-          Chef::Policyfile.load!(:logger => logger)
+          Chef::Policyfile.load!(logger: logger)
         elsif File.exist?(berksfile)
           debug("Berksfile found at #{berksfile}, loading Berkshelf")
-          Chef::Berkshelf.load!(:logger => logger)
+          Chef::Berkshelf.load!(logger: logger)
         elsif File.exist?(cheffile)
           debug("Cheffile found at #{cheffile}, loading Librarian-Chef")
-          Chef::Librarian.load!(:logger => logger)
+          Chef::Librarian.load!(logger: logger)
         end
       end
 
@@ -327,9 +324,9 @@ module Kitchen
       # @api private
       def script_for_product
         installer = Mixlib::Install.new({
-          :product_name => config[:product_name],
-          :product_version => config[:product_version],
-          :channel => (config[:channel] || :stable).to_sym
+          product_name: config[:product_name],
+          product_version: config[:product_version],
+          channel: (config[:channel] || :stable).to_sym,
         }.tap do |opts|
           opts[:shell_type] = :ps1 if powershell_shell?
           [:platform, :platform_version, :architecture].each do |key|

data/lib/kitchen/provisioner/chef_solo.rb

@@ -19,14 +19,11 @@
 require "kitchen/provisioner/chef_base"
 
 module Kitchen
-
   module Provisioner
-
     # Chef Solo provisioner.
     #
     # @author Fletcher Nichol <fnichol@nichol.ca>
     class ChefSolo < ChefBase
-
       kitchen_provisioner_api_version 2
 
       plugin_version Kitchen::VERSION
@@ -34,9 +31,9 @@ module Kitchen
       default_config :solo_rb, {}
 
       default_config :chef_solo_path do |provisioner|
-        provisioner.
-          remote_path_join(%W[#{provisioner[:chef_omnibus_root]} bin chef-solo]).
-          tap { |path| path.concat(".bat") if provisioner.windows_os? }
+        provisioner
+          .remote_path_join(%W{#{provisioner[:chef_omnibus_root]} bin chef-solo})
+          .tap { |path| path.concat(".bat") if provisioner.windows_os? }
       end
 
       # (see Base#create_sandbox)
@@ -64,13 +61,13 @@ module Kitchen
       # rubocop:disable Metrics/PerceivedComplexity, Metrics/CyclomaticComplexity, Metrics/AbcSize
       def run_command
         config[:log_level] = "info" if !modern? && config[:log_level] = "auto"
-        cmd = sudo(config[:chef_solo_path]).dup.
-          tap { |str| str.insert(0, "& ") if powershell_shell? }
+        cmd = sudo(config[:chef_solo_path]).dup
+                                           .tap { |str| str.insert(0, "& ") if powershell_shell? }
         args = [
-          "--config #{remote_path_join(config[:root_path], "solo.rb")}",
+          "--config #{remote_path_join(config[:root_path], 'solo.rb')}",
           "--log_level #{config[:log_level]}",
           "--no-color",
-          "--json-attributes #{remote_path_join(config[:root_path], "dna.json")}"
+          "--json-attributes #{remote_path_join(config[:root_path], 'dna.json')}",
         ]
         args << " --force-formatter" if modern?
         args << "--logfile #{config[:log_file]}" if config[:log_file]
@@ -79,10 +76,10 @@ module Kitchen
 
         prefix_command(
           wrap_shell_code(
-            [cmd, *args].join(" ").
-            tap { |str| str.insert(0, reload_ps1_path) if windows_os? }
+            [cmd, *args].join(" ")
+            .tap { |str| str.insert(0, reload_ps1_path) if windows_os? }
+          )
         )
-      )
       end
 
       private

data/lib/kitchen/provisioner/chef_zero.rb

@@ -19,14 +19,11 @@
 require "kitchen/provisioner/chef_base"
 
 module Kitchen
-
   module Provisioner
-
     # Chef Zero provisioner.
     #
     # @author Fletcher Nichol <fnichol@nichol.ca>
     class ChefZero < ChefBase
-
       kitchen_provisioner_api_version 2
 
       plugin_version Kitchen::VERSION
@@ -38,14 +35,14 @@ module Kitchen
       default_config :chef_zero_port, 8889
 
       default_config :chef_client_path do |provisioner|
-        provisioner.
-          remote_path_join(%W[#{provisioner[:chef_omnibus_root]} bin chef-client]).
-          tap { |path| path.concat(".bat") if provisioner.windows_os? }
+        provisioner
+          .remote_path_join(%W{#{provisioner[:chef_omnibus_root]} bin chef-client})
+          .tap { |path| path.concat(".bat") if provisioner.windows_os? }
       end
 
       default_config :ruby_bindir do |provisioner|
-        provisioner.
-          remote_path_join(%W[#{provisioner[:chef_omnibus_root]} embedded bin])
+        provisioner
+          .remote_path_join(%W{#{provisioner[:chef_omnibus_root]} embedded bin})
       end
 
       # (see Base#create_sandbox)
@@ -60,11 +57,11 @@ module Kitchen
       def prepare_command
         return if modern?
 
-        gem_bin = remote_path_join(config[:ruby_bindir], "gem").
-          tap { |path| path.concat(".bat") if windows_os? }
+        gem_bin = remote_path_join(config[:ruby_bindir], "gem")
+                  .tap { |path| path.concat(".bat") if windows_os? }
         vars = [
           chef_client_zero_env,
-          shell_var("gem", sudo(gem_bin))
+          shell_var("gem", sudo(gem_bin)),
         ].join("\n").concat("\n")
 
         prefix_command(shell_code_from_file(vars, "chef_zero_prepare_command_legacy"))
@@ -76,8 +73,8 @@ module Kitchen
 
         prefix_command(
           wrap_shell_code(
-            [cmd, *chef_client_args, last_exit_code].join(" ").
-            tap { |str| str.insert(0, reload_ps1_path) if windows_os? }
+            [cmd, *chef_client_args, last_exit_code].join(" ")
+            .tap { |str| str.insert(0, reload_ps1_path) if windows_os? }
           )
         )
       end
@@ -99,9 +96,7 @@ module Kitchen
           json = remote_path_join(config[:root_path], "dna.json")
           args << "--json-attributes #{json}"
         end
-        if config[:log_file]
-          args << "--logfile #{config[:log_file]}"
-        end
+        args << "--logfile #{config[:log_file]}" if config[:log_file]
         return unless modern?
 
         # these flags are modern/chef-client local most only and will not work
@@ -112,9 +107,7 @@ module Kitchen
         if config[:chef_zero_port]
           args << "--chef-zero-port #{config[:chef_zero_port]}"
         end
-        if config[:profile_ruby]
-          args << "--profile-ruby"
-        end
+        args << "--profile-ruby" if config[:profile_ruby]
       end
       # rubocop:enable Metrics/CyclomaticComplexity
 
@@ -125,10 +118,10 @@ module Kitchen
       def chef_client_args
         level = config[:log_level]
         args = [
-          "--config #{remote_path_join(config[:root_path], "client.rb")}",
+          "--config #{remote_path_join(config[:root_path], 'client.rb')}",
           "--log_level #{level}",
           "--force-formatter",
-          "--no-color"
+          "--no-color",
         ]
         add_optional_chef_client_args!(args)
 
@@ -149,7 +142,7 @@ module Kitchen
           shell_env_var("CHEF_REPO_PATH", root),
           shell_env_var("GEM_HOME", gem_home),
           shell_env_var("GEM_PATH", gem_path),
-          shell_env_var("GEM_CACHE", gem_cache)
+          shell_env_var("GEM_CACHE", gem_cache),
         ].join("\n").concat("\n")
       end
 
@@ -159,8 +152,8 @@ module Kitchen
       # @return [String] the command string
       # @api private
       def local_mode_command
-        "#{sudo(config[:chef_client_path])} --local-mode".
-          tap { |str| str.insert(0, "& ") if powershell_shell? }
+        "#{sudo(config[:chef_client_path])} --local-mode"
+          .tap { |str| str.insert(0, "& ") if powershell_shell? }
       end
 
       # Determines whether or not local mode (a.k.a chef zero mode) is
@@ -203,7 +196,7 @@ module Kitchen
         debug("Using a vendored chef-client-zero.rb")
 
         source = File.join(File.dirname(__FILE__),
-          %w[.. .. .. support chef-client-zero.rb])
+                           %w{.. .. .. support chef-client-zero.rb})
         FileUtils.cp(source, File.join(sandbox_path, "chef-client-zero.rb"))
       end
 
@@ -212,7 +205,7 @@ module Kitchen
       # @api private
       def prepare_client_rb
         data = default_config_rb.merge(config[:client_rb])
-        data = data.merge(:named_run_list => config[:named_run_list]) if config[:named_run_list]
+        data = data.merge(named_run_list: config[:named_run_list]) if config[:named_run_list]
 
         info("Preparing client.rb")
         debug("Creating client.rb from #{data.inspect}")
@@ -230,7 +223,7 @@ module Kitchen
         debug("Using a dummy validation.pem")
 
         source = File.join(File.dirname(__FILE__),
-          %w[.. .. .. support dummy-validation.pem])
+                           %w{.. .. .. support dummy-validation.pem})
         FileUtils.cp(source, File.join(sandbox_path, "validation.pem"))
       end
 
@@ -240,8 +233,8 @@ module Kitchen
       # @return [String] the command string
       # @api private
       def shim_command
-        ruby = remote_path_join(config[:ruby_bindir], "ruby").
-          tap { |path| path.concat(".exe") if windows_os? }
+        ruby = remote_path_join(config[:ruby_bindir], "ruby")
+               .tap { |path| path.concat(".exe") if windows_os? }
         shim = remote_path_join(config[:root_path], "chef-client-zero.rb")
 
         "#{chef_client_zero_env}\n#{sudo(ruby)} #{shim}"