cookstyle 6.11.4 → 6.15.5

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Copyright:: Copyright 2019, Chef Software Inc.
 # Author:: Tim Smith (<tsmith@chef.io>)
@@ -26,7 +27,7 @@ module RuboCop
         #   node.policy_group == "foo"
         #
         class CookbookUsesPolicygroups < Cop
-          MSG = 'Cookbook uses Policy Groups, which cannot be used with Effortless Infra'.freeze
+          MSG = 'Cookbook uses Policy Groups, which cannot be used with Effortless Infra'
 
           def on_send(node)
             if node.method_name == :policy_group && node.receiver && node.receiver.send_type? && node.receiver.method_name == :node

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Copyright:: Copyright 2019, Chef Software Inc.
 # Author:: Tim Smith (<tsmith@chef.io>)
@@ -18,16 +19,16 @@ 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'.freeze
+          MSG = 'Cookbook uses roles, which cannot be used in Policyfiles or Effortless Infra'
 
           def on_send(node)
             if %i(role? roles).include?(node.method_name) && node.receiver && node.receiver.send_type? && node.receiver.method_name == :node

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Copyright:: Copyright 2019, Chef Software Inc.
 # Author:: Tim Smith (<tsmith@chef.io>)
@@ -27,7 +28,7 @@ module RuboCop
         #   search(:node, 'role:bar')
         #
         class SearchForEnvironmentsOrRoles < Cop
-          MSG = 'Cookbook uses search with a node query that looks for a role or environment'.freeze
+          MSG = 'Cookbook uses search with a node query that looks for a role or environment'
 
           def on_send(node)
             if node.method_name == :search && node.arguments[1]&.value&.match?(/chef_environment|role/)

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Copyright:: Copyright 2019, Chef Software Inc.
 # Author:: Tim Smith (<tsmith@chef.io>)
@@ -26,7 +27,7 @@ module RuboCop
         #   search(:node, 'run_list:recipe\[bacula\:\:server\]')
         #
         class CookbookUsesSearch < Cop
-          MSG = 'Cookbook uses search, which cannot be used in the Effortless Infra pattern'.freeze
+          MSG = 'Cookbook uses search, which cannot be used in the Effortless Infra pattern'
 
           def on_send(node)
             add_offense(node, location: :expression, message: MSG, severity: :refactor) if node.method_name == :search

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Copyright:: 2019, Chef Software Inc.
 # Author:: Tim Smith (<tsmith@chef.io>)
@@ -40,7 +41,7 @@ module RuboCop
         class AllowedActionsFromInitialize < Cop
           include RangeHelp
 
-          MSG = 'The allowed actions of a resource can be set with the "allowed_actions" helper instead of using the initialize method.'.freeze
+          MSG = 'The allowed actions of a resource can be set with the "allowed_actions" helper instead of using the initialize method.'
 
           def on_def(node)
             return unless node.method_name == :initialize
@@ -55,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/apt_default_recipe.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Copyright:: 2019, Chef Software, Inc.
 # Author:: Tim Smith (<tsmith@chef.io>)
@@ -34,7 +35,7 @@ module RuboCop
 
           minimum_target_chef_version '12.7'
 
-          MSG = 'Do not include the Apt default recipe to update package cache. Instead use the apt_update resource, which is built into Chef Infra Client 12.7 and later.'.freeze
+          MSG = 'Do not include the Apt default recipe to update package cache. Instead use the apt_update resource, which is built into Chef Infra Client 12.7 and later.'
 
           def_node_matcher :apt_recipe_usage?, <<-PATTERN
             (send nil? :include_recipe (str {"apt" "apt::default"}))

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Copyright:: 2019, Chef Software, Inc.
 # Author:: Tim Smith (<tsmith@chef.io>)
@@ -34,7 +35,7 @@ module RuboCop
         #   source 'https://supermarket.chef.io'
         #
         class LegacyBerksfileSource < Cop
-          MSG = 'Do not use legacy Berksfile community sources. Use Chef Supermarket instead.'.freeze
+          MSG = 'Do not use legacy Berksfile community sources. Use Chef Supermarket instead.'
 
           def_node_matcher :berksfile_site?, <<-PATTERN
             (send nil? :site (:sym _))

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Copyright:: 2019, Chef Software, Inc.
 # Author:: Tim Smith (<tsmith@chef.io>)
@@ -31,7 +32,7 @@ module RuboCop
         #   build_essential 'install compilation tools'
         #
         class UseBuildEssentialResource < Cop
-          MSG = 'Use the build_essential resource instead of the legacy build-essential recipe. This resource ships in the build-essential cookbook v5.0+ and is built into Chef Infra Client 14+'.freeze
+          MSG = 'Use the build_essential resource instead of the legacy build-essential recipe. This resource ships in the build-essential cookbook v5.0+ and is built into Chef Infra Client 14+'
 
           def_node_matcher :build_essential_recipe_usage?, <<-PATTERN
             (send nil? :include_recipe (str {"build-essential" "build-essential::default"}))

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Copyright:: 2019, Chef Software, Inc.
 # Author:: Tim Smith (<tsmith@chef.io>)
@@ -37,7 +38,7 @@ module RuboCop
 
           minimum_target_chef_version '14.0'
 
-          MSG = "Don't depend on cookbooks made obsolete by Chef Infra Client 14+. These community cookbooks contain resources that are now included in Chef Infra Client itself.".freeze
+          MSG = "Don't depend on cookbooks made obsolete by Chef Infra Client 14+. These community cookbooks contain resources that are now included in Chef Infra Client itself."
 
           def_node_matcher :legacy_depends?, <<-PATTERN
             (send nil? :depends (str {"build-essential" "chef_handler" "chef_hostname" "dmg" "mac_os_x" "swap" "sysctl"}) ... )

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Copyright:: 2019, Chef Software Inc.
 # Author:: Tim Smith (<tsmith@chef.io>)
@@ -30,7 +31,7 @@ module RuboCop
           include RangeHelp
           include RuboCop::Chef::CookbookHelpers
 
-          MSG = 'The nokogiri gem ships in Chef Infra Client 12+ and does not need to be installed before being used.'.freeze
+          MSG = 'The nokogiri gem ships in Chef Infra Client 12+ and does not need to be installed before being used.'
 
           def_node_matcher :nokogiri_install?, <<-PATTERN
             (send nil? :chef_gem (str "nokogiri"))

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Copyright:: 2020, Chef Software, Inc.
 # Author:: Tim Smith (<tsmith@chef.io>)
@@ -33,7 +34,7 @@ module RuboCop
         #   end
         #
         class ResourceForcingCompileTime < Cop
-          MSG = "Set 'compile_time true' in resources when available instead of forcing resources to run at compile time by setting an action on the block.".freeze
+          MSG = "Set 'compile_time true' in resources when available instead of forcing resources to run at compile time by setting an action on the block."
 
           def_node_matcher :compile_time_resource?, <<-PATTERN
             (send (block (send nil? {:build_essential :chef_gem :hostname :ohai_hint} (...)) (args) (...)) $:run_action (sym ...))

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Copyright:: 2019, Chef Software, Inc.
 # Author:: Tim Smith (<tsmith@chef.io>)
@@ -29,7 +30,7 @@ module RuboCop
         #   only_if { ::File.exist?('bin/foo') }
         #
         class ConditionalUsingTest < Cop
-          MSG = "Use ::File.exist?('/foo/bar') instead of the slower 'test -f /foo/bar' which requires shelling out".freeze
+          MSG = "Use ::File.exist?('/foo/bar') instead of the slower 'test -f /foo/bar' which requires shelling out"
 
           def_node_matcher :resource_conditional?, <<~PATTERN
           (send nil? {:not_if :only_if} $str )

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/cron_manage_resource.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Copyright:: 2019, Chef Software, Inc.
 # Author:: Tim Smith (<tsmith@chef.io>)
@@ -33,7 +34,7 @@ module RuboCop
 
           minimum_target_chef_version '14.4'
 
-          MSG = 'The cron_manage resource was renamed to cron_access in the 6.1 release of the cron cookbook and later shipped in Chef Infra Client 14.4. The new resource name should be used.'.freeze
+          MSG = 'The cron_manage resource was renamed to cron_access in the 6.1 release of the cron cookbook and later shipped in Chef Infra Client 14.4. The new resource name should be used.'
 
           def on_send(node)
             add_offense(node, location: :expression, message: MSG, severity: :refactor) if node.method_name == :cron_manage

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Copyright:: 2020, Chef Software, Inc.
 # Author:: Tim Smith (<tsmith@chef.io>)
@@ -31,7 +32,7 @@ module RuboCop
         #   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
+          MSG = 'Use the `data_bag_item` helper instead of `Chef::DataBagItem.load` or `Chef::EncryptedDataBagItem.load`.'
 
           def_node_matcher :data_bag_class_load?, <<-PATTERN
           (send

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Copyright:: 2019-2020, Chef Software Inc.
 # Author:: Tim Smith (<tsmith@chef.io>)
@@ -40,19 +41,19 @@ module RuboCop
         class DefaultActionFromInitialize < Cop
           include RangeHelp
 
-          MSG = 'The default action of a resource can be set with the "default_action" helper instead of using the initialize method.'.freeze
+          MSG = 'The default action of a resource can be set with the "default_action" helper instead of using the initialize method.'
 
           def_node_matcher :action_variable_assignment?, <<-PATTERN
             (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
 
@@ -60,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/defines_chefspec_matchers.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Copyright:: 2019, Chef Software, Inc.
 # Author:: Tim Smith (<tsmith@chef.io>)
@@ -32,7 +33,7 @@ module RuboCop
         class DefinesChefSpecMatchers < Cop
           include RangeHelp
 
-          MSG = 'ChefSpec matchers are now auto generated by ChefSpec 7.1+ and do not need to be defined in a cookbook'.freeze
+          MSG = 'ChefSpec matchers are now auto generated by ChefSpec 7.1+ and do not need to be defined in a cookbook'
 
           def_node_matcher :chefspec_matcher?, <<-PATTERN
             (if ( :defined? (const nil? :ChefSpec)) ... )

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Copyright:: 2019, Chef Software, Inc.
 # Author:: Tim Smith (<tsmith@chef.io>)
@@ -18,12 +19,12 @@ 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
 
-          MSG = 'Legacy Chef Infra definitions should be rewritten as custom resources to take full advantage of the Chef Infra feature set.'.freeze
+          MSG = 'Legacy Chef Infra definitions should be rewritten as custom resources to take full advantage of the Chef Infra feature set.'
 
           def on_block(node)
             add_offense(node, location: :expression, message: MSG, severity: :refactor) if node.respond_to?(:method_name) && node.method_name == :define

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Copyright:: 2019-2020, Chef Software, Inc.
 # Author:: Tim Smith (<tsmith@chef.io>)
@@ -31,7 +32,7 @@ module RuboCop
 
           minimum_target_chef_version '13.3'
 
-          MSG = "Don't depend on the zypper cookbook as the zypper_repository resource is built into Chef Infra Client 13.3+".freeze
+          MSG = "Don't depend on the zypper cookbook as the zypper_repository resource is built into Chef Infra Client 13.3+"
 
           def_node_matcher :zypper_depends?, <<-PATTERN
             (send nil? :depends (str "zypper"))