Class: Inspec::Metadata

Inherits:
Object
  • Object
show all
Defined in:
lib/inspec/metadata.rb

Overview

The Metadata class represents a profile’s metadata. This includes the metadata stored in the profile’s metadata.rb file, as well as inferred metadata like if this profile supports the current runtime and the intended target. This class does NOT represent the runtime state of a profile during execution. See lib/inspec/profile.rb for the runtime representation of a profile.

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

Instance Method Summary collapse

Constructor Details

#initialize(ref, logger = nil) ⇒ Metadata

Returns a new instance of Metadata.



24
25
26
27
28
29
30
 
# File 'lib/inspec/metadata.rb', line 24

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 



168
169
170
171
 
# File 'lib/inspec/metadata.rb', line 168

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.



23
24
25
 
# File 'lib/inspec/metadata.rb', line 23

def content
  @content
end

#params ⇒ Object

Returns the value of attribute params.



23
24
25
 
# File 'lib/inspec/metadata.rb', line 23

def params
  @params
end

#ref ⇒ Object (readonly)

Returns the value of attribute ref.



22
23
24
 
# File 'lib/inspec/metadata.rb', line 22

def ref
  @ref
end

Class Method Details

.finalize(metadata, profile_id, options, logger = nil) ⇒ Object 



241
242
243
244
245
246
247
248
249
250
251
252
 
# File 'lib/inspec/metadata.rb', line 241

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 



219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
 
# File 'lib/inspec/metadata.rb', line 219

def self.finalize_name(metadata, profile_id, original_target)
  # profile_id always overwrites whatever already exists as the name
  unless profile_id.to_s.empty?
    metadata.params[:name] = profile_id.to_s
    return
  end

  # don't overwrite an existing name
  return unless metadata.params[:name].nil?

  # if there's a title, there is no need to set a name too
  return unless metadata.params[:title].nil?

  # create a new name based on the original target if it exists
  # Crudely slug the target to not contain slashes, to avoid breaking
  # unit tests that look for warning sequences
  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 



211
212
213
214
215
216
217
 
# File 'lib/inspec/metadata.rb', line 211

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 []
  end
end

.finalize_supports_elem(elem, logger) ⇒ Object 



188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
 
# File 'lib/inspec/metadata.rb', line 188

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
    Inspec.deprecate(
      :supports_syntax,
      "Do not use deprecated `supports: #{x}` syntax. Instead use:\n"\
        "supports:\n  - os-family: #{x}\n\n"
    )

    { :'os-family' => x } # rubocop:disable Style/HashSyntax
  end
end

.from_file(path, profile_id, logger = nil) ⇒ Object 



284
285
286
287
288
289
290
291
292
 
# File 'lib/inspec/metadata.rb', line 284

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 



269
270
271
272
273
274
275
276
277
278
279
280
281
282
 
# File 'lib/inspec/metadata.rb', line 269

def self.from_ref(ref, content, profile_id, logger = nil)
  # NOTE there doesn't have to exist an actual file, it may come from an
  # archive (i.e., content)
  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 



262
263
264
265
266
267
 
# File 'lib/inspec/metadata.rb', line 262

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 



254
255
256
257
258
259
260
 
# File 'lib/inspec/metadata.rb', line 254

def self.from_yaml(ref, content, profile_id, logger = nil)
  require "erb" unless defined?(Erb)
  res = Metadata.new(ref, logger)
  res.params = YAML.load(ERB.new(content).result)
  res.content = content
  finalize(res, profile_id, {}, logger)
end

.symbolize_keys(obj) ⇒ Object 



177
178
179
180
181
182
183
184
185
186
 
# File 'lib/inspec/metadata.rb', line 177

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 



51
52
53
 
# File 'lib/inspec/metadata.rb', line 51

def dependencies
  params[:depends] || []
end

#gem_dependencies ⇒ Object 



55
56
57
 
# File 'lib/inspec/metadata.rb', line 55

def gem_dependencies
  params[:gem_dependencies] || []
end

#inspec_requirement ⇒ Object 



65
66
67
68
69
 
# File 'lib/inspec/metadata.rb', line 65

def inspec_requirement
  # using Gem::Requirement here to allow nil values which
  # translate to [">= 0"]
  Gem::Requirement.create(params[:inspec_version])
end

#supports(sth, version = nil) ⇒ Object 



59
60
61
62
63
 
# File 'lib/inspec/metadata.rb', line 59

def supports(sth, version = nil)
  # Ignore supports with metadata.rb. This file is legacy and the way it
  # it handles `supports` deprecated. A deprecation warning will be printed
  # already.
end

#supports_platform?(backend) ⇒ Boolean

Returns:

  • (Boolean) 


76
77
78
79
 
# File 'lib/inspec/metadata.rb', line 76

def supports_platform?(backend)
  require "inspec/resources/platform" # break circularity in load
  backend.platform.supported?(params[:supports])
end

#supports_runtime? ⇒ Boolean

Returns:

  • (Boolean) 


71
72
73
74
 
# File 'lib/inspec/metadata.rb', line 71

def supports_runtime?
  running = Gem::Version.new(Inspec::VERSION)
  inspec_requirement.satisfied_by?(running)
end

#unsupported ⇒ Object 



173
174
175
 
# File 'lib/inspec/metadata.rb', line 173

def unsupported
  @missing_methods
end

#valid ⇒ Object

return all warn and errors



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
 
# File 'lib/inspec/metadata.rb', line 82

def valid # rubocop:disable Metrics/AbcSize
  errors = []
  warnings = []

  %w{name version}.each do |field|
    next unless params[field.to_sym].nil?

    errors.push("Missing profile #{field} in #{ref}")
  end

  if %r{[\/\\]} =~ params[:name]
    errors.push("The profile name (#{params[:name]}) contains a slash" \
                  " which is not permitted. Please remove all slashes from `inspec.yml`.")
  end

  # if version is set, ensure it is correct
  if !params[:version].nil? && !valid_version?(params[:version])
    errors.push("Version needs to be in SemVer format")
  end

  if params[:entitlement_id] && params[:entitlement_id].strip.empty?
    errors.push("Entitlement ID should not be blank.")
  end

  unless supports_runtime?
    warnings.push("The current inspec version #{Inspec::VERSION} cannot satisfy profile inspec_version constraint #{params[:inspec_version]}")
  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 license is set, ensure it is in SPDX format or marked as proprietary
  if !params[:license].nil? && !valid_license?(params[:license])
    warnings.push("License '#{params[:license]}' needs to be in SPDX format or marked as 'Proprietary'. See https://spdx.org/licenses/.")
  end

  # If gem_dependencies is set, it must be an array of hashes with keys name and optional version
  unless params[:gem_dependencies].nil?
    list = params[:gem_dependencies]
    if list.is_a?(Array) && list.all? { |e| e.is_a? Hash }
      list.each do |entry|
        errors.push("gem_dependencies entries must all have a 'name' field") unless entry.key?(:name)
        if entry[:version]
          orig = entry[:version]
          begin
            # Split on commas as we may have a complex dep
            orig.split(",").map { |c| Gem::Requirement.parse(c) }
          rescue Gem::Requirement::BadRequirementError
            errors.push "Unparseable gem dependency '#{orig}' for #{entry[:name]}"
          rescue Inspec::GemDependencyInstallError => e
            errors.push e.message
          end
        end
        extra = (entry.keys - %i{name version})
        unless extra.empty?
          warnings.push "Unknown gem_dependencies key(s) #{extra.join(",")} seen for entry '#{entry[:name]}'"
        end
      end
    else
      errors.push("gem_dependencies must be a List of Hashes")
    end
  end

  [errors, warnings]
end

#valid? ⇒ Boolean

returns true or false

Returns:

  • (Boolean) 


152
153
154
155
 
# File 'lib/inspec/metadata.rb', line 152

def valid?
  errors, _warnings = valid
  errors.empty? && unsupported.empty?
end

#valid_license?(value) ⇒ Boolean

Returns:

  • (Boolean) 


164
165
166
 
# File 'lib/inspec/metadata.rb', line 164

def valid_license?(value)
  value =~ /^Proprietary[,;]?\b/ || Spdx.valid_license?(value)
end

#valid_version?(value) ⇒ Boolean

Returns:

  • (Boolean) 


157
158
159
160
161
162
 
# File 'lib/inspec/metadata.rb', line 157

def valid_version?(value)
  Semverse::Version.new(value)
  true
rescue Semverse::InvalidVersionFormat
  false
end