cookstyle 6.17.5 → 6.19.11

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

@@ -37,6 +37,8 @@ module RuboCop
         class NodeDeepFetch < Base
           extend RuboCop::Cop::AutoCorrector
 
+          RESTRICT_ON_SEND = [:deep_fetch, :deep_fetch!].freeze
+
           def_node_matcher :node_deep_fetch?, <<-PATTERN
             (send (send _ :node) ${:deep_fetch :deep_fetch!} _)
           PATTERN

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

@@ -41,43 +41,38 @@ module RuboCop
           extend AutoCorrector
 
           MSG = 'Use node attributes to access Ohai data instead of node methods, which were deprecated in Chef Infra Client 13.'
+          RESTRICT_ON_SEND = %i(
+            current_user
+            domain
+            fqdn
+            hostname
+            ip6address
+            ipaddress
+            macaddress
+            machinename
+            ohai_time
+            os
+            os_version
+            platform
+            platform_build
+            platform_family
+            platform_version
+            root_group
+            shard_seed
+            uptime
+            uptime_seconds).freeze
 
           def_node_matcher :node_ohai_methods?, <<-PATTERN
-            (send (send nil? :node) #non_nested_ohai_attribute?)
+            (send (send nil? :node) _)
           PATTERN
 
           def on_send(node)
             node_ohai_methods?(node) do
               add_offense(node.loc.selector, message: MSG, severity: :warning) do |corrector|
-                corrector.replace(node.loc.expression, "node['#{node.method_name}']")
+                corrector.replace(node, "node['#{node.method_name}']")
               end
             end
           end
-
-          private
-
-          def non_nested_ohai_attribute?(attribute)
-            %i(
-              current_user
-              domain
-              fqdn
-              hostname
-              ip6address
-              ipaddress
-              macaddress
-              machinename
-              ohai_time
-              os
-              os_version
-              platform
-              platform_build
-              platform_family
-              platform_version
-              root_group
-              shard_seed
-              uptime
-              uptime_seconds).include?(attribute)
-          end
         end
       end
     end

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

@@ -34,6 +34,7 @@ module RuboCop
           extend AutoCorrector
 
           MSG = 'Do not use node.set. Replace with node.normal to keep identical behavior.'
+          RESTRICT_ON_SEND = [:set].freeze
 
           def_node_matcher :node_set?, <<-PATTERN
             (send (send _ :node) $:set)

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

@@ -34,6 +34,7 @@ module RuboCop
           extend AutoCorrector
 
           MSG = 'Do not use node.set_unless. Replace with node.normal_unless to keep identical behavior.'
+          RESTRICT_ON_SEND = [:set_unless].freeze
 
           def_node_matcher :node_set_unless?, <<-PATTERN
             (send (send _ :node) $:set_unless)

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

@@ -36,6 +36,7 @@ module RuboCop
         #
         class NodeSetWithoutLevel < Base
           MSG = 'When setting a node attribute in Chef Infra Client 11 and later you must specify the precedence level.'
+          RESTRICT_ON_SEND = [:[]=, :<<].freeze
 
           def on_op_asgn(node)
             # make sure it was a += or -=

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

@@ -49,6 +49,7 @@ module RuboCop
         #
         class PartialSearchClassUsage < Base
           MSG = 'Legacy Chef::PartialSearch class usage should be updated to use the search helper instead with the filter_result key.'
+          RESTRICT_ON_SEND = [:new].freeze
 
           def_node_matcher :partial_search_class?, <<-PATTERN
             (send (const (const ... :Chef) :PartialSearch) :new)

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

@@ -36,6 +36,7 @@ module RuboCop
           extend AutoCorrector
 
           MSG = "Use node['powershell']['version'] or the new powershell_version helper available in Chef Infra Client 15.8+ instead of the deprecated PowerShell cookbook helpers."
+          RESTRICT_ON_SEND = [:powershell_version?].freeze
 
           def_node_matcher :ps_cb_helper?, <<-PATTERN
           (send
@@ -47,7 +48,7 @@ module RuboCop
           def on_send(node)
             ps_cb_helper?(node) do |ver|
               add_offense(node, message: MSG, severity: :warning) do |corrector|
-                corrector.replace(node.loc.expression, "node['powershell']['version'].to_f == #{ver.source}")
+                corrector.replace(node, "node['powershell']['version'].to_f == #{ver.source}")
               end
             end
           end

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

@@ -34,12 +34,12 @@ module RuboCop
         class ResourceOverridesProvidesMethod < Base
           MSG = "Don't override the provides? method in a resource provider. Use provides :SOME_PROVIDER_NAME instead. This will cause failures in Chef Infra Client 13 and later."
 
-          def_node_search :provides, '(send nil? :provides ...)'
+          def_node_search :calls_provides?, '(send nil? :provides ...)'
 
           def on_def(node)
             return unless node.method_name == :provides?
 
-            add_offense(node, message: MSG, severity: :warning) if provides(processed_source.ast).count == 0
+            add_offense(node, message: MSG, severity: :warning) unless calls_provides?(processed_source.ast)
           end
         end
       end

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

@@ -45,8 +45,8 @@ module RuboCop
           def on_send(node)
             positional_shellout?(node) do |h|
               next unless h.braces?
-              add_offense(h.loc.expression, message: MSG, severity: :refactor) do |corrector|
-                corrector.replace(h.loc.expression, h.loc.expression.source[1..-2])
+              add_offense(h, message: MSG, severity: :refactor) do |corrector|
+                corrector.replace(h, h.source[1..-2])
               end
             end
           end

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

@@ -50,8 +50,8 @@ module RuboCop
             match_property_in_resource?(:ruby_block, 'action', node) do |ruby_action|
               ruby_action.arguments.each do |action|
                 next unless action.source == ':create'
-                add_offense(action.loc.expression, message: MSG, severity: :warning) do |corrector|
-                  corrector.replace(action.loc.expression, ':run')
+                add_offense(action, message: MSG, severity: :warning) do |corrector|
+                  corrector.replace(action, ':run')
                 end
               end
             end

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

@@ -50,7 +50,7 @@ module RuboCop
           def on_send(node)
             search_method?(node) do
               add_offense(node, message: MSG, severity: :warning) do |corrector|
-                corrector.replace(node.loc.expression, corrected_string(node))
+                corrector.replace(node, corrected_string(node))
               end if positional_arguments?(node)
             end
           end

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

@@ -60,7 +60,7 @@ module RuboCop
                   new_text << "#{key_value} #{v.source}"
                 end
 
-                corrector.replace(property.loc.expression, new_text.join("\n  "))
+                corrector.replace(property, new_text.join("\n  "))
               end
             end
           end

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

@@ -49,7 +49,7 @@ module RuboCop
               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|
+              add_offense(offense, message: MSG, severity: :warning) do |corrector|
                 corrector.replace(offense.arguments.first.source_range, ":#{offense.arguments.first.value}")
               end
             end

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

@@ -67,11 +67,11 @@ module RuboCop
             if ast_obj.respond_to?(:value) && ast_obj.value == :change
               add_offense(ast_obj, message: MSG, severity: :warning) do |corrector|
                 if ast_obj.parent.send_type? # :change was the only action
-                  corrector.replace(ast_obj.loc.expression, ':create')
+                  corrector.replace(ast_obj, ':create')
                 # chances are it's [:create, :change] since that's all that makes sense, but double check that theory
                 elsif ast_obj.parent.child_nodes.count == 2 &&
                       ast_obj.parent.child_nodes.map(&:value).sort == [:change, :create]
-                  corrector.replace(ast_obj.parent.loc.expression, ':create')
+                  corrector.replace(ast_obj.parent, ':create')
                 end
               end
             end

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

@@ -42,6 +42,7 @@ module RuboCop
           minimum_target_chef_version '14.0'
 
           MSG = "Use node['platform_version'] and node['kernel'] data introduced in Chef Infra Client 14 instead of the deprecated Windows::VersionHelper helpers from the Windows cookbook."
+          RESTRICT_ON_SEND = [:nt_version, :server_version?, :core_version?, :workstation_version?].freeze
 
           def_node_matcher :windows_helper?, <<-PATTERN
             (send ( const ( const {nil? cbase} :Windows ) :VersionHelper ) $_ )
@@ -52,13 +53,13 @@ module RuboCop
               add_offense(node, message: MSG, severity: :refactor) do |corrector|
                 case method
                 when :nt_version
-                  corrector.replace(node.loc.expression, 'node[\'platform_version\'].to_f')
+                  corrector.replace(node, 'node[\'platform_version\'].to_f')
                 when :server_version?
-                  corrector.replace(node.loc.expression, 'node[\'kernel\'][\'product_type\'] == \'Server\'')
+                  corrector.replace(node, 'node[\'kernel\'][\'product_type\'] == \'Server\'')
                 when :core_version?
-                  corrector.replace(node.loc.expression, 'node[\'kernel\'][\'server_core\']')
+                  corrector.replace(node, 'node[\'kernel\'][\'server_core\']')
                 when :workstation_version?
-                  corrector.replace(node.loc.expression, 'node[\'kernel\'][\'product_type\'] == \'Workstation\'')
+                  corrector.replace(node, 'node[\'kernel\'][\'product_type\'] == \'Workstation\'')
                 end
               end
             end

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

@@ -40,7 +40,7 @@ module RuboCop
             xml_ruby_recipe?(node) do
               node = node.parent if node.parent&.conditional? && node.parent&.single_line_condition? # make sure we catch any inline conditionals
               add_offense(node, message: MSG, severity: :warning) do |corrector|
-                corrector.remove(node.loc.expression)
+                corrector.remove(node)
               end
             end
           end

data/lib/rubocop/cop/chef/effortless/chef_vault_used.rb

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+#
+# Copyright:: 2020, Chef Software Inc.
+# Author:: Scott Vidmar (<svidmar@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 ChefEffortless
+        # Chef Vault is not supported in the Effortless pattern, so usage of Chef Vault must be shifted to another secrets management solution before leveraging the Effortless pattern.
+        #
+        # @example
+        #
+        #   # bad
+        #   require 'chef-vault'
+        #
+        #   # bad
+        #   ChefVault::Item
+        #
+        #   # bad
+        #   include_recipe 'chef-vault'
+        #
+        #   # bad
+        #   chef_gem 'chef-vault'
+        #
+        #   # bad
+        #   chef_vault_item_for_environment(arg, arg1)
+        #
+        #   # bad
+        #   chef_vault_item(arg, arg1)
+        #
+
+        class ChefVaultUsed < Base
+          MSG = 'Chef Vault usage is not supported in the Effortless pattern'
+          RESTRICT_ON_SEND = [:chef_vault_item,
+                              :chef_vault_item_for_environment,
+                              :include_recipe,
+                              :require,
+                              :chef_gem].freeze
+
+          def_node_matcher :require?, <<-PATTERN
+            (send nil? { :require :include_recipe :chef_gem }
+              (str "chef-vault"))
+          PATTERN
+
+          def_node_matcher :vault_const?, <<-PATTERN
+            (const
+              (const nil? :ChefVault)
+              :Item)
+          PATTERN
+
+          def_node_matcher :chef_vault_item_for_environment?, <<-PATTERN
+            (send nil? :chef_vault_item_for_environment _ _)
+          PATTERN
+
+          def_node_matcher :chef_vault_item?, <<-PATTERN
+            (send nil? :chef_vault_item _ _)
+          PATTERN
+
+          def on_send(node)
+            return unless require?(node) ||
+                          chef_vault_item_for_environment?(node) ||
+                          chef_vault_item?(node)
+            add_offense(node.loc.expression, message: MSG, severity: :refactor)
+          end
+
+          def on_const(node)
+            vault_const?(node) do
+              add_offense(node.loc.expression, message: MSG, severity: :refactor)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/chef/effortless/depends_chef_vault.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+#
+# Copyright:: 2020, Chef Software Inc.
+# Author:: Scott Vidmar (<svidmar@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 ChefEffortless
+        # Chef Vault is not supported in the Effortless pattern, so usage of Chef Vault must be shifted to another secrets management solution before leveraging the Effortless pattern.
+        #
+        # @example
+        #
+        #   # bad
+        #   depends 'chef-vault'
+        #
+
+        class DependsChefVault < Base
+          MSG = 'Chef Vault usage is not supported in the Effortless pattern'
+          RESTRICT_ON_SEND = [:depends].freeze
+
+          def_node_matcher :depends?, <<-PATTERN
+            (send nil? :depends
+              (str "chef-vault"))
+          PATTERN
+
+          def on_send(node)
+            depends?(node) do
+              add_offense(node.loc.expression, message: MSG, severity: :refactor)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/chef/modernize/action_method_in_resource.rb

@@ -45,9 +45,9 @@ module RuboCop
             return if node.arguments? # if they passed in arguments they may actually need this
             return if node.parent && includes_poise?(node.parent)
 
-            add_offense(node.loc.expression, message: MSG, severity: :refactor) do |corrector|
+            add_offense(node, message: MSG, severity: :refactor) do |corrector|
               # @todo when we drop ruby 2.4 support we can convert this to use delete_suffix
-              corrector.replace(node.loc.expression, node.source.gsub("def #{node.method_name}", "action :#{node.method_name.to_s.gsub(/^action_/, '')} do"))
+              corrector.replace(node, node.source.gsub("def #{node.method_name}", "action :#{node.method_name.to_s.gsub(/^action_/, '')} do"))
             end
           end
         end

data/lib/rubocop/cop/chef/modernize/berksfile_source.rb

@@ -55,13 +55,13 @@ module RuboCop
           def on_send(node)
             berksfile_source?(node) do
               add_offense(node, message: MSG, severity: :refactor) do |corrector|
-                corrector.replace(node.loc.expression, "source 'https://supermarket.chef.io'")
+                corrector.replace(node, "source 'https://supermarket.chef.io'")
               end
             end
 
             berksfile_site?(node) do
               add_offense(node, message: MSG, severity: :refactor) do |corrector|
-                corrector.replace(node.loc.expression, "source 'https://supermarket.chef.io'")
+                corrector.replace(node, "source 'https://supermarket.chef.io'")
               end
             end
           end

data/lib/rubocop/cop/chef/modernize/build_essential.rb

@@ -44,7 +44,7 @@ module RuboCop
           def on_send(node)
             build_essential_recipe_usage?(node) do
               add_offense(node, message: MSG, severity: :refactor) do |corrector|
-                corrector.replace(node.loc.expression, "build_essential 'install compilation tools'")
+                corrector.replace(node, "build_essential 'install compilation tools'")
               end
             end
           end

data/lib/rubocop/cop/chef/modernize/compile_time_resources.rb

@@ -35,6 +35,7 @@ module RuboCop
         #
         class ResourceForcingCompileTime < Base
           MSG = "Set 'compile_time true' in resources when available instead of forcing resources to run at compile time by setting an action on the block."
+          RESTRICT_ON_SEND = [:run_action].freeze
 
           def_node_matcher :compile_time_resource?, <<-PATTERN
             (send (block (send nil? {:build_essential :chef_gem :hostname :ohai_hint} (...)) (args) (...)) $:run_action (sym ...))

data/lib/rubocop/cop/chef/modernize/conditional_using_test.rb

@@ -36,7 +36,7 @@ module RuboCop
           RESTRICT_ON_SEND = [:not_if, :only_if].freeze
 
           def_node_matcher :resource_conditional?, <<~PATTERN
-          (send nil? {:not_if :only_if} $str )
+            (send nil? {:not_if :only_if} $str )
           PATTERN
 
           def on_send(node)
@@ -44,7 +44,7 @@ module RuboCop
               return unless conditional.value.match?(/^test -[ef] \S*$/)
               add_offense(node, message: MSG, severity: :refactor) do |corrector|
                 new_string = "{ ::File.exist?('#{conditional.value.match(/^test -[ef] (\S*)$/)[1]}') }"
-                corrector.replace(conditional.loc.expression, new_string)
+                corrector.replace(conditional, new_string)
               end
             end
           end