cookstyle 7.11.1 → 7.12.6

data/lib/rubocop/cop/chef/deprecation/chef_handler_supports.rb

@@ -15,12 +15,11 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-
 module RuboCop
   module Cop
     module Chef
       module Deprecations
-        # Use the type property instead of the deprecated supports property in the chef_handler resource. The supports property was removed in chef_handler cookbook version 3.0 (June 2017) and Chef Infra Client 14.0.
+        # Use the type `property` instead of the deprecated `supports` property in the `chef_handler` resource. The `supports` property was removed in `chef_handler` cookbook version 3.0 (June 2017) and Chef Infra Client 14.0.
         #
         # @example
         #

data/lib/rubocop/cop/chef/deprecation/chef_rest.rb

@@ -15,12 +15,11 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-
 module RuboCop
   module Cop
     module Chef
       module Deprecations
-        # Chef::REST was removed in Chef Infra Client 13.
+        # The `Chef::REST` class was removed in Chef Infra Client 13.
         #
         # @example
         #

data/lib/rubocop/cop/chef/deprecation/chef_rewind.rb

@@ -15,12 +15,11 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-
 module RuboCop
   module Cop
     module Chef
       module Deprecations
-        # Use delete_resource / edit_resource introduced in Chef Infra Client 12.10 instead of functionality in the deprecated chef-rewind gem
+        # Use `delete_resource` or `edit_resource` helpers introduced in Chef Infra Client 12.10 instead of functionality in the deprecated `chef-rewind` gem
         #
         # @example
         #
@@ -48,7 +47,7 @@ module RuboCop
             unwind: 'delete_resource',
           }.freeze
 
-          MSG = 'Use delete_resource / edit_resource introduced in Chef Infra Client 12.10 instead of functionality in the deprecated chef-rewind gem'
+          MSG = 'Use delete_resource or edit_resource helpers introduced in Chef Infra Client 12.10 instead of functionality in the deprecated chef-rewind gem'
           RESTRICT_ON_SEND = [:chef_gem, :require, :rewind, :unwind].freeze
 
           def_node_matcher :rewind_gem_install?, <<-PATTERN

data/lib/rubocop/cop/chef/deprecation/chef_shellout.rb

@@ -15,14 +15,11 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-
 module RuboCop
   module Cop
     module Chef
       module Deprecations
-        # Don't use deprecated Chef::ShellOut which was removed in Chef Infra Client 13.
-        # Use Mixlib::ShellOut instead, which behaves identically or convert to the shell_out
-        # helper provided in chef-utils.
+        # Don't use the deprecated `Chef::ShellOut` class which was removed in Chef Infra Client 13. Use the `Mixlib::ShellOut` class instead, which behaves identically or convert to the simpler `shell_out` helper.
         #
         # @example
         #
@@ -40,7 +37,7 @@ module RuboCop
           include RangeHelp
           extend AutoCorrector
 
-          MSG = "Don't use deprecated Chef::ShellOut which was removed in Chef Infra Client 13. Use Mixlib::ShellOut instead, which behaves identically."
+          MSG = "Don't use the deprecated `Chef::ShellOut` class which was removed in Chef Infra Client 13. Use the `Mixlib::ShellOut` class instead, which behaves identically."
           RESTRICT_ON_SEND = [:new, :require, :include].freeze
 
           def_node_matcher :include_shellout?, <<-PATTERN

data/lib/rubocop/cop/chef/deprecation/chef_sugar_helpers.rb

@@ -15,33 +15,32 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-
 module RuboCop
   module Cop
     module Chef
-      # 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
-      #
-      # @example
-      #
-      #   #### incorrect
-      #   vagrant_key?
-      #   vagrant_domain?
-      #   vagrant_user?
-      #   require_chef_gem
-      #   best_ip_for(node)
-      #   nexus?
-      #   ios_xr?
-      #   ruby_20?
-      #   ruby_19?
-      #   includes_recipe?('foo::bar')
-      #   wrlinux?
-      #   dev_null
-      #   nexentacore_platform?
-      #   opensolaris_platform?
-      #   nexentacore?
-      #   opensolaris?
-      #
       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
+        #
+        # @example
+        #
+        #   #### incorrect
+        #   vagrant_key?
+        #   vagrant_domain?
+        #   vagrant_user?
+        #   require_chef_gem
+        #   best_ip_for(node)
+        #   nexus?
+        #   ios_xr?
+        #   ruby_20?
+        #   ruby_19?
+        #   includes_recipe?('foo::bar')
+        #   wrlinux?
+        #   dev_null
+        #   nexentacore_platform?
+        #   opensolaris_platform?
+        #   nexentacore?
+        #   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'
           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

data/lib/rubocop/cop/chef/deprecation/chefdk_generators.rb

@@ -15,12 +15,11 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-
 module RuboCop
   module Cop
     module Chef
       module Deprecations
-        # Chef Workstation 0.8 and later renamed the ChefDK module used when writing custom cookbook generators from ChefDK to ChefCLI. For compatibility with the latest Chef Workstation releases you'll need to reference the new class names.
+        # Chef Workstation 0.8 and later renamed the `ChefDK` module used when writing custom cookbook generators from `ChefDK` to `ChefCLI`. For compatibility with the latest Chef Workstation releases you'll need to reference the new class names.
         #
         # @example
         #

data/lib/rubocop/cop/chef/deprecation/cheffile.rb

@@ -15,13 +15,12 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-
 module RuboCop
   module Cop
     module Chef
-      # The Librarian-Chef depsolving project is no longer maintained and a Cheffile should not be used for cookbook depsolving. Consider using Policyfiles instead. If the Policyfiles model is not compatible with your workflow you may find Berkshelf offers a more similar, and still supported, experience to Librarian-Chef.
-      #
       module Deprecations
+        # The Librarian-Chef depsolving project is no longer maintained and a Cheffile should not be used for cookbook depsolving. Consider using Policyfiles instead. If the Policyfiles model is not compatible with your workflow you may find Berkshelf offers a more similar, and still supported, experience to Librarian-Chef.
+        #
         class Cheffile < Base
           include RangeHelp
 

data/lib/rubocop/cop/chef/deprecation/chefspec_coverage_report.rb

@@ -15,7 +15,6 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-
 module RuboCop
   module Cop
     module Chef

data/lib/rubocop/cop/chef/deprecation/chefspec_legacy_runner.rb

@@ -15,12 +15,11 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-
 module RuboCop
   module Cop
     module Chef
       module Deprecations
-        # Use ChefSpec::SoloRunner or ChefSpec::ServerRunner instead of the deprecated ChefSpec::Runner. These new runners were introduced in ChefSpec 4.1 (Oct 2014).
+        # Use `ChefSpec::SoloRunner` or `ChefSpec::ServerRunner` instead of the deprecated `ChefSpec::Runner`. These new runners were introduced in ChefSpec 4.1 (Oct 2014).
         #
         # @example
         #

data/lib/rubocop/cop/chef/deprecation/chocolatey_package_uninstall_action.rb

@@ -15,12 +15,11 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-
 module RuboCop
   module Cop
     module Chef
       module Deprecations
-        # Use the :remove action in the chocolatey_package resource instead of :uninstall which was removed in Chef Infra Client 14+
+        # Use the `:remove` action in the `chocolatey_package` resource instead of `:uninstall` which was removed in Chef Infra Client 14+.
         #
         # @example
         #

data/lib/rubocop/cop/chef/deprecation/depends_compat_resource.rb

@@ -19,7 +19,7 @@ module RuboCop
   module Cop
     module Chef
       module Deprecations
-        # Don't depend on the deprecated compat_resource cookbook made obsolete by Chef Infra Client 12.19+
+        # Don't depend on the deprecated `compat_resource` cookbook made obsolete by Chef Infra Client 12.19+.
         #
         # @example
         #

data/lib/rubocop/cop/chef/deprecation/depends_partial_search.rb

@@ -19,7 +19,7 @@ module RuboCop
   module Cop
     module Chef
       module Deprecations
-        # Don't depend on the partial_search cookbook made obsolete by Chef Infra Client 13
+        # Don't depend on the `partial_search` cookbook made obsolete by Chef Infra Client 13.
         #
         # @example
         #

data/lib/rubocop/cop/chef/deprecation/deprecated_chefspec_platform.rb

@@ -15,12 +15,11 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-
 module RuboCop
   module Cop
     module Chef
       module Deprecations
-        # 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
+        # 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 values so it's always best to be less specific ie. 10 instead of 10.3
         #
         # @example
         #

data/lib/rubocop/cop/chef/deprecation/deprecated_mixins.rb

@@ -15,12 +15,11 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-
 module RuboCop
   module Cop
     module Chef
       module Deprecations
-        # Don't use deprecated Mixins no longer included in Chef Infra Client 14 and later
+        # Don't use deprecated Mixins no longer included in Chef Infra Client 14 and later.
         #
         # @example
         #

data/lib/rubocop/cop/chef/deprecation/deprecated_platform_methods.rb

@@ -15,12 +15,11 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-
 module RuboCop
   module Cop
     module Chef
       module Deprecations
-        # Use provider_for_action or provides instead of the deprecated Chef::Platform methods in resources, which were removed in Chef Infra Client 13.
+        # Use `provider_for_action` or provides instead of the deprecated `Chef::Platform` methods in resources, which were removed in Chef Infra Client 13.
         #
         # @example
         #

data/lib/rubocop/cop/chef/deprecation/deprecated_shellout_methods.rb

@@ -15,12 +15,11 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-
 module RuboCop
   module Cop
     module Chef
       module Deprecations
-        # The large number of shell_out helper methods in Chef Infra Client has been reduced to just shell_out and shell_out! methods. The legacy methods were removed in Chef Infra Client and cookbooks using these legacy helpers will need to be updated.
+        # The large number of `shell_out` helper methods in Chef Infra Client has been reduced to just `shell_out` and `shell_out!` methods. The legacy methods were removed in Chef Infra Client and cookbooks using these legacy helpers will need to be updated.
         #
         # @example
         #

data/lib/rubocop/cop/chef/deprecation/deprecated_windows_version_check.rb

@@ -19,7 +19,7 @@ module RuboCop
   module Cop
     module Chef
       module Deprecations
-        # Don't use the deprecated older_than_win_2012_or_8? helper. Windows versions before 2012 and 8 are now end of life and this helper will always return false.
+        # Don't use the deprecated `older_than_win_2012_or_8?` helper. Windows versions before 2012 and 8 are now end of life and this helper will always return false.
         #
         # @example
         #

data/lib/rubocop/cop/chef/deprecation/deprecated_yum_repository_actions.rb

@@ -19,7 +19,7 @@ module RuboCop
   module Cop
     module Chef
       module Deprecations
-        # With the release of Chef Infra Client 12.14 and the yum cookbook 3.0 the actions the yum_repository resource actions were renamed. The `add` action became `create` and `delete` became `remove` to better match other resources in Chef Infra Client.
+        # With the release of Chef Infra Client 12.14 and the yum cookbook 3.0 the actions the `yum_repository` resource actions were renamed. The `add` action became `create` and `delete` became `remove` to better match other resources in Chef Infra Client.
         #
         # @example
         #

data/lib/rubocop/cop/chef/deprecation/deprecated_yum_repository_properties.rb

@@ -19,7 +19,7 @@ module RuboCop
   module Cop
     module Chef
       module Deprecations
-        # With the release of Chef Infra Client 12.14 and the yum cookbook 3.0 several properties in the yum_repository resource were renamed. url -> baseurl, keyurl -> gpgkey, and mirrorexpire -> mirror_expire.
+        # With the release of Chef Infra Client 12.14 and the yum cookbook 3.0 several properties in the `yum_repository` resource were renamed. `url` -> `baseurl`, `keyurl` -> `gpgkey`, and `mirrorexpire` -> `mirror_expire`.
         #
         # @example
         #

data/lib/rubocop/cop/chef/deprecation/easy_install.rb

@@ -15,12 +15,11 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-
 module RuboCop
   module Cop
     module Chef
       module Deprecations
-        # Don't use the deprecated easy_install resource removed in Chef Infra Client 13
+        # Don't use the deprecated easy_install resource removed in Chef Infra Client 13.
         #
         # @example
         #

data/lib/rubocop/cop/chef/deprecation/eol_audit_mode.rb

@@ -19,7 +19,7 @@ module RuboCop
   module Cop
     module Chef
       module Deprecations
-        # The beta Audit Mode for Chef Infra Client was removed in Chef Infra Client 15.0. Users should instead use InSpec and the audit cookbook. See https://www.inspec.io/ for more information.
+        # The beta Audit Mode for Chef Infra Client was removed in Chef Infra Client 15.0. Users should instead use InSpec and the audit cookbook or the Compliance Phase introduced in Chef Infra Client 17. See https://www.inspec.io/ for more information.
         #
         # @example
         #
@@ -31,9 +31,8 @@ module RuboCop
         #       end
         #     end
         #   end
-
         class EOLAuditModeUsage < Base
-          MSG = 'The beta Audit Mode feature in Chef Infra Client was removed in Chef Infra Client 15.0. Users should instead use InSpec and the audit cookbook. See https://www.inspec.io/ for more information.'
+          MSG = 'The beta Audit Mode feature in Chef Infra Client was removed in Chef Infra Client 15.0.'
           RESTRICT_ON_SEND = [:control_group].freeze
 
           def_node_matcher :control_group?, '(send nil? :control_group ...)'

data/lib/rubocop/cop/chef/deprecation/epic_fail.rb

@@ -15,12 +15,11 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-
 module RuboCop
   module Cop
     module Chef
       module Deprecations
-        # Make sure ignore_failure is used instead of epic_fail
+        # Use `ignore_failure` in resources to continue when failures occur instead of the deprecated `epic_fail` property.
         #
         # @example
         #
@@ -37,7 +36,7 @@ module RuboCop
         class EpicFail < Base
           extend AutoCorrector
 
-          MSG = 'Use ignore_failure method instead of the deprecated epic_fail method'
+          MSG = 'Use `ignore_failure` in resources to continue when failures occur instead of the deprecated `epic_fail` property'
           RESTRICT_ON_SEND = [:epic_fail].freeze
 
           def on_send(node)

data/lib/rubocop/cop/chef/deprecation/erl_call.rb

@@ -15,12 +15,11 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-
 module RuboCop
   module Cop
     module Chef
       module Deprecations
-        # Don't use the deprecated erl_call resource
+        # Don't use the deprecated `erl_call` resource removed in Chef Infra Client 13."
         #
         # @example
         #

data/lib/rubocop/cop/chef/deprecation/execute_path_property.rb

@@ -15,7 +15,6 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-
 module RuboCop
   module Cop
     module Chef

data/lib/rubocop/cop/chef/deprecation/execute_relative_creates_without_cwd.rb

@@ -15,7 +15,6 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-
 module RuboCop
   module Cop
     module Chef

data/lib/rubocop/cop/chef/deprecation/hwrp_without_provides.rb

@@ -15,7 +15,6 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-
 module RuboCop
   module Cop
     module Chef

data/lib/rubocop/cop/chef/deprecation/hwrp_without_unified_mode_true.rb

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+#
+# Copyright:: Copyright (c) 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
+        # Chef Infra Client 15.3 and later include a new Unified Mode that simplies the execution of resoures by replace the traditional compile and converge phases with a single phase. Unified mode simplies writing advanced resources and avoids confusing errors that often occur when mixing ruby and Chef Infra resources. Chef Infra Client 17.0 and later will beging warning that `unified_mode true` should be set in all resources to validate that they will continue to function in Chef Infra Client 18.0 (April 2022) when Unified Mode becomes the default.
+        #
+        # @example
+        #
+        #  #### incorrect
+        #   class Chef
+        #     class Resource
+        #       class UlimitRule < Chef::Resource
+        #         provides :ulimit_rule
+        #
+        #         property :type, [Symbol, String], required: true
+        #         property :item, [Symbol, String], required: true
+        #
+        #         # additional resource code
+        #       end
+        #     end
+        #   end
+        #
+        #  #### correct
+        #   class Chef
+        #     class Resource
+        #       class UlimitRule < Chef::Resource
+        #         provides :ulimit_rule
+        #         unified_mode true
+        #
+        #         property :type, [Symbol, String], required: true
+        #         property :item, [Symbol, String], required: true
+        #
+        #         # additional resource code
+        #       end
+        #     end
+        #   end
+        #
+        class HWRPWithoutUnifiedTrue < Base
+          extend TargetChefVersion
+
+          minimum_target_chef_version '15.3'
+
+          MSG = 'Set `unified_mode true` in Chef Infra Client 15.3+ HWRP style custom resources to ensure they work correctly in Chef Infra Client 18 (April 2022) when Unified Mode becomes the default.'
+
+          def_node_matcher :HWRP?, <<-PATTERN
+          (class
+            (const nil? :Chef) nil?
+            (class
+              (const nil? :Resource) nil?
+              $(class
+                (const nil? ... )
+                (const
+                  (const nil? :Chef) :Resource)
+                  (begin ... ))))
+          PATTERN
+
+          def_node_search :unified_mode?, '(send nil? :unified_mode ...)'
+
+          def on_class(node)
+            return if unified_mode?(processed_source.ast)
+            HWRP?(node) do |inherit|
+              add_offense(inherit, message: MSG, severity: :warning)
+            end
+          end
+        end
+      end
+    end
+  end
+end