cookstyle-ng 8.0.0

data/lib/rubocop/cop/chef/deprecation/epic_fail.rb

@@ -0,0 +1,51 @@
+# 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 Deprecations
+        # Use `ignore_failure` in resources to continue when failures occur instead of the deprecated `epic_fail` property.
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   package "foo" do
+        #     epic_fail true
+        #   end
+        #
+        #   ### correct
+        #   package "foo" do
+        #     ignore_failure true
+        #   end
+        #
+        class EpicFail < Base
+          extend AutoCorrector
+
+          MSG = 'Use `ignore_failure` in resources to continue when failures occur instead of the deprecated `epic_fail` property'
+          RESTRICT_ON_SEND = [:epic_fail].freeze
+
+          def on_send(node)
+            add_offense(node, severity: :warning) do |corrector|
+              corrector.replace(node, 'ignore_failure true')
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/chef/deprecation/erl_call.rb

@@ -0,0 +1,42 @@
+# 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 Deprecations
+        # Don't use the deprecated `erl_call` resource removed in Chef Infra Client 13."
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   erl_call "foo" do
+        #     bar
+        #   end
+        #
+        class ErlCallResource < Base
+          MSG = "Don't use the deprecated erl_call resource removed in Chef Infra Client 13"
+          RESTRICT_ON_SEND = [:erl_call].freeze
+
+          def on_send(node)
+            add_offense(node, severity: :warning)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/chef/deprecation/execute_path_property.rb

@@ -0,0 +1,50 @@
+# 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 Deprecations
+        # In Chef Infra Client 13 and later you must set path env vars in execute resources using the `environment` property not the legacy `path` property.
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   execute 'some_cmd' do
+        #     path '/foo/bar'
+        #   end
+        #
+        #   ### correct
+        #   execute 'some_cmd' do
+        #     environment {path: '/foo/bar'}
+        #   end
+        #
+        class ExecutePathProperty < Base
+          include RuboCop::Chef::CookbookHelpers
+
+          MSG = 'In Chef Infra Client 13 and later you must set path env vars in execute resources using the `environment` property not the legacy `path` property.'
+
+          def on_block(node)
+            match_property_in_resource?(:execute, 'path', node) do |offense|
+              add_offense(offense, severity: :warning) # @todo: we could probably autocorrect this with some work
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/chef/deprecation/execute_relative_creates_without_cwd.rb

@@ -0,0 +1,66 @@
+# 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 Deprecations
+        # In Chef Infra Client 13 and later you must either specific an absolute path when using the `execute` resource's `creates` property or also use the `cwd` property.
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   execute 'some_cmd' do
+        #     creates 'something'
+        #   end
+        #
+        #   ### correct
+        #   execute 'some_cmd' do
+        #     creates '/tmp/something'
+        #   end
+        #
+        #   execute 'some_cmd' do
+        #     creates 'something'
+        #     cwd '/tmp/'
+        #   end
+        #
+        class ExecuteRelativeCreatesWithoutCwd < Base
+          include RuboCop::Chef::CookbookHelpers
+
+          MSG = "In Chef Infra Client 13 and later you must either specific an absolute path when using the `execute` resource's `creates` property or also use the `cwd` property."
+
+          def on_block(node)
+            match_property_in_resource?(:execute, 'creates', node) do |offense|
+              return unless offense.arguments.count == 1 # we can only analyze simple string args
+              return unless offense.arguments.first.str_type? # we can only analyze simple string args
+
+              # skip any creates that are abs paths https://rubular.com/r/3TbDsgcAa1EaIF
+              return if offense.arguments.first.value.match?(%r{^(/|[a-zA-Z]:)})
+
+              # return if we have a cwd property
+              match_property_in_resource?(:execute, 'cwd', node) do
+                return
+              end
+
+              add_offense(offense, severity: :warning)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/chef/deprecation/foodcritic_file.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+#
+# Copyright:: 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 Deprecations
+        # The Foodcritic cookbook linter has been deprecated and should no longer be used for validating cookbooks. Do not include the `.foodcritic` config file used by Foodcritic in your cookbooks.
+        #
+        class FoodcriticFile < Base
+          include RangeHelp
+
+          MSG = 'Do not include the `.foodcritic` config file for the deprecated Foodcritic cookbook linter.'
+
+          def on_new_investigation
+            return unless processed_source.path.end_with?('.foodcritic')
+
+            # Using range similar to RuboCop::Cop::Naming::Filename (file_name.rb)
+            range = source_range(processed_source.buffer, 1, 0)
+
+            add_offense(range, severity: :warning)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/chef/deprecation/foodcritic_testing.rb

@@ -0,0 +1,43 @@
+# 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 Deprecations
+        # The Foodcritic cookbook linter has been deprecated and should no longer be used for validating cookbooks.
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   gem 'foodcritic'
+        #   require 'foodcritic'
+        #
+        class FoodcriticTesting < Base
+          MSG = 'The Foodcritic cookbook linter has been deprecated and should no longer be used for validating cookbooks.'
+          RESTRICT_ON_SEND = [:require, :gem].freeze
+
+          def on_send(node)
+            return unless node.arguments.first == s(:str, 'foodcritic')
+
+            add_offense(node, severity: :warning)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/chef/deprecation/hwrp_without_provides.rb

@@ -0,0 +1,140 @@
+# frozen_string_literal: true
+#
+# Copyright:: Copyright (c) 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 Deprecations
+        # Chef Infra Client 16 and later a legacy HWRP resource must use `provides` to define how the resource is called in recipes or other resources. To maintain compatibility with Chef Infra Client < 16 use both `resource_name` and `provides`.
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   class Chef
+        #     class Resource
+        #       class UlimitRule < Chef::Resource
+        #         property :type, [Symbol, String], required: true
+        #         property :item, [Symbol, String], required: true
+        #
+        #         # additional resource code
+        #       end
+        #     end
+        #   end
+        #
+        #   ### incorrect
+        #   class Chef
+        #     class Resource
+        #       class UlimitRule < Chef::Resource
+        #         resource_name :ulimit_rule
+        #
+        #         property :type, [Symbol, String], required: true
+        #         property :item, [Symbol, String], required: true
+        #
+        #         # additional resource code
+        #       end
+        #     end
+        #   end
+        #
+        #  ### correct when Chef Infra Client < 15 (but compatible with 16+ as well)
+        #   class Chef
+        #     class Resource
+        #       class UlimitRule < Chef::Resource
+        #         resource_name :ulimit_rule
+        #         provides :ulimit_rule
+        #
+        #         property :type, [Symbol, String], required: true
+        #         property :item, [Symbol, String], required: true
+        #
+        #         # additional resource code
+        #       end
+        #     end
+        #   end
+        #
+        #  ### correct when Chef Infra Client 16+
+        #   class Chef
+        #     class Resource
+        #       class UlimitRule < Chef::Resource
+        #         provides :ulimit_rule
+        #
+        #         property :type, [Symbol, String], required: true
+        #         property :item, [Symbol, String], required: true
+        #
+        #         # additional resource code
+        #       end
+        #     end
+        #   end
+        #
+        #  # better
+        #  Convert your legacy HWRPs to custom resources
+        #
+        class HWRPWithoutProvides < Base
+          extend AutoCorrector
+
+          MSG = 'In Chef Infra Client 16 and later a legacy HWRP resource must use `provides` to define how the resource is called in recipes or other resources. To maintain compatibility with Chef Infra Client < 16 use both `resource_name` and `provides`.'
+
+          def_node_matcher :HWRP?, <<-PATTERN
+          (class
+            (const nil? :Chef) nil?
+            (class
+              (const nil? :Resource) nil?
+              $(class
+                (const nil? ... )
+                (const
+                  (const nil? :Chef) :Resource)
+                  (begin ... ))))
+          PATTERN
+
+          def_node_search :provides, '(send nil? :provides (sym $_) ...)'
+          def_node_search :resource_name_ast, '$(send nil? :resource_name ...)'
+          def_node_search :resource_name, '(send nil? :resource_name (sym $_))'
+
+          def on_class(node)
+            return if has_provides?
+            HWRP?(node) do |inherit|
+              add_offense(inherit, severity: :warning) do |corrector|
+                resource_name_ast(node) do |ast_match|
+                  # build a new string to add after that includes the new line and the proper indentation
+                  new_string = "\n" + ast_match.source.dup.gsub('resource_name', 'provides').prepend(' ' * indentation(ast_match))
+                  corrector.insert_after(ast_match.source_range, new_string)
+                end
+              end
+            end
+          end
+
+          def has_provides?
+            provides_ast = provides(processed_source.ast)
+            return false if provides_ast.count == 0
+
+            resource_ast = resource_name(processed_source.ast)
+
+            if resource_ast.count == 0
+              true # no resource_name, but provides
+            else
+              # since we have a resource and provides make sure the there is a provides that
+              # matches the resource name
+              provides_ast.include?(resource_ast.first)
+            end
+          end
+
+          def indentation(node)
+            node.source_range.source_line =~ /\S/
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/chef/deprecation/hwrp_without_unified_mode_true.rb

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+#
+# Copyright:: Copyright (c) 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 Deprecations
+        # Chef Infra Client 15.3 and later include a new Unified Mode that simplifies the execution of resources by replace the traditional compile and converge phases with a single phase. Unified mode simplifies writing advanced resources and avoids confusing errors that often occur when mixing ruby and Chef Infra resources. Chef Infra Client 17.0 and later will begin warning that `unified_mode true` should be set in all resources to validate that they will continue to function in Chef Infra Client 18.0 (April 2022) when Unified Mode becomes the default.
+        #
+        # @example
+        #
+        #  ### incorrect
+        #   class Chef
+        #     class Resource
+        #       class UlimitRule < Chef::Resource
+        #         provides :ulimit_rule
+        #
+        #         property :type, [Symbol, String], required: true
+        #         property :item, [Symbol, String], required: true
+        #
+        #         # additional resource code
+        #       end
+        #     end
+        #   end
+        #
+        #  ### correct
+        #   class Chef
+        #     class Resource
+        #       class UlimitRule < Chef::Resource
+        #         provides :ulimit_rule
+        #         unified_mode true
+        #
+        #         property :type, [Symbol, String], required: true
+        #         property :item, [Symbol, String], required: true
+        #
+        #         # additional resource code
+        #       end
+        #     end
+        #   end
+        #
+        class HWRPWithoutUnifiedTrue < Base
+          extend TargetChefVersion
+
+          minimum_target_chef_version '15.3'
+
+          MSG = 'Set `unified_mode true` in Chef Infra Client 15.3+ HWRP style custom resources to ensure they work correctly in Chef Infra Client 18 (April 2022) when Unified Mode becomes the default.'
+
+          def_node_matcher :HWRP?, <<-PATTERN
+          (class
+            (const nil? :Chef) nil?
+            (class
+              (const nil? :Resource) nil?
+              $(class
+                (const nil? ... )
+                (const
+                  (const nil? :Chef) :Resource)
+                  (begin ... ))))
+          PATTERN
+
+          def_node_search :unified_mode?, '(send nil? :unified_mode ...)'
+
+          def on_class(node)
+            return if unified_mode?(processed_source.ast)
+            HWRP?(node) do |inherit|
+              add_offense(inherit, severity: :warning)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/chef/deprecation/inherits_compat_resource.rb

@@ -0,0 +1,59 @@
+# 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 Deprecations
+        # Resources written in the class based HWRP style should inherit from the 'Chef::Resource' class and not the 'ChefCompat::Resource' class from the deprecated compat_resource cookbook.
+        #
+        # @example
+        #
+        #  ### incorrect
+        #  class AptUpdate < ChefCompat::Resource
+        #    # some resource code
+        #  end
+        #
+        #  ### correct
+        #  class AptUpdate < Chef::Resource
+        #    # some resource code
+        #  end
+        #
+        #  # better
+        #  Write a custom resource using the custom resource DSL and avoid class based HWRPs entirely
+        #
+        class ResourceInheritsFromCompatResource < Base
+          extend AutoCorrector
+
+          MSG = "HWRP style resource should inherit from the 'Chef::Resource' class and not the 'ChefCompat::Resource' class from the deprecated compat_resource cookbook."
+
+          def_node_matcher :inherits_from_compat_resource?, <<-PATTERN
+          (class (const nil? _ ) (const (const nil? :ChefCompat) :Resource) ... )
+          PATTERN
+
+          def on_class(node)
+            inherits_from_compat_resource?(node) do
+              add_offense(node, severity: :warning) do |corrector|
+                corrector.replace(node, node.source.gsub('ChefCompat', 'Chef'))
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/chef/deprecation/launchd_deprecated_hash_property.rb

@@ -0,0 +1,56 @@
+# 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 Deprecations
+        # The launchd resource's hash property was renamed to plist_hash in Chef Infra Client 13+ to avoid conflicts with Ruby's hash class.
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   launchd 'foo' do
+        #     hash foo: 'bar'
+        #   end
+        #
+        #   ### correct
+        #   launchd 'foo' do
+        #     plist_hash foo: 'bar'
+        #   end
+        #
+        class LaunchdDeprecatedHashProperty < Base
+          include RuboCop::Chef::CookbookHelpers
+          extend TargetChefVersion
+          extend AutoCorrector
+
+          minimum_target_chef_version '12.19'
+
+          MSG = "The launchd resource's hash property was renamed to plist_hash in Chef Infra Client 13+ to avoid conflicts with Ruby's hash class."
+
+          def on_block(node)
+            match_property_in_resource?(:launchd, 'hash', node) do |offense|
+              add_offense(offense.loc.expression, severity: :warning) do |corrector|
+                corrector.replace(offense.loc.expression, offense.loc.expression.source.gsub(/^hash/, 'plist_hash'))
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end