cookstyle 5.1.19 → 5.2.17

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

@@ -0,0 +1,92 @@
+#
+# 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
+      # metadata.rb supports methods should contain valid platforms
+      #
+      # @example
+      #
+      #   # bad
+      #   supports 'darwin'
+      #   supports 'mswin'
+      #
+      #
+      #   # good
+      #   supports 'mac_os_x'
+      #   supports 'windows'
+      #
+
+      class InvalidPlatformMetadata < Cop
+        COMMON_TYPOS = {
+          "aws": nil,
+          "archlinux": 'arch',
+          "amazonlinux": 'amazon',
+          "darwin": 'mac_os_x',
+          "debuan": nil,
+          "mingw32": 'windows',
+          "mswin": 'windows',
+          "macos": 'mac_os_x',
+          "macosx": 'mac_os_x',
+          "mac_os_x_server": 'mac_os_x',
+          "mint": 'linuxmint',
+          "linux": nil,
+          "oel": 'oracle',
+          "oraclelinux": 'oracle',
+          "rhel": 'redhat',
+          "schientific": 'scientific',
+          "scientificlinux": 'scientific',
+          "sles": 'suse',
+          "solaris": 'solaris2',
+          "ubundu": 'ubuntu',
+          "ubunth": 'ubuntu',
+          "ubunutu": 'ubuntu',
+          "windwos": 'windows',
+          "xcp": nil,
+        }.freeze
+
+        MSG = 'metadata.rb "supports" platform is invalid'.freeze
+
+        def_node_matcher :supports?, '(send nil? :supports $str ...)'
+
+        def on_send(node)
+          supports?(node) do |plat|
+            if COMMON_TYPOS[plat.str_content.to_sym]
+              add_offense(plat, location: :expression, message: MSG, severity: :refactor)
+            end
+          end
+        end
+
+        def autocorrect(node)
+          correct_string = autocorrect_license_string(node.str_content)
+          if correct_string
+            lambda do |corrector|
+              corrector.replace(node.loc.expression, "'#{correct_string}'")
+            end
+          end
+        end
+
+        # private
+
+        def autocorrect_license_string(bad_string)
+          COMMON_TYPOS[bad_string.delete(',').downcase.to_sym]
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,46 @@
+#
+# 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
+      # metadata.rb needs to include the name method
+      #
+      # @example
+      #
+      #   # good
+      #   name 'foo'
+      #
+      class MetadataMissingName < Cop
+        include RangeHelp
+
+        MSG = 'metadata.rb needs to include the name method'.freeze
+
+        def investigate(processed_source)
+          return if processed_source.blank?
+
+          # Using range similar to RuboCop::Cop::Naming::Filename (file_name.rb)
+          range = source_range(processed_source.buffer, 1, 0)
+
+          add_offense(nil, location: range, message: MSG, severity: :refactor) unless cb_name(processed_source.ast).any?
+        end
+
+        def_node_search :cb_name, '(send nil? :name str ...)'
+      end
+    end
+  end
+end

data/lib/rubocop/cop/chef/deprecation/long_description_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
+      # The long_description metadata.rb method is not used and is unnecessary in cookbooks
+      #
+      # @example
+      #
+      #   # bad
+      #   long_description 'this is my cookbook and this description will never be seen'
+      #
+
+      class LongDescriptionMetadata < Cop
+        MSG = 'The long_description metadata.rb method is not used and is unnecessary in cookbooks'.freeze
+
+        def on_send(node)
+          add_offense(node, location: :expression, message: MSG, severity: :refactor) if node.method_name == :long_description
+        end
+
+        def autocorrect(node)
+          lambda do |corrector|
+            corrector.remove(node.loc.expression)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,5 +1,5 @@
 #
-# Copyright:: Copyright 2019, Chef Software Inc.
+# 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.
@@ -33,18 +33,18 @@ module RuboCop
         MSG = 'Do not use node.set. Replace with node.normal to keep identical behavior.'.freeze
 
         def_node_matcher :node_set?, <<-PATTERN
-          (send (send _ :node) :set)
+          (send (send _ :node) $:set)
         PATTERN
 
         def on_send(node)
           node_set?(node) do
-            add_offense(node, location: :expression, message: MSG, severity: :refactor)
+            add_offense(node, location: :selector, message: MSG, severity: :refactor)
           end
         end
 
         def autocorrect(node)
           lambda do |corrector|
-            corrector.replace(node.loc.expression, 'node.normal')
+            corrector.replace(node.loc.selector, 'normal')
           end
         end
       end

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

@@ -33,18 +33,18 @@ module RuboCop
         MSG = 'Do not use node.set_unless. Replace with node.normal_unless to keep identical behavior.'.freeze
 
         def_node_matcher :node_set_unless?, <<-PATTERN
-          (send (send _ :node) :set_unless)
+          (send (send _ :node) $:set_unless)
         PATTERN
 
         def on_send(node)
           node_set_unless?(node) do
-            add_offense(node, location: :expression, message: MSG, severity: :refactor)
+            add_offense(node, location: :selector, message: MSG, severity: :refactor)
           end
         end
 
         def autocorrect(node)
           lambda do |corrector|
-            corrector.replace(node.loc.expression, 'node.normal_unless')
+            corrector.replace(node.loc.selector, 'normal_unless')
           end
         end
       end

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

@@ -0,0 +1,50 @@
+#
+# 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
+      # Make sure to use include_recipe instead of require_recipe
+      #
+      # @example
+      #
+      #   # bad
+      #   require_recipe 'foo'
+      #
+      #   # good
+      #   include_recipe 'foo'
+      #
+      class RequireRecipe < Cop
+        MSG = 'Use include_recipe instead of the require_recipe method'.freeze
+
+        def_node_matcher :require_recipe?, <<-PATTERN
+          (send nil? :require_recipe $str)
+        PATTERN
+
+        def on_send(node)
+          require_recipe?(node) { add_offense(node, location: :selector, message: MSG, severity: :refactor) }
+        end
+
+        def autocorrect(node)
+          lambda do |corrector|
+            corrector.replace(node.loc.selector, 'include_recipe')
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,53 @@
+#
+# 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
+      # It is not longer necessary respond_to?(:foo) in metadata. This was used to support new metadata
+      # methods in Chef 11 and early versions of Chef 12.
+      #
+      # @example
+      #
+      #   # bad
+      #   chef_version '>= 13' if respond_to?(:chef_version)
+      #
+      #   # good
+      #   chef_version '>= 13'
+      #
+
+      class RespondToInMetadata < Cop
+        MSG = 'It is no longer necessary to use respond_to? in metadata.rb in Chef 12.15 and later'.freeze
+
+        def on_if(node)
+          if_respond_to?(node) do
+            add_offense(node, location: :expression, message: MSG, severity: :refactor)
+          end
+        end
+
+        def_node_matcher :if_respond_to?, <<~PATTERN
+        (if (send nil? :respond_to? _ ) ... )
+        PATTERN
+
+        def autocorrect(node)
+          lambda do |corrector|
+            corrector.replace(node.loc.expression, node.children[1].source)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -29,7 +29,7 @@ module RuboCop
       #   # good
       #   build_essential 'install compilation tools'
       class UseBuildEssentialResource < Cop
-        MSG = 'Use the build_essential resource built into Chef 14+ instead of the legacy build-essential recipe'.freeze
+        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+'.freeze
 
         def_node_matcher :build_essential_recipe_usage?, <<-PATTERN
           (send nil? :include_recipe (str {"build-essential" "build-essential::default"}))

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

@@ -0,0 +1,50 @@
+#
+# 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
+      # set_or_return within a method should not be used to define property in a resource. Instead use
+      # the property method which properly validates and defines properties in a way that works with
+      # reporting and documentation functionality in Chef Infra Client
+      #
+      # @example
+      #
+      #   # bad
+      #    def severity(arg = nil)
+      #      set_or_return(
+      #        :severity, arg,
+      #        :kind_of => String,
+      #        :default => nil
+      #      )
+      #    end
+      #
+      #   # good
+      #   property :severity, String
+      #
+      class SetOrReturnInResources < Cop
+        MSG = 'Do not use set_or_return within a method to define a property for a resource. Use the property method instead, which supports validation, reporting, and documentation functionality'.freeze
+
+        def on_send(node)
+          if node.method_name == :set_or_return
+            add_offense(node, location: :expression, message: MSG, severity: :refactor)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,75 @@
+#
+# 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
+      # In HWRPs and LWRPs it was necessary to define the allowed actions within the resource.
+      # In custom resources this is no longer necessary as Chef will determine it based on the
+      # actions defined in the resource.
+      #
+      # @example
+      #
+      #   # bad
+      #   property :something, String
+      #
+      #   allowed_actions [:create, :remove]
+      #   action :create do
+      #     # some action code because we're in a custom resource
+      #   end
+      #
+      #   # also bad
+      #   property :something, String
+      #
+      #   actions [:create, :remove]
+      #   action :create do
+      #     # some action code because we're in a custom resource
+      #   end
+      #
+      #   # good
+      #   property :something, String
+      #
+      #   action :create do
+      #     # some action code because we're in a custom resource
+      #   end
+      #
+      class CustomResourceWithAllowedActions < Cop
+        MSG = "Custom Resources don't need to define the allowed actions with allowed_actions or actions methods".freeze
+
+        def_node_matcher :allowed_actions?, <<-PATTERN
+          (send nil? {:allowed_actions :actions} ... )
+        PATTERN
+
+        def_node_search :resource_actions?, <<-PATTERN
+          (block (send nil? :action ... ) ... )
+        PATTERN
+
+        def on_send(node)
+          allowed_actions?(node) do
+            add_offense(node, location: :expression, message: MSG, severity: :refactor) if resource_actions?(processed_source.ast)
+          end
+        end
+
+        def autocorrect(node)
+          lambda do |corrector|
+            corrector.remove(node.loc.expression)
+          end
+        end
+      end
+    end
+  end
+end