chef 18.9.4 → 18.11.11

data/lib/chef/resource/registry_key.rb

@@ -28,95 +28,95 @@ class Chef
 
       description "Use the **registry_key** resource to create and delete registry keys in Microsoft Windows. Note: 64-bit versions of Microsoft Windows have a 32-bit compatibility layer in the registry that reflects and redirects certain keys (and their values) into specific locations (or logical views) of the registry hive.\n\n#{ChefUtils::Dist::Infra::PRODUCT} can access any reflected or redirected registry key. The machine architecture of the system on which #{ChefUtils::Dist::Infra::PRODUCT} is running is used as the default (non-redirected) location. Access to the SysWow64 location is redirected must be specified. Typically, this is only necessary to ensure compatibility with 32-bit applications that are running on a 64-bit operating system.\n\nFor more information, see: [Registry Reflection](https://docs.microsoft.com/en-us/windows/win32/winprog64/registry-reflection)."
       examples <<~'DOC'
-      **Create a registry key**
-
-      ```ruby
-      registry_key 'HKEY_LOCAL_MACHINE\\path-to-key\\Policies\\System' do
-        values [{
-          name: 'EnableLUA',
-          type: :dword,
-          data: 0
-        }]
-        action :create
-      end
-      ```
-
-      **Create a registry key with binary data: "\x01\x02\x03"**:
-
-      ```ruby
-      registry_key 'HKEY_CURRENT_USER\ChefTest' do
-        values [{
-          :name => "test",
-          :type => :binary,
-          :data => [0, 1, 2].map(&:chr).join
-        }]
+        **Create a registry key**
+
+        ```ruby
+        registry_key 'HKEY_LOCAL_MACHINE\\path-to-key\\Policies\\System' do
+          values [{
+            name: 'EnableLUA',
+            type: :dword,
+            data: 0
+          }]
+          action :create
+        end
+        ```
 
-        action :create
-      end
-      ```
+        **Create a registry key with binary data: "\x01\x02\x03"**:
 
-      **Create 32-bit key in redirected wow6432 tree**
+        ```ruby
+        registry_key 'HKEY_CURRENT_USER\ChefTest' do
+          values [{
+            :name => "test",
+            :type => :binary,
+            :data => [0, 1, 2].map(&:chr).join
+          }]
 
-      In 64-bit versions of Microsoft Windows, HKEY_LOCAL_MACHINE\SOFTWARE\Example is a re-directed key. In the following examples, because HKEY_LOCAL_MACHINE\SOFTWARE\Example is a 32-bit key, the output will be “Found 32-bit key” if they are run on a version of Microsoft Windows that is 64-bit:
+          action :create
+        end
+        ```
 
-      ```ruby
-      registry_key 'HKEY_LOCAL_MACHINE\SOFTWARE\Example' do
-        architecture :i386
-        recursive true
-        action :create
-      end
-      ```
-
-      **Set proxy settings to be the same as those used by #{ChefUtils::Dist::Infra::PRODUCT}**
-
-      ```ruby
-      proxy = URI.parse(Chef::Config[:http_proxy])
-      registry_key 'HKCU\Software\Microsoft\path\to\key\Internet Settings' do
-        values [{name: 'ProxyEnable', type: :reg_dword, data: 1},
-                {name: 'ProxyServer', data: "#{proxy.host}:#{proxy.port}"},
-                {name: 'ProxyOverride', type: :reg_string, data: <local>},
-               ]
-        action :create
-      end
-      ```
+        **Create 32-bit key in redirected wow6432 tree**
 
-      **Set the name of a registry key to "(Default)"**
+        In 64-bit versions of Microsoft Windows, HKEY_LOCAL_MACHINE\SOFTWARE\Example is a re-directed key. In the following examples, because HKEY_LOCAL_MACHINE\SOFTWARE\Example is a 32-bit key, the output will be “Found 32-bit key” if they are run on a version of Microsoft Windows that is 64-bit:
 
-      ```ruby
-      registry_key 'Set (Default) value' do
-        key 'HKLM\Software\Test\Key\Path'
-        values [
-          {name: '', type: :string, data: 'test'},
-        ]
-        action :create
-      end
-      ```
+        ```ruby
+        registry_key 'HKEY_LOCAL_MACHINE\SOFTWARE\Example' do
+          architecture :i386
+          recursive true
+          action :create
+        end
+        ```
+
+        **Set proxy settings to be the same as those used by #{ChefUtils::Dist::Infra::PRODUCT}**
+
+        ```ruby
+        proxy = URI.parse(Chef::Config[:http_proxy])
+        registry_key 'HKCU\Software\Microsoft\path\to\key\Internet Settings' do
+          values [{name: 'ProxyEnable', type: :reg_dword, data: 1},
+                  {name: 'ProxyServer', data: "#{proxy.host}:#{proxy.port}"},
+                  {name: 'ProxyOverride', type: :reg_string, data: <local>},
+                 ]
+          action :create
+        end
+        ```
 
-      **Delete a registry key value**
+        **Set the name of a registry key to "(Default)"**
 
-      ```ruby
-      registry_key 'HKEY_LOCAL_MACHINE\SOFTWARE\path\to\key\AU' do
-        values [{
-          name: 'NoAutoRebootWithLoggedOnUsers',
-          type: :dword,
-          data: ''
-          }]
-        action :delete
-      end
-      ```
+        ```ruby
+        registry_key 'Set (Default) value' do
+          key 'HKLM\Software\Test\Key\Path'
+          values [
+            {name: '', type: :string, data: 'test'},
+          ]
+          action :create
+        end
+        ```
+
+        **Delete a registry key value**
+
+        ```ruby
+        registry_key 'HKEY_LOCAL_MACHINE\SOFTWARE\path\to\key\AU' do
+          values [{
+            name: 'NoAutoRebootWithLoggedOnUsers',
+            type: :dword,
+            data: ''
+            }]
+          action :delete
+        end
+        ```
 
-      Note: If data: is not specified, you get an error: Missing data key in RegistryKey values hash
+        Note: If data: is not specified, you get an error: Missing data key in RegistryKey values hash
 
-      **Delete a registry key and its subkeys, recursively**
+        **Delete a registry key and its subkeys, recursively**
 
-      ```ruby
-      registry_key 'HKCU\SOFTWARE\Policies\path\to\key\Themes' do
-        recursive true
-        action :delete_key
-      end
-      ```
+        ```ruby
+        registry_key 'HKCU\SOFTWARE\Policies\path\to\key\Themes' do
+          recursive true
+          action :delete_key
+        end
+        ```
 
-      Note: Be careful when using the :delete_key action with the recursive attribute. This will delete the registry key, all of its values and all of the names, types, and data associated with them. This cannot be undone by #{ChefUtils::Dist::Infra::PRODUCT}.
+        Note: Be careful when using the :delete_key action with the recursive attribute. This will delete the registry key, all of its values and all of the names, types, and data associated with them. This cannot be undone by #{ChefUtils::Dist::Infra::PRODUCT}.
       DOC
 
       default_action :create
@@ -152,10 +152,10 @@ class Chef
       property :recursive, [TrueClass, FalseClass], default: false
       property :architecture, Symbol, default: :machine, equal_to: %i{machine x86_64 i386}
       property :only_record_changes, [TrueClass, FalseClass],
-         default: true,
-         introduced: "18.7.3",
-         description: "(no-op) disabled functionality to only record registry value changes",
-         deprecated: true
+        default: true,
+        introduced: "18.7.3",
+        description: "(no-op) disabled functionality to only record registry value changes",
+        deprecated: true
 
       # Some registry key data types may not be safely reported as json.
       # Example (CHEF-5323):

data/lib/chef/resource/remote_file.rb

@@ -34,75 +34,75 @@ class Chef
       description "Use the **remote_file** resource to transfer a file from a remote location using file specificity. This resource is similar to the **file** resource. Note: Fetching files from the `files/` directory in a cookbook should be done with the **cookbook_file** resource."
 
       examples <<~'DOC'
-      **Download a file without checking the checksum**:
+        **Download a file without checking the checksum**:
 
-      ```ruby
-        remote_file '/tmp/remote.txt' do
-          source 'https://example.org/remote.txt'
-        end
-      ```
+        ```ruby
+          remote_file '/tmp/remote.txt' do
+            source 'https://example.org/remote.txt'
+          end
+        ```
 
-      **Download a file with a checksum to validate**:
+        **Download a file with a checksum to validate**:
 
-      ```ruby
-        remote_file '/tmp/test_file' do
-          source 'http://www.example.com/tempfiles/test_file'
-          mode '0755'
-          checksum '3a7dac00b1' # A SHA256 (or portion thereof) of the file.
-        end
-      ```
+        ```ruby
+          remote_file '/tmp/test_file' do
+            source 'http://www.example.com/tempfiles/test_file'
+            mode '0755'
+            checksum '3a7dac00b1' # A SHA256 (or portion thereof) of the file.
+          end
+        ```
 
-      **Download a file only if it's not already present**:
+        **Download a file only if it's not already present**:
 
-      ```ruby
-        remote_file '/tmp/remote.txt' do
-          source 'https://example.org/remote.txt'
-          checksum '3a7dac00b1' # A SHA256 (or portion thereof) of the file.
-          action :create_if_missing
-        end
-      ```
+        ```ruby
+          remote_file '/tmp/remote.txt' do
+            source 'https://example.org/remote.txt'
+            checksum '3a7dac00b1' # A SHA256 (or portion thereof) of the file.
+            action :create_if_missing
+          end
+        ```
 
-      **Using HTTP Basic Authentication in Headers**:
+        **Using HTTP Basic Authentication in Headers**:
 
-      ```ruby
-        remote_file '/tmp/remote.txt' do
-          source 'https://example.org/remote.txt'
-          headers('Authorization' => "Basic #{Base64.encode64("USERNAME_VALUE:PASSWORD_VALUE").delete("\n")}")
-          checksum '3a7dac00b1' # A SHA256 (or portion thereof) of the file.
-          action :create_if_missing
-        end
-      ```
+        ```ruby
+          remote_file '/tmp/remote.txt' do
+            source 'https://example.org/remote.txt'
+            headers('Authorization' => "Basic #{Base64.encode64("USERNAME_VALUE:PASSWORD_VALUE").delete("\n")}")
+            checksum '3a7dac00b1' # A SHA256 (or portion thereof) of the file.
+            action :create_if_missing
+          end
+        ```
 
-      **Downloading a file to the Chef file cache dir for execution**:
+        **Downloading a file to the Chef file cache dir for execution**:
 
-      ```ruby
-        remote_file '#{Chef::Config['file_cache_path']}/install.sh' do
-          source 'https://example.org/install.sh'
-          action :create_if_missing
-        end
+        ```ruby
+          remote_file '#{Chef::Config['file_cache_path']}/install.sh' do
+            source 'https://example.org/install.sh'
+            action :create_if_missing
+          end
 
-        execute '#{Chef::Config['file_cache_path']}/install.sh'
-      ```
-
-      **Specify advanced HTTP connection options including Net::HTTP (nethttp) options:**
-
-      ```ruby
-        remote_file '/tmp/remote.txt' do
-          source 'https://example.org/remote.txt'
-          http_options({
-            http_retry_delay: 0,
-            http_retry_count: 0,
-            keepalives: false,
-            nethttp: {
-              continue_timeout: 5,
-              max_retries: 5,
-              read_timeout: 5,
-              write_timeout: 5,
-              ssl_timeout: 5,
-            },
-          })
-        end
-      ```
+          execute '#{Chef::Config['file_cache_path']}/install.sh'
+        ```
+
+        **Specify advanced HTTP connection options including Net::HTTP (nethttp) options:**
+
+        ```ruby
+          remote_file '/tmp/remote.txt' do
+            source 'https://example.org/remote.txt'
+            http_options({
+              http_retry_delay: 0,
+              http_retry_count: 0,
+              keepalives: false,
+              nethttp: {
+                continue_timeout: 5,
+                max_retries: 5,
+                read_timeout: 5,
+                write_timeout: 5,
+                ssl_timeout: 5,
+              },
+            })
+          end
+        ```
       DOC
 
       def initialize(name, run_context = nil)
@@ -135,7 +135,7 @@ class Chef
       def parse_source_args(args)
         if args.empty?
           nil
-        elsif args[0].is_a?(Chef::DelayedEvaluator) && args.count == 1
+        elsif args[0].is_a?(Chef::DelayedEvaluator) && args.one?
           args[0]
         elsif args.any?(Chef::DelayedEvaluator) && args.count > 1
           raise Exceptions::InvalidRemoteFileURI, "Only 1 source argument allowed when using a lazy evaluator"
@@ -168,23 +168,23 @@ class Chef
 
       property :headers, Hash, default: {},
         description: <<~'DOCS'
-        A Hash of custom headers. For example:
+          A Hash of custom headers. For example:
 
-        ```ruby
-        headers({ "Cookie" => "user=some_user; pass=p@ssw0rd!" })
-        ```
+          ```ruby
+          headers({ "Cookie" => "user=some_user; pass=p@ssw0rd!" })
+          ```
 
-        or:
+          or:
 
-        ```ruby
-        headers({ "Referer" => "#{header}" })
-        ```
+          ```ruby
+          headers({ "Referer" => "#{header}" })
+          ```
 
-        or:
+          or:
 
-        ```ruby
-        headers( "Authorization"=>"Basic #{ Base64.encode64("#{username}:#{password}").gsub("\n", "") }" )
-        ```
+          ```ruby
+          headers( "Authorization"=>"Basic #{ Base64.encode64("#{username}:#{password}").gsub("\n", "") }" )
+          ```
         DOCS
 
       property :show_progress, [ TrueClass, FalseClass ],

data/lib/chef/resource/resource_notification.rb

@@ -41,7 +41,7 @@ class Chef
       # @return [Boolean] does the resource match
       def duplicates?(other_notification)
         unless other_notification.respond_to?(:resource) && other_notification.respond_to?(:action)
-          msg = "only duck-types of Chef::Resource::Notification can be checked for duplication "\
+          msg = "only duck-types of Chef::Resource::Notification can be checked for duplication " \
                 "you gave #{other_notification.inspect}"
           raise ArgumentError, msg
         end
@@ -73,7 +73,7 @@ class Chef
       def fix_resource_reference(resource_collection, always_raise = false)
         matching_resource = resource_collection.find(resource)
         if Array(matching_resource).size > 1
-          msg = "Notification #{self} from #{notifying_resource} was created with a reference to multiple resources, "\
+          msg = "Notification #{self} from #{notifying_resource} was created with a reference to multiple resources, " \
           "but can only notify one resource. Notifying resource was defined on #{notifying_resource.source_line}"
           raise Chef::Exceptions::InvalidResourceReference, msg
         end
@@ -108,8 +108,8 @@ class Chef
       def fix_notifier_reference(resource_collection)
         matching_notifier = resource_collection.find(notifying_resource)
         if Array(matching_notifier).size > 1
-          msg = "Notification #{self} from #{notifying_resource} was created with a reference to multiple notifying "\
-          "resources, but can only originate from one resource.  Destination resource was defined "\
+          msg = "Notification #{self} from #{notifying_resource} was created with a reference to multiple notifying " \
+          "resources, but can only originate from one resource.  Destination resource was defined " \
           "on #{resource.source_line}"
           raise Chef::Exceptions::InvalidResourceReference, msg
         end

data/lib/chef/resource/rhsm_errata_level.rb

@@ -35,7 +35,7 @@ class Chef
       DOC
 
       property :errata_level, String,
-        coerce: proc { |x| x.downcase },
+        coerce: proc(&:downcase),
         equal_to: %w{critical moderate important low},
         description: "An optional property for specifying the errata level of packages to install if it differs from the resource block's name.",
         name_property: true

data/lib/chef/resource/rhsm_register.rb

@@ -53,7 +53,7 @@ class Chef
       property :username, String,
         description: "The username to use when registering. This property is not applicable if using an activation key. If specified, password and environment properties are also required."
 
-      property :password, String,
+      property :password, String, sensitive: true,
         description: "The password to use when registering. This property is not applicable if using an activation key. If specified, username and environment are also required."
 
       property :system_name, String,
@@ -80,7 +80,7 @@ class Chef
 
       property :server_url, String,
         description: "The hostname of the subscription service to use. The default is Customer Portal Subscription Management, subscription.rhn.redhat.com. If you do not use this option, the system registers with Customer Portal Subscription Management.",
-          introduced: "17.8"
+        introduced: "17.8"
 
       property :base_url, String,
         description: "The hostname of the content delivery server to use to receive updates. Both Customer Portal Subscription Management and Subscription Asset Manager use Red Hat's hosted content delivery services, with the URL https://cdn.redhat.com. Since Satellite 6 hosts its own content, the URL must be used for systems registered with Satellite 6.",

data/lib/chef/resource/scm/git.rb

@@ -27,85 +27,85 @@ class Chef
 
       description "Use the **git** resource to manage source control resources that exist in a git repository. git version 1.6.5 (or higher) is required to use all of the functionality in the git resource."
       examples <<~DOC
-      **Use the git mirror**
-
-      ```ruby
-      git '/opt/my_sources/couch' do
-        repository 'git://git.apache.org/couchdb.git'
-        revision 'master'
-        action :sync
-      end
-      ```
-
-      **Use different branches**
-
-      To use different branches, depending on the environment of the node:
-
-      ```ruby
-      branch_name = if node.chef_environment == 'QA'
-                      'staging'
-                    else
-                      'master'
-                    end
-
-      git '/home/user/deployment' do
-         repository 'git@github.com:git_site/deployment.git'
-         revision branch_name
-         action :sync
-         user 'user'
-         group 'test'
-      end
-      ```
-
-      Where the `branch_name` variable is set to staging or master, depending on the environment of the node. Once this is determined, the `branch_name` variable is used to set the revision for the repository. If the git status command is used after running the example above, it will return the branch name as `deploy`, as this is the default value. Run Chef Infra Client in debug mode to verify that the correct branches are being checked out:
-
-      ```
-      sudo chef-client -l debug
-      ```
-
-      **Install an application from git using bash**
-
-      The following example shows how Bash can be used to install a plug-in for rbenv named ruby-build, which is located in git version source control. First, the application is synchronized, and then Bash changes its working directory to the location in which ruby-build is located, and then runs a command.
-
-      ```ruby
-      git "#{Chef::Config[:file_cache_path]}/ruby-build" do
-        repository 'git://github.com/rbenv/ruby-build.git'
-        revision 'master'
-        action :sync
-      end
-
-      bash 'install_ruby_build' do
-        cwd "#{Chef::Config[:file_cache_path]}/ruby-build"
-        user 'rbenv'
-        group 'rbenv'
-        code <<-EOH
-          ./install.sh
-          EOH
-        environment 'PREFIX' => '/usr/local'
-      end
-      ```
-
-      **Notify a resource post-checkout**
-
-      ```ruby
-      git "#{Chef::Config[:file_cache_path]}/my_app" do
-        repository node['my_app']['git_repository']
-        revision node['my_app']['git_revision']
-        action :sync
-        notifies :run, 'bash[compile_my_app]', :immediately
-      end
-      ```
-
-      **Pass in environment variables**
-
-      ```ruby
-      git '/opt/my_sources/couch' do
-        repository 'git://git.apache.org/couchdb.git'
-        revision 'master'
-        environment 'VAR' => 'whatever'
-        action :sync
-      end
-      ```
+        **Use the git mirror**
+
+        ```ruby
+        git '/opt/my_sources/couch' do
+          repository 'git://git.apache.org/couchdb.git'
+          revision 'master'
+          action :sync
+        end
+        ```
+
+        **Use different branches**
+
+        To use different branches, depending on the environment of the node:
+
+        ```ruby
+        branch_name = if node.chef_environment == 'QA'
+                        'staging'
+                      else
+                        'master'
+                      end
+
+        git '/home/user/deployment' do
+           repository 'git@github.com:git_site/deployment.git'
+           revision branch_name
+           action :sync
+           user 'user'
+           group 'test'
+        end
+        ```
+
+        Where the `branch_name` variable is set to staging or master, depending on the environment of the node. Once this is determined, the `branch_name` variable is used to set the revision for the repository. If the git status command is used after running the example above, it will return the branch name as `deploy`, as this is the default value. Run Chef Infra Client in debug mode to verify that the correct branches are being checked out:
+
+        ```
+        sudo chef-client -l debug
+        ```
+
+        **Install an application from git using bash**
+
+        The following example shows how Bash can be used to install a plug-in for rbenv named ruby-build, which is located in git version source control. First, the application is synchronized, and then Bash changes its working directory to the location in which ruby-build is located, and then runs a command.
+
+        ```ruby
+        git "#{Chef::Config[:file_cache_path]}/ruby-build" do
+          repository 'git://github.com/rbenv/ruby-build.git'
+          revision 'master'
+          action :sync
+        end
+
+        bash 'install_ruby_build' do
+          cwd "#{Chef::Config[:file_cache_path]}/ruby-build"
+          user 'rbenv'
+          group 'rbenv'
+          code <<-EOH
+            ./install.sh
+            EOH
+          environment 'PREFIX' => '/usr/local'
+        end
+        ```
+
+        **Notify a resource post-checkout**
+
+        ```ruby
+        git "#{Chef::Config[:file_cache_path]}/my_app" do
+          repository node['my_app']['git_repository']
+          revision node['my_app']['git_revision']
+          action :sync
+          notifies :run, 'bash[compile_my_app]', :immediately
+        end
+        ```
+
+        **Pass in environment variables**
+
+        ```ruby
+        git '/opt/my_sources/couch' do
+          repository 'git://git.apache.org/couchdb.git'
+          revision 'master'
+          environment 'VAR' => 'whatever'
+          action :sync
+        end
+        ```
       DOC
 
       property :additional_remotes, Hash,

data/lib/chef/resource/scm/subversion.rb

@@ -28,16 +28,16 @@ class Chef
 
       description "Use the **subversion** resource to manage source control resources that exist in a Subversion repository. Warning: The subversion resource has known bugs and may not work as expected. For more information see Chef GitHub issues, particularly [#4050](https://github.com/chef/chef/issues/4050) and [#4257](https://github.com/chef/chef/issues/4257)."
       examples <<~DOC
-      **Get the latest version of an application**
+        **Get the latest version of an application**
 
-      ```ruby
-      subversion 'CouchDB Edge' do
-        repository 'http://svn.apache.org/repos/asf/couchdb/trunk'
-        revision 'HEAD'
-        destination '/opt/my_sources/couch'
-        action :sync
-      end
-      ```
+        ```ruby
+        subversion 'CouchDB Edge' do
+          repository 'http://svn.apache.org/repos/asf/couchdb/trunk'
+          revision 'HEAD'
+          destination '/opt/my_sources/couch'
+          action :sync
+        end
+        ```
       DOC
 
       allowed_actions :force_export

data/lib/chef/resource/script.rb

@@ -27,9 +27,9 @@ class Chef
 
       identity_attr :name
 
-      description "Use the **script** resource to execute scripts using a specified interpreter, such as Bash, csh, Perl, Python, or Ruby."\
-                  " This resource may also use any of the actions and properties that are available to the **execute** resource. Commands"\
-                  " that are executed with this resource are (by their nature) not idempotent, as they are typically unique to the"\
+      description "Use the **script** resource to execute scripts using a specified interpreter, such as Bash, csh, Perl, Python, or Ruby." \
+                  " This resource may also use any of the actions and properties that are available to the **execute** resource. Commands" \
+                  " that are executed with this resource are (by their nature) not idempotent, as they are typically unique to the" \
                   " environment in which they are run. Use `not_if` and `only_if` to guard this resource for idempotence."
 
       def initialize(name, run_context = nil)