cookstyle 7.32.8 → 8.5.0

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

@@ -0,0 +1,104 @@
+# frozen_string_literal: true
+#
+# Copyright:: 2024, Chef Software Inc.
+# Author:: Sumedha (<https://github.com/sumedha-lolur>)
+#
+# 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
+        # Resource guards (not_if/only_if) should not be empty strings as empty strings will always evaluate to true.
+        # This will cause confusion in your cookbooks as the guard will always pass.
+        #
+        # Empty strings in Ruby are "truthy", which means:
+        # - `only_if ''` will ALWAYS execute the resource (guard always passes)
+        # - `not_if ''` will NEVER execute the resource (guard always blocks)
+        #
+        # This behavior is usually unintended and can lead to resources running when they shouldn't
+        # or never running when they should.
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   template '/etc/foo' do
+        #     mode '0644'
+        #     source 'foo.erb'
+        #     only_if ''  # This will always be true - resource always executes
+        #   end
+        #
+        #   cookbook_file '/logs/foo/error.log' do
+        #     source 'error.log'
+        #     not_if { '' }  # This will always be true - resource never executes
+        #   end
+        #
+        #   service 'apache2' do
+        #     action :restart
+        #     only_if { '' }  # Block form also problematic
+        #   end
+        #
+        #   ### correct
+        #   template '/etc/foo' do
+        #     mode '0644'
+        #     source 'foo.erb'
+        #     only_if 'test -f /etc/foo'  # Actual shell command
+        #   end
+        #
+        #   cookbook_file '/logs/foo/error.log' do
+        #     source 'error.log'
+        #     not_if { ::File.exist?('/logs/foo/error.log') }  # Proper Ruby expression
+        #   end
+        #
+        #   service 'apache2' do
+        #     action :restart
+        #     only_if { node['platform'] == 'ubuntu' }  # Meaningful condition
+        #   end
+        #
+        #   # Or simply remove the guard if no condition is needed
+        #   package 'curl' do
+        #     action :install
+        #   end
+        #
+        class EmptyResourceGuard < Base
+          MSG = 'Resource guards (not_if/only_if) should not be empty strings as empty strings will always evaluate to true.'
+          RESTRICT_ON_SEND = [:not_if, :only_if].freeze
+
+          def_node_matcher :empty_string_guard?, <<-PATTERN
+            (send nil? {:not_if :only_if} (str #empty_string?))
+          PATTERN
+
+          def_node_matcher :empty_string_block_guard?, <<-PATTERN
+            (block (send nil? {:not_if :only_if}) (args) (str #empty_string?))
+          PATTERN
+
+          def empty_string?(str)
+            str.empty?
+          end
+
+          def on_send(node)
+            empty_string_guard?(node) do
+              add_offense(node, severity: :refactor)
+            end
+          end
+
+          def on_block(node)
+            empty_string_block_guard?(node) do
+              add_offense(node, severity: :refactor)
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,77 +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
+# 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

@@ -1,47 +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
+# 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

@@ -1,48 +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
+# 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

@@ -1,59 +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
+# 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