chef 16.0.275 → 16.2.50

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] ]
@@ -340,6 +340,7 @@ class Chef
       # can also be overridden).  Exclude has priority over include, although the caller is likely better
       # off doing the set arithmetic themselves for explicitness.
       #
+      # ```ruby
       # action :doit do
       #   # use it inside a block
       #   file "/etc/whatever.xyz" do
@@ -350,10 +351,11 @@ class Chef
       #   r = declare_resource(:file, "etc/whatever.xyz")
       #   r.copy_properties_from(new_resource, :owner, :group, :mode)
       # end
+      # ```
       #
       # @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/node/mixin/deep_merge_cache.rb

@@ -19,9 +19,9 @@ class Chef
   class Node
     module Mixin
       module DeepMergeCache
-       # Cache of deep merged values by top-level key.  This is a simple hash which has keys that are the
-       # top-level keys of the node object, and we save the computed deep-merge for that key here.  There is
-       # no cache of subtrees.
+        # Cache of deep merged values by top-level key.  This is a simple hash which has keys that are the
+        # top-level keys of the node object, and we save the computed deep-merge for that key here.  There is
+        # no cache of subtrees.
         attr_accessor :deep_merge_cache
 
         def initialize
@@ -31,10 +31,10 @@ class Chef
           @deep_merge_cache = {}
         end
 
-       # Invalidate a key in the deep_merge_cache.  If called with nil, or no arg, this will invalidate
-       # the entire deep_merge cache.  In the case of the user doing node.default['foo']['bar']['baz']=
-       # that eventually results in a call to reset_cache('foo') here.  A node.default=hash_thing call
-       # must invalidate the entire cache and re-deep-merge the entire node object.
+        # Invalidate a key in the deep_merge_cache.  If called with nil, or no arg, this will invalidate
+        # the entire deep_merge cache.  In the case of the user doing node.default['foo']['bar']['baz']=
+        # that eventually results in a call to reset_cache('foo') here.  A node.default=hash_thing call
+        # must invalidate the entire cache and re-deep-merge the entire node object.
         def reset_cache(path = nil)
           if path.nil?
             deep_merge_cache.clear

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

@@ -34,7 +34,7 @@ class Chef
     # @param script [String] script to run
     # @return [Object] output
     def initialize(script)
-      raise "Chef::PowerShell can only be used on the Windows platform." unless RUBY_PLATFORM =~ /mswin|mingw32|windows/
+      raise "Chef::PowerShell can only be used on the Windows platform." unless RUBY_PLATFORM.match?(/mswin|mingw32|windows/)
 
       exec(script)
     end

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

@@ -24,22 +24,15 @@ class Chef
 
       provides :batch
 
-      def initialize(new_resource, run_context)
-        super(new_resource, run_context, ".bat")
-      end
-
       def command
-        basepath = is_forced_32bit ? wow64_directory : run_context.node["kernel"]["os_info"]["system_directory"]
-
         interpreter_path = Chef::Util::PathHelper.join(basepath, interpreter)
 
-        "\"#{interpreter_path}\" #{flags} \"#{script_file.path}\""
+        "\"#{interpreter_path}\" #{new_resource.flags} /c \"#{script_file_path}\""
       end
 
-      def flags
-        new_resource.flags.nil? ? "/c" : new_resource.flags + " /c"
+      def script_extension
+        ".bat"
       end
-
     end
   end
 end

data/lib/chef/provider/cron.rb

@@ -15,7 +15,6 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-
 require_relative "../log"
 require_relative "../provider"
 
@@ -27,8 +26,6 @@ class Chef
 
       SPECIAL_TIME_VALUES = %i{reboot yearly annually monthly weekly daily midnight hourly}.freeze
       CRON_ATTRIBUTES = %i{minute hour day month weekday time command mailto path shell home environment}.freeze
-      WEEKDAY_SYMBOLS = %i{sunday monday tuesday wednesday thursday friday saturday}.freeze
-
       CRON_PATTERN = %r{\A([-0-9*,/]+)\s([-0-9*,/]+)\s([-0-9*,/]+)\s([-0-9*,/]+|[a-zA-Z]{3})\s([-0-9*,/]+|[a-zA-Z]{3})\s(.*)}.freeze
       SPECIAL_PATTERN = /\A(@(#{SPECIAL_TIME_VALUES.join('|')}))\s(.*)/.freeze
       ENV_PATTERN = /\A(\S+)=(\S*)/.freeze
@@ -259,8 +256,8 @@ class Chef
         return "" if new_resource.time_out.empty?
 
         str = " timeout"
-        str << " --preserve-status" if new_resource.time_out["preserve-status"].to_s.downcase == "true"
-        str << " --foreground" if new_resource.time_out["foreground"].to_s.downcase == "true"
+        str << " --preserve-status" if new_resource.time_out["preserve-status"].to_s.casecmp("true") == 0
+        str << " --foreground" if new_resource.time_out["foreground"].to_s.casecmp("true") == 0
         str << " --kill-after #{new_resource.time_out["kill-after"]}" if new_resource.time_out["kill-after"]
         str << " --signal #{new_resource.time_out["signal"]}" if new_resource.time_out["signal"]
         str << " #{new_resource.time_out["duration"]};"
@@ -288,15 +285,6 @@ class Chef
 
         newcron.join("\n")
       end
-
-      def weekday_in_crontab
-        weekday_in_crontab = WEEKDAY_SYMBOLS.index(new_resource.weekday)
-        if weekday_in_crontab.nil?
-          new_resource.weekday
-        else
-          weekday_in_crontab.to_s
-        end
-      end
     end
   end
 end

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

@@ -27,7 +27,7 @@ class Chef
 
       provides :execute, target_mode: true
 
-      def_delegators :new_resource, :command, :returns, :environment, :user, :domain, :password, :group, :cwd, :umask, :creates, :elevated, :default_env, :timeout
+      def_delegators :new_resource, :command, :returns, :environment, :user, :domain, :password, :group, :cwd, :umask, :creates, :elevated, :default_env, :timeout, :input
 
       def load_current_resource
         current_resource = Chef::Resource::Execute.new(new_resource.name)
@@ -91,6 +91,7 @@ class Chef
         opts[:group]       = group if group
         opts[:cwd]         = cwd if cwd
         opts[:umask]       = umask if umask
+        opts[:input]       = input if input
         opts[:default_env] = default_env
         opts[:log_level]   = :info
         opts[:log_tag]     = new_resource.to_s

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/group/dscl.rb

@@ -39,7 +39,7 @@ class Chef
           result = dscl(*args)
           return "" if ( args.first =~ /^delete/ ) && ( result[1].exitstatus != 0 )
           raise(Chef::Exceptions::Group, "dscl error: #{result.inspect}") unless result[1].exitstatus == 0
-          raise(Chef::Exceptions::Group, "dscl error: #{result.inspect}") if result[2] =~ /No such key: /
+          raise(Chef::Exceptions::Group, "dscl error: #{result.inspect}") if /No such key: /.match?(result[2])
 
           result[2]
         end
@@ -77,7 +77,7 @@ class Chef
           gid = nil; next_gid_guess = 200
           groups_gids = safe_dscl("list", "/Groups", "gid")
           while next_gid_guess < search_limit + 200
-            if groups_gids =~ Regexp.new("#{Regexp.escape(next_gid_guess.to_s)}\n")
+            if groups_gids&.match?(Regexp.new("#{Regexp.escape(next_gid_guess.to_s)}\n"))
               next_gid_guess += 1
             else
               gid = next_gid_guess

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

@@ -17,7 +17,7 @@
 #
 
 require_relative "../user"
-if RUBY_PLATFORM =~ /mswin|mingw32|windows/
+if RUBY_PLATFORM.match?(/mswin|mingw32|windows/)
   require_relative "../../util/windows/net_group"
 end
 

data/lib/chef/provider/ifconfig.rb

@@ -59,12 +59,12 @@ class Chef
 
         @net_tools_version = shell_out("ifconfig", "--version")
         @net_tools_version.stdout.each_line do |line|
-          if line =~ /^net-tools (\d+\.\d+)/
+          if /^net-tools (\d+\.\d+)/.match?(line)
             @ifconfig_version = line.match(/^net-tools (\d+\.\d+)/)[1]
           end
         end
         @net_tools_version.stderr.each_line do |line|
-          if line =~ /^net-tools (\d+\.\d+)/
+          if /^net-tools (\d+\.\d+)/.match?(line)
             @ifconfig_version = line.match(/^net-tools (\d+\.\d+)/)[1]
           end
         end
@@ -88,11 +88,11 @@ class Chef
               @int_name = line[0..9].strip
               @interfaces[@int_name] = { "hwaddr" => (line =~ /(HWaddr)/ ? ($') : "nil").strip.chomp }
             else
-              @interfaces[@int_name]["inet_addr"] = (line =~ /inet addr:(\S+)/ ? Regexp.last_match(1) : "nil") if line =~ /inet addr:/
-              @interfaces[@int_name]["bcast"] = (line =~ /Bcast:(\S+)/ ? Regexp.last_match(1) : "nil") if line =~ /Bcast:/
-              @interfaces[@int_name]["mask"] = (line =~ /Mask:(\S+)/ ? Regexp.last_match(1) : "nil") if line =~ /Mask:/
-              @interfaces[@int_name]["mtu"] = (line =~ /MTU:(\S+)/ ? Regexp.last_match(1) : "nil") if line =~ /MTU:/
-              @interfaces[@int_name]["metric"] = (line =~ /Metric:(\S+)/ ? Regexp.last_match(1) : "nil") if line =~ /Metric:/
+              @interfaces[@int_name]["inet_addr"] = (line =~ /inet addr:(\S+)/ ? Regexp.last_match(1) : "nil") if /inet addr:/.match?(line)
+              @interfaces[@int_name]["bcast"] = (line =~ /Bcast:(\S+)/ ? Regexp.last_match(1) : "nil") if /Bcast:/.match?(line)
+              @interfaces[@int_name]["mask"] = (line =~ /Mask:(\S+)/ ? Regexp.last_match(1) : "nil") if /Mask:/.match?(line)
+              @interfaces[@int_name]["mtu"] = (line =~ /MTU:(\S+)/ ? Regexp.last_match(1) : "nil") if /MTU:/.match?(line)
+              @interfaces[@int_name]["metric"] = (line =~ /Metric:(\S+)/ ? Regexp.last_match(1) : "nil") if /Metric:/.match?(line)
             end
 
             next unless @interfaces.key?(new_resource.device)

data/lib/chef/provider/launchd.rb

@@ -36,7 +36,6 @@ class Chef
         label
         mode
         owner
-        path
         source
         session_type
         type
@@ -44,7 +43,6 @@ class Chef
 
       def load_current_resource
         current_resource = Chef::Resource::Launchd.new(new_resource.name)
-        @path = path ? path : gen_path_from_type
       end
 
       def gen_path_from_type
@@ -64,23 +62,23 @@ class Chef
       end
 
       action :delete do
-        # If you delete a service you want to make sure its not loaded or
-        # the service will be in memory and you wont be able to stop it.
-        if ::File.exists?(@path)
+        if ::File.exists?(path)
           manage_service(:disable)
         end
         manage_plist(:delete)
       end
 
       action :enable do
-        if manage_plist(:create)
-          manage_service(:restart)
-        else
-          manage_service(:enable)
+        manage_service(:nothing)
+        manage_plist(:create) do
+          notifies :restart, "macosx_service[#{label}]", :immediately
         end
+        manage_service(:enable)
       end
 
       action :disable do
+        return unless ::File.exist?(path)
+
         manage_service(:disable)
       end
 
@@ -88,39 +86,32 @@ class Chef
         manage_service(:restart)
       end
 
-      def manage_plist(action)
+      def manage_plist(action, &block)
         if source
-          cookbook_file @path do
-            cookbook_name = cookbook if cookbook
-            name(@path) if @path
-            backup(backup) if backup
-            group(group) if group
-            mode(mode) if mode
-            owner(owner) if owner
-            source(source) if source
+          cookbook_file path do
+            cookbook_name = new_resource.cookbook if new_resource.cookbook
+            copy_properties_from(new_resource, :backup, :group, :mode, :owner, :source)
             action(action)
             only_if { manage_agent?(action) }
+            instance_eval(&block) if block_given?
           end
         else
-          file @path do
-            name(@path) if @path
-            backup(backup) if backup
-            content(content) if content?
-            group(group) if group
-            mode(mode) if mode
-            owner(owner) if owner
+          file path do
+            copy_properties_from(new_resource, :backup, :group, :mode, :owner)
+            content(file_content) if file_content?
             action(action)
             only_if { manage_agent?(action) }
+            instance_eval(&block) if block_given?
           end
         end
       end
 
       def manage_service(action)
+        plist_path = path
         macosx_service label do
-          name(label) if label
-          service_name(label) if label
-          plist(@path) if @path
-          session_type(session_type) if session_type
+          service_name(new_resource.label) if new_resource.label
+          plist(plist_path) if plist_path
+          copy_properties_from(new_resource, :session_type)
           action(action)
           only_if { manage_agent?(action) }
         end
@@ -155,11 +146,11 @@ class Chef
         end
       end
 
-      def content?
-        !!content
+      def file_content?
+        !!file_content
       end
 
-      def content
+      def file_content
         plist_hash = new_resource.plist_hash || gen_hash
         ::Plist::Emit.dump(plist_hash) unless plist_hash.nil?
       end
@@ -215,6 +206,11 @@ class Chef
           memo[val] = new_resource.send(key) if new_resource.send(key)
         end
       end
+
+      # @api private
+      def path
+        @path ||= new_resource.path ? new_resource.path : gen_path_from_type
+      end
     end
   end
 end