cookstyle 6.8.0 → 6.13.3

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Copyright:: 2019-2020, Chef Software Inc.
 # Author:: Tim Smith (<tsmith@chef.io>)
@@ -32,7 +33,7 @@ module RuboCop
         class IncludingMixinShelloutInResources < Cop
           include RangeHelp
 
-          MSG = 'There is no need to include Chef::Mixin::ShellOut or Chef::Mixin::PowershellOut in resources or providers as this is already done by Chef Infra Client 12.4+.'.freeze
+          MSG = 'There is no need to include Chef::Mixin::ShellOut or Chef::Mixin::PowershellOut in resources or providers as this is already done by Chef Infra Client 12.4+.'
 
           def_node_matcher :include_shellout?, <<-PATTERN
             (send nil? :include (const (const (const nil? :Chef) :Mixin) {:ShellOut :PowershellOut}))

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Copyright:: 2019-2020, Chef Software Inc.
 # Author:: Tim Smith (<tsmith@chef.io>)
@@ -38,7 +39,7 @@ module RuboCop
 
           minimum_target_chef_version '15.0'
 
-          MSG = 'Use the archive_file resource built into Chef Infra Client 15+ instead of the libarchive file resource'.freeze
+          MSG = 'Use the archive_file resource built into Chef Infra Client 15+ instead of the libarchive file resource'
 
           def_node_matcher :notification_property?, <<-PATTERN
             (send nil? {:notifies :subscribes} (sym _) $(...) (sym _))

data/lib/rubocop/cop/chef/modernize/macos_user_defaults.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
 
           minimum_target_chef_version '14.0'
 
-          MSG = 'The mac_os_x_userdefaults resource was renamed to macos_userdefaults when it was added to Chef Infra Client 14.0. The new resource name should be used.'.freeze
+          MSG = 'The mac_os_x_userdefaults resource was renamed to macos_userdefaults when it was added to Chef Infra Client 14.0. The new resource name should be used.'
 
           def on_send(node)
             add_offense(node, location: :expression, message: MSG, severity: :refactor) if node.method_name == :mac_os_x_userdefaults

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Copyright:: 2019, Chef Software, Inc.
 # Author:: Tim Smith (<tsmith@chef.io>)
@@ -28,7 +29,7 @@ module RuboCop
         class MinitestHandlerUsage < Cop
           include RangeHelp
 
-          MSG = 'Use Chef InSpec for testing instead of the Minitest Handler cookbook pattern.'.freeze
+          MSG = 'Use Chef InSpec for testing instead of the Minitest Handler cookbook pattern.'
 
           def_node_matcher :minitest_depends?, <<-PATTERN
             (send nil? :depends (str "minitest-handler"))

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Copyright:: 2020, Chef Software, Inc.
 # Author:: Tim Smith (<tsmith@chef.io>)
@@ -27,19 +28,21 @@ module RuboCop
         #   ::File.open('/proc/1/comm').chomp == 'systemd'
         #   File.open('/proc/1/comm').gets.chomp == 'systemd'
         #   File.open('/proc/1/comm').chomp == 'systemd'
-        #   File.exist?('/proc/1/comm') && File.open('/proc/1/comm').chomp == 'systemd'
-        #
         #   IO.read('/proc/1/comm').chomp == 'systemd'
         #   IO.read('/proc/1/comm').gets.chomp == 'systemd'
         #   ::IO.read('/proc/1/comm').chomp == 'systemd'
         #   ::IO.read('/proc/1/comm').gets.chomp == 'systemd'
         #   File.exist?('/proc/1/comm') && File.open('/proc/1/comm').chomp == 'systemd'
+        #   only_if 'test -f /bin/systemctl && /bin/systemctl'
         #
         #   # good
         #   node['init_package'] == 'systemd'
+        #   only_if { node['init_package'] == 'systemd' }
         #
-        class NodeInitPackage < Cop
-          MSG = "Use node['init_package'] to check for systemd instead of reading the contents of '/proc/1/comm'".freeze
+        class NodeInitPackage < Base
+          extend RuboCop::Cop::AutoCorrector
+
+          MSG = "Use node['init_package'] to check for systemd instead of reading the contents of '/proc/1/comm'"
 
           def_node_matcher :file_reads_proc_1_comm?, <<-PATTERN
             (send (const {(cbase) nil?} {:File :IO}) {:open :read} (str "/proc/1/comm"))
@@ -58,18 +61,24 @@ module RuboCop
                 :== (str "systemd"))
           PATTERN
 
+          def_node_matcher :file_systemd_conditional?, <<~PATTERN
+          (send nil? {:not_if :only_if} $(str "test -f /bin/systemctl && /bin/systemctl"))
+          PATTERN
+
           def on_send(node)
             compare_init_system?(node) do
               # if there's a ::File.exist?('/proc/1/comm') check first we want to match that as well
               node = node.parent if node.parent&.and_type? && proc_1_comm_exists?(node.parent.conditions.first)
 
-              add_offense(node, location: :expression, message: MSG, severity: :refactor)
+              add_offense(node.loc.expression, message: MSG, severity: :refactor) do |corrector|
+                corrector.replace(node, "node['init_package'] == 'systemd'")
+              end
             end
-          end
 
-          def autocorrect(node)
-            lambda do |corrector|
-              corrector.replace(node.loc.expression, "node['init_package'] == 'systemd'")
+            file_systemd_conditional?(node) do |conditional|
+              add_offense(node.loc.expression, message: MSG, severity: :refactor) do |corrector|
+                corrector.replace(conditional.loc.expression, "{ node['init_package'] == 'systemd' }")
+              end
             end
           end
         end

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Copyright:: 2020, Chef Software, Inc.
 # Author:: Tim Smith (<tsmith@chef.io>)
@@ -29,7 +30,7 @@ module RuboCop
         #   node.role?('foo')
         #
         class NodeRolesInclude < Cop
-          MSG = "Use `node.role?('foo')` to check if a node includes a role instead of `node['roles'].include?('foo')`.".freeze
+          MSG = "Use `node.role?('foo')` to check if a node includes a role instead of `node['roles'].include?('foo')`."
 
           def_node_matcher :node_role_include?, <<-PATTERN
           (send

data/lib/rubocop/cop/chef/modernize/ohai_default_recipe.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
         #   include_recipe 'ohai'
         #
         class IncludingOhaiDefaultRecipe < Cop
-          MSG = "Use the ohai_plugin resource to ship custom Ohai plugins instead of using the ohai::default recipe. If you're not shipping custom Ohai plugins, then you can remove this recipe entirely".freeze
+          MSG = "Use the ohai_plugin resource to ship custom Ohai plugins instead of using the ohai::default recipe. If you're not shipping custom Ohai plugins, then you can remove this recipe entirely"
 
           def_node_matcher :ohai_recipe_usage?, <<-PATTERN
             (send nil? :include_recipe (str {"ohai" "ohai::default"}))

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Copyright:: 2019, Chef Software, Inc.
 # Author:: Tim Smith (<tsmith@chef.io>)
@@ -36,7 +37,7 @@ module RuboCop
 
           minimum_target_chef_version '14.0'
 
-          MSG = 'The openssl_rsa_key resource was renamed to openssl_rsa_private_key in Chef Infra Client 14.0. The new resource name should be used.'.freeze
+          MSG = 'The openssl_rsa_key resource was renamed to openssl_rsa_private_key in Chef Infra Client 14.0. The new resource name should be used.'
 
           def on_send(node)
             add_offense(node, location: :expression, message: MSG, severity: :refactor) if node.method_name == :openssl_rsa_key

data/lib/rubocop/cop/chef/modernize/openssl_x509_resource.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.4'
 
-          MSG = 'The openssl_x509 resource was renamed to openssl_x509_certificate in Chef Infra Client 14.4. The new resource name should be used.'.freeze
+          MSG = 'The openssl_x509 resource was renamed to openssl_x509_certificate 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 == :openssl_x509

data/lib/rubocop/cop/chef/modernize/osx_config_profile_resource.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
         #   end
         #
         class OsxConfigProfileResource < Cop
-          MSG = 'The osx_config_profile resource was renamed to osx_profile. The new resource name should be used.'.freeze
+          MSG = 'The osx_config_profile resource was renamed to osx_profile. The new resource name should be used.'
 
           def on_send(node)
             add_offense(node, location: :expression, message: MSG, severity: :refactor) if node.method_name == :osx_config_profile

data/lib/rubocop/cop/chef/modernize/powershell_expand_archive.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 '15.0'
 
-          MSG = 'Use the archive_file resource built into Chef Infra Client 15+ instead of using Expand-Archive in a powershell_script resource'.freeze
+          MSG = 'Use the archive_file resource built into Chef Infra Client 15+ instead of using Expand-Archive in a powershell_script resource'
 
           def on_block(node)
             match_property_in_resource?(:powershell_script, 'code', node) do |code_property|

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Copyright:: 2019-2020, Chef Software, Inc.
 # Author:: Tim Smith (<tsmith@chef.io>)
@@ -49,7 +50,7 @@ module RuboCop
 
           minimum_target_chef_version '13.0'
 
-          MSG = 'PowerShell is already set as the default guard interpreter for `powershell_script` and `batch` resources in Chef Infra Client 13 and later and does not need to be specified.'.freeze
+          MSG = 'PowerShell is already set as the default guard interpreter for `powershell_script` and `batch` resources in Chef Infra Client 13 and later and does not need to be specified.'
 
           def on_block(node)
             match_property_in_resource?(%i(powershell_script batch), 'guard_interpreter', node) do |interpreter|

data/lib/rubocop/cop/chef/modernize/powershell_install_package.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 '12.16'
 
-          MSG = 'Use the powershell_package resource built into Chef Infra Client 12.16+ instead of using Install-Package in a powershell_script resource'.freeze
+          MSG = 'Use the powershell_package resource built into Chef Infra Client 12.16+ instead of using Install-Package in a powershell_script resource'
 
           def on_block(node)
             match_property_in_resource?(:powershell_script, 'code', node) do |code_property|

data/lib/rubocop/cop/chef/modernize/powershell_install_windowsfeature.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
 
           minimum_target_chef_version '14.0'
 
-          MSG = 'Use the windows_feature resource built into Chef Infra Client 14+ instead of using Install-WindowsFeature or Add-WindowsFeature in a powershell_script resource'.freeze
+          MSG = 'Use the windows_feature resource built into Chef Infra Client 14+ instead of using Install-WindowsFeature or Add-WindowsFeature in a powershell_script resource'
 
           def on_block(node)
             match_property_in_resource?(:powershell_script, 'code', node) do |code_property|

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Copyright:: Copyright 2019, Chef Software Inc.
 # Author:: Tim Smith (<tsmith@chef.io>)
@@ -29,7 +30,7 @@ module RuboCop
         #   property :bob, String, name_property: true
         #
         class PropertyWithNameAttribute < Cop
-          MSG = 'Resource property sets name_attribute instead of name_property'.freeze
+          MSG = 'Resource property sets name_attribute instead of name_property'
 
           # match on a property that has any name and any type and a hash that
           # contains name_attribute true. The hash pairs are wrapped in

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Copyright:: 2020, Chef Software Inc.
 # Author:: Tim Smith (<tsmith@chef.io>)
@@ -34,7 +35,7 @@ module RuboCop
         class ProvidesFromInitialize < Cop
           include RangeHelp
 
-          MSG = 'Provides should be set using the `provides` resource DSL method instead of instead of setting @provides in the initialize method.'.freeze
+          MSG = 'Provides should be set using the `provides` resource DSL method instead of instead of setting @provides in the initialize method.'
 
           def_node_matcher :provides_assignment?, <<-PATTERN
             (ivasgn :@provides $(sym ...))

data/lib/rubocop/cop/chef/modernize/resource_name_initializer.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
         class ResourceNameFromInitialize < Cop
           include RangeHelp
 
-          MSG = 'The name of a resource can be set with the "resource_name" helper instead of using the initialize method.'.freeze
+          MSG = 'The name of a resource can be set with the "resource_name" helper instead of using the initialize method.'
 
           def on_def(node)
             return unless node.method_name == :initialize

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Copyright:: 2019, Chef Software, Inc.
 # Author:: Tim Smith (<tsmith@chef.io>)
@@ -38,7 +39,7 @@ module RuboCop
         #   property :severity, String
         #
         class SetOrReturnInResources < Cop
-          MSG = 'Do not use set_or_return within a method to define a property for a resource. Use the property method instead, which supports validation, reporting, and documentation functionality'.freeze
+          MSG = 'Do not use set_or_return within a method to define a property for a resource. Use the property method instead, which supports validation, reporting, and documentation functionality'
 
           def on_send(node)
             if node.method_name == :set_or_return

data/lib/rubocop/cop/chef/modernize/resource_with_attributes.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
         #   end
         #
         class CustomResourceWithAttributes < Cop
-          MSG = 'Custom Resources should contain properties not attributes'.freeze
+          MSG = 'Custom Resources should contain properties not attributes'
 
           def_node_matcher :attribute?, <<-PATTERN
             (send nil? $:attribute ... )

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Copyright:: 2020, Chef Software, Inc.
 # Author:: Tim Smith (<tsmith@chef.io>)
@@ -47,7 +48,7 @@ module RuboCop
 
           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
+          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.'
 
           def_node_matcher :compile_time_method_defined?, <<-PATTERN
           (if

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Copyright:: 2019, Chef Software, Inc.
 # Author:: Tim Smith (<tsmith@chef.io>)
@@ -38,7 +39,7 @@ module RuboCop
 
           minimum_target_chef_version '12.15'
 
-          MSG = 'It is no longer necessary to use respond_to? or if_defined? in metadata.rb in Chef Infra Client 12.15 and later'.freeze
+          MSG = 'It is no longer necessary to use respond_to? or if_defined? in metadata.rb in Chef Infra Client 12.15 and later'
 
           def on_if(node)
             if_respond_to?(node) do

data/lib/rubocop/cop/chef/modernize/respond_to_provides.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
         #   provides :foo
         #
         class RespondToProvides < Cop
-          MSG = 'Using `respond_to?(:provides)` or `if defined? 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+.'
 
           def on_if(node)
             if_respond_to_provides?(node) do

data/lib/rubocop/cop/chef/modernize/respond_to_resource_name.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
         #   resource_name :foo
         #
         class RespondToResourceName < Cop
-          MSG = 'respond_to?(:resource_name) in resources is no longer necessary in Chef Infra Client 12.5+'.freeze
+          MSG = 'respond_to?(:resource_name) in resources is no longer necessary in Chef Infra Client 12.5+'
 
           def on_if(node)
             if_respond_to_resource_name?(node) do

data/lib/rubocop/cop/chef/modernize/sc_windows_resource.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 without the need for the sc cookbook dependency. See the windows_service documentation at https://docs.chef.io/resource_windows_service.html for additional details.'.freeze
+          MSG = 'Chef Infra Client 14.0 and later includes :create, :delete, and :configure actions without the need for the sc cookbook dependency. See the windows_service documentation at https://docs.chef.io/resource_windows_service.html for additional details.'
 
           def on_send(node)
             add_offense(node, location: :expression, message: MSG, severity: :refactor) if node.method_name == :sc_windows

data/lib/rubocop/cop/chef/modernize/seven_zip_archive.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 '15.0'
 
-          MSG = 'Use the archive_file resource built into Chef Infra Client 15+ instead of the seven_zip_archive'.freeze
+          MSG = 'Use the archive_file resource built into Chef Infra Client 15+ instead of the seven_zip_archive'
 
           def on_send(node)
             add_offense(node, location: :expression, message: MSG, severity: :refactor) if node.method_name == :seven_zip_archive

data/lib/rubocop/cop/chef/modernize/shell_out_helper.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.11'
 
-          MSG = "Use the built-in `shell_out` helper available in Chef Infra Client 12.11+ instead of calling `Mixlib::ShellOut.new('foo').run_command`.".freeze
+          MSG = "Use the built-in `shell_out` helper available in Chef Infra Client 12.11+ instead of calling `Mixlib::ShellOut.new('foo').run_command`."
 
           def_node_matcher :mixlib_shellout_run_cmd?, <<-PATTERN
           (send

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Copyright:: 2019, Chef Software, Inc.
 # Author:: Tim Smith (<tsmith@chef.io>)
@@ -35,7 +36,7 @@ module RuboCop
         class ShellOutToChocolatey < Cop
           include RuboCop::Chef::CookbookHelpers
 
-          MSG = 'Use the Chocolatey resources built into Chef Infra Client instead of shelling out to the choco command'.freeze
+          MSG = 'Use the Chocolatey resources built into Chef Infra Client instead of shelling out to the choco command'
 
           def on_block(node)
             match_property_in_resource?(:powershell_script, 'code', node) do |code_property|

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Copyright:: 2020, Chef Software Inc.
 # Author:: Tim Smith (<tsmith@chef.io>)
@@ -43,7 +44,7 @@ module RuboCop
           include RangeHelp
           include RuboCop::Chef::CookbookHelpers
 
-          MSG = 'The apt_repository resource allows setting up PPAs without using the full URL to ppa.launchpad.net.'.freeze
+          MSG = 'The apt_repository resource allows setting up PPAs without using the full URL to ppa.launchpad.net.'
 
           def on_block(node)
             match_property_in_resource?(:apt_repository, 'uri', node) do |uri|