cookstyle 6.2.9 → 6.7.3

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

@@ -29,7 +29,7 @@ module RuboCop
         #   end
         #
         class ErlCallResource < Cop
-          MSG = "Don't use the deprecated erl_call resource removed in Chef 13".freeze
+          MSG = "Don't use the deprecated erl_call resource removed in Chef Infra Client 13".freeze
 
           def on_send(node)
             add_offense(node, location: :expression, message: MSG, severity: :warning) if node.method_name == :erl_call

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

@@ -18,7 +18,7 @@ module RuboCop
   module Cop
     module Chef
       module ChefDeprecations
-        # The local resource's lc_all property has been deprecated and will be removed in Chef Infra Client 16
+        # The local resource's lc_all property has been deprecated and will be removed in Chef Infra Client 17
         #
         # @example
         #
@@ -31,7 +31,7 @@ module RuboCop
         class LocaleDeprecatedLcAllProperty < Cop
           include RuboCop::Chef::CookbookHelpers
 
-          MSG = "The local resource's lc_all property has been deprecated and will be removed in Chef Infra Client 16".freeze
+          MSG = "The local resource's lc_all property has been deprecated and will be removed in Chef Infra Client 17".freeze
 
           def on_block(node)
             match_property_in_resource?(:locale, 'lc_all', node) do |property|

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

@@ -18,7 +18,7 @@ module RuboCop
   module Cop
     module Chef
       module ChefDeprecations
-        # Incorrectly using node methods for Ohai data when you really want node attributes
+        # Use node attributes to access data provided by Ohai instead of using node methods to access that data.
         #
         # @example
         #

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

@@ -17,10 +17,9 @@ module RuboCop
   module Cop
     module Chef
       module ChefDeprecations
-        # The node.set method has been removed in Chef-13 and must be replaced by node.normal.
+        # The `node.set` method has been removed in Chef Infra Client 13 and usage must be replaced with `node.normal`.
         #
-        # Note that node.normal keeps the semantics identical, but the use of node.normal is
-        # also discouraged.
+        # This cop will autocorrect code to use node.normal, which is functionally identical to node.set, but we also discourage the use of that method as normal level attributes persist on the node even if the code setting the attribute is later removed.
         #
         # @example
         #

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

@@ -17,10 +17,9 @@ module RuboCop
   module Cop
     module Chef
       module ChefDeprecations
-        # The node.set_unless method has been removed in Chef-13 and must be replaced by node.normal_unless.
+        # The node.set_unless method has been removed in Chef Infra Client 13 and usage must be replaced with node.normal_unless.
         #
-        # Note that node.normal_unless keeps the semantics identical, but the use of node.normal is
-        # also discouraged.
+        # This cop will autocorrect code to use node.normal_unless, which is functionally identical to node.set_unless, but we also discourage the use of that method as normal level attributes persist on the node even if the code setting the attribute is later removed.
         #
         # @example
         #

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

@@ -18,7 +18,7 @@ module RuboCop
   module Cop
     module Chef
       module ChefDeprecations
-        # Use node['powershell']['version'] or the new powershell_version helper available in Chef Infra Client 16+ instead of the deprecated PowerShell cookbook helpers
+        # Use `node['powershell']['version']` or the new `powershell_version` helper available in Chef Infra Client 15.8+ instead of the deprecated PowerShell cookbook helpers
         #
         # @example
         #
@@ -28,11 +28,11 @@ module RuboCop
         #   # good
         #   node['powershell']['version'].to_f == 4.0
         #
-        #   # good (Chef Infra Client 16+)
+        #   # better (Chef Infra Client 15.8+)
         #   powershell_version == 4.0
         #
         class PowershellCookbookHelpers < Cop
-          MSG = "Use node['powershell']['version'] or the new powershell_version helper available in Chef Infra Client 16+ instead of the deprecated PowerShell cookbook helpers.".freeze
+          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.".freeze
 
           def_node_matcher :ps_cb_helper?, <<-PATTERN
           (send

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

@@ -0,0 +1,77 @@
+#
+# 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
+        # Starting with Chef Infra Client 16, using `resource_name` without also using `provides` will result in resource failures. Use `provides` to change the name of the resource instead and omit `resource_name` entirely if it matches the name Chef Infra Client automatically assigns based on COOKBOOKNAME_FILENAME.
+        #
+        # @example
+        #
+        #   # bad
+        #   mycookbook/resources/myresource.rb:
+        #   resource_name :mycookbook_myresource
+        #
+        class ResourceUsesOnlyResourceName < Cop
+          include RuboCop::Chef::CookbookHelpers
+          include RangeHelp
+
+          MSG = 'Starting with Chef Infra Client 16, using `resource_name` without also using `provides` will result in resource failures. Use `provides` to change the name of the resource instead and omit `resource_name` entirely if it matches the name Chef Infra Client automatically assigns based on COOKBOOKNAME_FILENAME.'.freeze
+
+          def_node_matcher :resource_name?, <<-PATTERN
+          (send nil? :resource_name (sym $_ ))
+          PATTERN
+
+          def_node_search :cb_name_match, <<~PATTERN
+          (send nil? :name (str $_))
+          PATTERN
+
+          def_node_search :provides_methods?, '(send nil? {:provides :chef_version_for_provides} ... )'
+
+          def cookbook_name
+            cb_path = File.expand_path(File.join(processed_source.file_path, '../..'))
+
+            if File.exist?(File.join(cb_path, 'metadata.rb'))
+              cb_metadata_ast = ProcessedSource.from_file(File.join(cb_path, 'metadata.rb'), @config.target_ruby_version).ast
+              cb_name_match(cb_metadata_ast).first
+            elsif File.exist?(File.join(cb_path, 'metadata.json')) # this exists only for supermarket files that lack metadata.rb
+              JSON.parse(File.read(File.join(cb_path, 'metadata.json')))['name']
+            end
+          end
+
+          def on_send(node)
+            resource_name?(node) do |_name|
+              add_offense(node, location: :expression, message: MSG, severity: :warning) unless provides_methods?(processed_source.ast)
+            end
+          end
+
+          def autocorrect(node)
+            lambda do |corrector|
+              resource_name?(node) do |name|
+                if name.to_s == "#{cookbook_name}_#{File.basename(processed_source.path, '.rb')}"
+                  corrector.remove(range_with_surrounding_space(range: node.loc.expression, side: :left))
+                else
+                  corrector.replace(node.loc.expression, node.source.gsub('resource_name', 'provides'))
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,59 @@
+#
+# 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
+        # Pass options to shell_out helpers without the brackets to avoid Ruby 2.7 deprecation warnings.
+        #
+        # @example
+        #
+        #   # bad
+        #   shell_out!('hostnamectl status', { returns: [0, 1] })
+        #   shell_out('hostnamectl status', { returns: [0, 1] })
+        #
+        #   # good
+        #   shell_out!('hostnamectl status', returns: [0, 1])
+        #   shell_out('hostnamectl status', returns: [0, 1])
+        #
+        class Ruby27KeywordArgumentWarnings < Cop
+          include RuboCop::Chef::CookbookHelpers
+
+          MSG = 'Pass options to shell_out helpers without the brackets to avoid Ruby 2.7 deprecation warnings.'.freeze
+
+          def_node_matcher :positional_shellout?, <<-PATTERN
+            (send nil? {:shell_out :shell_out!} ... $(hash ... ))
+          PATTERN
+
+          def on_send(node)
+            positional_shellout?(node) do |h|
+              add_offense(h, location: :expression, message: MSG, severity: :refactor) if h.braces?
+            end
+          end
+
+          def autocorrect(node)
+            lambda do |corrector|
+              # @todo when we drop ruby 2.4 support we can convert to to just delete_prefix delete_suffix
+              corrector.replace(node.loc.expression, node.loc.expression.source.gsub(/^{/, '').gsub(/}$/, ''))
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -54,8 +54,13 @@ module RuboCop
           def autocorrect(node)
             lambda do |corrector|
               new_text = []
+
               node.arguments.first.each_pair do |k, v|
-                new_text << "#{k.value} #{v.source}"
+                # account for a strange edge case where the person incorrectly makes "manage_home a method
+                # the code would be broken, but without this handling cookstyle would explode
+                key_value = (k.send_type? && k.method_name == :manage_home) ? 'manage_home' : k.value
+
+                new_text << "#{key_value} #{v.source}"
               end
 
               corrector.replace(node.loc.expression, new_text.join("\n  "))

data/lib/rubocop/cop/chef/deprecation/xml_ruby_recipe.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,8 +18,7 @@ module RuboCop
   module Cop
     module Chef
       module ChefDeprecations
-        # Do not include the deprecated xml::ruby recipe to install the nokogiri gem.
-        # Chef Infra Client 12 and later ships with nokogiri included.
+        # Do not include the deprecated xml::ruby recipe to install the nokogiri gem. Chef Infra Client 12 and later ships with nokogiri included.
         #
         # @example
         #
@@ -35,6 +34,7 @@ module RuboCop
 
           def on_send(node)
             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, location: :expression, message: MSG, severity: :warning)
             end
           end

data/lib/rubocop/cop/chef/modernize/includes_mixin_shellout.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");
@@ -42,13 +42,34 @@ module RuboCop
             (send nil? :require ( str {"chef/mixin/shell_out" "chef/mixin/powershell_out"} ))
           PATTERN
 
+          def_node_search :hwrp_classes?, <<-PATTERN
+            (class
+              (const ... )
+              {(const
+                (const
+                  (const nil? :Chef) :Provider) :LWRPBase)
+               (const
+                 (const nil? :Chef) :Provider)
+               }
+              ...)
+          PATTERN
+
+          def check_for_offenses(node)
+            containing_dir = File.basename(File.dirname(processed_source.path))
+
+            # only add offenses when we're in a custom resource or HWRP, but not a plain old library
+            if containing_dir == 'resources' || hwrp_classes?(processed_source.ast)
+              add_offense(node, location: :expression, message: MSG, severity: :refactor)
+            end
+          end
+
           def on_send(node)
             require_shellout?(node) do
-              add_offense(node, location: :expression, message: MSG, severity: :refactor)
+              check_for_offenses(node)
             end
 
             include_shellout?(node) do
-              add_offense(node, location: :expression, message: MSG, severity: :refactor)
+              check_for_offenses(node)
             end
           end
 

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

@@ -0,0 +1,93 @@
+#
+# 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
+        # There is no need to check if the chef_gem resource supports compile_time as Chef Infra Client 12.1 and later support the compile_time property.
+        #
+        #   # bad
+        #   chef_gem 'ultradns-sdk' do
+        #     compile_time true if Chef::Resource::ChefGem.method_defined?(:compile_time)
+        #     action :nothing
+        #   end
+        #
+        #   chef_gem 'ultradns-sdk' do
+        #     compile_time true if Chef::Resource::ChefGem.instance_methods(false).include?(:compile_time)
+        #     action :nothing
+        #   end
+        #
+        #   chef_gem 'ultradns-sdk' do
+        #     compile_time true if respond_to?(:compile_time)
+        #     action :nothing
+        #   end
+        #
+        #   # good
+        #   chef_gem 'ultradns-sdk' do
+        #     compile_time true
+        #     action :nothing
+        #   end
+        #
+        class RespondToCompileTime < Cop
+          extend TargetChefVersion
+
+          minimum_target_chef_version '12.1'
+
+          MSG = 'There is no need to check if the chef_gem resource supports compile_time as Chef Infra Client 12.1 and later support the compile_time property.'.freeze
+
+          def_node_matcher :compile_time_method_defined?, <<-PATTERN
+          (if
+            {
+              (send
+              (const
+                (const
+                  (const nil? :Chef) :Resource) :ChefGem) :method_defined?
+              (sym :compile_time))
+
+              (send
+                (send
+                  (const
+                    (const
+                      (const nil? :Chef) :Resource) :ChefGem) :instance_methods
+                  (false)) :include?
+                (sym :compile_time))
+
+              (send nil? :respond_to?
+                (sym :compile_time))
+            }
+            (send nil? :compile_time
+              $(_)) nil?)
+          PATTERN
+
+          def on_if(node)
+            compile_time_method_defined?(node) do
+              add_offense(node, location: :expression, message: MSG, severity: :refactor)
+            end
+          end
+
+          def autocorrect(node)
+            lambda do |corrector|
+              compile_time_method_defined?(node) do |val|
+                corrector.replace(node.loc.expression, "compile_time #{val.source}")
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/chef/modernize/respond_to_provides.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,20 @@ module RuboCop
   module Cop
     module Chef
       module ChefModernize
-        # 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.
+        # 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`.
         #
         # @example
         #
         #   # bad
         #   provides :foo if respond_to?(:provides)
         #
+        #   provides :foo if defined? provides
+        #
         #   # good
         #   provides :foo
         #
         class RespondToProvides < Cop
-          MSG = 'respond_to?(:provides) in resources is no longer necessary in Chef Infra Client 12+'.freeze
+          MSG = 'Using `respond_to?(:provides)` or `if defined? provides` in resources is no longer necessary in Chef Infra Client 12+.'.freeze
 
           def on_if(node)
             if_respond_to_provides?(node) do
@@ -39,7 +40,16 @@ module RuboCop
           end
 
           def_node_matcher :if_respond_to_provides?, <<~PATTERN
-          (if (send nil? :respond_to? ( :sym :provides ) ) ... )
+          (if
+            {
+            (send nil? :respond_to?
+              (sym :provides))
+
+            (:defined?
+              (send nil? :provides))
+            }
+            (send nil? :provides
+              (sym _)) ... )
           PATTERN
 
           def autocorrect(node)