cookstyle 6.16.10 → 6.19.5

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

@@ -51,7 +51,7 @@ module RuboCop
           def on_const(node)
             chefspec_runner?(node) do
               add_offense(node, message: MSG, severity: :warning) do |corrector|
-                corrector.replace(node.loc.expression, 'ChefSpec::ServerRunner')
+                corrector.replace(node, 'ChefSpec::ServerRunner')
               end
             end
           end

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

@@ -120,7 +120,7 @@ module RuboCop
               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}'")
+                  corrector.replace(ver, "'#{replacement}'")
                 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,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)

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

@@ -54,7 +54,7 @@ module RuboCop
             %w(url keyurl mirrorexpire).each do |prop|
               match_property_in_resource?(:yum_repository, prop, node) do |prop_node|
                 add_offense(prop_node, message: MSG, severity: :warning)  do |corrector|
-                  corrector.replace(prop_node.loc.expression, prop_node.loc.expression.source
+                  corrector.replace(prop_node, prop_node.source
                     .gsub(/^url/, 'baseurl')
                     .gsub(/^keyurl/, 'gpgkey')
                     .gsub(/^mirrorexpire/, 'mirror_expire'))

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

@@ -42,7 +42,7 @@ module RuboCop
 
           def on_send(node)
             add_offense(node, message: MSG, severity: :warning) do |corrector|
-              corrector.replace(node.loc.expression, 'ignore_failure true')
+              corrector.replace(node, 'ignore_failure true')
             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, 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, message: MSG, severity: :warning)
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -49,7 +49,7 @@ module RuboCop
           def on_class(node)
             inherits_from_compat_resource?(node) do
               add_offense(node, message: MSG, severity: :warning) do |corrector|
-                corrector.replace(node.loc.expression, node.loc.expression.source.gsub('ChefCompat', 'Chef'))
+                corrector.replace(node, node.source.gsub('ChefCompat', 'Chef'))
               end
             end
           end

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

@@ -80,7 +80,7 @@ module RuboCop
                                 end
                 new_val = "#{notify_type} #{action.source}, #{service_value}".dup
                 new_val << ", #{timing.first.source}" unless timing.empty?
-                corrector.replace(node.loc.expression, new_val)
+                corrector.replace(node, new_val)
               end
             end
           end

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

@@ -49,7 +49,7 @@ module RuboCop
           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

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

@@ -47,7 +47,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/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,13 +50,15 @@ 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
 
           private
 
+          VALID_TYPES = %i(send hash block_pass).freeze
+
           #
           # Are the arguments in the passed node object positional
           #
@@ -68,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
@@ -81,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/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_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, 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

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

@@ -52,13 +52,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