Skip to main content

UnnecessaryPlatformCaseStatement

All Cookstyle Cops


The department is: Chef/Style

The full name of the cop is: Chef/Style/UnnecessaryPlatformCaseStatement


Enabled by defaultSupports autocorrectionTarget Chef Version
EnabledYesAll Versions

Use the platform?() and platform_family?() helpers instead of a case statement that only includes a single when statement.

Examples

incorrect

case node['platform']
when 'ubuntu'
  log "We're on Ubuntu"
  apt_update
end

case node['platform_family']
when 'rhel'
  include_recipe 'yum'
end

correct

if platform?('ubuntu')
  log "We're on Ubuntu"
  apt_update
end

include_recipe 'yum' if platform_family?('rhel')

Configurable attributes

NameDefault valueConfigurable values
Version Added5.16.0String
Exclude
  • **/metadata.rb
  • **/Berksfile
Array

Was this page helpful?