cookstyle 5.23.0 → 6.0.19

data/lib/cookstyle.rb

@@ -7,7 +7,6 @@ require 'yaml'
 gem 'rubocop', "= #{Cookstyle::RUBOCOP_VERSION}"
 require 'rubocop'
 require 'rubocop/monkey_patches/comment_config.rb'
-require 'rubocop/monkey_patches/json_formatter.rb'
 
 # monkey patches needed for the TargetChefVersion config option
 require 'rubocop/monkey_patches/config.rb'

data/lib/cookstyle/version.rb

@@ -1,4 +1,4 @@
 module Cookstyle
-  VERSION = "5.23.0".freeze # rubocop: disable Style/StringLiterals
-  RUBOCOP_VERSION = '0.75.1'.freeze
+  VERSION = "6.0.19".freeze # rubocop: disable Style/StringLiterals
+  RUBOCOP_VERSION = '0.80.1'.freeze
 end

data/lib/rubocop/chef/cookbook_helpers.rb

@@ -39,16 +39,16 @@ module RuboCop
 
       # Match particular properties within a resource
       #
-      # @param [String] resource_name The name of the resource to match
+      # @param [Symbol, Array<Symbol>] resource_names The name of the resources to match
       # @param [String] property_names The name of the property to match (or action)
       # @param [RuboCop::AST::Node] node The rubocop ast node to search
       #
       # @yield
       #
-      def match_property_in_resource?(resource_name, property_names, node)
+      def match_property_in_resource?(resource_names, property_names, node)
         return unless looks_like_resource?(node)
         # bail out if we're not in the resource we care about or nil was passed (all resources)
-        return unless resource_name.nil? || node.children.first.method?(resource_name.to_sym) # see if we're in the right resource
+        return unless resource_names.nil? || Array(resource_names).include?(node.children.first.method_name) # see if we're in the right resource
 
         resource_block = node.children[2] # the 3rd child is the actual block in the resource
         return unless resource_block # nil would be an empty block

data/lib/rubocop/cop/chef/correctness/chef_application_fatal.rb

@@ -0,0 +1,58 @@
+#
+# Copyright:: 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 ChefCorrectness
+        # Use raise to force Chef Infra Client to fail instead of using Chef::Application.fatal, which masks the full stack trace of the failure and makes debugging difficult.
+        #
+        # @example
+        #
+        #   # bad
+        #   Chef::Application.fatal!('Something horrible happened!')
+        #
+        #   # good
+        #   raise "Something horrible happened!"
+        #
+        class ChefApplicationFatal < Cop
+          MSG = 'Use raise to force Chef Infra Client to fail instead of using Chef::Application.fatal'.freeze
+
+          def_node_matcher :application_fatal?, <<-PATTERN
+            (send
+              (const
+                (const nil? :Chef) :Application) :fatal!
+              $( ... ))
+          PATTERN
+
+          def on_send(node)
+            application_fatal?(node) do
+              add_offense(node, location: :expression, message: MSG, severity: :refactor)
+            end
+          end
+
+          def autocorrect(node)
+            lambda do |corrector|
+              application_fatal?(node) do |val|
+                corrector.replace(node.loc.expression, "raise(#{val.source})")
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/chef/correctness/incorrect_library_injection.rb

@@ -1,5 +1,5 @@
 #
-# Copyright:: Copyright 2019-2020, Chef Software Inc.
+# Copyright:: Copyright 2019, Chef Software Inc.
 # Author:: Tim Smith (<tsmith@chef.io>)
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -18,22 +18,24 @@ module RuboCop
   module Cop
     module Chef
       module ChefCorrectness
-        # Libraries should be injected into the Chef::DSL::Recipe class and not Chef::Recipe or Chef::Provider classes directly.
+        # Libraries should be injected into the Chef::DSL::Recipe or Chef::DSL::Resource classes and not Recipe/Resource/Provider classes directly.
         #
         # @example
         #
         #   # bad
         #   ::Chef::Recipe.send(:include, Filebeat::Helpers)
         #   ::Chef::Provider.send(:include, Filebeat::Helpers)
+        #   ::Chef::Resource.send(:include, Filebeat::Helpers)
         #
         #   # good
         #   ::Chef::DSL::Recipe.send(:include, Filebeat::Helpers) # covers previous Recipe & Provider classes
+        #   ::Chef::DSL::Resource.send(:include, Filebeat::Helpers)
         #
         class IncorrectLibraryInjection < Cop
-          MSG = 'Libraries should be injected into the Chef::DSL::Recipe class and not Chef::Recipe or Chef::Provider classes directly.'.freeze
+          MSG = 'Libraries should be injected into the Chef::DSL::Recipe or Chef::DSL::Resource classes and not Recipe/Resource/Provider classes directly.'.freeze
 
           def_node_matcher :legacy_class_sends?, <<-PATTERN
-            (send (const (const (cbase) :Chef) {:Recipe :Provider}) :send (sym :include) ... )
+            (send (const (const (cbase) :Chef) {:Recipe :Provider :Resource}) :send (sym :include) ... )
           PATTERN
 
           def on_send(node)
@@ -44,7 +46,11 @@ module RuboCop
 
           def autocorrect(node)
             lambda do |corrector|
-              corrector.replace(node.loc.expression, node.source.gsub(/Chef::(Provider|Recipe)/, 'Chef::DSL::Recipe'))
+              new_val = node.source
+              new_val.gsub!(/Chef::(Provider|Recipe)/, 'Chef::DSL::Recipe')
+              new_val.gsub!(/Chef::Resource/, 'Chef::DSL::Resource')
+
+              corrector.replace(node.loc.expression, new_val)
             end
           end
         end

data/lib/rubocop/cop/chef/correctness/powershell_delete_file.rb

@@ -0,0 +1,53 @@
+#
+# 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 ChefCorrectness
+        # Use the `file` or `directory` resources built into Chef Infra Client with the :delete action to remove files/directories instead of using Remove-Item in a powershell_script resource
+        #
+        # @example
+        #
+        #   # bad
+        #   powershell_script 'Cleanup old files' do
+        #     code 'Remove-Item C:\Windows\foo\bar.txt'
+        #     only_if { ::File.exist?('C:\\Windows\\foo\\bar.txt') }
+        #   end
+        #
+        #  # good
+        #  file 'C:\Windows\foo\bar.txt' do
+        #    action :delete
+        #  end
+        #
+        class PowershellScriptDeleteFile < Cop
+          include RuboCop::Chef::CookbookHelpers
+
+          MSG = 'Use the `file` or `directory` resources built into Chef Infra Client with the :delete action to remove files/directories instead of using Remove-Item in a powershell_script resource'.freeze
+
+          def on_block(node)
+            match_property_in_resource?(:powershell_script, 'code', node) do |code_property|
+              property_data = method_arg_ast_to_string(code_property)
+              if property_data && property_data.match?(/^remove-item/i) && !property_data.include?('*')
+                add_offense(node, location: :expression, message: MSG, severity: :refactor)
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/chef/deprecation/chef_handler_supports.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");
@@ -39,8 +39,8 @@ module RuboCop
           MSG = 'Use the type property instead of the deprecated supports property in the chef_handler resource. The supports property was removed in chef_handler cookbook version 3.0 (June 2017) and Chef Infra Client 14.0.'.freeze
 
           def on_block(node)
-            match_property_in_resource?('chef_handler', 'supports', node) do |prop_node|
-              add_offense(prop_node, location: :expression, message: MSG, severity: :refactor)
+            match_property_in_resource?(:chef_handler, 'supports', node) do |prop_node|
+              add_offense(prop_node, location: :expression, message: MSG, severity: :warning)
             end
           end
 

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

@@ -40,13 +40,13 @@ module RuboCop
 
           def on_send(node)
             require_rest?(node) do
-              add_offense(node, location: :expression, message: MSG, severity: :refactor)
+              add_offense(node, location: :expression, message: MSG, severity: :warning)
             end
           end
 
           def on_const(node)
             rest_const?(node) do
-              add_offense(node, location: :expression, message: MSG, severity: :refactor)
+              add_offense(node, location: :expression, message: MSG, severity: :warning)
             end
           end
         end

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

@@ -62,21 +62,21 @@ module RuboCop
 
           def on_send(node)
             rewind_gem_install?(node) do
-              add_offense(node, location: :expression, message: MSG, severity: :refactor)
+              add_offense(node, location: :expression, message: MSG, severity: :warning)
             end
 
             require_rewind?(node) do
-              add_offense(node, location: :expression, message: MSG, severity: :refactor)
+              add_offense(node, location: :expression, message: MSG, severity: :warning)
             end
 
             rewind_resources?(node) do
-              add_offense(node, location: :expression, message: MSG, severity: :refactor)
+              add_offense(node, location: :expression, message: MSG, severity: :warning)
             end
           end
 
           def on_block(node)
             match_property_in_resource?(:chef_gem, 'package_name', node) do |pkg_name|
-              add_offense(node, location: :expression, message: MSG, severity: :refactor) if pkg_name.arguments&.first&.str_content == 'chef-rewind'
+              add_offense(node, location: :expression, message: MSG, severity: :warning) if pkg_name.arguments&.first&.str_content == 'chef-rewind'
             end
           end
 

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

@@ -0,0 +1,56 @@
+#
+# 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
+        # Use `platform?('windows')` instead of the legacy `Chef::Platform.windows?` helper
+        #
+        # @example
+        #
+        #   # bad
+        #   Chef::Platform.windows?
+        #
+        #   # good
+        #   platform?('windows')
+        #   platform_family?('windows')
+        #
+        class ChefWindowsPlatformHelper < Cop
+          MSG = "Use `platform?('windows')` instead of the legacy `Chef::Platform.windows?` helper.".freeze
+
+          def_node_matcher :chef_platform_windows?, <<-PATTERN
+            (send
+              (const
+                (const nil? :Chef) :Platform) :windows?)
+          PATTERN
+
+          def on_send(node)
+            chef_platform_windows?(node) do
+              add_offense(node, location: :expression, message: MSG, severity: :warning)
+            end
+          end
+
+          def autocorrect(node)
+            lambda do |corrector|
+              corrector.replace(node.loc.expression, "platform?('windows')")
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -32,7 +32,7 @@ module RuboCop
             # Using range similar to RuboCop::Cop::Naming::Filename (file_name.rb)
             range = source_range(processed_source.buffer, 1, 0)
 
-            add_offense(nil, location: range, message: MSG, severity: :refactor)
+            add_offense(nil, location: range, message: MSG, severity: :warning)
           end
         end
       end

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

@@ -36,7 +36,7 @@ module RuboCop
 
           def on_block(node)
             coverage_reporter?(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/chefspec_legacy_runner.rb

@@ -48,7 +48,7 @@ module RuboCop
 
           def on_const(node)
             chefspec_runner?(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/chocolatey_package_uninstall_action.rb

@@ -41,7 +41,7 @@ module RuboCop
           def on_block(node)
             match_property_in_resource?(:chocolatey_package, 'action', node) do |choco_action|
               choco_action.arguments.each do |action|
-                add_offense(action, location: :expression, message: MSG, severity: :refactor) if action.source == ':uninstall'
+                add_offense(action, location: :expression, message: MSG, severity: :warning) if action.source == ':uninstall'
               end
             end
           end

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

@@ -39,7 +39,7 @@ module RuboCop
 
           def on_send(node)
             depends_compat_resource?(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/depends_partial_search.rb

@@ -26,10 +26,6 @@ module RuboCop
         #   depends 'partial_search'
         #
         class CookbookDependsOnPartialSearch < Cop
-          extend TargetChefVersion
-
-          minimum_target_chef_version '13.0'
-
           MSG = "Don't depend on the deprecated partial_search cookbook made obsolete by Chef 13".freeze
 
           def_node_matcher :depends_partial_search?, <<-PATTERN
@@ -38,7 +34,7 @@ module RuboCop
 
           def on_send(node)
             depends_partial_search?(node) do
-              add_offense(node, location: :expression, message: MSG, severity: :refactor)
+              add_offense(node, location: :expression, message: MSG, severity: :warning)
             end
           end
         end

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

@@ -35,7 +35,7 @@ module RuboCop
 
           def on_send(node)
             depends_method?(node) do |arg|
-              add_offense(node, location: :expression, message: MSG, severity: :refactor) if %w(poise poise-service).include?(arg.value)
+              add_offense(node, location: :expression, 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

@@ -108,7 +108,7 @@ module RuboCop
 
           def on_send(node)
             chefspec_definition?(node) do |plat, ver|
-              add_offense(node, location: :expression, message: MSG, severity: :refactor) if legacy_chefspec_platform(plat.value, ver.value)
+              add_offense(node, location: :expression, message: MSG, severity: :warning) if legacy_chefspec_platform(plat.value, ver.value)
             end
           end
 

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

@@ -52,15 +52,15 @@ module RuboCop
 
           def on_send(node)
             deprecated_mixin?(node) do
-              add_offense(node, location: :expression, message: MSG, severity: :refactor)
+              add_offense(node, location: :expression, message: MSG, severity: :warning)
             end
 
             deprecated_dsl?(node) do
-              add_offense(node, location: :expression, message: MSG, severity: :refactor)
+              add_offense(node, location: :expression, message: MSG, severity: :warning)
             end
 
             dsl_mixin_require?(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/deprecated_platform_methods.rb

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

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

@@ -0,0 +1,40 @@
+#
+# 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
+        # 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.
+        #
+        # @example
+        #
+        #   # bad
+        #   if older_than_win_2012_or_8?
+        #     # do some legacy things
+        #   end
+        #
+        class DeprecatedWindowsVersionCheck < Cop
+          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.".freeze
+
+          def on_send(node)
+            add_offense(node, location: :expression, message: MSG, severity: :warning) if node.method_name == :older_than_win_2012_or_8?
+          end
+        end
+      end
+    end
+  end
+end