Class: SourceReaders::InspecReader

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(target, metadata_source) ⇒ InspecReader

This create a new instance of an InSpec profile source reader

Parameters:

  • target (FileProvider) —

    An instance of a FileProvider object that can list files and read them

  • metadata_source (String) —

    eg. inspec.yml or metadata.rb



32
33
34
35
36
37
 
# File 'lib/source_readers/inspec.rb', line 32

def initialize(target, metadata_source)
  @target    = target
  @metadata  = load_metadata(metadata_source)
  @tests     = load_tests
  @libraries = load_libs
end

Instance Attribute Details

#libraries ⇒ Object (readonly)

Returns the value of attribute libraries.



26
27
28
 
# File 'lib/source_readers/inspec.rb', line 26

def libraries
  @libraries
end

#metadata ⇒ Object (readonly)

Returns the value of attribute metadata.



26
27
28
 
# File 'lib/source_readers/inspec.rb', line 26

def metadata
  @metadata
end

#tests ⇒ Object (readonly)

Returns the value of attribute tests.



26
27
28
 
# File 'lib/source_readers/inspec.rb', line 26

def tests
  @tests
end

Class Method Details

.resolve(target) ⇒ Object 



13
14
15
16
17
18
19
20
21
22
23
24
 
# File 'lib/source_readers/inspec.rb', line 13

def self.resolve(target)
  return new(target, 'inspec.yml') if target.files.include?('inspec.yml')
  # TODO: deprecated for 1.0.0 release
  if target.files.include?('metadata.rb') &&
     (
       target.files.include?('controls') ||
       target.files.include?('test')
     )
    return new(target, 'metadata.rb')
  end
  nil
end