Class: Inspec::Profile

Inherits:
Object
  • Object
show all
Extended by:
Forwardable
Defined in:
lib/inspec/profile.rb

Overview

rubocop:disable Metrics/ClassLength

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(source_reader, options = {}) ⇒ Profile

rubocop:disable Metrics/AbcSize



54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
 
# File 'lib/inspec/profile.rb', line 54

def initialize(source_reader, options = {})
  @target = options.delete(:target)
  @logger = options[:logger] || Logger.new(nil)
  @locked_dependencies = options[:dependencies]
  @controls = options[:controls] || []
  @writable = options[:writable] || false
  @profile_id = options[:id]
  @cache = options[:cache] || Cache.new
  @backend = options[:backend] || Inspec::Backend.create(options)
  @attr_values = options[:attributes]
  @source_reader = source_reader
  @tests_collected = false
  @libraries_loaded = false
  Metadata.finalize(@source_reader.metadata, @profile_id)
  @runner_context =
    options[:profile_context] ||
    Inspec::ProfileContext.for_profile(self, @backend, @attr_values)
end

Instance Attribute Details

#backend ⇒ Object (readonly)

Returns the value of attribute backend.



48
49
50
 
# File 'lib/inspec/profile.rb', line 48

def backend
  @backend
end

#runner_context ⇒ Object (readonly)

Returns the value of attribute runner_context.



48
49
50
 
# File 'lib/inspec/profile.rb', line 48

def runner_context
  @runner_context
end

#source_reader ⇒ Object (readonly)

Returns the value of attribute source_reader.



48
49
50
 
# File 'lib/inspec/profile.rb', line 48

def source_reader
  @source_reader
end

Class Method Details

.for_fetcher(fetcher, opts) ⇒ Object 



38
39
40
41
 
# File 'lib/inspec/profile.rb', line 38

def self.for_fetcher(fetcher, opts)
  path, writable = fetcher.fetch
  for_path(path, opts.merge(target: fetcher.target, writable: writable))
end

.for_path(path, opts) ⇒ Object 



28
29
30
31
32
33
34
35
36
 
# File 'lib/inspec/profile.rb', line 28

def self.for_path(path, opts)
  file_provider = FileProvider.for_path(path)
  reader = Inspec::SourceReader.resolve(file_provider.relative_provider)
  if reader.nil?
    fail("Don't understand inspec profile in #{path}, it " \
         "doesn't look like a supported profile structure.")
  end
  new(reader, opts)
end

.for_target(target, opts = {}) ⇒ Object 



43
44
45
46
 
# File 'lib/inspec/profile.rb', line 43

def self.for_target(target, opts = {})
  fetcher = resolve_target(target, opts[:cache])
  for_fetcher(fetcher, opts)
end

.resolve_target(target, cache = nil) ⇒ Object 



24
25
26
 
# File 'lib/inspec/profile.rb', line 24

def self.resolve_target(target, cache = nil)
  Inspec::CachedFetcher.new(target, cache || Cache.new)
end

Instance Method Details

#archive(opts) ⇒ Object

generates a archive of a folder profile assumes that the profile was checked before



274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
 
# File 'lib/inspec/profile.rb', line 274

def archive(opts)
  # check if file exists otherwise overwrite the archive
  dst = archive_name(opts)
  if dst.exist? && !opts[:overwrite]
    @logger.info "Archive #{dst} exists already. Use --overwrite."
    return false
  end

  # remove existing archive
  File.delete(dst) if dst.exist?
  @logger.info "Generate archive #{dst}."

  # filter files that should not be part of the profile
  # TODO ignore all .files, but add the files to debug output

  # display all files that will be part of the archive
  @logger.debug 'Add the following files to archive:'
  root_path = @source_reader.target.prefix
  files = @source_reader.target.files
  files.each { |f| @logger.debug '    ' + f }

  if opts[:zip]
    # generate zip archive
    require 'inspec/archive/zip'
    zag = Inspec::Archive::ZipArchiveGenerator.new
    zag.archive(root_path, files, dst)
  else
    # generate tar archive
    require 'inspec/archive/tar'
    tag = Inspec::Archive::TarArchiveGenerator.new
    tag.archive(root_path, files, dst)
  end

  @logger.info 'Finished archive generation.'
  true
end

#check ⇒ Boolean

Check if the profile is internall well-structured. The logger will be used to print information on errors and warnings which are found.

Returns:

  • (Boolean) —

    true if no errors were found, false otherwise



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
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
 
# File 'lib/inspec/profile.rb', line 183

def check # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity, Metrics/MethodLength
  # initial values for response object
  result = {
    summary: {
      valid: false,
      timestamp: Time.now.iso8601,
      location: @target,
      profile: nil,
      controls: 0,
    },
    errors: [],
    warnings: [],
  }

  entry = lambda { |file, line, column, control, msg|
    {
      file: file,
      line: line,
      column: column,
      control_id: control,
      msg: msg,
    }
  }

  warn = lambda { |file, line, column, control, msg|
    @logger.warn(msg)
    result[:warnings].push(entry.call(file, line, column, control, msg))
  }

  error = lambda { |file, line, column, control, msg|
    @logger.error(msg)
    result[:errors].push(entry.call(file, line, column, control, msg))
  }

  @logger.info "Checking profile in #{@target}"
  meta_path = @source_reader.target.abs_path(@source_reader.metadata.ref)
  if meta_path =~ /metadata\.rb$/
    warn.call(@target, 0, 0, nil, 'The use of `metadata.rb` is deprecated. Use `inspec.yml`.')
  end

  # verify metadata
  m_errors, m_warnings = metadata.valid
  m_errors.each { |msg| error.call(meta_path, 0, 0, nil, msg) }
  m_warnings.each { |msg| warn.call(meta_path, 0, 0, nil, msg) }
  m_unsupported = metadata.unsupported
  m_unsupported.each { |u| warn.call(meta_path, 0, 0, nil, "doesn't support: #{u}") }
  @logger.info 'Metadata OK.' if m_errors.empty? && m_unsupported.empty?

  # extract profile name
  result[:summary][:profile] = metadata.params[:name]

  # check if the profile is using the old test directory instead of the
  # new controls directory
  if @source_reader.tests.keys.any? { |x| x =~ %r{^test/$} }
    warn.call(@target, 0, 0, nil, 'Profile uses deprecated `test` directory, rename it to `controls`.')
  end

  count = controls_count
  result[:summary][:controls] = count
  if count == 0
    warn.call(nil, nil, nil, nil, 'No controls or tests were defined.')
  else
    @logger.info("Found #{count} controls.")
  end

  # iterate over hash of groups
  params[:controls].each { |id, control|
    sfile = control[:source_location][:ref]
    sline = control[:source_location][:line]
    error.call(sfile, sline, nil, id, 'Avoid controls with empty IDs') if id.nil? or id.empty?
    next if id.start_with? '(generated '
    warn.call(sfile, sline, nil, id, "Control #{id} has no title") if control[:title].to_s.empty?
    warn.call(sfile, sline, nil, id, "Control #{id} has no description") if control[:desc].to_s.empty?
    warn.call(sfile, sline, nil, id, "Control #{id} has impact > 1.0") if control[:impact].to_f > 1.0
    warn.call(sfile, sline, nil, id, "Control #{id} has impact < 0.0") if control[:impact].to_f < 0.0
    warn.call(sfile, sline, nil, id, "Control #{id} has no tests defined") if control[:checks].nil? or control[:checks].empty?
  }

  # profile is valid if we could not find any error
  result[:summary][:valid] = result[:errors].empty?

  @logger.info 'Control definitions OK.' if result[:warnings].empty?
  result
end

#collect_tests(include_list = @controls) ⇒ Object 



107
108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'lib/inspec/profile.rb', line 107

def collect_tests(include_list = @controls)
  if !@tests_collected
    locked_dependencies.each(&:collect_tests)

    tests.each do |path, content|
      next if content.nil? || content.empty?
      abs_path = source_reader.target.abs_path(path)
      @runner_context.load_control_file(content, abs_path, nil)
    end
    @tests_collected = true
  end
  filter_controls(@runner_context.all_rules, include_list)
end

#controls_count ⇒ Object 



268
269
270
 
# File 'lib/inspec/profile.rb', line 268

def controls_count
  params[:controls].values.length
end

#cwd ⇒ Object

TODO(ssd): Relative path handling really needs to be carefully thought through, especially with respect to relative paths in tarballs.



328
329
330
 
# File 'lib/inspec/profile.rb', line 328

def cwd
  @target.is_a?(String) && File.directory?(@target) ? @target : './'
end

#filter_controls(controls_array, include_list) ⇒ Object 



121
122
123
124
125
126
127
 
# File 'lib/inspec/profile.rb', line 121

def filter_controls(controls_array, include_list)
  return controls_array if include_list.nil? || include_list.empty?
  controls_array.select do |c|
    id = ::Inspec::Rule.rule_id(c)
    include_list.include?(id)
  end
end

#generate_lockfile ⇒ Inspec::Lockfile

Generate an in-memory lockfile. This won’t render the lock file to disk, it must be explicitly written to disk by the caller.

Parameters:

  • vendor_path (String) —

    Path to the on-disk vendor dir

Returns:



347
348
349
350
351
 
# File 'lib/inspec/profile.rb', line 347

def generate_lockfile
  res = Inspec::DependencySet.new(cwd, @cache, nil, @backend)
  res.vendor(metadata.dependencies)
  Inspec::Lockfile.from_dependency_set(res)
end

#info(res = params.dup) ⇒ Object 



155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
 
# File 'lib/inspec/profile.rb', line 155

def info(res = params.dup)
  # add information about the controls
  res[:controls] = res[:controls].map do |id, rule|
    next if id.to_s.empty?
    data = rule.dup
    data.delete(:checks)
    data[:impact] ||= 0.5
    data[:impact] = 1.0 if data[:impact] > 1.0
    data[:impact] = 0.0 if data[:impact] < 0.0
    data[:id] = id
    data
  end.compact

  # resolve hash structure in groups
  res[:groups] = res[:groups].map do |id, group|
    group[:id] = id
    group
  end

  # add information about the required attributes
  res[:attributes] = res[:attributes].map(&:to_hash) unless res[:attributes].nil? || res[:attributes].empty?
  res
end

#info! ⇒ Object

return info using uncached params



151
152
153
 
# File 'lib/inspec/profile.rb', line 151

def info!
  info(load_params.dup)
end

#load_dependencies ⇒ Object 



353
354
355
 
# File 'lib/inspec/profile.rb', line 353

def load_dependencies
  Inspec::DependencySet.from_lockfile(lockfile, cwd, @cache, @backend, { attributes: @attr_values })
end

#load_libraries ⇒ Object 



129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
 
# File 'lib/inspec/profile.rb', line 129

def load_libraries
  return @runner_context if @libraries_loaded

  locked_dependencies.each do |d|
    c = d.load_libraries
    @runner_context.add_resources(c)
  end

  libs = libraries.map do |path, content|
    [content, path]
  end

  @runner_context.load_libraries(libs)
  @libraries_loaded = true
  @runner_context
end

#locked_dependencies ⇒ Object 



311
312
313
 
# File 'lib/inspec/profile.rb', line 311

def locked_dependencies
  @locked_dependencies ||= load_dependencies
end

#lockfile ⇒ Object 



332
333
334
335
336
337
338
 
# File 'lib/inspec/profile.rb', line 332

def lockfile
  @lockfile ||= if lockfile_exists?
                  Inspec::Lockfile.from_file(lockfile_path)
                else
                  generate_lockfile
                end
end

#lockfile_exists? ⇒ Boolean

Returns:

  • (Boolean) 


315
316
317
 
# File 'lib/inspec/profile.rb', line 315

def lockfile_exists?
  File.exist?(lockfile_path)
end

#lockfile_path ⇒ Object 



319
320
321
 
# File 'lib/inspec/profile.rb', line 319

def lockfile_path
  File.join(cwd, 'inspec.lock')
end

#name ⇒ Object 



73
74
75
 
# File 'lib/inspec/profile.rb', line 73

def name
  metadata.params[:name]
end

#params ⇒ Object 



103
104
105
 
# File 'lib/inspec/profile.rb', line 103

def params
  @params ||= load_params
end

#supported? ⇒ Boolean

Is this profile is supported on the current platform of the backend machine and the current inspec version.

Returns:

  • (Boolean) 


91
92
93
 
# File 'lib/inspec/profile.rb', line 91

def supported?
  supports_os? && supports_runtime?
end

#supports_os? ⇒ Boolean

Returns:

  • (Boolean) 


95
96
97
 
# File 'lib/inspec/profile.rb', line 95

def supports_os?
  metadata.supports_transport?(@backend)
end

#supports_runtime? ⇒ Boolean

Returns:

  • (Boolean) 


99
100
101
 
# File 'lib/inspec/profile.rb', line 99

def supports_runtime?
  metadata.supports_runtime?
end

#to_s ⇒ Object 



146
147
148
 
# File 'lib/inspec/profile.rb', line 146

def to_s
  "Inspec::Profile<#{name}>"
end

#version ⇒ Object 



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

def version
  metadata.params[:version]
end

#writable? ⇒ Boolean

rubocop:disable Style/TrivialAccessors

Returns:

  • (Boolean) 


81
82
83
 
# File 'lib/inspec/profile.rb', line 81

def writable? # rubocop:disable Style/TrivialAccessors
  @writable
end