cookstyle 5.16.11 → 5.17.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d1f54db0598a337932e9af4148f10d1b6859e25299c11d768e422447c98fc70a
-  data.tar.gz: e0cd92fcda91ef0fb6ffde326250b71fa3aafc47cc91fa9d98cd75567931c5bb
+  metadata.gz: 9542dd1a3bbc3a2f0f4db8c2108e67ef70cec17da89557746489ccc9dd89d4f5
+  data.tar.gz: b2a67152f01ef162bfe42b833e15b627fe361403a2ad450b0f591bc490a1b551
 SHA512:
-  metadata.gz: 9f49d0dbab8862ce77c1820c2e02ddbb8c0a5174ee5c665c6655b8534dfc95668e7aeeb0eff86a4dba077f2d8b7c9c74e21c2c383e669f80fca673502bdee515
-  data.tar.gz: 6f130be8ca5c343e0ea938166848206761a5a8d26e278c68151dee3601be53ca966c1311a7cc7dd415c5790d88005148a232a18216210e6bf8d8ae60fa642844
+  metadata.gz: 1432f849f9464fabd9e9b17c559889f1c537671175b5690fb48d2f311030dd51c12746fc1dbad60dfd084fde4377e48ea5ee4c8a3bdd991f486f46ffafa8627e
+  data.tar.gz: a0f4c2a88b75f3049967747a8fc183d922800ff0b84d0d11bcb853444d1755bc83c7ee90e02c70a0bdb04b4d65b208ee438093010fbcab184c5bbeb817f7ec62

data/config/cookstyle.yml

@@ -801,7 +801,7 @@ ChefModernize/MinitestHandlerUsage:
     - '**/metadata.rb'
 
 ChefModernize/IncludingMixinShelloutInResources:
-  Description: There is no need to include Chef::Mixin::ShellOut in resources or providers as this is already done by Chef Infra Client.
+  Description: There is no need to include Chef::Mixin::ShellOut or Chef::Mixin::PowershellOut in resources or providers as this is already done by Chef Infra Client 12.4+.
   Enabled: true
   VersionAdded: '5.4.0'
   Include:
@@ -1056,6 +1056,14 @@ ChefModernize/ExecuteSleep:
     - '**/attributes/*.rb'
     - '**/Berksfile'
 
+ChefModernize/DslIncludeInResource:
+  Description: 'There is no need to include Chef::DSL::Recipe or Chef::DSL::IncludeRecipe classes in resources or providers as this is done automatically.'
+  Enabled: true
+  VersionAdded: '5.17.0'
+  Include:
+    - '**/resources/*.rb'
+    - '**/providers/*.rb'
+
 ###############################
 # ChefRedundantCode: Cleanup unncessary code in your cookbooks regardless of chef-client release
 ###############################
@@ -1177,6 +1185,24 @@ ChefRedundantCode/UnnecessaryDesiredState:
     - '**/resources/*.rb'
     - '**/libraries/*.rb'
 
+ChefRedundantCode/AptRepositoryNotifiesAptUpdate:
+  Description: There is no need to notify an apt-get update when an apt_repository is created as this is done automatically by the apt_repository resource.
+  Enabled: true
+  VersionAdded: '5.17.0'
+  Exclude:
+    - '**/metadata.rb'
+    - '**/attributes/*.rb'
+    - '**/Berksfile'
+
+ChefRedundantCode/AptRepositoryDistributionDefault:
+  Description: There is no need to pass `distribution node['lsb']['codename']` to an apt_repository resource as this is done automatically by the apt_repository resource.
+  Enabled: true
+  VersionAdded: '5.17.0'
+  Exclude:
+    - '**/metadata.rb'
+    - '**/attributes/*.rb'
+    - '**/Berksfile'
+
 ###############################
 # Migrating to new patterns
 ###############################

data/lib/cookstyle.rb

@@ -1,4 +1,4 @@
-require 'cookstyle/version'
+require_relative 'cookstyle/version'
 
 require 'pathname'
 require 'yaml'
@@ -37,11 +37,11 @@ module Cookstyle
   end
 end
 
-require 'rubocop/chef'
-require 'rubocop/chef/cookbook_helpers'
-require 'rubocop/chef/platform_helpers'
-require 'rubocop/chef/cookbook_only'
-require 'rubocop/cop/target_chef_version'
+require_relative 'rubocop/chef'
+require_relative 'rubocop/chef/cookbook_helpers'
+require_relative 'rubocop/chef/platform_helpers'
+require_relative 'rubocop/chef/cookbook_only'
+require_relative 'rubocop/cop/target_chef_version'
 
 # Chef specific cops
 Dir.glob(File.dirname(__FILE__) + '/rubocop/cop/chef/**/*.rb') do |file|

data/lib/cookstyle/version.rb

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

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

@@ -38,6 +38,15 @@ module RuboCop
 
           def_node_matcher :supports?, '(send nil? :supports $str ...)'
 
+          def_node_matcher :supports_array?, <<-PATTERN
+            (block
+              (send
+                $(array ...) :each)
+              (args
+                (arg _))
+              (send nil? :supports (lvar _)))
+          PATTERN
+
           def on_send(node)
             supports?(node) do |plat|
               if INVALID_PLATFORMS[plat.str_content]
@@ -46,19 +55,33 @@ module RuboCop
             end
           end
 
+          def on_block(node)
+            supports_array?(node) do |plats|
+              plats.values.each do |plat|
+                if INVALID_PLATFORMS[plat.str_content]
+                  add_offense(plat, location: :expression, message: MSG, severity: :refactor)
+                end
+              end
+            end
+          end
+
           def autocorrect(node)
-            correct_string = autocorrect_platform_string(node.str_content)
+            correct_string = corrected_platform_source(node)
             if correct_string
               lambda do |corrector|
-                corrector.replace(node.loc.expression, "'#{correct_string}'")
+                corrector.replace(node.loc.expression, correct_string)
               end
             end
           end
 
           # private
 
-          def autocorrect_platform_string(bad_string)
-            INVALID_PLATFORMS[bad_string.delete(',').downcase]
+          def corrected_platform_source(node)
+            val = INVALID_PLATFORMS[node.str_content.delete(',').downcase]
+            return false unless val
+
+            # if the value was previously quoted make sure to quote it again
+            node.source.match?(/^('|")/) ? "'" + val + "'" : val
           end
         end
       end

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

@@ -0,0 +1,54 @@
+#
+# 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
+        # Chef Infra Client 12.4+ includes the Chef::DSL::Recipe in the resource and provider classed by default so there is no need to include this DSL in your resources or providers.
+        #
+        #   # bad
+        #   include Chef::DSL::Recipe
+        #   include Chef::DSL::IncludeRecipe
+        #
+        class DslIncludeInResource < Cop
+          include RangeHelp
+
+          MSG = 'Chef Infra Client 12.4+ includes the Chef::DSL::Recipe in the resource and provider classed by default so there is no need to include this DSL in your resources or providers.'.freeze
+
+          def_node_matcher :dsl_include?, <<-PATTERN
+          (send nil? :include
+            (const
+              (const
+                (const nil? :Chef) :DSL) {:Recipe :IncludeRecipe}))
+          PATTERN
+
+          def on_send(node)
+            dsl_include?(node) do
+              add_offense(node, location: :expression, message: MSG, severity: :refactor)
+            end
+          end
+
+          def autocorrect(node)
+            lambda do |corrector|
+              corrector.remove(range_with_surrounding_space(range: node.loc.expression, side: :left))
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -19,23 +19,25 @@ module RuboCop
   module Cop
     module Chef
       module ChefModernize
-        # There is no need to include Chef::Mixin::ShellOut in resources or providers as this is already done by Chef Infra Client 12.4+.
+        # There is no need to include Chef::Mixin::ShellOut or Chef::Mixin::PowershellOut in resources or providers as this is already done by Chef Infra Client 12.4+.
         #
         # @example
         #
         #   # bad
         #   require 'chef/mixin/shell_out'
         #   include Chef::Mixin::ShellOut
-
+        #   require 'chef/mixin/powershell_out'
+        #   include Chef::Mixin::PowershellOut
+        #
         class IncludingMixinShelloutInResources < Cop
-          MSG = 'There is no need to include Chef::Mixin::ShellOut in resources or providers as this is already done by Chef Infra Client 12.4+.'.freeze
+          MSG = 'There is no need to include Chef::Mixin::ShellOut or Chef::Mixin::PowershellOut in resources or providers as this is already done by Chef Infra Client 12.4+.'.freeze
 
           def_node_matcher :include_shellout?, <<-PATTERN
-            (send nil? :include (const (const (const nil? :Chef) :Mixin) :ShellOut))
+            (send nil? :include (const (const (const nil? :Chef) :Mixin) {:ShellOut :PowershellOut}))
           PATTERN
 
           def_node_matcher :require_shellout?, <<-PATTERN
-            (send nil? :require ( str "chef/mixin/shell_out"))
+            (send nil? :require ( str {"chef/mixin/shell_out" "chef/mixin/powershell_out"} ))
           PATTERN
 
           def on_send(node)

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

@@ -0,0 +1,66 @@
+#
+# 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 pass `distribution node['lsb']['codename']` to an apt_repository resource as this is done automatically by the apt_repository resource.
+        #
+        #   # bad
+        #   apt_repository 'my repo' do
+        #     uri 'http://packages.example.com/debian'
+        #     components %w(stable main)
+        #     deb_src false
+        #     distribution node['lsb']['codename']
+        #   end
+        #
+        #   # good
+        #   apt_repository 'my repo' do
+        #     uri 'http://packages.example.com/debian'
+        #     components %w(stable main)
+        #     deb_src false
+        #   end
+        #
+        class AptRepositoryDistributionDefault < Cop
+          include RuboCop::Chef::CookbookHelpers
+          include RangeHelp
+
+          MSG = "There is no need to pass `distribution node['lsb']['codename']` to an apt_repository resource as this is done automatically by the apt_repository resource.".freeze
+
+          def_node_matcher :default_dist?, <<-PATTERN
+            (send nil? :distribution (send (send (send nil? :node) :[] ({sym str} {:lsb "lsb"})) :[] ({sym str} {:codename "codename"})))
+          PATTERN
+
+          def on_block(node)
+            match_property_in_resource?(:apt_repository, 'distribution', node) do |dist|
+              ## require 'pry'; binding.pry
+              default_dist?(dist) do
+                add_offense(dist, location: :expression, message: MSG, severity: :refactor)
+              end
+            end
+          end
+
+          def autocorrect(node)
+            lambda do |corrector|
+              corrector.remove(range_with_surrounding_space(range: node.loc.expression, side: :left))
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/chef/redundant/apt_repository_notifies_apt_update.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 ChefRedundantCode
+        # There is no need to notify an apt-get update when an apt_repository is created as this is done automatically by the apt_repository resource.
+        #
+        #   # bad
+        #   apt_repository 'my repo' do
+        #     uri 'http://packages.example.com/debian'
+        #     components %w(stable main)
+        #     deb_src false
+        #     notifies :run, 'execute[apt-get update]', :immediately
+        #   end
+        #
+        #   # good
+        #   apt_repository 'my repo' do
+        #     uri 'http://packages.example.com/debian'
+        #     components %w(stable main)
+        #     deb_src false
+        #   end
+        #
+        class AptRepositoryNotifiesAptUpdate < Cop
+          include RuboCop::Chef::CookbookHelpers
+          include RangeHelp
+
+          MSG = 'There is no need to notify an apt-get update when an apt_repository is created as this is done automatically by the apt_repository resource.'.freeze
+
+          def on_block(node)
+            match_property_in_resource?(:apt_repository, 'notifies', node) do |notifies|
+              add_offense(notifies, location: :expression, message: MSG, severity: :refactor) if notifies.arguments[1] == s(:str, 'execute[apt-get update]')
+            end
+          end
+
+          def autocorrect(node)
+            lambda do |corrector|
+              corrector.remove(range_with_surrounding_space(range: node.loc.expression, side: :left))
+            end
+          end
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cookstyle
 version: !ruby/object:Gem::Version
-  version: 5.16.11
+  version: 5.17.4
 platform: ruby
 authors:
 - Thom May
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-12-17 00:00:00.000000000 Z
+date: 2019-12-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -134,6 +134,7 @@ files:
 - lib/rubocop/cop/chef/modernize/defines_chefspec_matchers.rb
 - lib/rubocop/cop/chef/modernize/definitions.rb
 - lib/rubocop/cop/chef/modernize/depends_zypper_cookbook.rb
+- lib/rubocop/cop/chef/modernize/dsl_include_in_resource.rb
 - lib/rubocop/cop/chef/modernize/empty_resource_initialize.rb
 - lib/rubocop/cop/chef/modernize/execute_apt_update.rb
 - lib/rubocop/cop/chef/modernize/execute_sc_exe.rb
@@ -171,6 +172,8 @@ files:
 - lib/rubocop/cop/chef/modernize/windows_zipfile.rb
 - lib/rubocop/cop/chef/modernize/zipfile_resource.rb
 - lib/rubocop/cop/chef/modernize/zypper_repo.rb
+- lib/rubocop/cop/chef/redundant/apt_repository_distribution_default.rb
+- lib/rubocop/cop/chef/redundant/apt_repository_notifies_apt_update.rb
 - lib/rubocop/cop/chef/redundant/attribute_metadata.rb
 - lib/rubocop/cop/chef/redundant/conflicts_metadata.rb
 - lib/rubocop/cop/chef/redundant/custom_resource_with_allowed_actions.rb