Hey everyone,
It's been just 3 days, but we have a new Cookstyle release with 14 new cops and a new way to specify the version of Chef Infra Client you'd like to target in Cookstyle.
New TargetChefVersion Configuration
Cookstyle now includes a new top-level configuration option TargetChefVersion. This new configuration option works similar 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.0
14 New Cops
ChefStyle/UnnecessaryPlatformCaseStatement
The 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
end
Autocorrected code:
include_recipe 'yum' if platform_family?('rhel)
end
Single condition case statement with a single line:
if platform?('ubuntu')
log "We're on Ubuntu"
apt_update
end
Autocorrected code:
include_recipe 'yum' if platform_family?('rhel)
end
ChefStyle/ImmediateNotificationTiming
The 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
ChefStyle/TrueClassFalseClassResourceProperties
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
ChefCorrectness/InvalidNotificationTiming
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
ChefCorrectness/MalformedPlatformValueForPlatformHelper
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',
}
)
ChefCorrectness/DnfPackageAllowDowngrades
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
ChefDeprecations/RubyBlockCreateAction
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
ChefDeprecations/DeprecatedPlatformMethods
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)
ChefRedundantCode/SensitivePropertyInResource
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
ChefRedundantCode/UnnecessaryDesiredState
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
ChefModernize/FoodcriticComments
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
ChefModernize/ExecuteScExe
The ChefModernize/ExecuteScExe resource detects cookbooks that use the execute resource to run sc.exe in order 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
ChefModernize/WindowsScResource
The ChefModernize/ExecuteScExe resource detects cookbooks that use the sc_windows resource from the sc coookbook in order to manage Windows services. Since Chef Infra Client 14.0, the windows_service resource has included the :create, :delete, and :configure actions which manage services without the need for additional dependencies.
Enabled by default: False
Autocorrects: No
ChefModernize/ExecuteSleep
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
Other fixes and changes
- 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'])
Enjoy,
Tim