Module: Inspec

Defined in:
lib/inspec/errors.rb,
lib/inspec/log.rb,
lib/inspec/rule.rb,
lib/inspec/shell.rb,
lib/inspec/expect.rb,
lib/inspec/runner.rb,
lib/inspec/schema.rb,
lib/inspec/backend.rb,
lib/inspec/fetcher.rb,
lib/inspec/objects.rb,
lib/inspec/plugins.rb,
lib/inspec/profile.rb,
lib/inspec/secrets.rb,
lib/inspec/version.rb,
lib/inspec/base_cli.rb,
lib/inspec/describe.rb,
lib/inspec/metadata.rb,
lib/inspec/resource.rb,
lib/inspec/dsl_shared.rb,
lib/inspec/env_printer.rb,
lib/inspec/objects/tag.rb,
lib/inspec/plugins/cli.rb,
lib/inspec/runner_mock.rb,
lib/inspec/objects/list.rb,
lib/inspec/objects/test.rb,
lib/inspec/runner_rspec.rb,
lib/inspec/file_provider.rb,
lib/inspec/objects/value.rb,
lib/inspec/source_reader.rb,
lib/inspec/cached_fetcher.rb,
lib/inspec/plugins/secret.rb,
lib/inspec/profile_vendor.rb,
lib/inspec/require_loader.rb,
lib/inspec/shell_detector.rb,
lib/inspec/objects/control.rb,
lib/inspec/objects/or_test.rb,
lib/inspec/plugins/fetcher.rb,
lib/inspec/profile_context.rb,
lib/inspec/plugins/resource.rb,
lib/inspec/objects/attribute.rb,
lib/inspec/objects/each_loop.rb,
lib/inspec/dependencies/cache.rb,
lib/inspec/objects/ruby_helper.rb,
lib/inspec/control_eval_context.rb,
lib/inspec/library_eval_context.rb,
lib/inspec/dependencies/lockfile.rb,
lib/inspec/dependencies/resolver.rb,
lib/inspec/plugins/source_reader.rb,
lib/inspec/dependencies/requirement.rb,
lib/inspec/dependencies/dependency_set.rb

Overview

author: Dominik Richter author: Christoph Hartmann

Defined Under Namespace

Modules: Archive, Backend, DSL, Plugins, ResourceBehaviors, ResourceDSL, Resources, RubyHelper Classes: Attribute, BaseCLI, Cache, CachedFetcher, Control, ControlEvalContext, CyclicDependencyError, DependencySet, DescribeBase, DirProvider, DuplicateDep, EachLoop, EnvPrinter, Error, Expect, FetcherFailure, FetcherRegistry, FileProvider, InspecCLI, LibraryEvalContext, List, Lockfile, Log, Metadata, MockProvider, OrTest, PluginCtl, Profile, ProfileContext, ProfileNotFound, ProfileVendor, RSpecReporter, RelativeFileProvider, RequireLoader, Requirement, Resolver, Resource, Rule, Runner, RunnerMock, RunnerRspec, Schema, Shell, ShellDetector, SourceReaderRegistry, Tag, TarProvider, Test, UnsatisfiedVersionSpecification, Value, ZipProvider

Constant Summary collapse

Fetcher = 
FetcherRegistry.new
SecretsBackend = 
PluginRegistry.new
VERSION = 
'1.20.0'.freeze
SourceReader = 
SourceReaderRegistry.new

Class Method Summary collapse

Class Method Details

.fetcher(version) ⇒ Object 



35
36
37
38
39
40
 
# File 'lib/inspec/fetcher.rb', line 35

def self.fetcher(version)
  if version != 1
    raise 'Only fetcher version 1 is supported!'
  end
  Inspec::Plugins::Fetcher
end

.resource(version) ⇒ Resource

Retrieve the base class for creating a new resource. Create classes that inherit from this class.

Parameters:

  • version (int) —

    the resource version to use

Returns:

  • (Resource) —

    base class for creating a new resource



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

def self.resource(version)
  validate_resource_dsl_version!(version)
  Inspec::Plugins::Resource
end

.secrets(version) ⇒ Object 



11
12
13
14
15
16
 
# File 'lib/inspec/secrets.rb', line 11

def self.secrets(version)
  if version != 1
    raise 'Only secrets version 1 is supported!'
  end
  Inspec::Plugins::Secret
end

.source_reader(version) ⇒ Object 



20
21
22
23
24
25
 
# File 'lib/inspec/source_reader.rb', line 20

def self.source_reader(version)
  if version != 1
    raise 'Only source readers version 1 is supported!'
  end
  Inspec::Plugins::SourceReader
end

.validate_resource_dsl_version!(version) ⇒ Object 



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

def self.validate_resource_dsl_version!(version)
  if version != 1
    raise 'Only resource version 1 is supported!'
  end
end