chef 16.1.0 → 16.1.16

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b138b7c33a13cb8016b0883638027a663dfd9a69b581b762905186accbf26583
-  data.tar.gz: 718b25c47f4adb5761c915a7445a3b450f062f5f79ee3eaa8d6c5f165bf077c0
+  metadata.gz: 954f3cdcc1620ea83e221b545df48e0ad9b5ed578aa367b6faecd828e573e3e6
+  data.tar.gz: d3cd87dbbe1be501e576b4697e3a7fd609fb5df6f68163e1843a65deeaec7485
 SHA512:
-  metadata.gz: 12485669d051d24c96a784f753d6c85a9a7b7afed6cdcf218c8dda31dc99133c26ee4e315c51f47d5868688ec3c8955eafa7e1c7fa2e63cceac370d146a41002
-  data.tar.gz: 85a441f6ae29db6e725621182fef6e9e4fd69f6393457bfaeb4a928212e2dcb09a8e6be54808c21282fdc8dd35bd0c6c50dbfa8e1562b73fbba70f1a551ab264
+  metadata.gz: 4c9bd8fff2699c41b1ffbfefeff88859d3f49f06d7d7d04f4e0e7c7bd9c1bb35240c48e30f0a8448e8238393ede67bf1a72ec3061106690e3661d8d359c62caf
+  data.tar.gz: 45fb0813908f4c7ce52198ad4c5c274545e1edc0493fe54b37a6a08595f625a2fe41e2f0b4ceedc578fab1c3acb04f8462a2ede20e3c6a229d2860878c222c57

data/Rakefile

@@ -58,7 +58,7 @@ namespace :pre_install do
   task all: ["pre_install:install_gems_from_dirs", "pre_install:render_powershell_extension"]
 end
 
-# hack in all the preinstall tasks to occur before the tradtional install task
+# hack in all the preinstall tasks to occur before the traditional install task
 task install: "pre_install:all"
 
 # make sure we build the correct gemspec on windows
@@ -108,3 +108,17 @@ begin
 rescue LoadError
   puts "yard is not available. bundle install first to make sure all dependencies are installed."
 end
+
+namespace :spellcheck do
+  task :run do
+    sh 'cspell "**/*" "*.md"'
+  end
+
+  desc "List the unique unrecognized words in the project."
+  task :unknown_words do
+    sh 'cspell "**/*" "*.md" --wordsOnly --no-summary | sort | uniq'
+  end
+end
+
+desc "Run spellcheck on the project."
+task spellcheck: "spellcheck:run"

data/lib/chef/chef_fs/file_system/chef_server/acls_dir.rb

@@ -60,7 +60,7 @@ class Chef
                   AclDir.new(entity_type, self)
                 end
               end
-              @children << AclEntry.new("organization.json", self, true) # the org acl is retrieved as GET /organizations/ORGNAME/ANYTHINGATALL/_acl
+              @children << AclEntry.new("organization.json", self, true) # the org acl is retrieved as GET /organizations/ORGNAME/ANYTHING/_acl
             end
             @children
           end

data/lib/chef/chef_fs/file_system/chef_server/cookbook_file.rb

@@ -69,7 +69,7 @@ class Chef
           private
 
           def calc_checksum(value)
-            OpenSSL::Digest::MD5.hexdigest(value)
+            OpenSSL::Digest.hexdigest("MD5", value)
           end
         end
       end

data/lib/chef/chef_fs/file_system/repository/directory.rb

@@ -104,7 +104,7 @@ class Chef
             children.empty?
           end
 
-          # Public API callied by chef_fs/file_system
+          # Public API called by chef_fs/file_system
           def child(name)
             possible_child = make_child_entry(name)
             if possible_child.name_valid?

data/lib/chef/chef_fs/parallelizer/parallel_enumerable.rb

@@ -235,7 +235,7 @@ class Chef
         # The order of these checks is important, as well, to be thread safe.
         # 1. If @unconsumed_input.empty? is true, then we will never have any more
         # work legitimately picked up.
-        # 2. If @in_process == 0, then there is no work in process, and because ofwhen unconsumed_input is empty, it will never go back up, because
+        # 2. If @in_process == 0, then there is no work in process, and because of when unconsumed_input is empty, it will never go back up, because
         # this is called after the input enumerator is finished.  Note that switching #2 and #1
         # could cause a race, because in_process is incremented *before* consuming input.
         # 3. If @unconsumed_output.empty? is true, then we are done with outputs.

data/lib/chef/chef_fs/path_utils.rb

@@ -71,9 +71,9 @@ class Chef
       # part that actually exists.  The paths operated on here are not Chef-FS paths.
       # These are OS paths that may contain symlinks but may not also fully exist.
       #
-      # If /x is a symlink to /blarghle, and has no subdirectories, then:
-      # PathUtils.realest_path('/x/y/z') == '/blarghle/y/z'
-      # PathUtils.realest_path('/x/*/z') == '/blarghle/*/z'
+      # If /x is a symlink to /foo_bar, and has no subdirectories, then:
+      # PathUtils.realest_path('/x/y/z') == '/foo_bar/y/z'
+      # PathUtils.realest_path('/x/*/z') == '/foo_bar/*/z'
       # PathUtils.realest_path('/*/y/z') == '/*/y/z'
       #
       # TODO: Move this to wherever util/path_helper is these days.

data/lib/chef/cookbook/file_system_file_vendor.rb

@@ -27,7 +27,7 @@ class Chef
     # and throws the rest away then re-builds the list of files on the
     # disk. This is due to the manifest not having the on-disk file
     # locations, since in the chef-client case, that information is
-    # non-sensical.
+    # nonsensical.
     class FileSystemFileVendor < FileVendor
 
       attr_reader :cookbook_name

data/lib/chef/cookbook/metadata.rb

@@ -357,7 +357,7 @@ class Chef
       # Array<String> - array of files or globs to eagerly load, otherwise it is treated like `false`
       #
       # @params arg [Array,String,TrueClass,FalseClass]
-      # @params [Array,TrueClass,FalseCalss]
+      # @params [Array,TrueClass,FalseClass]
       def eager_load_libraries(arg = nil)
         set_or_return(
           :eager_load_libraries,

data/lib/chef/cookbook_loader.rb

@@ -138,7 +138,7 @@ class Chef
       cookbooks_by_name.values
     end
 
-    # This method creates tmp directory and copies all cookbooks into it and creates cookbook loder object which points to tmp directory
+    # This method creates tmp directory and copies all cookbooks into it and creates cookbook loader object which points to tmp directory
     def self.copy_to_tmp_dir_from_array(cookbooks)
       tmp_cookbook_file = Tempfile.new("tmp_working_dir_path")
       tmp_cookbook_file.close

data/lib/chef/cookbook_manifest.rb

@@ -44,7 +44,7 @@ class Chef
     # cookbook_version in the "manifest" format, or #to_json to get a JSON
     # representation of the cookbook_version.
     #
-    # The inferface for this behavior is expected to change as we implement new
+    # The interface for this behavior is expected to change as we implement new
     # manifest formats. The entire class should be considered a private API for
     # now.
     #

data/lib/chef/cookbook_site_streaming_uploader.rb

@@ -147,7 +147,7 @@ class Chef
         class << res
           alias :to_s :body
 
-          # BUGBUG this makes the response compatible with what respsonse_steps expects to test headers (response.headers[] -> response[])
+          # BUG this makes the response compatible with what response_steps expects to test headers (response.headers[] -> response[])
           def headers # rubocop:disable Lint/NestedMethodDefinition
             self
           end

data/lib/chef/cookbook_version.rb

@@ -358,7 +358,7 @@ class Chef
 
         # extract the preference part from the path.
         if manifest_record_path =~ %r{(#{Regexp.escape(segment.to_s)}/[^/]+/#{Regexp.escape(dirname)})/.+$}
-          # Note the specificy_dirname includes the segment and
+          # Note the specificity_dirname includes the segment and
           # dirname argument as above, which is what
           # preferences_for_path returns. It could be
           # "files/ubuntu-9.10/dirname", for example.
@@ -566,7 +566,7 @@ class Chef
     def find_preferred_manifest_record(node, segment, filename)
       preferences = preferences_for_path(node, segment, filename)
 
-      # in order of prefernce, look for the filename in the manifest
+      # in order of preference, look for the filename in the manifest
       preferences.find { |preferred_filename| manifest_records_by_path[preferred_filename] }
     end
 

data/lib/chef/data_collector.rb

@@ -184,7 +184,7 @@ class Chef
         begin
           code = e&.response&.code&.to_s
         rescue
-          # i really dont care
+          # i really don't care
         end
 
         code ||= "No HTTP Code"

data/lib/chef/data_collector/error_handlers.rb

@@ -18,7 +18,7 @@
 class Chef
   class DataCollector
 
-    # This module isolates the handling of collecting error descriptions to insert into the data_colletor
+    # This module isolates the handling of collecting error descriptions to insert into the data_collector
     # report output.  For very early errors it is responsible for collecting the node_name for the report
     # to use.  For all failure conditions that have an ErrorMapper it collects the output.
     #

data/lib/chef/decorator/lazy_array.rb

@@ -21,8 +21,8 @@ class Chef
   class Decorator
     # Lazy Array around Lazy Objects
     #
-    # This only lazys access through `#[]`.  In order to implement #each we need to
-    # know how many items we have and what their indexes are, so we'd have to evalute
+    # This makes access lazy through `#[]`.  In order to implement #each we need to
+    # know how many items we have and what their indexes are, so we'd have to evaluate
     # the proc which makes that impossible.  You can call methods like #each and the
     # decorator will forward the method, but item access will not be lazy.
     #

data/lib/chef/digester.rb

@@ -39,9 +39,9 @@ class Chef
 
     def generate_checksum(file)
       if file.is_a?(StringIO)
-        checksum_io(file, OpenSSL::Digest::SHA256.new)
+        checksum_io(file, OpenSSL::Digest.new("SHA256"))
       else
-        checksum_file(file, OpenSSL::Digest::SHA256.new)
+        checksum_file(file, OpenSSL::Digest.new("SHA256"))
       end
     end
 
@@ -50,11 +50,11 @@ class Chef
     end
 
     def generate_md5_checksum_for_file(file)
-      checksum_file(file, OpenSSL::Digest::MD5.new)
+      checksum_file(file, OpenSSL::Digest.new("MD5"))
     end
 
     def generate_md5_checksum(io)
-      checksum_io(io, OpenSSL::Digest::MD5.new)
+      checksum_io(io, OpenSSL::Digest.new("MD5"))
     end
 
     private

data/lib/chef/dsl/declare_resource.rb

@@ -151,7 +151,7 @@ class Chef
       #     source "y.txt.erb"
       #     variables {}
       #   end
-      #   resource.variables.merge!({ home: "/home/klowns"  })
+      #   resource.variables.merge!({ home: "/home/clowns"  })
       #
       def edit_resource(type, name, created_at: nil, run_context: self.run_context, &resource_attrs_block)
         edit_resource!(type, name, created_at: created_at, run_context: run_context, &resource_attrs_block)

data/lib/chef/encrypted_data_bag_item/decryptor.rb

@@ -158,7 +158,7 @@ class Chef::EncryptedDataBagItem
             d = OpenSSL::Cipher.new(algorithm)
             d.decrypt
             # We must set key before iv: https://bugs.ruby-lang.org/issues/8221
-            d.key = OpenSSL::Digest::SHA256.digest(key)
+            d.key = OpenSSL::Digest.digest("SHA256", key)
             d.iv = iv
             d
           end

data/lib/chef/encrypted_data_bag_item/encryptor.rb

@@ -102,7 +102,7 @@ class Chef::EncryptedDataBagItem
           encryptor = OpenSSL::Cipher.new(algorithm)
           encryptor.encrypt
           # We must set key before iv: https://bugs.ruby-lang.org/issues/8221
-          encryptor.key = OpenSSL::Digest::SHA256.digest(key)
+          encryptor.key = OpenSSL::Digest.digest("SHA256", key)
           @iv ||= encryptor.random_iv
           encryptor.iv = @iv
           encryptor

data/lib/chef/formatters/base.rb

@@ -142,7 +142,7 @@ class Chef
 
       # Generic callback for any attribute/library/lwrp/recipe file in a
       # cookbook getting loaded. The per-filetype callbacks for file load are
-      # overriden so that they call this instead. This means that a subclass of
+      # overridden so that they call this instead. This means that a subclass of
       # Formatters::Base can implement #file_loaded to do the same thing for
       # every kind of file that Chef loads from a recipe instead of
       # implementing all the per-filetype callbacks.

data/lib/chef/http.rb

@@ -269,7 +269,7 @@ class Chef
       if keepalives && !base_url.nil?
         # only reuse the http_client if we want keepalives and have a base_url
         @http_client ||= {}
-        # the per-host per-port cache here gets peristent connections correct when
+        # the per-host per-port cache here gets persistent connections correct when
         # redirecting to different servers
         if base_url.is_a?(String) # sigh, this kind of abuse can't happen with strongly typed languages
           @http_client[base_url] ||= build_http_client(base_url)

data/lib/chef/http/decompressor.rb

@@ -22,7 +22,7 @@ require_relative "http_request"
 class Chef
   class HTTP
 
-    # Middleware-esque class for handling compression in HTTP responses.
+    # Middleware-ish class for handling compression in HTTP responses.
     class Decompressor
       class NoopInflater
         def inflate(chunk)

data/lib/chef/json_compat.rb

@@ -28,7 +28,7 @@ class Chef
 
     class <<self
 
-      # API to use to avoid create_addtions
+      # API to use to avoid create_additions
       def parse(source, opts = {})
         FFI_Yajl::Parser.parse(source, opts)
       rescue FFI_Yajl::ParseError => e

data/lib/chef/key.rb

@@ -252,7 +252,7 @@ class Chef
           OpenSSL::ASN1::Integer.new(openssl_key_object.public_key.n),
           OpenSSL::ASN1::Integer.new(openssl_key_object.public_key.e),
         ])
-        OpenSSL::Digest::SHA1.hexdigest(data_string.to_der).scan(/../).join(":")
+        OpenSSL::Digest.hexdigest("SHA1", data_string.to_der).scan(/../).join(":")
       end
 
       def list(keys, actor, load_method_symbol, inflate)

data/lib/chef/knife.rb

@@ -327,7 +327,7 @@ class Chef
       end
 
       # Grab a copy before config merge occurs, so that we can later identify
-      # whare a given config value is sourced from.
+      # where a given config value is sourced from.
       @original_config = config.dup
 
       # copy Mixlib::CLI over so that it can be configured in config.rb/knife.rb

data/lib/chef/knife/bootstrap.rb

@@ -94,7 +94,7 @@ class Chef
         boolean: true
 
       # This option was provided in knife bootstrap windows winrm,
-      # but it is ignored  in knife-windows/WinrmSession, and so remains unimplemeneted here.
+      # but it is ignored  in knife-windows/WinrmSession, and so remains unimplemented here.
       # option :kerberos_keytab_file,
       #   :short => "-T KEYTAB_FILE",
       #   :long => "--keytab-file KEYTAB_FILE",
@@ -275,7 +275,7 @@ class Chef
           accumulator
         }
 
-      # bootstrap override: url of a an installer shell script touse in place of omnitruck
+      # bootstrap override: url of a an installer shell script to use in place of omnitruck
       # Note that the bootstrap template _only_ references this out of Chef::Config, and not from
       # the provided options to knife bootstrap, so we set the Chef::Config option here.
       option :bootstrap_url,
@@ -713,7 +713,7 @@ class Chef
       # Fail if using plaintext auth without ssl because
       # this can expose keys in plaintext on the wire.
       # TODO test for this method
-      # TODO check that the protoocol is valid.
+      # TODO check that the protocol is valid.
       def validate_winrm_transport_opts!
         return true unless winrm?
 
@@ -967,7 +967,7 @@ class Chef
             gw_host = split[1]
           end
           gw_host, gw_port = gw_host.split(":", 2)
-          # TODO - validate convertable port in config validation?
+          # TODO - validate convertible port in config validation?
           gw_port = Integer(gw_port) rescue nil
           opts[:bastion_host] = gw_host
           opts[:bastion_user] = gw_user
@@ -1073,7 +1073,7 @@ class Chef
         remote_path
       end
 
-      # build the command string for bootrapping
+      # build the command string for bootstrapping
       # @return String
       def bootstrap_command(remote_path)
         if connection.windows?

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/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/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