cookstyle-ng 8.0.0

data/lib/rubocop/cop/chef/effortless/node_environment.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+#
+# Copyright:: 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 Effortless
+        # Neither Policyfiles or Effortless Infra which is based on Policyfiles supports Chef Environments
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   node.environment == "production"
+        #   node.chef_environment == "production"
+        #
+        class CookbookUsesEnvironments < Base
+          MSG = 'Cookbook uses environments, which cannot be used in Policyfiles or Effortless Infra'
+          RESTRICT_ON_SEND = [:environment, :chef_environment].freeze
+
+          def on_send(node)
+            if node.receiver &&
+               node.receiver.send_type? &&
+               node.receiver.method?(:node)
+              add_offense(node, severity: :refactor)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/chef/effortless/node_policygroup.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+#
+# Copyright:: 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 Effortless
+        # Effortless Infra does not support Policyfile's Policygroup feature
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   node.policy_group == "foo"
+        #
+        class CookbookUsesPolicygroups < Base
+          MSG = 'Cookbook uses Policy Groups, which cannot be used with Effortless Infra'
+          RESTRICT_ON_SEND = [:policy_group].freeze
+
+          def on_send(node)
+            if node.receiver &&
+               node.receiver.send_type? &&
+               node.receiver.method?(:node)
+              add_offense(node, severity: :refactor)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/chef/effortless/node_roles.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+#
+# Copyright:: 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 Effortless
+        # Neither Policyfiles or Effortless Infra which is based on Policyfiles supports Chef Infra Roles
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   node.role?('web_server')
+        #   node.roles.include?('web_server')
+        #
+        class CookbookUsesRoles < Base
+          MSG = 'Cookbook uses roles, which cannot be used in Policyfiles or Effortless Infra'
+          RESTRICT_ON_SEND = [:role?, :roles].freeze
+
+          def on_send(node)
+            if node.receiver &&
+               node.receiver.send_type? &&
+               node.receiver.method?(:node)
+              add_offense(node, severity: :refactor)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/chef/effortless/search_for_environments_or_roles.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+#
+# Copyright:: 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 Effortless
+        # Policyfiles (and Effortless) do not use environments or roles so searching for those will need to be refactored before migrating to Policyfiles and the Effortless pattern.
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   search(:node, 'chef_environment:foo')
+        #   search(:node, 'role:bar')
+        #
+        class SearchForEnvironmentsOrRoles < Base
+          MSG = 'Cookbook uses search with a node query that looks for a role or environment'
+          RESTRICT_ON_SEND = [:search].freeze
+
+          def on_send(node)
+            if node.arguments[1]&.value&.match?(/chef_environment|role/)
+              add_offense(node, severity: :refactor)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/chef/effortless/search_used.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+#
+# Copyright:: 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 Effortless
+        # Search is not compatible with the Effortless Infra pattern
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   search(:node, 'run_list:recipe\[bacula\:\:server\]')
+        #
+        class CookbookUsesSearch < Base
+          MSG = 'Cookbook uses search, which cannot be used in the Effortless Infra pattern'
+          RESTRICT_ON_SEND = [:search].freeze
+
+          def on_send(node)
+            add_offense(node, severity: :refactor)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,57 @@
+# 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 custom resource language's `action :my_action` blocks instead of creating actions with methods.
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   def action_create
+        #    # :create action code here
+        #   end
+        #
+        #   ### correct
+        #   action :create do
+        #    # :create action code here
+        #   end
+        #
+        class ActionMethodInResource < Base
+          extend AutoCorrector
+
+          MSG = "Use the custom resource language's `action :my_action` blocks instead of creating actions with methods."
+
+          def_node_search :includes_poise?, '(send nil? :include (const nil? :Poise))'
+
+          def on_def(node)
+            return unless node.method_name.to_s.start_with?('action_') # when we stop support for Ruby < 2.7 the .to_s can go away here
+            return if node.arguments? # if they passed in arguments they may actually need this
+            return if node.parent && includes_poise?(node.parent)
+
+            add_offense(node, severity: :refactor) do |corrector|
+              # @todo when we drop ruby 2.4 support we can convert this to use delete_suffix
+              corrector.replace(node, node.source.gsub("def #{node.method_name}", "action :#{node.method_name.to_s.gsub(/^action_/, '')} do"))
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,77 @@
+# 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 allowed actions can now be specified using the `allowed_actions` helper instead of using the @actions or @allowed_actions variables in the resource's 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
+        #     @actions = [ :create, :add ]
+        #   end
+        #
+        #   # also bad
+        #   def initialize(*args)
+        #     super
+        #     @allowed_actions = [ :create, :add ]
+        #   end
+        #
+        #   ### correct
+        #   allowed_actions [ :create, :add ]
+        #
+        class AllowedActionsFromInitialize < Base
+          include RangeHelp
+          extend AutoCorrector
+
+          MSG = 'The allowed actions of a resource can be set with the "allowed_actions" helper instead of using the initialize method.'
+
+          def on_def(node)
+            return unless node.method?(:initialize)
+            return if node.body.nil? # nil body is an empty initialize method
+
+            node.body.each_node do |x|
+              next unless x.assignment? &&
+                          !x.parent.op_asgn_type? &&
+                          !x.node_parts.empty? &&
+                          %i(@actions @allowed_actions).include?(x.node_parts.first)
+
+              add_offense(x, severity: :refactor) do |corrector|
+                # insert the new allowed_actions call above the initialize method, but not if one already exists (this is sadly common)
+                unless action_methods?(processed_source.ast)
+                  initialize_node = initialize_method(processed_source.ast).first
+                  corrector.insert_before(initialize_node.source_range, "allowed_actions #{x.descendants.first.source}\n\n")
+                end
+
+                # remove the variable from the initialize method
+                corrector.remove(range_with_surrounding_space(range: x.loc.expression, side: :left))
+              end
+            end
+          end
+
+          def_node_search :action_methods?, '(send nil? {:actions :allowed_actions} ... )'
+
+          def_node_search :initialize_method, '(def :initialize ... )'
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/chef/modernize/apt_default_recipe.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
+        # For many users the apt::default cookbook is used only to update apt's package cache. Chef Infra Client 12.7 and later include an apt_update resource which should be used to perform this instead. Keep in mind that some users will want to stick with the apt::default recipe as it also installs packages necessary for using https repositories on Debian systems and manages some configuration files.
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   include_recipe 'apt::default'
+        #   include_recipe 'apt'
+        #
+        #   ### correct
+        #   apt_update
+        #
+        class IncludingAptDefaultRecipe < Base
+          extend TargetChefVersion
+
+          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.'
+          RESTRICT_ON_SEND = [:include_recipe].freeze
+
+          def_node_matcher :apt_recipe_usage?, <<-PATTERN
+            (send nil? :include_recipe (str {"apt" "apt::default"}))
+          PATTERN
+
+          def on_send(node)
+            apt_recipe_usage?(node) do
+              add_offense(node, severity: :refactor)
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,70 @@
+# 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
+        # There have been many different valid community site / Supermarket URLs to use in a cookbook's Berksfile. These old URLs continue to function via redirects, but should be updated to point to the latest Supermarket URL.
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   source 'http://community.opscode.com/api/v3'
+        #   source 'https://supermarket.getchef.com'
+        #   source 'https://api.berkshelf.com'
+        #   site :opscode
+        #
+        #   ### correct
+        #   source 'https://supermarket.chef.io'
+        #
+        class LegacyBerksfileSource < Base
+          extend AutoCorrector
+
+          MSG = 'Do not use legacy Berksfile community sources. Use Chef Supermarket instead.'
+          RESTRICT_ON_SEND = [:source, :site].freeze
+
+          def_node_matcher :berksfile_site?, <<-PATTERN
+            (send nil? :site (:sym _))
+          PATTERN
+
+          def_node_matcher :berksfile_source?, <<-PATTERN
+            (send nil? :source (str #old_berkshelf_url?))
+          PATTERN
+
+          def old_berkshelf_url?(url)
+            %w(http://community.opscode.com/api/v3 https://supermarket.getchef.com https://api.berkshelf.com).include?(url)
+          end
+
+          def on_send(node)
+            berksfile_source?(node) do
+              add_offense(node, severity: :refactor) do |corrector|
+                corrector.replace(node, "source 'https://supermarket.chef.io'")
+              end
+            end
+
+            berksfile_site?(node) do
+              add_offense(node, severity: :refactor) do |corrector|
+                corrector.replace(node, "source 'https://supermarket.chef.io'")
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/chef/modernize/build_essential.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 the build_essential resource from the build-essential cookbook 5.0+ or Chef Infra Client 14+ instead of using the build-essential::default recipe.
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   depends 'build-essential'
+        #   include_recipe 'build-essential::default'
+        #   include_recipe 'build-essential'
+        #
+        #   ### correct
+        #   build_essential 'install compilation tools'
+        #
+        class UseBuildEssentialResource < Base
+          extend AutoCorrector
+
+          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+'
+          RESTRICT_ON_SEND = [:include_recipe].freeze
+
+          def_node_matcher :build_essential_recipe_usage?, <<-PATTERN
+            (send nil? :include_recipe (str {"build-essential" "build-essential::default"}))
+          PATTERN
+
+          def on_send(node)
+            build_essential_recipe_usage?(node) do
+              add_offense(node, severity: :refactor) do |corrector|
+                corrector.replace(node, "build_essential 'install compilation tools'")
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,60 @@
+# 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
+        # Don't depend on cookbooks made obsolete by Chef Infra Client 14.0+ These community cookbooks contain resources that are now included in Chef Infra Client itself.
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   depends 'build-essential'
+        #   depends 'chef_handler'
+        #   depends 'chef_hostname'
+        #   depends 'dmg'
+        #   depends 'mac_os_x'
+        #   depends 'swap'
+        #   depends 'sysctl'
+        #
+        class UnnecessaryDependsChef14 < Base
+          extend AutoCorrector
+          extend TargetChefVersion
+          include RangeHelp
+
+          minimum_target_chef_version '14.0'
+
+          MSG = "Don't depend on cookbooks made obsolete by Chef Infra Client 14.0+. These community cookbooks contain resources that are now included in Chef Infra Client itself."
+          RESTRICT_ON_SEND = [:depends].freeze
+
+          def_node_matcher :legacy_depends?, <<-PATTERN
+            (send nil? :depends (str {"build-essential" "chef_handler" "chef_hostname" "dmg" "mac_os_x" "swap" "sysctl"}) ... )
+          PATTERN
+
+          def on_send(node)
+            legacy_depends?(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/chef_15_resources.rb

@@ -0,0 +1,57 @@
+# 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
+        # Don't depend on cookbooks made obsolete by Chef Infra Client 15.0+. These community cookbooks contain resources that are now included in Chef Infra Client itself.
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   depends 'libarchive'
+        #   depends 'windows_dns'
+        #   depends 'windows_uac'
+        #   depends 'windows_dfs'
+        #
+        class UnnecessaryDependsChef15 < Base
+          extend AutoCorrector
+          extend TargetChefVersion
+          include RangeHelp
+
+          minimum_target_chef_version '15.0'
+
+          MSG = "Don't depend on cookbooks made obsolete by Chef Infra Client 15.0+. These community cookbooks contain resources that are now included in Chef Infra Client itself."
+          RESTRICT_ON_SEND = [:depends].freeze
+
+          def_node_matcher :legacy_depends?, <<-PATTERN
+            (send nil? :depends (str {"libarchive" "windows_dns" "windows_uac" "windows_dfs"}) ... )
+          PATTERN
+
+          def on_send(node)
+            legacy_depends?(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