cookstyle 5.19.9 → 5.20.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0f5cc0916309f625be3469422c3feb76f7e1340fca4ae99cc5110b0b80f857f6
-  data.tar.gz: 1c813c90c2bef8b8c869c4d9a826be958507a31db227c4b67ff1025192ab624c
+  metadata.gz: 5c8af7267fe94ef01b9da1d3b84c221101cdb7e8976217cbca2bd8f43c475858
+  data.tar.gz: 3f6196cac78246fc8b36a013f4bbb335470824f3ef23974869596087c8082925
 SHA512:
-  metadata.gz: 0e8ae2b07a6b712889fa67ececde059ae3063fa89627fe6937668ed101a9874bfc98d2faaf5ac36cf99063fb14c9835595052213ffc299d5bc0b5aac28502153
-  data.tar.gz: 61747c1c26cf1708cfd82ca7945850c8fb2022a18d16c33145ed805741c313ee6bb0c0fc849ba90dad4a0a65ae53e10ea9d4b0291f5b14faaafc43ea18d7a8b0
+  metadata.gz: ef274262f9b3e41204d9ee5153c9c4022958659b69a6a4d781848a523d6bb37336101fafe5c30ece1d072118b13422803bfa629ba97605c75bd9588c8ef21e36
+  data.tar.gz: 6fbff49a1400321bee3bec46011d0b3193d8460a702c9749a84e11c9992c5642e75b2e3857ab1c84461c23a31b0e5b4c4dcd186e9ea4a0cc588974fd3e28d4b7

data/config/cookstyle.yml

@@ -122,6 +122,11 @@ ChefStyle/OverlyComplexSupportsDependsMetadata:
   Include:
     - '**/metadata.rb'
 
+ChefStyle/ChefWhaaat:
+  Description: Do you mean Chef (the company) or a Chef product (e.g. Chef Infra, Chef InSpec, etc)?
+  Enabled: false
+  VersionAdded: '5.20.0'
+
 ###############################
 # ChefCorrectness: Avoiding potential problems
 ###############################
@@ -700,6 +705,13 @@ ChefDeprecations/DeprecatedPlatformMethods:
     - '**/resources/*.rb'
     - '**/providers/*.rb'
 
+ChefDeprecations/DeprecatedChefSpecPlatform:
+  Description: Use currently supported platforms in ChefSpec listed at https://github.com/chefspec/fauxhai/blob/master/PLATFORMS.md. Fauxhai / ChefSpec will perform fuzzy matching on platform version so it's always best to be less specific ie. 10 instead of 10.3
+  Enabled: true
+  VersionAdded: '5.20.0'
+  Include:
+    - '**/spec/**/*.rb'
+
 ###############################
 # ChefModernize: Cleaning up legacy code and using new built-in resources
 ###############################

data/lib/cookstyle.rb

@@ -43,7 +43,7 @@ require_relative 'rubocop/chef/platform_helpers'
 require_relative 'rubocop/chef/cookbook_only'
 require_relative 'rubocop/cop/target_chef_version'
 
-# Chef specific cops
+# Chef Infra specific cops
 Dir.glob(File.dirname(__FILE__) + '/rubocop/cop/chef/**/*.rb') do |file|
   next if File.directory?(file)
 

data/lib/cookstyle/version.rb

@@ -1,4 +1,4 @@
 module Cookstyle
-  VERSION = "5.19.9".freeze # rubocop: disable Style/StringLiterals
+  VERSION = "5.20.0".freeze # rubocop: disable Style/StringLiterals
   RUBOCOP_VERSION = '0.75.1'.freeze
 end

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

@@ -46,7 +46,9 @@ module RuboCop
 
           def autocorrect(node)
             lambda do |corrector|
-              corrector.replace(node.loc.expression, "type #{node.arguments.first.source}")
+              # make sure to delete leading and trailing {}s that would create invalid ruby syntax
+              extracted_val = node.arguments.first.source.gsub(/{|}/, '')
+              corrector.replace(node.loc.expression, "type #{extracted_val}")
             end
           end
         end

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

@@ -0,0 +1,128 @@
+#
+# Copyright:: 2020, 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 ChefDeprecations
+        # Use currently supported platforms in ChefSpec listed at https://github.com/chefspec/fauxhai/blob/master/PLATFORMS.md. Fauxhai / ChefSpec will perform fuzzy matching on platform version so it's always best to be less specific ie. 10 instead of 10.3
+        #
+        # @example
+        #
+        #   let(:chef_run) { ChefSpec::ServerRunner.new(platform: 'ubuntu', version: '14.04') }
+        #
+        class DeprecatedChefSpecPlatform < Cop
+          include RuboCop::Chef::CookbookHelpers
+
+          MSG = "Use currently supported platforms in ChefSpec listed at https://github.com/chefspec/fauxhai/blob/master/PLATFORMS.md. Fauxhai / ChefSpec will perform fuzzy matching on platform version so it's always best to be less specific ie. 10 instead of 10.3".freeze
+
+          Gem::Dependency.new('', ['~> 1.4.5', '>= 1.4.6']).match?('', '1.4.6')
+
+          DEPRECATED_MAPPING = {
+            'amazon' => {
+              '2017.12' => '2',
+            },
+            'aix' => {
+              '~> 6' => true,
+            },
+            'smartos' => {
+              '5.10' => true,
+            },
+            'ubuntu' => {
+              '< 16.04' => true,
+              '> 16.04, < 18.04' => true,
+            },
+            'fedora' => {
+              '< 30' => '30',
+            },
+            'freebsd' => {
+              '< 11' => '12',
+            },
+            'mac_os_x' => {
+              '< 10.12' => '10.15',
+            },
+            'opensuse' => {
+              '< 14' => true,
+              '~> 42.0' => true,
+            },
+            'debian' => {
+              '< 8' => true,
+              '> 8.0, < 8.9' => '8',
+              '> 9.0, < 9.8' => '9',
+            },
+            'centos' => {
+              '< 6.0' => true,
+              '~> 6.0, < 6.8' => '6',
+              '~> 7.0, < 7.6 ' => '7',
+            },
+            'redhat' => {
+              '< 6.0' => true,
+              '~> 6.0, < 6.8' => '6',
+              '~> 7.0, < 7.6' => '7',
+            },
+            'oracle' => {
+              '< 6.0' => true,
+              '~> 6.0, < 6.8' => '6',
+              '~> 7.0, < 7.6 ' => '7',
+            },
+          }.freeze
+
+          def_node_matcher :chefspec_definition?, <<-PATTERN
+            (send (const (const nil? :ChefSpec) ... ) :new (hash <(pair (sym :platform) $(str ... )) (pair (sym :version) $(str ... )) ... >))
+          PATTERN
+
+          def legacy_chefspec_platform(platform, version)
+            return false unless DEPRECATED_MAPPING.key?(platform)
+
+            DEPRECATED_MAPPING[platform].each_pair do |match_string, replacement|
+              return true if Gem::Dependency.new('', match_string.split(',')).match?('', version) &&
+                             replacement != version # we want to catch '7.0' and suggest '7', but not alert on '7'
+            end
+
+            false
+          end
+
+          def replacement_string(platform, version)
+            DEPRECATED_MAPPING[platform].each_pair do |match_string, replacement|
+              return replacement if Gem::Dependency.new('', match_string.split(',')).match?('', version) &&
+                                    replacement != version && # we want to catch '7.0' and suggest '7', but not alert on '7'
+                                    replacement != true # true means it's busted, but requires human intervention to fix
+            end
+
+            nil # we don't have a replacement os return nil
+          end
+
+          def on_send(node)
+            chefspec_definition?(node) do |plat, ver|
+              add_offense(node, location: :expression, message: MSG, severity: :refactor) if legacy_chefspec_platform(plat.value, ver.value)
+            end
+          end
+
+          def autocorrect(node)
+            chefspec_definition?(node) do |plat, ver|
+              if replacement = replacement_string(plat.value, ver.value) # rubocop: disable Lint/AssignmentInCondition
+                lambda do |corrector|
+                  corrector.replace(ver.loc.expression, "'#{replacement}'")
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -22,10 +22,7 @@ module RuboCop
         #
         #   # bad
         #   file '/etc/sysctl.d/ipv4.conf' do
-        #     owner 'root'
-        #     group 'root'
-        #     mode '0755'
-        #     notifies :run, 'service[sysctl -p /etc/sysctl.d/ipv4.conf]', :immediately
+        #     notifies :run, 'execute[sysctl -p /etc/sysctl.d/ipv4.conf]', :immediately
         #     content '9000 65500'
         #   end
         #
@@ -61,7 +58,7 @@ module RuboCop
           def on_block(node)
             match_property_in_resource?(:execute, 'command', node) do |code_property|
               property_data = method_arg_ast_to_string(code_property)
-              if property_data && property_data.match?(/^sysctl -p/i)
+              if property_data && property_data.match?(%r{^(/sbin/)?sysctl -p}i)
                 add_offense(node, location: :expression, message: MSG, severity: :refactor)
               end
             end

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

@@ -1,5 +1,5 @@
 #
-# Copyright:: 2019, Chef Software Inc.
+# Copyright:: 2019-2020, Chef Software Inc.
 # Author:: Tim Smith (<tsmith@chef.io>)
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -19,12 +19,17 @@ module RuboCop
   module Cop
     module Chef
       module ChefModernize
-        # Use the archive_file resource built into Chef Infra Client 15+ instead of the libarchive_file resource
+        # Use the archive_file resource built into Chef Infra Client 15+ instead of the libarchive_file resource.
         #
         # @example
         #
         #   # bad
-        #   libarchive "C:\file.zip" do
+        #   libarchive_file "C:\file.zip" do
+        #     path 'C:\expand_here'
+        #   end
+        #
+        #   # good
+        #   archive_file "C:\file.zip" do
         #     path 'C:\expand_here'
         #   end
         #
@@ -35,8 +40,22 @@ module RuboCop
 
           MSG = 'Use the archive_file resource built into Chef Infra Client 15+ instead of the libarchive file resource'.freeze
 
+          def_node_matcher :notification_property?, <<-PATTERN
+            (send nil? {:notifies :subscribes} (sym _) $(...) (sym _))
+          PATTERN
+
           def on_send(node)
             add_offense(node, location: :expression, message: MSG, severity: :refactor) if node.method_name == :libarchive_file
+
+            notification_property?(node) do |val|
+              add_offense(val, location: :expression, message: MSG, severity: :refactor) if val.str_content&.start_with?('libarchive_file')
+            end
+          end
+
+          def autocorrect(node)
+            lambda do |corrector|
+              corrector.replace(node.loc.expression, node.source.gsub('libarchive_file', 'archive_file'))
+            end
           end
         end
       end

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

@@ -0,0 +1,50 @@
+#
+# Copyright:: 2020, 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
+        # Checks for comments that mention "Chef" without context. Do you mean Chef Infra or Chef Software?
+        #
+        # @example
+        #
+        #   # bad
+        #   Chef makes software
+        #   Chef configures your systems
+        #
+        #   # good
+        #   Chef Software makes software
+        #   Chef Infra configures your systems
+        #
+        class ChefWhaaat < Cop
+          MSG = 'Do you mean Chef (the company) or a Chef product (e.g. Chef Infra, Chef InSpec, etc)?'.freeze
+
+          def investigate(processed_source)
+            return unless processed_source.ast
+
+            processed_source.comments.each do |comment|
+              if comment.text.match?(/Chef [a-z]/) # https://rubular.com/r/0YzfDAbwJrDHix
+                add_offense(comment, location: comment.loc.expression, message: MSG, severity: :refactor)
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -60,29 +60,42 @@ module RuboCop
           def autocorrect(node)
             lambda do |corrector|
               platform_case?(node) do |node_, type|
-                condition_string = node.when_branches.first.conditions.map(&:source).join(', ')
+                # we have at least one supermarket cookbook with an entirely empty platform case statement
+                # we can't actually fix that so let's do nothing here.
+                unless empty_case_statement?(node)
+                  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)
+                  # 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})")
+                    # 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)
+                    # 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))
+                    # 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
+
+          private
+
+          # determine if each branch of the case statement contains no code
+          #
+          # @private
+          def empty_case_statement?(node)
+            node.else_branch.nil? && node.when_branches.all? { |x| x.body.nil? }
+          end
         end
       end
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cookstyle
 version: !ruby/object:Gem::Version
-  version: 5.19.9
+  version: 5.20.0
 platform: ruby
 authors:
 - Thom May
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-01-07 00:00:00.000000000 Z
+date: 2020-01-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -81,6 +81,7 @@ files:
 - lib/rubocop/cop/chef/deprecation/depends_compat_resource.rb
 - lib/rubocop/cop/chef/deprecation/depends_partial_search.rb
 - lib/rubocop/cop/chef/deprecation/depends_poise.rb
+- lib/rubocop/cop/chef/deprecation/deprecated_chefspec_platform.rb
 - lib/rubocop/cop/chef/deprecation/deprecated_mixins.rb
 - lib/rubocop/cop/chef/deprecation/deprecated_platform_methods.rb
 - lib/rubocop/cop/chef/deprecation/deprecated_yum_repository_properties.rb
@@ -196,6 +197,7 @@ files:
 - lib/rubocop/cop/chef/sharing/insecure_cookbook_url.rb
 - lib/rubocop/cop/chef/sharing/invalid_license_string.rb
 - lib/rubocop/cop/chef/style/attribute_keys.rb
+- lib/rubocop/cop/chef/style/chef_whaaat.rb
 - lib/rubocop/cop/chef/style/comment_sentence_spacing.rb
 - lib/rubocop/cop/chef/style/comments_copyright_format.rb
 - lib/rubocop/cop/chef/style/comments_default_copyright.rb