cookstyle-ng 8.0.0

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

@@ -0,0 +1,58 @@
+# 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
+        # whyrun_supported? no longer needs to be set to true as that is the default in Chef Infra Client 13+
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   def whyrun_supported?
+        #    true
+        #   end
+        #
+        class WhyRunSupportedTrue < Base
+          extend TargetChefVersion
+          extend AutoCorrector
+          include RangeHelp
+
+          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+'
+
+          # match on both whyrun_supported? and the typo form why_run_supported?
+          def_node_matcher :whyrun_true?, <<-PATTERN
+            (def {:whyrun_supported? :why_run_supported?}
+              (args)
+              (true))
+          PATTERN
+
+          def on_def(node)
+            whyrun_true?(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/windows_default_recipe.rb

@@ -0,0 +1,52 @@
+# 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 include the windows default recipe that is either full of gem install that are part of the Chef Infra Client, or empty (depends on version).
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   include_recipe 'windows::default'
+        #   include_recipe 'windows'
+        #
+        class IncludingWindowsDefaultRecipe < Base
+          include RangeHelp
+          extend AutoCorrector
+
+          MSG = 'Do not include the Windows default recipe, which only installs win32 gems already included in Chef Infra Client'
+          RESTRICT_ON_SEND = [:include_recipe].freeze
+
+          def_node_matcher :windows_recipe_usage?, <<-PATTERN
+            (send nil? :include_recipe (str {"windows" "windows::default"}))
+          PATTERN
+
+          def on_send(node)
+            windows_recipe_usage?(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/windows_registry_uac.rb

@@ -0,0 +1,92 @@
+# frozen_string_literal: true
+#
+# Copyright:: 2020-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
+        # 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.
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   registry_key 'HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows\CurrentVersion\Policies\System' do
+        #     values [{ name: 'EnableLUA', type: :dword, data: 0 },
+        #             { name: 'PromptOnSecureDesktop', type: :dword, data: 0 },
+        #             { name: 'ConsentPromptBehaviorAdmin', type: :dword, data: 0 },
+        #            ]
+        #     action :create
+        #   end
+        #
+        #   ### correct
+        #   windows_uac 'Set Windows UAC settings' do
+        #     enable_uac false
+        #     prompt_on_secure_desktop true
+        #     consent_behavior_admins :no_prompt
+        #   end
+        #
+        class WindowsRegistryUAC < Base
+          include RuboCop::Chef::CookbookHelpers
+          extend TargetChefVersion
+
+          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.'
+          RESTRICT_ON_SEND = [:registry_key].freeze
+          VALID_VALUES = %w(EnableLUA ValidateAdminCodeSignatures PromptOnSecureDesktop ConsentPromptBehaviorAdmin ConsentPromptBehaviorUser EnableInstallerDetection).freeze
+
+          # block registry_key resources
+          def on_block(node)
+            return unless node.method?(:registry_key)
+            return unless correct_key?(node)
+            return unless uac_supported_values?(node)
+            add_offense(node, severity: :refactor)
+          end
+
+          # make sure the values passed are all the ones in the uac resource
+          # this key has other values we don't support in the windows_uac resource
+          def uac_supported_values?(node)
+            match_property_in_resource?(:registry_key, 'values', node) do |val_prop|
+              return false unless val_prop&.arguments[0].array_type? # make sure values isn't being passed a variable or method
+              val_prop.arguments[0].each_value do |array|
+                array.each_pair do |key, value|
+                  if key == s(:sym, :name)
+                    return false unless value.str_type? # make sure it isn't being a variable or method that we can't parse
+                    return false unless VALID_VALUES.include?(value.value)
+                  end
+                end
+              end
+            end
+            true
+          end
+
+          # make sure the registry_key resource is running against the correct key
+          # check the block name and the key property (registry_key's name property)
+          def correct_key?(node)
+            return true if node.send_node.arguments.first.source.match?(/(HKLM|HKEY_LOCAL_MACHINE)\\SOFTWARE\\Microsoft\\Windows\\CurrentVersion\\Policies\\System/i)
+
+            match_property_in_resource?(:registry_key, 'key', node) do |key_prop|
+              property_data = method_arg_ast_to_string(key_prop)
+              return true if property_data && property_data.match?(/(HKLM|HKEY_LOCAL_MACHINE)\\SOFTWARE\\Microsoft\\Windows\\CurrentVersion\\Policies\\System/i)
+            end
+            false
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,46 @@
+# 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 archive_file resource built into Chef Infra Client 15+ instead of the windows_zipfile from the Windows cookbook
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   windows_zipfile 'C:\\files\\' do
+        #     source 'C:\\Temp\\file.zip'
+        #   end
+        #
+        class WindowsZipfileUsage < Base
+          extend TargetChefVersion
+
+          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'
+          RESTRICT_ON_SEND = [:windows_zipfile].freeze
+
+          def on_send(node)
+            add_offense(node, severity: :refactor)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/chef/modernize/zipfile_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 Modernize
+        # Use the archive_file resource built into Chef Infra Client 15+ instead of the zipfile resource from the zipfile cookbook.
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   zipfile "C:\file.zip" do
+        #     path 'C:\expand_here'
+        #   end
+        #
+        class ZipfileResource < Base
+          include RuboCop::Chef::CookbookHelpers
+          extend TargetChefVersion
+
+          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.'
+          RESTRICT_ON_SEND = [:depends].freeze
+
+          def_node_matcher :depends_zipfile?, <<-PATTERN
+            (send nil? :depends (str "zipfile"))
+          PATTERN
+
+          def on_send(node)
+            depends_zipfile?(node) do
+              add_offense(node, severity: :refactor)
+            end
+          end
+
+          def on_block(node)
+            match_resource_type?(:zipfile, node) do
+              add_offense(node, severity: :refactor)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/chef/modernize/zypper_repo.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
+        # The zypper_repo resource was renamed zypper_repository when it was added to Chef Infra Client 13.3.
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   zypper_repo 'apache' do
+        #     baseurl 'http://download.opensuse.org/repositories/Apache'
+        #     path '/openSUSE_Leap_42.2'
+        #     type 'rpm-md'
+        #     priority '100'
+        #   end
+        #
+        #   ### correct
+        #   zypper_repository 'apache' do
+        #     baseurl 'http://download.opensuse.org/repositories/Apache'
+        #     path '/openSUSE_Leap_42.2'
+        #     type 'rpm-md'
+        #     priority '100'
+        #   end
+        #
+        class UsesZypperRepo < Base
+          extend TargetChefVersion
+          extend AutoCorrector
+
+          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.'
+          RESTRICT_ON_SEND = [:zypper_repo].freeze
+
+          def on_send(node)
+            add_offense(node, severity: :refactor) do |corrector|
+              corrector.replace(node, node.source.gsub(/^zypper_repo/, 'zypper_repository'))
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,65 @@
+# 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 RedundantCode
+        # 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.
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   apt_repository 'my repo' do
+        #     uri 'http://packages.example.com/debian'
+        #     components %w(stable main)
+        #     deb_src false
+        #     distribution node['lsb']['codename']
+        #   end
+        #
+        #   ### correct
+        #   apt_repository 'my repo' do
+        #     uri 'http://packages.example.com/debian'
+        #     components %w(stable main)
+        #     deb_src false
+        #   end
+        #
+        class AptRepositoryDistributionDefault < Base
+          include RuboCop::Chef::CookbookHelpers
+          include RangeHelp
+          extend AutoCorrector
+
+          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"})))
+          PATTERN
+
+          def on_block(node)
+            match_property_in_resource?(:apt_repository, 'distribution', node) do |dist|
+              default_dist?(dist) do
+                add_offense(dist, severity: :refactor) do |corrector|
+                  corrector.remove(range_with_surrounding_space(range: dist.loc.expression, side: :left))
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/chef/redundant/apt_repository_notifies_apt_update.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 RedundantCode
+        # 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.
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   apt_repository 'my repo' do
+        #     uri 'http://packages.example.com/debian'
+        #     components %w(stable main)
+        #     deb_src false
+        #     notifies :run, 'execute[apt-get update]', :immediately
+        #   end
+        #
+        #   ### correct
+        #   apt_repository 'my repo' do
+        #     uri 'http://packages.example.com/debian'
+        #     components %w(stable main)
+        #     deb_src false
+        #   end
+        #
+        class AptRepositoryNotifiesAptUpdate < Base
+          include RuboCop::Chef::CookbookHelpers
+          include RangeHelp
+          extend AutoCorrector
+
+          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|
+              return unless notifies.arguments[1] == s(:str, 'execute[apt-get update]')
+              add_offense(notifies, severity: :refactor) do |corrector|
+                corrector.remove(range_with_surrounding_space(range: notifies.loc.expression, side: :left))
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,52 @@
+# 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 RedundantCode
+        # The attribute metadata.rb method is not used and is unnecessary in cookbooks.
+        #
+        # @example
+        #
+        #   ### incorrect in metadata.rb:
+        #
+        #    attribute 'zookeeper_bridge/server',
+        #              display_name: 'zookeeper server',
+        #              description: 'Zookeeper server address.',
+        #              type: 'string',
+        #              required: 'optional',
+        #              default: '"127.0.0.1:2181"'
+        #
+        class AttributeMetadata < Base
+          include RangeHelp
+          include RuboCop::Chef::AutocorrectHelpers
+          extend AutoCorrector
+
+          MSG = 'The attribute metadata.rb method is not used and is unnecessary in cookbooks.'
+          RESTRICT_ON_SEND = [:attribute].freeze
+
+          def on_send(node)
+            add_offense(node, severity: :refactor) do |corrector|
+              corrector.remove(range_with_surrounding_space(range: expression_including_heredocs(node), side: :left))
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,46 @@
+# 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 RedundantCode
+        # The conflicts metadata.rb method is not used and is unnecessary in cookbooks.
+        #
+        # @example
+        #
+        #   ### incorrect in metadata.rb:
+        #
+        #   conflicts "another_cookbook"
+        #
+        class ConflictsMetadata < Base
+          include RangeHelp
+          extend AutoCorrector
+
+          MSG = 'The conflicts metadata.rb method is not used and is unnecessary in cookbooks.'
+          RESTRICT_ON_SEND = [:conflicts].freeze
+
+          def on_send(node)
+            add_offense(node, severity: :refactor) do |corrector|
+              corrector.remove(range_with_surrounding_space(range: node.loc.expression, side: :right))
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/chef/redundant/custom_resource_with_allowed_actions.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 RedundantCode
+        # 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.
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   allowed_actions [:create, :remove]
+        #
+        #   # also bad
+        #   actions [:create, :remove]
+        #
+        class CustomResourceWithAllowedActions < Base
+          include RangeHelp
+          extend AutoCorrector
+
+          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'
+          RESTRICT_ON_SEND = [:allowed_actions, :actions].freeze
+
+          def_node_search :poise_require, '(send nil? :require (str "poise"))'
+
+          def_node_search :resource_actions?, <<-PATTERN
+            (block (send nil? :action ... ) ... )
+          PATTERN
+
+          def on_send(node)
+            # avoid triggering on things like new_resource.actions
+            return unless node.receiver.nil?
+
+            # if the resource requires poise then bail out since we're in a poise resource where @allowed_actions is legit
+            return if poise_require(processed_source.ast).any? || !resource_actions?(processed_source.ast)
+
+            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