cookstyle 7.18.0 → 7.19.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e1efe7fb1177e49d1ee5f83fef4238438ad397342bf04e4aa1efa705b567ebc2
-  data.tar.gz: 0a5899ba6f505c59470620c738affb9a5642258ede37d690fb6270b81b89c8d1
+  metadata.gz: 61c40a5894885af02650005d23a37fd8409f68286e748b17d14e96ae0fe0243f
+  data.tar.gz: 367b410c6654f7513e80138a389870d75810e7020feefe46b9586e76dd1821f3
 SHA512:
-  metadata.gz: e96d0dc478cb7ff1b75d04bbeee4bd35b66a88f4f930b738f92edbb908df7f002878688253a28473da39ccac587c950fa4c694e5f3f400d693ae54340029a5cd
-  data.tar.gz: adf2a361b46f9c47c47343990a677bac16161f1d53b76f23cadea0ba22b708d6d131f227350a058a42d9be690fedf0f264f0f4231f4d7bb9fa2bf088c1cef802
+  metadata.gz: 2cced7f9b44a843941f8545bcbfa44996e5113227a6972be695f3acb86f2e7692c33f657f41617b12508a3523b3427612c55be6c071f56321819387efaf00a57
+  data.tar.gz: f0bbf8ce69ae9165c47a781654bca44904d2261269771fe117276ed9b63e6e857fe03717015e52100fa545d7c49c2a5658ca355d64a090dfc484ea6811a77b21

data/config/cookstyle.yml

@@ -489,6 +489,15 @@ Chef/Correctness/MetadataMalformedDepends:
   Include:
     - '**/metadata.rb'
 
+Chef/Correctness/PowershellFileExists:
+  Description: Use Ruby's built-in `File.exist?('C:\somefile') instead of executing PowerShell's `Test-Path` cmdlet, which takes longer to load.
+  StyleGuide: 'chef_correctness_powershellfileexists'
+  Enabled: true
+  VersionAdded: '7.19'
+  Exclude:
+    - '**/metadata.rb'
+    - '**/Berksfile'
+
 ###############################
 # Chef/Sharing: Issues that prevent sharing code with other teams or with the Chef community in general
 ###############################
@@ -1263,7 +1272,7 @@ Chef/Modernize/WhyRunSupportedTrue:
     - '**/libraries/*.rb'
 
 Chef/Modernize/UnnecessaryDependsChef14:
-  Description: Don't depend on cookbooks made obsolete by Chef Infra Client 14+. These community cookbooks contain resources that are now included in Chef Infra Client itself.
+  Description: Don't depend on cookbooks made obsolete by Chef Infra Client 14.0+. These community cookbooks contain resources that are now included in Chef Infra Client itself.
   StyleGuide: 'chef_modernize_unnecessarydependschef14'
   Enabled: true
   VersionAdded: '5.1.0'
@@ -1389,7 +1398,7 @@ Chef/Modernize/SevenZipArchiveResource:
     - '**/metadata.rb'
 
 Chef/Modernize/LibarchiveFileResource:
-  Description: Use the archive_file resource built into Chef Infra Client 15+ instead of the libarchive file resource
+  Description: Use the archive_file resource built into Chef Infra Client 15+ instead of the libarchive file resource from the libarchive cookbook
   StyleGuide: 'chef_modernize_libarchivefileresource'
   Enabled: true
   VersionAdded: '5.5.0'
@@ -1799,6 +1808,46 @@ Chef/Modernize/ActionMethodInResource:
     - '**/resources/*.rb'
     - '**/providers/*.rb'
 
+Chef/Modernize/UnnecessaryDependsChef15:
+  Description: Don't depend on cookbooks made obsolete by Chef Infra Client 15.0+. These community cookbooks contain resources that are now included in Chef Infra Client itself.
+  StyleGuide: 'chef_modernize_unnecessarydependschef15'
+  Enabled: true
+  VersionAdded: '7.19.0'
+  Include:
+    - '**/metadata.rb'
+
+Chef/Modernize/DependsOnLocaleCookbook:
+  Description: Don't depend on the locale cookbook made obsolete by Chef Infra Client 14.5. The locale resource is now included in Chef Infra Client itself.
+  StyleGuide: 'chef_modernize_dependsonlocalecookbook'
+  Enabled: true
+  VersionAdded: '7.19.0'
+  Include:
+    - '**/metadata.rb'
+
+Chef/Modernize/DependsOnTimezoneLwrpCookbook:
+  Description: Don't depend on the timezone_lwrp cookbook made obsolete by Chef Infra Client 14.6. The timezone resource is now included in Chef Infra Client itself.
+  StyleGuide: 'chef_modernize_dependsontimezonelwrpcookbook'
+  Enabled: true
+  VersionAdded: '7.19.0'
+  Include:
+    - '**/metadata.rb'
+
+Chef/Modernize/DependsOnWindowsFirewallCookbook:
+  Description: Don't depend on the windows_firewall cookbook made obsolete by Chef Infra Client 14.7. The windows_firewall resource is now included in Chef Infra Client itself.
+  StyleGuide: 'chef_modernize_dependsonwindowsfirewallcookbook'
+  Enabled: true
+  VersionAdded: '7.19.0'
+  Include:
+    - '**/metadata.rb'
+
+Chef/Modernize/DependsOnKernelModuleCookbook:
+  Description: Don't depend on the kernel_module cookbook made obsolete by Chef Infra Client 14.3. The kernel_module resource is now included in Chef Infra Client itself.
+  StyleGuide: 'chef_modernize_dependsonkernelmodulecookbook'
+  Enabled: true
+  VersionAdded: '7.19.0'
+  Include:
+    - '**/metadata.rb'
+
 ###############################
 # Chef/RedundantCode: Cleanup unnecessary code in your cookbooks regardless of Chef Infra Client release
 ###############################

data/lib/cookstyle/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 module Cookstyle
-  VERSION = "7.18.0" # rubocop: disable Style/StringLiterals
+  VERSION = "7.19.0" # rubocop: disable Style/StringLiterals
   RUBOCOP_VERSION = '1.19.0'
 end

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

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+#
+# Copyright:: 2021, 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 Correctness
+        # Use Ruby's built-in `File.exist?('C:\somefile') instead of executing PowerShell's `Test-Path` cmdlet, which takes longer to load.
+        #
+        # @example
+        #
+        #  #### incorrect
+        #  powershell_out('Test-Path "C:\\Program Files\\LAPS\\CSE\\AdmPwd.dll"').stdout.strip == 'True'
+        #
+        #  #### correct
+        #  ::File.exist?('C:\Program Files\LAPS\CSE\AdmPwd.dll')
+        #
+        class PowershellFileExists < Base
+          RESTRICT_ON_SEND = [:powershell_out, :powershell_out!].freeze
+          MSG = "Use Ruby's built-in `File.exist?('C:\somefile') instead of executing PowerShell's `Test-Path` cmdlet, which takes longer to load."
+
+          def_node_matcher :powershell_out_exists?, <<-PATTERN
+            (send nil? {:powershell_out :powershell_out!} (str $_))
+          PATTERN
+
+          def on_send(node)
+            powershell_out_exists?(node) do |exists_string|
+              return unless exists_string.match?(/^Test-Path/)
+              add_offense(node, message: MSG, severity: :refactor)
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -19,7 +19,7 @@ module RuboCop
   module Cop
     module Chef
       module Modernize
-        # Don't depend on cookbooks made obsolete by Chef Infra Client 14+. These community cookbooks contain resources that are now included in Chef Infra Client itself.
+        # Don't depend on cookbooks made obsolete by Chef Infra Client 14.0+ These community cookbooks contain resources that are now included in Chef Infra Client itself.
         #
         # @example
         #
@@ -39,7 +39,7 @@ module RuboCop
 
           minimum_target_chef_version '14.0'
 
-          MSG = "Don't depend on cookbooks made obsolete by Chef Infra Client 14+. These community cookbooks contain resources that are now included in Chef Infra Client itself."
+          MSG = "Don't depend on cookbooks made obsolete by Chef Infra Client 14.0+. These community cookbooks contain resources that are now included in Chef Infra Client itself."
           RESTRICT_ON_SEND = [:depends].freeze
 
           def_node_matcher :legacy_depends?, <<-PATTERN

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

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+#
+# Copyright:: 2021, 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 Modernize
+        # Don't depend on cookbooks made obsolete by Chef Infra Client 15.0+. These community cookbooks contain resources that are now included in Chef Infra Client itself.
+        #
+        # @example
+        #
+        #   #### incorrect
+        #   depends 'libarchive'
+        #   depends 'windows_dns'
+        #   depends 'windows_uac'
+        #   depends 'windows_dfs'
+        #
+        class UnnecessaryDependsChef15 < Base
+          extend AutoCorrector
+          extend TargetChefVersion
+          include RangeHelp
+
+          minimum_target_chef_version '15.0'
+
+          MSG = "Don't depend on cookbooks made obsolete by Chef Infra Client 15.0+. These community cookbooks contain resources that are now included in Chef Infra Client itself."
+          RESTRICT_ON_SEND = [:depends].freeze
+
+          def_node_matcher :legacy_depends?, <<-PATTERN
+            (send nil? :depends (str {"libarchive" "windows_dns" "windows_uac" "windows_dfs"}) ... )
+          PATTERN
+
+          def on_send(node)
+            legacy_depends?(node) do
+              add_offense(node, message: MSG, severity: :refactor) do |corrector|
+                corrector.remove(range_with_surrounding_space(range: node.loc.expression, side: :left))
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+#
+# Copyright:: 2021, 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 Modernize
+        # Don't depend on the kernel_module cookbook made obsolete by Chef Infra Client 14.3. The kernel_module resource is now included in Chef Infra Client itself.
+        #
+        # @example
+        #
+        #   #### incorrect
+        #   depends 'kernel_module'
+        #
+        class DependsOnKernelModuleCookbook < Base
+          extend AutoCorrector
+          extend TargetChefVersion
+          include RangeHelp
+
+          minimum_target_chef_version '14.3'
+
+          MSG = "Don't depend on the kernel_module cookbook made obsolete by Chef Infra Client 14.3. The kernel_module resource is now included in Chef Infra Client itself."
+          RESTRICT_ON_SEND = [:depends].freeze
+
+          def_node_matcher :legacy_depends?, <<-PATTERN
+            (send nil? :depends (str "kernel_module") ... )
+          PATTERN
+
+          def on_send(node)
+            legacy_depends?(node) do
+              add_offense(node, message: MSG, severity: :refactor) do |corrector|
+                corrector.remove(range_with_surrounding_space(range: node.loc.expression, side: :left))
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+#
+# Copyright:: 2021, 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 Modernize
+        # Don't depend on the locale cookbook made obsolete by Chef Infra Client 14.5. The locale resource is now included in Chef Infra Client itself.
+        #
+        # @example
+        #
+        #   #### incorrect
+        #   depends 'locale'
+        #
+        class DependsOnLocaleCookbook < Base
+          extend AutoCorrector
+          extend TargetChefVersion
+          include RangeHelp
+
+          minimum_target_chef_version '14.5'
+
+          MSG = "Don't depend on the locale cookbook made obsolete by Chef Infra Client 14.5. The locale resource is now included in Chef Infra Client itself."
+          RESTRICT_ON_SEND = [:depends].freeze
+
+          def_node_matcher :legacy_depends?, <<-PATTERN
+            (send nil? :depends (str "locale") ... )
+          PATTERN
+
+          def on_send(node)
+            legacy_depends?(node) do
+              add_offense(node, message: MSG, severity: :refactor) do |corrector|
+                corrector.remove(range_with_surrounding_space(range: node.loc.expression, side: :left))
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+#
+# Copyright:: 2021, 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 Modernize
+        # Don't depend on the timezone_lwrp cookbook made obsolete by Chef Infra Client 14.6. The timezone resource is now included in Chef Infra Client itself.
+        #
+        # @example
+        #
+        #   #### incorrect
+        #   depends 'timezone_lwrp'
+        #
+        class DependsOnTimezoneLwrpCookbook < Base
+          extend AutoCorrector
+          extend TargetChefVersion
+          include RangeHelp
+
+          minimum_target_chef_version '14.6'
+
+          MSG = "Don't depend on the timezone_lwrp cookbook made obsolete by Chef Infra Client 14.6. The timezone resource is now included in Chef Infra Client itself."
+          RESTRICT_ON_SEND = [:depends].freeze
+
+          def_node_matcher :legacy_depends?, <<-PATTERN
+            (send nil? :depends (str "timezone_lwrp") ... )
+          PATTERN
+
+          def on_send(node)
+            legacy_depends?(node) do
+              add_offense(node, message: MSG, severity: :refactor) do |corrector|
+                corrector.remove(range_with_surrounding_space(range: node.loc.expression, side: :left))
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+#
+# Copyright:: 2021, 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 Modernize
+        # Don't depend on the windows_firewall cookbook made obsolete by Chef Infra Client 14.7. The windows_firewall resource is now included in Chef Infra Client itself.
+        #
+        # @example
+        #
+        #   #### incorrect
+        #   depends 'windows_firewall'
+        #
+        class DependsOnWindowsFirewallCookbook < Base
+          extend AutoCorrector
+          extend TargetChefVersion
+          include RangeHelp
+
+          minimum_target_chef_version '14.7'
+
+          MSG = "Don't depend on the windows_firewall cookbook made obsolete by Chef Infra Client 14.7. The windows_firewall resource is now included in Chef Infra Client itself."
+          RESTRICT_ON_SEND = [:depends].freeze
+
+          def_node_matcher :legacy_depends?, <<-PATTERN
+            (send nil? :depends (str "windows_firewall") ... )
+          PATTERN
+
+          def on_send(node)
+            legacy_depends?(node) do
+              add_offense(node, message: MSG, severity: :refactor) do |corrector|
+                corrector.remove(range_with_surrounding_space(range: node.loc.expression, side: :left))
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -19,11 +19,13 @@ module RuboCop
   module Cop
     module Chef
       module Modernize
-        # 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 from the libarchive cookbook.
         #
         # @example
         #
         #   #### incorrect
+        #   depends 'libarchive'
+        #
         #   libarchive_file "C:\file.zip" do
         #     path 'C:\expand_here'
         #   end
@@ -39,7 +41,7 @@ module RuboCop
 
           minimum_target_chef_version '15.0'
 
-          MSG = 'Use the archive_file resource built into Chef Infra Client 15+ instead of the libarchive file resource'
+          MSG = 'Use the archive_file resource built into Chef Infra Client 15+ instead of the libarchive file resource from the libarchive cookbook'
           RESTRICT_ON_SEND = [:libarchive_file, :notifies, :subscribes].freeze
 
           def_node_matcher :notification_property?, <<-PATTERN

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cookstyle
 version: !ruby/object:Gem::Version
-  version: 7.18.0
+  version: 7.19.0
 platform: ruby
 authors:
 - Thom May
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-08-14 00:00:00.000000000 Z
+date: 2021-08-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -78,6 +78,7 @@ files:
 - lib/rubocop/cop/chef/correctness/octal_mode_as_string.rb
 - lib/rubocop/cop/chef/correctness/openssl_password_helpers.rb
 - lib/rubocop/cop/chef/correctness/powershell_delete_file.rb
+- lib/rubocop/cop/chef/correctness/powershell_file_exists.rb
 - lib/rubocop/cop/chef/correctness/property_without_type.rb
 - lib/rubocop/cop/chef/correctness/resource_sets_internal_properties.rb
 - lib/rubocop/cop/chef/correctness/resource_sets_name_property.rb
@@ -175,6 +176,7 @@ files:
 - lib/rubocop/cop/chef/modernize/berksfile_source.rb
 - lib/rubocop/cop/chef/modernize/build_essential.rb
 - lib/rubocop/cop/chef/modernize/chef_14_resources.rb
+- lib/rubocop/cop/chef/modernize/chef_15_resources.rb
 - lib/rubocop/cop/chef/modernize/chef_gem_nokogiri.rb
 - lib/rubocop/cop/chef/modernize/compile_time_resources.rb
 - lib/rubocop/cop/chef/modernize/conditional_using_test.rb
@@ -184,6 +186,10 @@ files:
 - lib/rubocop/cop/chef/modernize/default_action_initializer.rb
 - lib/rubocop/cop/chef/modernize/defines_chefspec_matchers.rb
 - lib/rubocop/cop/chef/modernize/definitions.rb
+- lib/rubocop/cop/chef/modernize/depends_kernel_module_cookbook.rb
+- lib/rubocop/cop/chef/modernize/depends_locale_cookbook.rb
+- lib/rubocop/cop/chef/modernize/depends_timezone_lwrp_cookbook.rb
+- lib/rubocop/cop/chef/modernize/depends_windows_firewall_cookbook.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