Class: RuboCop::Cop::Chef::Modernize::ExecuteSysctl

Inherits:
Base
  • Object
show all
Extended by:
TargetChefVersion
Includes:
RuboCop::Chef::CookbookHelpers
Defined in:
lib/rubocop/cop/chef/modernize/execute_sysctl.rb

Overview

Chef Infra Client 14.0 and later includes a sysctl resource that should be used to idempotently load sysctl values instead of templating files and using execute to load them.

Examples:


### incorrect
file '/etc/sysctl.d/ipv4.conf' do
  notifies :run, 'execute[sysctl -p /etc/sysctl.d/ipv4.conf]', :immediately
  content '9000 65500'
end

execute 'sysctl -p /etc/sysctl.d/ipv4.conf' do
  action :nothing
end

### correct
sysctl 'net.ipv4.ip_local_port_range' do
  value '9000 65500'
end

Constant Summary collapse

MSG = 
'Chef Infra Client 14.0 and later includes a sysctl resource that should be used to idempotently load sysctl values instead of templating files and using execute to load them.'
RESTRICT_ON_SEND = 
[:execute].freeze

Instance Method Summary collapse

Methods included from TargetChefVersion

minimum_target_chef_version, required_minimum_chef_version, support_target_chef_version?

Methods included from RuboCop::Chef::CookbookHelpers

#match_property_in_resource?, #match_resource_type?, #method_arg_ast_to_string, #resource_block_name_if_string

Methods inherited from Base

#target_chef_version

Instance Method Details

#on_block(node) ⇒ Object

block execute resources



59
60
61
62
63
64
65
 
# File 'lib/rubocop/cop/chef/modernize/execute_sysctl.rb', line 59

def on_block(node)
  match_property_in_resource?(:execute, 'command', node) do |code_property|
    property_data = method_arg_ast_to_string(code_property)
    return unless property_data && property_data.match?(%r{^(/sbin/)?sysctl -p}i)
    add_offense(node, severity: :refactor)
  end
end

#on_send(node) ⇒ Object

non block execute resources



51
52
53
54
55
56
 
# File 'lib/rubocop/cop/chef/modernize/execute_sysctl.rb', line 51

def on_send(node)
  # use a regex on source instead of .value in case there's string interpolation which adds a complex dstr type
  # with a nested string and a begin. Source allows us to avoid a lot of defensive programming here
  return unless node&.arguments.first&.source&.match?(/^("|')sysctl -p/)
  add_offense(node, severity: :refactor)
end