cookstyle-ng 8.0.0

data/lib/rubocop/cop/chef/correctness/incorrect_library_injection.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+#
+# Copyright:: 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 Correctness
+        # Libraries should be injected into the `Chef::DSL::Recipe` class and not `Chef::Recipe` or `Chef::Provider` classes directly.
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   ::Chef::Recipe.send(:include, Filebeat::Helpers)
+        #   ::Chef::Provider.send(:include, Filebeat::Helpers)
+        #   ::Chef::Recipe.include Filebeat::Helpers
+        #   ::Chef::Provider.include Filebeat::Helpers
+        #
+        #   ### correct
+        #   ::Chef::DSL::Recipe.send(:include, Filebeat::Helpers) # covers previous Recipe & Provider classes
+        #
+        class IncorrectLibraryInjection < Base
+          include RangeHelp
+          extend AutoCorrector
+
+          MSG = 'Libraries should be injected into the Chef::DSL::Recipe class and not Chef::Recipe or Chef::Provider classes directly.'
+          RESTRICT_ON_SEND = [:send, :include].freeze
+
+          def_node_search :correct_injection?, <<-PATTERN
+            {(send
+               (const
+                 (const
+                   (const {cbase nil?} :Chef) :DSL) :Recipe) :send
+               (sym :include)
+             ... )
+             (send
+               (const
+                 (const
+                   (const {cbase nil?} :Chef) :DSL) :Recipe) :include
+             ... )}
+          PATTERN
+
+          def_node_matcher :legacy_injection?, <<-PATTERN
+            {(send (const (const {cbase nil?} :Chef) {:Recipe :Provider}) :send (sym :include) ... )
+             (send (const (const {cbase nil?} :Chef) {:Recipe :Provider}) :include ... )}
+          PATTERN
+
+          def on_send(node)
+            legacy_injection?(node) do
+              add_offense(node, severity: :refactor) do |corrector|
+                if node.parent && correct_injection?(node.parent)
+                  corrector.remove(range_with_surrounding_space(range: node.loc.expression, side: :left))
+                else
+                  corrector.replace(node,
+                    node.source.gsub(/Chef::(Provider|Recipe)/, 'Chef::DSL::Recipe'))
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/chef/correctness/invalid_cookbook_name.rb

@@ -0,0 +1,47 @@
+# 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 Correctness
+        # Cookbook names should not contain invalid characters such as periods.
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   name 'foo.bar'
+        #
+        #   ### correct
+        #   name 'foo_bar'
+        #
+        class InvalidCookbookName < Base
+          RESTRICT_ON_SEND = [:name].freeze
+          MSG = 'Cookbook names should not contain invalid characters such as periods.'
+
+          def_node_matcher :has_name?, '(send nil? :name $str)'
+
+          def on_send(node)
+            has_name?(node) do |val|
+              add_offense(node, severity: :refactor) if val.value.include?('.')
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/chef/correctness/invalid_default_action.rb

@@ -0,0 +1,48 @@
+# 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 Correctness
+        # Default actions in resources should be symbols or an array of symbols.
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   default_action 'create'
+        #
+        #   ### correct
+        #   default_action :create
+        #
+        class InvalidDefaultAction < Base
+          MSG = 'Default actions in resources should be symbols or an array of symbols.'
+          RESTRICT_ON_SEND = [:default_action].freeze
+
+          def_node_matcher :default_action?, '(send nil? :default_action $_)'
+
+          def on_send(node)
+            default_action?(node) do |match|
+              return if %i(send sym array).include?(match.type)
+              add_offense(node, severity: :refactor)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/chef/correctness/invalid_notification_resource.rb

@@ -0,0 +1,59 @@
+# 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 Correctness
+        # The resource to notify when calling `notifies` or `subscribes` must be a string.
+        #
+        # @example
+        #
+        #   ### incorrect
+        #
+        #   template '/etc/www/configures-apache.conf' do
+        #     notifies :restart, service['apache'], :immediately
+        #   end
+        #
+        #   template '/etc/www/configures-apache.conf' do
+        #     notifies :restart, service[apache], :immediately
+        #   end
+        #
+        #   ### correct
+        #
+        #   template '/etc/www/configures-apache.conf' do
+        #     notifies :restart, 'service[apache]', :immediately
+        #   end
+        #
+        class InvalidNotificationResource < Base
+          MSG = 'The resource to notify when calling `notifies` or `subscribes` must be a string.'
+          RESTRICT_ON_SEND = [:notifies, :subscribes].freeze
+
+          def_node_matcher :invalid_notification?, <<-PATTERN
+            (send nil? {:notifies :subscribes} (sym _) $(send (send nil? _) :[] ...) ...)
+          PATTERN
+
+          def on_send(node)
+            invalid_notification?(node) do |resource|
+              add_offense(resource, severity: :refactor)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/chef/correctness/invalid_notification_timing.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 Correctness
+        # Valid notification timings are `:immediately`, `:immediate` (alias for :immediately), `:delayed`, and `:before`.
+        #
+        # @example
+        #
+        #   ### incorrect
+        #
+        #   template '/etc/www/configures-apache.conf' do
+        #     notifies :restart, 'service[apache]', :nope
+        #   end
+        #
+        #   ### correct
+        #
+        #   template '/etc/www/configures-apache.conf' do
+        #     notifies :restart, 'service[apache]', :immediately
+        #   end
+        #
+        class InvalidNotificationTiming < Base
+          MSG = 'Valid notification timings are :immediately, :immediate (alias for :immediately), :delayed, and :before.'
+          RESTRICT_ON_SEND = [:notifies, :subscribes].freeze
+
+          def_node_matcher :notification_with_timing?, <<-PATTERN
+            (send nil? {:notifies :subscribes} (sym _) (...) $(sym _))
+          PATTERN
+
+          def on_send(node)
+            notification_with_timing?(node) do |timing|
+              add_offense(timing, severity: :refactor) unless %i(immediate immediately delayed before).include?(timing.value)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/chef/correctness/invalid_platform_family_helper.rb

@@ -0,0 +1,72 @@
+# 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 Correctness
+        # Pass valid platform families to the `platform_family?` helper. See [Infra Language: Platform Family](https://docs.chef.io/infra_language/checking_platforms/#platform_family-values) for a complete list of platform families.
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   platform_family?('redhat')
+        #   platform_family?('sles')
+        #
+        #   ### incorrect
+        #   platform_family?('rhel')
+        #   platform_family?('suse')
+        #
+        class InvalidPlatformFamilyHelper < Base
+          include ::RuboCop::Chef::PlatformHelpers
+          include RangeHelp
+          extend AutoCorrector
+
+          MSG = 'Pass valid platform families to the platform_family? helper.'
+          RESTRICT_ON_SEND = [:platform_family?].freeze
+
+          def_node_matcher :platform_family_helper?, <<-PATTERN
+            (send nil? :platform_family? $str*)
+          PATTERN
+
+          def on_send(node)
+            platform_family_helper?(node) do |plats|
+              plats.to_a.each do |p|
+                next unless INVALID_PLATFORM_FAMILIES.key?(p.value)
+                add_offense(p, severity: :refactor) do |corrector|
+                  replacement_platform = INVALID_PLATFORM_FAMILIES[p.value]
+                  all_passed_platforms = p.parent.arguments.map(&:value)
+
+                  # see if we have a replacement platform in our hash. If not we can't autocorrect
+                  next unless replacement_platform
+                  # if the replacement platform was one of the other platforms passed we can just delete this bad platform
+                  if all_passed_platforms.include?(replacement_platform)
+                    all_passed_platforms.delete(p.value)
+                    arg_range = p.parent.arguments.first.loc.expression.join(p.parent.arguments[-1].loc.expression.end)
+                    corrector.replace(arg_range, all_passed_platforms.map { |x| "'#{x}'" }.join(', '))
+                  else
+                    corrector.replace(p.loc.expression, p.value.gsub(p.value, "'#{replacement_platform}'")) # gsub to retain quotes
+                  end
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/chef/correctness/invalid_platform_family_values_in_case.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+#
+# Copyright:: 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 Correctness
+        # Use valid platform family values in case statements. See [Infra Language: Platform Family](https://docs.chef.io/infra_language/checking_platforms/#platform_family-values) for a complete list of platform families.
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   case node['platform_family']
+        #   when 'redhat'
+        #     puts "I'm on a RHEL-like system"
+        #   end
+        #
+        class InvalidPlatformFamilyInCase < Base
+          extend AutoCorrector
+          include RangeHelp
+          include ::RuboCop::Chef::PlatformHelpers
+
+          MSG = 'Use valid platform family values in case statements.'
+
+          def_node_matcher :node_platform_family?, <<-PATTERN
+            (send (send nil? :node) :[] (str "platform_family") )
+          PATTERN
+
+          def on_case(node)
+            node_platform_family?(node.condition) do
+              node.each_when do |when_node|
+                when_node.each_condition do |con|
+                  next unless con.str_type?
+                  # if the condition isn't a string we can't check so skip
+                  # some invalid platform families have no direct correction value and return nil instead
+                  new_value = INVALID_PLATFORM_FAMILIES[con.str_content]
+                  next unless new_value
+
+                  add_offense(con, severity: :refactor) do |corrector|
+                    # if the correct value already exists in the when statement then we just want to delete this node
+                    if con.parent.conditions.any? { |x| x.str_content == new_value }
+                      range = range_with_surrounding_comma(range_with_surrounding_space(range: con.loc.expression, side: :left), :both)
+                      corrector.remove(range)
+                    else
+                      corrector.replace(con, "'#{new_value}'")
+                    end
+                  end
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/chef/correctness/invalid_platform_helper.rb

@@ -0,0 +1,57 @@
+# 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 Correctness
+        # Pass valid platforms to the `platform?` helper. See [Infra Language: Platform](https://docs.chef.io/infra_language/checking_platforms/#platform-values) for a list of many common platform values.
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   platform?('darwin')
+        #   platform?('rhel')
+        #   platform?('sles')
+        #
+        #   ### correct
+        #   platform?('mac_os_x')
+        #   platform?('redhat')
+        #   platform?('suse')
+        #
+        class InvalidPlatformHelper < Base
+          include ::RuboCop::Chef::PlatformHelpers
+
+          MSG = 'Pass valid platforms to the platform? helper.'
+          RESTRICT_ON_SEND = [:platform?].freeze
+
+          def_node_matcher :platform_helper?, <<-PATTERN
+            (send nil? :platform? $str*)
+          PATTERN
+
+          def on_send(node)
+            platform_helper?(node) do |plat|
+              plat.to_a.each do |p|
+                add_offense(p, severity: :refactor) if INVALID_PLATFORMS.key?(p.value)
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/chef/correctness/invalid_platform_metadata.rb

@@ -0,0 +1,89 @@
+# 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 Correctness
+        # metadata.rb `supports` methods should contain valid platforms. See [Infra Language: Platform](https://docs.chef.io/infra_language/checking_platforms/#platform-values) for a list of many common platform values.
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   supports 'darwin'
+        #   supports 'mswin'
+        #
+        #   ### correct
+        #   supports 'mac_os_x'
+        #   supports 'windows'
+        #
+        class InvalidPlatformMetadata < Base
+          extend AutoCorrector
+          include ::RuboCop::Chef::PlatformHelpers
+
+          MSG = 'metadata.rb "supports" platform is invalid'
+          RESTRICT_ON_SEND = [:supports].freeze
+
+          def_node_matcher :supports?, '(send nil? :supports $str ...)'
+
+          def_node_matcher :supports_array?, <<-PATTERN
+            (block
+              (send
+                $(array ...) :each)
+              (args
+                (arg _))
+              (send nil? :supports (lvar _)))
+          PATTERN
+
+          def on_send(node)
+            supports?(node) do |plat|
+              next unless INVALID_PLATFORMS[plat.str_content]
+              add_offense(plat, severity: :refactor) do |corrector|
+                correct_string = corrected_platform_source(plat)
+                next unless correct_string
+                corrector.replace(plat, correct_string)
+              end
+            end
+          end
+
+          def on_block(node)
+            supports_array?(node) do |plats|
+              plats.values.each do |plat|
+                next unless INVALID_PLATFORMS[plat.str_content]
+                add_offense(plat, severity: :refactor) do |corrector|
+                  correct_string = corrected_platform_source(plat)
+                  next unless correct_string
+                  corrector.replace(plat, correct_string)
+                end
+              end
+            end
+          end
+
+          # private
+
+          def corrected_platform_source(node)
+            val = INVALID_PLATFORMS[node.str_content.delete(',').downcase]
+            return false unless val
+
+            # if the value was previously quoted make sure to quote it again
+            node.source.match?(/^('|")/) ? "'" + val + "'" : val
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/chef/correctness/invalid_platform_values_in_case.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+#
+# Copyright:: 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 Correctness
+        # Use valid platform values in case statements. See [Infra Language: Platform](https://docs.chef.io/infra_language/checking_platforms/#platform-values) for a list of many common platform values.
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   case node['platform']
+        #   when 'rhel'
+        #     puts "I'm on a Red Hat system!"
+        #   end
+        #
+        class InvalidPlatformInCase < Base
+          extend AutoCorrector
+          include RangeHelp
+          include ::RuboCop::Chef::PlatformHelpers
+
+          MSG = 'Use valid platform values in case statements.'
+          RESTRICT_ON_SEND = [:[]].freeze
+
+          def_node_matcher :node_platform?, <<-PATTERN
+            (send (send nil? :node) :[] (str "platform") )
+          PATTERN
+
+          def on_case(node)
+            node_platform?(node.condition) do
+              node.each_when do |when_node|
+                when_node.each_condition do |con|
+                  next unless con.str_type? # if the condition isn't a string we can't check so skip
+                  new_value = INVALID_PLATFORMS[con.str_content]
+                  # some invalid platform have no direct correction value and return nil instead
+                  next unless new_value
+
+                  add_offense(con, severity: :refactor) do |corrector|
+                    # if the correct value already exists in the when statement then we just want to delete this node
+                    if con.parent.conditions.any? { |x| x.str_content == new_value }
+                      range = range_with_surrounding_comma(range_with_surrounding_space(range: con.loc.expression, side: :left), :both)
+                      corrector.remove(range)
+                    else
+                      corrector.replace(con, "'#{new_value}'")
+                    end
+                  end
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end