cookstyle 6.15.9 → 6.17.5

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

@@ -27,8 +27,9 @@ module RuboCop
         #   depends 'poise'
         #   depends 'poise-service'
         #
-        class CookbookDependsOnPoise < Cop
+        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)
@@ -36,7 +37,7 @@ module RuboCop
 
           def on_send(node)
             depends_method?(node) do |arg|
-              add_offense(node, location: :expression, message: MSG, severity: :warning) if %w(poise poise-service).include?(arg.value)
+              add_offense(node, message: MSG, severity: :warning) if %w(poise poise-service).include?(arg.value)
             end
           end
         end

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

@@ -26,8 +26,9 @@ module RuboCop
         #
         #   let(:chef_run) { ChefSpec::ServerRunner.new(platform: 'ubuntu', version: '14.04') }
         #
-        class DeprecatedChefSpecPlatform < Cop
+        class DeprecatedChefSpecPlatform < Base
           include RuboCop::Chef::CookbookHelpers
+          extend AutoCorrector
 
           MSG = "Use currently supported platforms in ChefSpec listed at https://github.com/chefspec/fauxhai/blob/master/PLATFORMS.md. Fauxhai / ChefSpec will perform fuzzy matching on platform version so it's always best to be less specific ie. 10 instead of 10.3"
 
@@ -116,14 +117,9 @@ module RuboCop
 
           def on_send(node)
             chefspec_definition?(node) do |plat, ver|
-              add_offense(node, location: :expression, message: MSG, severity: :warning) if legacy_chefspec_platform(plat.value, ver.value)
-            end
-          end
-
-          def autocorrect(node)
-            chefspec_definition?(node) do |plat, ver|
-              if replacement = replacement_string(plat.value, ver.value) # rubocop: disable Lint/AssignmentInCondition
-                lambda do |corrector|
+              next unless legacy_chefspec_platform(plat.value, ver.value)
+              add_offense(node, message: MSG, severity: :warning) do |corrector|
+                if replacement = replacement_string(plat.value, ver.value) # rubocop: disable Lint/AssignmentInCondition
                   corrector.replace(ver.loc.expression, "'#{replacement}'")
                 end
               end

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

@@ -34,10 +34,12 @@ module RuboCop
         #   require 'chef/mixin/language_include_attribute'
         #   require 'chef/mixin/language_include_recipe'
         #
-        class UsesDeprecatedMixins < Cop
+        class UsesDeprecatedMixins < Base
           include RangeHelp
+          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 }))
@@ -53,21 +55,21 @@ module RuboCop
 
           def on_send(node)
             deprecated_mixin?(node) do
-              add_offense(node, location: :expression, message: MSG, severity: :warning)
+              add_offense(node, message: MSG, severity: :warning) do |corrector|
+                corrector.remove(range_with_surrounding_space(range: node.loc.expression, side: :left))
+              end
             end
 
             deprecated_dsl?(node) do
-              add_offense(node, location: :expression, message: MSG, severity: :warning)
+              add_offense(node, message: MSG, severity: :warning) do |corrector|
+                corrector.remove(range_with_surrounding_space(range: node.loc.expression, side: :left))
+              end
             end
 
             dsl_mixin_require?(node) do
-              add_offense(node, location: :expression, message: MSG, severity: :warning)
-            end
-          end
-
-          def autocorrect(node)
-            lambda do |corrector|
-              corrector.remove(range_with_surrounding_space(range: node.loc.expression, side: :left))
+              add_offense(node, message: MSG, severity: :warning) do |corrector|
+                corrector.remove(range_with_surrounding_space(range: node.loc.expression, side: :left))
+              end
             end
           end
         end

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,20 +34,24 @@ 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)
         #
-        class DeprecatedPlatformMethods < Cop
-          MSG = 'Use provider_for_action instead of the deprecated Chef::Platform methods in resources, which were removed in Chef Infra Client 13.'
+        #   # provides :package, platform_family: 'mac_os_x'
+
+        class DeprecatedPlatformMethods < Base
+          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)
             platform_method?(node) do
-              add_offense(node, location: :expression, message: MSG, severity: :warning)
+              add_offense(node, message: MSG, severity: :warning)
             end
           end
         end

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

@@ -39,25 +39,24 @@ module RuboCop
         #   shell_out!('foo')
         #   shell_out!('foo', default_env: false) # replaces shell_out_with_systems_locale
         #
-        class DeprecatedShelloutMethods < Cop
+        class DeprecatedShelloutMethods < Base
           extend TargetChefVersion
 
           minimum_target_chef_version '14.3'
 
-          DEPRECATED_SHELLOUT_METHODS = %i( shell_out_compact
-                                            shell_out_compact!
-                                            shell_out_compact_timeout
-                                            shell_out_compact_timeout!
-                                            shell_out_with_timeout
-                                            shell_out_with_timeout!
-                                            shell_out_with_systems_locale
-                                            shell_out_with_systems_locale!
-                                          ).freeze
-
           MSG = 'Many legacy specialized shell_out methods were replaced in Chef Infra Client 14.3 and removed in Chef Infra Client 15. Use shell_out and any additional options if necessary.'
+          RESTRICT_ON_SEND = %i( shell_out_compact
+          shell_out_compact!
+          shell_out_compact_timeout
+          shell_out_compact_timeout!
+          shell_out_with_timeout
+          shell_out_with_timeout!
+          shell_out_with_systems_locale
+          shell_out_with_systems_locale!
+        ).freeze
 
           def on_send(node)
-            add_offense(node, location: :expression, message: MSG, severity: :warning) if DEPRECATED_SHELLOUT_METHODS.include?(node.method_name)
+            add_offense(node, message: MSG, severity: :warning)
           end
         end
       end

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

@@ -28,11 +28,12 @@ module RuboCop
         #     # do some legacy things
         #   end
         #
-        class DeprecatedWindowsVersionCheck < Cop
+        class DeprecatedWindowsVersionCheck < Base
           MSG = "Don't use the deprecated older_than_win_2012_or_8? helper. Windows versions before 2012 and 8 are now end of life and this helper will always return false."
+          RESTRICT_ON_SEND = [:older_than_win_2012_or_8?].freeze
 
           def on_send(node)
-            add_offense(node, location: :expression, message: MSG, severity: :warning) if node.method_name == :older_than_win_2012_or_8?
+            add_offense(node, message: MSG, severity: :warning)
           end
         end
       end

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

@@ -41,9 +41,10 @@ module RuboCop
         #     action :create
         #   end
         #
-        class DeprecatedYumRepositoryProperties < Cop
+        class DeprecatedYumRepositoryProperties < Base
           include RuboCop::Chef::CookbookHelpers
           extend TargetChefVersion
+          extend AutoCorrector
 
           minimum_target_chef_version '12.14'
 
@@ -52,16 +53,15 @@ module RuboCop
           def on_block(node)
             %w(url keyurl mirrorexpire).each do |prop|
               match_property_in_resource?(:yum_repository, prop, node) do |prop_node|
-                add_offense(prop_node, location: :expression, message: MSG, severity: :warning)
+                add_offense(prop_node, message: MSG, severity: :warning)  do |corrector|
+                  corrector.replace(prop_node.loc.expression, prop_node.loc.expression.source
+                    .gsub(/^url/, 'baseurl')
+                    .gsub(/^keyurl/, 'gpgkey')
+                    .gsub(/^mirrorexpire/, 'mirror_expire'))
+                end
               end
             end
           end
-
-          def autocorrect(node)
-            lambda do |corrector|
-              corrector.replace(node.loc.expression, node.loc.expression.source.gsub(/^url/, 'baseurl').gsub(/^keyurl/, 'gpgkey').gsub(/^mirrorexpire/, 'mirror_expire'))
-            end
-          end
         end
       end
     end

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

@@ -29,11 +29,12 @@ module RuboCop
         #     bar
         #   end
         #
-        class EasyInstallResource < Cop
+        class EasyInstallResource < Base
           MSG = "Don't use the deprecated easy_install resource removed in Chef Infra Client 13"
+          RESTRICT_ON_SEND = [:easy_install].freeze
 
           def on_send(node)
-            add_offense(node, location: :expression, message: MSG, severity: :warning) if node.method_name == :easy_install
+            add_offense(node, message: MSG, severity: :warning)
           end
         end
       end

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

@@ -32,14 +32,15 @@ module RuboCop
         #     end
         #   end
 
-        class EOLAuditModeUsage < Cop
+        class EOLAuditModeUsage < Base
           MSG = 'The beta Audit Mode feature in Chef Infra Client was removed in Chef Infra Client 15.0. Users should instead use InSpec and the audit cookbook. See https://www.inspec.io/ for more information.'
+          RESTRICT_ON_SEND = [:control_group].freeze
 
           def_node_matcher :control_group?, '(send nil? :control_group ...)'
 
           def on_send(node)
             control_group?(node) do
-              add_offense(node, location: :selector, message: MSG, severity: :warning)
+              add_offense(node.loc.selector, message: MSG, severity: :warning)
             end
           end
         end

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

@@ -34,15 +34,14 @@ module RuboCop
         #     ignore_failure true
         #   end
         #
-        class EpicFail < Cop
+        class EpicFail < Base
+          extend AutoCorrector
+
           MSG = 'Use ignore_failure method instead of the deprecated epic_fail method'
+          RESTRICT_ON_SEND = [:epic_fail].freeze
 
           def on_send(node)
-            add_offense(node, location: :expression, message: MSG, severity: :warning) if node.method_name == :epic_fail
-          end
-
-          def autocorrect(node)
-            lambda do |corrector|
+            add_offense(node, message: MSG, severity: :warning) do |corrector|
               corrector.replace(node.loc.expression, 'ignore_failure true')
             end
           end

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

@@ -29,11 +29,12 @@ module RuboCop
         #     bar
         #   end
         #
-        class ErlCallResource < Cop
+        class ErlCallResource < Base
           MSG = "Don't use the deprecated erl_call resource removed in Chef Infra Client 13"
+          RESTRICT_ON_SEND = [:erl_call].freeze
 
           def on_send(node)
-            add_offense(node, location: :expression, message: MSG, severity: :warning) if node.method_name == :erl_call
+            add_offense(node, message: MSG, severity: :warning)
           end
         end
       end

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

@@ -0,0 +1,51 @@
+# 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
+        # 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.
+        #
+        # @example
+        #
+        #   # bad
+        #   execute 'some_cmd' do
+        #     path '/foo/bar'
+        #   end
+        #
+        #   # good
+        #   execute 'some_cmd' do
+        #     environment {path: '/foo/bar'}
+        #   end
+        #
+        class ExecutePathProperty < Base
+          include RuboCop::Chef::CookbookHelpers
+
+          MSG = '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.'
+
+          def on_block(node)
+            match_property_in_resource?(:execute, 'path', node) do |offense|
+              add_offense(offense.loc.expression, message: MSG, severity: :warning) # @todo: we could probably autocorrect this with some work
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,67 @@
+# 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
+        # In Chef Infra Client 13 and later you must either specific an absolute path when using the `execute` resource's `creates` property or also use the `cwd` property.
+        #
+        # @example
+        #
+        #   # bad
+        #   execute 'some_cmd' do
+        #     creates 'something'
+        #   end
+        #
+        #   # good
+        #   execute 'some_cmd' do
+        #     creates '/tmp/something'
+        #   end
+        #
+        #   execute 'some_cmd' do
+        #     creates 'something'
+        #     cwd '/tmp/'
+        #   end
+        #
+        class ExecuteRelativeCreatesWithoutCwd < Base
+          include RuboCop::Chef::CookbookHelpers
+
+          MSG = "In Chef Infra Client 13 and later you must either specific an absolute path when using the `execute` resource's `creates` property or also use the `cwd` property."
+
+          def on_block(node)
+            match_property_in_resource?(:execute, 'creates', node) do |offense|
+              return unless offense.arguments.count == 1 # we can only analyze simple string args
+              return unless offense.arguments.first.str_type? # we can only analyze simple string args
+
+              # skip any creates that are abs paths https://rubular.com/r/3TbDsgcAa1EaIF
+              return if offense.arguments.first.value.match?(%r{^(/|[a-zA-Z]:)})
+
+              # return if we have a cwd property
+              match_property_in_resource?(:execute, 'cwd', node) do
+                return
+              end
+
+              add_offense(offense.loc.expression, message: MSG, severity: :warning)
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -82,7 +82,9 @@ module RuboCop
         #  # better
         #  Convert your legacy HWRPs to custom resources
         #
-        class HWRPWithoutProvides < Cop
+        class HWRPWithoutProvides < Base
+          extend AutoCorrector
+
           MSG = 'In Chef Infra Client 16 and later a legacy HWRP resource must use `provides` to define how the resource is called in recipes or other resources. To maintain compatibility with Chef Infra Client < 16 use both `resource_name` and `provides`.'
 
           def_node_matcher :HWRP?, <<-PATTERN
@@ -102,8 +104,15 @@ module RuboCop
           def_node_search :resource_name, '(send nil? :resource_name (sym $_))'
 
           def on_class(node)
+            return if has_provides?
             HWRP?(node) do |inherit|
-              add_offense(inherit, location: :expression, message: MSG, severity: :warning) unless has_provides?
+              add_offense(inherit, message: MSG, severity: :warning) do |corrector|
+                resource_name_ast(node) do |ast_match|
+                  # build a new string to add after that includes the new line and the proper indentation
+                  new_string = "\n" + ast_match.source.dup.gsub('resource_name', 'provides').prepend(' ' * indentation(ast_match))
+                  corrector.insert_after(ast_match.source_range, new_string)
+                end
+              end
             end
           end
 
@@ -125,16 +134,6 @@ module RuboCop
           def indentation(node)
             node.source_range.source_line =~ /\S/
           end
-
-          def autocorrect(node)
-            lambda do |corrector|
-              resource_name_ast(node) do |ast_match|
-                # build a new string to add after that includes the new line and the proper indentation
-                new_string = "\n" + ast_match.source.dup.gsub('resource_name', 'provides').prepend(' ' * indentation(ast_match))
-                corrector.insert_after(ast_match.source_range, new_string)
-              end
-            end
-          end
         end
       end
     end