cookstyle-ng 8.0.0

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

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+#
+# Copyright:: 2019, Chef Software Inc.
+# Author:: Tim Smith (<tsmith84@gmail.com>)
+#
+# 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 Modernize
+        # The nokogiri gem ships in Chef Infra Client 12+ and does not need to be installed before being used
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   chef_gem 'nokogiri'
+        #
+        class ChefGemNokogiri < Base
+          extend AutoCorrector
+          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.'
+          RESTRICT_ON_SEND = [:chef_gem].freeze
+
+          def_node_matcher :nokogiri_install?, <<-PATTERN
+            (send nil? :chef_gem (str "nokogiri"))
+          PATTERN
+
+          def on_block(node)
+            match_property_in_resource?(:chef_gem, 'package_name', node) do |pkg_name|
+              return unless pkg_name.arguments&.first&.str_content == 'nokogiri'
+              add_offense(node, severity: :refactor) do |corrector|
+                node = node.parent if node.parent&.block_type? # make sure we get the whole block not just the method in the block
+                corrector.remove(range_with_surrounding_space(range: node.loc.expression, side: :left))
+              end
+            end
+          end
+
+          def on_send(node)
+            nokogiri_install?(node) do
+              add_offense(node, severity: :refactor) do |corrector|
+                node = node.parent if node.parent&.block_type? # make sure we get the whole block not just the method in the block
+                corrector.remove(range_with_surrounding_space(range: node.loc.expression, side: :left))
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+#
+# Copyright:: 2021, Chef Software, Inc.
+# Author:: Tim Smith (<tsmith84@gmail.com>)
+#
+# 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 Modernize
+        # In Chef Infra Client 12.9 and later it is no longer necessary to call the class_eval method on the action class block.
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   action_class.class_eval do
+        #     foo
+        #   end
+        #
+        #   ### correct
+        #   action_class do
+        #     foo
+        #   end
+        #
+        class ClassEvalActionClass < Base
+          extend TargetChefVersion
+          extend AutoCorrector
+
+          minimum_target_chef_version '12.9'
+
+          MSG = 'In Chef Infra Client 12.9 and later it is no longer necessary to call the class_eval method on the action class block.'
+
+          def_node_matcher :class_eval_action_class?, <<-PATTERN
+            (block
+              (send
+                (send nil? :action_class) :class_eval)
+              (args)
+              ... )
+          PATTERN
+
+          def on_block(node)
+            class_eval_action_class?(node) do
+              add_offense(node, severity: :refactor) do |corrector|
+                corrector.replace(node, node.source.gsub('.class_eval', ''))
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+#
+# Copyright:: 2020, Chef Software, Inc.
+# Author:: Tim Smith (<tsmith84@gmail.com>)
+#
+# 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 Modernize
+        # The hostname, build_essential, chef_gem, and ohai_hint resources include 'compile_time' properties, which should be used to force the resources to run at compile time by setting `compile_time true`.
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   build_essential 'install build tools' do
+        #    action :nothing
+        #   end.run_action(:install)
+        #
+        #   ### correct
+        #   build_essential 'install build tools' do
+        #    compile_time true
+        #   end
+        #
+        class ResourceForcingCompileTime < Base
+          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."
+          RESTRICT_ON_SEND = [:run_action].freeze
+
+          def_node_matcher :compile_time_resource?, <<-PATTERN
+            (send (block (send nil? {:build_essential :chef_gem :hostname :ohai_hint} (...)) (args) (...)) $:run_action (sym ...))
+          PATTERN
+
+          def on_send(node)
+            compile_time_resource?(node) do
+              add_offense(node, severity: :refactor)
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+#
+# Copyright:: 2019, Chef Software, Inc.
+# Author:: Tim Smith (<tsmith84@gmail.com>)
+#
+# 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 Modernize
+        # Use ::File.exist?('/foo/bar') instead of the slower 'test -f /foo/bar' which requires shelling out
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   only_if 'test -f /bin/foo'
+        #
+        #   ### correct
+        #   only_if { ::File.exist?('bin/foo') }
+        #
+        class ConditionalUsingTest < Base
+          extend AutoCorrector
+
+          MSG = "Use ::File.exist?('/foo/bar') instead of the slower 'test -f /foo/bar' which requires shelling out"
+          RESTRICT_ON_SEND = [:not_if, :only_if].freeze
+
+          def_node_matcher :resource_conditional?, <<~PATTERN
+            (send nil? {:not_if :only_if} $str )
+          PATTERN
+
+          def on_send(node)
+            resource_conditional?(node) do |conditional|
+              return unless conditional.value.match?(/^test -[ef] \S*$/)
+              add_offense(node, severity: :refactor) do |corrector|
+                new_string = "{ ::File.exist?('#{conditional.value.match(/^test -[ef] (\S*)$/)[1]}') }"
+                corrector.replace(conditional, 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,121 @@
+# frozen_string_literal: true
+#
+# Copyright:: 2020-2022, Chef Software, Inc.
+# Author:: Tim Smith (<tsmith84@gmail.com>)
+#
+# 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 Modernize
+        # 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
+        #
+        #   ### incorrect
+        #   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
+        #
+        #   file "/etc/cron.d/#{job_name}" do
+        #     action :delete
+        #   end
+        #
+        #   file File.join('/etc/cron.d', job) do
+        #     action :delete
+        #   end
+        #
+        #   file 'delete old cron job' do
+        #     path '/etc/cron.d/backup'
+        #     action :delete
+        #   end
+        #
+        #   file 'delete old cron job' do
+        #     path "/etc/cron.d/#{job}"
+        #     action :delete
+        #   end
+        #
+        #   file 'delete old cron job' do
+        #     path ::File.join('/etc/cron.d', job)
+        #     action :delete
+        #   end
+        #
+        #   ### correct
+        #   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 < Base
+          include RuboCop::Chef::CookbookHelpers
+          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 $_) | (dstr (str $_) ...) | (send _ _ (str $_) ...)})
+              ...
+            )
+          PATTERN
+
+          def on_block(node)
+            file_or_template?(node) do |file_name|
+              break unless file_name.start_with?(%r{/etc/cron\.d\b}i)
+              add_offense(node, severity: :refactor)
+            end
+
+            match_property_in_resource?(%i(template file cookbook_file), 'path', node) do |code_property|
+              # instead of using CookbookHelpers#method_arg_ast_to_string, walk the property's descendants
+              # and check if their value contains '/etc/cron.d'
+              # covers the case where the argument to the path property is provided via a method like File.join
+              code_property.each_descendant do |d|
+                add_offense(node, severity: :refactor) if d.respond_to?(:value) && d.value.match?(%r{/etc/cron\.d\b}i)
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+#
+# Copyright:: 2019, Chef Software, Inc.
+# Author:: Tim Smith (<tsmith84@gmail.com>)
+#
+# 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 Modernize
+        # 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.
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   cron_manage 'mike'
+        #
+        #   ### correct
+        #   cron_access 'mike'
+        #
+        class CronManageResource < Base
+          extend TargetChefVersion
+          extend AutoCorrector
+
+          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.'
+          RESTRICT_ON_SEND = [:cron_manage].freeze
+
+          def on_send(node)
+            add_offense(node, severity: :refactor) do |corrector|
+              corrector.replace(node, node.source.gsub(/^cron_manage/, 'cron_access'))
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+#
+# Copyright:: 2020, Chef Software, Inc.
+# Author:: Tim Smith (<tsmith84@gmail.com>)
+#
+# 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 Modernize
+        # Use the `data_bag_item` helper instead of `Chef::DataBagItem.load` or `Chef::EncryptedDataBagItem.load`.
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   plain_text_data = Chef::DataBagItem.load('foo', 'bar')
+        #   encrypted_data = Chef::EncryptedDataBagItem.load('foo2', 'bar2')
+        #
+        #   ### correct
+        #   plain_text_data = data_bag_item('foo', 'bar')
+        #   encrypted_data = data_bag_item('foo2', 'bar2')
+        #
+        class DatabagHelpers < Base
+          extend AutoCorrector
+
+          MSG = 'Use the `data_bag_item` helper instead of `Chef::DataBagItem.load` or `Chef::EncryptedDataBagItem.load`.'
+          RESTRICT_ON_SEND = [:load].freeze
+
+          def_node_matcher :data_bag_class_load?, <<-PATTERN
+          (send
+            (const
+              (const nil? :Chef) {:DataBagItem :EncryptedDataBagItem}) :load
+              ...)
+          PATTERN
+
+          def on_send(node)
+            data_bag_class_load?(node) do
+              add_offense(node, severity: :refactor) do |corrector|
+                corrector.replace(node,
+                   node.source.gsub(/Chef::(EncryptedDataBagItem|DataBagItem).load/, 'data_bag_item'))
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+#
+# Copyright:: 2021, Chef Software, Inc.
+# Author:: Tim Smith (<tsmith84@gmail.com>)
+#
+# 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 Modernize
+        # In Chef Infra Client 12.9 and later `action_class` can be used instead of `declare_action_class`.
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   declare_action_class do
+        #     foo
+        #   end
+        #
+        #   ### correct
+        #   action_class do
+        #     foo
+        #   end
+        #
+        class DeclareActionClass < Base
+          extend TargetChefVersion
+          extend AutoCorrector
+
+          minimum_target_chef_version '12.9'
+
+          MSG = 'In Chef Infra Client 12.9 and later `action_class` can be used instead of `declare_action_class`.'
+          RESTRICT_ON_SEND = [:declare_action_class].freeze
+
+          def on_send(node)
+            add_offense(node, severity: :refactor) do |corrector|
+              corrector.replace(node, node.source.gsub('declare_action_class', 'action_class'))
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+#
+# Copyright:: 2019-2020, Chef Software Inc.
+# Author:: Tim Smith (<tsmith84@gmail.com>)
+#
+# 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 Modernize
+        # The default actions can now be specified using the `default_action` helper instead of using the @action variable in the resource provider initialize method. In general we recommend against writing HWRPs, but if HWRPs are necessary you should utilize as much of the resource DSL as possible.
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   def initialize(*args)
+        #     super
+        #     @action = :create
+        #   end
+        #
+        #   ### incorrect
+        #   def initialize(*args)
+        #     super
+        #     @default_action = :create
+        #   end
+        #
+        #  ### correct
+        #  default_action :create
+
+        class DefaultActionFromInitialize < Base
+          extend AutoCorrector
+          include RangeHelp
+
+          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 :initialize_method, '(def :initialize ... )'
+
+          def_node_search :default_action_method?, '(send nil? :default_action ... )'
+
+          def on_ivasgn(node)
+            action_variable_assignment?(node) do
+              return unless initialize_method(node.parent.parent)
+              add_offense(node, severity: :refactor) 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 = initialize_method(processed_source.ast).first
+                  corrector.insert_before(initialize_node.source_range, "default_action #{node.descendants.first.source}\n\n")
+                end
+
+                # remove the variable from the initialize method
+                corrector.remove(range_with_surrounding_space(range: node.loc.expression, side: :left))
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+#
+# Copyright:: 2019, Chef Software, Inc.
+# Author:: Tim Smith (<tsmith84@gmail.com>)
+#
+# 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 Modernize
+        # ChefSpec 7.1 and later auto generate ChefSpec matchers. Matchers in cookbooks can now be removed.
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   if defined?(ChefSpec)
+        #     def create_yum_repository(resource_name)
+        #       ChefSpec::Matchers::ResourceMatcher.new(:yum_repository, :create, resource_name)
+        #     end
+        #   end
+        #
+        class DefinesChefSpecMatchers < Base
+          extend AutoCorrector
+          include RangeHelp
+
+          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)) ... )
+          PATTERN
+
+          def on_if(node)
+            chefspec_matcher?(node) do
+              add_offense(node, severity: :refactor) do |corrector|
+                corrector.remove(range_with_surrounding_space(range: node.loc.expression, side: :left))
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+#
+# Copyright:: 2019, Chef Software, Inc.
+# Author:: Tim Smith (<tsmith84@gmail.com>)
+#
+# 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 Modernize
+        # 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 < Base
+          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.'
+
+          def on_block(node)
+            add_offense(node, severity: :refactor) if node.respond_to?(:method_name) && node.method?(:define)
+          end
+        end
+      end
+    end
+  end
+end