cookstyle 5.15.7 → 5.16.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 394f526dcec8c22ebd9db30e8c32686fe508cf388d3903769157428c49690c6d
-  data.tar.gz: abba87a8fea82ef987ca27c3631fa25bc925c55ac7f59b6d07735123092d279a
+  metadata.gz: 66d82d484b05b0d3488692059365bd5528ab3520c1115b5141d67193ce20f348
+  data.tar.gz: 2134a1885a0d40337f1a7e5a130afd3b983ffc1896bbf71a2033a0a746e6314e
 SHA512:
-  metadata.gz: '08e6f1c8d8563494ab21c7d69021c4955d4b2ed2af6cb6e59394510fc07eff5eabf23b6a1575afcb8994d1dfbe11446a26a456395a8d7ce1392cf1c10074d548'
-  data.tar.gz: '09eecb0aebc0837b48e72741f805ac13fd4bb2b64e53d0d762053dfb6d6763f3c53ef81c6fc647c2909bf76351fad15d28264484ea0c8d81494c4482a1476976'
+  metadata.gz: 2b02f462850e5089721ee7492c43e95c97812332ec3c38e255e5aab9a1be8adc7639518a6330096ffc98fc51215273e71aef3a8d6990832ab74b65c33056afcd
+  data.tar.gz: 954bc031f06e5a5d0283e7fb6191306cf61be83b504652c7ad9240ab508a1485ad6cfeb70ec579167d86de750b3bced18bd01c1f133956756ac95c9a64771c7c

data/config/cookstyle.yml

@@ -1,5 +1,6 @@
 AllCops:
   TargetRubyVersion: 2.4
+  TargetChefVersion: ~
   Exclude:
     - files/**/*
     - vendor/**/*
@@ -55,21 +56,26 @@ ChefStyle/CommentFormat:
   Description: Use Chef's unique format for comment headers
   Enabled: true
   VersionAdded: '5.0.0'
+  Exclude:
+    - '**/Berksfile'
 
 ChefStyle/FileMode:
   Description: Use strings to represent file modes in Chef resources
   Enabled: true
   VersionAdded: '5.0.0'
   Exclude:
+    - '**/attributes/*'
     - '**/metadata.rb'
+    - '**/Berksfile'
 
 ChefStyle/UsePlatformHelpers:
-  Description: Use platform? and platform_family? helpers for checking node platform in resources and recipes
+  Description: Use platform? and platform_family? helpers to check node platform in resources and recipes
   Enabled: true
   VersionAdded: '5.6.0'
   Exclude:
     - '**/metadata.rb'
     - '**/libraries/*'
+    - '**/Berksfile'
 
 ChefStyle/SimplifyPlatformMajorVersionCheck:
   Description: Use node['platform_version'].to_i instead of node['platform_version'].split('.').first or node['platform_version'].split('.')[0]
@@ -77,12 +83,38 @@ ChefStyle/SimplifyPlatformMajorVersionCheck:
   VersionAdded: '5.8.0'
   Exclude:
     - '**/metadata.rb'
+    - '**/Berksfile'
 
 ChefStyle/DefaultCopyrightComments:
   Description: Cookbook copyright comment headers should be updated for a real person or organization.
   Enabled: true
   VersionAdded: '5.12.0'
 
+ChefStyle/UnnecessaryPlatformCaseStatement:
+  Description: Use the platform?() and platform_family?() helpers instead of a case statement that only includes a single when statement.
+  Enabled: true
+  VersionAdded: '5.16.0'
+  Exclude:
+    - '**/metadata.rb'
+    - '**/Berksfile'
+
+ChefStyle/ImmediateNotificationTiming:
+  Description: Use :immediately instead of :immediate for resource notification timing.
+  Enabled: true
+  VersionAdded: '5.16.0'
+  Exclude:
+    - '**/attributes/*.rb'
+    - '**/metadata.rb'
+    - '**/Berksfile'
+
+ChefStyle/TrueClassFalseClassResourceProperties:
+  Description: When setting the allowed types for a resource to accept either true or false values it's much simpler to use true and false instead of TrueClass and FalseClass.
+  Enabled: true
+  VersionAdded: '5.16.0'
+  Include:
+    - '**/libraries/*.rb'
+    - '**/resources/*.rb'
+
 ###############################
 # ChefCorrectness: Avoiding potential problems
 ###############################
@@ -92,7 +124,9 @@ ChefCorrectness/ServiceResource:
   Enabled: true
   VersionAdded: '5.0.0'
   Exclude:
+    - '**/attributes/*.rb'
     - '**/metadata.rb'
+    - '**/Berksfile'
 
 ChefCorrectness/NodeNormal:
   Description: Do not use the node.normal method
@@ -100,6 +134,7 @@ ChefCorrectness/NodeNormal:
   VersionAdded: '5.1.0'
   Exclude:
     - '**/metadata.rb'
+    - '**/Berksfile'
 
 ChefCorrectness/NodeNormalUnless:
   Description: Do not use the node.normal_unless method
@@ -107,6 +142,7 @@ ChefCorrectness/NodeNormalUnless:
   VersionAdded: '5.1.0'
   Exclude:
     - '**/metadata.rb'
+    - '**/Berksfile'
 
 ChefCorrectness/TmpPath:
   Description: Use file_cache_path rather than hard-coding tmp paths
@@ -114,6 +150,7 @@ ChefCorrectness/TmpPath:
   VersionAdded: '5.0.0'
   Exclude:
     - '**/metadata.rb'
+    - '**/Berksfile'
 
 ChefCorrectness/InvalidPlatformMetadata:
   Description: metadata.rb "supports" platform is invalid
@@ -128,6 +165,7 @@ ChefCorrectness/CookbookUsesNodeSave:
   VersionAdded: '5.5.0'
   Exclude:
     - '**/metadata.rb'
+    - '**/Berksfile'
 
 ChefCorrectness/CookbooksDependsOnSelf:
   Description: A cookbook cannot depend on itself
@@ -148,28 +186,36 @@ ChefCorrectness/BlockGuardWithOnlyString:
   Enabled: true
   VersionAdded: '5.2.0'
   Exclude:
+    - '**/attributes/*.rb'
     - '**/metadata.rb'
+    - '**/Berksfile'
 
 ChefCorrectness/ResourceSetsInternalProperties:
   Description: Do not set properties used internally by Chef Infra Client to track the system state.
   Enabled: true
   VersionAdded: '5.5.0'
   Exclude:
+    - '**/attributes/*.rb'
     - '**/metadata.rb'
+    - '**/Berksfile'
 
 ChefCorrectness/ResourceSetsNameProperty:
   Description: Resource sets the name property in the resource instead of using a name_property.
   Enabled: true
   VersionAdded: '5.5.0'
   Exclude:
+    - '**/attributes/*.rb'
     - '**/metadata.rb'
+    - '**/Berksfile'
 
 ChefCorrectness/ResourceWithNoneAction:
   Description: Resource uses the nonexistent :none action instead of the :nothing action
   Enabled: true
   VersionAdded: '5.5.0'
   Exclude:
+    - '**/attributes/*.rb'
     - '**/metadata.rb'
+    - '**/Berksfile'
 
 ChefCorrectness/InvalidVersionMetadata:
   Description: Cookbook metadata.rb version field should follow X.Y.Z version format.
@@ -179,11 +225,13 @@ ChefCorrectness/InvalidVersionMetadata:
     - '**/metadata.rb'
 
 ChefCorrectness/NotifiesActionNotSymbol:
-  Description: When notifying an action within a resource the action should always be a symbol. In Chef Infra Client releases before 14.0 this may result in double notification.
+  Description: When notifying or subscribing an action within a resource the action should always be a symbol. In Chef Infra Client releases before 14.0 this may result in double notification.
   Enabled: true
   VersionAdded: '5.10.0'
   Exclude:
+    - '**/attributes/*.rb'
     - '**/metadata.rb'
+    - '**/Berksfile'
 
 ChefCorrectness/IncorrectLibraryInjection:
   Description: Libraries should be injected into the Chef::DSL::Recipe or Chef::DSL::Resource classes and not Recipe/Resource/Provider classes directly.
@@ -198,6 +246,7 @@ ChefCorrectness/InvalidPlatformHelper:
   VersionAdded: '5.15.0'
   Exclude:
     - '**/metadata.rb'
+    - '**/Berksfile'
 
 ChefCorrectness/InvalidPlatformFamilyHelper:
   Description: Pass valid platform families to the platform_family? helper.
@@ -205,13 +254,16 @@ ChefCorrectness/InvalidPlatformFamilyHelper:
   VersionAdded: '5.15.0'
   Exclude:
     - '**/metadata.rb'
+    - '**/Berksfile'
 
 ChefCorrectness/ScopedFileExist:
   Description: Scope file exist to access the correct File class by using ::File.exist? not File.exist?.
   Enabled: true
   VersionAdded: '5.15.0'
   Exclude:
+    - '**/attributes/*.rb'
     - '**/metadata.rb'
+    - '**/Berksfile'
 
 ChefCorrectness/InvalidPlatformValueForPlatformFamilyHelper:
   Description: Pass valid platforms families to the value_for_platform_family helper.
@@ -219,6 +271,7 @@ ChefCorrectness/InvalidPlatformValueForPlatformFamilyHelper:
   VersionAdded: '5.15.0'
   Exclude:
     - '**/metadata.rb'
+    - '**/Berksfile'
 
 ChefCorrectness/InvalidPlatformValueForPlatformHelper:
   Description: Pass valid platforms to the value_for_platform helper.
@@ -226,6 +279,33 @@ ChefCorrectness/InvalidPlatformValueForPlatformHelper:
   VersionAdded: '5.15.0'
   Exclude:
     - '**/metadata.rb'
+    - '**/Berksfile'
+
+ChefCorrectness/InvalidNotificationTiming:
+  Description: Valid notification timings are :immediately, :immediate (alias for :immediately), :delayed, and :before.
+  Enabled: true
+  VersionAdded: '5.16.0'
+  Exclude:
+    - '**/attributes/*.rb'
+    - '**/metadata.rb'
+    - '**/Berksfile'
+
+ChefCorrectness/MalformedPlatformValueForPlatformHelper:
+  Description: When using the value_for_platform helper you must include a hash of possible platforms where each platform contains a hash of versions and potential values. If you don't wish to match on a particular version you can instead use the key 'default'.
+  Enabled: true
+  VersionAdded: '5.16.0'
+  Exclude:
+    - '**/metadata.rb'
+    - '**/Berksfile'
+
+ChefCorrectness/DnfPackageAllowDowngrades:
+  Description: dnf_package does not support the allow_downgrades property
+  Enabled: true
+  VersionAdded: '5.16.0'
+  Exclude:
+    - '**/attributes/*.rb'
+    - '**/metadata.rb'
+    - '**/Berksfile'
 
 ###############################
 # ChefSharing: Issues that prevent sharing code with other teams or with the Chef community in general
@@ -273,6 +353,7 @@ ChefDeprecations/NodeDeepFetch:
   VersionAdded: '5.12.0'
   Exclude:
     - '**/metadata.rb'
+    - '**/Berksfile'
 
 ChefDeprecations/NodeSet:
   Description: Do not use the deprecated node.set method
@@ -280,6 +361,7 @@ ChefDeprecations/NodeSet:
   VersionAdded: '5.0.0'
   Exclude:
     - '**/metadata.rb'
+    - '**/Berksfile'
 
 ChefDeprecations/NodeSetUnless:
   Description: Do not use the deprecated node.set_unless method
@@ -287,13 +369,16 @@ ChefDeprecations/NodeSetUnless:
   VersionAdded: '5.1.0'
   Exclude:
     - '**/metadata.rb'
+    - '**/Berksfile'
 
 ChefDeprecations/EpicFail:
   Description: Use ignore_failure method instead of the deprecated epic_fail method
   Enabled: true
   VersionAdded: '5.1.0'
   Exclude:
+    - '**/attributes/*.rb'
     - '**/metadata.rb'
+    - '**/Berksfile'
 
 ChefDeprecations/CookbookDependsOnPoise:
   Description: Cookbooks should not depend on the deprecated Poise framework
@@ -321,21 +406,27 @@ ChefDeprecations/EasyInstallResource:
   Enabled: true
   VersionAdded: '5.1.0'
   Exclude:
+    - '**/attributes/*.rb'
     - '**/metadata.rb'
+    - '**/Berksfile'
 
 ChefDeprecations/ErlCallResource:
   Description: Don't use the deprecated erl_call resource removed in Chef 13
   Enabled: true
   VersionAdded: '5.1.0'
   Exclude:
+    - '**/attributes/*.rb'
     - '**/metadata.rb'
+    - '**/Berksfile'
 
 ChefDeprecations/RequireRecipe:
   Description: Use include_recipe instead of the require_recipe method
   Enabled: true
   VersionAdded: '5.2.0'
   Exclude:
+    - '**/attributes/*.rb'
     - '**/metadata.rb'
+    - '**/Berksfile'
 
 ChefDeprecations/NodeMethodsInsteadofAttributes:
   Description: Use node attributes to access Ohai data instead of node methods, which were deprecated in Chef Infra Client 13.
@@ -343,6 +434,7 @@ ChefDeprecations/NodeMethodsInsteadofAttributes:
   VersionAdded: '5.4.0'
   Exclude:
     - '**/metadata.rb'
+    - '**/Berksfile'
 
 ChefDeprecations/UsesDeprecatedMixins:
   Description: Don't use deprecated Mixins no longer included in Chef Infra Client 14 and later.
@@ -358,7 +450,9 @@ ChefDeprecations/IncludingXMLRubyRecipe:
   Enabled: true
   VersionAdded: '5.4.0'
   Exclude:
+    - '**/attributes/*.rb'
     - '**/metadata.rb'
+    - '**/Berksfile'
 
 ChefDeprecations/LegacyYumCookbookRecipes:
   Description: The elrepo, epel, ius, remi, and repoforge recipes were split into their own cookbooks and the yum recipe was renamed to be default with the release of yum cookbook 3.0 (Dec 2013).
@@ -458,7 +552,6 @@ ChefDeprecations/NamePropertyWithDefaultValue:
   VersionAdded: '5.7.0'
   Include:
     - '**/libraries/*.rb'
-    - '**/providers/*.rb'
     - '**/resources/*.rb'
 
 ChefDeprecations/ResourceUsesProviderBaseMethod:
@@ -582,6 +675,24 @@ ChefDeprecations/ChefRewind:
     - '**/metadata.rb'
     - '**/attributes/*.rb'
 
+ChefDeprecations/RubyBlockCreateAction:
+  Description: Use the :run action in the ruby_block resource instead of the deprecated :create action
+  Enabled: true
+  VersionAdded: '5.16.0'
+  Exclude:
+    - '**/metadata.rb'
+    - '**/attributes/*.rb'
+    - '**/Berksfile'
+
+ChefDeprecations/DeprecatedPlatformMethods:
+  Description: Use provider_for_action instead of the deprecated Chef::Platform methods in resources.
+  Enabled: true
+  VersionAdded: '5.16.0'
+  Include:
+    - '**/libraries/*.rb'
+    - '**/resources/*.rb'
+    - '**/providers/*.rb'
+
 ###############################
 # ChefModernize: Cleaning up legacy code and using new built-in resources
 ###############################
@@ -901,6 +1012,7 @@ ChefModernize/IncludingOhaiDefaultRecipe:
   VersionChanged: '5.15.0'
   Exclude:
     - '**/metadata.rb'
+    - '**/Berksfile'
 
 ChefModernize/AllowedActionsFromInitialize:
   Description: The allowed actions of a resource can be set with the "allowed_actions" helper instead of using the initialize method.
@@ -910,6 +1022,40 @@ ChefModernize/AllowedActionsFromInitialize:
     - '**/resources/*.rb'
     - '**/libraries/*.rb'
 
+ChefModernize/FoodcriticComments:
+  Description: Remove legacy code comments that disable Foodcritic rules. These comments are no longer necessary if you've migrated from Foodcritic to Cookstyle for cookbook linting.
+  Enabled: false
+  VersionAdded: '5.16.0'
+  Exclude:
+    - '**/Berksfile'
+
+ChefModernize/ExecuteScExe:
+  Description: Chef Infra Client 14.0 and later includes :create, :delete, and :configure actions with the full idempotency of the windows_service resource. See the windows_service documentation at https://docs.chef.io/resource_windows_service.html for additional details on creating services with the windows_service resource
+  Enabled: false
+  VersionAdded: '5.16.0'
+  Exclude:
+    - '**/metadata.rb'
+    - '**/attributes/*.rb'
+    - '**/Berksfile'
+
+ChefModernize/WindowsScResource:
+  Description: Chef Infra Client 14.0 and later includes :create, :delete, and :configure actions without the need for the sc cookbook dependency. See the windows_service documentation at https://docs.chef.io/resource_windows_service.html for additional details.
+  Enabled: false
+  VersionAdded: '5.16.0'
+  Exclude:
+    - '**/metadata.rb'
+    - '**/attributes/*.rb'
+    - '**/Berksfile'
+
+ChefModernize/ExecuteSleep:
+  Description: Chef Infra Client 15.5 and later include a chef_sleep resource that should be used to sleep between executing resources if necessary instead of using the bash or execute resources to run the sleep command.
+  Enabled: false
+  VersionAdded: '5.16.0'
+  Exclude:
+    - '**/metadata.rb'
+    - '**/attributes/*.rb'
+    - '**/Berksfile'
+
 ###############################
 # ChefRedundantCode: Cleanup unncessary code in your cookbooks regardless of chef-client release
 ###############################
@@ -1007,7 +1153,7 @@ ChefRedundantCode/NamePropertyIsRequired:
     - '**/resources/*.rb'
     - '**/libraries/*.rb'
 
-ChefRedundant/CustomResourceWithAllowedActions:
+ChefRedundantCode/CustomResourceWithAllowedActions:
   Description: It is not necessary to set `actions` or `allowed_actions` in custom resources as Chef Infra Client determines these automatically from the set of all actions defined in the resource.
   Enabled: true
   VersionAdded: '5.2.0'
@@ -1015,6 +1161,22 @@ ChefRedundant/CustomResourceWithAllowedActions:
   Include:
     - '**/resources/*.rb'
 
+ChefRedundantCode/SensitivePropertyInResource:
+  Description: Every Chef Infra resources already include a sensitive property with a default value of false.
+  Enabled: true
+  VersionAdded: '5.16.0'
+  Include:
+    - '**/resources/*.rb'
+    - '**/libraries/*.rb'
+
+ChefRedundantCode/UnnecessaryDesiredState:
+  Description: 'There is no need to set a property to desired_state: true as all properties have a desired_state of true by default.'
+  Enabled: true
+  VersionAdded: '5.16.0'
+  Include:
+    - '**/resources/*.rb'
+    - '**/libraries/*.rb'
+
 ###############################
 # Migrating to new patterns
 ###############################
@@ -1025,6 +1187,7 @@ ChefEffortless/CookbookUsesSearch:
   VersionAdded: '5.1.0'
   Exclude:
     - '**/metadata.rb'
+    - '**/Berksfile'
 
 ChefEffortless/CookbookUsesDatabags:
   Description: Cookbook uses data bags, which cannot be used in the Effortless Infra pattern
@@ -1032,6 +1195,7 @@ ChefEffortless/CookbookUsesDatabags:
   VersionAdded: '5.1.0'
   Exclude:
     - '**/metadata.rb'
+    - '**/Berksfile'
 
 ChefEffortless/CookbookUsesEnvironmments:
   Description: Cookbook uses environments, which cannot be used in the Effortless Infra pattern
@@ -1039,6 +1203,7 @@ ChefEffortless/CookbookUsesEnvironmments:
   VersionAdded: '5.10.0'
   Exclude:
     - '**/metadata.rb'
+    - '**/Berksfile'
 
 ChefEffortless/CookbookUsesPolicygroups:
   Description: Cookbook uses Policy Groups, which cannot be used in the Effortless Infra pattern
@@ -1046,6 +1211,7 @@ ChefEffortless/CookbookUsesPolicygroups:
   VersionAdded: '5.10.0'
   Exclude:
     - '**/metadata.rb'
+    - '**/Berksfile'
 
 ChefEffortless/CookbookUsesRoles:
   Description: Cookbook uses Roles, which cannot be used in the Effortless Infra pattern
@@ -1053,6 +1219,7 @@ ChefEffortless/CookbookUsesRoles:
   VersionAdded: '5.10.0'
   Exclude:
     - '**/metadata.rb'
+    - '**/Berksfile'
 
 ChefEffortless/SearchForEnvironmentsOrRoles:
   Description: Cookbook uses search with a node query that looks for a role or environment
@@ -1060,6 +1227,7 @@ ChefEffortless/SearchForEnvironmentsOrRoles:
   VersionAdded: '5.11.0'
   Exclude:
     - '**/metadata.rb'
+    - '**/Berksfile'
 
 ChefEffortless/Berksfile:
   Description: Policyfiles should be used for cookbook dependency solving instead of a Berkshelf Berksfile.