cookstyle 5.4.13 → 5.5.7

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

@@ -18,73 +18,73 @@
 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'
-      #
+      module ChefCorrectness
+        # 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
 
-      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
 
-        MSG = 'metadata.rb "supports" platform is invalid'.freeze
+          def_node_matcher :supports?, '(send nil? :supports $str ...)'
 
-        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)
+          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
-        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}'")
+          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
-        end
 
-        # private
+          # private
 
-        def autocorrect_license_string(bad_string)
-          COMMON_TYPOS[bad_string.delete(',').downcase.to_sym]
+          def autocorrect_license_string(bad_string)
+            COMMON_TYPOS[bad_string.delete(',').downcase.to_sym]
+          end
         end
       end
     end

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

@@ -25,29 +25,31 @@ module RuboCop
       #   # good
       #   name 'foo'
       #
-      class MetadataMissingName < Cop
-        include RangeHelp
+      module ChefCorrectness
+        class MetadataMissingName < Cop
+          include RangeHelp
 
-        MSG = 'metadata.rb needs to include the name method'.freeze
+          MSG = 'metadata.rb needs to include the name method'.freeze
 
-        def investigate(processed_source)
-          return if processed_source.blank?
+          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)
+            # 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
+            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 ...)'
+          def_node_search :cb_name, '(send nil? :name str ...)'
 
-        def autocorrect(_node)
-          lambda do |_corrector|
-            path = processed_source.path
-            cb_name = File.basename(File.dirname(path))
+          def autocorrect(_node)
+            lambda do |_corrector|
+              path = processed_source.path
+              cb_name = File.basename(File.dirname(path))
 
-            metadata = IO.read(path)
-            IO.write(path, "name '#{cb_name}'\n" + metadata)
+              metadata = IO.read(path)
+              IO.write(path, "name '#{cb_name}'\n" + metadata)
+            end
           end
         end
       end

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

@@ -17,75 +17,77 @@
 module RuboCop
   module Cop
     module Chef
-      # When using properties in a custom resource you shouldn't set a property to
-      # be both required and a name_property. Name properties are a way to optionally
-      # override the name given to the resource block in cookbook code. In your resource
-      # code you use the name_property and if the user doesn't pass in anything to that
-      # property its value will be populated with resource block's name. This
-      # allows users to provide more friendly resource names for logging that give
-      # additional context on the change being made.
-      #
-      # How about a nice example! Here we have a resource called ntp_config that has a
-      # name_property of config_file. All throughout the code of this resource we'd
-      # use new_resource.config_file when referencing the path to the config.
-      #
-      # We can use a friendly name for the block and specific a value to config_file
-      # ntp_config 'Configure the main config file' do
-      #   config_file '/etc/ntp/ntp.conf'
-      #   action :create
-      # end
-      #
-      # We can also just set the config path as the resource block and Chef will
-      # make sure to pass this in as new_resource.config_file as well.
-      # ntp_config '/etc/ntp/ntp.conf' do
-      #   action :create
-      # end
-      #
-      # The core tenant of the name property feature is that these properties are optional
-      # and making them required effectively turns off the functionality provided by name
-      # properties. If the goal is to always require the user to pass the config_file property
-      # then it should just be made a required property and not a name_property.
-      #
-      #
-      # @example
-      #
-      #
-      #   # bad
-      #   property :config_file, String, required: true, name_property: true
-      #
-      #
-      #   # good
-      #   property :config_file, String, required: true
-      class NamePropertyIsRequired < Cop
-        MSG = 'Resource properties marked as name properties should not also be required properties'.freeze
+      module ChefCorrectness
+        # When using properties in a custom resource you shouldn't set a property to
+        # be both required and a name_property. Name properties are a way to optionally
+        # override the name given to the resource block in cookbook code. In your resource
+        # code you use the name_property and if the user doesn't pass in anything to that
+        # property its value will be populated with resource block's name. This
+        # allows users to provide more friendly resource names for logging that give
+        # additional context on the change being made.
+        #
+        # How about a nice example! Here we have a resource called ntp_config that has a
+        # name_property of config_file. All throughout the code of this resource we'd
+        # use new_resource.config_file when referencing the path to the config.
+        #
+        # We can use a friendly name for the block and specific a value to config_file
+        # ntp_config 'Configure the main config file' do
+        #   config_file '/etc/ntp/ntp.conf'
+        #   action :create
+        # end
+        #
+        # We can also just set the config path as the resource block and Chef will
+        # make sure to pass this in as new_resource.config_file as well.
+        # ntp_config '/etc/ntp/ntp.conf' do
+        #   action :create
+        # end
+        #
+        # The core tenant of the name property feature is that these properties are optional
+        # and making them required effectively turns off the functionality provided by name
+        # properties. If the goal is to always require the user to pass the config_file property
+        # then it should just be made a required property and not a name_property.
+        #
+        #
+        # @example
+        #
+        #
+        #   # bad
+        #   property :config_file, String, required: true, name_property: true
+        #
+        #   # good
+        #   property :config_file, String, required: true
+        #
+        class NamePropertyIsRequired < Cop
+          MSG = 'Resource properties marked as name properties should not also be required properties'.freeze
 
-        def on_send(node)
-          if required_property?(node) && property_is_name_property?(node)
-            add_offense(node, location: :expression, message: MSG, severity: :refactor)
+          def on_send(node)
+            if required_property?(node) && property_is_name_property?(node)
+              add_offense(node, location: :expression, message: MSG, severity: :refactor)
+            end
           end
-        end
 
-        private
+          private
 
-        def property_is_name_property?(node)
-          if node.method_name == :property
-            node.arguments.each do |arg|
-              if arg.type == :hash
-                return true if arg.source.match?(/name_property:\s*true/)
+          def property_is_name_property?(node)
+            if node.method_name == :property
+              node.arguments.each do |arg|
+                if arg.type == :hash
+                  return true if arg.source.match?(/name_property:\s*true/)
+                end
               end
+              false # no required: true found
             end
-            false # no required: true found
           end
-        end
 
-        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 default: found
             end
-            false # no default: found
           end
         end
       end

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

@@ -16,35 +16,37 @@
 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
+      module ChefCorrectness
+        # 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_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)
+          def on_send(node)
+            node_normal?(node) do
+              add_offense(node, location: :expression, message: MSG, severity: :refactor)
+            end
           end
         end
       end

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

@@ -16,35 +16,37 @@
 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
+      module ChefCorrectness
+        # 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_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)
+          def on_send(node)
+            node_normal_unless?(node) do
+              add_offense(node, location: :expression, message: MSG, severity: :refactor)
+            end
           end
         end
       end

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

@@ -0,0 +1,46 @@
+#
+# 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
+        # Don't use node.save to save partial node data to the Chef Infra Server mid-run unless it's
+        # absolutely necessary. Node.save can result in failed Chef Infra runs appearing in search and
+        # increases load on the Chef Infra Server."
+        #
+        # @example
+        #
+        #   # bad
+        #   node.save
+        #
+        class CookbookUsesNodeSave < Cop
+          MSG = "Don't use node.save to save partial node data to the Chef Infra Server mid-run unless it's absolutely necessary. Node.save can result in failed Chef Infra runs appearing in search and increases load on the Chef Infra Server.".freeze
+
+          def_node_matcher :node_save?, <<-PATTERN
+            (send (send nil? :node) :save)
+          PATTERN
+
+          def on_send(node)
+            node_save?(node) do
+              add_offense(node, location: :expression, message: MSG, severity: :refactor)
+            end
+          end
+        end
+      end
+    end
+  end
+end