cookstyle 7.19.0 → 7.20.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 61c40a5894885af02650005d23a37fd8409f68286e748b17d14e96ae0fe0243f
-  data.tar.gz: 367b410c6654f7513e80138a389870d75810e7020feefe46b9586e76dd1821f3
+  metadata.gz: 1beeee72a35f1c32830c7c968ba50d7a277bed019de89697fb54e232d53cfa3d
+  data.tar.gz: 98a912f077a8d14033a03ace34622f1b651dec2b1aea69e3c7c8121f9c487423
 SHA512:
-  metadata.gz: 2cced7f9b44a843941f8545bcbfa44996e5113227a6972be695f3acb86f2e7692c33f657f41617b12508a3523b3427612c55be6c071f56321819387efaf00a57
-  data.tar.gz: f0bbf8ce69ae9165c47a781654bca44904d2261269771fe117276ed9b63e6e857fe03717015e52100fa545d7c49c2a5658ca355d64a090dfc484ea6811a77b21
+  metadata.gz: b7a79148cf57524f1df2f880fcaea77f82cff8d87f1b2e347c1f0ed39a6629bfd91436caa4c7a6b55d99da6d2429e8bea99d9feeb78bc29585458bddf739f4a1
+  data.tar.gz: 6793431fc22cb1de03923569fcf0d2fb57fe3e0b646df99579752fa999d1898956b799dd2734b1e0459bc156fb48081ba685ad0fbedd45204b3b45a9438a5101

data/config/cookstyle.yml

@@ -490,7 +490,7 @@ Chef/Correctness/MetadataMalformedDepends:
     - '**/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.
+  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'
@@ -1246,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 by 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
 ###############################
@@ -1848,6 +1872,30 @@ Chef/Modernize/DependsOnKernelModuleCookbook:
   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 resource are now included directly in Chef Infra Client.
+  StyleGuide: 'chef_modernize_dependsonopensslcookbook'
+  Enabled: true
+  VersionAdded: '7.20.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.19.0" # rubocop: disable Style/StringLiterals
+  VERSION = "7.20.0" # rubocop: disable Style/StringLiterals
   RUBOCOP_VERSION = '1.19.0'
 end

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

@@ -19,7 +19,7 @@ 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.
+        # Use Ruby's built-in `File.exist?('C:\somefile')` method instead of executing PowerShell's `Test-Path` cmdlet, which takes longer to load.
         #
         # @example
         #
@@ -31,7 +31,7 @@ module RuboCop
         #
         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."
+          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 $_))

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

data/lib/rubocop/cop/chef/deprecation/depends_omnibus_updater_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 EOL `omnibus_updater` cookbook. This cookbook no longer works with newer Chef Infra Client releases and has been replaced by with the more reliable `chef_client_updater` cookbook.
+        #
+        # @example
+        #
+        #   #### incorrect
+        #   depends 'omnibus_updater'
+        #
+        #   #### correct
+        #   depends 'chef_client_updater'
+        #
+        class DependsOnOmnibusUpdaterCookbook < Base
+          extend AutoCorrector
+          include RangeHelp
+
+          MSG = "Don't depend on the EOL `omnibus_updater` cookbook. This cookbook no longer works with newer Chef Infra Client releases and has been replaced by with the more reliable `chef_client_updater` cookbook."
+          RESTRICT_ON_SEND = [:depends].freeze
+
+          def_node_matcher :legacy_depends?, <<-PATTERN
+            (send nil? :depends (str "omnibus_updater") ... )
+          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

data/lib/rubocop/cop/chef/modernize/depends_chef_vault_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 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.
+        #
+        # @example
+        #
+        #   #### incorrect
+        #   depends 'chef-vault'
+        #
+        class DependsOnChefVaultCookbook < Base
+          extend AutoCorrector
+          extend TargetChefVersion
+          include RangeHelp
+
+          minimum_target_chef_version '16.0'
+
+          MSG = "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."
+          RESTRICT_ON_SEND = [:depends].freeze
+
+          def_node_matcher :legacy_depends?, <<-PATTERN
+            (send nil? :depends (str "chef-vault") ... )
+          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_chocolatey_cookbooks.rb

@@ -0,0 +1,55 @@
+# 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 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.
+        #
+        # @example
+        #
+        #   #### incorrect
+        #   depends 'chocolatey_source'
+        #   depends 'chocolatey_config'
+        #
+        class DependsOnChocolateyCookbooks < Base
+          extend AutoCorrector
+          extend TargetChefVersion
+          include RangeHelp
+
+          minimum_target_chef_version '14.3'
+
+          MSG = "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."
+          RESTRICT_ON_SEND = [:depends].freeze
+
+          def_node_matcher :legacy_depends?, <<-PATTERN
+            (send nil? :depends (str {"chocolatey_source" "chocolatey_config"}) ... )
+          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_openssl_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 openssl cookbook which was made obsolete by Chef Infra Client 14.4. All openssl resource are now included directly in Chef Infra Client.
+        #
+        # @example
+        #
+        #   #### incorrect
+        #   depends 'openssl'
+        #
+        class DependsOnOpensslCookbook < Base
+          extend AutoCorrector
+          extend TargetChefVersion
+          include RangeHelp
+
+          minimum_target_chef_version '14.4'
+
+          MSG = "Don't depend on the openssl cookbook which was made obsolete by Chef Infra Client 14.4. All openssl resource are now included directly in Chef Infra Client."
+          RESTRICT_ON_SEND = [:depends].freeze
+
+          def_node_matcher :legacy_depends?, <<-PATTERN
+            (send nil? :depends (str "openssl") ... )
+          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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cookstyle
 version: !ruby/object:Gem::Version
-  version: 7.19.0
+  version: 7.20.0
 platform: ruby
 authors:
 - Thom May
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-08-18 00:00:00.000000000 Z
+date: 2021-08-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -100,7 +100,10 @@ files:
 - lib/rubocop/cop/chef/deprecation/chefspec_coverage_report.rb
 - lib/rubocop/cop/chef/deprecation/chefspec_legacy_runner.rb
 - lib/rubocop/cop/chef/deprecation/chocolatey_package_uninstall_action.rb
+- lib/rubocop/cop/chef/deprecation/depends_chef_nginx_cookbook.rb
+- lib/rubocop/cop/chef/deprecation/depends_chef_reporting_cookbook.rb
 - lib/rubocop/cop/chef/deprecation/depends_compat_resource.rb
+- lib/rubocop/cop/chef/deprecation/depends_omnibus_updater_cookbook.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
@@ -186,8 +189,11 @@ 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_chef_vault_cookbook.rb
+- lib/rubocop/cop/chef/modernize/depends_chocolatey_cookbooks.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_openssl_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