chef 15.17.4 → 16.0.257

data/lib/chef/provider/user.rb

@@ -116,7 +116,7 @@ class Chef
         false
       end
 
-      def action_create
+      action :create do
         if !@user_exists
           converge_by("create user #{new_resource.username}") do
             create_user
@@ -130,7 +130,7 @@ class Chef
         end
       end
 
-      def action_remove
+      action :remove do
         return unless @user_exists
 
         converge_by("remove user #{new_resource.username}") do
@@ -139,7 +139,7 @@ class Chef
         end
       end
 
-      def action_manage
+      action :manage do
         return unless @user_exists && compare_user
 
         converge_by("manage user #{new_resource.username}") do
@@ -148,7 +148,7 @@ class Chef
         end
       end
 
-      def action_modify
+      action :modify do
         return unless compare_user
 
         converge_by("modify user #{new_resource.username}") do
@@ -157,7 +157,7 @@ class Chef
         end
       end
 
-      def action_lock
+      action :lock do
         if check_lock == false
           converge_by("lock the user #{new_resource.username}") do
             lock_user
@@ -168,7 +168,7 @@ class Chef
         end
       end
 
-      def action_unlock
+      action :unlock do
         if check_lock == true
           converge_by("unlock user #{new_resource.username}") do
             unlock_user

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

@@ -118,7 +118,7 @@ in 'password', with the associated 'salt' and 'iterations'.")
 
               # Calling shell_out directly since we want to give an input stream
               shadow_hash_xml = convert_binary_plist_to_xml(shadow_hash_binary.string)
-              shadow_hash = Plist.parse_xml(shadow_hash_xml)
+              shadow_hash = ::Plist.parse_xml(shadow_hash_xml)
 
               if shadow_hash["SALTED-SHA512-PBKDF2"] # 10.7+ contains this, but we retain the check in case it goes away in the future
                 @password_shadow_conversion_algorithm = "SALTED-SHA512-PBKDF2"
@@ -541,7 +541,7 @@ in 'password', with the associated 'salt' and 'iterations'.")
           begin
             user_plist_file = "#{USER_PLIST_DIRECTORY}/#{new_resource.username}.plist"
             user_plist_info = run_plutil("convert", "xml1", "-o", "-", user_plist_file)
-            user_info = Plist.parse_xml(user_plist_info)
+            user_info = ::Plist.parse_xml(user_plist_info)
           rescue Chef::Exceptions::PlistUtilCommandFailed
           end
 
@@ -554,7 +554,7 @@ in 'password', with the associated 'salt' and 'iterations'.")
         #
         def save_user_info(user_info)
           user_plist_file = "#{USER_PLIST_DIRECTORY}/#{new_resource.username}.plist"
-          Plist::Emit.save_plist(user_info, user_plist_file)
+          ::Plist::Emit.save_plist(user_info, user_plist_file)
           run_plutil("convert", "binary1", user_plist_file)
         end
 

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

@@ -22,6 +22,7 @@ require_relative "../../mixin/shell_out"
 require_relative "../../mixin/which"
 require_relative "../user"
 require_relative "../../resource/user/mac_user"
+require "plist"
 
 class Chef
   class Provider
@@ -196,12 +197,12 @@ class Chef
             # group management should be done outside of the core resource.
             group_name, group_id, group_action = user_group_info
 
-            declare_resource(:group, group_name) do
+            group group_name do
               members new_resource.username
               gid group_id if group_id
-              action :nothing
+              action group_action
               append true
-            end.run_action(group_action)
+            end
 
             converge_by("create primary group ID") do
               run_dscl("create", "/Users/#{new_resource.username}", "PrimaryGroupID", group_id)
@@ -246,16 +247,16 @@ class Chef
 
           if diverged?(:admin)
             converge_by("alter admin group membership") do
-              declare_resource(:group, "admin") do
+              group "admin" do
                 if new_resource.admin
                   members new_resource.username
                 else
                   excluded_members new_resource.username
                 end
 
-                action :nothing
+                action :create
                 append true
-              end.run_action(:create)
+              end
 
               admins = admin_group_plist[:group_members]
               if new_resource.admin
@@ -271,12 +272,12 @@ class Chef
           end
 
           group_name, group_id, group_action = user_group_info
-          declare_resource(:group, group_name) do
+          group group_name do
             gid group_id if group_id
             members new_resource.username
-            action :nothing
+            action group_action
             append true
-          end.run_action(group_action)
+          end
 
           if diverged?(:gid)
             converge_by("alter group membership") do

data/lib/chef/provider/whyrun_safe_ruby_block.rb

@@ -21,7 +21,7 @@ class Chef
     class WhyrunSafeRubyBlock < Chef::Provider::RubyBlock
       provides :whyrun_safe_ruby_block
 
-      def action_run
+      action :run do
         new_resource.block.call
         new_resource.updated_by_last_action(true)
         @run_context.events.resource_update_applied(new_resource, :create, "execute the whyrun_safe_ruby_block #{new_resource.name}")

data/lib/chef/provider/windows_env.rb

@@ -78,7 +78,7 @@ class Chef
 
       alias_method :compare_value, :requires_modify_or_create?
 
-      def action_create
+      action :create do
         if @key_exists
           if requires_modify_or_create?
             modify_env
@@ -123,7 +123,7 @@ class Chef
         end
       end
 
-      def action_delete
+      action :delete do
         if ( ENV[new_resource.key_name] || @key_exists ) && !delete_element
           delete_env
           logger.info("#{new_resource} deleted")
@@ -131,7 +131,7 @@ class Chef
         end
       end
 
-      def action_modify
+      action :modify do
         if @key_exists
           if requires_modify_or_create?
             modify_env

data/lib/chef/provider/windows_script.rb

@@ -46,7 +46,7 @@ class Chef
 
       public
 
-      def action_run
+      action :run do
         wow64_redirection_state = nil
 
         if @is_wow64
@@ -54,7 +54,7 @@ class Chef
         end
 
         begin
-          super
+          super()
         rescue
           raise
         ensure

data/lib/chef/provider/windows_task.rb

@@ -19,7 +19,6 @@
 require_relative "../mixin/shell_out"
 require "rexml/document" unless defined?(REXML::Document)
 require "iso8601" if ChefUtils.windows?
-require_relative "../mixin/powershell_out"
 require_relative "../provider"
 require_relative "../util/path_helper"
 require "win32/taskscheduler" if ChefUtils.windows?
@@ -28,7 +27,6 @@ class Chef
   class Provider
     class WindowsTask < Chef::Provider
       include Chef::Mixin::ShellOut
-      include Chef::Mixin::PowershellOut
 
       if ChefUtils.windows?
         include Win32
@@ -115,7 +113,7 @@ class Chef
           @current_resource
         end
 
-        def action_create
+        action :create do
           set_command_and_arguments if new_resource.command
 
           if current_resource.exists
@@ -152,7 +150,7 @@ class Chef
           end
         end
 
-        def action_run
+        action :run do
           if current_resource.exists
             logger.trace "#{new_resource} task exists"
             if current_resource.task.status == "running"
@@ -167,7 +165,7 @@ class Chef
           end
         end
 
-        def action_delete
+        action :delete do
           if current_resource.exists
             logger.trace "#{new_resource} task exists"
             converge_by("delete scheduled task #{new_resource}") do
@@ -179,7 +177,7 @@ class Chef
           end
         end
 
-        def action_end
+        action :end do
           if current_resource.exists
             logger.trace "#{new_resource} task exists"
             if current_resource.task.status != "running"
@@ -194,7 +192,7 @@ class Chef
           end
         end
 
-        def action_enable
+        action :enable do
           if current_resource.exists
             logger.trace "#{new_resource} task exists"
             if current_resource.task.status == "not scheduled"
@@ -211,7 +209,7 @@ class Chef
           end
         end
 
-        def action_disable
+        action :disable do
           if current_resource.exists
             logger.info "#{new_resource} task exists"
             if %w{ready running}.include?(current_resource.task.status)
@@ -426,7 +424,7 @@ class Chef
             when TaskScheduler::AT_LOGON
               # TODO: handle option for this trigger
             when TaskScheduler::AT_SYSTEMSTART
-            # TODO: handle option for this trigger
+              # TODO: handle option for this trigger
           end
         end
 

data/lib/chef/provider/yum_repository.rb

@@ -37,7 +37,7 @@ class Chef
           if template_available?(new_resource.source)
             source new_resource.source
           else
-            source ::File.expand_path("support/yum_repo.erb", __dir__)
+            source ::File.expand_path("../support/yum_repo.erb", __FILE__)
             local true
           end
           sensitive new_resource.sensitive

data/lib/chef/provider/zypper_repository.rb

@@ -41,7 +41,7 @@ class Chef
           if template_available?(new_resource.source)
             source new_resource.source
           else
-            source ::File.expand_path("support/zypper_repo.erb", __dir__)
+            source ::File.expand_path("../support/zypper_repo.erb", __FILE__)
             local true
           end
           sensitive new_resource.sensitive
@@ -115,48 +115,28 @@ class Chef
         end
       end
 
-      # the version of gpg installed on the system
-      #
-      # @return [Gem::Version] the version of GPG
-      def gpg_version
-        so = shell_out!("gpg --version")
-        # matches 2.0 and 2.2 versions from SLES 12 and 15: https://rubular.com/r/e6D0WfGK6SXvUp
-        version = /gpg \(GnuPG\)\s*(.*)/.match(so.stdout)[1]
-        logger.trace("GPG package version is #{version}")
-        Gem::Version.new(version)
-      end
-
       # is the provided key already installed
       # @param [String] key_path the path to the key on the local filesystem
       #
       # @return [boolean] is the key already known by rpm
       def key_installed?(key_path)
-        so = shell_out("/bin/rpm -qa gpg-pubkey*")
+        so = shell_out("rpm -qa gpg-pubkey*")
         # expected output & match: http://rubular.com/r/RdF7EcXEtb
-        status = /gpg-pubkey-#{short_key_id(key_path)}/.match(so.stdout)
+        status = /gpg-pubkey-#{key_fingerprint(key_path)}/.match(so.stdout)
         logger.trace("GPG key at #{key_path} is known by rpm? #{status ? "true" : "false"}")
         status
       end
 
-      # extract the gpg key's short key id from a local file. Learning moment: This 8 hex value ID
-      # is sometimes incorrectly called the fingerprint. The fingerprint is the full length value
-      # and googling for that will just result in sad times.
-      #
+      # extract the gpg key fingerprint from a local file
       # @param [String] key_path the path to the key on the local filesystem
       #
-      # @return [String] the short key id of the key
-      def short_key_id(key_path)
-        if gpg_version >= Gem::Version.new("2.2") # SLES 15+
-          so = shell_out!("gpg --import-options import-show --dry-run --import --with-colons #{key_path}")
-          # expected output and match: https://rubular.com/r/uXWJo3yfkli1qA
-          short_key_id = /fpr:*\h*(\h{8}):/.match(so.stdout)[1].downcase
-        else # SLES 12 and earlier
-          so = shell_out!("gpg --with-fingerprint #{key_path}")
-          # expected output and match: http://rubular.com/r/BpfMjxySQM
-          short_key_id = %r{pub\s*\S*/(\S*)}.match(so.stdout)[1].downcase
-        end
-        logger.trace("GPG short key ID of key at #{key_path} is #{short_key_id}")
-        short_key_id
+      # @return [String] the fingerprint of the key
+      def key_fingerprint(key_path)
+        so = shell_out!("gpg --with-fingerprint #{key_path}")
+        # expected output and match: http://rubular.com/r/BpfMjxySQM
+        fingerprint = %r{pub\s*\S*/(\S*)}.match(so.stdout)[1].downcase
+        logger.trace("GPG fingerprint of key at #{key_path} is #{fingerprint}")
+        fingerprint
       end
 
       # install the provided gpg key

data/lib/chef/providers.rb

@@ -16,9 +16,6 @@
 # limitations under the License.
 #
 
-require_relative "provider/apt_update"
-require_relative "provider/apt_preference"
-require_relative "provider/apt_repository"
 require_relative "provider/batch"
 require_relative "provider/cookbook_file"
 require_relative "provider/cron"
@@ -35,9 +32,6 @@ require_relative "provider/http_request"
 require_relative "provider/ifconfig"
 require_relative "provider/launchd"
 require_relative "provider/link"
-require_relative "provider/log"
-require_relative "provider/ohai"
-require_relative "provider/mdadm"
 require_relative "provider/mount"
 require_relative "provider/noop"
 require_relative "provider/package"

data/lib/chef/recipe.rb

@@ -17,6 +17,7 @@
 # limitations under the License.
 #
 
+require "yaml"
 require_relative "dsl/recipe"
 require_relative "mixin/from_file"
 require_relative "mixin/deprecation"
@@ -85,6 +86,41 @@ class Chef
       end
     end
 
+    def from_yaml_file(filename)
+      self.source_file = filename
+      if File.file?(filename) && File.readable?(filename)
+        yaml_contents = IO.read(filename)
+        if ::YAML.load_stream(yaml_contents).length > 1
+          raise ArgumentError, "YAML recipe '#{filename}' contains multiple documents, only one is supported"
+        end
+
+        from_yaml(yaml_contents)
+      else
+        raise IOError, "Cannot open or read file '#{filename}'!"
+      end
+    end
+
+    def from_yaml(string)
+      res = ::YAML.safe_load(string)
+      unless res.is_a?(Hash) && res.key?("resources")
+        raise ArgumentError, "YAML recipe '#{source_file}' must contain a top-level 'resources' hash (YAML sequence), i.e. 'resources:'"
+      end
+
+      from_hash(res)
+    end
+
+    def from_hash(hash)
+      hash["resources"].each do |rhash|
+        type = rhash.delete("type").to_sym
+        name = rhash.delete("name")
+        res = declare_resource(type, name)
+        rhash.each do |key, value|
+          # FIXME?: we probably need a way to instance_exec a string that contains block code against the property?
+          res.send(key, value)
+        end
+      end
+    end
+
     def to_s
       "cookbook: #{cookbook_name ? cookbook_name : "(none)"}, recipe: #{recipe_name ? recipe_name : "(none)"} "
     end

data/lib/chef/resource.rb

@@ -415,7 +415,6 @@ class Chef
       @not_if
     end
 
-    #
     # The number of times to retry this resource if it fails by throwing an
     # exception while running an action.  Default: 0
     #
@@ -427,7 +426,6 @@ class Chef
     #
     property :retries, Integer, default: 0, desired_state: false
 
-    #
     # The number of seconds to wait between retries.  Default: 2.
     #
     # @param arg [Integer] The number of seconds to wait between retries.
@@ -435,7 +433,6 @@ class Chef
     #
     property :retry_delay, Integer, default: 2, desired_state: false
 
-    #
     # Whether to treat this resource's data as sensitive.  If set, no resource
     # data will be displayed in log output.
     #
@@ -444,7 +441,16 @@ class Chef
     #
     property :sensitive, [ TrueClass, FalseClass ], default: false, desired_state: false
 
+    # If this is set the resource will be set to run at compile time and the converge time
+    # action will be set to :nothing.
+    #
+    # @param arg [Boolean] Whether or not to force this resource to run at compile time.
+    # @return [Boolean] Whether or not to force this resource to run at compile time.
     #
+    property :compile_time, [TrueClass, FalseClass],
+      description: "Determines whether or not the resource is executed during the compile time phase.",
+      default: false, desired_state: false
+
     # The time it took (in seconds) to run the most recently-run action.  Not
     # cumulative across actions.  This is set to 0 as soon as a new action starts
     # running, and set to the elapsed time at the end of the action.
@@ -458,7 +464,6 @@ class Chef
     #
     attr_accessor :executed_by_runner
 
-    #
     # The guard interpreter that will be used to process `only_if` and `not_if`
     # statements.  If left unset, the #default_guard_interpreter will be used.
     #
@@ -493,7 +498,7 @@ class Chef
       state = {}
       state_properties = self.class.state_properties
       state_properties.each do |property|
-        if property.identity? || property.is_set?(self)
+        if property.is_set?(self)
           state[property.name] = property.sensitive? ? "*sensitive value suppressed*" : send(property.name)
         end
       end
@@ -613,7 +618,6 @@ class Chef
     # Do NOT use this. It may be removed. It is for internal purposes only.
     # @api private
     attr_reader :resource_initializing
-
     def resource_initializing=(value)
       if value
         @resource_initializing = true
@@ -864,7 +868,6 @@ class Chef
     #   have.
     #
     attr_writer :allowed_actions
-
     def allowed_actions(value = NOT_PASSED)
       if value != NOT_PASSED
         self.allowed_actions = value
@@ -937,13 +940,7 @@ class Chef
     #
     # The display name of this resource type, for printing purposes.
     #
-    # This also automatically calls "provides" to provide DSL with the given
-    # name.
-    #
-    # resource_name defaults to your class name.
-    #
-    # Call `resource_name nil` to remove the resource name (and any
-    # corresponding DSL).
+    # Call `resource_name nil` to remove the resource name
     #
     # @param value [Symbol] The desired name of this resource type (e.g.
     #   `execute`), or `nil` if this class is abstract and has no resource_name.
@@ -953,16 +950,13 @@ class Chef
     def self.resource_name(name = NOT_PASSED)
       # Setter
       if name != NOT_PASSED
-        remove_canonical_dsl
-
-        # Set the resource_name and call provides
         if name
+          @resource_name = name.to_sym
           name = name.to_sym
-          # If our class is not already providing this name, provide it.
+          # FIXME: determine a way to deprecate this magic behavior
           unless Chef::ResourceResolver.includes_handler?(name, self)
-            provides name, canonical: true
+            provides name
           end
-          @resource_name = name
         else
           @resource_name = nil
         end
@@ -976,19 +970,6 @@ class Chef
       resource_name(name)
     end
 
-    #
-    # Use the class name as the resource name.
-    #
-    # Munges the last part of the class name from camel case to snake case,
-    # and sets the resource_name to that:
-    #
-    # A::B::BlahDBlah -> blah_d_blah
-    #
-    def self.use_automatic_resource_name
-      automatic_name = convert_to_snake_case(name.split("::")[-1])
-      resource_name automatic_name
-    end
-
     # If the resource's action should run in separated compile/converge mode.
     #
     # @param flag [Boolean] value to set unified_mode to
@@ -1320,12 +1301,6 @@ class Chef
     def self.inherited(child)
       super
       @@sorted_descendants = nil
-      # set resource_name automatically if it's not set
-      if child.name && !child.resource_name
-        if child.name =~ /^Chef::Resource::(\w+)$/
-          child.resource_name(convert_to_snake_case($1))
-        end
-      end
     end
 
     # If an unknown method is invoked, determine whether the enclosing Provider's
@@ -1347,9 +1322,7 @@ class Chef
     #
     # Since resource_name calls provides the generally correct way of doing this is
     # to do `chef_version_for_provides` first, then `resource_name` and then
-    # any additional options `provides` lines.  Calling `resource_name` is somewhat
-    # important to have the canonical_dsl removed or else that'll stick around
-    # and chef_version won't get applied to it.
+    # any additional options `provides` lines.
     #
     # Once we no longer care about supporting chef < 14.4 then we can deprecate
     # this API.
@@ -1373,17 +1346,14 @@ class Chef
       # quell warnings
       @chef_version_for_provides = nil unless defined?(@chef_version_for_provides)
 
-      # `provides :resource_name, os: 'linux'`) needs to remove the old
-      # canonical DSL before adding the new one.
-      if @resource_name && name == @resource_name
-        remove_canonical_dsl
-      end
+      # deliberately do not go through the accessor here
+      @resource_name = name if resource_name.nil?
 
       if @chef_version_for_provides && !options.include?(:chef_version)
         options[:chef_version] = @chef_version_for_provides
       end
 
-      result = Chef.resource_handler_map.set(name, self, options, &block)
+      result = Chef.resource_handler_map.set(name, self, **options, &block)
       Chef::DSL::Resources.add_resource_dsl(name)
       result
     end
@@ -1491,6 +1461,20 @@ class Chef
       @default_description
     end
 
+    # Use a partial code fragment.  This can be used for code sharing between multiple resources.
+    #
+    # Do not wrap the code fragment in a class or module.  It also does not support the use of super
+    # to subclass any methods defined in the fragment, the methods will just be overwritten.
+    #
+    # @param partial [String] the code fragment to eval against the class
+    #
+    def self.use(partial)
+      dirname = ::File.dirname(partial)
+      basename = ::File.basename(partial, ".rb")
+      basename = basename[1..-1] if basename.start_with?("_")
+      class_eval IO.read(::File.expand_path("#{dirname}/_#{basename}.rb", ::File.dirname(caller_locations.first.absolute_path)))
+    end
+
     # The cookbook in which this Resource was defined (if any).
     #
     # @return Chef::CookbookVersion The cookbook in which this Resource was defined.
@@ -1587,7 +1571,7 @@ class Chef
     # <Chef::Resource>:: returns the proper Chef::Resource class
     #
     def self.resource_matching_short_name(short_name)
-      Chef::ResourceResolver.resolve(short_name, canonical: true)
+      Chef::ResourceResolver.resolve(short_name)
     end
 
     # @api private
@@ -1602,13 +1586,14 @@ class Chef
       self.class.resource_for_node(name, node).new("name", run_context).provider_for_action(action).class
     end
 
-    def self.remove_canonical_dsl
-      if @resource_name
-        remaining = Chef.resource_handler_map.delete_canonical(@resource_name, self)
-        unless remaining
-          Chef::DSL::Resources.remove_resource_dsl(@resource_name)
-        end
-      end
+    # This is used to suppress the "(up to date)" message in the doc formatter
+    # for the log resource (where it is nonsensical).
+    #
+    # This is not exactly a private API, but its doubtful there exist many other sane
+    # use cases for this.
+    #
+    def suppress_up_to_date_messages?
+      false
     end
   end
 end