chef 18.9.4 → 18.11.11

data/lib/chef/provider/package/rubygems.rb

@@ -375,6 +375,8 @@ class Chef
             cmd = "#{@gem_binary_location} list #{gem_dependency.name} --remote --all #{source_args}"
             result = shell_out!(cmd)
 
+            target_platforms = nil
+
             versions = []
             result.stdout.each_line do |line|
               next unless line.start_with?("#{gem_dependency.name} (")
@@ -383,10 +385,31 @@ class Chef
               next unless version_string
 
               version_string.split(/,\s*/).each do |v|
-                version = Gem::Version.new(v.strip)
+                # `gem list --remote --all` emits entries like "1.6.0 x86_64-linux".
+                # Accept platform-specific tokens only when the platform is compatible
+                # with the target gem environment; pure-Ruby tokens have no suffix and
+                # are always accepted.
+                version_token, *platform_tokens = v.strip.split(/\s+/)
+
+                if platform_tokens.any?
+                  target_platforms ||= gem_platforms
+                  # Each comma-separated entry from `gem list --remote --all` can list
+                  # multiple platforms for one version: "1.5.9 ruby x86_64-linux aarch64-linux ...".
+                  # Accept if any listed platform is "ruby" (pure-Ruby) or matches the target env.
+                  compatible = platform_tokens.any? do |pt|
+                    pt == "ruby" || target_platforms.any? do |p|
+                      Gem::Platform.new(p) === Gem::Platform.new(pt)
+                    rescue ArgumentError
+                      false
+                    end
+                  end
+                  next unless compatible
+                end
+
+                version = Gem::Version.new(version_token)
                 versions << version if gem_dependency.requirement.satisfied_by?(version)
               rescue ArgumentError
-                # Skip invalid versions
+                # Skip tokens with invalid version strings.
               end
             end
 

data/lib/chef/provider/package/snap.rb

@@ -135,7 +135,7 @@ class Chef
             "Accept: application/json\r\n" +
             "Content-Type: application/json\r\n"
           if method == "POST"
-            pdata = post_data.to_json.to_s
+            pdata = post_data.to_json
             request.concat("Content-Length: #{pdata.bytesize}\r\n\r\n#{pdata}")
           end
           request.concat("\r\n")

data/lib/chef/provider/package/windows/exe.rb

@@ -92,7 +92,7 @@ class Chef
 
           def current_installed_version
             @current_installed_version ||=
-              if uninstall_entries.count != 0
+              if uninstall_entries.any?
                 uninstall_entries.map(&:display_version).uniq
               end
           end

data/lib/chef/provider/package/windows/msi.rb

@@ -52,7 +52,7 @@ class Chef
               logger.trace("#{new_resource} checking package status and version for #{product_code}")
               get_installed_version(product_code)
             else
-              if uninstall_entries.count != 0
+              if uninstall_entries.any?
                 uninstall_entries.map(&:display_version).uniq
               end
             end

data/lib/chef/provider/package/yum/rpm_utils.rb

@@ -78,12 +78,12 @@ class Chef
 
             def isalpha(x)
               v = x.ord
-              (v >= 65 && v <= 90) || (v >= 97 && v <= 122)
+              (v.between?(65, 90)) || (v.between?(97, 122))
             end
 
             def isdigit(x)
               v = x.ord
-              v >= 48 && v <= 57
+              v.between?(48, 57)
             end
 
             # based on the reference spec in lib/rpmvercmp.c in rpm 4.9.0

data/lib/chef/provider/package/yum.rb

@@ -38,7 +38,7 @@ class Chef
         use_package_name_for_source
         use_magic_version
 
-        provides :package, platform_family: "fedora_derived"
+        provides :package, platform_family: %w{fedora rhel amazon}
 
         provides :yum_package
 

data/lib/chef/provider/powershell_script.rb

@@ -204,91 +204,91 @@ class Chef
       # very slightly different semantics.
       def powershell_wrapper_script
         <<~EOH
-          # Chef Client wrapper for powershell_script resources
-
-          # In rare cases, such as when PowerShell is executed
-          # as an alternate user, the new-variable cmdlet is not
-          # available, so import it just in case
-          if ( get-module -ListAvailable Microsoft.PowerShell.Utility )
-          {
-              Import-Module Microsoft.PowerShell.Utility
-          }
-
-          # LASTEXITCODE can be uninitialized -- make it explicitly 0
-          # to avoid incorrect detection of failure (non-zero) codes
-          $global:LASTEXITCODE = 0
-
-          # Catch any exceptions -- without this, exceptions will result
-          # In a zero return code instead of the desired non-zero code
-          # that indicates a failure
-
-#{if new_resource.use_inline_powershell
-    # Inline powershell doesn't allow for private visibility variables,
-    # and uses return instead of exit
-    <<-EOI
-          trap [Exception] {write-error ($_.Exception.Message);return 1}
-          $interpolatedexitcode = $#{new_resource.convert_boolean_return}
-    EOI
-  else
-    <<-EOI
-          trap [Exception] {write-error ($_.Exception.Message);exit 1}
-
-          # Variable state that should not be accessible to the user code
-          new-variable -name interpolatedexitcode -visibility private -value $#{new_resource.convert_boolean_return}
-          new-variable -name chefscriptresult -visibility private
-    EOI
-  end}
-          # Initialize a variable we use to capture $? inside a block
-          $global:lastcmdlet = $null
-
-          # Execute the user's code in a script block --
-          $chefscriptresult =
-          {
-           #{new_resource.code}
-
-           # This assignment doesn't affect the block's return value
-           $global:lastcmdlet = $?
-          }.invokereturnasis()
-
-          # Assume failure status of 1 -- success cases
-          # will have to override this
-          $exitstatus = 1
-
-          # If convert_boolean_return is enabled, the block's return value
-          # gets precedence in determining our exit status
-          if ($interpolatedexitcode -and $chefscriptresult -ne $null -and $chefscriptresult.gettype().name -eq 'boolean')
-          {
-            $exitstatus = [int32](!$chefscriptresult)
-          }
-          elseif ($lastcmdlet)
-          {
-            # Otherwise, a successful cmdlet execution defines the status
-            $exitstatus = 0
-          }
-          elseif ( $LASTEXITCODE -ne $null -and $LASTEXITCODE -ne 0 )
-          {
-            # If the cmdlet status is failed, allow the Win32 status
-            # in $LASTEXITCODE to define exit status. This handles the case
-            # where no cmdlets, only Win32 processes have run since $?
-            # will be set to $false whenever a Win32 process returns a non-zero
-            # status.
-            $exitstatus = $LASTEXITCODE
+                    # Chef Client wrapper for powershell_script resources
+
+                    # In rare cases, such as when PowerShell is executed
+                    # as an alternate user, the new-variable cmdlet is not
+                    # available, so import it just in case
+                    if ( get-module -ListAvailable Microsoft.PowerShell.Utility )
+                    {
+                        Import-Module Microsoft.PowerShell.Utility
+                    }
+
+                    # LASTEXITCODE can be uninitialized -- make it explicitly 0
+                    # to avoid incorrect detection of failure (non-zero) codes
+                    $global:LASTEXITCODE = 0
+
+                    # Catch any exceptions -- without this, exceptions will result
+                    # In a zero return code instead of the desired non-zero code
+                    # that indicates a failure
+
+          #{if new_resource.use_inline_powershell
+              # Inline powershell doesn't allow for private visibility variables,
+              # and uses return instead of exit
+              <<-EOI
+                    trap [Exception] {write-error ($_.Exception.Message);return 1}
+                    $interpolatedexitcode = $#{new_resource.convert_boolean_return}
+              EOI
+            else
+              <<-EOI
+                    trap [Exception] {write-error ($_.Exception.Message);exit 1}
+
+                    # Variable state that should not be accessible to the user code
+                    new-variable -name interpolatedexitcode -visibility private -value $#{new_resource.convert_boolean_return}
+                    new-variable -name chefscriptresult -visibility private
+              EOI
+            end}
+                    # Initialize a variable we use to capture $? inside a block
+                    $global:lastcmdlet = $null
+
+                    # Execute the user's code in a script block --
+                    $chefscriptresult =
+                    {
+                     #{new_resource.code}
+
+                     # This assignment doesn't affect the block's return value
+                     $global:lastcmdlet = $?
+                    }.invokereturnasis()
+
+                    # Assume failure status of 1 -- success cases
+                    # will have to override this
+                    $exitstatus = 1
+
+                    # If convert_boolean_return is enabled, the block's return value
+                    # gets precedence in determining our exit status
+                    if ($interpolatedexitcode -and $chefscriptresult -ne $null -and $chefscriptresult.gettype().name -eq 'boolean')
+                    {
+                      $exitstatus = [int32](!$chefscriptresult)
+                    }
+                    elseif ($lastcmdlet)
+                    {
+                      # Otherwise, a successful cmdlet execution defines the status
+                      $exitstatus = 0
+                    }
+                    elseif ( $LASTEXITCODE -ne $null -and $LASTEXITCODE -ne 0 )
+                    {
+                      # If the cmdlet status is failed, allow the Win32 status
+                      # in $LASTEXITCODE to define exit status. This handles the case
+                      # where no cmdlets, only Win32 processes have run since $?
+                      # will be set to $false whenever a Win32 process returns a non-zero
+                      # status.
+                      $exitstatus = $LASTEXITCODE
+                    }
+
+                    # Print STDOUT for the script execution
+                    Write-Output $chefscriptresult
+
+                    # If this script is launched with -File, the process exit
+                    # status of PowerShell.exe will be $exitstatus. If it was
+                    # launched with -Command, it will be 0 if $exitstatus was 0,
+                    # 1 (i.e. failed) otherwise.
+          #{if new_resource.use_inline_powershell
+              # Inline powershell needs return, not exit
+              "return $exitstatus\n"
+            else
+              "exit $exitstatus\n"
+            end
           }
-
-          # Print STDOUT for the script execution
-          Write-Output $chefscriptresult
-
-          # If this script is launched with -File, the process exit
-          # status of PowerShell.exe will be $exitstatus. If it was
-          # launched with -Command, it will be 0 if $exitstatus was 0,
-          # 1 (i.e. failed) otherwise.
-#{if new_resource.use_inline_powershell
-    # Inline powershell needs return, not exit
-    "return $exitstatus\n"
-  else
-    "exit $exitstatus\n"
-  end
-}
         EOH
       end
 

data/lib/chef/provider/service/debian.rb

@@ -91,11 +91,9 @@ class Chef
 
         def get_priority
           priority = {}
-          rc_files = []
-
           levels = parse_init_file(@init_command)
-          levels.each do |level|
-            rc_files.push Dir.glob("/etc/rc#{level}.d/[SK][0-9][0-9]#{current_resource.service_name}")
+          rc_files = levels.map do |level|
+            Dir.glob("/etc/rc#{level}.d/[SK][0-9][0-9]#{current_resource.service_name}")
           end
 
           rc_files.flatten.each do |line|

data/lib/chef/provider/user/dscl.rb

@@ -429,7 +429,7 @@ in 'password', with the associated 'salt' and 'iterations'.")
         # Unlocks the user
         #
         def unlock_user
-          auth_string = authentication_authority.gsub(/AuthenticationAuthority: /, "").gsub(/;DisabledUser;/, "").strip
+          auth_string = authentication_authority.gsub("AuthenticationAuthority: ", "").gsub(";DisabledUser;", "").strip
           run_dscl("create", "/Users/#{new_resource.username}", "AuthenticationAuthority", auth_string)
         end
 

data/lib/chef/provider/user/mac.rb

@@ -307,7 +307,7 @@ class Chef
 
         def remove_user
           cmd = ["-deleteUser", new_resource.username]
-          cmd << new_resource.manage_home ? "-secure" : "-keepHome"
+          cmd << new_resource.manage_home ? "-secure" : "-keepHome" # rubocop:disable Lint/Void
           if %i{admin_username admin_password}.all? { |p| prop_is_set?(p) }
             cmd += ["-adminUser", new_resource.admin_username]
             cmd += ["-adminPassword", new_resource.admin_password]

data/lib/chef/provider/windows_script.rb

@@ -94,7 +94,7 @@ class Chef
         acl = Chef::ReservedNames::Win32::Security::ACL.create(aces)
 
         # This actually applies the modified DACL to the file
-        # Use parentheses to bypass RuboCop / ChefStyle warning
+        # Use parentheses to bypass RuboCop / Cookstyle warning
         # about useless setter
         (securable_object.dacl = acl)
       end

data/lib/chef/resource/_rest_resource.rb

@@ -86,7 +86,7 @@ action :delete do
     end
   else
     logger.debug format("REST resource %<name>s of type %<type>s does not exist. Skipping.",
-                        type: new_resource.name, name: id_property)
+      type: new_resource.name, name: id_property)
   end
 end
 
@@ -174,13 +174,15 @@ action_class do
   end
 
   def rest_url_collection
-    current_resource.class.rest_api_collection
+    endpoint = current_resource.class.rest_api_endpoint || ""
+    "#{endpoint}#{current_resource.class.rest_api_collection}"
   end
 
   # Resource document URL after RFC 6570 template evaluation via properties substitution
   def rest_url_document
+    endpoint = current_resource.class.rest_api_endpoint || ""
     template = ::Addressable::Template.new(current_resource.class.rest_api_document)
-    template.expand(property_map).to_s
+    "#{endpoint}#{template.expand(property_map)}"
   end
 
   # Convenience method for conditional requires
@@ -198,9 +200,9 @@ action_class do
       end
 
       message = format("Setting property :%<property>s requires properties :%<properties>s to be set as well on resource %<resource_name>s",
-                       property: property,
-                       properties: dependent_properties.join(", :"),
-                       resource_name: current_resource.to_s)
+        property: property,
+        properties: dependent_properties.join(", :"),
+        resource_name: current_resource.to_s)
 
       a.failure_message message
     end
@@ -376,7 +378,7 @@ action_class do
     arr = path.split(".")
     ret = {}
 
-    if arr.count == 1
+    if arr.one?
       ret[arr.first] = value
 
       ret

data/lib/chef/resource/alternatives.rb

@@ -28,54 +28,54 @@ class Chef
       description "Use the **alternatives** resource to configure command alternatives in Linux using the alternatives or update-alternatives packages."
       introduced "16.0"
       examples <<~DOC
-      **Install an alternative**:
-
-      ```ruby
-      alternatives 'python install 2' do
-        link_name 'python'
-        path '/usr/bin/python2.7'
-        priority 100
-        action :install
-      end
-      ```
+        **Install an alternative**:
+
+        ```ruby
+        alternatives 'python install 2' do
+          link_name 'python'
+          path '/usr/bin/python2.7'
+          priority 100
+          action :install
+        end
+        ```
 
-      **Set an alternative**:
+        **Set an alternative**:
 
-      ```ruby
-      alternatives 'python set version 3' do
-        link_name 'python'
-        path '/usr/bin/python3'
-        action :set
-      end
-      ```
+        ```ruby
+        alternatives 'python set version 3' do
+          link_name 'python'
+          path '/usr/bin/python3'
+          action :set
+        end
+        ```
 
-      **Set the automatic alternative state**:
+        **Set the automatic alternative state**:
 
-      ```ruby
-      alternatives 'python auto' do
-        link_name 'python'
-        action :auto
-      end
-      ```
+        ```ruby
+        alternatives 'python auto' do
+          link_name 'python'
+          action :auto
+        end
+        ```
 
-      **Refresh an alternative**:
+        **Refresh an alternative**:
 
-      ```ruby
-      alternatives 'python refresh' do
-        link_name 'python'
-        action :refresh
-      end
-      ```
+        ```ruby
+        alternatives 'python refresh' do
+          link_name 'python'
+          action :refresh
+        end
+        ```
 
-      **Remove an alternative**:
+        **Remove an alternative**:
 
-      ```ruby
-      alternatives 'python remove' do
-        link_name 'python'
-        path '/usr/bin/python3'
-        action :remove
-      end
-      ```
+        ```ruby
+        alternatives 'python remove' do
+          link_name 'python'
+          path '/usr/bin/python3'
+          action :remove
+        end
+        ```
       DOC
 
       property :link_name, String,
@@ -91,7 +91,7 @@ class Chef
         description: "The absolute path to the original application binary such as `/usr/bin/ruby27`."
 
       property :priority, [String, Integer],
-        coerce: proc { |n| n.to_i },
+        coerce: proc(&:to_i),
         description: "The priority of the alternative."
 
       def define_resource_requirements

data/lib/chef/resource/apt_package.rb

@@ -25,48 +25,48 @@ class Chef
       provides :apt_package, target_mode: true
       provides :package, platform_family: "debian", target_mode: true
       examples <<~DOC
-      **Install a package using package manager**:
+        **Install a package using package manager**:
 
-      ```ruby
-      apt_package 'name of package' do
-        action :install
-      end
-      ```
+        ```ruby
+        apt_package 'name of package' do
+          action :install
+        end
+        ```
 
-      **Install a package without specifying the default action**:
+        **Install a package without specifying the default action**:
 
-      ```ruby
-      apt_package 'name of package'
-      ```
+        ```ruby
+        apt_package 'name of package'
+        ```
 
-      **Install multiple packages at once**:
+        **Install multiple packages at once**:
 
-      ```ruby
-      apt_package %w(package1 package2 package3)
-      ```
+        ```ruby
+        apt_package %w(package1 package2 package3)
+        ```
 
-      **Install without using recommend packages as a dependency**:
+        **Install without using recommend packages as a dependency**:
 
-      ```ruby
-      package 'apache2' do
-        options '--no-install-recommends'
-      end
-      ```
+        ```ruby
+        package 'apache2' do
+          options '--no-install-recommends'
+        end
+        ```
 
-      **Prevent the apt_package resource from installing packages with pattern matching names**:
+        **Prevent the apt_package resource from installing packages with pattern matching names**:
 
-      By default, the apt_package resource will install the named package.
-      If it can't find a package with the exact same name, it will treat the package name as regular expression string and match with any package that matches that regular expression.
-      This may lead Chef Infra Client to install one or more packages with names that match that regular expression.
+        By default, the apt_package resource will install the named package.
+        If it can't find a package with the exact same name, it will treat the package name as regular expression string and match with any package that matches that regular expression.
+        This may lead Chef Infra Client to install one or more packages with names that match that regular expression.
 
-      In this example, `anchor_package_regex true` prevents the apt_package resource from installing matching packages if it can't find the `lua5.3` package.
+        In this example, `anchor_package_regex true` prevents the apt_package resource from installing matching packages if it can't find the `lua5.3` package.
 
-      ```ruby
-      apt_package 'lua5.3' do
-        version '5.3.3-1.1ubuntu2'
-        anchor_package_regex true
-      end
-      ```
+        ```ruby
+        apt_package 'lua5.3' do
+          version '5.3.3-1.1ubuntu2'
+          anchor_package_regex true
+        end
+        ```
       DOC
 
       description "Use the **apt_package** resource to manage packages on Debian, Ubuntu, and other platforms that use the APT package system."

data/lib/chef/resource/apt_preference.rb

@@ -27,34 +27,34 @@ class Chef
       description "Use the **apt_preference** resource to create APT [preference files](https://wiki.debian.org/AptPreferences). Preference files are used to control which package versions and sources are prioritized during installation."
       introduced "13.3"
       examples <<~DOC
-      **Pin libmysqlclient16 to a version 5.1.49-3**:
+        **Pin libmysqlclient16 to a version 5.1.49-3**:
 
-      ```ruby
-      apt_preference 'libmysqlclient16' do
-        pin          'version 5.1.49-3'
-        pin_priority '700'
-      end
-      ```
+        ```ruby
+        apt_preference 'libmysqlclient16' do
+          pin          'version 5.1.49-3'
+          pin_priority '700'
+        end
+        ```
 
-      Note: The `pin_priority` of `700` ensures that this version will be preferred over any other available versions.
+        Note: The `pin_priority` of `700` ensures that this version will be preferred over any other available versions.
 
-      **Unpin a libmysqlclient16**:
+        **Unpin a libmysqlclient16**:
 
-      ```ruby
-      apt_preference 'libmysqlclient16' do
-        action :remove
-      end
-      ```
+        ```ruby
+        apt_preference 'libmysqlclient16' do
+          action :remove
+        end
+        ```
 
-      **Pin all packages to prefer the packages.dotdeb.org repository**:
+        **Pin all packages to prefer the packages.dotdeb.org repository**:
 
-      ```ruby
-      apt_preference 'dotdeb' do
-        glob         '*'
-        pin          'origin packages.dotdeb.org'
-        pin_priority '700'
-      end
-      ```
+        ```ruby
+        apt_preference 'dotdeb' do
+          glob         '*'
+          pin          'origin packages.dotdeb.org'
+          pin_priority '700'
+        end
+        ```
       DOC
 
       property :package_name, String,

data/lib/chef/resource/apt_repository.rb

@@ -201,7 +201,7 @@ class Chef
         # @return [Array] an array of fingerprints
         def extract_fingerprints_from_cmd(*cmd)
           so = shell_out(*cmd)
-          so.stdout.split(/\n/).map do |t|
+          so.stdout.split("\n").map do |t|
             if z = t.match(/^fpr:+([0-9A-F]+):/)
               z[1].split.join
             end
@@ -218,7 +218,7 @@ class Chef
           so = shell_out(*cmd)
           # Sample output
           # pub:-:4096:1:D94AA3F0EFE21092:1336774248:::-:::scSC::::::23::0:
-          so.stdout.split(/\n/).map do |t|
+          so.stdout.split("\n").map do |t|
             if t.match(/^pub:/)
               f = t.split(":")
               f.slice(0, 6).join(":")