cookstyle 5.0.4 → 5.1.19

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

@@ -0,0 +1,53 @@
+#
+# Copyright:: Copyright 2019-2019, Chef Software Inc.
+#
+# 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
+      # Normal attributes are discouraged since their semantics differ importantly from the
+      # default and override levels.  Their values persist in the node object even after
+      # all code referencing them has been deleted, unlike default and override.
+      #
+      # Code should be updated to use default or override levels, but this will change
+      # attribute merging behavior so needs to be validated manually and force_default or
+      # force_override levels may need to be used in recipe code.
+      #
+      # @example
+      #
+      #   # bad
+      #   node.normal['foo'] = true
+      #
+      #   # good
+      #   node.default['foo'] = true
+      #   node.override['foo'] = true
+      #   node.force_default['foo'] = true
+      #   node.force_override['foo'] = true
+      #
+      class NodeNormal < Cop
+        MSG = 'Do not use node.normal. Replace with default/override/force_default/force_override attribute levels.'.freeze
+
+        def_node_matcher :node_normal?, <<-PATTERN
+          (send (send _ :node) :normal)
+        PATTERN
+
+        def on_send(node)
+          node_normal?(node) do
+            add_offense(node, location: :expression, message: MSG, severity: :refactor)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,53 @@
+#
+# Copyright:: Copyright 2019-2019, Chef Software Inc.
+#
+# 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
+      # Normal attributes are discouraged since their semantics differ importantly from the
+      # default and override levels.  Their values persist in the node object even after
+      # all code referencing them has been deleted, unlike default and override.
+      #
+      # Code should be updated to use default or override levels, but this will change
+      # attribute merging behavior so needs to be validated manually and force_default or
+      # force_override levels may need to be used in recipe code.
+      #
+      # @example
+      #
+      #   # bad
+      #   node.normal_unless['foo'] = true
+      #
+      #   # good
+      #   node.default_unless['foo'] = true
+      #   node.override_unless['foo'] = true
+      #   node.force_default_unless['foo'] = true
+      #   node.force_override_unless['foo'] = true
+      #
+      class NodeNormalUnless < Cop
+        MSG = 'Do not use node.normal_unless. Replace with default/override/force_default/force_override attribute levels.'.freeze
+
+        def_node_matcher :node_normal_unless?, <<-PATTERN
+          (send (send _ :node) :normal_unless)
+        PATTERN
+
+        def on_send(node)
+          node_normal_unless?(node) do
+            add_offense(node, location: :expression, message: MSG, severity: :refactor)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,67 @@
+#
+# Copyright:: Copyright 2019, Chef Software Inc.
+# Author:: Tim Smith (<tsmith@chef.io>)
+#
+# 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
+      # When using properties in a custom resource you shouldn't set a property to
+      # required and then provide a default value. If a property is required the
+      # user will always pass in a value and the default will never be used.
+      #
+      # @example
+      #
+      #   # bad
+      #   property :bob, String, required: true, default: 'foo'
+      #
+      #   # good
+      #   property :bob, String, required: true
+      #
+      class PropertyWithRequiredAndDefault < Cop
+        MSG = 'Resource property should not be both required and have a default value'.freeze
+
+        def on_send(node)
+          if required_property?(node) && property_has_default?(node)
+            add_offense(node, location: :expression, message: MSG, severity: :refactor)
+          end
+        end
+
+        private
+
+        def required_property?(node)
+          if node.method_name == :property
+            node.arguments.each do |arg|
+              if arg.type == :hash
+                return true if arg.source.match?(/required:\s*true/)
+              end
+            end
+            false # no required: true found
+          end
+        end
+
+        def property_has_default?(node)
+          if node.method_name == :property
+            node.arguments.each do |arg|
+              if arg.type == :hash
+                return true if arg.source.match?(/default:/)
+              end
+            end
+            false # no default: found
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,59 @@
+#
+# Copyright:: Copyright 2019, Chef Software Inc.
+# Author:: Tim Smith (<tsmith@chef.io>)
+#
+# 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
+      # When using properties in a custom resource you should use name_property not
+      # the legacy name_attribute from the days of attributes
+      #
+      # @example
+      #
+      #   # bad
+      #   property :bob, String, name_attribute: true
+      #
+      #   # good
+      #   property :bob, String, name_property: true
+      #
+      class PropertyWithNameAttribute < Cop
+        MSG = 'Resource property sets name_attribute not name_property'.freeze
+
+        def on_send(node)
+          add_offense(node, location: :expression, message: MSG, severity: :refactor) if attribute_method_mix?(node)
+        end
+
+        def autocorrect(node)
+          lambda do |corrector|
+            corrector.replace(node.loc.expression, node.source.gsub('name_attribute', 'name_property'))
+          end
+        end
+
+        private
+
+        def attribute_method_mix?(node)
+          if node.method_name == :property
+            node.arguments.each do |arg|
+              if arg.type == :hash
+                return true if arg.source.match?(/name_attribute:/)
+              end
+            end
+            false # no name_attribute found
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/chef/{service_resource.rb → correctness/service_resource.rb}

@@ -35,7 +35,7 @@ module RuboCop
         def on_send(node)
           execute_command?(node) do |command|
             if starts_service?(command)
-              add_offense(command, location: :expression, message: MSG, severity: :warning)
+              add_offense(command, location: :expression, message: MSG, severity: :refactor)
             end
           end
         end

data/lib/rubocop/cop/chef/{tmp_path.rb → correctness/tmp_path.rb}

@@ -38,7 +38,7 @@ module RuboCop
         def on_send(node)
           remote_file?(node) do |command|
             if hardcoded_tmp?(command) && !file_cache_path?(command)
-              add_offense(command, location: :expression, message: MSG, severity: :warning)
+              add_offense(command, location: :expression, message: MSG, severity: :refactor)
             end
           end
         end

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

@@ -0,0 +1,49 @@
+#
+# Copyright:: 2019, Chef Software Inc.
+# Author:: Tim Smith (<tsmith@chef.io>)
+#
+# 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
+      # Don't use the deprecated 'attribute' metadata value
+      #
+      # @example
+      #
+      #   # bad 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 < Cop
+        MSG = "Don't use the deprecated 'attribute' metadata value".freeze
+
+        def on_send(node)
+          add_offense(node, location: :expression, message: MSG, severity: :refactor) if node.method_name == :attribute
+        end
+
+        def autocorrect(node)
+          lambda do |corrector|
+            corrector.remove(node.loc.expression)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,44 @@
+#
+# Copyright:: 2019, Chef Software Inc.
+# Author:: Tim Smith (<tsmith@chef.io>)
+#
+# 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
+      # Don't use the deprecated 'conflicts' metadata value
+      #
+      # @example
+      #
+      #   # bad in metadata.rb:
+      #
+      #   conflicts "another_cookbook"
+      #
+      class ConflictsMetadata < Cop
+        MSG = "Don't use the deprecated 'conflicts' metadata value".freeze
+
+        def on_send(node)
+          add_offense(node, location: :expression, message: MSG, severity: :refactor) if node.method_name == :conflicts
+        end
+
+        def autocorrect(node)
+          lambda do |corrector|
+            corrector.remove(node.loc.expression)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,48 @@
+#
+# Copyright:: 2019, Chef Software, Inc.
+# Author:: Tim Smith (<tsmith@chef.io>)
+#
+# 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
+      # Don't depend on the deprecated compat_resource cookbook made obsolete by Chef 12.19+
+      #
+      # @example
+      #
+      #   # bad
+      #   depends 'compat_resource'
+      #
+      class CookbookDependsOnCompatResource < Cop
+        MSG = "Don't depend on the deprecated compat_resource cookbook made obsolete by Chef 12.19+".freeze
+
+        def_node_matcher :depends_compat_resource?, <<-PATTERN
+          (send nil? :depends (str {"compat_resource"}))
+        PATTERN
+
+        def on_send(node)
+          depends_compat_resource?(node) do
+            add_offense(node, location: :expression, message: MSG, severity: :refactor)
+          end
+        end
+
+        def autocorrect(node)
+          lambda do |corrector|
+            corrector.remove(node.loc.expression)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,42 @@
+#
+# Copyright:: 2019, Chef Software, Inc.
+# Author:: Tim Smith (<tsmith@chef.io>)
+#
+# 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
+      # Don't depend on the partial_search cookbook made obsolete by Chef 13
+      #
+      # @example
+      #
+      #   # bad
+      #   depends 'partial_search'
+      #
+      class CookbookDependsOnPartialSearch < Cop
+        MSG = "Don't depend on the deprecated partial_search cookbook made obsolete by Chef 13".freeze
+
+        def_node_matcher :depends_partial_search?, <<-PATTERN
+          (send nil? :depends (str {"partial_search"}))
+        PATTERN
+
+        def on_send(node)
+          depends_partial_search?(node) do
+            add_offense(node, location: :expression, message: MSG, severity: :refactor)
+          end
+        end
+      end
+    end
+  end
+end