chef 15.1.36 → 15.2.20

data/lib/chef/resource/systemd_unit.rb

@@ -30,13 +30,13 @@ class Chef
 
       default_action :nothing
       allowed_actions :create, :delete,
-                      :preset, :revert,
-                      :enable, :disable, :reenable,
-                      :mask, :unmask,
-                      :start, :stop,
-                      :restart, :reload,
-                      :try_restart, :reload_or_restart,
-                      :reload_or_try_restart
+        :preset, :revert,
+        :enable, :disable, :reenable,
+        :mask, :unmask,
+        :start, :stop,
+        :restart, :reload,
+        :try_restart, :reload_or_restart,
+        :reload_or_try_restart
 
       # Internal provider-managed properties
       property :enabled, [TrueClass, FalseClass], skip_docs: true
@@ -49,15 +49,15 @@ class Chef
                description: "The user account that the systemd unit process is run under. The path to the unit for that user would be something like '/etc/systemd/user/sshd.service'. If no user account is specified, the systemd unit will run under a 'system' account, with the path to the unit being something like '/etc/systemd/system/sshd.service'."
 
       property :content, [String, Hash],
-                description: "A string or hash that contains a systemd `unit file <https://www.freedesktop.org/software/systemd/man/systemd.unit.html>`_ definition that describes the properties of systemd-managed entities, such as services, sockets, devices, and so on. In #{Chef::Dist::PRODUCT} 14.4 or later, repeatable options can be implemented with an array."
+        description: "A string or hash that contains a systemd `unit file <https://www.freedesktop.org/software/systemd/man/systemd.unit.html>`_ definition that describes the properties of systemd-managed entities, such as services, sockets, devices, and so on. In #{Chef::Dist::PRODUCT} 14.4 or later, repeatable options can be implemented with an array."
 
       property :triggers_reload, [TrueClass, FalseClass],
-               description: "Specifies whether to trigger a daemon reload when creating or deleting a unit.",
-               default: true, desired_state: false
+        description: "Specifies whether to trigger a daemon reload when creating or deleting a unit.",
+        default: true, desired_state: false
 
       property :verify, [TrueClass, FalseClass],
-               default: true, desired_state: false,
-               description: "Specifies if the unit will be verified before installation. Systemd can be overly strict when verifying units, so in certain cases it is preferable not to verify the unit."
+        default: true, desired_state: false,
+        description: "Specifies if the unit will be verified before installation. Systemd can be overly strict when verifying units, so in certain cases it is preferable not to verify the unit."
 
       property :unit_name, String, desired_state: false,
                identity: true, name_property: true,

data/lib/chef/resource/template.rb

@@ -59,16 +59,16 @@ class Chef
       end
 
       property :variables, Hash,
-               description: "The variables property of the template resource can be used to reference a partial template file by using a Hash.",
-               default: lazy { Hash.new }
+        description: "The variables property of the template resource can be used to reference a partial template file by using a Hash.",
+        default: lazy { {} }
 
       property :cookbook, String,
-               description: "The cookbook in which a file is located (if it is not located in the current cookbook). The default value is the current cookbook.",
-               desired_state: false
+        description: "The cookbook in which a file is located (if it is not located in the current cookbook). The default value is the current cookbook.",
+        desired_state: false
 
       property :local, [ TrueClass, FalseClass ],
-               default: false, desired_state: false,
-               description: "Load a template from a local path. By default, the #{Chef::Dist::CLIENT} loads templates from a cookbook’s /templates directory. When this property is set to true, use the source property to specify the path to a template on the local node."
+        default: false, desired_state: false,
+        description: "Load a template from a local path. By default, the #{Chef::Dist::CLIENT} loads templates from a cookbook’s /templates directory. When this property is set to true, use the source property to specify the path to a template on the local node."
 
       # Declares a helper method to be defined in the template context when
       # rendering.
@@ -109,7 +109,7 @@ class Chef
             "`helper(:method)` requires a block argument (e.g., `helper(:method) { code }`)"
         end
 
-        unless method_name.kind_of?(Symbol)
+        unless method_name.is_a?(Symbol)
           raise Exceptions::ValidationFailed,
             "method_name argument to `helper(method_name)` must be a symbol (e.g., `helper(:method) { code }`)"
         end
@@ -163,7 +163,7 @@ class Chef
             "Passing both a module and block to #helpers is not supported. Call #helpers multiple times instead"
         elsif block_given?
           @inline_helper_modules << block
-        elsif module_name.kind_of?(::Module)
+        elsif module_name.is_a?(::Module)
           @helper_modules << module_name
         elsif module_name.nil?
           raise Exceptions::ValidationFailed,

data/lib/chef/resource/timezone.rb

@@ -28,8 +28,8 @@ class Chef
       introduced "14.6"
 
       property :timezone, String,
-               description: "An optional property to set the timezone value if it differs from the resource block's name.",
-               name_property: true
+        description: "An optional property to set the timezone value if it differs from the resource block's name.",
+        name_property: true
 
       action :set do
         description "Set the timezone."
@@ -126,6 +126,7 @@ class Chef
         def current_windows_tz
           tz_shellout = shell_out("tzutil /g")
           raise "There was an error running the tzutil command" if tz_shellout.exitstatus == 1
+
           tz_shellout.stdout.strip
         end
       end

data/lib/chef/resource/user.rb

@@ -29,47 +29,47 @@ class Chef
       allowed_actions :create, :remove, :modify, :manage, :lock, :unlock
 
       property :username, String,
-                description: "An optional property to set the username value if it differs from the resource block's name.",
-                name_property: true, identity: true
+        description: "An optional property to set the username value if it differs from the resource block's name.",
+        name_property: true, identity: true
 
       property :comment, String,
-                description: "The contents of the user comments field."
+        description: "The contents of the user comments field."
 
       property :home, String,
-                description: "The location of the home directory."
+        description: "The location of the home directory."
 
       property :salt, String,
-                description: "A SALTED-SHA512-PBKDF2 hash.",
-                desired_state: false
+        description: "A SALTED-SHA512-PBKDF2 hash.",
+        desired_state: false
 
       property :shell, String,
-                description: "The login shell."
+        description: "The login shell."
 
       property :password, String,
-                description: "The password shadow hash",
-                desired_state: false
+        description: "The password shadow hash",
+        desired_state: false
 
       property :non_unique, [ TrueClass, FalseClass ],
-                description: "Create a duplicate (non-unique) user account.",
-                default: false, desired_state: false
+        description: "Create a duplicate (non-unique) user account.",
+        default: false, desired_state: false
 
       property :manage_home, [ TrueClass, FalseClass ],
-                description: "Manage a user’s home directory.\nWhen used with the :create action, a user’s home directory is created based on HOME_DIR. If the home directory is missing, it is created unless CREATE_HOME in /etc/login.defs is set to no. When created, a skeleton set of files and subdirectories are included within the home directory.\nWhen used with the :modify action, a user’s home directory is moved to HOME_DIR. If the home directory is missing, it is created unless CREATE_HOME in /etc/login.defs is set to no. The contents of the user’s home directory are moved to the new location.",
-                default: false, desired_state: false
+        description: "Manage a user’s home directory.\nWhen used with the :create action, a user’s home directory is created based on HOME_DIR. If the home directory is missing, it is created unless CREATE_HOME in /etc/login.defs is set to no. When created, a skeleton set of files and subdirectories are included within the home directory.\nWhen used with the :modify action, a user’s home directory is moved to HOME_DIR. If the home directory is missing, it is created unless CREATE_HOME in /etc/login.defs is set to no. The contents of the user’s home directory are moved to the new location.",
+        default: false, desired_state: false
 
       property :force, [ TrueClass, FalseClass ],
-                description: "Force the removal of a user. May be used only with the :remove action.",
-                default: false, desired_state: false
+        description: "Force the removal of a user. May be used only with the :remove action.",
+        default: false, desired_state: false
 
       property :system, [ TrueClass, FalseClass ],
-                description: "Create a system user. This property may be used with useradd as the provider to create a system user which passes the -r flag to useradd.",
-                default: false
+        description: "Create a system user. This property may be used with useradd as the provider to create a system user which passes the -r flag to useradd.",
+        default: false
 
       property :uid, [ String, Integer, NilClass ], # nil for backwards compat
-                description: "The numeric user identifier."
+        description: "The numeric user identifier."
 
       property :gid, [ String, Integer, NilClass ], # nil for backwards compat
-                description: "The numeric group identifier."
+        description: "The numeric group identifier."
 
       alias_method :group, :gid
     end

data/lib/chef/resource/user/dscl_user.rb

@@ -27,8 +27,8 @@ class Chef
         provides :user, os: "darwin"
 
         property :iterations, Integer,
-                  description: "macOS platform only. The number of iterations for a password with a SALTED-SHA512-PBKDF2 shadow hash.",
-                  default: 27855, desired_state: false
+          description: "macOS platform only. The number of iterations for a password with a SALTED-SHA512-PBKDF2 shadow hash.",
+          default: 27855, desired_state: false
       end
     end
   end

data/lib/chef/resource/user/windows_user.rb

@@ -27,8 +27,8 @@ class Chef
         provides :user, os: "windows"
 
         property :full_name, String,
-                  description: "The full name of the user.",
-                  introduced: "14.6"
+          description: "The full name of the user.",
+          introduced: "14.6"
       end
     end
   end

data/lib/chef/resource/windows_ad_join.rb

@@ -31,35 +31,35 @@ class Chef
       introduced "14.0"
 
       property :domain_name, String,
-               description: "The FQDN of the Active Directory domain to join if it differs from the resource block's name.",
-               validation_message: "The 'domain_name' property must be a FQDN.",
-               regex: /.\../, # anything.anything
-               name_property: true
+        description: "The FQDN of the Active Directory domain to join if it differs from the resource block's name.",
+        validation_message: "The 'domain_name' property must be a FQDN.",
+        regex: /.\../, # anything.anything
+        name_property: true
 
       property :domain_user, String,
-               description: "The domain user that will be used to join the domain.",
-               required: true
+        description: "The domain user that will be used to join the domain.",
+        required: true
 
       property :domain_password, String,
-               description: "The password for the domain user. Note that this resource is set to hide sensitive information by default. ",
-               required: true
+        description: "The password for the domain user. Note that this resource is set to hide sensitive information by default. ",
+        required: true
 
       property :ou_path, String,
-               description: "The path to the Organizational Unit where the host will be placed."
+        description: "The path to the Organizational Unit where the host will be placed."
 
       property :reboot, Symbol,
-               equal_to: [:immediate, :delayed, :never, :request_reboot, :reboot_now],
-               validation_message: "The reboot property accepts :immediate (reboot as soon as the resource completes), :delayed (reboot once the #{Chef::Dist::PRODUCT} run completes), and :never (Don't reboot)",
-               description: "Controls the system reboot behavior post domain joining. Reboot immediately, after the #{Chef::Dist::PRODUCT} run completes, or never. Note that a reboot is necessary for changes to take effect.",
-               default: :immediate
+        equal_to: %i{immediate delayed never request_reboot reboot_now},
+        validation_message: "The reboot property accepts :immediate (reboot as soon as the resource completes), :delayed (reboot once the #{Chef::Dist::PRODUCT} run completes), and :never (Don't reboot)",
+        description: "Controls the system reboot behavior post domain joining. Reboot immediately, after the #{Chef::Dist::PRODUCT} run completes, or never. Note that a reboot is necessary for changes to take effect.",
+        default: :immediate
 
       property :new_hostname, String,
-               description: "Specifies a new hostname for the computer in the new domain.",
-               introduced: "14.5"
+        description: "Specifies a new hostname for the computer in the new domain.",
+        introduced: "14.5"
 
       # define this again so we can default it to true. Otherwise failures print the password
       property :sensitive, [TrueClass, FalseClass],
-               default: true, desired_state: false
+        default: true, desired_state: false
 
       action :join do
         description "Join the Active Directory domain."
@@ -96,6 +96,7 @@ class Chef
         def on_domain?
           node_domain = powershell_out!("(Get-WmiObject Win32_ComputerSystem).Domain")
           raise "Failed to check if the system is joined to the domain #{new_resource.domain_name}: #{node_domain.stderr}}" if node_domain.error?
+
           node_domain.stdout.downcase.strip == new_resource.domain_name.downcase
         end
 

data/lib/chef/resource/windows_auto_run.rb

@@ -28,20 +28,20 @@ class Chef
       introduced "14.0"
 
       property :program_name, String,
-               description: "The name of the program to run at login if it differs from the resource block's name.",
-               name_property: true
+        description: "The name of the program to run at login if it differs from the resource block's name.",
+        name_property: true
 
       property :path, String,
-               coerce: proc { |x| x.tr("/", "\\") }, # make sure we have windows paths for the registry
-               description: "The path to the program that will run at login. "
+        coerce: proc { |x| x.tr("/", "\\") }, # make sure we have windows paths for the registry
+        description: "The path to the program that will run at login. "
 
       property :args, String,
-               description: "Any arguments to be used with the program."
+        description: "Any arguments to be used with the program."
 
       property :root, Symbol,
-               description: "The registry root key to put the entry under.",
-               equal_to: %i{machine user},
-               default: :machine
+        description: "The registry root key to put the entry under.",
+        equal_to: %i{machine user},
+        default: :machine
 
       alias_method :program, :path
 

data/lib/chef/resource/windows_certificate.rb

@@ -2,7 +2,7 @@
 # Author:: Richard Lavey (richard.lavey@calastone.com)
 #
 # Copyright:: 2015-2017, Calastone Ltd.
-# Copyright:: 2018, Chef Software, Inc.
+# Copyright:: 2018-2019, Chef Software Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -32,30 +32,30 @@ class Chef
       introduced "14.7"
 
       property :source, String,
-               description: "The source file (for create and acl_add), thumbprint (for delete and acl_add) or subject (for delete) if it differs from the resource block's name.",
-               name_property: true
+        description: "The source file (for create and acl_add), thumbprint (for delete and acl_add) or subject (for delete) if it differs from the resource block's name.",
+        name_property: true
 
       property :pfx_password, String,
-               description: "The password to access the source if it is a pfx file."
+        description: "The password to access the source if it is a pfx file."
 
       property :private_key_acl, Array,
-               description: "An array of 'domain\account' entries to be granted read-only access to the certificate's private key. Not idempotent."
+        description: "An array of 'domain\account' entries to be granted read-only access to the certificate's private key. Not idempotent."
 
       property :store_name, String,
-               description: "The certificate store to manipulate.",
-               default: "MY", equal_to: ["TRUSTEDPUBLISHER", "TrustedPublisher", "CLIENTAUTHISSUER", "REMOTE DESKTOP", "ROOT", "TRUSTEDDEVICES", "WEBHOSTING", "CA", "AUTHROOT", "TRUSTEDPEOPLE", "MY", "SMARTCARDROOT", "TRUST", "DISALLOWED"]
+        description: "The certificate store to manipulate.",
+        default: "MY", equal_to: ["TRUSTEDPUBLISHER", "TrustedPublisher", "CLIENTAUTHISSUER", "REMOTE DESKTOP", "ROOT", "TRUSTEDDEVICES", "WEBHOSTING", "CA", "AUTHROOT", "TRUSTEDPEOPLE", "MY", "SMARTCARDROOT", "TRUST", "DISALLOWED"]
 
       property :user_store, [TrueClass, FalseClass],
-               description: "Use the user store of the local machine store if set to false.",
-               default: false
+        description: "Use the user store of the local machine store if set to false.",
+        default: false
 
       property :cert_path, String,
-               description: ""
+        description: ""
 
       # lazy used to set default value of sensitive to true if password is set
       property :sensitive, [TrueClass, FalseClass],
-               description: "Ensure that sensitive resource data is not logged by the #{Chef::Dist::CLIENT}.",
-               default: lazy { |r| r.pfx_password ? true : false }, skip_docs: true
+        description: "Ensure that sensitive resource data is not logged by the #{Chef::Dist::CLIENT}.",
+        default: lazy { pfx_password ? true : false }, skip_docs: true
 
       action :create do
         description "Creates or updates a certificate."
@@ -77,7 +77,7 @@ class Chef
           guard_script = cert_script(false)
         else
           # make sure we have no spaces in the hash string
-          hash = "\"#{new_resource.source.gsub(/\s/, '')}\""
+          hash = "\"#{new_resource.source.gsub(/\s/, "")}\""
           code_script = ""
           guard_script = ""
         end

data/lib/chef/resource/windows_dfs_folder.rb

@@ -28,35 +28,36 @@ class Chef
       introduced "15.0"
 
       property :folder_path, String,
-               description: "An optional property to set the path of the dfs folder if it differs from the resource block's name.",
-               name_property: true
+        description: "An optional property to set the path of the dfs folder if it differs from the resource block's name.",
+        name_property: true
 
       property :namespace_name, String,
-               description: "The namespace this should be created within.",
-               required: true
+        description: "The namespace this should be created within.",
+        required: true
 
       property :target_path, String,
-               description: "The target that this path will connect you to."
+        description: "The target that this path will connect you to."
 
       property :description, String,
-               description: "Description for the share."
+        description: "Description for the share."
 
       action :create do
         description "Creates the folder in dfs namespace."
 
         raise "target_path is required for install" unless property_is_set?(:target_path)
         raise "description is required for install" unless property_is_set?(:description)
+
         powershell_script "Create or Update DFS Folder" do
           code <<-EOH
 
-            $needs_creating = (Get-DfsnFolder -Path '\\\\#{ENV['COMPUTERNAME']}\\#{new_resource.namespace_name}\\#{new_resource.folder_path}' -ErrorAction SilentlyContinue) -eq $null
+            $needs_creating = (Get-DfsnFolder -Path '\\\\#{ENV["COMPUTERNAME"]}\\#{new_resource.namespace_name}\\#{new_resource.folder_path}' -ErrorAction SilentlyContinue) -eq $null
             if (!($needs_creating))
             {
-              Remove-DfsnFolder -Path '\\\\#{ENV['COMPUTERNAME']}\\#{new_resource.namespace_name}\\#{new_resource.folder_path}' -Force
+              Remove-DfsnFolder -Path '\\\\#{ENV["COMPUTERNAME"]}\\#{new_resource.namespace_name}\\#{new_resource.folder_path}' -Force
             }
-              New-DfsnFolder -Path '\\\\#{ENV['COMPUTERNAME']}\\#{new_resource.namespace_name}\\#{new_resource.folder_path}' -TargetPath '#{new_resource.target_path}' -Description '#{new_resource.description}'
+              New-DfsnFolder -Path '\\\\#{ENV["COMPUTERNAME"]}\\#{new_resource.namespace_name}\\#{new_resource.folder_path}' -TargetPath '#{new_resource.target_path}' -Description '#{new_resource.description}'
           EOH
-          not_if "return ((Get-DfsnFolder -Path '\\\\#{ENV['COMPUTERNAME']}\\#{new_resource.namespace_name}\\#{new_resource.folder_path}' -ErrorAction SilentlyContinue).Description -eq '#{new_resource.description}' -and  (Get-DfsnFolderTarget -Path '\\\\#{ENV['COMPUTERNAME']}\\#{new_resource.namespace_name}\\#{new_resource.folder_path}').TargetPath -eq '#{new_resource.target_path}' )"
+          not_if "return ((Get-DfsnFolder -Path '\\\\#{ENV["COMPUTERNAME"]}\\#{new_resource.namespace_name}\\#{new_resource.folder_path}' -ErrorAction SilentlyContinue).Description -eq '#{new_resource.description}' -and  (Get-DfsnFolderTarget -Path '\\\\#{ENV["COMPUTERNAME"]}\\#{new_resource.namespace_name}\\#{new_resource.folder_path}').TargetPath -eq '#{new_resource.target_path}' )"
         end
       end
 
@@ -65,9 +66,9 @@ class Chef
 
         powershell_script "Delete DFS Namespace" do
           code <<-EOH
-            Remove-DfsnFolder -Path '\\\\#{ENV['COMPUTERNAME']}\\#{new_resource.namespace_name}\\#{new_resource.folder_path}' -Force
+            Remove-DfsnFolder -Path '\\\\#{ENV["COMPUTERNAME"]}\\#{new_resource.namespace_name}\\#{new_resource.folder_path}' -Force
           EOH
-          only_if "return ((Get-DfsnFolder -Path '\\\\#{ENV['COMPUTERNAME']}\\#{new_resource.namespace_name}\\#{new_resource.folder_path}' ) -ne $null)"
+          only_if "return ((Get-DfsnFolder -Path '\\\\#{ENV["COMPUTERNAME"]}\\#{new_resource.namespace_name}\\#{new_resource.folder_path}' ) -ne $null)"
         end
       end
     end

data/lib/chef/resource/windows_dfs_namespace.rb

@@ -28,28 +28,28 @@ class Chef
       introduced "15.0"
 
       property :namespace_name, String,
-               description: "An optional property to set the dfs namespace if it differs from the resource block's name.",
-               name_property: true
+        description: "An optional property to set the dfs namespace if it differs from the resource block's name.",
+        name_property: true
 
       property :description, String,
-               description: "Description of the share.",
-               required: true
+        description: "Description of the share.",
+        required: true
 
       property :full_users, Array,
-               description: "Determines which users should have full access to the share.",
-               default: ['BUILTIN\\administrators']
+        description: "Determines which users should have full access to the share.",
+        default: ['BUILTIN\\administrators']
 
       property :change_users, Array,
-               description: "Determines which users should have change access to the share.",
-               default: []
+        description: "Determines which users should have change access to the share.",
+        default: []
 
       property :read_users, Array,
-               description: "Determines which users should have read access to the share.",
-               default: []
+        description: "Determines which users should have read access to the share.",
+        default: []
 
       property :root, String,
-               description: "The root from which to create the DFS tree. Defaults to C:\\DFSRoots.",
-               default: 'C:\\DFSRoots'
+        description: "The root from which to create the DFS tree. Defaults to C:\\DFSRoots.",
+        default: 'C:\\DFSRoots'
 
       action :create do
         description "Creates the dfs namespace on the server."
@@ -69,17 +69,17 @@ class Chef
 
         powershell_script "Create DFS Namespace" do
           code <<-EOH
-            $needs_creating = (Get-DfsnRoot -Path '\\\\#{ENV['COMPUTERNAME']}\\#{new_resource.namespace_name}' -ErrorAction SilentlyContinue) -eq $null
+            $needs_creating = (Get-DfsnRoot -Path '\\\\#{ENV["COMPUTERNAME"]}\\#{new_resource.namespace_name}' -ErrorAction SilentlyContinue) -eq $null
             if ($needs_creating)
             {
-                New-DfsnRoot -Path '\\\\#{ENV['COMPUTERNAME']}\\#{new_resource.namespace_name}' -TargetPath '\\\\#{ENV['COMPUTERNAME']}\\#{new_resource.namespace_name}' -Type Standalone -Description '#{new_resource.description}'
+                New-DfsnRoot -Path '\\\\#{ENV["COMPUTERNAME"]}\\#{new_resource.namespace_name}' -TargetPath '\\\\#{ENV["COMPUTERNAME"]}\\#{new_resource.namespace_name}' -Type Standalone -Description '#{new_resource.description}'
             }
             else
             {
-                Set-DfsnRoot -Path '\\\\#{ENV['COMPUTERNAME']}\\#{new_resource.namespace_name}' -Description '#{new_resource.description}'
+                Set-DfsnRoot -Path '\\\\#{ENV["COMPUTERNAME"]}\\#{new_resource.namespace_name}' -Description '#{new_resource.description}'
             }
           EOH
-          not_if "return (Get-DfsnRoot -Path '\\\\#{ENV['COMPUTERNAME']}\\#{new_resource.namespace_name}' -ErrorAction SilentlyContinue).description -eq '#{new_resource.description}'"
+          not_if "return (Get-DfsnRoot -Path '\\\\#{ENV["COMPUTERNAME"]}\\#{new_resource.namespace_name}' -ErrorAction SilentlyContinue).description -eq '#{new_resource.description}'"
         end
       end
 
@@ -88,9 +88,9 @@ class Chef
 
         powershell_script "Delete DFS Namespace" do
           code <<-EOH
-            Remove-DfsnRoot -Path '\\\\#{ENV['COMPUTERNAME']}\\#{new_resource.namespace_name}' -Force
+            Remove-DfsnRoot -Path '\\\\#{ENV["COMPUTERNAME"]}\\#{new_resource.namespace_name}' -Force
           EOH
-          only_if "return ((Get-DfsnRoot -Path '\\\\#{ENV['COMPUTERNAME']}\\#{new_resource.namespace_name}') -ne $null)"
+          only_if "return ((Get-DfsnRoot -Path '\\\\#{ENV["COMPUTERNAME"]}\\#{new_resource.namespace_name}') -ne $null)"
         end
 
         windows_share new_resource.namespace_name do