cookstyle 7.18.0 → 7.22.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e1efe7fb1177e49d1ee5f83fef4238438ad397342bf04e4aa1efa705b567ebc2
-  data.tar.gz: 0a5899ba6f505c59470620c738affb9a5642258ede37d690fb6270b81b89c8d1
+  metadata.gz: 2f991818edd484753a75e2c0ae4e0d363f48b9213189cd4240bda17b08e260d4
+  data.tar.gz: fa69ed0eb47f5276d723b7f75acd6c08f21e8c57391f6c1b8c71f2e74c023880
 SHA512:
-  metadata.gz: e96d0dc478cb7ff1b75d04bbeee4bd35b66a88f4f930b738f92edbb908df7f002878688253a28473da39ccac587c950fa4c694e5f3f400d693ae54340029a5cd
-  data.tar.gz: adf2a361b46f9c47c47343990a677bac16161f1d53b76f23cadea0ba22b708d6d131f227350a058a42d9be690fedf0f264f0f4231f4d7bb9fa2bf088c1cef802
+  metadata.gz: 5f5a09a0805b0b184e1fe10e90bbdd0270a537b4c823560f74f1b4cfd6e6ea332fc62fc6695595b92cf35733db3871d94a037b4747681572bd0925525c7a3da9
+  data.tar.gz: 5118bf5677557d03e0e730de31670c7defcd943d5d356147f40eed1c86118f463f29083f081d4af0e622c7375db9415c5b9e57da933291c441c500ee658d6265

data/config/cookstyle.yml

@@ -482,13 +482,22 @@ Chef/Correctness/OctalModeAsString:
     - '**/Berksfile'
 
 Chef/Correctness/MetadataMalformedDepends:
-  Description: Don't represent file modes as strings containing octal values. Use standard base 10 file modes instead.
+  Description: metadata.rb cookbook dependencies and version constraints should be comma separated.
   StyleGuide: 'chef_correctness_metadatamalformeddepends'
   Enabled: true
   VersionAdded: '7.16'
   Include:
     - '**/metadata.rb'
 
+Chef/Correctness/PowershellFileExists:
+  Description: Use Ruby's built-in `File.exist?('C:\somefile')` method 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
 ###############################
@@ -970,7 +979,7 @@ Chef/Deprecations/DeprecatedPlatformMethods:
     - '**/providers/*.rb'
 
 Chef/Deprecations/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
+  Description: Use currently supported platforms in ChefSpec listed at https://github.com/chefspec/fauxhai/blob/main/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
   StyleGuide: 'chef_deprecations_deprecatedchefspecplatform'
   Enabled: true
   VersionAdded: '5.20.0'
@@ -1189,7 +1198,7 @@ Chef/Deprecations/DeprecatedYumRepositoryActions:
     - '**/Rakefile'
 
 Chef/Deprecations/ChefSugarHelpers:
-  Description: Do not use legacy chef-sugar helper methods, which will not be moved into Chef Infra Client itself. For a complete set of chef-sugar helpers now shipping in Chef Infra Client itself see https://github.com/chef/chef/tree/master/chef-utils#getting-started
+  Description: Do not use legacy chef-sugar helper methods, which will not be moved into Chef Infra Client itself. For a complete set of chef-sugar helpers now shipping in Chef Infra Client itself see https://github.com/chef/chef/tree/main/chef-utils#getting-started
   StyleGuide: 'chef_deprecations_chefsugarhelpers'
   Enabled: true
   VersionAdded: '7.3.0'
@@ -1237,6 +1246,30 @@ Chef/Deprecations/DeprecatedSudoActions:
     - '**/Berksfile'
     - '**/Rakefile'
 
+Chef/Deprecations/DependsOnChefNginxCookbook:
+  Description: Don't depend on the deprecated `chef_nginx` cookbook that was replaced by the `nginx` cookbook. The legacy chef_nginx cookbook may not be compatible with newer Chef Infra Client releases.
+  StyleGuide: 'chef_deprecations_dependsonchefnginxcookbook'
+  Enabled: true
+  VersionAdded: '7.20.0'
+  Include:
+    - '**/metadata.rb'
+
+Chef/Deprecations/DependsOnChefReportingCookbook:
+  Description: Don't depend on the chef-reporting cookbook made obsolete by Chef Infra Client 11.6. This cookbook installs a gem that is not compatible with newer Chef Infra Client releases.
+  StyleGuide: 'chef_deprecations_dependsonchefreportingcookbook'
+  Enabled: true
+  VersionAdded: '7.20.0'
+  Include:
+    - '**/metadata.rb'
+
+Chef/Deprecations/DependsOnOmnibusUpdaterCookbook:
+  Description: Don't depend on the EOL `omnibus_updater` cookbook. This cookbook no longer works with newer Chef Infra Client releases and has been replaced with the more reliable `chef_client_updater` cookbook.
+  StyleGuide: 'chef_deprecations_dependsonomnibusupdatercookbook'
+  Enabled: true
+  VersionAdded: '7.20.0'
+  Include:
+    - '**/metadata.rb'
+
 ###############################
 # Chef/Modernize: Cleaning up legacy code and using new built-in resources
 ###############################
@@ -1263,7 +1296,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 +1422,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 +1832,90 @@ 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/Modernize/DependsOnChefVaultCookbook:
+  Description: Don't depend on the chef-vault cookbook made obsolete by Chef Infra Client 16.0. The chef-vault gem and helpers are now included in Chef Infra Client itself.
+  StyleGuide: 'chef_modernize_dependsonchefvaultcookbook'
+  Enabled: true
+  VersionAdded: '7.20.0'
+  Include:
+    - '**/metadata.rb'
+
+Chef/Modernize/DependsOnChocolateyCookbooks:
+  Description: Don't depend on the chocolatey_source or chocolatey_config cookbooks made obsolete by Chef Infra Client 14.3. The chocolatey_source and chocolatey_config resources are now included in Chef Infra Client itself.
+  StyleGuide: 'chef_modernize_dependsonchocolateycookbooks'
+  Enabled: true
+  VersionAdded: '7.20.0'
+  Include:
+    - '**/metadata.rb'
+
+Chef/Modernize/DependsOnOpensslCookbook:
+  Description: Don't depend on the `openssl` cookbook which was made obsolete by Chef Infra Client 14.4. All `openssl_*` resources are now included directly in Chef Infra Client.
+  StyleGuide: 'chef_modernize_dependsonopensslcookbook'
+  Enabled: true
+  VersionAdded: '7.20.0'
+  Include:
+    - '**/metadata.rb'
+
+Chef/Modernize/UseChefLanguageEnvHelpers:
+  Description: Chef Infra Client 15.5 and later include a large number of new helpers in the Chef Infra Language to simplify checking the system configuration in recipes and resources. These should be used when possible over more complex attribute or ENV var comparisons.
+  StyleGuide: 'chef_modernize_usecheflanguageenvhelpers'
+  Enabled: true
+  VersionAdded: '7.21.0'
+  Include:
+    - '**/resources/*.rb'
+    - '**/providers/*.rb'
+    - '**/recipes/*.rb'
+
+Chef/Modernize/UseChefLanguageCloudHelpers:
+  Description: hef Infra Client 15.5 and later include cloud helpers to make detecting instance that run on public and private clouds easier.
+  StyleGuide: 'chef_modernize_usecheflanguagecloudhelpers'
+  Enabled: true
+  VersionAdded: '7.22.0'
+  Include:
+    - '**/resources/*.rb'
+    - '**/providers/*.rb'
+    - '**/recipes/*.rb'
+    
 ###############################
 # Chef/RedundantCode: Cleanup unnecessary code in your cookbooks regardless of Chef Infra Client release
 ###############################

data/config/disable_all.yml

@@ -5,6 +5,8 @@ Bundler/DuplicatedGem:
   Enabled: false
 Bundler/GemComment:
   Enabled: false
+Bundler/GemFilename:
+  Enabled: false
 Bundler/GemVersion:
   Enabled: false
 Bundler/InsecureProtocolSource:

data/config/upstream.yml

@@ -174,6 +174,20 @@ Bundler/GemComment:
   IgnoredGems: []
   OnlyFor: []
 
+Bundler/GemFilename:
+  Description: 'Enforces the filename for managing gems.'
+  Enabled: true
+  VersionAdded: '1.20'
+  EnforcedStyle: 'Gemfile'
+  SupportedStyles:
+    - 'Gemfile'
+    - 'gems.rb'
+  Include:
+    - '**/Gemfile'
+    - '**/gems.rb'
+    - '**/Gemfile.lock'
+    - '**/gems.locked'
+
 Bundler/GemVersion:
   Description: 'Requires or forbids specifying gem versions.'
   Enabled: false
@@ -1519,6 +1533,11 @@ Lint/Debugger:
     Capybara:
       - save_and_open_page
       - save_and_open_screenshot
+    debug.rb:
+      - binding.b
+      - binding.break
+      - Kernel.binding.b
+      - Kernel.binding.break
     Pry:
       - binding.pry
       - binding.remote_pry
@@ -1527,6 +1546,8 @@ Lint/Debugger:
     Rails:
       - debugger
       - Kernel.debugger
+    RubyJard:
+      - jard
     WebConsole:
       - binding.console
 
@@ -3149,7 +3170,7 @@ Style/CommentAnnotation:
   StyleGuide: '#annotate-keywords'
   Enabled: true
   VersionAdded: '0.10'
-  VersionChanged: '1.3'
+  VersionChanged: '1.20'
   Keywords:
     - TODO
     - FIXME
@@ -4692,8 +4713,9 @@ Style/StructInheritance:
   Description: 'Checks for inheritance from Struct.new.'
   StyleGuide: '#no-extend-struct-new'
   Enabled: true
+  SafeAutoCorrect: false
   VersionAdded: '0.29'
-  VersionChanged: '0.86'
+  VersionChanged: '1.20'
 
 Style/SwapValues:
   Description: 'This cop enforces the use of shorthand-style swapping of 2 variables.'

data/cookstyle.gemspec

@@ -22,7 +22,7 @@ Gem::Specification.new do |spec|
 
   spec.metadata = {
     'homepage_uri' => 'https://github.com/chef/cookstyle',
-    'changelog_uri' => 'https://github.com/chef/cookstyle/blob/master/CHANGELOG.md',
+    'changelog_uri' => 'https://github.com/chef/cookstyle/blob/main/CHANGELOG.md',
     'source_code_uri' => 'https://github.com/chef/cookstyle',
     'documentation_uri' => 'https://docs.chef.io/workstation/cookstyle/',
     'bug_tracker_uri' => 'https://github.com/chef/cookstyle/issues',

data/lib/cookstyle/version.rb

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

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

@@ -19,7 +19,7 @@ module RuboCop
   module Cop
     module Chef
       module Correctness
-        # metadata.rb cookbook dependencies and version constraints should be comma separated
+        # metadata.rb cookbook dependencies and version constraints should be comma separated.
         #
         # @example
         #

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')` method 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')` method 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/deprecation/chef_sugar_helpers.rb

@@ -19,7 +19,7 @@ module RuboCop
   module Cop
     module Chef
       module Deprecations
-        # Do not use legacy chef-sugar helper methods, which will not be moved into Chef Infra Client itself. For a complete set of chef-sugar helpers now shipping in Chef Infra Client itself see https://github.com/chef/chef/tree/master/chef-utils#getting-started
+        # Do not use legacy chef-sugar helper methods, which will not be moved into Chef Infra Client itself. For a complete set of chef-sugar helpers now shipping in Chef Infra Client itself see https://github.com/chef/chef/tree/main/chef-utils#getting-started
         #
         # @example
         #
@@ -42,7 +42,7 @@ module RuboCop
         #   opensolaris?
         #
         class ChefSugarHelpers < Base
-          MSG = 'Do not use legacy chef-sugar helper methods, which will not be moved into Chef Infra Client itself. For a complete set of chef-sugar helpers now shipping in Chef Infra Client itself see https://github.com/chef/chef/tree/master/chef-utils#getting-started'
+          MSG = 'Do not use legacy chef-sugar helper methods, which will not be moved into Chef Infra Client itself. For a complete set of chef-sugar helpers now shipping in Chef Infra Client itself see https://github.com/chef/chef/tree/main/chef-utils#getting-started'
           RESTRICT_ON_SEND = [:vagrant_key?, :vagrant_domain?, :vagrant_user?, :require_chef_gem, :best_ip_for, :nexus?, :ios_xr?, :ruby_20?, :ruby_19?, :includes_recipe?, :wrlinux?, :dev_null, :nexentacore_platform?, :opensolaris_platform?, :nexentacore?, :opensolaris?].freeze
 
           def on_send(node)

data/lib/rubocop/cop/chef/deprecation/depends_chef_nginx_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 Deprecations
+        # Don't depend on the deprecated `chef_nginx` cookbook that was replaced by the `nginx` cookbook. The legacy chef_nginx cookbook may not be compatible with newer Chef Infra Client releases.
+        #
+        # @example
+        #
+        #   #### incorrect
+        #   depends 'chef_nginx'
+        #
+        #   #### correct
+        #   depends 'nginx'
+        #
+        class DependsOnChefNginxCookbook < Base
+          include RangeHelp
+          extend AutoCorrector
+
+          MSG = "Don't depend on the deprecated `chef_nginx` cookbook that was replaced by the `nginx` cookbook."
+          RESTRICT_ON_SEND = [:depends].freeze
+
+          def_node_matcher :depends_compat_resource?, <<-PATTERN
+            (send nil? :depends (str {"chef_nginx"}))
+          PATTERN
+
+          def on_send(node)
+            depends_compat_resource?(node) do
+              add_offense(node, message: MSG, severity: :warning) 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/deprecation/depends_chef_reporting_cookbook.rb

@@ -0,0 +1,51 @@
+# 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 Deprecations
+        # Don't depend on the chef-reporting cookbook made obsolete by Chef Infra Client 11.6. This cookbook installs a gem that is not compatible with newer Chef Infra Client releases.
+        #
+        # @example
+        #
+        #   #### incorrect
+        #   depends 'chef-reporting'
+        #
+        class DependsOnChefReportingCookbook < Base
+          extend AutoCorrector
+          include RangeHelp
+
+          MSG = "Don't depend on the chef-reporting cookbook made obsolete by Chef Infra Client 11.6. This cookbook installs a gem that is not compatible with newer Chef Infra Client releases."
+          RESTRICT_ON_SEND = [:depends].freeze
+
+          def_node_matcher :legacy_depends?, <<-PATTERN
+            (send nil? :depends (str "chef-reporting") ... )
+          PATTERN
+
+          def on_send(node)
+            legacy_depends?(node) do
+              add_offense(node, message: MSG, severity: :warning) do |corrector|
+                corrector.remove(range_with_surrounding_space(range: node.loc.expression, side: :left))
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end