Sha256: 7b91068709686d80f254c68b57bf53bd343088ce6f4b569e6abf59f9a4830dec

Contents?: true

Size: 1.24 KB

Versions: 6

Compression:

Stored size: 1.24 KB

Contents

# encoding: utf-8
# author: Dominik Richter
# author: Christoph Hartmann

require 'utils/plugin_registry'

module Inspec
  module Plugins
    class SourceReader < PluginRegistry::Plugin
      def self.plugin_registry
        Inspec::SourceReader
      end

      # Retrieve this profile's metadata.
      #
      # @return [Inspec::Metadata] profile metadata
      def metadata
        raise "SourceReader #{self} does not implement `metadata()`. This method is required"
      end

      # 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.
      #
      # @return [Hash] Collection with references pointing to test contents
      def tests
        raise "SourceReader #{self} does not implement `tests()`. This method is required"
      end

      # Retrieve this profile's libraries
      #
      # @return [Hash] Collection with references pointing to library contents
      def libraries
        raise "SourceReader #{self} does not implement `libraries()`. This method is required"
      end
    end
  end
end

Version data entries

6 entries across 6 versions & 1 rubygems

Version Path
inspec-2.1.81 lib/inspec/plugins/source_reader.rb
inspec-2.1.21 lib/inspec/plugins/source_reader.rb
inspec-2.1.10 lib/inspec/plugins/source_reader.rb
inspec-2.0.32 lib/inspec/plugins/source_reader.rb
inspec-2.0.17 lib/inspec/plugins/source_reader.rb
inspec-1.51.15 lib/inspec/plugins/source_reader.rb