chef 16.1.0 → 16.1.16

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

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

data/lib/chef/property.rb

@@ -574,7 +574,7 @@ class Chef
       # be using the existing getter/setter to manipulate it instead.
       return unless instance_variable_name
 
-      # Properties may override existing properties up the inheritance heirarchy, but
+      # Properties may override existing properties up the inheritance hierarchy, but
       # properties must not override inherited methods like Object#hash.  When the Resource is
       # placed into the resource collection the ruby Hash object will call the
       # Object#hash method on the resource, and overriding that with a property will cause
@@ -702,7 +702,7 @@ class Chef
       # override their own properties.
       return false unless [ Object, BasicObject, Kernel, Chef::Resource ].include?(declared_in.instance_method(name).owner)
 
-      # Allow top-level Chef::Resource proprties, such as `name`, to be overridden.
+      # Allow top-level Chef::Resource properties, such as `name`, to be overridden.
       # As of this writing, `name` is the only Chef::Resource property created with the
       # `property` definition, but this will allow for future properties to be extended
       # as needed.

data/lib/chef/provider.rb

@@ -152,7 +152,7 @@ class Chef
       new_resource.cookbook_name
     end
 
-    # hook that subclasses can use to do lazy validation for where properties aren't flexibile enough
+    # hook that subclasses can use to do lazy validation for where properties aren't flexible enough
     def check_resource_semantics!; end
 
     # a simple placeholder method that will be called / raise if a resource tries to
@@ -167,7 +167,7 @@ class Chef
 
     def load_after_resource
       # This is a backwards compatible hack, custom resources properly wire up a new after_resource
-      # via load_current_value.  It is acceptible for old style resources that cannot be easily made
+      # via load_current_value.  It is acceptable for old style resources that cannot be easily made
       # into custom resources to override this method and provide a proper after_resource.
       @after_resource = @new_resource
     end
@@ -190,7 +190,7 @@ class Chef
     def run_action(action = nil)
       @action = action unless action.nil?
 
-      # hook that subclasses can use to do lazy validation for where properties aren't flexibile enough
+      # hook that subclasses can use to do lazy validation for where properties aren't flexible enough
       check_resource_semantics!
 
       # force the validation of required properties

data/lib/chef/provider/directory.rb

@@ -142,7 +142,7 @@ class Chef
           converge_by("delete existing directory #{new_resource.path}") do
             if new_resource.recursive == true
               # we don't use rm_rf here because it masks all errors, including
-              # IO errors or permission errors that would prvent the deletion
+              # IO errors or permission errors that would prevent the deletion
               FileUtils.rm_r(new_resource.path)
               logger.info("#{new_resource} deleted #{new_resource.path} recursively")
             else

data/lib/chef/provider/file.rb

@@ -334,7 +334,7 @@ class Chef
       end
 
       def do_validate_content
-        if new_resource.checksum && tempfile && ( new_resource.checksum.downcase != tempfile_checksum )
+        if new_resource.checksum && tempfile && ( new_resource.checksum != tempfile_checksum )
           raise Chef::Exceptions::ChecksumMismatch.new(short_cksum(new_resource.checksum), short_cksum(tempfile_checksum))
         end
 

data/lib/chef/provider/package/chocolatey.rb

@@ -249,7 +249,7 @@ class Chef
         end
 
         # Helper to convert choco.exe list output to a Hash
-        # (names are downcased for case-insenstive matching)
+        # (names are downcased for case-insensitive matching)
         #
         # @param cmd [String] command to run
         # @return [Hash] list output converted to ruby Hash

data/lib/chef/provider/package/dpkg.rb

@@ -149,7 +149,7 @@ class Chef
           resolved_source_array.all? { |s| s && ::File.exist?(s) }
         end
 
-        # Helper to return all the nanes of the missing sources for error messages.
+        # Helper to return all the names of the missing sources for error messages.
         #
         # @return [Array<String>] Array of missing sources
         def missing_sources

data/lib/chef/provider/package/portage.rb

@@ -70,6 +70,7 @@ class Chef
 
           if pkginfo.exitstatus != 0
             pkginfo.stderr.each_line do |line|
+              # cspell:disable-next-line
               if line =~ /[Uu]nqualified atom .*match.* multiple/
                 raise_error_for_query("matched multiple packages (please specify a category):\n#{pkginfo.inspect}")
               end

data/lib/chef/provider/package/rubygems.rb

@@ -250,7 +250,7 @@ class Chef
           private
 
           def logger
-            Chef::Log.with_child({ subsytem: "gem_installer_environment" })
+            Chef::Log.with_child({ subsystem: "gem_installer_environment" })
           end
 
         end

data/lib/chef/provider/package/windows.rb

@@ -38,7 +38,7 @@ class Chef
         def define_resource_requirements
           if new_resource.checksum
             requirements.assert(:install) do |a|
-              a.assertion { new_resource.checksum.downcase == checksum(source_location) }
+              a.assertion { new_resource.checksum == checksum(source_location) }
               a.failure_message Chef::Exceptions::Package, "Checksum on resource (#{short_cksum(new_resource.checksum)}) does not match checksum on content (#{short_cksum(source_location)})"
             end
           end
@@ -169,7 +169,7 @@ class Chef
         # is not multipackage.  The existing implementation of package_provider.installed_version should probably
         # be what `uninstall_version_array` is, and then that list should be sorted and last/first'd into the
         # current_resource.version.  The current_version_array method was not intended to be overwritten by
-        # sublasses (but ruby provides no feature to block doing so -- it is already marked as private).
+        # subclasses (but ruby provides no feature to block doing so -- it is already marked as private).
         #
         def current_version_array
           [ current_resource.version ]

data/lib/chef/provider/package/yum.rb

@@ -100,7 +100,7 @@ class Chef
 
             # If this is a package like the kernel that can be installed multiple times, we'll skip over this logic
             if new_resource.allow_downgrade && version_gt?(iv.version_with_arch, av.version_with_arch) && !python_helper.install_only_packages(name)
-              # We allow downgrading only in the evenit of single-package
+              # We allow downgrading only in the event of single-package
               # rules where the user explicitly allowed it
               method = "downgrade"
             end

data/lib/chef/provider/package/yum/yum_cache.rb

@@ -22,7 +22,7 @@ require "singleton" unless defined?(Singleton)
 
 #
 # These are largely historical APIs, the YumCache object no longer exists and this is a
-# fascade over the python helper class.  It should be considered deprecated-lite and
+# facade over the python helper class.  It should be considered deprecated-lite and
 # no new APIs should be added and should be added to the python_helper instead.
 #
 

data/lib/chef/provider/remote_directory.rb

@@ -147,7 +147,7 @@ class Chef
         new_resource.updated_by_last_action(true) if res.updated?
       end
 
-      # Get the files to tranfer.  This returns files in lexicographical sort order.
+      # Get the files to transfer.  This returns files in lexicographical sort order.
       #
       # FIXME: it should do breadth-first, see CHEF-5080 (please use a performant sort)
       #
@@ -245,7 +245,7 @@ class Chef
         res = Chef::Resource::Directory.new(dir, run_context)
         res.cookbook_name = resource_cookbook
         if ChefUtils.windows? && rights
-          # rights are only meant to be applied to the toppest-level directory;
+          # rights are only meant to be applied to the most top-level directory;
           # Windows will handle inheritance.
           if dir == path
             rights.each do |r|

data/lib/chef/provider/service/arch.rb

@@ -42,7 +42,7 @@ class Chef::Provider::Service::Arch < Chef::Provider::Service::Init
   end
 
   # Get list of all daemons from the file '/etc/rc.conf'.
-  # Mutiple lines and background form are supported. Example:
+  # Multiple lines and background form are supported. Example:
   #   DAEMONS=(\
   #     foobar \
   #     @example \

data/lib/chef/provider/service/upstart.rb

@@ -41,7 +41,7 @@ class Chef
 
         # Upstart does more than start or stop a service, creating multiple 'states' [1] that a service can be in.
         # In chef, when we ask a service to start, we expect it to have started before performing the next step
-        # since we have top down dependencies. Which is to say we may follow witha resource next that requires
+        # since we have top down dependencies. Which is to say we may follow with a resource next that requires
         # that service to be running. According to [2] we can trust that sending a 'goal' such as start will not
         # return until that 'goal' is reached, or some error has occurred.
         #

data/lib/chef/provider/user/aix.rb

@@ -40,7 +40,7 @@ class Chef
           shell_out!("userdel", userdel_options, new_resource.username)
         end
 
-        # Aix does not support -r like other unix, sytem account is created by adding to 'system' group
+        # Aix does not support -r like other unix, system account is created by adding to 'system' group
         def useradd_options
           opts = []
           opts << "-g" << "system" if new_resource.system

data/lib/chef/provider/user/dscl.rb

@@ -382,7 +382,7 @@ in 'password', with the associated 'salt' and 'iterations'.")
               salt,
               iterations,
               128,
-              OpenSSL::Digest::SHA512.new
+              OpenSSL::Digest.new("SHA512")
             )
           end
 
@@ -627,7 +627,7 @@ in 'password', with the associated 'salt' and 'iterations'.")
             salt,
             current_resource.iterations,
             128,
-            OpenSSL::Digest::SHA512.new
+            OpenSSL::Digest.new("SHA512")
           ).unpack("H*").first == current_resource.password
         end
 

data/lib/chef/provider/user/mac.rb

@@ -102,7 +102,7 @@ class Chef
           shadow_hash_hex = user_plist[:shadow_hash][0]
           return unless shadow_hash_hex && shadow_hash_hex != ""
 
-          # The password infomation is stored in the ShadowHashData key in the
+          # The password information is stored in the ShadowHashData key in the
           # plist. However, parsing it is a bit tricky as the value is itself
           # another encoded binary plist. We have to extract the encoded plist,
           # decode it from hex to a binary plist and then convert the binary
@@ -116,6 +116,8 @@ class Chef
           #
           #  eg:
           #
+          # spellchecker: disable
+          #
           # <array>
           #   <string>77687920 63616e27 74206170 706c6520 6275696c 6420636f 6e736973 74656e74 20746f6f 6c696e67</string>
           # </array>
@@ -126,6 +128,8 @@ class Chef
           #   <data>AADKAAAKAA4LAA0MAAAAAAAAAAA=</data>
           # </array>
           #
+          # spellchecker: disable
+          #
           begin
             shadow_binary_plist = [shadow_hash_hex.delete(" ")].pack("H*")
             shadow_xml_plist = shell_out("plutil", "-convert", "xml1", "-o", "-", "-", input: shadow_binary_plist).stdout
@@ -179,7 +183,7 @@ class Chef
           end
 
           if new_resource.manage_home
-            # "sydadminctl -addUser" will create the home directory if it's
+            # "sysadminctl -addUser" will create the home directory if it's
             # the default /Users/<username>, otherwise it sets it in plist
             # but does not create it. Here we'll ensure that it gets created
             # if we've been given a directory that is not the default.
@@ -491,7 +495,7 @@ class Chef
             convert_to_binary(current_resource.salt),
             current_resource.iterations.to_i,
             128,
-            OpenSSL::Digest::SHA512.new
+            OpenSSL::Digest.new("SHA512")
           ).unpack("H*")[0] != current_resource.password
         end
 
@@ -517,7 +521,7 @@ class Chef
                 salt.string,
                 new_resource.iterations,
                 128,
-                OpenSSL::Digest::SHA512.new
+                OpenSSL::Digest.new("SHA512")
               )
             )
           end
@@ -554,7 +558,7 @@ class Chef
           # 0x0A                                    End of record denoted by \n
           # 0x5C                                    Escaping is denoted by \
           # 0x3A                                    Fields are separated by :
-          # 0x2C                                    Values are seperated by ,
+          # 0x2C                                    Values are separated by ,
           # dsRecTypeStandard:Users                 The record type we're configuring
           # 2                                       How many properties we're going to set
           # dsAttrTypeStandard:RecordName           Property 1: our users record name
@@ -598,7 +602,7 @@ class Chef
 
         def run_sysadminctl(args)
           # sysadminctl doesn't exit with a non-zero code when errors are encountered
-          # and ouputs everything to STDERR instead of STDOUT and STDERR. Therefore we'll
+          # and outputs everything to STDERR instead of STDOUT and STDERR. Therefore we'll
           # return the STDERR and let the caller handle it.
           shell_out!("sysadminctl", args).stderr
         end

data/lib/chef/provider/windows_task.rb

@@ -72,6 +72,7 @@ class Chef
           6 => TaskScheduler::TASK_SIXTH,
           7 => TaskScheduler::TASK_SEVENTH,
           8 => TaskScheduler::TASK_EIGHTH,
+          # cspell:disable-next-line
           9 => TaskScheduler::TASK_NINETH,
           10 => TaskScheduler::TASK_TENTH,
           11 => TaskScheduler::TASK_ELEVENTH,
@@ -93,6 +94,7 @@ class Chef
           27 => TaskScheduler::TASK_TWENTY_SEVENTH,
           28 => TaskScheduler::TASK_TWENTY_EIGHTH,
           29 => TaskScheduler::TASK_TWENTY_NINTH,
+          # cspell:disable-next-line
           30 => TaskScheduler::TASK_THIRTYETH,
           31 => TaskScheduler::TASK_THIRTY_FIRST,
         }.freeze
@@ -229,7 +231,7 @@ class Chef
 
         private
 
-        # seprated command arguments from :command property
+        # separated command arguments from :command property
         def set_command_and_arguments
           cmd, *args = Chef::Util::PathHelper.split_args(new_resource.command)
           new_resource.command = cmd
@@ -577,7 +579,7 @@ class Chef
 
         def logon_type
           # Ref: https://msdn.microsoft.com/en-us/library/windows/desktop/aa383566(v=vs.85).aspx
-          # if nothing is passed as logon_type the TASK_LOGON_SERVICE_ACCOUNT is getting set as default so using that for comparision.
+          # if nothing is passed as logon_type the TASK_LOGON_SERVICE_ACCOUNT is getting set as default so using that for comparison.
           user_id = new_resource.user.to_s
           password = new_resource.password.to_s
           if Chef::ReservedNames::Win32::Security::SID.service_account_user?(user_id)