chef 16.0.257 → 16.2.44

data/lib/chef/knife/bootstrap/chef_vault_handler.rb

@@ -102,7 +102,7 @@ class Chef
           config[:bootstrap_vault_item]
         end
 
-        # Helper to return a ruby object represeting all the data bags and items
+        # Helper to return a ruby object representing all the data bags and items
         # to update via chef-vault.
         #
         # @return [Hash] deserialized ruby hash with all the vault items

data/lib/chef/knife/bootstrap/client_builder.rb

@@ -86,7 +86,7 @@ class Chef
           config[:chef_node_name]
         end
 
-        # @return [String] enviroment from the config
+        # @return [String] environment from the config
         def environment
           config[:environment]
         end

data/lib/chef/knife/bootstrap/templates/chef-full.erb

@@ -185,50 +185,50 @@ if test "x$tmp_dir" != "x"; then
   rm -r "$tmp_dir"
 fi
 
-mkdir -p <%= ChefConfig::Config.etc_chef_dir(false) %>
+mkdir -p /etc/chef
 
 <% if client_pem -%>
-(umask 077 && (cat > <%= ChefConfig::Config.etc_chef_dir(false) %>/client.pem <<'EOP'
+(umask 077 && (cat > /etc/chef/client.pem <<'EOP'
 <%= ::File.read(::File.expand_path(client_pem)) %>
 EOP
 )) || exit 1
 <% end -%>
 
 <% if validation_key -%>
-(umask 077 && (cat > <%= ChefConfig::Config.etc_chef_dir(false) %>/validation.pem <<'EOP'
+(umask 077 && (cat > /etc/chef/validation.pem <<'EOP'
 <%= validation_key %>
 EOP
 )) || exit 1
 <% end -%>
 
 <% if encrypted_data_bag_secret -%>
-(umask 077 && (cat > <%= ChefConfig::Config.etc_chef_dir(false) %>/encrypted_data_bag_secret <<'EOP'
+(umask 077 && (cat > /etc/chef/encrypted_data_bag_secret <<'EOP'
 <%= encrypted_data_bag_secret %>
 EOP
 )) || exit 1
 <% end -%>
 
 <% unless trusted_certs.empty? -%>
-mkdir -p <%= ChefConfig::Config.etc_chef_dir(false) %>/trusted_certs
+mkdir -p /etc/chef/trusted_certs
 <%= trusted_certs %>
 <% end -%>
 
 <%# Generate Ohai Hints -%>
 <% unless @config[:hints].nil? || @config[:hints].empty? -%>
-mkdir -p <%= ChefConfig::Config.etc_chef_dir(false) %>/ohai/hints
+mkdir -p /etc/chef/ohai/hints
 
 <% @config[:hints].each do |name, hash| -%>
-cat > <%= ChefConfig::Config.etc_chef_dir(false) %>/ohai/hints/<%= name %>.json <<'EOP'
+cat > /etc/chef/ohai/hints/<%= name %>.json <<'EOP'
 <%= Chef::JSONCompat.to_json(hash) %>
 EOP
 <% end -%>
 <% end -%>
 
-cat > <%= ChefConfig::Config.etc_chef_dir(false) %>/client.rb <<'EOP'
+cat > /etc/chef/client.rb <<'EOP'
 <%= config_content %>
 EOP
 
-cat > <%= ChefConfig::Config.etc_chef_dir(false) %>/first-boot.json <<'EOP'
+cat > /etc/chef/first-boot.json <<'EOP'
 <%= Chef::JSONCompat.to_json(first_boot) %>
 EOP
 

data/lib/chef/knife/bootstrap/templates/windows-chef-client-msi.erb

@@ -202,10 +202,12 @@ If !ERRORLEVEL!==0 (
   ) else (
       @echo Installation completed successfully
       del /f /q "%CHEF_CLIENT_MSI_LOG_PATH%"
-    )
+  )
 
 <% end %>
 
+@rem This line is required to separate the key_create label from the "block boundary"
+@rem Removing these lines will cause the error "The system cannot find the batch label specified - key_create"
 :key_create
 @endlocal
 

data/lib/chef/knife/client_bulk_delete.rb

@@ -44,7 +44,7 @@ class Chef
         clients_to_delete = {}
         validators_to_delete = {}
         all_clients.each do |name, client|
-          next unless name =~ matcher
+          next unless name&.match?(matcher)
 
           if client.validator
             validators_to_delete[client.name] = client

data/lib/chef/knife/config_get.rb

@@ -75,7 +75,7 @@ class Chef
               # It's a regex.
               filter_re = Regexp.new($1, $2 ? Regexp::IGNORECASE : 0)
               config_data.each do |key, value|
-                output_data[key] = value if key.to_s =~ filter_re
+                output_data[key] = value if key.to_s&.match?(filter_re)
               end
             else
               # It's a dotted path string.

data/lib/chef/knife/cookbook_delete.rb

@@ -89,7 +89,7 @@ class Chef
           url_and_version["versions"].map { |url_by_version| url_by_version["version"] }
         end.flatten
       rescue Net::HTTPClientException => e
-        if e.to_s =~ /^404/
+        if /^404/.match?(e.to_s)
           ui.error("Cannot find a cookbook named #{@cookbook_name} to delete.")
           nil
         else

data/lib/chef/knife/core/cookbook_scm_repo.rb

@@ -58,7 +58,7 @@ class Chef
           exit 1
         end
         cmd = git("status --porcelain")
-        if cmd.stdout =~ DIRTY_REPO
+        if DIRTY_REPO.match?(cmd.stdout)
           ui.error "You have uncommitted changes to your cookbook repo (#{repo_path}):"
           ui.msg cmd.stdout
           ui.info "Commit or stash your changes before importing cookbooks"

data/lib/chef/knife/core/hashed_command_loader.rb

@@ -44,7 +44,7 @@ class Chef
           else
             commands = manifest[KEY]["plugins_by_category"]
           end
-          # If any of the specified plugins in the manifest dont have a valid path we will
+          # If any of the specified plugins in the manifest don't have a valid path we will
           # eventually get an error and the user will need to rehash - instead, lets just
           # print out 1 error here telling them to rehash
           errors = {}

data/lib/chef/knife/core/node_presenter.rb

@@ -94,7 +94,7 @@ class Chef
         def summarize(data)
           if data.is_a?(Chef::Node)
             node = data
-            # special case clouds with their split horizon whatsis.
+            # special case clouds with their split horizon thing.
             ip = (node[:cloud] && node[:cloud][:public_ipv4_addrs] && node[:cloud][:public_ipv4_addrs].first) || node[:ipaddress]
 
             summarized = <<~SUMMARY

data/lib/chef/knife/core/status_presenter.rb

@@ -95,7 +95,7 @@ class Chef
           summarized = ""
           list.each do |data|
             node = data
-            # special case clouds with their split horizon whatsis.
+            # special case clouds with their split horizon thing.
             ip = (node[:cloud] && node[:cloud][:public_ipv4_addrs] && node[:cloud][:public_ipv4_addrs].first) || node[:ipaddress]
             fqdn = (node[:cloud] && node[:cloud][:public_hostname]) || node[:fqdn]
             name = node["name"] || node.name

data/lib/chef/knife/core/subcommand_loader.rb

@@ -32,7 +32,7 @@ class Chef
     #                            optionally filtering by category
     # subcommand_files         - returns an array of all subcommand files
     #                            that could be loaded
-    # commnad_class_from(args) - returns the subcommand class for the
+    # command_class_from(args) - returns the subcommand class for the
     #                            user-requested command
     #
     class SubcommandLoader

data/lib/chef/knife/core/windows_bootstrap_context.rb

@@ -24,7 +24,7 @@ class Chef
   class Knife
     module Core
       # Instances of BootstrapContext are the context objects (i.e., +self+) for
-      # bootstrap templates. For backwards compatability, they +must+ set the
+      # bootstrap templates. For backwards compatibility, they +must+ set the
       # following instance variables:
       # * @config   - a hash of knife's config values
       # * @run_list - the run list for the node to boostrap
@@ -41,6 +41,21 @@ class Chef
           super(config, run_list, chef_config, secret)
         end
 
+        # This is a duplicate of ChefConfig::PathHelper.cleanpath, however
+        # this presumes Windows so we can avoid changing the method definitions
+        # across Chef, ChefConfig, and ChefUtils for the circumstance where
+        # the methods are being run for a system other than the one Ruby is
+        # executing on.
+        #
+        # We only need to cleanpath the paths that we are passing to cmd.exe,
+        # anything written to a configuration file or passed as an argument
+        # will be interpreted by ruby later and do the right thing.
+        def cleanpath(path)
+          path = Pathname.new(path).cleanpath.to_s
+          path = path.gsub(File::SEPARATOR, '\\')
+          path
+        end
+
         def validation_key
           if File.exist?(File.expand_path(chef_config[:validation_key]))
             IO.read(File.expand_path(chef_config[:validation_key]))
@@ -160,7 +175,7 @@ class Chef
 
         def start_chef
           bootstrap_environment_option = bootstrap_environment.nil? ? "" : " -E #{bootstrap_environment}"
-          start_chef = "SET \"PATH=%SystemRoot%\\system32;%SystemRoot%;%SystemRoot%\\System32\\Wbem;%SYSTEMROOT%\\System32\\WindowsPowerShell\\v1.0\\;C:\\ruby\\bin;#{ChefConfig::Config.c_opscode_dir}\\#{ChefConfig::Dist::DIR_SUFFIX}\\bin;#{ChefConfig::Config.c_opscode_dir}\\#{ChefConfig::Dist::DIR_SUFFIX}\\embedded\\bin\;%PATH%\"\n"
+          start_chef = "SET \"PATH=%SystemRoot%\\system32;%SystemRoot%;%SystemRoot%\\System32\\Wbem;%SYSTEMROOT%\\System32\\WindowsPowerShell\\v1.0\\;C:\\ruby\\bin;#{ChefConfig::Config.c_opscode_dir}\\bin;#{ChefConfig::Config.c_opscode_dir}\\embedded\\bin\;%PATH%\"\n"
           start_chef << "#{Chef::Dist::CLIENT} -c #{ChefConfig::Config.etc_chef_dir(true)}/client.rb -j #{ChefConfig::Config.etc_chef_dir(true)}/first-boot.json#{bootstrap_environment_option}\n"
         end
 
@@ -262,7 +277,7 @@ class Chef
         end
 
         def bootstrap_directory
-          ChefConfig::Config.etc_chef_dir(true)
+          cleanpath(ChefConfig::Config.etc_chef_dir(true))
         end
 
         def local_download_path

data/lib/chef/knife/data_bag_create.rb

@@ -54,7 +54,7 @@ class Chef
           rest.get("data/#{@data_bag_name}")
           ui.info("Data bag #{@data_bag_name} already exists")
         rescue Net::HTTPClientException => e
-          raise unless e.to_s =~ /^404/
+          raise unless /^404/.match?(e.to_s)
 
           # if it doesn't exists, try to create it
           rest.post("data", { "name" => @data_bag_name })

data/lib/chef/knife/environment_compare.rb

@@ -81,7 +81,7 @@ class Chef
 
       def constraint_list(environments)
         constraints = {}
-        environments.each do |env, url| # rubocop:disable Performance/HashEachMethods
+        environments.each do |env, url| # rubocop:disable Style/HashEachMethods
           # Because you cannot modify the default environment I filter it out here.
           unless env == "_default"
             envdata = Chef::Environment.load(env)

data/lib/chef/knife/key_create_base.rb

@@ -42,7 +42,7 @@ class Chef
           option :expiration_date,
             short: "-e DATE",
             long: "--expiration-date DATE",
-            description: "Optionally pass the expiration date for the key in ISO 8601 fomatted string: YYYY-MM-DDTHH:MM:SSZ e.g. 2013-12-24T21:00:00Z. Defaults to infinity if not passed. UTC timezone assumed."
+            description: "Optionally pass the expiration date for the key in ISO 8601 formatted string: YYYY-MM-DDTHH:MM:SSZ e.g. 2013-12-24T21:00:00Z. Defaults to infinity if not passed. UTC timezone assumed."
         end
       end
     end

data/lib/chef/knife/key_edit_base.rb

@@ -47,7 +47,7 @@ class Chef
           option :expiration_date,
             short: "-e DATE",
             long: "--expiration-date DATE",
-            description: "Updates the expiration_date field of your key if passed. Pass in ISO 8601 fomatted string: YYYY-MM-DDTHH:MM:SSZ e.g. 2013-12-24T21:00:00Z or infinity. UTC timezone assumed."
+            description: "Updates the expiration_date field of your key if passed. Pass in ISO 8601 formatted string: YYYY-MM-DDTHH:MM:SSZ e.g. 2013-12-24T21:00:00Z or infinity. UTC timezone assumed."
         end
       end
     end

data/lib/chef/knife/list.rb

@@ -90,7 +90,7 @@ class Chef
 
         # Flatten out directory results if necessary
         if config[:flat]
-          dir_results.each do |result, children| # rubocop:disable Performance/HashEachMethods
+          dir_results.each do |result, children| # rubocop:disable Style/HashEachMethods
             results += children
           end
           dir_results = []

data/lib/chef/knife/node_bulk_delete.rb

@@ -39,7 +39,7 @@ class Chef
         matcher = /#{name_args[0]}/
 
         all_nodes.each do |name, node|
-          next unless name =~ matcher
+          next unless name&.match?(matcher)
 
           nodes_to_delete[name] = node
         end

data/lib/chef/knife/node_run_list_remove.rb

@@ -49,7 +49,7 @@ class Chef
             node.run_list.remove(e)
           else
             ui.warn "#{e} is not in the run list"
-            unless e =~ /^(recipe|role)\[/
+            unless /^(recipe|role)\[/.match?(e)
               ui.warn "(did you forget recipe[] or role[] around it?)"
             end
           end

data/lib/chef/knife/role_bulk_delete.rb

@@ -40,7 +40,7 @@ class Chef
         matcher = /#{@name_args[0]}/
         roles_to_delete = {}
         all_roles.each do |name, role|
-          next unless name =~ matcher
+          next unless name&.match?(matcher)
 
           roles_to_delete[role.name] = role
         end

data/lib/chef/knife/ssh.rb

@@ -59,7 +59,7 @@ class Chef
 
       option :prefix_attribute,
         long: "--prefix-attribute ATTR",
-        description: "The attribute to use for prefixing the ouput - default depends on the context."
+        description: "The attribute to use for prefixing the output - default depends on the context."
 
       option :ssh_user,
         short: "-x USERNAME",
@@ -364,7 +364,7 @@ class Chef
 
               ch.on_data do |ichannel, data|
                 print_data(ichannel.connection[:prefix], data)
-                if data =~ /^knife sudo password: /
+                if /^knife sudo password: /.match?(data)
                   print_data(ichannel.connection[:prefix], "\n")
                   ichannel.send_data("#{get_password}\n")
                 end

data/lib/chef/knife/supermarket_install.rb

@@ -96,7 +96,7 @@ class Chef
         extract_cookbook(upstream_file, downloader.version)
 
         # TODO: it'd be better to store these outside the cookbook repo and
-        # keep them around, e.g., in ~/Library/Caches on OS X.
+        # keep them around, e.g., in ~/Library/Caches on macOS.
         ui.info("Removing downloaded tarball")
         File.unlink(upstream_file)
 

data/lib/chef/knife/supermarket_share.rb

@@ -132,7 +132,7 @@ class Chef
         res = Chef::JSONCompat.from_json(http_resp.body)
         if http_resp.code.to_i != 201
           if res["error_messages"]
-            if res["error_messages"][0] =~ /Version already exists/
+            if /Version already exists/.match?(res["error_messages"][0])
               ui.error "The same version of this cookbook already exists on Supermarket."
               exit(1)
             else

data/lib/chef/knife/supermarket_unshare.rb

@@ -48,7 +48,7 @@ class Chef
         begin
           rest.delete "#{config[:supermarket_site]}/api/v1/cookbooks/#{@name_args[0]}"
         rescue Net::HTTPClientException => e
-          raise e unless e.message =~ /Forbidden/
+          raise e unless /Forbidden/.match?(e.message)
 
           ui.error "Forbidden: You must be the maintainer of #{@cookbook_name} to unshare it."
           exit 1

data/lib/chef/knife/{user_invite_recind.rb → user_invite_rescind.rb}

@@ -20,14 +20,14 @@ require_relative "../knife"
 
 class Chef
   class Knife
-    class UserInviteRecind < Chef::Knife
+    class UserInviteRescind < Chef::Knife
       category "user"
-      banner "knife user invite recind [USERNAMES] (options)"
+      banner "knife user invite rescind [USERNAMES] (options)"
 
       option :all,
         short: "-a",
         long: "--all",
-        description: "Recind all invites!"
+        description: "Rescind all invites!"
 
       def run
         if (name_args.length < 1) && ! config.key?(:all)
@@ -36,18 +36,18 @@ class Chef
           exit 1
         end
 
-        # To recind we need to send a DELETE to association_requests/INVITE_ID
+        # To rescind we need to send a DELETE to association_requests/INVITE_ID
         # For user friendliness we look up the invite ID based on username.
         @invites = {}
         usernames = name_args
         rest.get_rest("association_requests").each { |i| @invites[i["username"]] = i["id"] }
         if config[:all]
-          ui.confirm("Are you sure you want to recind all association requests")
+          ui.confirm("Are you sure you want to rescind all association requests")
           @invites.each do |u, i|
             rest.delete_rest("association_requests/#{i}")
           end
         else
-          ui.confirm("Are you sure you want to recind the association requests for: #{usernames.join(", ")}")
+          ui.confirm("Are you sure you want to rescind the association requests for: #{usernames.join(", ")}")
           usernames.each do |u|
             if @invites.key?(u)
               rest.delete_rest("association_requests/#{@invites[u]}")

data/lib/chef/knife/yaml_convert.rb

@@ -56,7 +56,7 @@ class Chef::Knife::YamlConvert < Chef::Knife
     end
 
     # Unfortunately, per the YAML spec, comments are stripped when we load, so we lose them on conversion
-    yaml_hash = ::YAML.safe_load(yaml_contents)
+    yaml_hash = ::YAML.safe_load(yaml_contents, permitted_classes: [Symbol])
     unless yaml_hash.is_a?(Hash) && yaml_hash.key?("resources")
       ui.fatal!("YAML recipe '#{source_file}' must contain a top-level 'resources' hash (YAML sequence), i.e. 'resources:'")
     end
@@ -81,7 +81,7 @@ class Chef::Knife::YamlConvert < Chef::Knife
 
       ruby_contents << "#{type} \"#{name}\" do"
       r.each do |k, v|
-        ruby_contents << "  #{k} \"#{v}\""
+        ruby_contents << "  #{k} #{v.inspect}"
       end
       ruby_contents << "end\n"
     end

data/lib/chef/log.rb

@@ -21,7 +21,7 @@ require "logger"
 require_relative "monologger"
 require_relative "exceptions"
 require "mixlib/log"
-require_relative "log/syslog" unless RUBY_PLATFORM =~ /mswin|mingw|windows/
+require_relative "log/syslog" unless RUBY_PLATFORM.match?(/mswin|mingw|windows/)
 require_relative "log/winevt"
 
 class Chef

data/lib/chef/mixin/api_version_request_handling.rb

@@ -53,7 +53,7 @@ class Chef
         <<~EOH
           The reregister command only supports server API version 0.
           The server that received the request supports a min version of #{min_version} and a max version of #{max_version}.
-          User keys are now managed via the key rotation commmands.
+          User keys are now managed via the key rotation commands.
           Please refer to the documentation on how to manage your keys via the key rotation commands:
           https://docs.chef.io/ctl_chef_server/#key-rotation
         EOH

data/lib/chef/mixin/checksum.rb

@@ -16,7 +16,6 @@
 # limitations under the License.
 #
 
-require "digest/sha2" unless defined?(Digest::SHA2)
 require_relative "../digester"
 
 class Chef

data/lib/chef/mixin/create_path.rb

@@ -53,14 +53,14 @@ class Chef
       private
 
       def create_dir(path)
-          # When doing multithreaded downloads into the file cache, the following
-          # interleaving raises an error here:
-          #
-          # thread1                                     thread2
-          # File.directory?(create_path) <- false
-          #                                             File.directory?(create_path) <- false
-          #                                             Dir.mkdir(create_path)
-          # Dir.mkdir(create_path) <- raises Errno::EEXIST
+        # When doing multithreaded downloads into the file cache, the following
+        # interleaving raises an error here:
+        #
+        # thread1                                     thread2
+        # File.directory?(create_path) <- false
+        #                                             File.directory?(create_path) <- false
+        #                                             Dir.mkdir(create_path)
+        # Dir.mkdir(create_path) <- raises Errno::EEXIST
         Chef::Log.trace("Creating directory #{path}")
         Dir.mkdir(path)
       rescue Errno::EEXIST