The RuboCop engine that powers Cookstyle has been updated to 1.17.0. This new release improves autocorrection and resolves a large number of detection errors.
Cookstyle now includes Chef InSpec specific Cops in the InSpec/Deprecations department. These new Chef InSpec cops help with the migration from InSpec attributes to inputs. We plan to add additional deprecation and correctness cops for InSpec in the future. If you have any ideas for InSpec cops you'd like to see added, please request a new cop.
The Chef/Deprecations/AttributeDefault cop detects Chef InSpec profiles that pass the default option to attribute or input helpers instead of the newer value option.
Enabled by default: True
Autocorrects: False
The Chef/Deprecations/AttributeHelper cop detects Chef InSpec profiles that use the deprecated attribute helper instead of the input helper.
Enabled by default: True
Autocorrects: False
The RuboCop engine that powers Cookstyle has been updated to 1.9.0. This new release improves autocorrection and resolves a large number of detection errors.
The Lint/DeprecatedConstants cop detects legacy constant values TRUE, FALSE, and NIL that were deprecated in Ruby 2.4 (Chef Infra Client 13).
The RuboCop engine that powers Cookstyle has been updated to 1.7.0. This new release improves autocorrection and resolves several detection errors.
- The
Chef/RedundantCode/UnnecessaryNamePropertyhas been improved to detect additional cases where an unnecessary name property is defined in a resource.
The RuboCop engine that powers Cookstyle has been updated to 1.6.1. This new release enables autocorrection in several existing cops, improves messages when using incorrect department names in configuration files, and resolves several detection errors.
RuboCop has been updated to 1.5.0, which includes bug fixes and improvements for many of RuboCop's built in Ruby cops.
The Chef/Deprecations/ChefSugarHelpers cop detects cookbooks that use helpers from the deprecated chef-sugar project that have not been moved into the Chef Infra Client itself. Chef Sugar functionality was mostly merged into Chef Infra Client, but we do not plan to move some helpers with limited or dated value.
- 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?
The Chef/Deprecations/DeprecatedYumRepositoryActions cop detects legacy yum_repository actions replaced with the release of Chef Infra Client 12.14 and the yum cookbook 3.0.
- :add -> :create
- :delete -> :remove
- The
Lint/SendWithMixinArgumentcop has been disabled as the correction necessary to resolve the warning is not clear. - The
Chef/Modernize/RespondToProvidesnow checks custom resources for.respond_to?(:provides). - The
Chef/Modernize/ActionMethodInResourcecop has been updated to skip HWRPs where it would cause errors in some releases of Chef Infra Client. - Cookstyle now skips additional files when executing cops in order to speed up Cookstyle scan times.
- Fixed a failure running
Chef/Style/CommentSentenceSpacing. - The
Chef/Deprecations/DeprecatedChefSpecPlatformcop has been updated to detect ChefSpec tests using macOS 10.13 and Debian 8 Fauxhai data, which is now deprecated.
RuboCop has been updated to 1.3.1, which includes bug fixes and improvements for many of RuboCop's built in Ruby cops.
RuboCop has been updated to 1.2.0, which includes bug fixes and improvements for many of RuboCop's built in Ruby cops.
The Chef/Deprecations/FoodcriticTesting cop detects cookbooks with a Gemfile that requires Foodcritic or any code, such as a Rakefile/Guardfile, that requires the Foodcritic gem. Foodcritic is no longer supported and has been significantly eclipsed in functionality by Cookstyle. Any existing Rakefile or Guardfile tests for Foodcritic should be updated to use Cookstyle instead.
Enabled by default: True
Autocorrects: False
The Chef/Deprecations/LibrarianChefSpec cop detects ChefSpec tests that require the legacy chefspec/librarian library. Librarian Chef is no longer supported and users should migrate to Berkshelf or Policyfiles.
Enabled by default: True
Autocorrects: True
The Style/CollectionCompact cop detects code that removes nil values from Hashes or Arrays using a Ruby block when this can be done with the compact method instead.
Examples:
Overly complex nil removals:
array.reject { |e| e.nil? }
array.select { |e| !e.nil? }Simpler nil removal:
array.compact- The
Chef/Modernize/UseMultipackageInstallscop no longer fails if thewhencondition uses a Regex instead of a String. - The
Chef/Modernize/UseMultipackageInstallscop detects overly complex arrays of package resources if thewhencondition contains code other than the package resources.
Cookstyle 7.0 upgrades to the RuboCop 1.0 engine. This new release of RuboCop has enabled us to improve the naming scheme for Cookstyle cops. Previously all Cookstyle cops started with Chef and then included the description of what the department actually did such as ChefDeprecations, which was for deprecation cops. Cop names are now three parts instead of two so ChefDeprecations/SomeCop becomes Chef/Deprecations/SomeCop. Why the change? Using this format makes it much easier to enable just the Chef specific cops in Cookstyle without having to list each individual department. Now you can run cookstyle --only Chef to see just Chef Infra related cops without the additional few hundred Ruby specific cops provided by RuboCop. Cookstyle will automatically migrate any comments to the new department names, but anything in your .rubocop.yml will need to be updated manually.
- ChefCorrectness -> Chef/Correctness
- ChefDeprecations -> Chef/Deprecations
- ChefEffortless -> Chef/Effortless
- ChefModernize -> Chef/Modernize
- RedundantCode -> Chef/RedundantCode
- ChefSharing -> Chef/Sharing
- ChefStyle -> Chef/Style
The ChefCorrectness/OctalModeAsString cop detects mode properties that incorrectly use a string to represent an octal value. We highly recommend using strings which contain a base 10 mode value, but even if you want to use octal values, they can't be passed as strings.
Enabled by default: True
Autocorrects: False
The ChefDeprecations/UseYamlDump cop detects cookbooks that use the .to_yaml method. Chef Infra Client 16.5 introduced performance enhancements to Ruby library loading and due to the underlying implementation of Ruby's .to_yaml method, it does not automatically load the yaml library. We recommend using YAML.dump() instead, which is functionally equivalent, and also properly loads the yaml library.
Enabled by default: True
Autocorrects: True
RuboCop has been updated to 0.93.0, which includes a large number of bug fixes and performance improvements when scanning large repositories.
The Lint/RedundantSafeNavigation cop detects redundant save navigation operators in order to simplify code. For example attrs&.respond_to?(:[]) can be simplified to just attrs.respond_to?(:[]) because respond_to? will not error even if attrs is not defined.
Enabled by default: True
Autocorrects: True
RuboCop has been updated to 0.92.0, which includes a large number of bug fixes to the built-in RuboCop cops that Cookstyle uses.
The ChefEffortless/ChefVaultUsed cop detects cookbooks that use the Chef Vault helpers to access Chef Vault encrypted data bag secrets. Chef Vault is not compatible with the Chef Infra Effortless pattern and users will need to migrate to a different secrets storage system.
Enabled by default: False
Autocorrects: False
The ChefEffortless/DependsChefVault cop detects cookbooks that depend on the chef-vault cookbook. Chef Vault is not compatible with the Chef Infra Effortless pattern and users will need to migrate to a different secrets storage system.
Enabled by default: False
Autocorrects: False
- The performance of the
ChefStyle/CommentFormatandChefCorrectness/IncorrectLibraryInjectioncops have been greatly improved. - The
ChefModernize/RespondToInMetadatacop now detects additional methods of gating metadata for legacy Chef Infra Client releases.
RuboCop has been updated to 0.91.0, which includes a large number of bug fixes to the built-in RuboCop cops that Cookstyle uses as well as significant performance improvements.
The ChefCorrectness/LazyInResourceGuard cop detects resources that use only_if/not_if conditionals where the Ruby code block is wrapped in lazy {}. All resource conditionals are always lazily evaluated (evaluated at runtime) so there is no need to wrap them in lazy and doing so results in failures.
Enabled by default: True
Autocorrects: Yes
The ChefCorrectness/PropertyWithoutType cop detects properties or attributes in resources that don't declare their type such as Array, String, or Hash. Not including a type limits the built-in validation performed by the Chef Infra Client for all user inputs, and can cause difficult to troubleshoot failures.
Enabled by default: True
Autocorrects: No
Several new built-in RuboCop cops have been enabled to help simplify Ruby code within Chef Infra cookbooks. We've chosen to enable these cops as they simplify cookbook code and they all support autocorrection.
The Lint/RedundantRequireStatement cop detects code requiring several built-in Ruby libraries that are required out of the box by Ruby.
The Style/Strip cop detects code that calls 'abc'.lstrip.rstrip when 'abc'.strip can be used instead.
The Style/StderrPuts cop detects code that calls $stderr.puts('hello') when warn('hello') can be used instead.
The Style/Sample detects code that uses the shuffle method to sample data from an array when sample can be used instead.
The Style/ReturnNil cop detects methods that use return nil when return can be used instead as nil is implied.
The Style/RedundantSortBy cop detects code that calls sort_by with a block in ways that can be simplified to use just sort instead, without the need for a block.
The Style/RedundantSort cop detects code that calls sort in order to determine the minimum or maximum values when the min or max methods could be used instead.
The Style/RedundantFileExtensionInRequire cop detects code that requires libraries with their complete filenames when the .rb extension is not necessary.
The Style/RedundantCondition cop detects complex ternary operators that can be reduced to simpler x || y type expressions.
The Style/Encoding cop detects .rb files that start with a UTF-8 Ruby encoding comment. These comments are no longer necessary as Ruby now defaults to UTF-8 as of Ruby 2.0 (Chef Infra Client 12).
The Style/Dir cop detects code with complex methods of detecting the current file path, which can be simplified by using the built in __dir__ method in Ruby.
The Style/ExpandPathArguments cop detects code with overly complex File.expand_path usage that can be simplified.
- The
ChefModernize/RespondToCompileTimecop has seen significant performance optimizations that will result in faster overall Cookstyle runtimes.
The ChefDeprecations/ChefShellout cop detects the use of the Chef::ShellOut class, which was removed in Chef Infra Client 13. It will autocorrect all occurrences to instead use Mixlib::ShellOut, which is a drop-in replacement.
Enabled by default: True
Autocorrects: Yes
The ChefDeprecations/ExecutePathProperty cop detects execute resources that use the path property, which was removed in Chef Infra Client 13. To set a path for use when executing, you should instead set the PATH via the environment property.
Enabled by default: True
Autocorrects: No
The ChefDeprecations/ExecuteRelativeCreatesWithoutCwd cop detects the usage of the execute resource with a relative path in the creates property and with no cwd property present. This condition will fail in Chef Infra Client 13 or later, and it never would have actually worked, so it was always failing code. You should either provide an absolute path to the creates property, or use a relative path with creates and specify the working directory with cwd.
Enabled by default: True
Autocorrects: No
The ChefDeprecations/WindowsPackageInstallerTypeString cop detects the usage of the windows_package resource with a installer_type property value that is a String. In Chef Infra Client 13 or later, this property value must be a Symbol.
Enabled by default: True
Autocorrects: Yes
- The
ChefDeprecations/DeprecatedPlatformMethodscop now detects the usage ofChef::Platform.set, which was removed in Chef Infra Client 13. - Several minor performance and memory usage improvements were made to speed up Cookstyle scans.
- An error was resolved that would occur when using Cookstyle with the
rubocop-astgem, version 0.4.0 or later.
RuboCop has been updated to 0.90.0, which includes a large number of improvements to the built-in RuboCop cops that Cookstyle uses.
All Cookstyle Cops have been refactored to use a more performant plugin format added in a recent release of RuboCop. With this change many cops no longer have to detect issues twice in order to autocorrect, which allows for faster autocorrection with less memory usage.
The ChefCorrectness/CookbooksDependsOnSelf cop has been moved to ChefDeprecations/CookbooksDependsOnSelf as a cookbook that depends on itself will fail with Chef Infra Client 13 or later.
RuboCop has been updated to 0.89.1 which offers significant performance and autocorrection improvements to many Ruby cops that Cookstyle utilizes.
We have enabled many new built-in RuboCop cops that we believe are also useful in correcting Chef Infra cookbooks:
The Lint/BinaryOperatorWithIdenticalOperands cop detects conditionals with duplicate checks. For example, b == 0 && b == 0 which can be simplified to just b == 0
The Lint/BinaryOperatorWithIdenticalOperands cop detects conditions with duplicate elsif checks that can be removed.
The Lint/BinaryOperatorWithIdenticalOperands cop detects duplicate rescue statements in code that can be removed.
The Lint/OutOfRangeRegexpRef detects the use of regex captures that are outside of the range of possible capture groups within a regex statement. For example, /(foo)bar/ =~ 'foobar' has a single capture so $2 is not a valid capture and will always return nil.
The Style/ArrayCoercion cop ensures a consistent method of coercing data types into Arrays. For example, this will autocorrect foo = "some_string"; [foo] into foo = "some_string"; Array(foo) and [*paths] into Array(paths) to make it more clear what is being done.
The Style/BisectedAttrAccessor cop will detect classes that include both an attr_reader and attr_writer and combine them into a single attr_accessor.
The Style/RedundantAssignment cop detects methods that assign a value to a variable immediately before returning the variable. This assignment is not necessary and increases memory usage. Instead just return the value directly.
The Style/SingleArgumentDig cop detects code that uses .dig to fetch a value from a Hash just one level deep. For example, this cop will autocorrect { key: 'value' }.dig(:key) to just { key: 'value' }[:key]
The macos_userdefaults resource prior to Chef Infra Client 16.3 would silently continue if invalid types were passed resulting in unexpected behavior. Valid values are array, bool, dict, float, int, and string. The ChefCorrectness/MacosUserdefaultsInvalidType will detect invalid types and autocorrect several common mistakes such as using integer instead of int.
Enabled by default: True
Autocorrects: Yes
The ChefDeprecations/MacosUserdefaultsGlobalProperty cop detects the usage of the global property in the macos_userdefaults resource which was deprecated in Chef Infra Client 16.3. You can now omit the domain property to set global default values instead.
Enabled by default: True
Autocorrects: Yes
ChefCorrectness/InvalidPlatformFamilyHelperwill now autocorrect offenses.ChefEffortless/CookbookUsesEnvironmmentshas been renamedChefEffortless/CookbookUsesEnvironments. Sticky MacBook keyboards are not fun.ChefStyle/FileModenow detects thefiles_modeproperty inremote_directoryresources.- Many styleguide links have been fixed to properly point to the docs in the Cookstyle repo.
The ChefCorrectness/InvalidDefaultAction cop detects resources that set the default_action to a value that is not a Symbol, Array, or variable.
Enabled by default: True
Autocorrects: Yes
Examples:
Invalid default_action:
default_action 'create'The ChefCorrectness/SupportsMustBeFloat cop detects supports metadata in the metadata.rb that specifies a platform version as an Integer and not a Float. Integer platform values will cause errors when the cookbook is uploaded to a Chef Infra Server.
Enabled by default: True
Autocorrects: Yes
Examples:
Supports using an Integer value for a platform version:
supports 'redhat', '< 8'The ChefModernize/ActionMethodInResource detects resources that define resource actions as methods instead of using the custom resource language's action :my_action syntax.
Enabled by default: True
Autocorrects: Yes
Examples:
Resource using a method to define an action:
def action_create
# :create action code here
endAutocorrected action:
action :create do
# :create action code here
endThe ChefModernize/CronDFileOrTemplate cop detects cookbooks that use cookbook_file, template, or file resources to create cron jobs in /etc/cron.d instead of using the cron_d resource included in Chef Infra Client 14 and later.
Enabled by default: True
Autocorrects: No
Examples:
Using template to create a cron.d file:
template '/etc/cron.d/backup' do
source 'cron_backup_job.erb'
owner 'root'
group 'root'
mode '644'
endUsing cron_d to create the same cron job:
cron_d 'backup' do
minute '1'
hour '1'
mailto '[email protected]'
command '/usr/local/bin/backup_script.sh'
endThe ChefRedundantCode/DoubleCompileTime cop detects resources that are set to run at compile time by using both the compile_time property and the run_action method, which do the same thing.
Enabled by default: True
Autocorrects: Yes
Examples:
Resource compile_time and run_action:
chef_gem 'deep_merge' do
action :nothing
compile_time true
end.run_action(:install)Autocorrected resource:
chef_gem 'deep_merge' do
action :install
compile_time true
endThe ChefDeprecations/ChefDKGenerators cop detects custom cookbook generators for the chef CLI that utilize the legacy ChefDK classes and not ChefCLI classes.
Enabled by default: True
Autocorrects: Yes
The ChefDeprecations/ChefHandlerRecipe cop detects cookbooks that include the deprecated chef-handler::default recipe. This recipe is empty and does not need to be included, and the chef_handler resource was merged directly into Chef Infra Client in 14.0.
Enabled by default: True
Autocorrects: Yes
The ChefDeprecations/UseAutomaticResourceName cop detects resources that use the legacy use_automatic_resource_name, which was removed in Chef Infra Client 16.
Enabled by default: True
Autocorrects: No
RuboCop has been updated to 0.88, which offers significant performance improvements to many Ruby cops that Cookstyle utilizes.
ChefModernize/ExecuteAptUpdatehas been updated to detect additional methods of executingapt-get update.
The ChefModernize/ConditionalUsingTest cop detects resources that have an only_if or not_if conditional which uses test -e /some/file or test -f /some/file to determine if a file exists. Using the test command in a conditional requires shelling out and is slower and more resource intensive than using Ruby's built-in File.exist?('/some/file') helper.
Enabled by default: True
Autocorrects: Yes
Examples:
Conditional using test:
execute 'apt-get update' do
only_if 'test -f /usr/bin/apt'
endUsing File.exist instead:
execute 'apt-get update' do
only_if { ::File.exist?('/usr/bin/apt') }
endThe ChefStyle/IncludeRecipeWithParentheses cop detects unnecessary parentheses used with the include_recipe helper.
Enabled by default: True
Autocorrects: Yes
Examples:
Parentheses with include_recipe:
include_recipe('my_recipe')Bare include_recipe:
include_recipe 'my_recipe'RuboCop has been updated to 0.87.1 which greatly expands the autocorrection capabilities of RuboCop and resolves many bugs in existing cops.
- The
ChefModernize/NodeInitPackagecop has been improved to detect additional methods of testing a node for systemd support. - The
ChefCorrectness/IncorrectLibraryInjectioncop has been improved to detect additional incorrect methods of injecting libraries helpers.
The ChefSharing/IncludeResourceExamples cop detects resources that don't include examples. The chef-resource-inspector command displays resource examples and those examples can be used to automatically generate documentation.
Enabled by default: False
Autocorrects: No
The ChefRedundantCode/MultiplePlatformChecks cop detects usage of multiple platform? or platform_family? helpers that can be simplified by passing multiple values to a single helper.
Enabled by default: True
Autocorrects: Yes
Examples:
Conditional using multiple platform? helpers:
if platform?('ubuntu') || platform?('centos')
...
endSimplified conditional using a single platform? helper:
if platform?('ubuntu', 'centos')
...
endThe ChefRedundantCode/OhaiAttributeToString cop detects cookbooks that use .to_s on node attributes from Ohai that are already String type.
Enabled by default: True
Autocorrects: Yes
- RuboCop's built-in
Migration/DepartmentNamecop now suggests running cookstyle, not rubocop, to resolve cop naming deprecations.
RuboCop has been updated to 0.86, which includes several bug fixes to prevent false positives and includes new autocorrection capabilities.
Chef Infra Client 16.2 contains additional changes to how resource names are specified in order to avoid edge cases in resource naming. When setting the name of a custom resource provides should now be used instead of resource_name. If writing cookbooks that support Chef Infra Client < 16 you'll want to use both provides and resource_name to support all releases.
To support these changes we've made several updates to existing cops. The ChefDeprecations/ResourceUsesOnlyResourceName cop has been updated to add provides in addition to resource_name instead of replacing resource_name with provides. This change ensures cookbooks continue to function on Chef Infra Client less than 16. The ChefDeprecations/ResourceWithoutNameOrProvides cop has also been renamed to ChefDeprecations/HWRPWithoutProvides and improves detection of resources without provides. Both cops now better validate the contents of existing provides calls.
RuboCop has been updated to 0.85.1, which includes several bug fixes to prevent false positives and improve autocorrection.
The ChefDeprecations/ResourceUsesOnlyResourceName cop detects custom resources / LWRPs that define a resource_name without also using provides. Starting with Chef Infra Client 16, using resource_name without also using provides will result in resource failures. Use provides to change the name of the resource instead and omit resource_name entirely if it matches the name Chef Infra Client automatically assigns based on COOKBOOKNAME_FILENAME.
Enabled by default: True
Autocorrects: Yes
The Lint/DeprecatedOpenSSLConstant cop detects an upcoming deprecation in Ruby 3.0 that impacts the usage of OpenSSL constants. This deprecation is incredibly uncommon in Chef Infra cookbooks, but we wanted to make sure that any occurrences were corrected before Ruby 3.0 ships next year.
Enabled by default: True
Autocorrects: Yes
The RuboCop engine that powers Cookstyle has been upgraded from 0.83 to 0.85. This new release resolves several issues that impacted detection and correction of code in cookbooks.
- The
Naming/AccessorMethodNamecop has been disabled. This cop did not significantly improve cookbook code and could not be autocorrected. - The
ChefModernize/IncludingMixinShelloutInResourcescop now detects and corrects occurrences in legacy HWRP resources.
The ChefCorrectness/LazyEvalNodeAttributeDefaults cop detects custom resource properties using node attribute default values without wrapping those attributes with the lazy method. The lazy helper method ensures that node data is available at the time of resource execution.
Enabled by default: True
Autocorrects: Yes
The ChefCorrectness/OpenSSLPasswordHelpers cop detects the usage of the legacy Opscode::OpenSSL::Password class from the openssl cookbook. This class included a secure_password helper method that would generate a random password for use when a data bag or attribute was not present. The practice of generating passwords to be stored on the node is bad security practice as it exposes the password to anyone that can view the nodes, and deleting a node deletes the password. Passwords should be retrieved from a secure source for use in cookbooks.
Enabled by default: True
Autocorrects: No
The ChefCorrectness/InvalidPlatformFamilyInCase cop detects cookbooks that use case node['platform_family'] with an incorrect platform family name.
Enabled by default: True
Autocorrects: Yes
The ChefCorrectness/InvalidPlatformInCase cop detects cookbooks that use case node['platform'] with an incorrect platform name.
Enabled by default: True
Autocorrects: Yes
- The
ChefModernize/UseMultipackageInstallshas been updated to detect additional forms of creating multiple package resources from an Array of package names. - The
ChefDeprecations/IncludingXMLRubyRecipeautocorrect has been updated to remove any inline conditionals. - Added
oracleas an invalid platform family for cops validating platform families. - All cops now include links to documentation that can be enabled by running Cookstyle with the
--display-style-guidecommand line flag.
The ChefModernize/ShellOutHelper cop detects cookbooks that use Mixlib::ShellOut.new('foo').run_command instead of the shell_out('foo') helper included in Chef Infra Client 12.11 and later.
Enabled by default: True
Autocorrects: Yes
The ChefDeprecations/Ruby27KeywordArgumentWarnings cop detects cookbooks that use the shell_out helper with shellout options within hash braces. Using braces in this helper will result in Ruby 2.7 deprecation warnings when running on Chef Infra Client 16 and later.
With braces:
shell_out!('hostnamectl status', { returns: [0, 1] })Without braces:
shell_out!('hostnamectl status', returns: [0, 1])Enabled by default: True
Autocorrects: Yes
- The
ChefDeprecations/DeprecatedChefSpecPlatformcop has been updated to detect and correct additional legacy platform releases in ChefSpecs.
The RuboCop engine that powers Cookstyle has been upgraded from 0.82 to 0.83. This new release resolves several issues that impacted detection and correction of code in cookbooks. The release also includes expanded autocorrection functionality, making it easier to fix your codebase without manual work.
- ChefModernize/FoodcriticComments is now enabled by default.
- ChefDeprecations/UserDeprecatedSupportsProperty now autocorrects invalid supports property values containing methods instead of hash keys.
- Files in
vendorandfilesdirectories will now be ignored even if running Cookstyle against a larger repository of cookbooks.
The ChefModernize/RespondToCompileTime cop detects gating usage of the compile_time property in the chef_gem resource with if respond_to?(:compile_time). The compile_time property was added in Chef Infra Client 12.1 and can safely be used without checking first.
Enabled by default: True
Autocorrects: Yes
The ChefDeprecations/DeprecatedShelloutMethods cop detects deprecated shell_out helper methods that were removed in Chef Infra Client 15. These helpers were not widely used and were never publicly documented, but they are still occasionally found in cookbooks.
Enabled by default: True
Autocorrects: No
The RuboCop engine that powers Cookstyle has been updated from 0.81.0 to 0.82.0. This update includes several important bug fixes that impacted cookbooks.
- The
ChefModernize/RespondToProvidescop now detects additional ways of gating the usage of theprovidesmethod in resources. - The
TargetRubyVersionconfiguration has been set back to Ruby 2.4 as support for Ruby 2.3 has been removed from RuboCop.
The ChefRedundantCode/UseCreateIfMissing cop detects file, cookbook_file, template, and remote_file resources that contain a not_if conditional check used to check that the file they manage is already present on disk. These complex conditionals can be removed by changing the action from :create to :create_if_missing.
Overly complex conditional check:
file '/etc/some/config' do
content 'value = true'
not_if { ::File.exist?('/etc/some/config') }
end:create_if_missing action usage:
file '/etc/some/config' do
content 'value = true'
action :create_if_missing
endEnabled by default: True
Autocorrects: Yes
The ChefStyle/NegatingOnlyIf cop detects resources that use an only_if to run Ruby code that is then negated using Ruby's logical NOT operator (!). This conditional will be autocorrected to use not_if without the operator instead.
only_if with negated ruby:
package 'legacy-sysv-deps' do
only_if { !is_something_true? }
endnot_if without the negated ruby:
package 'legacy-sysv-deps' do
not_if { is_something_true? }
endEnabled by default: True
Autocorrects: Yes
The RuboCop engine that powers Cookstyle has been updated from 0.80.1 to 0.81.0 which includes a large number of fixes for bugs encountered during cookbook testing. This release also includes support for new Ruby syntax, introduced in Ruby 2.7, which will ship in Chef Infra Client 16.
- The
ChefCorrectness/IncorrectLibraryInjectionno longer incorrectly autocorrects libraries that send to theChef::DSL::Resourceclass. TargetChefVersionsupport in the .rubocop.yml config has been added to five of theChefDeprecationcops. This will make it easier to move from legacy versions of Chef Infra Client without jumping right to the latest releases.ChefModernize/WhyRunSupportedTruenow detects a common typo form of the whyrun_supported? method
The ChefModernize/NodeRolesInclude cop detects cookbooks that use node['roles'].include?('foo') to see if a particular role has been applied to a node. Use the simpler node.role?('foo') helper instead.
Enabled by default: True
Autocorrects: Yes
The ChefDeprecations/PowershellCookbookHelpers cop detects cookbooks that use the deprecated Powershell::VersionHelper.powershell_version? helper from the powershell cookbook. Chef Infra Client provides information on the installed PowerShell release at node['powershell']['version'] and Chef Infra Client 15.8 and later includes a new powershell_version method which should be used when possible.
Enabled by default: True
Autocorrects: Yes
The ChefCorrectness/ConditionalRubyShellout cop detects resources that use unnecessary Ruby code in not_if and only_if conditionals to shellout when a string can be used to avoid additional complexity.
Shelling out with ruby:
cookbook_file '/logs/foo/error.log' do
only_if { system('wget https://www.bar.com/foobar.txt -O /dev/null') }
endShelling out without Ruby:
cookbook_file '/logs/foo/error.log' do
only_if 'wget https://www.bar.com/foobar.txt -O /dev/null'
endEnabled by default: True
Autocorrects: Yes
The ChefSharing/IncludePropertyDescriptions cop detects resource properties that don't include a description value. The chef-resource-inspector command displays the description value in resource properties and that description can be used to automatically generate documentation.
Enabled by default: False
Autocorrects: No
The ChefSharing/IncludeResourceDescriptions cop detects resources that don't include a description. The chef-resource-inspector command displays the description value in resources and that description can be used to automatically generate documentation.
Enabled by default: False
Autocorrects: No
ChefModernize/PowershellInstallWindowsFeaturenow correctly identifies the required Chef Infra Client release as 14.0 and later.- The
WindowsVersionHelpercop has been moved to theChefDeprecationsdepartment and now includes autocorrection for each of the helpers it identifies.
The RuboCop engine that powers Cookstyle has been updated from 0.75.1 to 0.80.1. This new engine includes hundreds of bug fixes and new features that will allow us to write even more advanced Cookstyle rules in the future. This release also renames many of RuboCop's built-in cops so if you have a complex rubocop.yml file that disables or enables rules, you may see warnings instructing you to update your config.
All ChefDeprecation department cops now alert at Warning level instead of Refactor. This means that these cops will now result in Cookstyle exiting with a -1 exit code, which will cause failures in CI tests. ChefDeprecation cops are important to resolve and we believe this will the use of the latest Chef Infra coding standards.
The ChefDeprecations/DeprecatedWindowsVersionCheck cop detects cookbooks that use the legacy older_than_win_2012_or_8? helper method. Chef Infra Client no longer supports Windows releases before 8 / 2012. Those releases are end of life so this check can be removed from cookbooks.
The ChefDeprecations/ChefWindowsPlatformHelper cop detects cookbooks that use the deprecated helper Chef::Platform.windows? to see if a system is running on Windows instead of using platform?('windows') or the new windows? helper.
The ChefDeprecations/LogResourceNotifications cop detects notifications in the log resource. Beginning in Chef Infra Client 16, the log resource will no longer trigger an update, so these notifications will never fire. This will create problems for users who concatenate notifications from multiple resources into a single log resource so that those notifications only fire a single time. For example, many resource updates in your cookbook may require a service to restart, but a user may only want to trigger that service to restart once. Chef Infra Client 15.8 and later ships with a notify_group resource specifically for aggregating notifications in this way. This resource should be used instead.
template '/etc/foo' do
source 'bar.erb'
notifies :write, 'log[Aggregate notifications using a single log resource]', :immediately
end
log 'Aggregate notifications using a single log resource' do
notifies :restart, 'service[foo]', :delayed
endtemplate '/etc/foo' do
source 'bar.erb'
notifies :run, 'notify_group[Aggregate notifications using a single notify_group resource]', :immediately
end
notify_group 'Aggregate notifications using a single notify_group resource' do
notifies :restart, 'service[foo]', :delayed
endThe ChefDeprecations/ResourceWithoutNameOrProvides cop checks for legacy HWRP-style resources that do not set either resource_name or provides. These attributes are required by Chef Infra Client 16 and later.
The ChefCorrectness/ChefApplicationFatal cop detects cookbooks that use Chef::Application.fatal! to raise a failure during a Chef Infra Client run. When an error needs to be presented to a user, raise should be used instead as it provides the full stack trace to make debugging significantly easier.
The ChefCorrectness/PowershellScriptDeleteFile cop detects using a powershell_script resource to delete a file. This should be accomplished by using the file resource with the :delete action instead. The file resource offers a simpler syntax and full idempotency.
The ChefModernize/UseMultipackageInstalls cop detects cookbooks that use Ruby loops to install multiple packages using multiple package resources. When using a package provider that supports multi-package installs you can pass an array of packages to install to a single package resource. Passing multiple packages to a single package resource greatly simplifies the log output and is significantly faster. Multi-package installs are available for package installs using apt, dnf, yum, snap, dpkg, deb, and Chocolatey package management systems.
The ChefModernize/ProvidesFromInitialize cop detects legacy HWRP-style resources that set the provides name in an initialize method instead of using the provides method in the resource DSL.
The ChefModernize/DatabagHelpers cop detects cookbooks that load data bags with Chef::DataBagItem.load or Chef::EncryptedDataBagItem.load instead of the simpler data_bag_item helper.
ChefStyle/UnnecessaryOSCheckis now enabled by default. This was disabled by mistake previously.Lint/SendWithMixinArgumentis now enabled by default. This code simplifies how libraries are included in recipes and resources.Naming/PredicateNameis no longer enabled by default. The naming of methods and names doesn't impact the execution of the code, and without autocorrection any warnings required significant effort to resolve.Style/MultilineWhenThenis now enabled by default. This cop simplifies case statements.Style/HashEachMethodis now enabled by default. This cop detects and autocorrects overly complex code against hashes that can be simplified.ChefRedundant/UnnecessaryNamePropertynow detects unnecessary :Name attributes as well as properties.ChefModernize/DefaultActionFromInitializehas been improved to detect more forms of default actions set in initializers.ChefCorrectness/DnfPackageAllowDowngradesnow supports autocorrection.ChefModernize/WindowsRegistryUACnow detects additional registry key forms used to set UAC settings.ChefModernize/PowerShellGuardInterpreternow also detects if the PowerShell guard is set inbatchresources
The ChefModernize/NodeInitPackage cop detects cookbooks that detect the systemd init system by parsing the content of /proc/1/comm. Chef Infra Client 12.0 and later include a node['init_package'] attribute, which should be used instead.
The ChefDeprecations/WindowsFeatureServermanagercmd cop detects windows_feature resources that set the install_method property to :servermanagercmd. The windows_feature resource no longer supports the legacy Server Manager command in Windows. Use :windows_feature_dism or :windows_feature_powershell instead.
The ChefModernize/WindowsRegistryUAC resource detects the usage of the registry_key resource to set values in the HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows\CurrentVersion\Policies\System key in order to control UAC behavior in Windows. Chef Infra Client 15.0+ ships with a windows_uac resource that should be used instead.
The ChefModernize/UseRequireRelative cop detects cookbooks that use overly complex require statements with File.expand_path and __FILE__. These can be simplified by using require_relative instead.
- Updated
ChefStyle/TrueClassFalseClassResourcePropertiesto no longer detectTrueClass/FalseClassin resource attributes where these are required. - Updated
ChefModernize/ExecuteAptUpdateto detect additional execute resources runningapt-get updateas well as resources notifying one of these execute resources. - Disabled RuboCop's
Naming/MethodNameandNaming/VariableNamecops since these can't be autocorrected and don't impact Chef Infra Client.
The ChefStyle/UnnecessaryOSCheck cop checks cookbooks that use node['os'] to check the operating system of a node, when they could instead use the platform_family?() helper. All values of os from Ohai match one-to-one with platform_family values, except for linux which has no single equivalent platform_family.
The ChefModernize/SimplifyAptPpaSetup cop detects apt_repository resources that setup Ubuntu PPAs by using their full URL. For example, http://ppa.launchpad.net/webupd8team/atom/ubuntu can be simplified to just ppa:webupd8team/atom.
The ChefRedundantCode/StringPropertyWithNilDefault cop detects String type resource properties that set their default value to nil. All String type properties default to nil so this does not need to be set.
The ChefRedundantCode/PropertySplatRegex cop detects String type resource properties that validate their input with a regex of /.*/. This regex will match on any String value and is not necessary.
ChefDeprecations/IncludingYumDNFCompatRecipewill now remove any inline conditionals around theinclude_recipestatement during autocorrection so that it does not leave behind invalid Ruby.ChefDeprecations/WindowsTaskChangeActionwill no longer fail when the action value is not a String type value.ChefSharing/InvalidLicenseStringwill not autocorrectapache v2toApache-2.0.Layout/EndAlignmentandLayout/DefEndAlignmentnow have autocorrection enabled to eliminate the need for manually fixing indentation in cookbooks.ChefStyle/UsePlatformHelpersnow detects and autocorrectsnode['platform'].eql?()usage.Style/ModuleFunctioncop has been disabled because this caused library helpers to fail to load.- All metadata cops now properly autocorrect legacy metadata that included HEREDOCs.
- The
TargetRubyVersionis now set to 2.3 to match the version of Ruby that shipped in Chef Infra Client 12. This config value is used to enable/disable cops and autocorrection that may break Ruby code in these older Chef Infra Client releases. If you are on a later release of Chef Infra Client, you can set this value to Ruby 2.6 to enable additional cops and autocorrection.
The ChefDeprecations/DeprecatedChefSpecPlatform cop detects platforms in ChefSpec tests that have been deprecated in the Fauxhai / ChefSpec projects. Specifying deprecated platforms will create errors in ChefSpec because the mock Ohai data cannot be loaded to emulate a full Chef Infra Client run.
Platforms are deprecated from the Fauxhai project from time to time to prevent the Fauxhai package size from becoming too large. To avoid specifying deprecated platforms, use the newer platform matching functionality in ChefSpec. Previously you needed to specify the exact platform release when writing specs, but now ChefSpec will load the latest version if you skip the version number, or you can provide the major release and let ChefSpec do the rest.
Examples
ChefSpec calling a deprecated release of Debian 8:
let(:chef_run) { ChefSpec::ServerRunner.new(platform: 'debian', version: '8.2') }ChefSpec calling the latest minor version of Debian 8 instead:
let(:chef_run) { ChefSpec::ServerRunner.new(platform: 'debian', version: '8') }ChefSpec calling using the latest major.minor version of Debian instead:
let(:chef_run) { ChefSpec::ServerRunner.new(platform: 'debian') }- The
ChefModernize/ExecuteSysctlcop will now detectexecuteresources that call sysctl using the full path to the binary. - The
ChefModernize/LibarchiveFileResourceresource will now replace thelibarchive_fileresource with Chef Infra Client's built-inarchive_fileresource. - The
ChefStyle/UnnecessaryPlatformCaseStatementcop will no longer attempt to autocorrect empty case statements.
The ChefRedundantCode/GroupingMetadata cop removes the legacy grouping metadata from the metadata.rb file. This metadata was never consumed by any Chef Infra services and does not need to be defined.
The ChefStyle/OverlyComplexSupportsDependsMetadata cop cleans up overly complex methods of declaring supports or depends metadata via an array. This rule will detect and correct the array or each form of declaring this metadata when there are fewer than three items.
Overly complex metadata:
%w(windows apt).each do |cb|
depends cb
endSimpler form:
depends 'apt'
depends 'windows'- Various cops that remove legacy code no longer leave behind empty lines when autocorrecting.
ChefRedundantCode/LongDescriptionMetadatanow properly autocorrects whenlong_descriptionuses a here document (heredoc).ChefDeprecations/UserDeprecatedSupportsPropertyno longer fails to autocorrect when the supports hash uses Ruby 1.8 hash rocket syntax.ChefStyle/FileModenow autocorrects file modes using single quotes instead of double quotes.ChefSharing/InvalidLicenseStringnow autocorrectsUNLICENSEDtoall rights reserved.ChefModernize/AllowedActionsFromInitializeno longer alerts when appending into an existing@allowed_actionsvariable.
The ChefModernize/ResourceForcingCompileTime cop detects hostname, build_essential, chef_gem, and ohai_hint resources that are being set to run at compile-time by forcing an action on the resource block. These resources include compile-time properties which should be set to force the resources to run at compile-time.
The ChefModernize/ExecuteSysctl detects the usage of execute to load sysctl values. Chef Infra Client 14.0+ includes the sysctl resource which should be used to idempotently add or remove sysctl values without the need for chaining file and execute resources.
- The
vendorandfilesdirectories in cookbooks are now better excluded when running cookstyle against a mono-repo or other collection of multiple cookbooks. - The
ChefRedundantCode/PropertyWithRequiredAndDefaultandChefStyle/TrueClassFalseClassResourcePropertiescops now check resource attributes in addition to properties. - The
ChefRedundantCode/PropertyWithRequiredAndDefaultcop now supports autocorrection by removing unnecessary default values from the property.
The ChefModernize/DslIncludeInResource cop detects resources and providers that include either the Chef::DSL::Recipe or Chef::DSL::IncludeRecipe classes. Starting with Chef Infra Client 12.4+ this is done automatically for each resource and provider.
The ChefRedundantCode/AptRepositoryNotifiesAptUpdate cop detects apt_repository resources that notify an execute resource to run apt-get update. Updating apt cache is performed automatically when the apt_repository makes any updates to the repository config and doesn't need to be performed again afterward.
The ChefRedundantCode/AptRepositoryDistributionDefault cop detects apt_repository resources that set the distribution property to node['lsb']['codename'] which is the default and does not need to be set in cookbook code.
- The
ChefModernize/IncludingMixinShelloutInResourcescop now also detects resources that requirechef/mixin/powershell_outor includeChef::Mixin::PowershellOutas these are both performed by default in Chef Infra Client 12.4+ - The
ChefCorrectness/InvalidPlatformMetadatanow analyzessupportmetadata that is defined with an array and a loop inmetadata.rb
Cookstyle now includes a new top-level configuration option TargetChefVersion. This new configuration option works similarly to RuboCop's TargetRubyVersion config option and allows you to specify a Chef Infra version that you want to target in your Cookstyle analysis. This prevents Cookstyle from autocorrecting cookbook code in a way that would make your cookbook incompatible with your desired Chef Infra Client version. It also makes it easier to perform staged upgrades of the Chef Infra Client by allowing you to step the TargetChefVersion one major version at a time.
Example .rubocop.yml config specifying a TargetChefVersion of 14.0:
AllCops:
TargetChefVersion: 14.0The ChefStyle/UnnecessaryPlatformCaseStatement cop detects a case statement against the value node['platform'] or node['platform_family'] that includes just a single when condition. Instead of using a case statement in this scenario the simpler platform? or platform_family? helpers should be used. Additionally, if this cop detects a when condition that has just a single line, it will autocorrect the case statement to be an inline conditional. See the examples below for a sample:
Enabled by default: True
Autocorrects: Yes
Single condition case statement:
case node['platform']
when 'ubuntu'
log "We're on Ubuntu"
apt_update
endAutocorrected code:
include_recipe 'yum' if platform_family?('rhel)
endSingle condition case statement with a single line:
if platform?('ubuntu')
log "We're on Ubuntu"
apt_update
endAutocorrected code:
include_recipe 'yum' if platform_family?('rhel)
endThe ChefStyle/ImmediateNotificationTiming cop detects the usage of the :immediate notification timing instead of :immediately. The two values result in the same notification, but :immediately is the documented form and should be used for consistency.
Enabled by default: True
Autocorrects: Yes
The ChefStyle/TrueClassFalseClassResourceProperties cop detects resources that set the allowed types to TrueClass and FalseClass instead of the simpler true and false. TrueClass and FalseClass are technically the correct value as they are Ruby types, but we believe using true and false here is significantly simpler for those reading and writing resources.
Enabled by default: True
Autocorrects: Yes
The ChefCorrectness/InvalidNotificationTiming cop will detect a resource that notifies with timing other than :before, :immediate, :immediately, or :delayed.
Enabled by default: True
Autocorrects: No
The ChefCorrectness/MalformedPlatformValueForPlatformHelper detects incorrect usage of the value_for_platform() helper. The value_for_platform() helper requires that additional information is passed that is not required by the value_for_platform_family() helper. These two formats are often confused. The value_for_platform() helper takes a hash of platforms where each platform has a hash of potential platform values or a default key. This cop detects if a hash of platforms is passed incorrectly or if a hash of platform versions or a default value is not included.
Enabled by default: True
Autocorrects: No
Helper usage without the platform version hash
value_for_platform(
%w(redhat oracle) => 'baz'
)Helper usage with the platform version hash
value_for_platform(
%w(redhat oracle) => {
'5' => 'foo',
'6' => 'bar',
'default' => 'baz',
}
)The ChefCorrectness/DnfPackageAllowDowngrades cop detects the usage of the dnf_package resource with the unsupported allow_downgrades property set.
Enabled by default: True
Autocorrects: No
The ChefRedundantCode/RubyBlockCreateAction cop detects ruby_block resources that use the legacy :create action instead of the newer :run action.
Enabled by default: True
Autocorrects: Yes
The ChefDeprecations/DeprecatedPlatformMethods cop detects the usage of the legacy Chef::Platform methods provider_for_resource, find_provider, and find_provider_for_node, which were removed in Chef Infra Client 13.
Enabled by default: True
Autocorrects: No
Legacy Chef::Platform methods
resource = Chef::Resource::File.new("/tmp/foo.xyz", run_context)
provider = Chef::Platform.provider_for_resource(resource, :create)
resource = Chef::Resource::File.new("/tmp/foo.xyz", run_context)
provider = Chef::Platform.find_provider("ubuntu", "16.04", resource)
resource = Chef::Resource::File.new("/tmp/foo.xyz", run_context)
provider = Chef::Platform.find_provider_for_node(node, resource)The ChefRedundantCode/SensitivePropertyInResource cop detects resources that default a sensitive property with a default value of false. Chef Infra defines this same property/default combination on all resources, so this code is not necessary.
Enabled by default: True
Autocorrects: Yes
The ChefRedundantCode/UnnecessaryDesiredState cop detects resources that set desired_state: true on a property. desired_state: true is the default for all properties and does not need to be specified.
Enabled by default: True
Autocorrects: Yes
The ChefModernize/FoodcriticComments cop will remove any # ~FCXXX code comments in your cookbook. These comments were used to disable Foodcritic rules from alerting and are no longer necessary if you rely on Cookstyle for all cookbook linting. This cop is currently disabled by default, but will be enabled by default at a future date.
Enabled by default: False
Autocorrects: Yes
The ChefModernize/ExecuteScExe resource detects cookbooks that use the execute resource to run sc.exe to manage Windows services. Since Chef Infra Client 14.0, the windows_service resource has included the :create, :delete, and :configure actions for idempotently managing services.
Enabled by default: False
Autocorrects: No
The ChefModernize/ExecuteScExe resource detects cookbooks that use the sc_windows resource from the sc cookbook to manage Windows services. Since Chef Infra Client 14.0, the windows_service resource has included the :create, :delete, and :configure actions that manage services without the need for additional dependencies.
Enabled by default: False
Autocorrects: No
The ChefModernize/ExecuteSleep cop detects cookbooks that use either execute or bash resources to run the sleep command. Chef Infra Client 15.5 and later include the chef_sleep resource which should be used to sleep during the Chef Infra Client run without the need for shelling out.
Enabled by default: False
Autocorrects: No
- The list of files that Cookstyle checks for offenses has been updated to improve the time it takes to scan a large repository.
- The
ChefCorrectness/NotifiesActionNotSymbol,ChefCorrectness/ScopedFileExist, andChefDeprecations/LegacyNotifySyntaxcops will now also check subscriptions in resources. - The
match_property_in_resource?helper now accepts an array of properties to return from a resource. - The
ChefDeprecations/NamePropertyWithDefaultValuecop now autocorrects offenses by removing the unuseddefaultvalue. - All existing cops that checked properties within resources have been updated to also check
attributesin LWRP style resources. - The
ChefStyle/UsePlatformHelperscop now detects and autocorrects platform checks in the form of%w(rhel suse).include?(node['platform_family'])or%w(ubuntu amazon).include?(node['platform'])
Cookstyle 5.15 adds two new Chef cop departments and moves a large number of existing cops into more appropriate departments. Our goal is to have clearly defined cop departments that can be enabled or disabled to detect particular conditions in your cookbooks. Cops in the new ChefSharing department are focused around sharing cookbooks internally or on the public Supermarket. This includes things like ensuring proper license strings and complete metadata. Cops in the ChefRedundantCode category detect and correct unnecessary cookbook code. Anything detected by ChefRedundantCode cops can be removed regardless of the Chef Infra Client release you run in your infrastructure, so these are always safe to run.
With the addition of these new departments, we've moved many cops out of the ChefCorrectness department. Going forward only cops that detect code that may fail a Chef Infra Client run or cause it to behave incorrectly will be included in this category. We hope that ChefCorrectness along with ChefDeprecations are used in most cookbook CI pipelines.
- ChefModernize/CustomResourceWithAllowedActions -> ChefRedundantCode/CustomResourceWithAllowedActions
- ChefCorrectness/InsecureCookbookURL -> ChefSharing/InsecureCookbookURL
- ChefCorrectness/InvalidLicenseString -> ChefSharing/InvalidLicenseString
- ChefCorrectness/DefaultMetadataMaintainer -> ChefSharing/DefaultMetadataMaintainer
- ChefCorrectness/EmptyMetadataField -> ChefSharing/EmptyMetadataField
- ChefCorrectness/PropertyWithRequiredAndDefault -> ChefRedundantCode/PropertyWithRequiredAndDefault
- ChefCorrectness/NamePropertyIsRequired -> ChefRedundantCode/NamePropertyIsRequired
- ChefCorrectness/UnnecessaryNameProperty -> ChefRedundantCode/UnnecessaryNameProperty
- ChefCorrectness/ResourceWithNothingAction -> ChefRedundantCode/ResourceWithNothingAction
- ChefCorrectness/IncludingOhaiDefaultRecipe -> ChefModernize/IncludingOhaiDefaultRecipe
- ChefCorrectness/PropertyWithNameAttribute -> ChefModernize/ PropertyWithNameAttribute
- ChefDeprecations/RecipeMetadata -> ChefRedundantCode/RecipeMetadata
- ChefDeprecations/LongDescriptionMetadata -> ChefRedundantCode/LongDescriptionMetadata
- ChefDeprecations/AttributeMetadata -> ChefRedundantCode/AttributeMetadata
- ChefDeprecations/ReplacesMetadata -> ChefRedundantCode/ReplacesMetadata
- ChefDeprecations/ProvidesMetadata -> ChefRedundantCode/ProvidesMetadata
- ChefDeprecations/SuggestsMetadata -> ChefRedundantCode/SuggestsMetadata
- ChefDeprecations/ConflictsMetadata -> ChefRedundantCode/ConflictsMetadata
The ChefModernize/AllowedActionsFromInitialize cop detects cookbooks that set either @allowed_actions or @actions variables in the initialize method of legacy HWRP style resources. This cop updates those resources to use the allowed_actions method instead.
Enabled by default: True
Autocorrects: Yes
The ChefCorrectness/InvalidPlatformHelper cop detects invalid platforms passed to the platform? helper.
Enabled by default: True
Autocorrects: No
The ChefCorrectness/InvalidPlatformFamilyHelper cop detects invalid platform families passed to the platform_family? helper.
Enabled by default: True
Autocorrects: No
The ChefCorrectness/ScopedFileExist cop detects when using File.exist? in a resource conditional instead of ::File.exist?.
Enabled by default: True
Autocorrects: Yes
The ChefCorrectness/InvalidPlatformValueForPlatformFamilyHelper cop detects when invalid platform families are passed to the value_for_platform_family helper.
Enabled by default: True
Autocorrects: No
The ChefCorrectness/InvalidPlatformValueForPlatformHelper cop detects when invalid platforms are passed to the value_for_platform helper.
Enabled by default: True
Autocorrects: No
- ChefModernize/LegacyBerksfileSource now detects the usage of
site :opscodein aBerksfile - ChefModernize/DefaultActionFromInitialize now detects
@default_actionin theinitializemethod - ChefCorrectness/InvalidPlatformMetadata now detects additional invalid platforms
- ChefRedundant/CustomResourceWithAllowedActions no longer incorrectly removes
actionsorallowed_actionscalls from legacy LWRP style resources
The ChefModernize/ChefGemNokogiri cop detects cookbooks that use chef_gem to install nokogiri into the Chef Infra Client's Ruby installation. The nokogiri gem is built into Chef Infra Client 12 and later so this is no longer necessary.
Enabled by default: True
Autocorrects: Yes
The ChefDeprecations/ChefRewind cop detects the usage of the deprecated chef-rewind gem and updates code to instead use the built-in edit_resource and delete_resource methods.
Enabled by default: True
Autocorrects: Yes
- The
ChefDeprecations/UsesRunCommandHelpercop has been improved to detect more cases of legacy run_command usage. - The
ChefModernize/UnnecessaryMixlibShelloutRequirecop has been improved to better describe when this change was made in Chef Infra Client.
The ChefDeprecations/LegacyNotifySyntax cop detects the legacy notification syntax in resources. The newer notification method supports notifying resources that occur later in the recipe and should be used instead.
Legacy notification syntax:
notifies :restart, resources(service: 'apache')New notification syntax:
notifies :restart, 'service[apache]'Enabled by default: True
Autocorrects: Yes
The ChefDeprecations/NodeSetWithoutLevel cop detects recipes and resources that set node attributes without specifying the precedence level required by Chef Infra Client 11 and later.
Setting node attributes without a precedence level:
node['foo']['bar'] = 1
node['foo']['bar'] << 1
node['foo']['bar'] += 1
node['foo']['bar'] -= 1Setting node attributes with a precedence level of override:
node.override['foo']['bar'] = 1
node.override['foo']['bar'] << 1
node.override['foo']['bar'] += 1
node.override['foo']['bar'] -= 1Enabled by default: True
Autocorrects: No
The ChefModernize/EmptyResourceInitializeMethod cop detects empty initialize methods in resources and providers. These methods are usually leftover from refactoring older HWRP-style resources into simpler custom resources and they can be removed.
Enabled by default: True
Autocorrects: Yes
- The JSON output formatter now exposes offenses that could be auto-corrected with a new
correctablefield in the hash. - The
ChefModernize/DefaultActionFromInitializecop will no longer insert adefault_actioninto the resource if one already exists.
The ChefModernize/UnnecessaryMixlibShelloutRequire cop detects providers or resources that include require 'mixlib/shellout. Chef Infra Client automatically includes the mixlib-shellout library so this require statement can be removed.
Enabled by default: True
Autocorrects: Yes
The ChefDeprecations/Cheffile cop will detect a Cheffile in cookbooks. librarian-chef uses this file to solve dependencies, but the librarian-chef project is no longer maintained. Users should handle dependency solving with Chef Infra Policyfiles or a Berkshelf Berksfile.
Enabled by default: True
Autocorrects: No
The ChefEffortless/Berksfile cop is an optional cop for detecting the use of Berkshelf's Berksfiles for cookbook dependency solving. This will help users identify cookbooks that still need to be migrated to Policyfiles before moving to the Effortless pattern.
Enabled by default: False
Autocorrects: No
The ChefDeprecations/NodeDeepFetch cop detects the node.deep_fetch method which been deprecated in Chef-Sugar. Chef Infra Client's built-in node.read API should be used instead.
Enabled by default: True
Autocorrects: No
The ChefModernize/IfProvidesDefaultAction cop detects the usage of legacy if defined?(default_action) Chef Infra resources. The default_action method was added to chef-client in 0.10.8, so it is no longer necessary to conditionally call that method using if defined?.
Enabled by default: True
Autocorrects: Yes
The ChefStyle/DefaultCopyrightComments cop detects cookbook copyright comment headers that still include the default NAME / ORGANIZATION information that chef generate cookbook creates. These headers should be updated with the names of the actual author or organization responsible for the cookbook.
Enabled by default: True
Autocorrects: No
The ChefModernize/ZipfileResource cop detects the usage of the zipfile resource from the zipfile cookbook. Use the archive_file resource built into Chef Infra Client 15+ instead.
Enabled by default: True
Autocorrects: No
The ChefCorrectness/ResourceWithNothingAction cop detects a resource or provider that defines its own :nothing action. There is no need to define a :nothing action in your resource as Chef Infra Client provides the :nothing action by default for every resource.
Enabled by default: True
Autocorrects: Yes
You can now use cookstyle specific comments in your cookbook code to enable or disable cops instead of the standard rubocop comments. We think that it will be easier to understand the cops that you intend to control if you use cookstyle comments. You can continue to use the existing rubocop comments, if you prefer them, since both types of comments will be honored by Cookstyle.
RuboCop comment to disable a cop:
'node.normal[:foo] # rubocop: disable ChefCorrectness/Bar'Cookstyle comment to disable a cop:
'node.normal[:foo] # cookstyle: disable ChefCorrectness/Bar'ChefStyle/UsePlatformHelpersnow detects and autocorrects the use of!=withnode['platform']andnode['platform_family']. For example,node['platform'] != 'ubuntu'will autocorrect to!platform?('ubuntu)ChefModernize/RespondToInMetadatanow detects and autocorrects the usage ofif respond_to?(:chef_version)inmetadata.rband also detects if statements are defined in additional ways.ChefDeprecations/UsesRunCommandHelpernow detects the usage of therun_command_with_systems_localehelper method.
The SearchUsesPositionalParameters cop will detect if the search helper is used with unnamed parameters. In chef-client 12+ the third and later parameters in the search helper must be named hash values. This cop will also search for and remove the legacy sort field as that functionality was removed in chef-client 12.
Legacy positional parameter usage in search:
search(:node, '*:*', 0, 1000)Modern named parameter usage in search:
search(:node, '*:*', start: 0, rows: 1000)Enabled by default: True
Autocorrects: Yes
The PartialSearchHelperUsage cop detects the partial_search helper that was introduced in Chef Client 11.x. This helper was replaced in Chef Client 12 with a built-in partial search and should be replaced with filtering using Chef Infra Client's built-in search helper.
Legacy partial_search helper usage:
partial_search(:node, 'role:web',
keys: { 'name' => [ 'name' ],
'ip' => [ 'ipaddress' ],
'kernel_version' => %w(kernel version),
})Modern search usage with filtering:
search(:node, 'role:web',
filter_result: { 'name' => [ 'name' ],
'ip' => [ 'ipaddress' ],
'kernel_version' => %w(kernel version),
})Enabled by default: True
Autocorrects: No
The PartialSearchClassUsage cop detects the legacy partial_search helper by using the Chef::PartialSearch class. Similar to the PartialSearchHelperUsage cop, this functionality should also be replaced with filtering using Chef Infra Client's built-in search helper.
Legacy Chef::PartialSearch class usage:
Chef::PartialSearch.new.search(:node, 'role:web',
keys: { 'name' => [ 'name' ],
'ip' => [ 'ipaddress' ],
'kernel_version' => %w(kernel version),
})Modern search usage with filtering:
search(:node, 'role:web',
filter_result: { 'name' => [ 'name' ],
'ip' => [ 'ipaddress' ],
'kernel_version' => %w(kernel version),
})Enabled by default: True
Autocorrects: No
The PoiseArchiveUsage cop detects the poise_archive resource in cookbooks. Chef Infra Client 15+ ships with the built-in archive_file resource which should be used instead.
Enabled by default: True
Autocorrects: No
The Definitions cop detects cookbooks that include Definitions. We highly recommend replacing legacy Definitions with Custom Resources. Definitions are not currently deprecated, but we do plan to deprecate this functionality in the future. See Converting Definitions to Custom Resources for more information on the benefits of Custom Resources and how to convert legacy Definitions.
Enabled by default: True
Autocorrects: No
The SearchForEnvironmentsOrRoles cop is an optional cop for users who are migrating to Policyfiles or the Effortless pattern. This cop detects searches that find nodes based on their roles and environments. Policyfiles replace roles and environments so these node searches will need to be updated as part of a migration.
Enabled by default: False
Autocorrects: No
- The RuboCop engine that powers Cookstyle has been upgraded from 0.72 to 0.75.1. This update includes more than 50 bug fixes that may result in new warnings during your Cookstyle runs. We have also enabled a new
Migration/DepartmentNamecop that will detect and update the names of disabled cops in cookbook code. This will prevent cop name deprecation warnings when you run Cookstyle. - The
ChefModernize/RespondToInMetadatacop will now detect the usage ofif defined?(foo)in metadata.rb as well.
The VerifyPropertyUsesFileExpansion cop detects resources using the verify property to validate file content with the legacy file variable instead of the path variable required in Chef Infra Client 13 and later.
Enabled by default: True
Autocorrects: Yes
The ResourceInheritsFromCompatResource cop detects legacy Heavy Weight Resource Providers (HWRPs) that inherit from the CompatResource class, which shipped in the legacy compat_resource cookbook. Ideally, these resources are rewritten as standard Custom Resources, but at a minimum they should inherit from the proper class: Chef::Resource.
Enabled by default: True
Autocorrects: Yes
The EOLAuditModeUsage cookbook detects the usage of the beta Audit Mode feature that was removed in Chef Infra Client 15.0. Users should instead use Chef InSpec with the audit cookbook, which offers a far more robust framework for system auditing.
Enabled by default: True
Autocorrects: No
The LegacyYumRepositoryProperties cop detects the usage of legacy properties in the yum_repository resource. These properties were renamed in the yum cookbook 3.0 and shipped in Chef Infra Client 12.14, which included the yum_repository resource.
These properties will be updated:
- url -> baseurl
- keyurl -> gpgkey
- mirrorexpire -> mirror_expire
Enabled by default: True
Autocorrects: Yes
The IncorrectLibraryInjection cop detects libraries that inject their helpers into Recipe/Resource/Provider classes directly instead of using the Chef::DSL::Recipe or Chef::DSL::Resource classes.
These calls will be updated:
- ::Chef::Recipe.send(:include, MyCookbook::Helpers) -> ::Chef::DSL::Recipe.send(:include, MyCookbook::Helpers)
- ::Chef::Provider.send(:include, MyCookbook::Helpers) -> ::Chef::DSL::Recipe.send(:include, MyCookbook::Helpers)
- ::Chef::Resource.send(:include, MyCookbook::Helpers) -> ::Chef::DSL::Resource.send(:include, MyCookbook::Helpers)
Enabled by default: True
Autocorrects: Yes
The NotifiesActionNotSymbol cop detects resources that notify another resource to converge an action, but specify the action as a string instead of a symbol.
Enabled by default: True
Autocorrects: Yes
CookbookUsesEnvironments is a disabled by default cop that helps users migrating to the Chef Infra Effortless pattern by detecting cookbooks that use Chef Infra Environments.
Enabled by default: False
Autocorrects: No
CookbookUsesPolicygroups is a disabled by default cop that helps users migrating to the Chef Infra Effortless pattern by detecting cookbooks that use Chef Infra Policy Groups.
Enabled by default: False
Autocorrects: No
CookbookUsesRoles is disabled by default cop that helps users migrating to the Chef Infra Effortless pattern by detecting cookbooks that use Chef Infra Roles.
Enabled by default: False
Autocorrects: No
The DefaultActionFromInitialize cop detects HWRPs that define a resource's default actions by setting the @actions variable within the initialize method instead of using the default_action method.
Enabled by default: Yes
Autocorrects: Yes
The ResourceNameFromInitialize cop detects HWRPs that define a resource's name by setting the @resource_name variable within the initialize method instead of using the resource_name method.
Enabled by default: Yes
Autocorrects: Yes
- The
ChefModernize/CustomResourceWithAllowedActionscop now detects unnecessaryallowed_actionsin legacy HWRPs. - The
ChefDeprecations/CookbookDependsOnPoisecop now detects thepoise-servicecookbook in addition to thepoisecookbook.
The PowerShellGuardInterpreter cop detects powershell_script resources that set the guard_interpreter property to :powershell_script. In Chef Infra Client 13 and later, :powershell_script is the default and does not need to be set.
Enabled by default: True
Autocorrects: Yes
The UsesRunCommandHelper cop detects recipes and resources that use the legacy run_command helper, which was removed in Chef Infra Client 13. Users should instead use the shell_out or shell_out! helpers, which use the mixlib-shellout Ruby gem under the hood.
Enabled by default: True
Autocorrects: No
The ChefHandlerUsesSupports cop detects handler resources that use the supports property instead of the newer type property. The supports property was removed in the chef_handler cookbook version 3.0 (June 2017) and Chef Infra Client 14.0.
Enabled by default: True
Autocorrects: Yes
- The
ChefModernize/UnnecessaryDependsChef14cop will now detect cookbook dependencies that include a version constraint.
The InvalidVersionMetadata cop detects cookbook metadata that specifies invalid cookbook versions. Chef Infra cookbook versions must be in the x.y.z format.
Enabled by default: True
Autocorrects: No
The SimplifyPlatformMajorVersionCheck cop detects overly complex code for determining the major version of a platform using the node['platform_version'] attribute. The cop will detect the following methods for selecting the major version from node['platform_version']:
node['platform_version'].split('.').first
node['platform_version'].split('.')[0]
node['platform_version'].split('.').first.to_i
node['platform_version'].split('.')[0].to_iThese will be autocorrected to node['platform_version'].to_i.
Enabled by default: True
Autocorrects: Yes
The ChefSpecCoverageReport cop detects the usage of deprecated ChefSpec Coverage report functionality in your specs. This feature has been removed from ChefSpec as coverage reports encourage cookbook authors to write ineffective specs. Instead authors should focus on testing logic instead of achieving 100% code coverage.
Enabled by default: True
Autocorrects: Yes
The ChefSpecLegacyRunner cop detects usage of the legacy ChefSpec::Runner class in ChefSpec unit tests. ChefSpec 4.1 (Oct 2014) and later require the use of either the ChefSpec::ServerRunner or ChefSpec::SoloRunner class.
Enabled by default: True
Autocorrects: Yes
The UnnecessaryNameProperty cop detects resources that define a property with the name of :Name. All Chef Infra resources automatically receive a property of :Name so there's no need to define this.
Enabled by default: True
Autocorrects: Yes
ChefDeprecations/UserDeprecatedSupportsPropertynow supports autocorrectChefDeprecations/UseInlineResourcesDefinednow detectsuse_inline_resources if respond_to?(:use_inline_resources)CustomResourceWithAllowedActionsnow detects unnecessary actions in LWRPs as well- The docs at https://github.com/chef/cookstyle/blob/main/docs/cops.md are now auto-generated on each pull request merge
The ChefDeprecations/ResourceOverridesProvidesMethod cop detects overriding the provides? method in a resource's provider. This will cause failures in Chef Infra Client 13 and later. Instead use provides :SOME_PROVIDER_NAME to register the provider.
Enabled by default: True
Autocorrects: No
The ChefDeprecations/ResourceUsesDslNameMethod cop detects resources that use the dsl_name method instead of resource_name. This will cause failures in Chef Infra Client 13 and later.
Enabled by default: True
Autocorrects: No
The ChefDeprecations/ResourceUsesUpdatedMethod cop detects resources that update resource convergence state by setting updated = true (or false). This will cause failures in Chef Infra Client 13 and later.
Enabled by default: False (high likelihood of false positives)
Autocorrects: No
The ChefDeprecations/NamePropertyWithDefaultValue cop detects resource properties that are marked as a name_property while also having a default value. This will fail in Chef Infra Client 13 or later.
Enabled by default: True
Autocorrects: No
The ChefDeprecations/ResourceUsesProviderBaseMethod cop detects the provider_base method being in a resource to specify the provider module to use. Instead, the provider should call provides to register itself, or the resource should call provider to specify the provider to use. This will cause failures in Chef Infra Client 13 and later.
Enabled by default: True
Autocorrects: No
The ChefDeprecations/WindowsTaskChangeAction cop detects the windows_task resource used with the legacy :change action. When the windows_task resource was moved into Chef Infra Client 13, the :change action was merged into the :create action. Most users set the :change action in conjunction with :create, and :change can now be removed.
Enabled by default: True
Autocorrects: Yes
The ChefDeprecations/RecipeMetadata cop detects the usage of the recipe method in metadata.rb. This method was never used by Chef Infra and it has been deprecated. User-facing documentation, such as recipe descriptions, should instead be placed in the cookbook's README.md file.
Enabled by default: True
Autocorrects: Yes
The ChefStyle/UsePlatformHelpers cop detects the usage of node['platform] == 'foo' or node['platform_family] == 'bar' and instead suggests using platform?('foo') or platform_family?('bar'). These platform helpers help simplify platform check logic, especially when checking for multiple platforms as they accept more than one platform: platform?('foo', 'bar')
Enabled by default: True
Autocorrects: Yes
The ChefModernize/CronManageResource cop detects the usage of the cron_manage resource, which was renamed to cron_access when it was included in Chef Infra Client 14.4.
Enabled by default: True
Autocorrects: Yes
The ChefModernize/UsesZypperRepo cop detects the usage of the zypper_repo resource, which was renamed to zypper_repository when it was included in Chef Infra Client 13.3.
Enabled by default: True
Autocorrects: Yes
The ChefModernize/DependsOnZypperCookbook cop detects a cookbook that depends on the zypper cookbook. Chef Infra Client 13.3 and later include the zypper_repository resource, which was previously only available in the zypper cookbook.
Enabled by default: True
Autocorrects: Yes
The ChefModernize/ExecuteTzUtil cop detects a cookbook that uses an execute resource to shell out to the tzutil.exe command. Chef Infra Client 14.6 and later ships with the timezone resource, which should be used instead of tzutil.
Enabled by default: True
Autocorrects: No
The ChefModernize/OpensslRsaKeyResource cop detects usage of the openssl_rsa_key resource, which was renamed to openssl_rsa_private_key when it shipped in Chef Infra Client 14.0.
Enabled by default: True
Autocorrects: Yes
The ChefModernize/OpensslX509Resource cop detects usage of the openssl_x509 resource, which was renamed to openssl_x509_certificate when it shipped in Chef Infra Client 14.4.
Enabled by default: True
Autocorrects: Yes
The ChefModernize/OsxConfigProfileResource cop detects usage of the osx_config_profile resource, which was renamed to osx_profile.
Enabled by default: True
Autocorrects: Yes
The ChefModernize/SysctlParamResource cop detects usage of the sysctl_param resource, which was renamed to sysctl when it shipped in Chef Infra Client 14.0.
Enabled by default: True
Autocorrects: Yes
The ChefModernize/MacOsXUserdefaults cop detects usage of the mac_os_x_userdefaults resource, which was renamed to macos_userdefaults when it was added to Chef Infra Client 14.0.
Enabled by default: True
Autocorrects: Yes
The Chef cops have been broken up into four more granular cop departments. This makes it easier to pick and choose which cops to scan for, and makes disabling groups of cops simpler. Instead of just "Chef" we now have the following departments:
ChefDeprecations: Cops that detect (and in many cases correct) deprecations that will prevent cookbooks from running on modern versions of Chef Infra Client.ChefStyle: Cops that help with the format and readability of your cookbooks.ChefModernize: Cops that help you modernize your cookbooks to better use functionality introduced in new Chef Infra Client Releases.ChefEffortless: Cops that help with the migration to the Effortless pattern. These are disabled by default.
You can run cookstyle with just a single department:
cookstyle --only ChefDeprecationsYou can also exclude a specific group from the command line:
cookstyle --except ChefStyleYou can also add the following to your .rubocop.yml config to disable a specific department:
ChefStyle:
Enabled: falseDocumentation for all Chef cops can now be found in the Cookstyle repos's docs directory
The ResourceSetsInternalProperties cop detects resources that set internal state properties used by built-in Chef Infra resources. These undocumented properties should not be set in a resource block and doing so will cause unexpected behavior when running Chef Infra Client.
Examples
Service resource setting the internal running property:
service 'foo' do
running true
action [:start, :enable]
endThe ResourceSetsNameProperty cop detects a resource block with the name property set. The name property is a special property that is derived from the name of the resource block and should not be changed with the block. Changing the name within a resource block can cause issues with reporting and notifications. If you wish to give your resources a more friendly name, consider setting a name_property, which is available in all built-in Chef Infra resources. The name_property for each resource can be found in the resource reference documentation.
Examples
Service resource incorrectly setting the name property:
service 'Start the important service' do
name 'foo'
action [:start, :enable]
endService resource correctly setting the service_name name property:
service 'Start the important service' do
service_name 'foo'
action [:start, :enable]
endEnabled by default: True
Autocorrects: No
The ResourceWithNoneAction cop detects the use of the :none action in a resource. The :none action is a common typo for the built-in :nothing action in all resources.
Examples
Service resource with the incorrect :none action:
service 'my_service' do
action [:none]
endEnabled by default: True
Autocorrects: Yes
The ChocolateyPackageUninstallAction cop detects a chocolatey_package resource that uses the :uninstall action. The uninstall action has been replaced with the :remove action and will error in Chef Infra Client 14+.
Examples
chocolatey_package incorrectly setting the :uninstall action:
chocolatey_package 'nginx' do
action :uninstall
endchocolatey_package correctly setting the :remove action:
chocolatey_package 'nginx' do
action :remove
endEnabled by default: True
Autocorrects: Yes
The LaunchdDeprecatedHashProperty cop detects the use of the deprecated hash property in the launchd resource. The hash property was renamed to plist_hash in Chef Infra Client 13 and support for the hash name was removed in Chef Infra Client 14.
Examples
launchd with the deprecated hash property:
launchd 'foo' do
hash foo: 'bar'
endlaunchd with the correct plist_hash property:
launchd 'foo' do
plist_hash foo: 'bar'
endEnabled by default: True
Autocorrects: Yes
The LocaleDeprecatedLcAllProperty cop detects the use of the lc_all property in the locale resource. The lc_all property was deprecated in Chef Infra Client 15.0 and will be removed in the 16.0 release. Setting the LC_ALL variable is NOT recommended. As a system-wide setting, LANG should provide the desired behavior. LC_ALL is intended to be used for temporarily troubleshooting issues rather than an everyday system setting. Changing LC_ALL can break Chef’s parsing of command output in unexpected ways. Use one of the more specific LC_ properties as needed.
Examples
locale resource setting the lc_all property:
locale 'set locale' do
lang 'en_gb.utf-8'
lc_all 'en_gb.utf-8'
endEnabled by default: True
Autocorrects: No
The UserDeprecatedSupportsProperty cop detects the usage of the deprecated supports property in the user resource.
Enabled by default: True
Autocorrects: No
The PowershellScriptExpandArchive op detects the usage of the powershell_script resource to run the Expand-Archive Cmdlet. The archive_file resource in Chef Infra Client 15.0 should be used instead.
Examples
powershell_script using Expand-Archive to setup a website:
powershell_script 'Expand website' do
code 'Expand-Archive "C:\\file.zip" -DestinationPath "C:\\inetpub\\wwwroot\\mysite"'
not_if { File.exist?("C:\\inetpub\\wwwroot\\mysite") }
endThe same archive handled by archive_file:
archive_file 'Expand website' do
path 'C:\file.zip'
destination 'C:\inetpub\wwwroot\mysite'
endEnabled by default: True
Autocorrects: No
The PowershellInstallPackage cop detects the usage of the powershell_script resource to run the Install-Package Cmdlet. The powershell_package resources should be used to install packages via the PowerShell Package Manager instead.
Installing Docker via powershell_script and Install-Package:
powershell_script 'Install Docker' do
code 'Install-Package -Name docker'
not_if { File.exist?("C:\\Program Files\\Docker") }
endThe same package installed with powershell_package:
powershell_package 'Install Docker' do
package_name 'Docker'
endEnabled by default: True
Autocorrects: No
The PowershellInstallWindowsFeature cop detects the usage of the powershell_script resource to run the Install-WindowsFeature or Add-WindowsFeature Cmdlets. The windows_feature resource should be used to install Windows features.
Examples
powershell_script using Install-WindowsFeature to install a feature:
powershell_script 'Install Feature' do
code 'Install-WindowsFeature -Name "Windows-Identity-Foundation"'
not_if '(Get-WindowsFeature | where {$_.Name -eq "Windows-Identity-Foundation"}).IsInstalled -eq true'
endThe same feature install with windows_feature:
windows_feature 'Windows-Identity-Foundation' do
action :install
install_method :windows_feature_powershell
endEnabled by default: True
Autocorrects: No
The CookbookUsesNodeSave cop detects the usage of node.save within a cookbook. node.save is often used to ensure a run_list is saved, or so that other state information is immediately available for search by other nodes in your environment. The use of node.save can be incredibly problematic and should be avoided as a run failure will still result in the node data being saved to the Chef Infra Server. If search is used to put nodes into production state, this may result in non-functioning nodes being used.
Enabled by default: True
Autocorrects: No
The SevenZipArchiveResource cop detects the usage of the seven_zip_archive resource from the seven_zip community cookbook. The archive_file resource built into Chef Infra Client 15.0 should be used instead to avoid the need for extra cookbook dependencies.
Examples
Expanding a zip archive with seven_zip_archive:
seven_zip_archive 'seven_zip_source' do
path 'C:\inetpub\wwwroot\mysite'
source 'C:\file.zip'
endThe same archive handled by archive_file:
archive_file 'Expand website' do
path 'C:\file.zip'
destination 'C:\inetpub\wwwroot\mysite'
endEnabled by default: True
Autocorrects: No
The LibarchiveFile cop detects the usage of the libarchive_file resource from the libarchive community cookbook. The archive_file resource built into Chef Infra Client 15.0 is based on the libarchive_file resource and it should be used instead to avoid the need for extra cookbook dependencies.
Examples
Expanding a zip archive with libarchive_file:
libarchive_file 'seven_zip_source' do
path 'C:\file.zip'
destination 'C:\inetpub\wwwroot\mysite'
endThe same archive handled by archive_file:
archive_file 'Expand website' do
path 'C:\file.zip'
destination 'C:\inetpub\wwwroot\mysite'
endEnabled by default: True
Autocorrects: No
The ShellOutToChocolatey cop detects the use of powershell_script or execute resources to shell out to Chocolatey's choco command line utility. Chef Infra Client ships with multiple chocolatey resources, which should be used instead to install packages, configure features, and setup sources:
Enabled by default: True
Autocorrects: No
The UsesChefRESTHelpers cop detects the usage of the various Chef::REST helpers, which were removed in Chef Infra Client 13.0. For communicating with the Chef Infra Server directly, you may consider using the Chef::ServerAPI helpers instead.
Enabled by default: True
Autocorrects: No
Chef/DefaultMetadataMaintainernow detects additional defaultmaintainerandmaintainer_emailfield values.Chef/UsesDeprecatedMixinsnow inspects files in the resources directory in addition to the providers and libraries directories.
The UseInlineResourcesDefined cop checks for resources that call the use_inline_resources method. Chef Infra Client 13 made the inline resources mode as the default for all resources, so this call is no longer necessary.
Enabled by default: True
Autocorrects: Yes
The IncludingOhaiDefaultRecipe cop detects cookbooks that include the ohai::default recipe. The ohai cookbook's default recipe was used to install custom Ohai plugins located in the cookbook's files directory. Since the ohai cookbook required placing plugins into the cookbook's files directory it had to be forked locally, which we no longer recommend doing. Modern versions of the Ohai cookbook provide an ohai_plugin resource, which can be used to install plugins into Chef Infra Client. Chef Infra Client will install also install Ohai plugins at runtime if they are placed in an /ohai directory in any cookbook. Note: This feature requires Chef Infra Server 12.18 or later.
Enabled by default: True
Autocorrects: No
The IncludingXMLRubyRecipe cop detects cookbooks that include the xml::ruby recipe. This recipe was used to install the nokogiri gem into Chef Infra Client for use in parsing XML in cookbooks. Nokogiri ships with Chef Infra Client 13+, so this recipe is no longer necessary.
Enabled by default: True
Autocorrects: Yes
The LegacyYumCookbookRecipes cop detects usage of legacy yum cookbook recipes. These recipes were removed from the yum cookbook in version 3.0, which was released in 2013. Cookbooks should be updated to use the new individual yum cookbooks, which contain the same functionality as the legacy recipes.
Examples
Legacy recipes:
include_recipe 'yum::epel'
include_recipe 'yum::ius'New cookbooks containing the same functionality:
include_recipe 'yum-epel'
include_recipe 'yum-ius'Enabled by default: True
Autocorrects: No
The DefaultMetadataMaintainer cop detects the default maintainer and maintainer_email fields generated by the chef generate cookbook command. Cookbook metadata should be updated with actual maintainer information.
Enabled by default: True
Autocorrects: No
The UsesDeprecatedMixins cop detects various legacy mixins used in HWRP and LWRP resources. These mixins are no longer necessary and were removed in Chef Infra Client 14. Running these legacy mixins with HWRP and LWRP resources on modern Chef Infra Client releases will cause errors.
Enabled by default: True
Autocorrects: Yes
The MinitestHandlerUsage cop detects cookbooks that depend on the minitest-handler cookbook. This cookbook provides a handler for running minitest after each Chef Infra Client run. The handler is no longer maintained and we highly recommend using InSpec for validating a system configuration after a Chef Infra Client run. InSpec includes over 100 built-in resources and integrates with Automate to report the results of a system state validation.
Enabled by default: True
Autocorrects: No
The WindowsVersionHelper cop detects the usage of the various Windows version helpers that shipped in the windows cookbook. Nearly all of the resources that originally shipped in the windows cookbook are now part of Chef Infra Client itself. We would like to help move users away from the windows cookbook so they can avoid the added dependency in their environment. Instead of using the Windows version helpers, we suggest using data from Ohai itself to determine what version of Windows is running on a node.
Examples
A cookbook using the Windows version helper:
Windows::VersionHelper.nt_version == 6.1The same version comparison could be done using Ohai attributes
node['platform_version'].to_f == 6.1Enabled by default: True
Autocorrects: No
The WindowsZipfileUsage detects the usage of the windows_zipfile resource in the Windows cookbook. This is one of the remaining resources in the windows cookbook that is not present in Chef Infra Client itself. In Chef Infra Client 15.0 we introduced the archive_file resource, which is a cross-platform resource for uncompressing archives. This resource uses an ultra-fast compression library with support for multiple compression formats, and should be used instead of the legacy windows_zipfile resource.
Enabled by default: True
Autocorrects: No
The NodeMethodsInsteadofAttributes cop detects cookbooks that reference node attributes in the legacy node.some.value format. Chef Infra Client 13 officially deprecated this attribute format. This cop detects the usage of common Ohai attributes and can autocorrect those. But it won't detect cookbook attributes which also need to be updated.
Enabled by default: True
Autocorrects: Yes
Examples
Node attributes in the method format:
node.platform
node.platform_version
node.my_cookbook.attribute1The preferred format:
node['platform']
node['platform_version']
node['my_cookbook']['attribute1']The IncludingMixinShelloutInResources cop detects resources that require and include the Chef Shellout Mixin helper. Chef Infra Client now includes the Chef Shellout Mixin helper automatically for all resources, so require and include statements can be removed from all resources.
Enabled by default: True
Autocorrects: Yes
- Multiple cops will now skip scanning metadata.rb to speed up cookstyle runs
- Chef/MetadataMissingName now supports autocorrecting. The folder containing the metadata.rb will be used as the cookbook name if it's missing from metadata.rb
- Chef/WhyRunSupportedTrue has been corrected to properly trigger on the whyrun_supported method in resources
- The files directory in cookbooks is now excluded from Cookstyle scans
The IncludingAptDefaultRecipe cop detects cookbooks that include the apt::default cookbook in order to run the apt-get update command. Users should use Chef Infra Client's built in apt_update resource instead.
Enabled by default: True
Autocorrects: No, due to potential notifications to these resources, which need to be updated.
The ExecuteAptUpdate cop detects the use of an execute resource to run the apt-get update command. Users should use Chef Infra Client's built in apt_update resource instead.
Enabled by default: True
Autocorrects: No, due to potential notifications to these resources, which need to be updated.
The IncludingWindowsDefaultRecipe detects cookbooks that include the windows::default recipe. This recipe installs gems that ship as part of Chef Infra Client 12.0+ and do not need to be installed again.
Enabled by default: True
Autocorrects: Yes
The IncludingYumDNFCompatRecipe detects cookbooks that include the yum::dnf_yum_compat recipe in order to install yum libraries on systems that use DNF as their default package manager. Chef Infra Client 12.18 and later support the native installation of packages using DNF.
Enabled by default: True
Autocorrects: Yes
The DefinesChefSpecMatchers detects cookbooks that ship ChefSpec matchers. ChefSpec 7.1 and later automatically generate ChefSpec matchers for testing resources, so these ChefSpec matchers no longer need to be shipped with cookbooks.
Enabled by default: True
Autocorrects: Yes. This may result in an empty libraries/matchers.rb file, which can then be deleted.
- Chef/InvalidLicenseString now auto-corrects
Apache v2.0toApache-2.0 - Chef/CommentFormat better handles leading spaces in comments when auto-correcting
- Testing has been expanded to include testing of auto-correct functionality
The InvalidPlatformMetadata cop detects invalid platform names in the supports metadata.rb method. It uses a hardcoded set of common typos so it can't detect all invalid platforms, but it does detect the most common mistakes found on the Supermarket.
Enabled by default: True
Autocorrects: True (deletes the occurrence)
The RespondToResourceName cop detects the usage of respond_to?(:resource_name) in resources to provide backwards compatibility. This respond_to? check is no longer necessary in Chef Infra Client 12.5+
Enabled by default: True
Autocorrects: True (deletes the if respond_to? occurrence)
The RespondToProvides cop detects the usage of respond_to?(:provides) in providers to provide backwards compatibility. This respond_to? check is no longer necessary in Chef Infra Client 12+
Enabled by default: True
Autocorrects: True (deletes the if respond_to? occurrence)
The RespondToInMetadata cop detects the usage of if respond_to?(:foo) to prevent newer metadata methods from running on Chef Infra Client versions older than 12.15. The chef-client doesn't fail when it encounters unknown metadata in Chef Infra Client versions 12.15.
Enabled by default: True
Autocorrects: True (deletes the if respond_to? occurrence)
The LongDescriptionMetadata cop detects usage of long_description in metadata.rb. Chef Infra and Supermarket never utilized the long_description metadata, but cookbooks commonly load their README.md file into the metadata. This increases the size of metadata stored on Chef Infra Server without providing a clear benefit to users.
Enabled by default: True
Autocorrects: True (deletes the occurrence)
The CookbooksDependsOnSelf cop detects a cookbook that depends on itself in metadata.rb.
Enabled by default: True
Autocorrects: True
The MetadataMissingName cop detects a missing name field in the metadata.rb. Chef Infra Client 12+ requires the name field.
Enabled by default: True
Autocorrects: False
The RequireRecipe cop detects the usage of require_recipe to include a recipe instead of include_recipe.
Enabled by default: True
Autocorrects: True
The InvalidLicenseString cop detects non-SPDX compliant license strings (or 'all rights reserved') in metadata.rb and autocorrects many common license typos.
Enabled by default: True
Autocorrects: True
The SetOrReturnInResources cop detects the usage of the set_or_return helper method in resources to create properties. Modern Chef Infra practice prefers using the property method because set_or_return lacks additional validation, reporting, and documentation functionality.
Examples
A resource property created using set_or_return:
def severity(arg = nil)
set_or_return(
:severity, arg,
:kind_of => String,
:default => nil
)
endThe same property created using the resource DSL
property :severity, StringEnabled by default: True
Autocorrects: False
The CustomResourceWithAttributes cop detects a custom resource that contains attributes. LWRPs and HWRPs contained attributes, but custom resources changed the name attribute to property to avoid confusion with traditional Chef Infra node attributes.
Enabled by default: True
Autocorrects: True (deletes the occurrence)
The CustomResourceWithAllowedActions cop detects a custom resource that uses the actions or allowed_actions methods. These methods were necessary when writing LWRPs and HWRPs, but are no longer necessary with custom resources.
Enabled by default: True
Autocorrects: True (deletes the occurrence)
- Improves the configuration file to correctly verify LWRP/HWRP files
- Enables several Chef/* cops in the config file
- Enables Chef/UseBuildEssentialResource by default
- Fixes Chef/NodeSetUnless and Chef/NodeSet to correctly autocorrect node.set in ChefSpec tests
Cookstyle 5.1 greatly expands the Chef Infra linting experience of Cookstyle with a large number of new Chef specific Cops and improved configuration default behavior.
Cookstyle now ships with 32 Chef Infra specific cops to help you update cookbooks for the latest releases of Chef Infra Client.
This release also introduces a less user impacting method of shipping new Chef cops going forward. All of the existing Chef cops are now Refactor level instead of Error, and Cookstyle has been updated to not fail builds for anything at the Refactor level by default. We'll continue to ship new Cops every month and you'll be able to autocorrect any of these new warnings without impacting any CI jobs. Every April, in our major release window, the existing cops will become Error level and any occurrences will need to be resolved or excluded.
The ConflictsMetadata cop detects the usage of the conflicts method in metadata.rb. This method was never used by Chef Infra and it has been deprecated.
Enabled by default: True
Autocorrects: True (deletes the occurrence)
The SuggestsMetadata cop detects the usage of the suggests method in metadata.rb. This method was never used by Chef Infra and it has been deprecated.
Enabled by default: True
Autocorrects: True (deletes the occurrence)
The ReplacesMetadata cop detects the usage of the replaces method in metadata.rb. This method was never used by Chef Infra and it has been deprecated.
Enabled by default: True
Autocorrects: True (deletes the occurrence)
The ProvidesMetadata cop detects the usage of the provides method in metadata.rb. This method was never used by Chef Infra and it has been deprecated.
Enabled by default: True
Autocorrects: True (deletes the occurrence)
The AttributeMetadata detects metadata that contains attribute documentation. The attribute method for documenting attributes in metadata was never used by Chef Infra itself and has been deprecated. Attributes should be documented using inline comments or in a readme.
Enabled by default: True
Autocorrects: True (deletes the occurrence)
The CookbookDependsOnCompatResource cop detects cookbooks that depend on the deprecated compat_resource cookbook. This cookbook backported custom resource functionality to early version of Chef Infra Client 12 and is no longer necessary.
Enabled by default: True
Autocorrects: True (deletes the occurrence)
The CookbookDependsOnPartialSearch cop detects cookbooks that depend on the deprecated partial_search cookbook. This cookbook was necessary on older Chef Infra Client releases, which lacked the Partial Search functionality, but this functionality is built into Chef Infra Client 13 and later.
Enabled by default: True
Autocorrects: True (deletes the occurrence)
The CookbookDependsOnPartialSearch cop detects cookbooks that depend on various resource cookbooks, which were made obsolete with the release of Chef Infra Client 14. These cookbooks no longer need to be shipped to the load or loaded and can be removed.
Examples
depends 'build-essential'
depends 'chef_handler'
depends 'chef_hostname'
depends 'dmg'
depends 'mac_os_x'
depends 'swap'
depends 'sysctl'Enabled by default: True
Autocorrects: True (deletes the occurrence)
The CookbookDependsOnPoise cop detects a cookbook that depends on the poise library. Poise is no longer maintained and cookbooks that depend on it should be refactored to use standard Custom Resource functionality.
Enabled by default: True
Autocorrects: False
The EasyInstallResource cop detects the usage of the easy_install resource, which was removed in Chef Infra Client 13. If you are using this resource you will need to find a new method of accomplishing the same functionality.
Enabled by default: True
Autocorrects: False
The ErlCallResource cop detects the usage of the erl_call resource, which was removed in Chef Infra Client 13. If you are using this resource you will need to find a new method of accomplishing the same functionality.
Enabled by default: True
Autocorrects: False
The NamePropertyIsRequired detects Custom Resource properties that are marked as both required: true and name_property: true. The name property functionality exists to provide an optional way to override the resource block name set in a recipe. Since this is an optional method, it does not make sense to mark the property as a required. If it's necessary for this property to always be passed just remove name_property: true.
Enabled by default: True
Autocorrects: False
The PropertyWithRequiredAndDefault cop detects resource properties that are set to required: true and also have a default: value set. Since these properties are required the default will never actually be used and shouldn't be set in the resource.
Example:
property :type, String, required: true, default: 'cpu'Enabled by default: True
Autocorrects: False
The PropertyWithNameAttribute cop detects a property within a custom resource that defines a name_attribute instead of a name_property.
Example:
property :command, String, name_attribute: trueEnabled by default: True
Autocorrects: True
The EpicFail cop detects usage of the legacy epic_fail method, which was aliases to ignore_failure many years ago. This method was removed in Chef Infra Client 15.
Example:
execute '/bin/command_that_fails_often' do
epic_fail true
endEnabled by default: True
Autocorrects: True
The UseBuildEssentialResource cop detects usage of the legacy default.rb recipe in the build-essential cookbook. Chef Infra Client 14 shipped with a build_essential resource, which should be used instead.
Example:
include_recipe 'build-essential'
include_recipe 'build-essential::default'Enabled by default: True
Autocorrects: True
The WhyRunSupportedTrue cop detects cookbooks that enable Why Run support within LWRPs and custom resources. Why Run support is enabled by default in Chef 13, and this configuration is no longer necessary.
Enabled by default: True
Autocorrects: True (deletes the occurrence)
The NodeNormal detects the usage of node.normal level attributes. Normal level attributes persist to the node even if the cookbook code is removed and should be avoided unless there is an absolute need for their usage. Instead consider default or override levels.
Enabled by default: True
Autocorrects: False
The NodeNormalUnless detects the usage of node.normal_unless level attributes. Normal level attributes persist to the node even if the cookbook code is removed and should be avoided unless there is an absolute need for their usage. Instead consider default_unless or override_unless levels.
Enabled by default: True
Autocorrects: False
The NodeSetUnless detects the usage of node.set_unless level attributes. The name set was unfortunate and did not correctly convey the functionality of the level. The set level of attributes was removed in Chef Infra Client 14 in favor of the normal level, which behaves the same, but has a more descriptive name. This cop will autocorrect node.set_unless to node.normal_unless
Enabled by default: True
Autocorrects: True
The LegacyBerksfileSource cop detects legacy source URLs in a Berksfile. These URLs continue to function, but often require redirects to point to the current Supermarket URL. This cop will autocorrect the URLs to supermarket.chef.io
Examples:
source 'http://community.opscode.com/api/v3'
source 'https://supermarket.getchef.com'
source 'https://api.berkshelf.com'Enabled by default: True
Autocorrects: True
The InsecureCookbookURL cop detects non-HTTP GitHub and GitLab URLs in metadata.rb's issue_url and source_url fields.
Examples:
source_url 'http://github.com/something/something'
source_url 'http://www.github.com/something/something'
source_url 'http://www.gitlab.com/something/something'
source_url 'http://gitlab.com/something/something'Enabled by default: True
Autocorrects: True
The CookbookUsesDatabags is an optional cop for users wishing to migrate to the Effortless Infra pattern. This cop detects usage of Data Bags, which are incompatible with the Effortless pattern. This cop will need to be enabled in your rubocop.yml file or it can be run on the command line using cookstyle --only Chef/CookbookUsesDatabags
Enabled by default: False
Autocorrects: False
The CookbookUsesSearch is an optional cop for users wishing to migrate to the Effortless Infra pattern. This cop detects usage of search, which is incompatible with the Effortless pattern. This cop will need to be enabled in your rubocop.yml file or it can be run on the command line using cookstyle --only Chef/CookbookUsesSearch
Enabled by default: False
Autocorrects: False