chef 18.10.17 → 19.2.12

data/lib/chef/resource/windows_security_policy.rb

@@ -2,7 +2,7 @@
 # Author:: Ashwini Nehate (<anehate@chef.io>)
 # Author:: Davin Taddeo (<davin@chef.io>)
 # Author:: Jeff Brimager (<jbrimager@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.
@@ -51,39 +51,39 @@ class Chef
       introduced "16.0"
 
       examples <<~DOC
-        **Set Administrator Account to Enabled**:
+      **Set Administrator Account to Enabled**:
 
-        ```ruby
-        windows_security_policy 'EnableAdminAccount' do
-          secvalue       '1'
-          action         :set
-        end
-        ```
+      ```ruby
+      windows_security_policy 'EnableAdminAccount' do
+        secvalue       '1'
+        action         :set
+      end
+      ```
 
-        **Rename Administrator Account**:
+      **Rename Administrator Account**:
 
-        ```ruby
-        windows_security_policy 'NewAdministratorName' do
-          secvalue       'AwesomeChefGuy'
-          action         :set
-        end
-        ```
+      ```ruby
+      windows_security_policy 'NewAdministratorName' do
+        secvalue       'AwesomeChefGuy'
+        action         :set
+      end
+      ```
 
-        **Set Guest Account to Disabled**:
+      **Set Guest Account to Disabled**:
 
-        ```ruby
-        windows_security_policy 'EnableGuestAccount' do
-          secvalue       '0'
-          action         :set
-        end
-        ```
+      ```ruby
+      windows_security_policy 'EnableGuestAccount' do
+        secvalue       '0'
+        action         :set
+      end
+      ```
       DOC
 
       property :secoption, String, name_property: true, required: true, equal_to: policy_names,
-        description: "The name of the policy to be set on windows platform to maintain its security."
+      description: "The name of the policy to be set on windows platform to maintain its security."
 
       property :secvalue, String, required: true,
-        description: "Policy value to be set for policy name."
+      description: "Policy value to be set for policy name."
 
       load_current_value do |new_resource|
         current_state = load_security_options

data/lib/chef/resource/windows_service.rb

@@ -1,6 +1,6 @@
 #
 # Author:: Bryan McLellan <btm@loftninjas.org>
-# 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");
@@ -39,111 +39,111 @@ class Chef
       description "Use the **windows_service** resource to create, delete, or manage a service on the Microsoft Windows platform."
       introduced "12.0"
       examples <<~DOC
-        **Starting Services**
-
-        Start a service with a `manual` startup type:
-
-        ```ruby
-        windows_service 'BITS' do
-          action :configure_startup
-          startup_type :manual
-        end
-        ```
-
-        **Creating Services**
-
-        Create a service named chef-client:
-
-        ```ruby
-        windows_service 'chef-client' do
-          action :create
-          binary_path_name "C:\\opscode\\chef\\bin"
-        end
-        ```
-
-        Create a service with `service_name` and `display_name`:
-
-        ```ruby
-        windows_service 'Setup chef-client as a service' do
-          action :create
-          display_name 'CHEF-CLIENT'
-          service_name 'chef-client'
-          binary_path_name "C:\\opscode\\chef\\bin"
-        end
-        ```
-
-        Create a service with the `manual` startup type:
-
-        ```ruby
-        windows_service 'chef-client' do
-          action :create
-          binary_path_name "C:\\opscode\\chef\\bin"
-          startup_type :manual
-        end
-        ```
-
-        Create a service with the `disabled` startup type:
-
-        ```ruby
-        windows_service 'chef-client' do
-          action :create
-          binary_path_name "C:\\opscode\\chef\\bin"
-          startup_type :disabled
-        end
-        ```
-
-        Create a service with the `automatic` startup type and delayed start enabled:
-
-        ```ruby
-        windows_service 'chef-client' do
-          action :create
-          binary_path_name "C:\\opscode\\chef\\bin"
-          startup_type :automatic
-          delayed_start true
-        end
-        ```
-
-        Create a service with a description:
-
-        ```ruby
-        windows_service 'chef-client' do
-          action :create
-          binary_path_name "C:\\opscode\\chef\\bin"
-          startup_type :automatic
-          description "Chef client as service"
-        end
-        ```
-
-        **Deleting Services**
-
-        Delete a service named chef-client:
-
-        ```ruby
-        windows_service 'chef-client' do
-          action :delete
-        end
-        ```
-
-        Delete a service with the `service_name` property:
-
-        ```ruby
-        windows_service 'Delete chef client' do
-          action :delete
-          service_name 'chef-client'
-        end
-        ```
-
-        **Configuring Services**
-
-        Change an existing service from automatic to manual startup:
-
-        ```ruby
-        windows_service 'chef-client' do
-          action :configure
-          binary_path_name "C:\\opscode\\chef\\bin"
-          startup_type :manual
-        end
-        ```
+      **Starting Services**
+
+      Start a service with a `manual` startup type:
+
+      ```ruby
+      windows_service 'BITS' do
+        action :configure_startup
+        startup_type :manual
+      end
+      ```
+
+      **Creating Services**
+
+      Create a service named chef-client:
+
+      ```ruby
+      windows_service 'chef-client' do
+        action :create
+        binary_path_name "C:\\opscode\\chef\\bin"
+      end
+      ```
+
+      Create a service with `service_name` and `display_name`:
+
+      ```ruby
+      windows_service 'Setup chef-client as a service' do
+        action :create
+        display_name 'CHEF-CLIENT'
+        service_name 'chef-client'
+        binary_path_name "C:\\opscode\\chef\\bin"
+      end
+      ```
+
+      Create a service with the `manual` startup type:
+
+      ```ruby
+      windows_service 'chef-client' do
+        action :create
+        binary_path_name "C:\\opscode\\chef\\bin"
+        startup_type :manual
+      end
+      ```
+
+      Create a service with the `disabled` startup type:
+
+      ```ruby
+      windows_service 'chef-client' do
+        action :create
+        binary_path_name "C:\\opscode\\chef\\bin"
+        startup_type :disabled
+      end
+      ```
+
+      Create a service with the `automatic` startup type and delayed start enabled:
+
+      ```ruby
+      windows_service 'chef-client' do
+        action :create
+        binary_path_name "C:\\opscode\\chef\\bin"
+        startup_type :automatic
+        delayed_start true
+      end
+      ```
+
+      Create a service with a description:
+
+      ```ruby
+      windows_service 'chef-client' do
+        action :create
+        binary_path_name "C:\\opscode\\chef\\bin"
+        startup_type :automatic
+        description "Chef client as service"
+      end
+      ```
+
+      **Deleting Services**
+
+      Delete a service named chef-client:
+
+      ```ruby
+      windows_service 'chef-client' do
+        action :delete
+      end
+      ```
+
+      Delete a service with the `service_name` property:
+
+      ```ruby
+      windows_service 'Delete chef client' do
+        action :delete
+        service_name 'chef-client'
+      end
+      ```
+
+      **Configuring Services**
+
+      Change an existing service from automatic to manual startup:
+
+      ```ruby
+      windows_service 'chef-client' do
+        action :configure
+        binary_path_name "C:\\opscode\\chef\\bin"
+        startup_type :manual
+      end
+      ```
       DOC
 
       allowed_actions :configure_startup, :create, :delete, :configure
@@ -165,7 +165,7 @@ class Chef
 
       # https://github.com/chef/win32-service/blob/ffi/lib/win32/windows/constants.rb#L31-L41
       property :service_type, Integer, default: SERVICE_WIN32_OWN_PROCESS,
-        introduced: "14.0"
+      introduced: "14.0"
 
       # Valid options:
       #   - :automatic

data/lib/chef/resource/windows_share.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.
@@ -31,24 +31,24 @@ class Chef
       description "Use the **windows_share** resource to create, modify and remove Windows shares."
       introduced "14.7"
       examples <<~DOC
-        **Create a share**:
-
-        ```ruby
-        windows_share 'foo' do
-          action :create
-          path 'C:\\foo'
-          full_users ['DOMAIN_A\\some_user', 'DOMAIN_B\\some_other_user']
-          read_users ['DOMAIN_C\\Domain users']
-        end
-        ```
+      **Create a share**:
+
+      ```ruby
+      windows_share 'foo' do
+        action :create
+        path 'C:\\foo'
+        full_users ['DOMAIN_A\\some_user', 'DOMAIN_B\\some_other_user']
+        read_users ['DOMAIN_C\\Domain users']
+      end
+      ```
 
-        **Delete a share**:
+      **Delete a share**:
 
-        ```ruby
-        windows_share 'foo' do
-          action :delete
-        end
-        ```
+      ```ruby
+      windows_share 'foo' do
+        action :delete
+      end
+      ```
       DOC
 
       # Specifies a name for the SMB share. The name may be composed of any valid file name characters, but must be less than 80 characters long. The names pipe and mailslot are reserved for use by the computer.

data/lib/chef/resource/windows_shortcut.rb

@@ -1,7 +1,7 @@
 #
 # Author:: Doug MacEachern <dougm@vmware.com>
 # Copyright:: 2010-2018, VMware, Inc.
-# 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.
@@ -27,14 +27,14 @@ class Chef
       description "Use the **windows_shortcut** resource to create shortcut files on Windows."
       introduced "14.0"
       examples <<~DOC
-        **Create a shortcut with a description**:
+      **Create a shortcut with a description**:
 
-        ```ruby
-        windows_shortcut 'C:\\shortcut_dir.lnk' do
-          target 'C:\\original_dir'
-          description 'Make a shortcut to C:\\original_dir'
-        end
-        ```
+      ```ruby
+      windows_shortcut 'C:\\shortcut_dir.lnk' do
+        target 'C:\\original_dir'
+        description 'Make a shortcut to C:\\original_dir'
+      end
+      ```
       DOC
 
       property :shortcut_name, String,

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