cookstyle 5.23.0 → 6.0.19

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

@@ -45,7 +45,7 @@ module RuboCop
 
           def on_send(node)
             search_method?(node) do
-              add_offense(node, location: :expression, message: MSG, severity: :refactor) if positional_arguments?(node)
+              add_offense(node, location: :expression, message: MSG, severity: :warning) if positional_arguments?(node)
             end
           end
 

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

@@ -43,7 +43,7 @@ module RuboCop
               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, location: :expression, message: MSG, severity: :refactor)
+              add_offense(node, location: :expression, message: MSG, severity: :warning)
             end
           end
 

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

@@ -47,7 +47,7 @@ module RuboCop
 
           def on_block(node)
             match_property_in_resource?(:user, 'supports', node) do |property|
-              add_offense(property, location: :expression, message: MSG, severity: :refactor)
+              add_offense(property, location: :expression, message: MSG, severity: :warning)
             end
           end
 

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

@@ -34,15 +34,12 @@ module RuboCop
         #
         class VerifyPropertyUsesFileExpansion < Cop
           include RuboCop::Chef::CookbookHelpers
-          extend TargetChefVersion
-
-          minimum_target_chef_version '12.5'
 
           MSG = "Use the 'path' variable in the verify property and not the 'file' variable which was removed in Chef Infra Client 13.".freeze
 
           def on_block(node)
             match_property_in_resource?(nil, 'verify', node) do |verify|
-              add_offense(verify, location: :expression, message: MSG, severity: :refactor) if verify.source.match?(/%{file}/)
+              add_offense(verify, location: :expression, message: MSG, severity: :warning) if verify.source.match?(/%{file}/)
             end
           end
 

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

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

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

@@ -41,9 +41,6 @@ module RuboCop
         #
         class WindowsTaskChangeAction < Cop
           include RuboCop::Chef::CookbookHelpers
-          extend TargetChefVersion
-
-          minimum_target_chef_version '13.0'
 
           MSG = 'The :change action in the windows_task resource was removed when windows_task was added to Chef Infra Client 13+. The default action of :create should can now be used to create an update tasks.'.freeze
 
@@ -77,7 +74,7 @@ module RuboCop
 
           def check_action(ast_obj)
             if ast_obj.respond_to?(:value) && ast_obj.value == :change
-              add_offense(ast_obj, location: :expression, message: MSG, severity: :refactor)
+              add_offense(ast_obj, location: :expression, message: MSG, severity: :warning)
             end
           end
         end

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

@@ -35,7 +35,7 @@ module RuboCop
 
           def on_send(node)
             xml_ruby_recipe?(node) do
-              add_offense(node, location: :expression, message: MSG, severity: :refactor)
+              add_offense(node, location: :expression, message: MSG, severity: :warning)
             end
           end
 

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

@@ -38,7 +38,7 @@ module RuboCop
           def on_send(node)
             yum_dnf_compat_recipe_usage?(node) do
               node = node.parent if node.parent&.conditional? && node.parent&.single_line?
-              add_offense(node, location: :expression, message: MSG, severity: :refactor)
+              add_offense(node, location: :expression, message: MSG, severity: :warning)
             end
           end
 

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

@@ -0,0 +1,58 @@
+#
+# 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 ChefModernize
+        # Use the `data_bag_item` helper instead of `Chef::DataBagItem.load` or `Chef::EncryptedDataBagItem.load`.
+        #
+        # @example
+        #
+        #   # bad
+        #   plain_text_data = Chef::DataBagItem.load('foo', 'bar')
+        #   encrypted_data = Chef::EncryptedDataBagItem.load('foo2', 'bar2')
+        #
+        #   # good
+        #   plain_text_data = data_bag_item('foo', 'bar')
+        #   encrypted_data = data_bag_item('foo2', 'bar2')
+        #
+        class DatabagHelpers < Cop
+          MSG = 'Use the `data_bag_item` helper instead of `Chef::DataBagItem.load` or `Chef::EncryptedDataBagItem.load`.'.freeze
+
+          def_node_matcher :data_bag_class_load?, <<-PATTERN
+          (send
+            (const
+              (const nil? :Chef) {:DataBagItem :EncryptedDataBagItem}) :load
+              ...)
+          PATTERN
+
+          def on_send(node)
+            data_bag_class_load?(node) do
+              add_offense(node, location: :expression, message: MSG, severity: :refactor)
+            end
+          end
+
+          def autocorrect(node)
+            lambda do |corrector|
+              corrector.replace(node.loc.expression, node.source.gsub(/Chef::(EncryptedDataBagItem|DataBagItem).load/, 'data_bag_item'))
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,5 +1,5 @@
 #
-# 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");
@@ -18,19 +18,28 @@ module RuboCop
   module Cop
     module Chef
       module ChefModernize
-        # PowerShell is already set as the default guard interpreter for powershell_script resources in Chef Infra Client 13 and later and does not need to be specified.
+        # PowerShell is already set as the default guard interpreter for `powershell_script` and `batch` resources in Chef Infra Client 13 and later and does not need to be specified.
         #
         # @example
         #
         #   # bad
-        #   powershell_script 'whatever' do
-        #     code "mkdir test_dir"
+        #   powershell_script 'Create Directory' do
+        #     code "New-Item -ItemType Directory -Force -Path C:\mydir"
+        #     guard_interpreter :powershell_script
+        #   end
+        #
+        #   batch 'Create Directory' do
+        #     code "mkdir C:\mydir"
         #     guard_interpreter :powershell_script
         #   end
         #
         #   # good
-        #   powershell_script 'whatever' do
-        #     code "mkdir test_dir"
+        #   powershell_script 'Create Directory' do
+        #     code "New-Item -ItemType Directory -Force -Path C:\mydir"
+        #   end
+        #
+        #   batch 'Create Directory' do
+        #     code "mkdir C:\mydir"
         #   end
         #
         class PowerShellGuardInterpreter < Cop
@@ -40,10 +49,10 @@ module RuboCop
 
           minimum_target_chef_version '13.0'
 
-          MSG = 'PowerShell is already set as the default guard interpreter for powershell_script resources in Chef Infra Client 13 and later and does not need to be specified.'.freeze
+          MSG = 'PowerShell is already set as the default guard interpreter for `powershell_script` and `batch` resources in Chef Infra Client 13 and later and does not need to be specified.'.freeze
 
           def on_block(node)
-            match_property_in_resource?(:powershell_script, 'guard_interpreter', node) do |interpreter|
+            match_property_in_resource?(%i(powershell_script batch), 'guard_interpreter', node) do |interpreter|
               if interpreter.arguments.first.source == ':powershell_script'
                 add_offense(interpreter, location: :expression, message: MSG, severity: :refactor)
               end

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

@@ -18,7 +18,7 @@ module RuboCop
   module Cop
     module Chef
       module ChefModernize
-        # Use the windows_feature resource built into Chef Infra Client 14+ instead of the powershell_script resource
+        # Use the windows_feature resource built into Chef Infra Client 15+ instead of the powershell_script resource
         # to run Install-WindowsFeature or Add-WindowsFeature
         #
         # @example
@@ -38,9 +38,9 @@ module RuboCop
           include RuboCop::Chef::CookbookHelpers
           extend TargetChefVersion
 
-          minimum_target_chef_version '14.0'
+          minimum_target_chef_version '13.0'
 
-          MSG = 'Use the windows_feature resource built into Chef Infra Client 14+ instead of using Install-WindowsFeature or Add-WindowsFeature in a powershell_script resource'.freeze
+          MSG = 'Use the windows_feature resource built into Chef Infra Client 13+ instead of using Install-WindowsFeature or Add-WindowsFeature in a powershell_script resource'.freeze
 
           def on_block(node)
             match_property_in_resource?(:powershell_script, 'code', node) do |code_property|

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

@@ -0,0 +1,69 @@
+#
+# 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 ChefModernize
+        # Provides should be set using the `provides` resource DSL method instead of instead of setting @provides in the initialize method.
+        #
+        # @example
+        #
+        #   # bad
+        #   def initialize(*args)
+        #     super
+        #     @provides = :foo
+        #   end
+        #
+        #   # good
+        #   provides :foo
+        #
+        class ProvidesFromInitialize < Cop
+          include RangeHelp
+
+          MSG = 'Provides should be set using the `provides` resource DSL method instead of instead of setting @provides in the initialize method.'.freeze
+
+          def_node_matcher :provides_assignment?, <<-PATTERN
+            (ivasgn :@provides $(sym ...))
+          PATTERN
+
+          def on_ivasgn(node)
+            provides_assignment?(node) do
+              add_offense(node, location: :expression, message: MSG, severity: :refactor) if intialize_method(node.parent.parent).any?
+            end
+          end
+
+          def_node_search :provides_method?, '(send nil? :provides ... )'
+
+          def_node_search :intialize_method, '(def :initialize ... )'
+
+          def autocorrect(node)
+            lambda do |corrector|
+              # insert the new provides call above the initialize method, but not if one already exists (this is sadly common)
+              unless provides_method?(processed_source.ast)
+                initialize_node = intialize_method(processed_source.ast).first
+                corrector.insert_before(initialize_node.source_range, "provides #{node.descendants.first.source}\n\n")
+              end
+
+              # remove the variable from the initialize method
+              corrector.remove(range_with_surrounding_space(range: node.loc.expression, side: :left))
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,5 +1,5 @@
 #
-# Copyright:: 2019-2020, Chef Software, Inc.
+# Copyright:: 2019, Chef Software, Inc.
 # Author:: Tim Smith (<tsmith@chef.io>)
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -18,20 +18,19 @@ module RuboCop
   module Cop
     module Chef
       module ChefModernize
-        # In Chef Infra Client 12+ is is no longer necessary to gate the use of the provides methods in resources with `if respond_to?(:provides)` or `if defined? provides`.
+        # It is not longer necessary respond_to?(:foo) in metadata. This was used to support new metadata
+        # methods in Chef 11 and early versions of Chef 12.
         #
         # @example
         #
         #   # bad
         #   provides :foo if respond_to?(:provides)
         #
-        #   provides :foo if defined? provides
-        #
         #   # good
         #   provides :foo
         #
         class RespondToProvides < Cop
-          MSG = 'Using `respond_to?(:provides)` or `if defined? provides` in resources is no longer necessary in Chef Infra Client 12+.'.freeze
+          MSG = 'respond_to?(:provides) in resources is no longer necessary in Chef Infra Client 12+'.freeze
 
           def on_if(node)
             if_respond_to_provides?(node) do
@@ -40,16 +39,7 @@ module RuboCop
           end
 
           def_node_matcher :if_respond_to_provides?, <<~PATTERN
-          (if
-            {
-            (send nil? :respond_to?
-              (sym :provides))
-
-            (:defined?
-              (send nil? :provides))
-            }
-            (send nil? :provides
-              (sym _)) ... )
+          (if (send nil? :respond_to? ( :sym :provides ) ) ... )
           PATTERN
 
           def autocorrect(node)

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

@@ -0,0 +1,103 @@
+#
+# 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 ChefModernize
+        # Pass an array of packages to package resources instead of interating over an array of packages when using multi-package capable package subystem such as apt, yum, chocolatey, dnf, or zypper. Multipackage installs are faster and simplify logs.
+        #
+        # @example
+        #
+        #   # bad
+        #   %w(bmon htop vim curl).each do |pkg|
+        #     package pkg do
+        #       action :install
+        #     end
+        #   end
+        #
+        #   # good
+        #   package %w(bmon htop vim curl)
+        #
+        class UseMultipackageInstalls < Cop
+          MSG = 'Pass an array of packages to package resources instead of interating over an array of packages when using multi-package capable package subystem such as apt, yum, chocolatey, dnf, or zypper. Multipackage installs are faster and simplify logs.'.freeze
+          MULTIPACKAGE_PLATS = %w(debian redhat suse amazon fedora scientific oracle rhel ubuntu centos redhat).freeze
+
+          def_node_matcher :platform_or_platform_family?, <<-PATTERN
+            (send (send nil? :node) :[] (str {"platform" "platform_family"}) )
+          PATTERN
+
+          def_node_matcher :platform_helper?, <<-PATTERN
+          (if
+            (send nil? {:platform_family? :platform?} $... )
+            $(block
+              (send
+                $(array ... ) :each)
+              (args ... )
+              (block
+                (send nil? :package
+                  (lvar ... ))
+                (args)
+                (send nil? :action
+                  (sym :install)))) nil?)
+          PATTERN
+
+          def_node_matcher :package_array_install?, <<-PATTERN
+          (block
+            (send
+              $(array ... ) :each)
+            (args ... )
+            (block
+              (send nil? :package
+                (lvar ... ))
+              (args)
+              (send nil? :action
+                (sym :install))))
+          PATTERN
+
+          # see if all platforms in the when condition are multipackage compliant
+          def multipackage_platforms?(condition_obj)
+            condition_obj.all? do |p|
+              MULTIPACKAGE_PLATS.include?(p.value)
+            end
+          end
+
+          def on_when(node)
+            if platform_or_platform_family?(node.parent.condition) &&
+               package_array_install?(node.body) &&
+               multipackage_platforms?(node.conditions)
+              add_offense(node.body, location: :expression, message: MSG, severity: :refactor)
+            end
+          end
+
+          def on_if(node)
+            platform_helper?(node) do |plats, blk, _pkgs|
+              add_offense(blk, location: :expression, message: MSG, severity: :refactor) if multipackage_platforms?(plats)
+            end
+          end
+
+          def autocorrect(node)
+            package_array_install?(node) do |vals|
+              lambda do |corrector|
+                corrector.replace(node.loc.expression, "package #{vals.source}")
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end