cookstyle 7.18.0 → 7.22.3

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

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

@@ -0,0 +1,90 @@
+# 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
+        # Chef Infra Client 15.5 and later include cloud helpers to make detecting instance that run on public and private clouds easier.
+        #
+        # @example
+        #
+        #   #### incorrect
+        #   node['cloud']['provider'] == 'alibaba'
+        #   node['cloud']['provider'] == 'ec2'
+        #   node['cloud']['provider'] == 'gce'
+        #   node['cloud']['provider'] == 'rackspace'
+        #   node['cloud']['provider'] == 'eucalyptus'
+        #   node['cloud']['provider'] == 'linode'
+        #   node['cloud']['provider'] == 'openstack'
+        #   node['cloud']['provider'] == 'azure'
+        #   node['cloud']['provider'] == 'digital_ocean'
+        #   node['cloud']['provider'] == 'softlayer'
+        #
+        #   #### correct
+        #   alibaba?
+        #   ec2?
+        #   gce?
+        #   rackspace?
+        #   eucalyptus?
+        #   linode?
+        #   openstack?
+        #   azure?
+        #   digital_ocean?
+        #   softlayer?
+        #
+        class UseChefLanguageCloudHelpers < Base
+          extend AutoCorrector
+
+          MSG = 'Chef Infra Client 15.5 and later include cloud helpers to make detecting instance that run on public and private clouds easier.'
+          RESTRICT_ON_SEND = [:==, :[]].freeze
+          VALID_CLOUDS = %w(alibaba ec2 gce rackspace eucalyptus linode openstack azure digital_ocean softlayer).freeze
+
+          def_node_matcher :provider_comparison?, <<-PATTERN
+            (send
+              (send
+                (send
+                  (send nil? :node) :[]
+                  (str "cloud")) :[]
+                (str "provider")) :==
+              (str $_))
+          PATTERN
+
+          def_node_matcher :node_cloud?, <<-PATTERN
+            (send
+              (send nil? :node) :[]
+              (str "cloud"))
+          PATTERN
+
+          def on_send(node)
+            provider_comparison?(node) do |cloud_name|
+              # skip it if someone was checking for a bogus cloud provider
+              next unless VALID_CLOUDS.include?(cloud_name)
+
+              # if they were checking for node['cloud'] and the provider replace it all
+              node = node.parent if node.parent.and_type? && node_cloud?(node.left_sibling)
+
+              add_offense(node, message: MSG, severity: :refactor) do |corrector|
+                corrector.replace(node, "#{cloud_name}?")
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,66 @@
+# 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
+        # 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.
+        #
+        # @example
+        #
+        #   #### incorrect
+        #   ENV['CI']
+        #   ENV['TEST_KITCHEN']
+        #
+        #   #### correct
+        #   ci?
+        #   kitchen?
+        #
+        class UseChefLanguageEnvHelpers < Base
+          extend AutoCorrector
+
+          RESTRICT_ON_SEND = [:[]].freeze
+
+          def_node_matcher :env?, <<-PATTERN
+            (send
+              (const nil? :ENV) :[]
+              (str ${"TEST_KITCHEN" "CI"}))
+          PATTERN
+
+          def on_send(node)
+            env?(node) do |env_value|
+              # we don't handle .nil? checks yet so just skip them
+              next if node.parent.send_type? && node.parent.method_name == :nil?
+
+              case env_value
+              when 'CI'
+                add_offense(node, message: 'Chef Infra Client 15.5 and later include a helper `ci?` that should be used to see if the `CI` env var is set.', severity: :refactor) do |corrector|
+                  corrector.replace(node, 'ci?')
+                end
+              when 'TEST_KITCHEN'
+                add_offense(node, message: 'Chef Infra Client 15.5 and later include a helper `kitchen?` that should be used to see if the `TEST_KITCHEN` env var is set.', severity: :refactor) do |corrector|
+                  corrector.replace(node, 'kitchen?')
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -19,7 +19,7 @@ module RuboCop
   module Cop
     module Chef
       module Style
-        # Use :immediately instead of :immediate for resource notification timing
+        # Use :immediately instead of :immediate for resource notification timing.
         #
         # @example
         #
@@ -39,10 +39,10 @@ module RuboCop
           extend AutoCorrector
 
           MSG = 'Use :immediately instead of :immediate for resource notification timing'
-          RESTRICT_ON_SEND = [:notifies].freeze
+          RESTRICT_ON_SEND = [:notifies, :subscribes].freeze
 
           def_node_matcher :immediate_notify?, <<-PATTERN
-            (send nil? :notifies (sym _) (...) $(sym :immediate))
+            (send nil? {:notifies :subscribes} (sym _) (...) $(sym :immediate))
           PATTERN
 
           def on_send(node)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cookstyle
 version: !ruby/object:Gem::Version
-  version: 7.18.0
+  version: 7.22.3
 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-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -17,14 +17,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.19.0
+        version: 1.20.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.19.0
+        version: 1.20.0
 description: 
 email:
 - thom@chef.io
@@ -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
@@ -99,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
@@ -175,6 +179,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 +189,13 @@ 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
 - lib/rubocop/cop/chef/modernize/dsl_include_in_resource.rb
 - lib/rubocop/cop/chef/modernize/empty_resource_initialize.rb
@@ -224,6 +236,8 @@ files:
 - lib/rubocop/cop/chef/modernize/simplify_apt_ppa_setup.rb
 - lib/rubocop/cop/chef/modernize/sysctl_param_resource.rb
 - lib/rubocop/cop/chef/modernize/unnecessary_mixlib_shellout_require.rb
+- lib/rubocop/cop/chef/modernize/use_chef_language_cloud_helpers.rb
+- lib/rubocop/cop/chef/modernize/use_chef_language_env_helpers.rb
 - lib/rubocop/cop/chef/modernize/use_multipackage_installs.rb
 - lib/rubocop/cop/chef/modernize/use_require_relative.rb
 - lib/rubocop/cop/chef/modernize/whyrun_supported_true.rb
@@ -291,7 +305,7 @@ licenses:
 - Apache-2.0
 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