cookstyle 5.15.7 → 5.16.10

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

@@ -34,6 +34,10 @@ module RuboCop
         #   chef_version '>= 13'
         #
         class RespondToInMetadata < Cop
+          extend TargetChefVersion
+
+          minimum_target_chef_version '12.15'
+
           MSG = 'It is no longer necessary to use respond_to? or if_defined? in metadata.rb in Chef Infra Client 12.15 and later'.freeze
 
           def on_if(node)

data/lib/rubocop/cop/chef/modernize/sc_windows_resource.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
+      module ChefModernize
+        # The sc_windows resource from the sc cookbook allowed for the creation of windows services on legacy Chef Infra Client releases. Chef Infra Client 14.0 and later includes :create, :delete, and :configure actions without the need for additional cookbook dependencies. See the windows_service documentation at https://docs.chef.io/resource_windows_service.html for additional details on creating services with the windows_service resource.
+        #
+        #   # bad
+        #   sc_windows 'chef-client' do
+        #     path "C:\\opscode\\chef\\bin"
+        #     action :create
+        #   end
+        #
+        #   # good
+        #   windows_service 'chef-client' do
+        #     action :create
+        #     binary_path_name "C:\\opscode\\chef\\bin"
+        #   end
+        #
+        class WindowsScResource < Cop
+          extend TargetChefVersion
+
+          minimum_target_chef_version '14.0'
+
+          MSG = 'Chef Infra Client 14.0 and later includes :create, :delete, and :configure actions without the need for the sc cookbook dependency. See the windows_service documentation at https://docs.chef.io/resource_windows_service.html for additional details.'.freeze
+
+          def on_send(node)
+            add_offense(node, location: :expression, message: MSG, severity: :refactor) if node.method_name == :sc_windows
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -29,6 +29,10 @@ module RuboCop
         #   end
         #
         class SevenZipArchiveResource < Cop
+          extend TargetChefVersion
+
+          minimum_target_chef_version '15.0'
+
           MSG = 'Use the archive_file resource built into Chef Infra Client 15+ instead of the seven_zip_archive'.freeze
 
           def on_send(node)

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

@@ -18,8 +18,7 @@ module RuboCop
   module Cop
     module Chef
       module ChefModernize
-        # The sysctl_param resource was renamed to sysctl when it was added to Chef Infra Client
-        # 14.0. The new resource name should be used.
+        # The sysctl_param resource was renamed to sysctl when it was added to Chef Infra Client 14.0. The new resource name should be used.
         #
         #   # bad
         #   sysctl_param 'fs.aio-max-nr' do
@@ -33,6 +32,9 @@ module RuboCop
         #
         class SysctlParamResource < Cop
           include RuboCop::Chef::CookbookHelpers
+          extend TargetChefVersion
+
+          minimum_target_chef_version '14.0'
 
           MSG = 'The sysctl_param resource was renamed to sysctl when it was added to Chef Infra Client 14.0. The new resource name should be used.'.freeze
 

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

@@ -28,6 +28,10 @@ module RuboCop
         #   end
         #
         class WhyRunSupportedTrue < Cop
+          extend TargetChefVersion
+
+          minimum_target_chef_version '13.0'
+
           MSG = 'whyrun_supported? no longer needs to be set to true as it is the default in Chef Infra Client 13+'.freeze
 
           def on_def(node)

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

@@ -18,8 +18,7 @@ module RuboCop
   module Cop
     module Chef
       module ChefModernize
-        # Don't include the windows default recipe that is either full of gem install that are part
-        # of the Chef Infra Client, or empty (depends on version).
+        # Don't include the windows default recipe that is either full of gem install that are part of the Chef Infra Client, or empty (depends on version).
         #
         # @example
         #

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

@@ -28,6 +28,10 @@ module RuboCop
         #   end
         #
         class WindowsZipfileUsage < Cop
+          extend TargetChefVersion
+
+          minimum_target_chef_version '15.0'
+
           MSG = 'Use the archive_file resource built into Chef Infra Client 15+ instead of the windows_zipfile from the Windows cookbook'.freeze
 
           def on_send(node)

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

@@ -30,6 +30,9 @@ module RuboCop
         #
         class ZipfileResource < Cop
           include RuboCop::Chef::CookbookHelpers
+          extend TargetChefVersion
+
+          minimum_target_chef_version '15.0'
 
           MSG = 'Use the archive_file resource built into Chef Infra Client 15+ instead of the zipfile resource from the zipfile cookbook.'.freeze
 

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

@@ -39,6 +39,10 @@ module RuboCop
         #   end
         #
         class UsesZypperRepo < Cop
+          extend TargetChefVersion
+
+          minimum_target_chef_version '13.3'
+
           MSG = 'The zypper_repo resource was renamed zypper_repository when it was added to Chef Infra Client 13.3.'.freeze
 
           def on_send(node)

data/lib/rubocop/cop/chef/redundant/custom_resource_with_allowed_actions.rb

@@ -18,7 +18,7 @@
 module RuboCop
   module Cop
     module Chef
-      module ChefRedundant
+      module ChefRedundantCode
         # It is not necessary to set `actions` or `allowed_actions` in custom resources as Chef Infra Client determines these automatically from the set of all actions defined in the resource.
         #
         # @example

data/lib/rubocop/cop/chef/redundant/long_description_metadata.rb

@@ -26,7 +26,6 @@ module RuboCop
         #   # bad
         #   long_description 'this is my cookbook and this description will never be seen'
         #
-
         class LongDescriptionMetadata < Cop
           include RangeHelp
 

data/lib/rubocop/cop/chef/redundant/sensitive_property_in_resource.rb

@@ -0,0 +1,48 @@
+#
+# 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 ChefRedundantCode
+        # Every Chef Infra resources already include a sensitive property with a default value of false.
+        #
+        # # bad
+        # property :sensitive, [true, false], default: false
+        #
+        class SensitivePropertyInResource < Cop
+          MSG = 'Every Chef Infra resources already include a sensitive property with a default value of false.'.freeze
+
+          def_node_matcher :sensitive_property?, <<-PATTERN
+            (send nil? {:property :attribute} (sym :sensitive) ... (hash (pair (sym :default) (false))))
+          PATTERN
+
+          def on_send(node)
+            if sensitive_property?(node)
+              add_offense(node, location: :expression, message: MSG, severity: :refactor)
+            end
+          end
+
+          def autocorrect(node)
+            lambda do |corrector|
+              corrector.remove(node.source_range)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/chef/redundant/unnecessary_desired_state.rb

@@ -0,0 +1,57 @@
+#
+# 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 ChefRedundantCode
+        # There is no need to set a property to desired_state: true as all properties have a desired_state of true by default.
+        #
+        # @example
+        #
+        #   # bad
+        #   property :foo, String, desired_state: true
+        #
+        class UnnecessaryDesiredState < Cop
+          include RangeHelp
+
+          MSG = 'There is no need to set a property to desired_state: true as all properties have a desired_state of true by default.'.freeze
+
+          def_node_matcher :property?, <<-PATTERN
+            (send nil? {:property :attribute} (sym _) ... $(hash ...))
+          PATTERN
+
+          def on_send(node)
+            property?(node) do |hash_vals|
+              hash_vals.each_pair do |k, v|
+                if k == s(:sym, :desired_state) && v == s(:true) # cookstyle: disable Lint/BooleanSymbol
+                  add_offense(v.parent, location: :expression, message: MSG, severity: :refactor)
+                end
+              end
+            end
+          end
+
+          def autocorrect(node)
+            lambda do |corrector|
+              range = range_with_surrounding_comma(range_with_surrounding_space(range: node.loc.expression, side: :left), :left)
+              corrector.remove(range)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/chef/redundant/unnecessary_name_property.rb

@@ -18,26 +18,29 @@ module RuboCop
   module Cop
     module Chef
       module ChefRedundantCode
-        # There is no need to define a property named :name in a resource as Chef Infra defines that property for all resources by default.
+        # There is no need to define a property or attribute named :name in a resource as Chef Infra defines this on all resources by default.
         #
         # @example
         #
         #   # bad
         #   property :name, String
         #   property :name, String, name_property: true
+        #   attribute :name, String
+        #   attribute :name, String, name_attribute: true
         #
         class UnnecessaryNameProperty < Cop
-          MSG = 'There is no need to define a property named :name in a resource as Chef Infra defines that property for all resources by default.'.freeze
+          MSG = 'There is no need to define a property or attribute named :name in a resource as Chef Infra defines this on all resources by default.'.freeze
 
+          # match on a property/attribute named :name that's a string. The property/attribute optionally
+          # set name_property/name_attribute true, but nothing else is allowed. If you're doing that it's
+          # no longer the default and your usage is fine.
           def_node_matcher :name_property?, <<-PATTERN
-            (send nil? :property (sym :name) (const nil? :String) $...)
+            (send nil? {:property :attribute} (sym :name) (const nil? :String) (hash (pair (sym {:name_attribute :name_property}) (true)))?)
           PATTERN
 
           def on_send(node)
-            name_property?(node) do |hash_vals|
-              if hash_vals.empty? || (hash_vals.first.keys.count == 1 && hash_vals.first.keys.first.source == 'name_property')
-                add_offense(node, location: :expression, message: MSG, severity: :refactor)
-              end
+            name_property?(node) do
+              add_offense(node, location: :expression, message: MSG, severity: :refactor)
             end
           end
 

data/lib/rubocop/cop/chef/style/immediate_notification_timing.rb

@@ -0,0 +1,59 @@
+#
+# 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 ChefStyle
+        # Use :immediately instead of :immediate for resource notification timing
+        #
+        # @example
+        #
+        #   # bad
+        #
+        #   template '/etc/www/configures-apache.conf' do
+        #     notifies :restart, 'service[apache]', :immediate
+        #   end
+        #
+        #   # good
+        #
+        #   template '/etc/www/configures-apache.conf' do
+        #     notifies :restart, 'service[apache]', :immediately
+        #   end
+        #
+        class ImmediateNotificationTiming < Cop
+          MSG = 'Use :immediately instead of :immediate for resource notification timing'.freeze
+
+          def_node_matcher :immediate_notify?, <<-PATTERN
+            (send nil? :notifies (sym _) (...) $(sym :immediate))
+          PATTERN
+
+          def on_send(node)
+            immediate_notify?(node) do |timing|
+              add_offense(timing, location: :expression, message: MSG, severity: :refactor)
+            end
+          end
+
+          def autocorrect(node)
+            lambda do |corrector|
+              corrector.replace(node.loc.expression, ':immediately')
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/chef/style/true_false_resource_properties.rb

@@ -0,0 +1,55 @@
+#
+# 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 ChefStyle
+        # When setting the allowed types for a resource to accept either true or false values it's much simpler to use true and false instead of TrueClass and FalseClass.
+        #
+        # @example
+        #
+        #   # bad
+        #   property :foo, [TrueClass, FalseClass]
+        #
+        #   # good
+        #   property :foo, [true, false]
+        #
+        class TrueClassFalseClassResourceProperties < Cop
+          MSG = "When setting the allowed types for a resource to accept either true or false values it's much simpler to use true and false instead of TrueClass and FalseClass.".freeze
+
+          def_node_matcher :trueclass_falseclass_property?, <<-PATTERN
+            (send nil? {:property :attribute} (sym _) $(array (const nil? :TrueClass) (const nil? :FalseClass)) ... )
+          PATTERN
+
+          def on_send(node)
+            trueclass_falseclass_property?(node) do
+              add_offense(node, location: :expression, message: MSG, severity: :refactor)
+            end
+          end
+
+          def autocorrect(node)
+            lambda do |corrector|
+              trueclass_falseclass_property?(node) do |types|
+                corrector.replace(types.loc.expression, '[true, false]')
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/chef/style/unnecessary_platform_case_statement.rb

@@ -0,0 +1,90 @@
+#
+# 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 ChefStyle
+        # Use the platform?() and platform_family?() helpers instead of a case statement that only includes a single when statement.
+        #
+        # @example
+        #
+        #   # bad
+        #   case node['platform']
+        #   when 'ubuntu'
+        #     log "We're on Ubuntu"
+        #     apt_update
+        #   end
+        #
+        #   case node['platform_family']
+        #   when 'rhel'
+        #     include_recipe 'yum'
+        #   end
+        #
+        #   # good
+        #   if platform?('ubuntu')
+        #     log "We're on Ubuntu"
+        #     apt_update
+        #   end
+        #
+        #   include_recipe 'yum' if platform_family?('rhel')
+        #
+        class UnnecessaryPlatformCaseStatement < Cop
+          include RangeHelp
+
+          MSG = 'Use the platform?() and platform_family?() helpers instead of a case statement that only includes a single when statement.'.freeze
+
+          def_node_matcher :platform_case?, <<-PATTERN
+          ( case $( send (send nil? :node) :[] $(str {"platform" "platform_family"})) ... )
+          PATTERN
+
+          def on_case(node)
+            platform_case?(node) do
+              add_offense(node, location: :expression, message: MSG, severity: :refactor) if node&.when_branches&.count == 1
+            end
+          end
+
+          def autocorrect(node)
+            lambda do |corrector|
+              platform_case?(node) do |node_, type|
+                condition_string = node.when_branches.first.conditions.map(&:source).join(', ')
+
+                # single line bodies without an else statement should be transformed into `X if platform?('ubuntu')` style statements
+                # while multiline statements should just have the case and when bits replace with `if platform?('ubuntu')`
+                if !node.else? && !node.when_branches.first.body.multiline?
+                  new_source = "#{node.when_branches.first.body.source} if #{type.value}?(#{condition_string})"
+                  corrector.replace(node.loc.expression, new_source)
+                else
+                  # find the range from the beginning of the case to the end of the node['platform'] or node['platform_family']
+                  case_range = node.loc.keyword.join(node_.loc.expression.end)
+
+                  # replace the complete conditional range with a new if statement
+                  corrector.replace(case_range, "if #{type.value}?(#{condition_string})")
+
+                  # find the range from the start of the when to the end of the last argument
+                  conditional_range = node.when_branches.first.conditions[-1].source_range.join(node.when_branches.first.loc.keyword.begin)
+
+                  # remove the when XYZ condition along with any leading spaces so that we remove the whole empty line
+                  corrector.remove(range_with_surrounding_space(range: conditional_range, side: :left))
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end