Class: Inspec::Plugins::SourceReader

Inherits:
PluginRegistry::Plugin show all
Defined in:
lib/inspec/plugin/v1/plugin_types/source_reader.rb

Instance Attribute Summary

Attributes inherited from PluginRegistry::Plugin

#parent, #target

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from PluginRegistry::Plugin

name, priority, resolve, resolve_next

Class Method Details

.plugin_registry ⇒ Object 



10
11
12
 
# File 'lib/inspec/plugin/v1/plugin_types/source_reader.rb', line 10

def self.plugin_registry
  Inspec::SourceReader
end

Instance Method Details

#libraries ⇒ Hash

Retrieve this profile’s libraries

Returns:

  • (Hash) —

    Collection with references pointing to library contents



35
36
37
 
# File 'lib/inspec/plugin/v1/plugin_types/source_reader.rb', line 35

def libraries
  raise "SourceReader #{self} does not implement `libraries()`. This method is required"
end

#metadata ⇒ Inspec::Metadata

Retrieve this profile’s metadata.

Returns:



17
18
19
 
# File 'lib/inspec/plugin/v1/plugin_types/source_reader.rb', line 17

def metadata
  raise "SourceReader #{self} does not implement `metadata()`. This method is required"
end

#tests ⇒ Hash

Retrieve this profile’s tests

“tests” here refers to a test file. Individual controls and anonymous tests are later extracted from the raw contents of a test file. The map her simply maps from a test file name to the file contents.

Returns:

  • (Hash) —

    Collection with references pointing to test contents



28
29
30
 
# File 'lib/inspec/plugin/v1/plugin_types/source_reader.rb', line 28

def tests
  raise "SourceReader #{self} does not implement `tests()`. This method is required"
end