chef 16.0.287 → 16.2.73

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/config_use_profile.rb

@@ -33,17 +33,27 @@ class Chef
       end
 
       def run
+        credentials_data = self.class.config_loader.parse_credentials_file
         context_file = ChefConfig::PathHelper.home(".chef", "context").freeze
         profile = @name_args[0]&.strip
-        if profile && !profile.empty?
+        if profile.nil? || profile.empty?
+          show_usage
+          ui.fatal("You must specify a profile")
+          exit 1
+        end
+
+        if credentials_data.nil? || credentials_data.empty?
+          ui.fatal("No profiles found, #{self.class.config_loader.credentials_file_path} does not exist or is empty")
+          exit 1
+        end
+
+        if credentials_data[profile].nil?
+          raise ChefConfig::ConfigurationError, "Profile #{profile} doesn't exist. Please add it to #{self.class.config_loader.credentials_file_path} and if it is profile with DNS name check that you are not missing single quotes around it as per docs https://docs.chef.io/workstation/knife_setup/#knife-profiles."
+        else
           # Ensure the .chef/ folder exists.
           FileUtils.mkdir_p(File.dirname(context_file))
           IO.write(context_file, "#{profile}\n")
           ui.msg("Set default profile to #{profile}")
-        else
-          show_usage
-          ui.fatal("You must specify a profile")
-          exit 1
         end
       end
 

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/cookbook_upload.rb

@@ -23,9 +23,6 @@ require_relative "../knife"
 class Chef
   class Knife
     class CookbookUpload < Knife
-      CHECKSUM = "checksum".freeze
-      MATCH_CHECKSUM = /[0-9a-f]{32,}/.freeze
-
       deps do
         require_relative "../mixin/file_class"
         include Chef::Mixin::FileClass
@@ -245,7 +242,7 @@ class Chef
         # manifest object, but the manifest becomes invalid when you
         # regenerate the metadata
         broken_files = cookbook.dup.manifest_records_by_path.select do |path, info|
-          info[CHECKSUM].nil? || info[CHECKSUM] !~ MATCH_CHECKSUM
+          !/[0-9a-f]{32,}/.match?(info["checksum"])
         end
         unless broken_files.empty?
           broken_filenames = Array(broken_files).map { |path, info| path }

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

@@ -28,7 +28,7 @@ class Chef
       # 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
+      # * @run_list - the run list for the node to bootstrap
       #
       class BootstrapContext
 

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,10 +24,10 @@ 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
+      # * @run_list - the run list for the node to bootstrap
       #
       class WindowsBootstrapContext < BootstrapContext
         attr_accessor :config
@@ -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/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/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_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/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/openssl_helper.rb

@@ -218,7 +218,7 @@ class Chef
         # Chef 12 backward compatibility
         ::OpenSSL::PKey::EC.send(:alias_method, :private?, :private_key?)
 
-        request.sign(key, ::OpenSSL::Digest::SHA256.new)
+        request.sign(key, ::OpenSSL::Digest.new("SHA256"))
         request
       end
 
@@ -289,7 +289,7 @@ class Chef
         cert.add_extension ef.create_extension("authorityKeyIdentifier",
           "keyid:always,issuer:always")
 
-        cert.sign(key, ::OpenSSL::Digest::SHA256.new)
+        cert.sign(key, ::OpenSSL::Digest.new("SHA256"))
         cert
       end
 
@@ -319,7 +319,7 @@ class Chef
         crl.add_extension ::OpenSSL::X509::Extension.new("crlNumber", ::OpenSSL::ASN1::Integer(1))
         crl.add_extension ef.create_extension("authorityKeyIdentifier",
           "keyid:always,issuer:always")
-        crl.sign(ca_private_key, ::OpenSSL::Digest::SHA256.new)
+        crl.sign(ca_private_key, ::OpenSSL::Digest.new("SHA256"))
         crl
       end
 
@@ -398,7 +398,7 @@ class Chef
           ::OpenSSL::ASN1::Integer(get_next_crl_number(crl)))]
         crl.add_extension ef.create_extension("authorityKeyIdentifier",
           "keyid:always,issuer:always")
-        crl.sign(ca_private_key, ::OpenSSL::Digest::SHA256.new)
+        crl.sign(ca_private_key, ::OpenSSL::Digest.new("SHA256"))
         crl
       end
 

data/lib/chef/mixin/properties.rb

@@ -264,7 +264,7 @@ class Chef
           end
 
           result = properties.values.select(&:identity?)
-          # if there are no other identity properites set, then the name_property becomes the identity, or
+          # if there are no other identity properties set, then the name_property becomes the identity, or
           # failing that we use the actual name.
           if result.empty?
             result = name_property ? [ properties[name_property] ] : [ properties[:name] ]
@@ -355,7 +355,7 @@ class Chef
       #
       # @param other [Object] the other object (Chef::Resource) which implements the properties API
       # @param includes [Array<Symbol>] splat-args list of symbols of the properties to copy.
-      # @param exclude [Array<Symbol>] list of symbosl of the properties to exclude.
+      # @param exclude [Array<Symbol>] list of symbols of the properties to exclude.
       # @return the self object the properties were copied to for method chaining
       #
       def copy_properties_from(other, *includes, exclude: [ :name ])

data/lib/chef/mixin/securable.rb

@@ -172,14 +172,14 @@ class Chef
         end
       end
 
-      if RUBY_PLATFORM =~ /mswin|mingw|windows/
+      if RUBY_PLATFORM.match?(/mswin|mingw|windows/)
         include WindowsSecurableAttributes
       end
 
       # Callback that fires when included; will extend the including class
       # with WindowsMacros and define #rights and #deny_rights on it.
       def self.included(including_class)
-        if RUBY_PLATFORM =~ /mswin|mingw|windows/
+        if RUBY_PLATFORM.match?(/mswin|mingw|windows/)
           including_class.extend(WindowsMacros)
           # create a default 'rights' attribute
           including_class.rights_attribute(:rights)

data/lib/chef/mixin/shell_out.rb

@@ -71,7 +71,7 @@ class Chef
         default_val = 900
         return options if options.key?(:timeout)
 
-        # FIXME: need to nuke descendents tracker out of Chef::Provider so we can just define that class here without requiring the
+        # FIXME: need to nuke descendent tracker out of Chef::Provider so we can just define that class here without requiring the
         # world, and then just use symbol lookup
         if obj.class.ancestors.map(&:name).include?("Chef::Provider") && obj.respond_to?(:new_resource) && obj.new_resource.respond_to?(:timeout) && !options.key?(:timeout)
           options[:timeout] = obj.new_resource.timeout ? obj.new_resource.timeout.to_f : default_val

data/lib/chef/node/attribute.rb

@@ -184,7 +184,7 @@ class Chef
       # return the role level override attribute component
       attr_reader :role_override
 
-      # return the enviroment level override attribute component
+      # return the environment level override attribute component
       attr_reader :env_override
 
       # return the force override level attribute component
@@ -535,7 +535,7 @@ class Chef
         e
       end
 
-      # Deep merge all attribute levels using hash-only merging between different precidence
+      # Deep merge all attribute levels using hash-only merging between different precedence
       # levels (so override arrays completely replace arrays set at any default level).
       #
       # The path allows for selectively deep-merging a subtree of the node object.

data/lib/chef/node/immutable_collections.rb

@@ -120,7 +120,7 @@ class Chef
     # ImmutableMash acts like a Mash (Hash that is indifferent to String or
     # Symbol keys), with some important exceptions:
     # * Methods that mutate state are overridden to raise an error instead.
-    # * Methods that read from the collection are overriden so that they check
+    # * Methods that read from the collection are overridden so that they check
     #   if the Chef::Node::Attribute has been modified since an instance of
     #   this class was generated. An error is raised if the object detects that
     #   it is stale.

data/lib/chef/policy_builder/policyfile.rb

@@ -328,7 +328,7 @@ class Chef
         end
       end
 
-      # Do some mimimal validation of the policyfile we fetched from the
+      # Do some minimal validation of the policyfile we fetched from the
       # server. Compatibility mode relies on using data bags to store policy
       # files; therefore no real validation will be performed server-side and
       # we need to make additional checks to ensure the data will be formatted