cookstyle 6.16.4 → 6.17.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c12050a348d700990dba93b33e7e15d0151ff5f2fef01aed90bb4f8014a6c04b
-  data.tar.gz: 62577299c8994813248be5f8c73e27680fd9907d7c2088656e0cb03f035f5932
+  metadata.gz: ba71cee9089746fb000cf88734c03cd0017265baba00f7559ad9f31453ec8d78
+  data.tar.gz: 57599dee847f9240cd882bf777cdc5b6a45649851725f0520c9f2704ff181b14
 SHA512:
-  metadata.gz: df19582100f6907be3fdb9d2fcd5f583c674b57538abce8d69d98e4112dab6232e65e3e298347479698a32dace5c41d6f99e6bd1ca83e48955c75f41ec982624
-  data.tar.gz: 0ed13875d921f88edeb14a476b7bbd71342136e6d4f7a1b9ca83a17953951e949aa38ffc85e8792a4a48ecb774d3ad8387d4fe5aa48c757c0723830c06cb272c
+  metadata.gz: e54c382931bae26f96ddad4d54ed69f630d4ab02464dae8f5bbce300d0a0b552d765151dbc912456a34e8344b4517e98f520a839d20266d0f9a7e1d09b4eac0d
+  data.tar.gz: 2ed745d40e3538b0681cdce2e896a8ae1b99c29fd0ca7d74dd0c007ebf1b13458cbf39d383a26aa26a932289e1badf796e06ab6f145046f305c301b9b634a792

data/bin/cookstyle

@@ -2,7 +2,7 @@
 # -*- encoding: utf-8 -*-
 # frozen_string_literal: true
 
-$LOAD_PATH.unshift File.join(File.dirname(__FILE__), %w(.. lib))
+$LOAD_PATH.unshift File.join(__dir__, %w(.. lib))
 
 require 'cookstyle'
 

data/config/cookstyle.yml

@@ -908,10 +908,11 @@ ChefDeprecations/RubyBlockCreateAction:
     - '**/Berksfile'
 
 ChefDeprecations/DeprecatedPlatformMethods:
-  Description: Use provider_for_action instead of the deprecated Chef::Platform methods in resources.
+  Description: Use provider_for_action or provides instead of the deprecated Chef::Platform methods in resources.
   StyleGuide: '#chefdeprecationsdeprecatedplatformmethods'
   Enabled: true
   VersionAdded: '5.16.0'
+  VersionChanged: '6.17.0'
   Include:
     - '**/libraries/*.rb'
     - '**/resources/*.rb'
@@ -1062,6 +1063,46 @@ ChefDeprecations/CookbooksDependsOnSelf:
   Include:
     - '**/metadata.rb'
 
+ChefDeprecations/ChefShellout:
+  Description: Don't use deprecated Chef::ShellOut which was removed in Chef Infra Client 13. Use Mixlib::ShellOut instead, which behaves identically.
+  StyleGuide: '#chefdeprecationschefshellout'
+  Enabled: true
+  VersionAdded: '6.17.0'
+  Exclude:
+    - '**/metadata.rb'
+    - '**/attributes/*.rb'
+    - '**/Berksfile'
+
+ChefDeprecations/ExecutePathProperty:
+  Description: In Chef Infra Client 13 and later you must set path env vars in `execute` resources using the `environment` property not the legacy `path` property.
+  StyleGuide: '#chefdeprecationsexecutepathproperty'
+  Enabled: true
+  VersionAdded: '6.17.0'
+  Exclude:
+    - '**/metadata.rb'
+    - '**/attributes/*.rb'
+    - '**/Berksfile'
+
+ChefDeprecations/ExecuteRelativeCreatesWithoutCwd:
+  Description: In Chef Infra Client 13 and later you must either specify an absolute path when using the `execute` resource's `creates` property or also use the `cwd` property.
+  StyleGuide: '#chefdeprecationsexecuterelativecreateswithoutcwd'
+  Enabled: true
+  VersionAdded: '6.17.0'
+  Exclude:
+    - '**/metadata.rb'
+    - '**/attributes/*.rb'
+    - '**/Berksfile'
+
+ChefDeprecations/WindowsPackageInstallerTypeString:
+  Description: In Chef Infra Client 13 and later the `windows_package` resource's `installer_type` property must be a symbol.
+  StyleGuide: '#chefdeprecationswindowspackageinstallertypestring'
+  Enabled: true
+  VersionAdded: '6.17.0'
+  Exclude:
+    - '**/metadata.rb'
+    - '**/attributes/*.rb'
+    - '**/Berksfile'
+
 ###############################
 # ChefModernize: Cleaning up legacy code and using new built-in resources
 ###############################
@@ -2612,4 +2653,8 @@ Style/BisectedAttrAccessor:
 
 # avoid assignments that aren't needed
 Style/RedundantAssignment:
-  Enabled: true
+  Enabled: true
+
+# alert on invalid ruby
+Lint/Syntax:
+  Enabled: true

data/config/upstream.yml

@@ -1861,7 +1861,6 @@ Lint/Syntax:
   Enabled: true
   VersionAdded: '0.9'
 
-
 Lint/ToJSON:
   Description: 'Ensure #to_json includes an optional argument.'
   Enabled: true

data/lib/cookstyle.rb

@@ -19,7 +19,7 @@ module RuboCop
   class ConfigLoader
     RUBOCOP_HOME.gsub!(
       /^.*$/,
-      File.realpath(File.join(File.dirname(__FILE__), '..'))
+      File.realpath(File.join(__dir__, '..'))
     )
 
     DEFAULT_FILE.gsub!(
@@ -46,7 +46,7 @@ require_relative 'rubocop/chef/cookbook_only'
 require_relative 'rubocop/cop/target_chef_version'
 
 # Chef Infra specific cops
-Dir.glob(File.dirname(__FILE__) + '/rubocop/cop/chef/**/*.rb') do |file|
+Dir.glob(__dir__ + '/rubocop/cop/chef/**/*.rb') do |file|
   next if File.directory?(file)
 
   require_relative file # not actually relative but require_relative is faster

data/lib/cookstyle/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 module Cookstyle
-  VERSION = "6.16.4" # rubocop: disable Style/StringLiterals
+  VERSION = "6.17.6" # rubocop: disable Style/StringLiterals
   RUBOCOP_VERSION = '0.90.0'
 end

data/lib/rubocop/cop/chef/correctness/incorrect_library_injection.rb

@@ -38,11 +38,11 @@ module RuboCop
           MSG = 'Libraries should be injected into the Chef::DSL::Recipe class and not Chef::Recipe or Chef::Provider classes directly.'
 
           def_node_matcher :legacy_class_sends?, <<-PATTERN
-            (send (const (const (cbase) :Chef) {:Recipe :Provider}) :send (sym :include) ... )
+            (send (const (const {cbase nil?} :Chef) {:Recipe :Provider}) :send (sym :include) ... )
           PATTERN
 
           def_node_matcher :legacy_class_includes?, <<-PATTERN
-            (send (const (const (cbase) :Chef) {:Recipe :Provider}) :include ... )
+            (send (const (const {cbase nil?} :Chef) {:Recipe :Provider}) :include ... )
           PATTERN
 
           def on_send(node)

data/lib/rubocop/cop/chef/correctness/invalid_default_action.rb

@@ -32,6 +32,7 @@ module RuboCop
       module ChefCorrectness
         class InvalidDefaultAction < Base
           MSG = 'Default actions in resources should be symbols or an array of symbols.'
+          RESTRICT_ON_SEND = [:default_action].freeze
 
           def_node_matcher :default_action?, '(send nil? :default_action $_)'
 

data/lib/rubocop/cop/chef/correctness/invalid_notification_timing.rb

@@ -37,6 +37,7 @@ module RuboCop
         #
         class InvalidNotificationTiming < Base
           MSG = 'Valid notification timings are :immediately, :immediate (alias for :immediately), :delayed, and :before.'
+          RESTRICT_ON_SEND = [:notifies, :subscribes].freeze
 
           def_node_matcher :notification_with_timing?, <<-PATTERN
             (send nil? {:notifies :subscribes} (sym _) (...) $(sym _))

data/lib/rubocop/cop/chef/correctness/invalid_platform_family_helper.rb

@@ -37,6 +37,7 @@ module RuboCop
           extend AutoCorrector
 
           MSG = 'Pass valid platform families to the platform_family? helper.'
+          RESTRICT_ON_SEND = [:platform_family?].freeze
 
           def_node_matcher :platform_family_helper?, <<-PATTERN
             (send nil? :platform_family? $str*)

data/lib/rubocop/cop/chef/correctness/invalid_platform_helper.rb

@@ -36,6 +36,7 @@ module RuboCop
           include ::RuboCop::Chef::PlatformHelpers
 
           MSG = 'Pass valid platforms to the platform? helper.'
+          RESTRICT_ON_SEND = [:platform?].freeze
 
           def_node_matcher :platform_helper?, <<-PATTERN
             (send nil? :platform? $str*)

data/lib/rubocop/cop/chef/correctness/invalid_platform_metadata.rb

@@ -37,6 +37,7 @@ module RuboCop
           include ::RuboCop::Chef::PlatformHelpers
 
           MSG = 'metadata.rb "supports" platform is invalid'
+          RESTRICT_ON_SEND = [:supports].freeze
 
           def_node_matcher :supports?, '(send nil? :supports $str ...)'
 

data/lib/rubocop/cop/chef/correctness/invalid_value_for_platform_family_helper.rb

@@ -39,6 +39,7 @@ module RuboCop
           include ::RuboCop::Chef::PlatformHelpers
 
           MSG = 'Pass valid platform families to the value_for_platform_family helper.'
+          RESTRICT_ON_SEND = [:value_for_platform_family].freeze
 
           def_node_matcher :value_for_platform_family?, <<-PATTERN
           (send nil? :value_for_platform_family

data/lib/rubocop/cop/chef/correctness/invalid_value_for_platform_helper.rb

@@ -38,6 +38,7 @@ module RuboCop
           include ::RuboCop::Chef::PlatformHelpers
 
           MSG = 'Pass valid platforms to the value_for_platform helper.'
+          RESTRICT_ON_SEND = [:value_for_platform].freeze
 
           def_node_matcher :value_for_platform?, <<-PATTERN
           (send nil? :value_for_platform

data/lib/rubocop/cop/chef/correctness/malformed_value_for_platform.rb

@@ -45,9 +45,9 @@ module RuboCop
         #   )
         #
         class MalformedPlatformValueForPlatformHelper < Base
-          def on_send(node)
-            return unless node.method_name == :value_for_platform
+          RESTRICT_ON_SEND = [:value_for_platform].freeze
 
+          def on_send(node)
             if node.arguments.count > 1
               msg = 'Malformed value_for_platform helper argument. The value_for_platform helper takes a single hash of platforms as an argument.'
               add_offense(node, message: msg, severity: :refactor)

data/lib/rubocop/cop/chef/correctness/service_resource.rb

@@ -29,6 +29,7 @@ module RuboCop
         #
         class ServiceResource < Base
           MSG = 'Use a service resource to start and stop services'
+          RESTRICT_ON_SEND = [:command].freeze
 
           def_node_matcher :execute_command?, <<-PATTERN
             (send nil? :command $str)

data/lib/rubocop/cop/chef/correctness/supports_must_be_float.rb

@@ -34,6 +34,7 @@ module RuboCop
           extend RuboCop::Cop::AutoCorrector
 
           MSG = 'Versions used in metadata.rb supports calls should be floats not integers.'
+          RESTRICT_ON_SEND = [:supports].freeze
 
           def_node_matcher :supports_with_constraint?, '(send nil? :supports str $str)'
 

data/lib/rubocop/cop/chef/correctness/tmp_path.rb

@@ -32,6 +32,7 @@ module RuboCop
         #
         class TmpPath < Base
           MSG = 'Use file_cache_path rather than hard-coding tmp paths'
+          RESTRICT_ON_SEND = [:remote_file].freeze
 
           def_node_matcher :remote_file?, <<-PATTERN
             (send nil? :remote_file $str)

data/lib/rubocop/cop/chef/deprecation/ use_automatic_resource_name.rb

@@ -37,10 +37,9 @@ module RuboCop
           include RangeHelp
 
           MSG = 'The use_automatic_resource_name method was removed in Chef Infra Client 16. The resource name/provides should be set explicitly instead.'
+          RESTRICT_ON_SEND = [:use_automatic_resource_name].freeze
 
           def on_send(node)
-            return unless node.method_name == :use_automatic_resource_name
-
             add_offense(node.loc.selector, message: MSG, severity: :warning) do |corrector|
               corrector.remove(range_with_surrounding_space(range: node.loc.expression, side: :left))
             end

data/lib/rubocop/cop/chef/deprecation/cb_depends_on_self.rb

@@ -36,6 +36,7 @@ module RuboCop
           include RangeHelp
 
           MSG = 'A cookbook cannot depend on itself. This will fail on Chef Infra Client 13+'
+          RESTRICT_ON_SEND = [:name].freeze
 
           def_node_search :dependencies, '(send nil? :depends str ...)'
           def_node_matcher :cb_name?, '(send nil? :name str ...)'

data/lib/rubocop/cop/chef/deprecation/chef_handler_recipe.rb

@@ -33,6 +33,7 @@ module RuboCop
           extend AutoCorrector
 
           MSG = 'There is no need to include the empty and deprecated chef_handler::default recipe in order to use the chef_handler resource'
+          RESTRICT_ON_SEND = [:include_recipe].freeze
 
           def_node_matcher :chef_handler_recipe?, <<-PATTERN
             (send nil? :include_recipe (str {"chef_handler" "chef_handler::default"}))

data/lib/rubocop/cop/chef/deprecation/chef_rest.rb

@@ -30,6 +30,7 @@ module RuboCop
         #
         class UsesChefRESTHelpers < Base
           MSG = "Don't use the helpers in Chef::REST which were removed in Chef Infra Client 13"
+          RESTRICT_ON_SEND = [:require].freeze
 
           def_node_matcher :require_rest?, <<-PATTERN
           (send nil? :require ( str "chef/rest"))

data/lib/rubocop/cop/chef/deprecation/chef_rewind.rb

@@ -49,6 +49,7 @@ module RuboCop
           }.freeze
 
           MSG = 'Use delete_resource / edit_resource introduced in Chef Infra Client 12.10 instead of functionality in the deprecated chef-rewind gem'
+          RESTRICT_ON_SEND = [:chef_gem, :require, :rewind, :unwind].freeze
 
           def_node_matcher :rewind_gem_install?, <<-PATTERN
             (send nil? :chef_gem (str "chef-rewind"))

data/lib/rubocop/cop/chef/deprecation/chef_shellout.rb

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+#
+# Copyright:: 2020, Chef Software Inc.
+# Author:: Tim Smith (<tsmith@chef.io>)
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+module RuboCop
+  module Cop
+    module Chef
+      module ChefDeprecations
+        # Don't use deprecated Chef::ShellOut which was removed in Chef Infra Client 13.
+        # Use Mixlib::ShellOut instead, which behaves identically or convert to the shell_out
+        # helper provided in chef-utils.
+        #
+        # @example
+        #
+        #   # bad
+        #   include Chef::ShellOut
+        #   require 'chef/shellout'
+        #   Chef::ShellOut.new('some_command')
+        #
+        #   # good
+        #   include Mixlib::ShellOut
+        #   require 'mixlib/shellout'
+        #   Mixlib::ShellOut.new('some_command')
+        #
+        class ChefShellout < Base
+          include RangeHelp
+          extend AutoCorrector
+
+          MSG = "Don't use deprecated Chef::ShellOut which was removed in Chef Infra Client 13. Use Mixlib::ShellOut instead, which behaves identically."
+          # RESTRICT_ON_SEND = [:new, :require, :include].freeze
+
+          def_node_matcher :include_shellout?, <<-PATTERN
+          (send nil? :include
+            (const
+              (const nil? :Chef) :ShellOut))
+          PATTERN
+
+          def_node_matcher :require_shellout?, <<-PATTERN
+          (send nil? :require (str "chef/shellout"))
+          PATTERN
+
+          def_node_matcher :shellout_new?, <<-PATTERN
+          (send
+            (const
+              (const nil? :Chef) :ShellOut) :new
+              ... )
+          PATTERN
+
+          def on_send(node)
+            include_shellout?(node) do
+              add_offense(node, message: MSG, severity: :warning) do |corrector|
+                corrector.remove(range_with_surrounding_space(range: node.loc.expression, side: :left))
+              end
+            end
+
+            require_shellout?(node) do
+              add_offense(node, message: MSG, severity: :warning) do |corrector|
+                corrector.remove(range_with_surrounding_space(range: node.loc.expression, side: :left))
+              end
+            end
+
+            shellout_new?(node) do
+              add_offense(node, message: MSG, severity: :warning) do |corrector|
+                corrector.replace(node.loc.expression, node.source.gsub('Chef::ShellOut', 'Mixlib::ShellOut'))
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/chef/deprecation/depends_compat_resource.rb

@@ -29,16 +29,17 @@ module RuboCop
         class CookbookDependsOnCompatResource < Base
           include RangeHelp
           extend TargetChefVersion
+          extend AutoCorrector
 
           minimum_target_chef_version '12.19'
 
           MSG = "Don't depend on the deprecated compat_resource cookbook made obsolete by Chef 12.19+"
+          RESTRICT_ON_SEND = [:depends].freeze
 
           def_node_matcher :depends_compat_resource?, <<-PATTERN
             (send nil? :depends (str {"compat_resource"}))
           PATTERN
 
-          extend AutoCorrector
           def on_send(node)
             depends_compat_resource?(node) do
               add_offense(node, message: MSG, severity: :warning) do |corrector|

data/lib/rubocop/cop/chef/deprecation/depends_partial_search.rb

@@ -32,6 +32,7 @@ module RuboCop
           minimum_target_chef_version '13.0'
 
           MSG = "Don't depend on the deprecated partial_search cookbook made obsolete by Chef 13"
+          RESTRICT_ON_SEND = [:depends].freeze
 
           def_node_matcher :depends_partial_search?, <<-PATTERN
             (send nil? :depends (str "partial_search"))

data/lib/rubocop/cop/chef/deprecation/depends_poise.rb

@@ -29,6 +29,7 @@ module RuboCop
         #
         class CookbookDependsOnPoise < Base
           MSG = 'Cookbooks should not depend on the deprecated Poise framework'
+          RESTRICT_ON_SEND = [:depends].freeze
 
           def_node_matcher :depends_method?, <<-PATTERN
             (send nil? :depends $str)

data/lib/rubocop/cop/chef/deprecation/deprecated_mixins.rb

@@ -39,6 +39,7 @@ module RuboCop
           extend AutoCorrector
 
           MSG = "Don't use deprecated Mixins no longer included in Chef Infra Client 14 and later."
+          RESTRICT_ON_SEND = [:include, :require].freeze
 
           def_node_matcher :deprecated_mixin?, <<-PATTERN
             (send nil? :include (const (const (const nil? :Chef) :Mixin) { :Language :LanguageIncludeAttribute :RecipeDefinitionDSLCore :LanguageIncludeRecipe }))

data/lib/rubocop/cop/chef/deprecation/deprecated_platform_methods.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 #
-# Copyright:: 2019, Chef Software Inc.
+# Copyright:: 2019-2020, Chef Software Inc.
 # Author:: Tim Smith (<tsmith@chef.io>)
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -20,7 +20,7 @@ module RuboCop
   module Cop
     module Chef
       module ChefDeprecations
-        # Use provider_for_action instead of the deprecated Chef::Platform methods in resources, which were removed in Chef Infra Client 13.
+        # Use provider_for_action or provides instead of the deprecated Chef::Platform methods in resources, which were removed in Chef Infra Client 13.
         #
         # @example
         #
@@ -34,15 +34,19 @@ module RuboCop
         #   resource = Chef::Resource::File.new("/tmp/foo.xyz", run_context)
         #   provider = Chef::Platform.find_provider_for_node(node, resource)
         #
+        #   Chef::Platform.set :platform => :mac_os_x, :resource => :package, :provider => Chef::Provider::Package::Homebrew
+        #
         #   # good
         #   resource = Chef::Resource::File.new("/tmp/foo.xyz", run_context)
         #   provider = resource.provider_for_action(:create)
         #
+        #   # provides :package, platform_family: 'mac_os_x'
+
         class DeprecatedPlatformMethods < Base
-          MSG = 'Use provider_for_action instead of the deprecated Chef::Platform methods in resources, which were removed in Chef Infra Client 13.'
+          MSG = 'Use provider_for_action or provides instead of the deprecated Chef::Platform methods in resources, which were removed in Chef Infra Client 13.'
 
           def_node_matcher :platform_method?, <<-PATTERN
-            (send (const (const nil? :Chef) :Platform) {:provider_for_resource :find_provider :find_provider_for_node} ... )
+            (send (const (const nil? :Chef) :Platform) {:provider_for_resource :find_provider :find_provider_for_node :set} ... )
           PATTERN
 
           def on_send(node)