chef 18.9.4 → 18.11.11

data/lib/chef/resource/windows_service.rb

@@ -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
@@ -226,9 +226,9 @@ class Chef
       property :run_as_user, String,
         description: "The user under which a Microsoft Windows service runs.",
         default: "localsystem",
-        coerce: proc { |x| x.downcase }
+        coerce: proc(&:downcase)
 
-      property :run_as_password, String,
+      property :run_as_password, String, sensitive: true,
         description: "The password for the user specified by `run_as_user`.",
         default: ""
     end

data/lib/chef/resource/windows_share.rb

@@ -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.
@@ -69,17 +69,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: [], coerce: proc { |u| u.sort }
+        default: [], coerce: proc(&: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: [], coerce: proc { |u| u.sort }
+        default: [], coerce: proc(&: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: [], coerce: proc { |u| u.sort }
+        default: [], coerce: proc(&: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],

data/lib/chef/resource/windows_shortcut.rb

@@ -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

@@ -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
@@ -164,7 +164,7 @@ class Chef
         default: lazy { Chef::ReservedNames::Win32::Security::SID.LocalSystem.account_simple_name if ChefUtils.windows_ruby? },
         default_description: "The localized SYSTEM user for the node."
 
-      property :password, String,
+      property :password, String, sensitive: true,
         description: "The user's password. The user property must be set if using this property."
 
       property :run_level, Symbol, equal_to: %i{highest limited},
@@ -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,
@@ -233,7 +233,7 @@ class Chef
 
       property :priority, Integer,
         description: "Use to set Priority Levels range from 0 to 10.",
-        default: 7, callbacks: { "should be in range of 0 to 10" => proc { |v| v >= 0 && v <= 10 } }
+        default: 7, callbacks: { "should be in range of 0 to 10" => proc { |v| v.between?(0, 10) } }
 
       property :disallow_start_if_on_batteries, [TrueClass, FalseClass],
         introduced: "14.4", default: false,
@@ -300,7 +300,7 @@ class Chef
 
       # Validate the passed value is numeric values only if it is a string
       def numeric_value_in_string?(val)
-        return true if Integer(val)
+        true if Integer(val)
       rescue ArgumentError
         false
       end

data/lib/chef/resource/windows_uac.rb

@@ -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