cookstyle 6.12.6 → 6.15.9

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

@@ -32,8 +32,8 @@ module RuboCop
         #   shell_out!('hostnamectl status', returns: [0, 1])
         #   shell_out('hostnamectl status', returns: [0, 1])
         #
-        class Ruby27KeywordArgumentWarnings < Cop
-          include RuboCop::Chef::CookbookHelpers
+        class Ruby27KeywordArgumentWarnings < Base
+          extend RuboCop::Cop::AutoCorrector
 
           MSG = 'Pass options to shell_out helpers without the brackets to avoid Ruby 2.7 deprecation warnings.'
 
@@ -43,14 +43,10 @@ module RuboCop
 
           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(/}$/, ''))
+              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])
+              end
             end
           end
         end

data/lib/rubocop/cop/chef/effortless/node_environment.rb

@@ -27,7 +27,7 @@ module RuboCop
         #   node.environment == "production"
         #   node.chef_environment == "production"
         #
-        class CookbookUsesEnvironmments < Cop
+        class CookbookUsesEnvironments < Cop
           MSG = 'Cookbook uses environments, which cannot be used in Policyfiles or Effortless Infra'
 
           def on_send(node)

data/lib/rubocop/cop/chef/effortless/node_roles.rb

@@ -19,13 +19,13 @@ module RuboCop
   module Cop
     module Chef
       module ChefEffortless
-        # Neither Policyfiles or Effortless Infra which is based on Policyfiles supports Chef Roles
+        # Neither Policyfiles or Effortless Infra which is based on Policyfiles supports Chef Infra Roles
         #
         # @example
         #
         #   # bad
-        #   node.role?('webserver')
-        #   node.roles.include?('webserver')
+        #   node.role?('web_server')
+        #   node.roles.include?('web_server')
         #
         class CookbookUsesRoles < Cop
           MSG = 'Cookbook uses roles, which cannot be used in Policyfiles or Effortless Infra'

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

@@ -0,0 +1,57 @@
+# 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 ChefModernize
+        # Use the custom resource language's `action :my_action` blocks instead of creating actions with methods.
+        #
+        # @example
+        #
+        #   # bad
+        #   def action_create
+        #    # :create action code here
+        #   end
+        #
+        #   # good
+        #   action :create do
+        #    # :create action code here
+        #   end
+        #
+        class ActionMethodInResource < Base
+          extend AutoCorrector
+
+          MSG = "Use the custom resource language's `action :my_action` blocks instead of creating actions with methods."
+
+          def_node_search :includes_poise?, '(send nil? :include (const nil? :Poise))'
+
+          def on_def(node)
+            return unless node.method_name.to_s.start_with?('action_') # when we stop support for Ruby < 2.7 the .to_s can go away here
+            return if node.arguments? # if they passed in arguments they may actually need this
+            return if node.parent && includes_poise?(node.parent)
+
+            add_offense(node.loc.expression, message: MSG, severity: :refactor) do |corrector|
+              # @todo when we drop ruby 2.4 support we can convert this to use delete_suffix
+              corrector.replace(node.loc.expression, node.source.gsub("def #{node.method_name}", "action :#{node.method_name.to_s.gsub(/^action_/, '')} do"))
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -56,13 +56,13 @@ module RuboCop
 
           def_node_search :action_methods?, '(send nil? {:actions :allowed_actions} ... )'
 
-          def_node_search :intialize_method, '(def :initialize ... )'
+          def_node_search :initialize_method, '(def :initialize ... )'
 
           def autocorrect(node)
             lambda do |corrector|
               # insert the new allowed_actions call above the initialize method, but not if one already exists (this is sadly common)
               unless action_methods?(processed_source.ast)
-                initialize_node = intialize_method(processed_source.ast).first
+                initialize_node = initialize_method(processed_source.ast).first
                 corrector.insert_before(initialize_node.source_range, "allowed_actions #{node.descendants.first.source}\n\n")
               end
 

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

@@ -0,0 +1,88 @@
+# 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 ChefModernize
+        # Use the cron_d resource that ships with Chef Infra Client 14.4+ instead of manually creating the file with template, file, or cookbook_file resources.
+        #
+        # @example
+        #
+        #   # bad
+        #   template '/etc/cron.d/backup' do
+        #     source 'cron_backup_job.erb'
+        #     owner 'root'
+        #     group 'root'
+        #     mode '644'
+        #   end
+        #
+        #   cookbook_file '/etc/cron.d/backup' do
+        #     owner 'root'
+        #     group 'root'
+        #     mode '644'
+        #   end
+        #
+        #   file '/etc/cron.d/backup' do
+        #     content '*/30 * * * * backup /usr/local/bin/backup_script.sh'
+        #     owner 'root'
+        #     group 'root'
+        #     mode '644'
+        #   end
+        #
+        #   file '/etc/cron.d/blogs' do
+        #     action :delete
+        #   end
+        #
+        #   # good
+        #   cron_d 'backup' do
+        #     minute '1'
+        #     hour '1'
+        #     mailto 'sysadmins@example.com'
+        #     command '/usr/local/bin/backup_script.sh'
+        #   end
+        #
+        #   cron_d 'blogs' do
+        #     action :delete
+        #   end
+        #
+        class CronDFileOrTemplate < Cop
+          extend TargetChefVersion
+
+          minimum_target_chef_version '14.4'
+
+          MSG = 'Use the cron_d resource that ships with Chef Infra Client 14.4+ instead of manually creating the file with template, file, or cookbook_file resources'
+
+          def_node_matcher :file_or_template?, <<-PATTERN
+            (block
+              (send nil? {:template :file :cookbook_file}
+                (str $_))
+              ...
+            )
+          PATTERN
+
+          def on_block(node)
+            file_or_template?(node) do |file_name|
+              return unless file_name.start_with?('/etc/cron.d/')
+              add_offense(node, location: :expression, message: MSG, severity: :refactor)
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -47,13 +47,13 @@ module RuboCop
             (ivasgn {:@action :@default_action} $(...))
           PATTERN
 
-          def_node_search :intialize_method, '(def :initialize ... )'
+          def_node_search :initialize_method, '(def :initialize ... )'
 
           def_node_search :default_action_method?, '(send nil? :default_action ... )'
 
           def on_ivasgn(node)
             action_variable_assignment?(node) do
-              add_offense(node, location: :expression, message: MSG, severity: :refactor) if intialize_method(node.parent.parent)
+              add_offense(node, location: :expression, message: MSG, severity: :refactor) if initialize_method(node.parent.parent)
             end
           end
 
@@ -61,7 +61,7 @@ module RuboCop
             lambda do |corrector|
               # insert the new default_action call above the initialize method, but not if one already exists (this is sadly common)
               unless default_action_method?(processed_source.ast)
-                initialize_node = intialize_method(processed_source.ast).first
+                initialize_node = initialize_method(processed_source.ast).first
                 corrector.insert_before(initialize_node.source_range, "default_action #{node.descendants.first.source}\n\n")
               end
 

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

@@ -19,7 +19,7 @@ module RuboCop
   module Cop
     module Chef
       module ChefModernize
-        # In 2016 with Chef Infra Client 12.5 Custom Resources were introduced as a way of writing reusable resource code that could be shipped in cookbooks. Custom Resources offer many advantages of legacy Definitions including unit testing with ChefSpec, input validation, actions, commmon properties like not_if/only_if, and resource reporting.
+        # In 2016 with Chef Infra Client 12.5 Custom Resources were introduced as a way of writing reusable resource code that could be shipped in cookbooks. Custom Resources offer many advantages of legacy Definitions including unit testing with ChefSpec, input validation, actions, common properties like not_if/only_if, and resource reporting.
         #
         class Definitions < Cop
           include RuboCop::Chef::CookbookHelpers

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

@@ -43,19 +43,19 @@ module RuboCop
 
           def on_ivasgn(node)
             provides_assignment?(node) do
-              add_offense(node, location: :expression, message: MSG, severity: :refactor) if intialize_method(node.parent.parent).any?
+              add_offense(node, location: :expression, message: MSG, severity: :refactor) if initialize_method(node.parent.parent).any?
             end
           end
 
           def_node_search :provides_method?, '(send nil? :provides ... )'
 
-          def_node_search :intialize_method, '(def :initialize ... )'
+          def_node_search :initialize_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
+                initialize_node = initialize_method(processed_source.ast).first
                 corrector.insert_before(initialize_node.source_range, "provides #{node.descendants.first.source}\n\n")
               end
 

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

@@ -48,12 +48,12 @@ module RuboCop
             end
           end
 
-          def_node_search :intialize_method, '(def :initialize ... )'
+          def_node_search :initialize_method, '(def :initialize ... )'
 
           def autocorrect(node)
             lambda do |corrector|
               # insert the new resource_name call above the initialize method
-              initialize_node = intialize_method(processed_source.ast).first
+              initialize_node = initialize_method(processed_source.ast).first
               corrector.insert_before(initialize_node.source_range, "resource_name #{node.descendants.first.source}\n\n")
 
               # remove the variable from the initialize method

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

@@ -19,7 +19,7 @@ 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.
+        # Pass an array of packages to package resources instead of iterating over an array of packages when using multi-package capable package subsystem such as apt, yum, chocolatey, dnf, or zypper. Multi-package installs are faster and simplify logs.
         #
         # @example
         #
@@ -34,7 +34,7 @@ module RuboCop
         #   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.'
+          MSG = 'Pass an array of packages to package resources instead of iterating over an array of packages when using multi-package capable package subsystem such as apt, yum, chocolatey, dnf, or zypper. Multi-package installs are faster and simplify logs.'
           MULTIPACKAGE_PLATS = %w(debian redhat suse amazon fedora scientific oracle rhel ubuntu centos redhat).freeze
 
           def_node_matcher :platform_or_platform_family?, <<-PATTERN
@@ -73,7 +73,7 @@ module RuboCop
                   (lvar _))})
           PATTERN
 
-          # see if all platforms in the when condition are multipackage compliant
+          # see if all platforms in the when condition are multi-package compliant
           def multipackage_platforms?(condition_obj)
             condition_obj.all? do |p|
               MULTIPACKAGE_PLATS.include?(p.value)

data/lib/rubocop/cop/chef/redundant/double_compile_time.rb

@@ -0,0 +1,65 @@
+# 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 ChefRedundantCode
+        # If a resource includes the `compile_time` property there's no need to also use `.run_action(:some_action)` on the resource block
+        #
+        #   # bad
+        #   chef_gem 'deep_merge' do
+        #     action :nothing
+        #     compile_time true
+        #   end.run_action(:install)
+        #
+        #   # good
+        #   chef_gem 'deep_merge' do
+        #     action :install
+        #     compile_time true
+        #   end
+        #
+        class DoubleCompileTime < Base
+          extend RuboCop::Cop::AutoCorrector
+
+          MSG = "If a resource includes the `compile_time` property there's no need to also use `.run_action(:some_action)` on the resource block."
+
+          def_node_matcher :compile_time_and_run_action?, <<-PATTERN
+          (send
+            $(block
+              (send nil? ... )
+              (args)
+              (begin <
+                (send nil? :action (sym $_) )
+                (send nil? :compile_time (true) )
+                ...
+              >)
+            ) :run_action (sym $_) )
+          PATTERN
+
+          def on_send(node)
+            compile_time_and_run_action?(node) do |resource, action, run_action|
+              add_offense(node.loc.selector, message: MSG, severity: :refactor) do |corrector|
+                corrector.replace(node.loc.expression, resource.source.gsub(action.to_s, run_action.to_s))
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/chef/redundant/ohai_attribute_to_string.rb

@@ -45,18 +45,18 @@ module RuboCop
         class OhaiAttributeToString < Cop
           MSG = "This Ohai node attribute is already a string and doesn't need to be converted"
 
-          def_node_matcher :platform_to_s?, <<-PATTERN
+          def_node_matcher :attribute_to_s?, <<-PATTERN
             (send (send (send nil? :node) :[] $(str {"platform" "platform_family" "platform_version" "fqdn" "hostname" "os" "name"}) ) :to_s )
           PATTERN
 
           def on_send(node)
-            platform_to_s?(node) do
+            attribute_to_s?(node) do
               add_offense(node, location: :expression, message: MSG, severity: :refactor)
             end
           end
 
           def autocorrect(node)
-            platform_to_s?(node) do |method|
+            attribute_to_s?(node) do |method|
               lambda do |corrector|
                 corrector.replace(node.loc.expression, "node['#{method.value}']")
               end

data/lib/rubocop/cop/chef/sharing/empty_metadata_field.rb

@@ -31,7 +31,7 @@ module RuboCop
         #   license 'Apache-2.0'
         #
         class EmptyMetadataField < Cop
-          MSG = 'Cookbook metadata.rb contains an field with an empty string.'
+          MSG = 'Cookbook metadata.rb contains a field with an empty string.'
 
           def_node_matcher :field?, '(send nil? _ $str ...)'
 

data/lib/rubocop/cop/chef/sharing/include_property_descriptions.rb

@@ -19,7 +19,7 @@ module RuboCop
   module Cop
     module Chef
       module ChefSharing
-        # Resource properties should include description fields to allow automated documention. Requires Chef Infra Client 13.9 or later.
+        # Resource properties should include description fields to allow automated documentation. Requires Chef Infra Client 13.9 or later.
         #
         # @example
         #
@@ -29,22 +29,22 @@ module RuboCop
         #   # good
         #   property :foo, String, description: "Set the important thing to..."
         #
-        class IncludePropertyDescriptions < Cop
+        class IncludePropertyDescriptions < Base
           extend TargetChefVersion
 
           minimum_target_chef_version '13.9'
 
-          MSG = 'Resource properties should include description fields to allow automated documention. Requires Chef Infra Client 13.9 or later.'
+          MSG = 'Resource properties should include description fields to allow automated documentation. Requires Chef Infra Client 13.9 or later.'
 
           # any method named property being called with a symbol argument and anything else
           def_node_matcher :property?, '(send nil? :property (sym _) ...)'
 
           # hash that contains description in any order (that's the <> bit)
-          def_node_search :description_hash, '(hash <(pair (sym :description) ...) ...>)'
+          def_node_search :description_hash?, '(hash <(pair (sym :description) ...) ...>)'
 
           def on_send(node)
             property?(node) do
-              add_offense(node, location: :expression, message: MSG, severity: :refactor) unless description_hash(processed_source.ast).any?
+              add_offense(node.loc.expression, message: MSG, severity: :refactor) unless description_hash?(node)
             end
           end
         end