1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
|
#
# Author:: Adam Jacob (<adam@chef.io>)
# Author:: Claire McQuin (<claire@chef.io>)
# Copyright:: Copyright (c) 2008-2016 Chef Software, Inc.
# License:: Apache License, Version 2.0
#
# 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.
#
require_relative "../mixin/os"
require_relative "../mixin/command"
require_relative "../mixin/seconds_to_human"
require_relative "../hints"
require_relative "../util/file_helper"
module Ohai
# For plugin namespacing
module NamedPlugin
# Is the plugin a Symbol starting with a capital letter that has no underscores
#
# @param name [String] the plugin name
# @return [Boolean]
def self.valid_name?(name)
name.is_a?(Symbol) && name.to_s.match(/^[^A-Z]|_/).nil?
end
# @return [Boolean]
def self.strict_const_defined?(const)
const_defined?(const, false)
end
end
# @param name [String]
def self.plugin(name, &block)
raise Ohai::Exceptions::InvalidPluginName, "#{name} is not a valid plugin name. A valid plugin name is a symbol which begins with a capital letter and contains no underscores" unless NamedPlugin.valid_name?(name)
plugin = nil
# avoid already initialized constant warnings if already defined
if NamedPlugin.strict_const_defined?(name)
plugin = NamedPlugin.const_get(name)
plugin.class_eval(&block)
else
klass = Class.new(DSL::Plugin::VersionVII, &block)
plugin = NamedPlugin.const_set(name, klass)
end
plugin
end
# Cross platform /dev/null to support testability
#
# @return [String]
def self.dev_null
if RUBY_PLATFORM =~ /mswin|mingw|windows/
"NUL"
else
"/dev/null"
end
end
# Extracted abs_path to support testability:
# This method gets overridden at test time, to force the shell to check
# ohai/spec/unit/path/original/absolute/path/to/exe
def self.abs_path( abs_path )
abs_path
end
module DSL
class Plugin
include Ohai::Mixin::OS
include Ohai::Mixin::Command
include Ohai::Mixin::SecondsToHuman
include Ohai::Util::FileHelper
attr_reader :data
attr_reader :failed
attr_reader :logger
def initialize(data, logger)
@data = data
@logger = logger.with_child({ subsystem: "plugin", plugin: name })
@has_run = false
@failed = false
end
def run
@has_run = true
if Ohai.config[:disabled_plugins].include?(name)
logger.trace("Skipping disabled plugin #{name}")
else
run_plugin
end
end
def has_run?
@has_run
end
def reset!
@has_run = false
end
def [](key)
@data[key]
end
def []=(key, value)
@data[key] = value
end
def each(&block)
@data.each do |key, value|
yield(key, value)
end
end
def has_key?(name)
@data.key?(name)
end
def attribute?(name, *keys)
!safe_get_attribute(name, *keys).nil?
end
def set(name, *value)
set_attribute(name, *value)
end
def from(cmd)
_status, stdout, _stderr = run_command(command: cmd)
return "" if stdout.nil? || stdout.empty?
stdout.strip
end
# Set the value equal to the stdout of the command, plus
# run through a regex - the first piece of match data is\
# the value.
def from_with_regex(cmd, *regex_list)
regex_list.flatten.each do |regex|
_status, stdout, _stderr = run_command(command: cmd)
return "" if stdout.nil? || stdout.empty?
stdout.chomp!.strip
md = stdout.match(regex)
return md[1]
end
end
def set_attribute(name, *attrs, value)
# Initialize the path in the @data Mash with new Mashes, if needed.
# Will raise a TypeError if we hit a subattribute that is not a
# Hash, Mash, or Array.
keys = [name] + attrs
attribute = keys[0..-2].inject(@data) do |atts, key|
atts[key] ||= Mash.new
atts[key]
end
# Set the subattribute to the value.
attr_name = attrs.empty? ? name : attrs[-1]
attribute[attr_name] = value
@data[name]
end
def get_attribute(name, *keys)
safe_get_attribute(name, *keys)
end
def hint?(name)
Ohai::Hints.hint?(name)
end
# emulates the old plugin loading behavior
def safe_run
run
rescue Ohai::Exceptions::Error => e
@failed = true
raise e
rescue => e
@failed = true
logger.trace("Plugin #{name} threw #{e.inspect}")
e.backtrace.each { |line| logger.trace( line ) }
end
def method_missing(name, *args)
return get_attribute(name) if args.length == 0
set_attribute(name, *args)
end
private
def safe_get_attribute(*keys)
keys.inject(@data) do |attrs, key|
unless attrs.nil? || attrs.is_a?(Array) || attrs.is_a?(Hash)
raise TypeError.new("Expected Hash but got #{attrs.class}.")
end
attrs[key]
end
rescue NoMethodError
# NoMethodError occurs when trying to access a key on nil
nil
end
end
end
end
|
