chef 15.17.4 → 16.0.257

data/lib/chef/resource/windows_share.rb

@@ -26,7 +26,7 @@ require_relative "../util/path_helper"
 class Chef
   class Resource
     class WindowsShare < Chef::Resource
-      resource_name :windows_share
+      provides :windows_share
 
       description "Use the windows_share resource to create, modify and remove Windows shares."
       introduced "14.7"
@@ -145,10 +145,6 @@ class Chef
         read_users r_users
       end
 
-      def after_created
-        raise "The windows_share resource relies on PowerShell cmdlets not present in Windows releases prior to 8/2012. Cannot continue!" if node["platform_version"].to_f < 6.3
-      end
-
       # given the string output of Get-SmbShareAccess parse out
       # arrays of full access users, change users, and read only users
       def parse_permissions(results_string)
@@ -171,8 +167,8 @@ class Chef
         [f_users, c_users, r_users]
       end
 
-      # local names are returned from Get-SmbShareAccess in the full format MACHINE\\NAME
-      # but users of this resource would simply say NAME so we need to strip the values for comparison
+# local names are returned from Get-SmbShareAccess in the full format MACHINE\\NAME
+# but users of this resource would simply say NAME so we need to strip the values for comparison
       def stripped_account(name)
         name.slice!("#{node["hostname"]}\\")
         name

data/lib/chef/resource/windows_shortcut.rb

@@ -21,7 +21,6 @@ require_relative "../resource"
 class Chef
   class Resource
     class WindowsShortcut < Chef::Resource
-      resource_name :windows_shortcut
       provides(:windows_shortcut) { true }
 
       description "Use the windows_shortcut resource to create shortcut files on Windows."

data/lib/chef/resource/windows_task.rb

@@ -22,7 +22,6 @@ require_relative "../win32/security" if Chef::Platform.windows?
 class Chef
   class Resource
     class WindowsTask < Chef::Resource
-      resource_name :windows_task
       provides(:windows_task) { true }
 
       description "Use the windows_task resource to create, delete or run a Windows scheduled task. Requires Windows Server 2008 or later due to API usage."
@@ -122,7 +121,7 @@ class Chef
         description: "The task description."
 
       property :start_when_available, [TrueClass, FalseClass],
-        introduced: "15.0", default: false,
+        introduced: "14.15", default: false,
         description: "To start the task at any time after its scheduled time has passed."
 
       attr_accessor :exists, :task, :command_arguments
@@ -159,16 +158,16 @@ class Chef
 
       private
 
-      ## Resource is not idempotent when day, start_day is not provided with frequency :weekly
-      ## we set start_day when not given by user as current date based on which we set the day property for current current date day is monday ..
-      ## we set the monday as the day so at next run when  new_resource.day is nil and current_resource day is monday due to which udpate gets called
+        ## Resource is not idempotent when day, start_day is not provided with frequency :weekly
+        ## we set start_day when not given by user as current date based on which we set the day property for current current date day is monday ..
+        ## we set the monday as the day so at next run when  new_resource.day is nil and current_resource day is monday due to which udpate gets called
       def idempotency_warning_for_frequency_weekly(day, start_day)
         if start_day.nil? && day.nil?
           logger.warn "To maintain idempotency for frequency :weekly provide start_day, start_time and day."
         end
       end
 
-      # Validate the passed value is numeric values only if it is a string
+        # Validate the passed value is numeric values only if it is a string
       def numeric_value_in_string?(val)
         return true if Integer(val)
       rescue ArgumentError
@@ -194,7 +193,7 @@ class Chef
         end
       end
 
-      # returns true if frequency_modifer has values First, second, third, fourth, last, lastday
+        # returns true if frequency_modifer has values First, second, third, fourth, last, lastday
       def frequency_modifier_includes_days_of_weeks?(frequency_modifier)
         frequency_modifier = frequency_modifier.to_s.split(",")
         frequency_modifier.map! { |value| value.strip.upcase }
@@ -209,7 +208,7 @@ class Chef
         raise ArgumentError, "Invalid value passed for `random_delay`. Please pass seconds as an Integer (e.g. 60) or a String with numeric values only (e.g. '60')." unless numeric_value_in_string?(random_delay)
       end
 
-      # @todo when we drop ruby 2.3 support this should be converted to .match?() instead of =~f
+        # @todo when we drop ruby 2.3 support this should be converted to .match?() instead of =~f
       def validate_start_day(start_day, frequency)
         if start_day && frequency == :none
           raise ArgumentError, "`start_day` property is not supported with frequency: #{frequency}"
@@ -221,7 +220,7 @@ class Chef
         end
       end
 
-      # @todo when we drop ruby 2.3 support this should be converted to .match?() instead of =~
+        # @todo when we drop ruby 2.3 support this should be converted to .match?() instead of =~
       def validate_start_time(start_time, frequency)
         if start_time
           raise ArgumentError, "`start_time` property is not supported with `frequency :none`" if frequency == :none
@@ -321,7 +320,7 @@ class Chef
         end
       end
 
-      # This method returns true if day has values from 1-31 which is a days of moths and used with frequency :monthly
+        # This method returns true if day has values from 1-31 which is a days of moths and used with frequency :monthly
       def days_includes_days_of_months?(days)
         days.map! { |day| day.to_s.strip.downcase }
         (days - VALID_DAYS_OF_MONTH).empty?
@@ -339,11 +338,11 @@ class Chef
         end
       end
 
-      # Converts the number of seconds to an ISO8601 duration format and returns it.
-      # Ref : https://github.com/arnau/ISO8601/blob/master/lib/iso8601/duration.rb#L18-L23
-      # e.g.
-      # ISO8601::Duration.new(65707200).to_s
-      # returns 'PT65707200S'
+        # Converts the number of seconds to an ISO8601 duration format and returns it.
+        # Ref : https://github.com/arnau/ISO8601/blob/master/lib/iso8601/duration.rb#L18-L23
+        # e.g.
+        # ISO8601::Duration.new(65707200).to_s
+        # returns 'PT65707200S'
       def sec_to_dur(seconds)
         ISO8601::Duration.new(seconds.to_i).to_s
       end

data/lib/chef/resource/windows_uac.rb

@@ -20,7 +20,6 @@ require_relative "../resource"
 class Chef
   class Resource
     class WindowsUac < Chef::Resource
-      resource_name :windows_uac
       provides :windows_uac
 
       description 'The windows_uac resource configures UAC on Windows hosts by setting registry keys at \'HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows\CurrentVersion\Policies\System\''

data/lib/chef/resource/windows_user_privilege.rb

@@ -0,0 +1,157 @@
+#
+# Author:: Jared Kauppila (<jared@kauppi.la>)
+# Author:: Vasundhara Jagdale(<vasundhara.jagdale@chef.io>)
+# Copyright:: Copyright (c) Chef Software Inc.
+
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+
+#     http://www.apache.org/licenses/LICENSE-2.0
+
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+require_relative "../resource"
+
+class Chef
+  class Resource
+    class WindowsUserPrivilege < Chef::Resource
+      privilege_opts = %w{SeTrustedCredManAccessPrivilege
+                          SeNetworkLogonRight
+                          SeTcbPrivilege
+                          SeMachineAccountPrivilege
+                          SeIncreaseQuotaPrivilege
+                          SeInteractiveLogonRight
+                          SeRemoteInteractiveLogonRight
+                          SeBackupPrivilege
+                          SeChangeNotifyPrivilege
+                          SeSystemtimePrivilege
+                          SeTimeZonePrivilege
+                          SeCreatePagefilePrivilege
+                          SeCreateTokenPrivilege
+                          SeCreateGlobalPrivilege
+                          SeCreatePermanentPrivilege
+                          SeCreateSymbolicLinkPrivilege
+                          SeDebugPrivilege
+                          SeDenyNetworkLogonRight
+                          SeDenyBatchLogonRight
+                          SeDenyServiceLogonRight
+                          SeDenyInteractiveLogonRight
+                          SeDenyRemoteInteractiveLogonRight
+                          SeEnableDelegationPrivilege
+                          SeRemoteShutdownPrivilege
+                          SeAuditPrivilege
+                          SeImpersonatePrivilege
+                          SeIncreaseWorkingSetPrivilege
+                          SeIncreaseBasePriorityPrivilege
+                          SeLoadDriverPrivilege
+                          SeLockMemoryPrivilege
+                          SeBatchLogonRight
+                          SeServiceLogonRight
+                          SeSecurityPrivilege
+                          SeRelabelPrivilege
+                          SeSystemEnvironmentPrivilege
+                          SeManageVolumePrivilege
+                          SeProfileSingleProcessPrivilege
+                          SeSystemProfilePrivilege
+                          SeUndockPrivilege
+                          SeAssignPrimaryTokenPrivilege
+                          SeRestorePrivilege
+                          SeShutdownPrivilege
+                          SeSyncAgentPrivilege
+                          SeTakeOwnershipPrivilege
+                        }
+
+      provides :windows_user_privilege
+      description "The windows_user_privilege resource allows to add and set principal (User/Group) to the specified privilege. \n Ref: https://docs.microsoft.com/en-us/windows/security/threat-protection/security-policy-settings/user-rights-assignment"
+
+      introduced "16.0"
+
+      property :principal, String,
+        description: "An optional property to add the user to the given privilege. Use only with add and remove action.",
+        name_property: true
+
+      property :users, Array,
+        description: "An optional property to set the privilege for given users. Use only with set action."
+
+      property :privilege, [Array, String],
+        description: "Privilege to set for users.",
+        required: true,
+        coerce: proc { |v| v.is_a?(String) ? Array[v] : v },
+        callbacks: {
+           "Option privilege must include any of the: #{privilege_opts}" => lambda {
+             |v| (privilege_opts & v).size == v.size
+           },
+         }
+
+      load_current_value do |new_resource|
+        unless new_resource.principal.nil?
+          privilege Chef::ReservedNames::Win32::Security.get_account_right(new_resource.principal) unless new_resource.action.include?(:set)
+        end
+      end
+
+      action :add do
+        ([*new_resource.privilege] - [*current_resource.privilege]).each do |user_right|
+          converge_by("adding user '#{new_resource.principal}' privilege #{user_right}") do
+            Chef::ReservedNames::Win32::Security.add_account_right(new_resource.principal, user_right)
+          end
+        end
+      end
+
+      action :set do
+        if new_resource.users.nil? || new_resource.users.empty?
+          raise Chef::Exceptions::ValidationFailed, "Users are required property with set action."
+        end
+
+        users = []
+
+        # Getting users with its domain for comparison
+        new_resource.users.each do |user|
+          user = Chef::ReservedNames::Win32::Security.lookup_account_name(user)
+          users << user[1].account_name if user
+        end
+
+        new_resource.privilege.each do |privilege|
+          accounts = Chef::ReservedNames::Win32::Security.get_account_with_user_rights(privilege)
+
+          # comparing the existing accounts for privilege with users
+          unless users == accounts
+            # Removing only accounts which is not matching with users in new_resource
+            (accounts - users).each do |account|
+              converge_by("removing user '#{account}' from privilege #{privilege}") do
+                Chef::ReservedNames::Win32::Security.remove_account_right(account, privilege)
+              end
+            end
+
+            # Adding only users which is not already exist
+            (users - accounts).each do |user|
+              converge_by("adding user '#{user}' to privilege #{privilege}") do
+                Chef::ReservedNames::Win32::Security.add_account_right(user, privilege)
+              end
+            end
+          end
+        end
+      end
+
+      action :remove do
+        curr_res_privilege = current_resource.privilege
+        missing_res_privileges = (new_resource.privilege - curr_res_privilege)
+
+        if missing_res_privileges
+          Chef::Log.info("User \'#{new_resource.principal}\' for Privilege: #{missing_res_privileges.join(", ")} not found. Nothing to remove.")
+        end
+
+        (new_resource.privilege - missing_res_privileges).each do |user_right|
+          converge_by("removing user #{new_resource.principal} from privilege #{user_right}") do
+            Chef::ReservedNames::Win32::Security.remove_account_right(new_resource.principal, user_right)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/chef/resource/windows_workgroup.rb

@@ -22,7 +22,6 @@ require_relative "../dist"
 class Chef
   class Resource
     class WindowsWorkgroup < Chef::Resource
-      resource_name :windows_workgroup
       provides :windows_workgroup
 
       include Chef::Mixin::PowershellOut

data/lib/chef/resource/yum_package.rb

@@ -22,7 +22,9 @@ require_relative "../dist"
 class Chef
   class Resource
     class YumPackage < Chef::Resource::Package
-      resource_name :yum_package
+      unified_mode true
+
+      provides :yum_package
       provides :package, platform_family: "fedora_derived"
 
       description "Use the yum_package resource to install, upgrade, and remove packages with Yum"\

data/lib/chef/resource/yum_repository.rb

@@ -21,7 +21,8 @@ require_relative "../resource"
 class Chef
   class Resource
     class YumRepository < Chef::Resource
-      resource_name :yum_repository
+      unified_mode true
+
       provides(:yum_repository) { true }
 
       description "Use the yum_repository resource to manage a Yum repository configuration"\

data/lib/chef/resource/zypper_package.rb

@@ -20,9 +20,10 @@ require_relative "package"
 
 class Chef
   class Resource
-
     class ZypperPackage < Chef::Resource::Package
-      resource_name :zypper_package
+      unified_mode true
+
+      provides :zypper_package
       provides :package, platform_family: "suse"
 
       description "Use the zypper_package resource to install, upgrade, and remove packages with Zypper for the SUSE Enterprise and OpenSUSE platforms."

data/lib/chef/resource/zypper_repository.rb

@@ -21,7 +21,8 @@ require_relative "../resource"
 class Chef
   class Resource
     class ZypperRepository < Chef::Resource
-      resource_name :zypper_repository
+      unified_mode true
+
       provides(:zypper_repository) { true }
       provides(:zypper_repo) { true }
 

data/lib/chef/resource_builder.rb

@@ -73,6 +73,14 @@ class Chef
       # Run optional resource hook
       resource.after_created
 
+      # Force to compile_time execution if the flag is set
+      if resource.compile_time
+        Array(resource.action).each do |action|
+          resource.run_action(action)
+        end
+        resource.action :nothing
+      end
+
       resource
     end
 

data/lib/chef/resource_inspector.rb

@@ -58,7 +58,8 @@ module ResourceInspector
                deprecated: opts[:deprecated] || false,
                required: opts[:required] || false,
                default: opts[:default_description] || get_default(opts[:default]),
-               name_property: opts[:name_property] || false }
+               name_property: opts[:name_property] || false,
+               equal_to: opts[:equal_to] || [] }
     end
     data
   end
@@ -68,8 +69,8 @@ module ResourceInspector
     dir, name = File.split(path)
     Chef::Cookbook::FileVendor.fetch_from_disk(path)
     loader = Chef::CookbookLoader.new(dir)
-    cookbook = loader.load_cookbook(name)
-    resources = cookbook.files_for(:resources)
+    cookbooks = loader.load_cookbooks
+    resources = cookbooks[name].files_for(:resources)
 
     resources.each_with_object({}) do |r, res|
       pth = r["full_path"]
@@ -82,18 +83,17 @@ module ResourceInspector
   # otherwise, if we have a path then extract all the resources from the cookbook
   # or else do a list of built in resources
   #
-  # @param arguments [Array, String] One of more paths to a cookbook or a resource file to inspect
   # @param complete [TrueClass, FalseClass] Whether to show properties defined in the base Resource class
   # @return [String] JSON formatting of all resources
   def self.inspect(arguments = [], complete: false)
     output = if arguments.empty?
                ObjectSpace.each_object(Class).select { |k| k < Chef::Resource }.each_with_object({}) { |klass, acc| acc[klass.resource_name] = extract_resource(klass) }
              else
-               Array(arguments).each_with_object({}) do |arg, acc|
+               arguments.each_with_object({}) do |arg, acc|
                  if File.directory?(arg)
                    extract_cookbook(arg, complete).each { |k, v| acc[k] = v }
                  else
-                   r = Chef::ResourceResolver.resolve(arg.to_sym, canonical: nil)
+                   r = Chef::ResourceResolver.resolve(arg.to_sym)
                    acc[r.resource_name] = extract_resource(r, complete)
                  end
                end

data/lib/chef/resource_resolver.rb

@@ -29,8 +29,8 @@ class Chef
     # @param node [Chef::Node] The node against which to resolve. `nil` causes
     #   platform filters to be ignored.
     #
-    def self.resolve(resource_name, node: nil, canonical: nil)
-      new(node, resource_name, canonical: canonical).resolve
+    def self.resolve(resource_name, node: nil)
+      new(node, resource_name).resolve
     end
 
     #
@@ -40,11 +40,9 @@ class Chef
     # @param resource_name [Symbol] The resource DSL name (e.g. `:file`).
     # @param node [Chef::Node] The node against which to resolve. `nil` causes
     #   platform filters to be ignored.
-    # @param canonical [Boolean] `true` or `false` to match canonical or
-    #   non-canonical values only. `nil` to ignore canonicality.
     #
-    def self.list(resource_name, node: nil, canonical: nil)
-      new(node, resource_name, canonical: canonical).list
+    def self.list(resource_name, node: nil)
+      new(node, resource_name).list
     end
 
     include Chef::Mixin::ConvertToClassName
@@ -55,8 +53,6 @@ class Chef
     attr_reader :resource_name
     # @api private
     attr_reader :action
-    # @api private
-    attr_reader :canonical
 
     #
     # Create a resolver.
@@ -64,14 +60,11 @@ class Chef
     # @param node [Chef::Node] The node against which to resolve. `nil` causes
     #   platform filters to be ignored.
     # @param resource_name [Symbol] The resource DSL name (e.g. `:file`).
-    # @param canonical [Boolean] `true` or `false` to match canonical or
-    #   non-canonical values only. `nil` to ignore canonicality.  Default: `nil`
     #
     # @api private use Chef::ResourceResolver.resolve or .list instead.
-    def initialize(node, resource_name, canonical: nil)
+    def initialize(node, resource_name)
       @node = node
       @resource_name = resource_name.to_sym
-      @canonical = canonical
     end
 
     # @api private use Chef::ResourceResolver.resolve instead.
@@ -135,7 +128,7 @@ class Chef
 
     # @api private
     def potential_handlers
-      handler_map.list(node, resource_name, canonical: canonical).uniq
+      handler_map.list(node, resource_name).uniq
     end
 
     def enabled_handlers
@@ -146,7 +139,7 @@ class Chef
       @prioritized_handlers ||= begin
         enabled_handlers = self.enabled_handlers
 
-        prioritized = priority_map.list(node, resource_name, canonical: canonical).flatten(1)
+        prioritized = priority_map.list(node, resource_name).flatten(1)
         prioritized &= enabled_handlers # Filter the priority map by the actual enabled handlers
         prioritized |= enabled_handlers # Bring back any handlers that aren't in the priority map, at the *end* (ordered set)
         prioritized