Class: Inspec::Metadata
- Inherits:
-
Object
show all
- Defined in:
- lib/inspec/metadata.rb
Overview
Extract metadata.rb information A Metadata object may be created and finalized with invalid data. This allows the check CLI command to analyse the issues. Use valid? to determine if the metadata is coherent.
Instance Attribute Summary collapse
Class Method Summary
collapse
-
.finalize(metadata, profile_id, options, logger = nil) ⇒ Object
-
.finalize_name(metadata, profile_id, original_target) ⇒ Object
-
.finalize_supports(supports, logger) ⇒ Object
-
.finalize_supports_elem(elem, logger) ⇒ Object
-
.from_file(path, profile_id, logger = nil) ⇒ Object
-
.from_ref(ref, content, profile_id, logger = nil) ⇒ Object
-
.from_ruby(ref, content, profile_id, logger = nil) ⇒ Object
-
.from_yaml(ref, content, profile_id, logger = nil) ⇒ Object
-
.symbolize_keys(obj) ⇒ Object
Instance Method Summary
collapse
Constructor Details
#initialize(ref, logger = nil) ⇒ Metadata
Returns a new instance of Metadata.
20
21
22
23
24
25
26
|
# File 'lib/inspec/metadata.rb', line 20
def initialize(ref, logger = nil)
@ref = ref
@logger = logger || Logger.new(nil)
@content = ''
@params = {}
@missing_methods = []
end
|
Dynamic Method Handling
This class handles dynamic methods through the method_missing method
#method_missing(sth, *args) ⇒ Object
118
119
120
121
|
# File 'lib/inspec/metadata.rb', line 118
def method_missing(sth, *args)
@logger.warn "#{ref} doesn't support: #{sth} #{args}"
@missing_methods.push(sth)
end
|
Instance Attribute Details
#content ⇒ Object
Returns the value of attribute content.
19
20
21
|
# File 'lib/inspec/metadata.rb', line 19
def content
@content
end
|
#params ⇒ Object
Returns the value of attribute params.
19
20
21
|
# File 'lib/inspec/metadata.rb', line 19
def params
@params
end
|
#ref ⇒ Object
Returns the value of attribute ref.
18
19
20
|
# File 'lib/inspec/metadata.rb', line 18
def ref
@ref
end
|
Class Method Details
.finalize(metadata, profile_id, options, logger = nil) ⇒ Object
196
197
198
199
200
201
202
203
204
205
206
|
# File 'lib/inspec/metadata.rb', line 196
def self.finalize(metadata, profile_id, options, logger = nil)
return nil if metadata.nil?
param = metadata.params || {}
options ||= {}
param['version'] = param['version'].to_s unless param['version'].nil?
metadata.params = symbolize_keys(param)
metadata.params[:supports] = finalize_supports(metadata.params[:supports], logger)
finalize_name(metadata, profile_id, options[:target])
metadata
end
|
.finalize_name(metadata, profile_id, original_target) ⇒ Object
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
|
# File 'lib/inspec/metadata.rb', line 175
def self.finalize_name(metadata, profile_id, original_target)
unless profile_id.to_s.empty?
metadata.params[:name] = profile_id.to_s
return
end
return unless metadata.params[:name].nil?
return unless metadata.params[:title].nil?
return if original_target.to_s.empty?
metadata.params[:title] = "tests from #{original_target}"
metadata.params[:name] = metadata.params[:title].gsub(%r{[\\\/]}, '.')
end
|
.finalize_supports(supports, logger) ⇒ Object
160
161
162
163
164
165
166
167
168
169
170
171
172
173
|
# File 'lib/inspec/metadata.rb', line 160
def self.finalize_supports(supports, logger)
case x = supports
when Hash then [finalize_supports_elem(x, logger)]
when Array then x.map { |e| finalize_supports_elem(e, logger) }.compact
when nil then []
else
logger ||= Logger.new(nil)
logger.warn(
"Do not use deprecated `supports: #{x}` syntax. Instead use:\n"\
"supports:\n - os-family: #{x}\n\n",
)
[{ :'os-family' => x }] end
end
|
.finalize_supports_elem(elem, logger) ⇒ Object
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
|
# File 'lib/inspec/metadata.rb', line 138
def self.finalize_supports_elem(elem, logger)
case x = elem
when Hash
x[:release] = x[:release].to_s if x[:release]
x
when Array
logger.warn(
'Failed to read supports entry that is an array. Please use '\
'the `supports: {os-family: xyz}` syntax.',
)
nil
when nil then nil
else
logger ||= Logger.new(nil)
logger.warn(
"Do not use deprecated `supports: #{x}` syntax. Instead use:\n"\
"supports:\n - os-family: #{x}\n\n",
)
{ :'os-family' => x } end
end
|
.from_file(path, profile_id, logger = nil) ⇒ Object
237
238
239
240
241
242
243
244
245
|
# File 'lib/inspec/metadata.rb', line 237
def self.from_file(path, profile_id, logger = nil)
unless File.file?(path)
logger ||= Logger.new(nil)
logger.error "Can't find metadata file #{path}"
return nil
end
from_ref(File.basename(path), File.read(path), profile_id, logger)
end
|
.from_ref(ref, content, profile_id, logger = nil) ⇒ Object
222
223
224
225
226
227
228
229
230
231
232
233
234
235
|
# File 'lib/inspec/metadata.rb', line 222
def self.from_ref(ref, content, profile_id, logger = nil)
case File.basename(ref)
when 'inspec.yml'
from_yaml(ref, content, profile_id, logger)
when 'metadata.rb'
from_ruby(ref, content, profile_id, logger)
else
logger ||= Logger.new(nil)
logger.error "Don't know how to handle metadata in #{ref}"
nil
end
end
|
.from_ruby(ref, content, profile_id, logger = nil) ⇒ Object
215
216
217
218
219
220
|
# File 'lib/inspec/metadata.rb', line 215
def self.from_ruby(ref, content, profile_id, logger = nil)
res = Metadata.new(ref, logger)
res.instance_eval(content, ref, 1)
res.content = content
finalize(res, profile_id, {}, logger)
end
|
.from_yaml(ref, content, profile_id, logger = nil) ⇒ Object
208
209
210
211
212
213
|
# File 'lib/inspec/metadata.rb', line 208
def self.from_yaml(ref, content, profile_id, logger = nil)
res = Metadata.new(ref, logger)
res.params = YAML.load(content)
res.content = content
finalize(res, profile_id, {}, logger)
end
|
.symbolize_keys(obj) ⇒ Object
127
128
129
130
131
132
133
134
135
136
|
# File 'lib/inspec/metadata.rb', line 127
def self.symbolize_keys(obj)
return obj.map { |i| symbolize_keys(i) } if obj.is_a?(Array)
return obj unless obj.is_a?(Hash)
obj.each_with_object({}) do |(k, v), h|
v = symbolize_keys(v) if v.is_a?(Hash)
v = symbolize_keys(v) if v.is_a?(Array)
h[k.to_sym] = v
end
end
|
Instance Method Details
#dependencies ⇒ Object
46
47
48
|
# File 'lib/inspec/metadata.rb', line 46
def dependencies
params[:depends] || []
end
|
#inspec_requirement ⇒ Object
56
57
58
59
60
|
# File 'lib/inspec/metadata.rb', line 56
def inspec_requirement
Gem::Requirement.create(params[:inspec_version])
end
|
#supports(sth, version = nil) ⇒ Object
50
51
52
53
54
|
# File 'lib/inspec/metadata.rb', line 50
def supports(sth, version = nil)
end
|
67
68
69
|
# File 'lib/inspec/metadata.rb', line 67
def supports_platform?(backend)
backend.platform.supported?(params[:supports])
end
|
#supports_runtime? ⇒ Boolean
62
63
64
65
|
# File 'lib/inspec/metadata.rb', line 62
def supports_runtime?
running = Gem::Version.new(Inspec::VERSION)
inspec_requirement.satisfied_by?(running)
end
|
#unsupported ⇒ Object
123
124
125
|
# File 'lib/inspec/metadata.rb', line 123
def unsupported
@missing_methods
end
|
#valid ⇒ Object
return all warn and errors
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
|
# File 'lib/inspec/metadata.rb', line 72
def valid errors = []
warnings = []
%w{name version}.each do |field|
next unless params[field.to_sym].nil?
errors.push("Missing profile #{field} in #{ref}")
end
if params[:name] =~ %r{[\/\\]}
warnings.push("Your profile name (#{params[:name]}) contains a slash " \
'which will not be permitted in InSpec 2.0. Please change your profile ' \
'name in the `inspec.yml` file.')
end
if !params[:version].nil? && !valid_version?(params[:version])
errors.push('Version needs to be in SemVer format')
end
%w{title summary maintainer copyright license}.each do |field|
next unless params[field.to_sym].nil?
warnings.push("Missing profile #{field} in #{ref}")
end
if !params[:license].nil? && !Spdx.valid_license?(params[:license])
warnings.push("License '#{params[:license]}' needs to be in SPDX format. See https://spdx.org/licenses/.")
end
[errors, warnings]
end
|
#valid? ⇒ Boolean
106
107
108
109
|
# File 'lib/inspec/metadata.rb', line 106
def valid?
errors, _warnings = valid
errors.empty? && unsupported.empty?
end
|
#valid_version?(value) ⇒ Boolean
111
112
113
114
115
116
|
# File 'lib/inspec/metadata.rb', line 111
def valid_version?(value)
Semverse::Version.new(value)
true
rescue Semverse::InvalidVersionFormat
false
end
|