chef 16.18.30-universal-mingw32 → 17.0.242-universal-mingw32

data/lib/chef/resource/windows_firewall_rule.rb

@@ -185,8 +185,7 @@ class Chef
         enabled state["enabled"]
       end
 
-      action :create do
-        description "Create a Windows firewall entry."
+      action :create, description: "Create a Windows firewall entry" do
         if current_resource
           converge_if_changed :rule_name, :description, :displayname, :local_address, :local_port, :remote_address,
             :remote_port, :direction, :protocol, :icmp_type, :firewall_action, :profile, :program, :service,
@@ -207,9 +206,7 @@ class Chef
         end
       end
 
-      action :delete do
-        description "Delete an existing Windows firewall entry."
-
+      action :delete, description: "Delete an existing Windows firewall entry" do
         if current_resource
           converge_by("delete firewall rule #{new_resource.rule_name}") do
             powershell_exec!("Remove-NetFirewallRule -Name '#{new_resource.rule_name}'")

data/lib/chef/resource/windows_font.rb

@@ -45,11 +45,9 @@ class Chef
         description: "A local filesystem path or URI that is used to source the font file.",
         coerce: proc { |x| /^.:.*/.match?(x) ? x.tr('\\', "/").gsub("//", "/") : x }
 
-      action :install do
-        description "Install a font to the system fonts directory."
-
+      action :install, description: "Install a font to the system fonts directory" do
         if font_exists?
-          logger.trace("Not installing font: #{new_resource.font_name} as font already installed.")
+          logger.debug("Not installing font: #{new_resource.font_name} as font already installed.")
         else
           retrieve_cookbook_font
           install_font

data/lib/chef/resource/windows_pagefile.rb

@@ -73,9 +73,7 @@ class Chef
       property :maximum_size, Integer,
         description: "Maximum size of the pagefile in megabytes."
 
-      action :set do
-        description "Configures the default pagefile, creating if it doesn't exist."
-
+      action :set, description: "Configures the default pagefile, creating if it doesn't exist" do
         pagefile = new_resource.path
         initial_size = new_resource.initial_size
         maximum_size = new_resource.maximum_size
@@ -103,9 +101,7 @@ class Chef
         end
       end
 
-      action :delete do
-        description "Deletes the specified pagefile."
-
+      action :delete, description: "Deletes the specified pagefile" do
         validate_name
         delete(new_resource.path) if exists?(new_resource.path)
       end

data/lib/chef/resource/windows_path.rb

@@ -64,7 +64,7 @@ class Chef
         end
       end
 
-      action :add do
+      action :add, description: "Add an item to the system path" do
         # The windows Env provider does not correctly expand variables in
         # the PATH environment variable. Ruby expects these to be expanded.
         #
@@ -76,7 +76,7 @@ class Chef
         end
       end
 
-      action :remove do
+      action :remove, description: "Remove an item from the system path" do
         # The windows Env provider does not correctly expand variables in
         # the PATH environment variable. Ruby expects these to be expanded.
         #

data/lib/chef/resource/windows_printer.rb

@@ -86,11 +86,11 @@ class Chef
       PRINTERS_REG_KEY = 'HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows NT\CurrentVersion\Print\Printers\\'.freeze unless defined?(PRINTERS_REG_KEY)
 
       # @todo Set @current_resource printer properties from registry
-      load_current_value do |desired|
-        name desired.name
+      load_current_value do |new_resource|
+        name new_resource.name
       end
 
-      action :create do
+      action :create, description: "Create a new printer and printer port, if one doesn't already" do
         description "Create a new printer and a printer port if one doesn't already exist."
 
         if printer_exists?
@@ -102,7 +102,7 @@ class Chef
         end
       end
 
-      action :delete do
+      action :delete, description: "Delete an existing printer. Note that this resource does not delete the associated printer port." do
         description "Delete an existing printer. Note this does not delete the associated printer port."
 
         if printer_exists?

data/lib/chef/resource/windows_printer_port.rb

@@ -89,13 +89,13 @@ class Chef
       PORTS_REG_KEY = 'HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\Print\Monitors\Standard TCP/IP Port\Ports\\'.freeze unless defined?(PORTS_REG_KEY)
 
       # @todo Set @current_resource port properties from registry
-      load_current_value do |desired|
-        name desired.name
-        ipv4_address desired.ipv4_address
-        port_name desired.port_name || "IP_#{desired.ipv4_address}"
+      load_current_value do |new_resource|
+        name new_resource.name
+        ipv4_address new_resource.ipv4_address
+        port_name new_resource.port_name || "IP_#{new_resource.ipv4_address}"
       end
 
-      action :create do
+      action :create, description: "Create the printer port, if one doesn't already exist" do
         description "Create the new printer port if it does not already exist."
 
         if port_exists?
@@ -107,7 +107,7 @@ class Chef
         end
       end
 
-      action :delete do
+      action :delete, description: "Delete an existing printer port" do
         description "Delete an existing printer port."
 
         if port_exists?

data/lib/chef/resource/windows_security_policy.rb

@@ -28,7 +28,6 @@ class Chef
 
       # The valid policy_names options found here
       # https://github.com/ChrisAWalker/cSecurityOptions under 'AccountSettings'
-      # This needs to be revisited - the list at the link above is non-exhaustive and is missing a couple of items
       policy_names = %w{LockoutDuration
                         MaximumPasswordAge
                         MinimumPasswordAge
@@ -37,8 +36,6 @@ class Chef
                         PasswordHistorySize
                         LockoutBadCount
                         ResetLockoutCount
-                        AuditPolicyChange
-                        LockoutDuration
                         RequireLogonToChangePassword
                         ForceLogoffWhenHourExpire
                         NewAdministratorName
@@ -86,22 +83,22 @@ class Chef
       property :secvalue, String, required: true,
       description: "Policy value to be set for policy name."
 
-      load_current_value do |desired|
+      load_current_value do |new_resource|
         current_state = load_security_options
 
-        if desired.secoption == "ResetLockoutCount"
-          if desired.secvalue.to_i > 30
+        if new_resource.secoption == "ResetLockoutCount"
+          if new_resource.secvalue.to_i > 30
             raise Chef::Exceptions::ValidationFailed, "The \"ResetLockoutCount\" value cannot be greater than 30 minutes"
           end
         end
-        if (desired.secoption == "ResetLockoutCount" || desired.secoption == "LockoutDuration") && current_state["LockoutBadCount"] == "0"
-          raise Chef::Exceptions::ValidationFailed, "#{desired.secoption} cannot be set unless the \"LockoutBadCount\" security policy has been set to a non-zero value"
+        if (new_resource.secoption == "ResetLockoutCount" || new_resource.secoption == "LockoutDuration") && current_state["LockoutBadCount"] == "0"
+          raise Chef::Exceptions::ValidationFailed, "#{new_resource.secoption} cannot be set unless the \"LockoutBadCount\" security policy has been set to a non-zero value"
         end
 
-        secvalue current_state[desired.secoption.to_s]
+        secvalue current_state[new_resource.secoption.to_s]
       end
 
-      action :set do
+      action :set, description: "Set the Windows security policy" do
         converge_if_changed :secvalue do
           security_option = new_resource.secoption
           security_value = new_resource.secvalue
@@ -118,13 +115,13 @@ class Chef
             policy_line = "#{security_option} = \"#{security_value}\""
             file.write("[Unicode]\r\nUnicode=yes\r\n[System Access]\r\n#{policy_line}\r\n[Version]\r\nsignature=\"$CHICAGO$\"\r\nRevision=1\r\n")
             file.close
-            file_path = file.path.gsub("/", '\\')
+            file_path = file.path.tr("/", '\\')
             cmd = "C:\\Windows\\System32\\secedit /configure /db C:\\windows\\security\\new.sdb /cfg #{file_path} /areas SECURITYPOLICY"
           else
             policy_line = "#{security_option} = #{security_value}"
             file.write("[Unicode]\r\nUnicode=yes\r\n[System Access]\r\n#{policy_line}\r\n[Version]\r\nsignature=\"$CHICAGO$\"\r\nRevision=1\r\n")
             file.close
-            file_path = file.path.gsub("/", '\\')
+            file_path = file.path.tr("/", '\\')
             cmd = "C:\\Windows\\System32\\secedit /configure /db C:\\windows\\security\\new.sdb /cfg #{file_path} /areas SECURITYPOLICY"
           end
           shell_out!(cmd)

data/lib/chef/resource/windows_share.rb

@@ -70,17 +70,17 @@ class Chef
       # Specifies which accounts are granted full permission to access the share. Use a comma-separated list to specify multiple accounts. An account may not be specified more than once in the FullAccess, ChangeAccess, or ReadAccess parameter lists, but may be specified once in the FullAccess, ChangeAccess, or ReadAccess parameter list and once in the NoAccess parameter list.
       property :full_users, Array,
         description: "The users that should have 'Full control' permissions on the share in domain\\username format.",
-        default: lazy { [] }, coerce: proc { |u| u.sort }
+        default: [], coerce: proc { |u| u.sort }
 
       # Specifies which users are granted modify permission to access the share
       property :change_users, Array,
         description: "The users that should have 'modify' permission on the share in domain\\username format.",
-        default: lazy { [] }, coerce: proc { |u| u.sort }
+        default: [], coerce: proc { |u| u.sort }
 
       # Specifies which users are granted read permission to access the share. Multiple users can be specified by supplying a comma-separated list.
       property :read_users, Array,
         description: "The users that should have 'read' permission on the share in domain\\username format.",
-        default: lazy { [] }, coerce: proc { |u| u.sort }
+        default: [], coerce: proc { |u| u.sort }
 
       # Specifies the lifetime of the new SMB share. A temporary share does not persist beyond the next restart of the computer. By default, new SMB shares are persistent, and non-temporary.
       property :temporary, [TrueClass, FalseClass],
@@ -118,11 +118,11 @@ class Chef
       # Specifies which files and folders in the SMB share are visible to users. AccessBased: SMB does not the display the files and folders for a share to a user unless that user has rights to access the files and folders. By default, access-based enumeration is disabled for new SMB shares. Unrestricted: SMB displays files and folders to a user even when the user does not have permission to access the items.
       # property :folder_enumeration_mode, String, equal_to: %(AccessBased Unrestricted)
 
-      load_current_value do |desired|
+      load_current_value do |new_resource|
         # this command selects individual objects because EncryptData & CachingMode have underlying
         # types that get converted to their Integer values by ConvertTo-Json & we need to make sure
         # those get written out as strings
-        share_state_cmd = "Get-SmbShare -Name '#{desired.share_name}' | Select-Object Name,Path, Description, Temporary, CATimeout, ContinuouslyAvailable, ConcurrentUserLimit, EncryptData"
+        share_state_cmd = "Get-SmbShare -Name '#{new_resource.share_name}' | Select-Object Name,Path, Description, Temporary, CATimeout, ContinuouslyAvailable, ConcurrentUserLimit, EncryptData"
 
         Chef::Log.debug("Running '#{share_state_cmd}' to determine share state'")
         ps_results = powershell_exec(share_state_cmd)
@@ -146,14 +146,14 @@ class Chef
         encrypt_data results["EncryptData"]
         # folder_enumeration_mode results['FolderEnumerationMode']
 
-        perm_state_cmd = %{Get-SmbShareAccess -Name "#{desired.share_name}" | Select-Object AccountName,AccessControlType,AccessRight}
+        perm_state_cmd = %{Get-SmbShareAccess -Name "#{new_resource.share_name}" | Select-Object AccountName,AccessControlType,AccessRight}
 
         Chef::Log.debug("Running '#{perm_state_cmd}' to determine share permissions state'")
         ps_perm_results = powershell_exec(perm_state_cmd)
 
         # we raise here instead of warning like above because we'd only get here if the above Get-SmbShare
         # command was successful and that continuing would leave us with 1/2 known state
-        raise "Could not determine #{desired.share_name} share permissions by running '#{perm_state_cmd}'" if ps_perm_results.error?
+        raise "Could not determine #{new_resource.share_name} share permissions by running '#{perm_state_cmd}'" if ps_perm_results.error?
 
         Chef::Log.debug("The Get-SmbShareAccess results were #{ps_perm_results.result}")
 
@@ -192,9 +192,7 @@ class Chef
         name
       end
 
-      action :create do
-        description "Create and modify Windows shares."
-
+      action :create, description: "Create or modify a Windows share" do
         # we do this here instead of requiring the property because :delete doesn't need path set
         raise "No path property set" unless new_resource.path
 
@@ -218,9 +216,7 @@ class Chef
         end
       end
 
-      action :delete do
-        description "Delete an existing Windows share."
-
+      action :delete, description: "Delete an existing Windows share" do
         if current_resource.nil?
           Chef::Log.debug("#{new_resource.share_name} does not exist - nothing to do")
         else
@@ -275,14 +271,11 @@ class Chef
         # users/groups will have their permissions updated with the same command that
         # sets it, but removes must be performed with Revoke-SmbShareAccess
         def users_to_revoke
-          @users_to_revoke ||= begin
-            # if the resource doesn't exist then nothing needs to be revoked
-            if current_resource.nil?
-              []
-            else # if it exists then calculate the current to new resource diffs
-              (current_resource.full_users + current_resource.change_users + current_resource.read_users) - (new_resource.full_users + new_resource.change_users + new_resource.read_users)
-            end
-          end
+          @users_to_revoke ||= if current_resource.nil?
+                                 []
+                               else # if it exists then calculate the current to new resource diffs
+                                 (current_resource.full_users + current_resource.change_users + current_resource.read_users) - (new_resource.full_users + new_resource.change_users + new_resource.read_users)
+                               end
         end
 
         # update existing permissions on a share

data/lib/chef/resource/windows_shortcut.rb

@@ -57,11 +57,11 @@ class Chef
       property :iconlocation, String,
         description: "Icon to use for the shortcut. Accepts the format of `path, index`, where index is the icon file to use. See Microsoft's [documentation](https://msdn.microsoft.com/en-us/library/3s9bx7at.aspx) for details"
 
-      load_current_value do |desired|
+      load_current_value do |new_resource|
         require "win32ole" if RUBY_PLATFORM.match?(/mswin|mingw32|windows/)
 
-        link = WIN32OLE.new("WScript.Shell").CreateShortcut(desired.shortcut_name)
-        name desired.shortcut_name
+        link = WIN32OLE.new("WScript.Shell").CreateShortcut(new_resource.shortcut_name)
+        name new_resource.shortcut_name
         target(link.TargetPath)
         arguments(link.Arguments)
         description(link.Description)
@@ -69,9 +69,7 @@ class Chef
         iconlocation(link.IconLocation)
       end
 
-      action :create do
-        description "Create or modify a Windows shortcut."
-
+      action :create, description: "Create or modify a Windows shortcut" do
         converge_if_changed do
           converge_by "creating shortcut #{new_resource.shortcut_name}" do
             link = WIN32OLE.new("WScript.Shell").CreateShortcut(new_resource.shortcut_name)

data/lib/chef/resource/windows_task.rb

@@ -21,6 +21,7 @@ require_relative "../resource"
 require_relative "../win32/security" if ChefUtils.windows_ruby?
 autoload :ISO8601, "iso8601" if ChefUtils.windows_ruby?
 require_relative "../util/path_helper"
+require_relative "../util/backup"
 require "win32/taskscheduler" if ChefUtils.windows_ruby?
 
 class Chef
@@ -236,6 +237,10 @@ class Chef
         introduced: "14.15", default: false,
         description: "To start the task at any time after its scheduled time has passed."
 
+      property :backup, [Integer, FalseClass],
+        introduced: "17.0", default: 5,
+        description: "Number of backups to keep of the task when modified/deleted. Set to false to disable backups."
+
       attr_accessor :exists, :task, :command_arguments
 
       VALID_WEEK_DAYS = %w{ mon tue wed thu fri sat sun * }.freeze
@@ -564,6 +569,7 @@ class Chef
 
         def update_task(task)
           converge_by("#{new_resource} task updated") do
+            do_backup
             task.set_account_information(new_resource.user, new_resource.password, new_resource.interactive_enabled)
             task.application_name = new_resource.command if new_resource.command
             task.parameters = new_resource.command_arguments if new_resource.command_arguments
@@ -948,6 +954,11 @@ class Chef
         def get_day(date)
           Date.strptime(date, "%m/%d/%Y").strftime("%a").upcase
         end
+
+        def do_backup
+          file = "C:/Windows/System32/Tasks/#{new_resource.task_name}"
+          Chef::Util::Backup.new(new_resource, file).backup!
+        end
       end
 
       action :create do
@@ -998,7 +1009,7 @@ class Chef
             end
           end
         else
-          logger.warn "#{new_resource} task does not exist - nothing to do"
+          logger.debug "#{new_resource} task does not exist - nothing to do"
         end
       end
 
@@ -1006,11 +1017,12 @@ class Chef
         if current_resource.exists
           logger.trace "#{new_resource} task exists"
           converge_by("delete scheduled task #{new_resource}") do
+            do_backup
             ts = ::Win32::TaskScheduler.new
             ts.delete(current_resource.task_name)
           end
         else
-          logger.warn "#{new_resource} task does not exist - nothing to do"
+          logger.debug "#{new_resource} task does not exist - nothing to do"
         end
       end
 
@@ -1018,14 +1030,14 @@ class Chef
         if current_resource.exists
           logger.trace "#{new_resource} task exists"
           if current_resource.task.status != "running"
-            logger.trace "#{new_resource} is not running - nothing to do"
+            logger.debug "#{new_resource} is not running - nothing to do"
           else
             converge_by("#{new_resource} task ended") do
               current_resource.task.stop
             end
           end
         else
-          logger.warn "#{new_resource} task does not exist - nothing to do"
+          logger.debug "#{new_resource} task does not exist - nothing to do"
         end
       end
 
@@ -1038,7 +1050,7 @@ class Chef
               run_schtasks "CHANGE", "ENABLE" => ""
             end
           else
-            logger.trace "#{new_resource} already enabled - nothing to do"
+            logger.debug "#{new_resource} already enabled - nothing to do"
           end
         else
           logger.fatal "#{new_resource} task does not exist - nothing to do"

data/lib/chef/resource/windows_uac.rb

@@ -72,7 +72,7 @@ class Chef
         equal_to: %i{auto_deny secure_prompt_for_creds prompt_for_creds},
         default: :prompt_for_creds
 
-      action :configure do
+      action :configure, description: "Configures UAC by setting registry keys at `HKEY_LOCAL_MACHINE\\SOFTWARE\\Microsoft\\Windows\\CurrentVersion\\Policies\\System`" do
         description 'Configures UAC by setting registry keys at \'HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows\CurrentVersion\Policies\System\''
 
         registry_key 'HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows\CurrentVersion\Policies\System' do
@@ -106,9 +106,7 @@ class Chef
         #
         # @return [Integer]
         def consent_behavior_users_symbol_to_reg(sym)
-          # Since 2 isn't a valid value for ConsentPromptBehaviorUser, assign the value at index as nil.
-          # https://docs.microsoft.com/en-us/windows/security/identity-protection/user-account-control/user-account-control-group-policy-and-registry-key-settings#registry-key-settings
-          [:auto_deny, :secure_prompt_for_creds, nil, :prompt_for_creds].index(sym)
+          %i{auto_deny secure_prompt_for_creds prompt_for_creds}.index(sym)
         end
       end
     end

data/lib/chef/resource/windows_user_privilege.rb

@@ -24,7 +24,7 @@ class Chef
       unified_mode true
 
       provides :windows_user_privilege
-      description "The windows_user_privilege resource allows to add a privilege to a principal or (User/Group).\n Ref: https://docs.microsoft.com/en-us/windows/security/threat-protection/security-policy-settings/user-rights-assignment"
+      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"
 
@@ -39,32 +39,23 @@ class Chef
       end
       ```
 
-      **Provide only the Builtin Guests and Administrator Groups with the SeCreatePageFile Privilege**:
-
-      ```ruby
-      windows_user_privilege 'Create Pagefile' do
-        privilege      'SeCreatePagefilePrivilege'
-        users          ['BUILTIN\\Guests', 'BUILTIN\\Administrators']
-        action         :set
-      end
-      ```
-
-      **Add the SeDenyRemoteInteractiveLogonRight Privilege to the 'Remote interactive logon' principal**:
+      **Add the SeDenyRemoteInteractiveLogonRight Privilege to the Builtin Guests and Local Accounts User Groups**:
 
       ```ruby
       windows_user_privilege 'Remote interactive logon' do
         privilege      'SeDenyRemoteInteractiveLogonRight'
+        users          ['Builtin\\Guests', 'NT AUTHORITY\\Local Account']
         action         :add
       end
       ```
 
-      **Add to the Builtin Guests Group the SeCreatePageFile Privilege**:
+      **Provide only the Builtin Guests and Administrator Groups with the SeCreatePageFile Privilege**:
 
       ```ruby
-      windows_user_privilege 'Guests add Create Pagefile' do
-        principal      'BUILTIN\\Guests'
+      windows_user_privilege 'Create Pagefile' do
         privilege      'SeCreatePagefilePrivilege'
-        action         :add
+        users          ['BUILTIN\\Guests', 'BUILTIN\\Administrators']
+        action         :set
       end
       ```
 
@@ -99,7 +90,6 @@ class Chef
                            SeCreateSymbolicLinkPrivilege
                            SeCreateTokenPrivilege
                            SeDebugPrivilege
-                           SeDelegateSessionUserImpersonatePrivilege
                            SeDenyBatchLogonRight
                            SeDenyInteractiveLogonRight
                            SeDenyNetworkLogonRight
@@ -136,20 +126,20 @@ class Chef
                           }.freeze
 
       property :principal, String,
-               description: "An optional property to add the privilege for given principal. Use only with add and remove action. Principal can either be a User/Group or one of special identities found here Ref: https://docs.microsoft.com/en-us/windows/security/identity-protection/access-control/special-identities",
-               name_property: true
+        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, String],
-               description: "An optional property to set the privilege for given users. Use only with set action.",
-               coerce: proc { |v| Array(v) }
+        description: "An optional property to set the privilege for given users. Use only with set action.",
+        coerce: proc { |v| Array(v) }
 
       property :privilege, [Array, String],
-               description: "One or more privileges to set for principal or users/groups. For more information on what each privilege does Ref: https://learn.microsoft.com/en-us/windows/security/threat-protection/security-policy-settings/user-rights-assignment",
-               required: true,
-               coerce: proc { |v| Array(v) },
-               callbacks: {
-                 "Privilege property restricted to the following values: #{PRIVILEGE_OPTS}" => lambda { |n| (n - PRIVILEGE_OPTS).empty? },
-               }, identity: true
+        description: "One or more privileges to set for users.",
+        required: true,
+        coerce: proc { |v| Array(v) },
+        callbacks: {
+          "Privilege property restricted to the following values: #{PRIVILEGE_OPTS}" => lambda { |n| (n - PRIVILEGE_OPTS).empty? },
+        }
 
       load_current_value do |new_resource|
         if new_resource.principal && (new_resource.action.include?(:add) || new_resource.action.include?(:remove))
@@ -157,15 +147,15 @@ class Chef
         end
       end
 
-      action :add, description: "Add a privileges to a principal." do
-        ([*new_resource.privilege] - [*current_resource.privilege]).each do |principal_right|
-          converge_by("adding principal '#{new_resource.principal}' privilege #{principal_right}") do
-            Chef::ReservedNames::Win32::Security.add_account_right(new_resource.principal, principal_right)
+      action :add, description: "Add a user privilege" 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, description: "Set the privileges that are listed in the `privilege` property for only the users listed in the `users` property. All other users not listed with given privilege will be have the privilege removed." do
+      action :set, description: "Set the privileges that are listed in the `privilege` property for only the users listed in the `users` property" do
         if new_resource.users.nil? || new_resource.users.empty?
           raise Chef::Exceptions::ValidationFailed, "Users are required property with set action."
         end
@@ -214,7 +204,7 @@ class Chef
         end
       end
 
-      action :remove, description: "Remove a principal privilege" do
+      action :remove, description: "Remove a user privilege" do
         curr_res_privilege = current_resource.privilege
         missing_res_privileges = (new_resource.privilege - curr_res_privilege)
 
@@ -222,9 +212,9 @@ class Chef
           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 |principal_right|
-          converge_by("removing principal #{new_resource.principal} from privilege #{principal_right}") do
-            Chef::ReservedNames::Win32::Security.remove_account_right(new_resource.principal, principal_right)
+        (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

data/lib/chef/resource/windows_workgroup.rb

@@ -87,8 +87,7 @@ class Chef
       property :sensitive, [TrueClass, FalseClass],
         default: true, desired_state: false
 
-      action :join do
-        description "Update the workgroup."
+      action :join, description: "Update the workgroup." do
 
         unless workgroup_member?
           converge_by("join workstation workgroup #{new_resource.workgroup_name}") do

data/lib/chef/resource.rb

@@ -1513,7 +1513,7 @@ class Chef
     # @return Chef::CookbookVersion The cookbook in which this Resource was defined.
     #
     def cookbook_version
-      if cookbook_name && cookbook_name != "@recipe_files"
+      if cookbook_name
         run_context.cookbook_collection[cookbook_name]
       end
     end

data/lib/chef/resource_reporter.rb

@@ -41,7 +41,7 @@ class Chef
       as_hash["result"] = action_record.action.to_s
       if new_resource.cookbook_name
         as_hash["cookbook_name"] = new_resource.cookbook_name
-        as_hash["cookbook_version"] = new_resource.cookbook_version&.version
+        as_hash["cookbook_version"] = new_resource.cookbook_version.version
       end
 
       as_hash

data/lib/chef/resources.rb

@@ -125,7 +125,6 @@ require_relative "resource/smartos_package"
 require_relative "resource/template"
 require_relative "resource/user"
 require_relative "resource/user/aix_user"
-require_relative "resource/user/dscl_user"
 require_relative "resource/user/linux_user"
 require_relative "resource/user/mac_user"
 require_relative "resource/user/pw_user"

data/lib/chef/shell/ext.rb

@@ -198,9 +198,9 @@ module Shell
           prints a detailed explanation of the command if available, or the
           description if no explanation is available.
       E
-      def help(command = nil)
-        if command
-          explain_command(command)
+      def help(commmand = nil)
+        if commmand
+          explain_command(commmand)
         else
           puts help_banner
         end

data/lib/chef/user.rb

@@ -36,7 +36,6 @@ require_relative "server_api"
 # should be removed once client support for Open Source Chef Server 11 expires.
 class Chef
   class User
-
     include Chef::Mixin::FromFile
     include Chef::Mixin::ParamsValidate
 

data/lib/chef/user_v1.rb

@@ -145,11 +145,11 @@ class Chef
         payload = {
           username: @username,
           display_name: @display_name,
-          first_name: @first_name,
-          last_name: @last_name,
           email: @email,
-          password: @password,
         }
+        payload[:first_name] = @first_name unless @first_name.nil?
+        payload[:last_name] = @last_name unless @last_name.nil?
+        payload[:password] = @password unless @password.nil?
         payload[:public_key] = @public_key unless @public_key.nil?
         payload[:create_key] = @create_key unless @create_key.nil?
         payload[:middle_name] = @middle_name unless @middle_name.nil?
@@ -258,7 +258,6 @@ class Chef
     end
 
     # Class Methods
-
     def self.from_hash(user_hash)
       user = Chef::UserV1.new
       user.username user_hash["username"]

data/lib/chef/util/dsc/configuration_generator.rb

@@ -88,6 +88,7 @@ class Chef::Util::DSC
         when FalseClass
           switch_present = false
         when TrueClass
+          # nothing
         when String
           switch_argument = escape_string_parameter_value(switch_value)
         else