cookstyle 6.8.0 → 6.13.3

data/lib/rubocop/cop/chef/modernize/systctl_param_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 sysctl_param resource was renamed to sysctl when it was added to Chef Infra Client 14.0. The new resource name should be used.'.freeze
+          MSG = 'The sysctl_param resource was renamed to sysctl 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 == :sysctl_param

data/lib/rubocop/cop/chef/modernize/unnecessary_mixlib_shellout_require.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
         class UnnecessaryMixlibShelloutRequire < Cop
           include RangeHelp
 
-          MSG = 'Chef Infra Client 12.4+ includes mixlib/shellout automatically in resources and providers.'.freeze
+          MSG = 'Chef Infra Client 12.4+ includes mixlib/shellout automatically in resources and providers.'
 
           def_node_matcher :require_mixlibshellout?, <<-PATTERN
           (send nil? :require ( str "mixlib/shellout"))

data/lib/rubocop/cop/chef/modernize/use_multipackage_installs.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
         #   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.'.freeze
+          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.'
           MULTIPACKAGE_PLATS = %w(debian redhat suse amazon fedora scientific oracle rhel ubuntu centos redhat).freeze
 
           def_node_matcher :platform_or_platform_family?, <<-PATTERN

data/lib/rubocop/cop/chef/modernize/use_require_relative.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
         #   require_relative '../libraries/helpers'
         #
         class UseRequireRelative < Cop
-          MSG = 'Instead of using require with a File.expand_path and __FILE__ use the simpler require_relative method.'.freeze
+          MSG = 'Instead of using require with a File.expand_path and __FILE__ use the simpler require_relative method.'
 
           def_node_matcher :require_with_expand_path?, <<-PATTERN
             (send nil? :require

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Copyright:: 2019-2020, Chef Software Inc.
 # Author:: Tim Smith (<tsmith@chef.io>)
@@ -33,7 +34,7 @@ module RuboCop
 
           minimum_target_chef_version '13.0'
 
-          MSG = 'whyrun_supported? no longer needs to be set to true as it is the default in Chef Infra Client 13+'.freeze
+          MSG = 'whyrun_supported? no longer needs to be set to true as it is the default in Chef Infra Client 13+'
 
           # match on both whyrun_supported? and the typo form why_run_supported?
           def_node_matcher :whyrun_true?, <<-PATTERN

data/lib/rubocop/cop/chef/modernize/windows_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
         class IncludingWindowsDefaultRecipe < Cop
           include RangeHelp
 
-          MSG = 'Do not include the Windows default recipe, which only installs win32 gems already included in Chef Infra Client'.freeze
+          MSG = 'Do not include the Windows default recipe, which only installs win32 gems already included in Chef Infra Client'
 
           def_node_matcher :windows_recipe_usage?, <<-PATTERN
             (send nil? :include_recipe (str {"windows" "windows::default"}))

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Copyright:: 2020, Chef Software, Inc.
 # Author:: Tim Smith (<tsmith@chef.io>)
@@ -42,7 +43,7 @@ module RuboCop
 
           minimum_target_chef_version '15.0'
 
-          MSG = 'Chef Infra Client 15.0 and later includes a windows_uac resource that should be used to set Windows UAC values instead of setting registry keys directly.'.freeze
+          MSG = 'Chef Infra Client 15.0 and later includes a windows_uac resource that should be used to set Windows UAC values instead of setting registry keys directly.'
 
           # non block execute resources
           def on_send(node)

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

data/lib/rubocop/cop/chef/modernize/zipfile_resource.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 the zipfile resource from the zipfile cookbook.'.freeze
+          MSG = 'Use the archive_file resource built into Chef Infra Client 15+ instead of the zipfile resource from the zipfile cookbook.'
 
           def_node_matcher :depends_zipfile?, <<-PATTERN
             (send nil? :depends (str "zipfile"))

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Copyright:: 2019, Chef Software, Inc.
 # Author:: Tim Smith (<tsmith@chef.io>)
@@ -43,7 +44,7 @@ module RuboCop
 
           minimum_target_chef_version '13.3'
 
-          MSG = 'The zypper_repo resource was renamed zypper_repository when it was added to Chef Infra Client 13.3.'.freeze
+          MSG = 'The zypper_repo resource was renamed zypper_repository when it was added to Chef Infra Client 13.3.'
 
           def on_send(node)
             add_offense(node, location: :expression, message: MSG, severity: :refactor) if node.method_name == :zypper_repo

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Copyright:: 2019, Chef Software, Inc.
 # Author:: Tim Smith (<tsmith@chef.io>)
@@ -39,7 +40,7 @@ module RuboCop
           include RuboCop::Chef::CookbookHelpers
           include RangeHelp
 
-          MSG = "There is no need to pass `distribution node['lsb']['codename']` to an apt_repository resource as this is done automatically by the apt_repository resource.".freeze
+          MSG = "There is no need to pass `distribution node['lsb']['codename']` to an apt_repository resource as this is done automatically by the apt_repository resource."
 
           def_node_matcher :default_dist?, <<-PATTERN
             (send nil? :distribution (send (send (send nil? :node) :[] ({sym str} {:lsb "lsb"})) :[] ({sym str} {:codename "codename"})))

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Copyright:: 2019, Chef Software, Inc.
 # Author:: Tim Smith (<tsmith@chef.io>)
@@ -39,7 +40,7 @@ module RuboCop
           include RuboCop::Chef::CookbookHelpers
           include RangeHelp
 
-          MSG = 'There is no need to notify an apt-get update when an apt_repository is created as this is done automatically by the apt_repository resource.'.freeze
+          MSG = 'There is no need to notify an apt-get update when an apt_repository is created as this is done automatically by the apt_repository resource.'
 
           def on_block(node)
             match_property_in_resource?(:apt_repository, 'notifies', node) do |notifies|

data/lib/rubocop/cop/chef/redundant/attribute_metadata.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
           include RangeHelp
           include RuboCop::Chef::AutocorrectHelpers
 
-          MSG = 'The attribute metadata.rb method is not used and is unnecessary in cookbooks.'.freeze
+          MSG = 'The attribute metadata.rb method is not used and is unnecessary in cookbooks.'
 
           def on_send(node)
             add_offense(node, location: :expression, message: MSG, severity: :refactor) if node.method_name == :attribute

data/lib/rubocop/cop/chef/redundant/conflicts_metadata.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 ConflictsMetadata < Cop
           include RangeHelp
 
-          MSG = 'The conflicts metadata.rb method is not used and is unnecessary in cookbooks.'.freeze
+          MSG = 'The conflicts metadata.rb method is not used and is unnecessary in cookbooks.'
 
           def on_send(node)
             add_offense(node, location: :expression, message: MSG, severity: :refactor) if node.method_name == :conflicts

data/lib/rubocop/cop/chef/redundant/custom_resource_with_allowed_actions.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 CustomResourceWithAllowedActions < Cop
           include RangeHelp
 
-          MSG = 'It is not necessary to set `actions` or `allowed_actions` in custom resources as Chef Infra Client determines these automatically from the set of all actions defined in the resource'.freeze
+          MSG = 'It is not necessary to set `actions` or `allowed_actions` in custom resources as Chef Infra Client determines these automatically from the set of all actions defined in the resource'
 
           def_node_matcher :allowed_actions?, <<-PATTERN
             (send nil? {:allowed_actions :actions} ... )

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Copyright:: 2019-2020, Chef Software Inc.
 # Author:: Tim Smith (<tsmith@chef.io>)
@@ -30,7 +31,7 @@ module RuboCop
           include RangeHelp
           include RuboCop::Chef::AutocorrectHelpers
 
-          MSG = 'The grouping metadata.rb method is not used and is unnecessary in cookbooks.'.freeze
+          MSG = 'The grouping metadata.rb method is not used and is unnecessary in cookbooks.'
 
           def on_send(node)
             add_offense(node, location: :expression, message: MSG, severity: :refactor) if node.method_name == :grouping

data/lib/rubocop/cop/chef/redundant/long_description_metadata.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::AutocorrectHelpers
 
-          MSG = 'The long_description metadata.rb method is not used and is unnecessary in cookbooks.'.freeze
+          MSG = 'The long_description metadata.rb method is not used and is unnecessary in cookbooks.'
 
           def on_send(node)
             add_offense(node, location: :expression, message: MSG, severity: :refactor) if node.method_name == :long_description

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

@@ -0,0 +1,61 @@
+# 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
+        # You can pass multiple values to the platform? and platform_family? helpers instead of calling the helpers multiple times.
+        #
+        # @example
+        #
+        #   # bad
+        #   platform?('redhat') || platform?('ubuntu')
+        #   platform_family?('debian') || platform_family?('rhel')
+        #
+        #   # good
+        #   platform?('redhat', 'ubuntu')
+        #   platform_family?('debian', 'rhel')
+        #
+        class MultiplePlatformChecks < Cop
+          MSG = 'You can pass multiple values to the platform? and platform_family? helpers instead of calling the helpers multiple times.'
+
+          def_node_matcher :or_platform_helpers?, <<-PATTERN
+            (or (send nil? ${:platform? :platform_family?} $_ )* )
+          PATTERN
+
+          def on_or(node)
+            or_platform_helpers?(node) do |helpers, _plats|
+              # if the helper types were the same it's an offense, but platform_family?('rhel') || platform?('ubuntu') is legit
+              add_offense(node, location: :expression, message: MSG, severity: :refactor) if helpers.uniq.size == 1
+            end
+          end
+
+          def autocorrect(node)
+            or_platform_helpers?(node) do |type, plats|
+              lambda do |corrector|
+                new_string = "#{type.first}(#{plats.map(&:source).join(', ')})"
+                corrector.replace(node.loc.expression, new_string)
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Copyright:: Copyright 2019-2020, Chef Software Inc.
 # Author:: Tim Smith (<tsmith@chef.io>)
@@ -59,7 +60,7 @@ module RuboCop
         #   property :config_file, String, required: true
         #
         class NamePropertyIsRequired < Cop
-          MSG = 'Resource properties marked as name properties should not also be required properties'.freeze
+          MSG = 'Resource properties marked as name properties should not also be required properties'
 
           # match on a property or attribute that has any name and any type and a hash that
           # contains name_property: true and required: true. These are wrapped in <> which means

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

@@ -0,0 +1,69 @@
+# 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
+        # Many Ohai node attributes are already strings and don't need to be cast to strings again
+        #
+        # @example
+        #
+        #   # bad
+        #   node['platform'].to_s
+        #   node['platform_family'].to_s
+        #   node['platform_version'].to_s
+        #   node['fqdn'].to_s
+        #   node['hostname'].to_s
+        #   node['os'].to_s
+        #   node['name'].to_s
+        #
+        #   # good
+        #   node['platform']
+        #   node['platform_family']
+        #   node['platform_version']
+        #   node['fqdn']
+        #   node['hostname']
+        #   node['os']
+        #   node['name']
+        #
+        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
+            (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
+              add_offense(node, location: :expression, message: MSG, severity: :refactor)
+            end
+          end
+
+          def autocorrect(node)
+            platform_to_s?(node) do |method|
+              lambda do |corrector|
+                corrector.replace(node.loc.expression, "node['#{method.value}']")
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end