cookstyle 5.15.7 → 5.16.10

data/lib/cookstyle.rb

@@ -9,6 +9,11 @@ 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'
+require 'rubocop/monkey_patches/cop.rb'
+require 'rubocop/monkey_patches/commissioner.rb'
+
 module RuboCop
   class ConfigLoader
     RUBOCOP_HOME.gsub!(
@@ -36,6 +41,7 @@ require 'rubocop/chef'
 require 'rubocop/chef/cookbook_helpers'
 require 'rubocop/chef/platform_helpers'
 require 'rubocop/chef/cookbook_only'
+require 'rubocop/cop/target_chef_version'
 
 # Chef specific cops
 Dir.glob(File.dirname(__FILE__) + '/rubocop/cop/chef/**/*.rb') do |file|

data/lib/cookstyle/version.rb

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

data/lib/rubocop/chef/cookbook_helpers.rb

@@ -40,27 +40,28 @@ module RuboCop
       # Match particular properties within a resource
       #
       # @param [String] resource_name The name of the resource to match
-      # @param [String] property_name The name of the property to match (or action)
+      # @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_name, node)
+      def match_property_in_resource?(resource_name, 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
 
         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
+
         if resource_block.begin_type? # if begin_type we need to iterate over the children
           resource_block.children.each do |resource_blk_child|
             extract_send_types(resource_blk_child) do |p|
-              yield(p) if p.method_name == property_name.to_sym
+              yield(p) if symbolized_property_types(property_names).include?(p.method_name)
             end
           end
         else # there's only a single property to check
           extract_send_types(resource_block) do |p|
-            yield(p) if p.method_name == property_name.to_sym
+            yield(p) if symbolized_property_types(property_names).include?(p.method_name)
           end
         end
       end
@@ -75,6 +76,13 @@ module RuboCop
 
       private
 
+      # @param [String, Array] property
+      #
+      # @return [Array]
+      def symbolized_property_types(property)
+        Array(property).map(&:to_sym)
+      end
+
       #
       # given a node object does it look like a chef resource or not?
       # warning: currently this requires a resource with properties since we key off blocks and property-less resources look like methods

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

@@ -0,0 +1,50 @@
+#
+# Copyright:: Copyright 2019, 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
+        # dnf_package does not support the allow_downgrades property
+        #
+        # @example
+        #
+        #   # bad
+        #   dnf_package 'nginx' do
+        #     version '1.2.3'
+        #     allow_downgrades true
+        #   end
+        #
+        #   # good
+        #   dnf_package 'nginx' do
+        #     version '1.2.3'
+        #   end
+        #
+        class DnfPackageAllowDowngrades < Cop
+          include RuboCop::Chef::CookbookHelpers
+
+          MSG = 'dnf_package does not support the allow_downgrades property'.freeze
+
+          def on_block(node)
+            match_property_in_resource?(:dnf_package, :allow_downgrades, node) do |prop|
+              add_offense(prop, location: :expression, message: MSG, severity: :refactor)
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,53 @@
+#
+# Copyright:: 2019, 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
+        # Valid notification timings are :immediately, :immediate (alias for :immediately), :delayed, and :before.
+        #
+        # @example
+        #
+        #   # bad
+        #
+        #   template '/etc/www/configures-apache.conf' do
+        #     notifies :restart, 'service[apache]', :nope
+        #   end
+        #
+        #   # good
+        #
+        #   template '/etc/www/configures-apache.conf' do
+        #     notifies :restart, 'service[apache]', :immediately
+        #   end
+        #
+        class InvalidNotificationTiming < Cop
+          MSG = 'Valid notification timings are :immediately, :immediate (alias for :immediately), :delayed, and :before.'.freeze
+
+          def_node_matcher :notification_with_timing?, <<-PATTERN
+            (send nil? {:notifies :subscribes} (sym _) (...) $(sym _))
+          PATTERN
+
+          def on_send(node)
+            notification_with_timing?(node) do |timing|
+              add_offense(timing, location: :expression, message: MSG, severity: :refactor) unless %i(immediate immediately delayed before).include?(timing.value)
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,67 @@
+#
+# Copyright:: Copyright 2019, 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
+        # When using the value_for_platform helper you must include a hash of possible platforms where each platform contains a hash of versions and potential values. If you don't wish to match on a particular version you can instead use the key 'default'.
+        #
+        # @example
+        #
+        #   # bad
+        #   value_for_platform(
+        #     %w(redhat oracle) => 'baz'
+        #   )
+        #
+        #   # good
+        #   value_for_platform(
+        #     %w(redhat oracle) => {
+        #       '5' => 'foo',
+        #       '6' => 'bar',
+        #       'default'd => 'baz',
+        #     }
+        #   )
+        #
+        #   value_for_platform(
+        #     %w(redhat oracle) => {
+        #       'default' => 'foo',
+        #     },
+        #     'default' => 'bar'
+        #   )
+        #
+        class MalformedPlatformValueForPlatformHelper < Cop
+          def on_send(node)
+            return unless node.method_name == :value_for_platform
+
+            if node.arguments.count > 1
+              msg = 'Malformed value_for_platform helper argument. The value_for_platform helper takes a single hash of platforms as an argument.'
+              add_offense(node, location: :expression, message: msg, severity: :refactor)
+            elsif node.arguments.first.hash_type? # if it's a variable we can't check what's in that variable so skip
+              msg = "Malformed value_for_platform helper argument. The value for each platform in your hash must be a hash of either platform version strings or a value with a key of 'default'"
+              node.arguments.first.each_pair do |plats, plat_vals|
+                # instead of a platform the hash key can be default with a value of anything. Depending on the hash format this is a string or symbol
+                unless plat_vals.hash_type? || plats == s(:str, 'default') || plats == s(:sym, :default)
+                  add_offense(plat_vals, location: :expression, message: msg, severity: :refactor)
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -19,7 +19,7 @@ module RuboCop
   module Cop
     module Chef
       module ChefCorrectness
-        # When notifying an action within a resource the action should always be a symbol. In Chef Infra Client releases before 14.0 this may result in double notification.
+        # When notifying or subscribing an action within a resource the action should always be a symbol. In Chef Infra Client releases before 14.0 this may result in double notification.
         #
         # @example
         #
@@ -28,18 +28,26 @@ module RuboCop
         #     notifies 'restart', 'service[httpd]', 'delayed'
         #   end
         #
+        #   execute 'some commmand' do
+        #     subscribes 'restart', 'service[httpd]', 'delayed'
+        #   end
+        #
         #   # good
         #   execute 'some commmand' do
         #     notifies :restart, 'service[httpd]', 'delayed'
         #   end
         #
+        #   execute 'some commmand' do
+        #     subscribes :restart, 'service[httpd]', 'delayed'
+        #   end
+        #
         class NotifiesActionNotSymbol < Cop
           include RuboCop::Chef::CookbookHelpers
 
-          MSG = 'Resource notifcation actions should be symbols not strings.'.freeze
+          MSG = 'Resource notification and subscription actions should be symbols not strings.'.freeze
 
           def on_block(node)
-            match_property_in_resource?(nil, 'notifies', node) do |notifies_property|
+            match_property_in_resource?(nil, %w(notifies subscribes), node) do |notifies_property|
               add_offense(notifies_property, location: :expression, message: MSG, severity: :refactor) if notifies_property.node_parts[2].str_type?
             end
           end

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

@@ -19,7 +19,7 @@ module RuboCop
   module Cop
     module Chef
       module ChefDeprecations
-        # Use delete_resource / edit_resource instead of functionality in the deprecated chef-rewind gem
+        # Use delete_resource / edit_resource introduced in Chef Infra Client 12.10 instead of functionality in the deprecated chef-rewind gem
         #
         # @example
         #
@@ -29,20 +29,23 @@ module RuboCop
         #
         #   rewind "user[postgres]" do
         #     home '/var/lib/pgsql/9.2'
-        #     cookbook 'my-postgresql'    # or `cookbook cookbook_name()`
+        #     cookbook 'my-postgresql'
         #   end
         #
         #   unwind "user[postgres]"
         #
         class ChefRewind < Cop
           include RuboCop::Chef::CookbookHelpers
+          extend TargetChefVersion
+
+          minimum_target_chef_version '12.10'
 
           MAPPING = {
             rewind: 'edit_resource',
             unwind: 'delete_resource',
           }.freeze
 
-          MSG = 'Use delete_resource / edit_resource instead of functionality in the deprecated chef-rewind gem'.freeze
+          MSG = 'Use delete_resource / edit_resource introduced in Chef Infra Client 12.10 instead of functionality in the deprecated chef-rewind gem'.freeze
 
           def_node_matcher :rewind_gem_install?, <<-PATTERN
             (send nil? :chef_gem (str "chef-rewind"))

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

@@ -26,6 +26,10 @@ module RuboCop
         #   depends 'compat_resource'
         #
         class CookbookDependsOnCompatResource < Cop
+          extend TargetChefVersion
+
+          minimum_target_chef_version '12.19'
+
           MSG = "Don't depend on the deprecated compat_resource cookbook made obsolete by Chef 12.19+".freeze
 
           def_node_matcher :depends_compat_resource?, <<-PATTERN

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

@@ -0,0 +1,56 @@
+#
+# Copyright:: 2019, 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 provider_for_action instead of the deprecated Chef::Platform methods in resources, which were removed in Chef Infra Client 13.
+        #
+        # @example
+        #
+        #   # bad
+        #   resource = Chef::Resource::File.new("/tmp/foo.xyz", run_context)
+        #   provider = Chef::Platform.provider_for_resource(resource, :create)
+        #
+        #   resource = Chef::Resource::File.new("/tmp/foo.xyz", run_context)
+        #   provider = Chef::Platform.find_provider("ubuntu", "16.04", resource)
+        #
+        #   resource = Chef::Resource::File.new("/tmp/foo.xyz", run_context)
+        #   provider = Chef::Platform.find_provider_for_node(node, resource)
+        #
+        #   # good
+        #   resource = Chef::Resource::File.new("/tmp/foo.xyz", run_context)
+        #   provider = resource.provider_for_action(:create)
+        #
+        class DeprecatedPlatformMethods < Cop
+          MSG = 'Use provider_for_action instead of the deprecated Chef::Platform methods in resources, which were removed in Chef Infra Client 13.'.freeze
+
+          def_node_matcher :platform_method?, <<-PATTERN
+            (send (const (const nil? :Chef) :Platform) {:provider_for_resource :find_provider :find_provider_for_node} ... )
+          PATTERN
+
+          def on_send(node)
+            platform_method?(node) do
+              add_offense(node, location: :expression, message: MSG, severity: :refactor)
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -35,6 +35,10 @@ module RuboCop
         #     notifies :restart, resources(service: service_name_variable), :immediately
         #   end
         #
+        #   template '/etc/www/configures-apache.conf' do
+        #     subscribes :restart, resources(service: service_name_variable), :immediately
+        #   end
+        #
         #   # good
         #   template '/etc/www/configures-apache.conf' do
         #     notifies :restart, 'service[apache]'
@@ -48,11 +52,15 @@ module RuboCop
         #     notifies :restart, "service[#{service_name_variable}]", :immediately
         #   end
         #
+        #   template '/etc/www/configures-apache.conf' do
+        #     subscribes :restart, "service[#{service_name_variable}]", :immediately
+        #   end
+        #
         class LegacyNotifySyntax < Cop
           MSG = 'Use the new-style notification syntax which allows you to notify resources defined later in a recipe or resource.'.freeze
 
           def_node_matcher :legacy_notify?, <<-PATTERN
-            (send nil? :notifies $(sym _) (send nil? :resources (hash (pair $(sym _) $(...) ) ) ) $... )
+            (send nil? ${:notifies :subscribes} $(sym _) (send nil? :resources (hash (pair $(sym _) $(...) ) ) ) $... )
           PATTERN
 
           def on_send(node)
@@ -63,7 +71,7 @@ module RuboCop
 
           def autocorrect(node)
             lambda do |corrector|
-              legacy_notify?(node) do |action, type, name, timing|
+              legacy_notify?(node) do |notify_type, action, type, name, timing|
                 service_value = case name.type
                                 when :str
                                   "'#{type.source}[#{name.value}]'"
@@ -72,7 +80,7 @@ module RuboCop
                                 else
                                   "\"#{type.source}[\#{#{name.source}}]\""
                                 end
-                new_val = "notifies #{action.source}, #{service_value}"
+                new_val = "#{notify_type} #{action.source}, #{service_value}"
                 new_val << ", #{timing.first.source}" unless timing.empty?
                 corrector.replace(node.loc.expression, new_val)
               end

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

@@ -18,46 +18,42 @@ module RuboCop
   module Cop
     module Chef
       module ChefDeprecations
-        # A custom resource property can't be marked as a name_property and also have a default value. The name property is a special property that is derived from the name of the resource block in and thus always has a value passed to the resource. For example if you define `my_resource 'foo'` in recipe, then the name property of `my_resource` will automatically be set to `foo`. Setting a property to be both a name_property and have a default value will cause Chef Infra Client failures in 13.0 and later releases.
+        # A resource property (or attribute) can't be marked as a name_property (or name_attribute) and also have a default value. The name property is a special property that is derived from the name of the resource block in and thus always has a value passed to the resource. For example if you define `my_resource 'foo'` in recipe, then the name property of `my_resource` will automatically be set to `foo`. Setting a property to be both a name_property and have a default value will cause Chef Infra Client failures in 13.0 and later releases.
         #
         # @example
         #
         #   # bad
         #   property :config_file, String, default: 'foo', name_property: true
+        #   attribute :config_file, String, default: 'foo', name_attribute: true
         #
         #   # good
         #   property :config_file, String, name_property: true
+        #   attribute :config_file, String, name_attribute: true
         #
         class NamePropertyWithDefaultValue < Cop
+          include RangeHelp
+
           MSG = "A resource property can't be marked as a name_property and also have a default value. This will fail in Chef Infra Client 13 or later.".freeze
 
+          # match on a property or attribute that has any name and any type and a hash that
+          # contains name_property/name_attribute true and any default value. These are wrapped in
+          # <> which means the order doesn't matter in the hash.
+          def_node_matcher :name_property_with_default?, <<-PATTERN
+            (send nil? {:property :attribute} (sym _) ... (hash <(pair (sym {:name_property :name_attribute}) (true)) $(pair (sym :default) ...) ...>))
+          PATTERN
+
           def on_send(node)
-            if default_value?(node) && property_is_name_property?(node)
+            name_property_with_default?(node) do
               add_offense(node, location: :expression, message: MSG, severity: :refactor)
             end
           end
 
-          private
-
-          def property_is_name_property?(node)
-            if node.method_name == :property
-              node.arguments.each do |arg|
-                if arg.type == :hash
-                  return true if arg.source.match?(/name_property:\s*true/)
-                end
-              end
-              false # no required: true found
-            end
-          end
-
-          def default_value?(node)
-            if node.method_name == :property
-              node.arguments.each do |arg|
-                if arg.type == :hash
-                  return true if arg.source.match?(/default:\s/)
-                end
+          def autocorrect(node)
+            lambda do |corrector|
+              name_property_with_default?(node) do |default|
+                range = range_with_surrounding_comma(range_with_surrounding_space(range: default.loc.expression, side: :left), :left)
+                corrector.remove(range)
               end
-              false # no default: found
             end
           end
         end