chef 18.10.17 → 19.1.164

data/lib/chef/resource/windows_task.rb

@@ -1,6 +1,6 @@
 #
 # Author:: Nimisha Sharad (<nimisha.sharad@msystechnologies.com>)
-# Copyright:: Copyright (c) Chef Software Inc.
+# Copyright:: Copyright (c) 2009-2026 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -33,118 +33,118 @@ class Chef
       description "Use the **windows_task** resource to create, delete or run a Windows scheduled task."
       introduced "13.0"
       examples <<~DOC
-        **Create a scheduled task to run every 15 minutes as the Administrator user**:
-
-        ```ruby
-        windows_task 'chef-client' do
-          user 'Administrator'
-          password 'password'
-          command 'chef-client'
-          run_level :highest
-          frequency :minute
-          frequency_modifier 15
-        end
-        ```
+      **Create a scheduled task to run every 15 minutes as the Administrator user**:
+
+      ```ruby
+      windows_task 'chef-client' do
+        user 'Administrator'
+        password 'password'
+        command 'chef-client'
+        run_level :highest
+        frequency :minute
+        frequency_modifier 15
+      end
+      ```
 
-        **Create a scheduled task to run every 2 days**:
+      **Create a scheduled task to run every 2 days**:
 
-        ```ruby
-        windows_task 'chef-client' do
-          command 'chef-client'
-          run_level :highest
-          frequency :daily
-          frequency_modifier 2
-        end
-        ```
+      ```ruby
+      windows_task 'chef-client' do
+        command 'chef-client'
+        run_level :highest
+        frequency :daily
+        frequency_modifier 2
+      end
+      ```
 
-        **Create a scheduled task to run on specific days of the week**:
+      **Create a scheduled task to run on specific days of the week**:
 
-        ```ruby
-        windows_task 'chef-client' do
-          command 'chef-client'
-          run_level :highest
-          frequency :weekly
-          day 'Mon, Thu'
-        end
-        ```
+      ```ruby
+      windows_task 'chef-client' do
+        command 'chef-client'
+        run_level :highest
+        frequency :weekly
+        day 'Mon, Thu'
+      end
+      ```
 
-        **Create a scheduled task to run only once**:
+      **Create a scheduled task to run only once**:
 
-        ```ruby
-        windows_task 'chef-client' do
-          command 'chef-client'
-          run_level :highest
-          frequency :once
-          start_time '16:10'
-        end
-        ```
+      ```ruby
+      windows_task 'chef-client' do
+        command 'chef-client'
+        run_level :highest
+        frequency :once
+        start_time '16:10'
+      end
+      ```
 
-        **Create a scheduled task to run on current day every 3 weeks and delay upto 1 min**:
+      **Create a scheduled task to run on current day every 3 weeks and delay upto 1 min**:
 
-        ```ruby
-        windows_task 'chef-client' do
-          command 'chef-client'
-          run_level :highest
-          frequency :weekly
-          frequency_modifier 3
-          random_delay '60'
-        end
-        ```
+      ```ruby
+      windows_task 'chef-client' do
+        command 'chef-client'
+        run_level :highest
+        frequency :weekly
+        frequency_modifier 3
+        random_delay '60'
+      end
+      ```
 
-        **Create a scheduled task to run weekly starting on Dec 28th 2018**:
+      **Create a scheduled task to run weekly starting on Dec 28th 2018**:
 
-        ```ruby
-        windows_task 'chef-client 8' do
-          command 'chef-client'
-          run_level :highest
-          frequency :weekly
-          start_day '12/28/2018'
-        end
-        ```
+      ```ruby
+      windows_task 'chef-client 8' do
+        command 'chef-client'
+        run_level :highest
+        frequency :weekly
+        start_day '12/28/2018'
+      end
+      ```
 
-        **Create a scheduled task to run every Monday, Friday every 2 weeks**:
+      **Create a scheduled task to run every Monday, Friday every 2 weeks**:
 
-        ```ruby
-        windows_task 'chef-client' do
-          command 'chef-client'
-          run_level :highest
-          frequency :weekly
-          frequency_modifier 2
-          day 'Mon, Fri'
-        end
-        ```
+      ```ruby
+      windows_task 'chef-client' do
+        command 'chef-client'
+        run_level :highest
+        frequency :weekly
+        frequency_modifier 2
+        day 'Mon, Fri'
+      end
+      ```
 
-        **Create a scheduled task to run when computer is idle with idle duration 20 min**:
+      **Create a scheduled task to run when computer is idle with idle duration 20 min**:
 
-        ```ruby
-        windows_task 'chef-client' do
-          command 'chef-client'
-          run_level :highest
-          frequency :on_idle
-          idle_time 20
-        end
-        ```
+      ```ruby
+      windows_task 'chef-client' do
+        command 'chef-client'
+        run_level :highest
+        frequency :on_idle
+        idle_time 20
+      end
+      ```
 
-        **Delete a task named "old task"**:
-        ```ruby
-        windows_task 'old task' do
-          action :delete
-        end
-        ```
+      **Delete a task named "old task"**:
+      ```ruby
+      windows_task 'old task' do
+        action :delete
+      end
+      ```
 
-        **Enable a task named "chef-client"**:
-        ```ruby
-        windows_task 'chef-client' do
-          action :enable
-        end
-        ```
+      **Enable a task named "chef-client"**:
+      ```ruby
+      windows_task 'chef-client' do
+        action :enable
+      end
+      ```
 
-        **Disable a task named "ProgramDataUpdater" with TaskPath "\\Microsoft\\Windows\\Application Experience\\ProgramDataUpdater"**
-        ```ruby
-        windows_task '\\Microsoft\\Windows\\Application Experience\\ProgramDataUpdater' do
-          action :disable
-        end
-        ```
+      **Disable a task named "ProgramDataUpdater" with TaskPath "\\Microsoft\\Windows\\Application Experience\\ProgramDataUpdater"**
+      ```ruby
+      windows_task '\\Microsoft\\Windows\\Application Experience\\ProgramDataUpdater' do
+        action :disable
+      end
+      ```
       DOC
 
       allowed_actions :create, :delete, :run, :end, :enable, :disable, :change
@@ -202,13 +202,13 @@ class Chef
         description: "Specifies the start time to run the task, in **HH:mm** format."
 
       property :day, [String, Integer],
-        description: <<~DOCS
-          The day(s) on which the task runs.
-            * Use this property when setting `frequency` to `:monthly` or `:weekly`.
-            * Valid values with frequency `:weekly` are `MON`-`SUN` or `*`.
-            * Valid values with frequency `:monthly` are `1-31`, `MON`-`SUN`, and `LASTDAY`.
-            * Use `MON`-`SUN` or `LASTDAY` if you are setting `frequency_modifier` as "FIRST, SECOND, THIRD etc." else use 1-31.
-            * Multiple days should be comma separated. e.g `1, 2, 3` or `MON, WED, FRI`.
+        description:  <<~DOCS
+        The day(s) on which the task runs.
+          * Use this property when setting `frequency` to `:monthly` or `:weekly`.
+          * Valid values with frequency `:weekly` are `MON`-`SUN` or `*`.
+          * Valid values with frequency `:monthly` are `1-31`, `MON`-`SUN`, and `LASTDAY`.
+          * Use `MON`-`SUN` or `LASTDAY` if you are setting `frequency_modifier` as "FIRST, SECOND, THIRD etc." else use 1-31.
+          * Multiple days should be comma separated. e.g `1, 2, 3` or `MON, WED, FRI`.
         DOCS
 
       property :months, String,
@@ -339,7 +339,6 @@ 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
       def validate_start_day(start_day, frequency)
         if start_day && frequency == :none
           raise ArgumentError, "`start_day` property is not supported with frequency: #{frequency}"
@@ -351,7 +350,6 @@ class Chef
         end
       end
 
-      # @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

data/lib/chef/resource/windows_uac.rb

@@ -1,6 +1,6 @@
 #
 # Author:: Tim Smith (<tsmith@chef.io>)
-# Copyright:: Copyright (c) Chef Software Inc.
+# Copyright:: Copyright (c) 2009-2026 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -26,23 +26,23 @@ class Chef
       description 'The *windows_uac* resource configures UAC on Windows hosts by setting registry keys at `HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows\CurrentVersion\Policies\System`'
       introduced "15.0"
       examples <<~DOC
-        **Disable UAC prompts for the admin**:
+      **Disable UAC prompts for the admin**:
 
-        ```ruby
-        windows_uac 'Disable UAC prompts for the admin' do
-          enable_uac true
-          prompt_on_secure_desktop false
-          consent_behavior_admins :no_prompt
-        end
-        ```
+      ```ruby
+      windows_uac 'Disable UAC prompts for the admin' do
+        enable_uac true
+        prompt_on_secure_desktop false
+        consent_behavior_admins :no_prompt
+      end
+      ```
 
-        **Disable UAC entirely**:
+      **Disable UAC entirely**:
 
-        ```ruby
-        windows_uac 'Disable UAC entirely' do
-          enable_uac false
-        end
-        ```
+      ```ruby
+      windows_uac 'Disable UAC entirely' do
+        enable_uac false
+      end
+      ```
       DOC
 
       # https://docs.microsoft.com/en-us/windows/security/identity-protection/user-account-control/user-account-control-group-policy-and-registry-key-settings#user-account-control-virtualize-file-and-registry-write-failures-to-per-user-locations

data/lib/chef/resource/windows_update_settings.rb

@@ -4,7 +4,7 @@
 # Author:: Tim Smith (tsmith@chef.io)
 #
 # Copyright:: 2014-2017, Sölvi Páll Ásgeirsson.
-# Copyright:: Copyright (c) Chef Software Inc.
+# Copyright:: Copyright (c) 2009-2026 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -29,20 +29,20 @@ class Chef
       description "Use the **windows_update_settings** resource to manage the various Windows Update patching options."
       introduced "17.3"
       examples <<~DOC
-        **Set Windows Update settings**:
-
-        ```ruby
-        windows_update_settings 'Settings to Configure Windows Nodes to automatically receive updates' do
-          disable_os_upgrades true
-          elevate_non_admins true
-          block_windows_update_website true
-          automatically_install_minor_updates true
-          scheduled_install_day 'Friday'
-          scheduled_install_hour 18
-          update_other_ms_products true
-          action :enable
-        end
-        ```
+      **Set Windows Update settings**:
+
+      ```ruby
+      windows_update_settings 'Settings to Configure Windows Nodes to automatically receive updates' do
+        disable_os_upgrades true
+        elevate_non_admins true
+        block_windows_update_website true
+        automatically_install_minor_updates true
+        scheduled_install_day 'Friday'
+        scheduled_install_hour 18
+        update_other_ms_products true
+        action :enable
+      end
+      ```
       DOC
 
       # required for the alias to pass validation
@@ -87,8 +87,8 @@ class Chef
       # HKLM\Software\Policies\Microsoft\Windows\WindowsUpdate\AU
 
       property :automatic_update_option, [Integer, Symbol], equal_to: UPDATE_OPTIONS.keys, coerce: proc { |x| UPDATE_OPTIONS.key(x) || x },
-        default: :download_and_schedule,
-        description: "Control what to do when updates are found. This allows you to notify, automatically download and notify to install, automatically download and schedule the install, or let the local admin decide what action to take."
+                default: :download_and_schedule,
+                description: "Control what to do when updates are found. This allows you to notify, automatically download and notify to install, automatically download and schedule the install, or let the local admin decide what action to take."
       # options: 2 - notify before download
       #          3 - auto download and notify
       #          4 - auto download and schedule - must also set day and time (below)
@@ -104,11 +104,11 @@ class Chef
       #          1 - yeah, buddy, i want to set my own interval for checking for updates - true
 
       property :custom_detection_frequency, Integer, default: 22, description: "If you decided to override the OS default detection frequency, specify your choice here. Valid choices are 0 - 22",
-        callbacks: {
-          "should be a valid detection frequency (0-22)" => lambda { |p|
-            p.between?(0, 22)
-          },
-        }
+      callbacks: {
+        "should be a valid detection frequency (0-22)" => lambda { |p|
+          p.between?(0, 22)
+        },
+      }
       # a time period of between 0 and 22 hours to check for new updates
       # this is a hex value - convert it from dec to hex
 
@@ -125,11 +125,11 @@ class Chef
       #          Sunday - Saturday day of the week to install, 1 == sunday
 
       property :scheduled_install_hour, Integer, description: "If you chose a scheduled day to install, then choose an hour on that day for you installation",
-        callbacks: {
-          "should be a valid hour in a 24 hour clock" => lambda { |p|
-            p > 0 && p < 25
-          },
-        }
+                callbacks: {
+                  "should be a valid hour in a 24 hour clock" => lambda { |p|
+                    p > 0 && p < 25
+                  },
+                }
       # options: --- 2-digit number representing an hour of the day, uses a 24-hour clock, 12 == noon, 24 == midnight
 
       property :update_other_ms_products, [true, false], default: true, description: "Allows for other Microsoft products to get updates too"

data/lib/chef/resource/windows_user_privilege.rb

@@ -1,7 +1,7 @@
 #
 # Author:: Jared Kauppila (<jared@kauppi.la>)
 # Author:: Vasundhara Jagdale(<vasundhara.jagdale@chef.io>)
-# Copyright:: Copyright (c) Chef Software Inc.
+# Copyright:: Copyright (c) 2009-2026 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved.
 
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -28,67 +28,67 @@ class Chef
       introduced "16.0"
 
       examples <<~DOC
-        **Set the SeNetworkLogonRight privilege for the Builtin Administrators and Authenticated Users groups**:
+      **Set the SeNetworkLogonRight privilege for the Builtin Administrators and Authenticated Users groups**:
 
-        The `:set` action will add this privilege for these two groups and remove this privilege from all other groups or users.
+      The `:set` action will add this privilege for these two groups and remove this privilege from all other groups or users.
 
-        ```ruby
-        windows_user_privilege 'Network Logon Rights' do
-          privilege      'SeNetworkLogonRight'
-          users          ['BUILTIN\\Administrators', 'NT AUTHORITY\\Authenticated Users']
-          action         :set
-        end
-        ```
+      ```ruby
+      windows_user_privilege 'Network Logon Rights' do
+        privilege      'SeNetworkLogonRight'
+        users          ['BUILTIN\\Administrators', 'NT AUTHORITY\\Authenticated Users']
+        action         :set
+      end
+      ```
 
-        **Set the SeCreatePagefilePrivilege privilege for the Builtin Guests and Administrator groups**:
+      **Set the SeCreatePagefilePrivilege privilege for the Builtin Guests and Administrator groups**:
 
-        The `:set` action will add this privilege for these two groups and remove this privilege from all other groups or users.
+      The `:set` action will add this privilege for these two groups and remove this privilege from all other groups or users.
 
-        ```ruby
-        windows_user_privilege 'Create Pagefile' do
-          privilege      'SeCreatePagefilePrivilege'
-          users          ['BUILTIN\\Guests', 'BUILTIN\\Administrators']
-          action         :set
-        end
-        ```
+      ```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 'Remote interactive logon' principal**:
 
-        ```ruby
-        windows_user_privilege 'Remote interactive logon' do
-          privilege      'SeDenyRemoteInteractiveLogonRight'
-          action         :add
-        end
-        ```
+      ```ruby
+      windows_user_privilege 'Remote interactive logon' do
+        privilege      'SeDenyRemoteInteractiveLogonRight'
+        action         :add
+      end
+      ```
 
-        **Add the SeCreatePageFilePrivilege privilege to the Builtin Guests group**:
+      **Add the SeCreatePageFilePrivilege privilege to the Builtin Guests group**:
 
-        ```ruby
-        windows_user_privilege 'Guests add Create Pagefile' do
-          principal      'BUILTIN\\Guests'
-          privilege      'SeCreatePagefilePrivilege'
-          action         :add
-        end
-        ```
+      ```ruby
+      windows_user_privilege 'Guests add Create Pagefile' do
+        principal      'BUILTIN\\Guests'
+        privilege      'SeCreatePagefilePrivilege'
+        action         :add
+      end
+      ```
 
-        **Remove the SeCreatePageFilePrivilege privilege from the Builtin Guests group**:
+      **Remove the SeCreatePageFilePrivilege privilege from the Builtin Guests group**:
 
-        ```ruby
-        windows_user_privilege 'Create Pagefile' do
-          privilege      'SeCreatePagefilePrivilege'
-          users          ['BUILTIN\\Guests']
-          action         :remove
-        end
-        ```
+      ```ruby
+      windows_user_privilege 'Create Pagefile' do
+        privilege      'SeCreatePagefilePrivilege'
+        principal      'BUILTIN\\Guests'
+        action         :remove
+      end
+      ```
 
-        **Clear the SeDenyNetworkLogonRight privilege from all users**:
+      **Clear the SeDenyNetworkLogonRight privilege from all users**:
 
-        ```ruby
-        windows_user_privilege 'Allow any user the Network Logon right' do
-          privilege      'SeDenyNetworkLogonRight'
-          action         :clear
-        end
-        ```
+      ```ruby
+      windows_user_privilege 'Allow any user the Network Logon right' do
+        privilege      'SeDenyNetworkLogonRight'
+        action         :clear
+      end
+      ```
       DOC
 
       PRIVILEGE_OPTS = %w{ SeAssignPrimaryTokenPrivilege
@@ -139,20 +139,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 [special identity](https://docs.microsoft.com/en-us/windows/security/identity-protection/access-control/special-identities).",
-        name_property: true
+               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 [special identity](https://docs.microsoft.com/en-us/windows/security/identity-protection/access-control/special-identities).",
+               name_property: true
 
       property :users, [Array, String],
-        description: "An optional property to set the privilege for the specified users. Use only with `:set` action",
-        coerce: proc { |v| Array(v) }
+               description: "An optional property to set the privilege for the specified 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, see [Microsoft's documentation on what each privilege does](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 principal or users/groups. For more information, see [Microsoft's documentation on what each privilege does](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
 
       load_current_value do |new_resource|
         if new_resource.principal && (new_resource.action.include?(:add) || new_resource.action.include?(:remove))

data/lib/chef/resource/windows_workgroup.rb

@@ -27,20 +27,20 @@ class Chef
       description "Use the **windows_workgroup** resource to join or change the workgroup of a Windows host."
       introduced "14.5"
       examples <<~DOC
-        **Join a workgroup**:
+      **Join a workgroup**:
 
-        ```ruby
-        windows_workgroup 'myworkgroup'
-        ```
+      ```ruby
+      windows_workgroup 'myworkgroup'
+      ```
 
-        **Join a workgroup using a specific user**:
+      **Join a workgroup using a specific user**:
 
-        ```ruby
-        windows_workgroup 'myworkgroup' do
-          user 'Administrator'
-          password 'passw0rd'
-        end
-        ```
+      ```ruby
+      windows_workgroup 'myworkgroup' do
+        user 'Administrator'
+        password 'passw0rd'
+      end
+      ```
       DOC
 
       property :workgroup_name, String,

data/lib/chef/resource/yum_package.rb

@@ -1,6 +1,6 @@
 #
 # Author:: AJ Christensen (<aj@chef.io>)
-# Copyright:: Copyright (c) Chef Software Inc.
+# Copyright:: Copyright (c) 2009-2026 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -23,8 +23,9 @@ class Chef
   class Resource
     class YumPackage < Chef::Resource::Package
 
-      provides :yum_package
+      provides :yum_package, target_mode: true
       provides :package, platform_family: "fedora_derived"
+      target_mode support: :full
 
       description "Use the **yum_package** resource to install, upgrade, and remove packages with Yum for the Red Hat and CentOS platforms. The yum_package resource is able to resolve `provides` data for packages much like Yum can do when it is run from the command line. This allows a variety of options for installing packages, like minimum versions, virtual provides, and library names. Note: Support for using file names to install packages (as in `yum_package '/bin/sh'`) is not available because the volume of data required to parse for this is excessive."
       examples <<~DOC
@@ -109,7 +110,7 @@ class Chef
         ```
       DOC
 
-      allowed_actions :install, :upgrade, :remove, :purge, :lock, :unlock
+      allowed_actions :install, :upgrade, :remove, :purge, :lock, :unlock, :flush_cache
 
       # XXX: the coercions here are due to the provider promiscuously updating the properties on the
       # new_resource which causes immutable modification exceptions when passed an immutable node array.
@@ -157,7 +158,7 @@ class Chef
         description: "The path to the yum binary."
 
       property :environment, Hash,
-        introduced: "18.8",
+        introduced: "19.0",
         description: "A Hash of environment variables in the form of {'ENV_VARIABLE' => 'VALUE'} to be set before running the command.",
         default: {}, desired_state: false
     end