cookstyle 6.8.0 → 6.13.3

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

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+#
+# 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 ChefModernize
+        # Use ::File.exist?('/foo/bar') instead of the slower 'test -f /foo/bar' which requires shelling out
+        #
+        # @example
+        #
+        #   # bad
+        #   only_if 'test -f /bin/foo'
+        #
+        #   # good
+        #   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"
+
+          def_node_matcher :resource_conditional?, <<~PATTERN
+          (send nil? {:not_if :only_if} $str )
+          PATTERN
+
+          def on_send(node)
+            resource_conditional?(node) do |conditional|
+              add_offense(node, location: :expression, message: MSG, severity: :refactor) if conditional.value.match?(/^test -[ef] \S*$/)
+            end
+          end
+
+          def autocorrect(node)
+            lambda do |corrector|
+              resource_conditional?(node) do |conditional|
+                new_string = "{ ::File.exist?('#{conditional.value.match(/^test -[ef] (\S*)$/)[1]}') }"
+                corrector.replace(conditional.loc.expression, new_string)
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+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/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,7 +41,7 @@ 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} $(...))

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>)
@@ -23,7 +24,7 @@ module RuboCop
         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"))

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Copyright:: 2019, Chef Software, Inc.
 # Author:: Tim Smith (<tsmith@chef.io>)
@@ -27,7 +28,7 @@ module RuboCop
         class DslIncludeInResource < Cop
           include RangeHelp
 
-          MSG = 'Chef Infra Client 12.4+ includes the Chef::DSL::Recipe in the resource and provider classed by default so there is no need to include this DSL in your resources or providers.'.freeze
+          MSG = 'Chef Infra Client 12.4+ includes the Chef::DSL::Recipe in the resource and provider classed by default so there is no need to include this DSL in your resources or providers.'
 
           def_node_matcher :dsl_include?, <<-PATTERN
           (send nil? :include

data/lib/rubocop/cop/chef/modernize/empty_resource_initialize.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
         class EmptyResourceInitializeMethod < Cop
           include RangeHelp
 
-          MSG = 'There is no need for an empty initialize method in a resource'.freeze
+          MSG = 'There is no need for an empty initialize method in a resource'
 
           def_node_matcher :empty_initialize?, <<-PATTERN
             (def :initialize (args (restarg :args)) (zsuper))

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Copyright:: 2019-2020, Chef Software, Inc.
 # Author:: Tim Smith (<tsmith@chef.io>)
@@ -42,10 +43,10 @@ module RuboCop
         #   end
         #
         class ExecuteAptUpdate < Cop
-          MSG = 'Use the apt_update resource instead of the execute resource to run an apt-get update package cache update'.freeze
+          MSG = 'Use the apt_update resource instead of the execute resource to run an apt-get update package cache update'
 
           def_node_matcher :execute_apt_update?, <<-PATTERN
-            (send nil? :execute (str "apt-get update"))
+            (send nil? :execute (str { "apt-get update" "apt-get update -y" "apt-get -y update" }))
           PATTERN
 
           def_node_matcher :notification_property?, <<-PATTERN

data/lib/rubocop/cop/chef/modernize/execute_sc_exe.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 = 'Chef Infra Client 14.0 and later includes :create, :delete, and :configure actions with the full idempotency of the windows_service resource. See the windows_service documentation at https://docs.chef.io/resource_windows_service.html for additional details on creating services with the windows_service resource'.freeze
+          MSG = 'Chef Infra Client 14.0 and later includes :create, :delete, and :configure actions with the full idempotency of the windows_service resource. See the windows_service documentation at https://docs.chef.io/resource_windows_service.html for additional details on creating services with the windows_service resource'
 
           # non block execute resources
           def on_send(node)

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Copyright:: 2019, Chef Software, Inc.
 # Author:: Tim Smith (<tsmith@chef.io>)
@@ -41,7 +42,7 @@ module RuboCop
 
           minimum_target_chef_version '15.5'
 
-          MSG = 'Chef Infra Client 15.5 and later include a chef_sleep resource that should be used to sleep between executing resources if necessary instead of using the bash or execute resources to run the sleep command.'.freeze
+          MSG = 'Chef Infra Client 15.5 and later include a chef_sleep resource that should be used to sleep between executing resources if necessary instead of using the bash or execute resources to run the sleep command.'
 
           # non block execute resources
           def on_send(node)

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Copyright:: 2020, Chef Software, Inc.
 # Author:: Tim Smith (<tsmith@chef.io>)
@@ -41,7 +42,7 @@ module RuboCop
 
           minimum_target_chef_version '14.0'
 
-          MSG = 'Chef Infra Client 14.0 and later includes a sysctl resource that should be used to idempotently load sysctl values instead of templating files and using execute to load them.'.freeze
+          MSG = 'Chef Infra Client 14.0 and later includes a sysctl resource that should be used to idempotently load sysctl values instead of templating files and using execute to load them.'
 
           # non block execute resources
           def on_send(node)

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Copyright:: 2019, Chef Software, Inc.
 # Author:: Tim Smith (<tsmith@chef.io>)
@@ -42,7 +43,7 @@ module RuboCop
 
           minimum_target_chef_version '14.6'
 
-          MSG = 'Use the timezone resource included in Chef Infra Client 14.6+ instead of shelling out to tzutil'.freeze
+          MSG = 'Use the timezone resource included in Chef Infra Client 14.6+ instead of shelling out to tzutil'
 
           def_node_matcher :execute_resource?, <<-PATTERN
             (send nil? :execute $str)

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Copyright:: 2016-2019, Chef Software, Inc.
 # Author:: Tim Smith (<tsmith@chef.io>)
@@ -27,7 +28,7 @@ module RuboCop
         #   # ~FC013
         #
         class FoodcriticComments < Cop
-          MSG = 'Remove legacy code comments that disable Foodcritic rules'.freeze
+          MSG = 'Remove legacy code comments that disable Foodcritic rules'
 
           def investigate(processed_source)
             return unless processed_source.ast

data/lib/rubocop/cop/chef/modernize/if_provides_default_action.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
         #   default_action :foo
         #
         class IfProvidesDefaultAction < Cop
-          MSG = 'if defined?(default_action) is no longer necessary in Chef Resources as default_action shipped in Chef 10.8.'.freeze
+          MSG = 'if defined?(default_action) is no longer necessary in Chef Resources as default_action shipped in Chef 10.8.'
 
           def on_defined?(node)
             return unless node.arguments.first == s(:send, nil, :default_action)