cookstyle 5.4.13 → 5.5.7

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

@@ -0,0 +1,47 @@
+#
+# 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
+      module ChefCorrectness
+        # The Ohai default recipe previously allowed a user to ship custom Ohai plugins to a system by including them
+        # in a directory in the Ohai cookbook. This functionality was replaced with the ohai_plugin resource, which
+        # should be used instead as it doesn't require forking the ohai cookbook.
+        #
+        # @example
+        #
+        #   # bad
+        #   include_recipe 'ohai::default'
+        #   include_recipe 'ohai'
+        #
+        class IncludingOhaiDefaultRecipe < Cop
+          MSG = "Use the ohai_plugin resource to ship custom Ohai plugins instead of using the ohai::default recipe. If you're not shipping custom Ohai plugins, then you can remove this recipe entirely".freeze
+
+          def_node_matcher :ohai_recipe_usage?, <<-PATTERN
+            (send nil? :include_recipe (str {"ohai" "ohai::default"}))
+          PATTERN
+
+          def on_send(node)
+            ohai_recipe_usage?(node) do
+              add_offense(node, location: :expression, message: MSG, severity: :refactor)
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -17,49 +17,51 @@
 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. In Chef
-      # Infra Client 13+ this became an error.
-      #
-      # @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. This will fail on Chef Infra Client 13+'.freeze
+      module ChefCorrectness
+        # 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. In Chef
+        # Infra Client 13+ this became an error.
+        #
+        # @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. This will fail on Chef Infra Client 13+'.freeze
 
-        def on_send(node)
-          if required_property?(node) && property_has_default?(node)
-            add_offense(node, location: :expression, message: MSG, severity: :refactor)
+          def on_send(node)
+            if required_property?(node) && property_has_default?(node)
+              add_offense(node, location: :expression, message: MSG, severity: :refactor)
+            end
           end
-        end
 
-        private
+          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/)
+          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
-            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:/)
+          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
-            false # no default: found
           end
         end
       end

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

@@ -17,40 +17,42 @@
 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
+      module ChefCorrectness
+        # 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 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'))
+          def autocorrect(node)
+            lambda do |corrector|
+              corrector.replace(node.loc.expression, node.source.gsub('name_attribute', 'name_property'))
+            end
           end
-        end
 
-        private
+          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:/)
+          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
-            false # no name_attribute found
           end
         end
       end

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

@@ -0,0 +1,52 @@
+#
+# 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
+      module ChefCorrectness
+        # Chef Infra Client uses properties in several resources to track state. These
+        # should not be set in recipes as they break the internal workings of the Chef
+        # Infra Client
+        #
+        # @example
+        #
+        #   # bad
+        #   service 'foo' do
+        #     running true
+        #     action [:start, :enable]
+        #   end
+        #
+        #   # good
+        #   service 'foo' do
+        #     action [:start, :enable]
+        #   end
+        #
+        class ResourceSetsInternalProperties < Cop
+          include RuboCop::Chef::CookbookHelpers
+
+          MSG = 'Do not set properties used internally by Chef Infra Client to track the system state.'.freeze
+
+          def on_block(node)
+            match_property_in_resource?(:service, 'running', node) do |prop|
+              add_offense(prop, location: :expression, message: MSG, severity: :refactor)
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,51 @@
+#
+# 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
+      module ChefCorrectness
+        # Use name properties instead of setting the name property in a resource. Setting the name property
+        # directly causes notification and reporting issues.
+        #
+        # @example
+        #
+        #   # bad
+        #   service 'foo' do
+        #    name 'bar'
+        #   end
+        #
+        #   # good
+        #   service 'foo' do
+        #    service_name 'bar'
+        #   end
+        #
+        class ResourceSetsNameProperty < Cop
+          include RuboCop::Chef::CookbookHelpers
+
+          MSG = 'Resource sets the name property in the resource instead of using a name_property.'.freeze
+
+          def on_block(node)
+            match_property_in_resource?(nil, 'name', node) do |name_node|
+              add_offense(name_node, location: :expression, message: MSG, severity: :refactor)
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,52 @@
+#
+# 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
+      module ChefCorrectness
+        # The :nothing action is often typo'd as :none
+        #
+        # @example
+        #
+        #   # bad
+        #   service 'foo' do
+        #    action :none
+        #   end
+        #
+        #   # good
+        #   service 'foo' do
+        #    action :nothing
+        #   end
+        #
+        class ResourceWithNoneAction < Cop
+          include RuboCop::Chef::CookbookHelpers
+
+          MSG = 'Resource uses the nonexistent :none action instead of the :nothing action'.freeze
+
+          def on_block(node)
+            match_property_in_resource?(nil, 'action', node) do |action_node|
+              action_node.arguments.each do |action|
+                add_offense(action, location: :expression, message: MSG, severity: :refactor) if action.source == ':none'
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -17,35 +17,37 @@
 module RuboCop
   module Cop
     module Chef
-      # Use a service resource to start and stop services
-      #
-      # @example when command starts a service
-      #
-      #   # bad
-      #   command "/etc/init.d/mysql start"
-      #   command "/sbin/service/memcached start"
-      #
-      class ServiceResource < Cop
-        MSG = 'Use a service resource to start and stop services'.freeze
+      module ChefCorrectness
+        # Use a service resource to start and stop services
+        #
+        # @example when command starts a service
+        #
+        #   # bad
+        #   command "/etc/init.d/mysql start"
+        #   command "/sbin/service/memcached start"
+        #
+        class ServiceResource < Cop
+          MSG = 'Use a service resource to start and stop services'.freeze
 
-        def_node_matcher :execute_command?, <<-PATTERN
-          (send nil? :command $str)
-        PATTERN
+          def_node_matcher :execute_command?, <<-PATTERN
+            (send nil? :command $str)
+          PATTERN
 
-        def on_send(node)
-          execute_command?(node) do |command|
-            if starts_service?(command)
-              add_offense(command, location: :expression, message: MSG, severity: :refactor)
+          def on_send(node)
+            execute_command?(node) do |command|
+              if starts_service?(command)
+                add_offense(command, location: :expression, message: MSG, severity: :refactor)
+              end
             end
           end
-        end
 
-        def starts_service?(cmd)
-          cmd_str = cmd.to_s
-          (cmd_str.include?('/etc/init.d') || ['service ', '/sbin/service ',
-                                               'start ', 'stop ', 'invoke-rc.d '].any? do |service_cmd|
-             cmd_str.start_with?(service_cmd)
-           end) && %w(start stop restart reload).any? { |a| cmd_str.include?(a) }
+          def starts_service?(cmd)
+            cmd_str = cmd.to_s
+            (cmd_str.include?('/etc/init.d') || ['service ', '/sbin/service ',
+                                                 'start ', 'stop ', 'invoke-rc.d '].any? do |service_cmd|
+               cmd_str.start_with?(service_cmd)
+             end) && %w(start stop restart reload).any? { |a| cmd_str.include?(a) }
+          end
         end
       end
     end

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

@@ -17,40 +17,42 @@
 module RuboCop
   module Cop
     module Chef
-      # Use file_cache_path rather than hard-coding tmp paths
-      #
-      # @example downloading a large file into /tmp/
-      #
-      #   # bad
-      #   remote_file '/tmp/large-file.tar.gz' do
-      #
-      #   # good
-      #   remote_file "#{Chef::Config[:file_cache_path]}/large-file.tar.gz" do
-      #
-      #
-      class TmpPath < Cop
-        MSG = 'Use file_cache_path rather than hard-coding tmp paths'.freeze
+      module ChefCorrectness
+        # Use file_cache_path rather than hard-coding tmp paths
+        #
+        # @example downloading a large file into /tmp/
+        #
+        #   # bad
+        #   remote_file '/tmp/large-file.tar.gz' do
+        #
+        #   # good
+        #   remote_file "#{Chef::Config[:file_cache_path]}/large-file.tar.gz" do
+        #
+        #
+        class TmpPath < Cop
+          MSG = 'Use file_cache_path rather than hard-coding tmp paths'.freeze
 
-        def_node_matcher :remote_file?, <<-PATTERN
-          (send nil? :remote_file $str)
-        PATTERN
+          def_node_matcher :remote_file?, <<-PATTERN
+            (send nil? :remote_file $str)
+          PATTERN
 
-        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: :refactor)
+          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: :refactor)
+              end
             end
           end
-        end
 
-        def hardcoded_tmp?(path)
-          path_str = path.to_s.scan(/"(.*)"/)[0][0]
-          path_str.start_with?('/tmp/')
-        end
+          def hardcoded_tmp?(path)
+            path_str = path.to_s.scan(/"(.*)"/)[0][0]
+            path_str.start_with?('/tmp/')
+          end
 
-        def file_cache_path?(path)
-          path_str = path.to_s.scan(/"(.*)"/)[0][0]
-          path_str.start_with?("\#\{Chef::Config[:file_cache_path]\}")
+          def file_cache_path?(path)
+            path_str = path.to_s.scan(/"(.*)"/)[0][0]
+            path_str.start_with?("\#\{Chef::Config[:file_cache_path]\}")
+          end
         end
       end
     end