cookstyle 6.16.4 → 6.17.6

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

@@ -44,20 +44,19 @@ module RuboCop
 
           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, 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

@@ -30,9 +30,10 @@ module RuboCop
         #
         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, 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/easy_install.rb

@@ -31,9 +31,10 @@ module RuboCop
         #
         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, 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

@@ -34,6 +34,7 @@ module RuboCop
 
         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 ...)'
 

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

@@ -38,9 +38,9 @@ module RuboCop
           extend AutoCorrector
 
           MSG = 'Use ignore_failure method instead of the deprecated epic_fail method'
+          RESTRICT_ON_SEND = [:epic_fail].freeze
 
           def on_send(node)
-            return unless node.method_name == :epic_fail
             add_offense(node, message: MSG, severity: :warning) do |corrector|
               corrector.replace(node.loc.expression, 'ignore_failure true')
             end

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

@@ -31,9 +31,10 @@ module RuboCop
         #
         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, 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/legacy_notify_syntax.rb

@@ -61,6 +61,7 @@ module RuboCop
           extend AutoCorrector
 
           MSG = 'Use the new-style notification syntax which allows you to notify resources defined later in a recipe or resource.'
+          RESTRICT_ON_SEND = [:notifies, :subscribes].freeze
 
           def_node_matcher :legacy_notify?, <<-PATTERN
             (send nil? ${:notifies :subscribes} $(sym _) (send nil? :resources (hash (pair $(sym _) $(...) ) ) ) $... )

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

@@ -35,6 +35,7 @@ module RuboCop
         #
         class LegacyYumCookbookRecipes < Base
           MSG = 'The elrepo, epel, ius, remi, and repoforge recipes were split into their own cookbooks and the yum recipe was renamed to be default with the release of yum cookbook 3.0 (Dec 2013).'
+          RESTRICT_ON_SEND = [:include_recipe].freeze
 
           def_node_matcher :old_yum_recipe?, <<-PATTERN
             (send nil? :include_recipe (str {"yum::elrepo" "yum::epel" "yum::ius" "yum::remi" "yum::repoforge" "yum::yum"}))

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

@@ -36,6 +36,7 @@ module RuboCop
           extend AutoCorrector
 
           MSG = "A resource property can't be marked as a name_property and also have a default value. This will fail in Chef Infra Client 13 or later."
+          RESTRICT_ON_SEND = [:attribute, :property].freeze
 
           # match on a property or attribute that has any name and any type and a hash that
           # contains name_property/name_attribute true and any default value. These are wrapped in

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

@@ -49,9 +49,10 @@ module RuboCop
         #
         class PartialSearchHelperUsage < Base
           MSG = 'Legacy partial_search usage should be updated to use :filter_result in the search helper instead'
+          RESTRICT_ON_SEND = [:partial_search].freeze
 
           def on_send(node)
-            add_offense(node, message: MSG, severity: :warning) if node.method_name == :partial_search
+            add_offense(node, message: MSG, severity: :warning)
           end
         end
       end

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

@@ -39,6 +39,7 @@ module RuboCop
           minimum_target_chef_version '15.0'
 
           MSG = 'The poise_archive resource in the deprecated poise-archive should be replaced with the archive_file resource found in Chef Infra Client 15+'
+          RESTRICT_ON_SEND = [:depends].freeze
 
           def_node_matcher :depends_poise_archive?, <<-PATTERN
             (send nil? :depends (str "poise-archive"))

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

@@ -34,6 +34,7 @@ module RuboCop
           extend AutoCorrector
 
           MSG = 'Use include_recipe instead of the require_recipe method'
+          RESTRICT_ON_SEND = [:require_recipe].freeze
 
           def_node_matcher :require_recipe?, <<-PATTERN
             (send nil? :require_recipe $str)

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

@@ -37,9 +37,9 @@ module RuboCop
           def_node_search :provides, '(send nil? :provides ...)'
 
           def on_def(node)
-            if node.method_name == :provides?
-              add_offense(node, message: MSG, severity: :warning) if provides(processed_source.ast).count == 0
-            end
+            return unless node.method_name == :provides?
+
+            add_offense(node, message: MSG, severity: :warning) if provides(processed_source.ast).count == 0
           end
         end
       end

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

@@ -31,9 +31,10 @@ module RuboCop
         #
         class ResourceUsesDslNameMethod < Base
           MSG = 'Use resource_name instead of the dsl_name method in resources. This will cause failures in Chef Infra Client 13 and later.'
+          RESTRICT_ON_SEND = [:dsl_name].freeze
 
           def on_send(node)
-            add_offense(node, message: MSG, severity: :warning) if node.method_name == :dsl_name
+            add_offense(node, message: MSG, severity: :warning)
           end
 
           # potential autocorrect is new_resource.updated_by_last_action true, but we need to actually see what class we were called from

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

@@ -33,6 +33,7 @@ module RuboCop
           extend AutoCorrector
 
           MSG = 'Starting with Chef Infra Client 16, using `resource_name` without also using `provides` will result in resource failures. Make sure to use both `resource_name` and `provides` to change the name of the resource. You can also omit `resource_name` entirely if the value set matches the name Chef Infra Client automatically assigns based on COOKBOOKNAME_FILENAME.'
+          RESTRICT_ON_SEND = [:resource_name].freeze
 
           def_node_matcher :resource_name?, '(send nil? :resource_name (sym $_ ))'
 

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

@@ -28,9 +28,10 @@ module RuboCop
         #
         class ResourceUsesProviderBaseMethod < Base
           MSG = "Don't use the deprecated provider_base method in a resource to specify the provider module to use. Instead, the provider should call provides to register itself, or the resource should call provider to specify the provider to use. This will cause failures in Chef Infra Client 13 and later."
+          RESTRICT_ON_SEND = [:provider_base].freeze
 
           def on_send(node)
-            add_offense(node, message: MSG, severity: :warning) if node.method_name == :provider_base
+            add_offense(node, message: MSG, severity: :warning)
           end
         end
       end

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

@@ -36,6 +36,7 @@ module RuboCop
           extend RuboCop::Cop::AutoCorrector
 
           MSG = 'Pass options to shell_out helpers without the brackets to avoid Ruby 2.7 deprecation warnings.'
+          RESTRICT_ON_SEND = [:shell_out!, :shell_out].freeze
 
           def_node_matcher :positional_shellout?, <<-PATTERN
             (send nil? {:shell_out :shell_out!} ... $(hash ... ))

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

@@ -35,6 +35,7 @@ module RuboCop
         #
         class UsesRunCommandHelper < Base
           MSG = "Use 'shell_out!' instead of the legacy 'run_command' or 'run_command_with_systems_locale' helpers for shelling out. The run_command helper was removed in Chef Infra Client 13."
+          RESTRICT_ON_SEND = [:require, :run_command, :run_command_with_systems_locale, :include].freeze
 
           def_node_matcher :calls_run_command?, '(send nil? {:run_command :run_command_with_systems_locale} ...)'
           def_node_matcher :require_mixin_command?, '(send nil? :require (str "chef/mixin/command"))'

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

@@ -39,6 +39,7 @@ module RuboCop
           extend AutoCorrector
 
           MSG = "Don't use deprecated positional parameters in cookbook search queries."
+          RESTRICT_ON_SEND = [:search].freeze
 
           NAMED_PARAM_LOOKUP_TABLE = [nil, nil, 'start', 'rows', 'filter_result'].freeze
 
@@ -56,6 +57,8 @@ module RuboCop
 
           private
 
+          VALID_TYPES = %i(send hash block_pass).freeze
+
           #
           # Are the arguments in the passed node object positional
           #
@@ -67,7 +70,7 @@ module RuboCop
             return false if node.arguments.count < 3
             node.arguments[2..-1].each do |arg|
               # hashes, blocks, or variable/methods are valid. Anything else is not
-              return true unless %i(send hash block_pass).include?(arg.type)
+              return true unless VALID_TYPES.include?(arg.type)
             end
             false
           end
@@ -80,7 +83,7 @@ module RuboCop
           # @return [String]
           #
           def corrected_string(node)
-            args = node.arguments
+            args = node.arguments.dup
 
             # If the 2nd argument is a String and not an Integer as a String
             # then it's the old sort field and we need to delete it. Same thing

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

@@ -34,21 +34,20 @@ module RuboCop
           extend AutoCorrector
 
           MSG = 'use_inline_resources is now the default for resources in Chef Infra Client 13+ and does not need to be specified.'
+          RESTRICT_ON_SEND = [:use_inline_resources].freeze
 
           def on_send(node)
-            if node.method_name == :use_inline_resources
-              # don't alert on the use_inline_resources within the defined? check
-              # that would result in 2 alerts on the same line and wouldn't be useful
-              return if node.parent && node.parent.defined_type?
+            # don't alert on the use_inline_resources within the defined? check
+            # that would result in 2 alerts on the same line and wouldn't be useful
+            return if node.parent && node.parent.defined_type?
 
-              # catch the full offense if the method is gated like this: use_inline_resources if defined?(use_inline_resources)
-              if node.parent && node.parent.if_type? && %i(defined? respond_to?).include?(node.parent.children.first.method_name)
-                node = node.parent
-              end
+            # catch the full offense if the method is gated like this: use_inline_resources if defined?(use_inline_resources)
+            if node.parent && node.parent.if_type? && %i(defined? respond_to?).include?(node.parent.children.first.method_name)
+              node = node.parent
+            end
 
-              add_offense(node, message: MSG, severity: :warning) do |corrector|
-                corrector.remove(range_with_surrounding_space(range: node.loc.expression, side: :left))
-              end
+            add_offense(node, message: MSG, severity: :warning) do |corrector|
+              corrector.remove(range_with_surrounding_space(range: node.loc.expression, side: :left))
             end
           end
         end

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

@@ -48,7 +48,7 @@ module RuboCop
 
           def on_block(node)
             match_property_in_resource?(:windows_feature, :install_method, node) do |prop_node|
-              add_offense(prop_node, message: MSG, severity: :warning) if prop_node.source.match?(/:servermanagercmd/)
+              add_offense(prop_node, message: MSG, severity: :warning) if prop_node.source.include?(':servermanagercmd')
             end
           end
         end

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

@@ -0,0 +1,61 @@
+# 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 the `windows_package` resource's `installer_type` property must be a symbol.
+        #
+        # @example
+        #
+        #   # bad
+        #   windows_package 'AppveyorDeploymentAgent' do
+        #     source 'https://www.example.com/appveyor.msi'
+        #     installer_type 'msi'
+        #     options "/quiet /qn /norestart /log install.log"
+        #   end
+        #
+        #   # good
+        #   windows_package 'AppveyorDeploymentAgent' do
+        #     source 'https://www.example.com/appveyor.msi'
+        #     installer_type :msi
+        #     options "/quiet /qn /norestart /log install.log"
+        #   end
+        #
+        class WindowsPackageInstallerTypeString < Base
+          include RuboCop::Chef::CookbookHelpers
+          extend AutoCorrector
+
+          MSG = "In Chef Infra Client 13 and later the `windows_package` resource's `installer_type` property must be a symbol."
+
+          def on_block(node)
+            match_property_in_resource?(:windows_package, 'installer_type', node) do |offense|
+              return unless offense.arguments.count == 1 # we can only analyze simple string args
+              return unless offense.arguments.first.str_type? # anything else is fine
+
+              add_offense(offense.loc.expression, message: MSG, severity: :warning) do |corrector|
+                corrector.replace(offense.arguments.first.source_range, ":#{offense.arguments.first.value}")
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end