-
Notifications
You must be signed in to change notification settings - Fork 54
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Use node['init_package'] to detect systemd
This reduces some crazy complex code that hasn't been necessary since Chef 12.0. Signed-off-by: Tim Smith <tsmith@chef.io>
- Loading branch information
Showing
1 changed file
with
79 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,79 @@ | ||
# | ||
# Copyright:: 2020, Chef Software, Inc. | ||
# Author:: Tim Smith (<tsmith@chef.io>) | ||
# | ||
# Licensed under the Apache License, Version 2.0 (the "License"); | ||
# you may not use this file except in compliance with the License. | ||
# You may obtain a copy of the License at | ||
# | ||
# http://www.apache.org/licenses/LICENSE-2.0 | ||
# | ||
# Unless required by applicable law or agreed to in writing, software | ||
# distributed under the License is distributed on an "AS IS" BASIS, | ||
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
# See the License for the specific language governing permissions and | ||
# limitations under the License. | ||
# | ||
module RuboCop | ||
module Cop | ||
module Chef | ||
module ChefModernize | ||
# Use node['init_package'] to check for systemd instead of reading the contents of '/proc/1/comm' | ||
# | ||
# @example | ||
# | ||
# # bad | ||
# ::File.open('/proc/1/comm').gets.chomp == 'systemd' | ||
# ::File.open('/proc/1/comm').chomp == 'systemd' | ||
# File.open('/proc/1/comm').gets.chomp == 'systemd' | ||
# File.open('/proc/1/comm').chomp == 'systemd' | ||
# File.exist?('/proc/1/comm') && File.open('/proc/1/comm').chomp == 'systemd' | ||
# | ||
# IO.read('/proc/1/comm').chomp == 'systemd' | ||
# IO.read('/proc/1/comm').gets.chomp == 'systemd' | ||
# ::IO.read('/proc/1/comm').chomp == 'systemd' | ||
# ::IO.read('/proc/1/comm').gets.chomp == 'systemd' | ||
# File.exist?('/proc/1/comm') && File.open('/proc/1/comm').chomp == 'systemd' | ||
# | ||
# # good | ||
# node['init_package'] == 'systemd' | ||
# | ||
class NodeInitPackage < Cop | ||
MSG = "Use node['init_package'] to check for systemd instead of reading the contents of '/proc/1/comm'".freeze | ||
|
||
def_node_matcher :file_reads_proc_1_comm?, <<-PATTERN | ||
(send (const {(cbase) nil?} {:File :IO}) {:open :read} (str "/proc/1/comm")) | ||
PATTERN | ||
|
||
def_node_matcher :proc_1_comm_exists?, <<-PATTERN | ||
(send | ||
(const | ||
{(cbase) nil?} :File) :exist? | ||
(str "/proc/1/comm")) | ||
PATTERN | ||
|
||
def_node_matcher :compare_init_system?, <<-PATTERN | ||
(send | ||
(send {#file_reads_proc_1_comm? (send #file_reads_proc_1_comm? :gets) } :chomp) | ||
:== (str "systemd")) | ||
PATTERN | ||
|
||
def on_send(node) | ||
compare_init_system?(node) do | ||
# if there's a ::File.exist?('/proc/1/comm') check first we want to match that as well | ||
node = node.parent if node.parent&.and_type? && proc_1_comm_exists?(node.parent.conditions.first) | ||
|
||
add_offense(node, location: :expression, message: MSG, severity: :refactor) | ||
end | ||
end | ||
|
||
def autocorrect(node) | ||
lambda do |corrector| | ||
corrector.replace(node.loc.expression, "node['init_package'] == 'systemd'") | ||
end | ||
end | ||
end | ||
end | ||
end | ||
end | ||
end |