Class: Inspec::Runner
- Inherits:
-
Object
- Object
- Inspec::Runner
- Extended by:
- Forwardable
- Defined in:
- lib/inspec/runner.rb
Overview
Inspec::Runner coordinates the running of tests and is the main entry point to the application.
Users are expected to insantiate a runner, add targets to be run, and then call the run method:
“‘ r = Inspec::Runner.new() r.add_target(“/path/to/some/profile”) r.add_target(“url/to/some/profile”) r.run “`
Instance Attribute Summary collapse
-
#attributes ⇒ Object
readonly
Returns the value of attribute attributes.
-
#backend ⇒ Object
readonly
Returns the value of attribute backend.
-
#rules ⇒ Object
readonly
Returns the value of attribute rules.
Instance Method Summary collapse
-
#add_target(target, _opts = []) ⇒ Object
add_target allows the user to add a target whose tests will be run when the user calls the run method.
-
#all_rules ⇒ Object
In some places we read the rules off of the runner, in other places we read it off of the profile context.
- #configure_transport ⇒ Object
- #eval_with_virtual_profile(command) ⇒ Object
-
#initialize(conf = {}) ⇒ Runner
constructor
A new instance of Runner.
- #load ⇒ Object
-
#load_attributes(options) ⇒ Object
determine all attributes before the execution, fetch data from secrets backend.
- #register_rules(ctx) ⇒ Object
- #reset ⇒ Object
- #run(with = nil) ⇒ Object
- #run_tests(with = nil) ⇒ Object
- #supports_profile?(profile) ⇒ Boolean
- #tests ⇒ Object
- #write_lockfile(profile) ⇒ Object
Constructor Details
#initialize(conf = {}) ⇒ Runner
Returns a new instance of Runner.
38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 |
# File 'lib/inspec/runner.rb', line 38 def initialize(conf = {}) @rules = [] @conf = conf.dup @conf[:logger] ||= Logger.new(nil) @target_profiles = [] @controls = @conf[:controls] || [] @ignore_supports = @conf[:ignore_supports] @create_lockfile = @conf[:create_lockfile] @cache = Inspec::Cache.new(@conf[:cache]) @test_collector = @conf.delete(:test_collector) || begin require 'inspec/runner_rspec' RunnerRspec.new(@conf) end # list of profile attributes @attributes = [] load_attributes(@conf) configure_transport end |
Instance Attribute Details
#attributes ⇒ Object (readonly)
Returns the value of attribute attributes.
37 38 39 |
# File 'lib/inspec/runner.rb', line 37 def attributes @attributes end |
#backend ⇒ Object (readonly)
Returns the value of attribute backend.
37 38 39 |
# File 'lib/inspec/runner.rb', line 37 def backend @backend end |
#rules ⇒ Object (readonly)
Returns the value of attribute rules.
37 38 39 |
# File 'lib/inspec/runner.rb', line 37 def rules @rules end |
Instance Method Details
#add_target(target, _opts = []) ⇒ Object
add_target allows the user to add a target whose tests will be run when the user calls the run method.
A target is a path or URL that points to a profile. Using this target we generate a Profile and a ProfileContext. The content (libraries, tests, and attributes) from the Profile are loaded into the ProfileContext.
If the profile depends on other profiles, those profiles will be loaded on-demand when include_content or required_content are called using similar code in Inspec::DSL.
Once the we’ve loaded all of the tests files in the profile, we query the profile for the full list of rules. Those rules are registered with the @test_collector which is ultimately responsible for actually running the tests.
TODO: Deduplicate/clarify the loading code that exists in here, the ProfileContext, the Profile, and Inspec::DSL
156 157 158 159 160 161 162 163 164 |
# File 'lib/inspec/runner.rb', line 156 def add_target(target, _opts = []) profile = Inspec::Profile.for_target(target, cache: @cache, backend: @backend, controls: @controls, attributes: @conf[:attributes]) fail "Could not resolve #{target} to valid input." if profile.nil? @target_profiles << profile if supports_profile?(profile) end |
#all_rules ⇒ Object
In some places we read the rules off of the runner, in other places we read it off of the profile context. To keep the API’s the same, we provide an #all_rules method here as well.
185 186 187 |
# File 'lib/inspec/runner.rb', line 185 def all_rules @rules end |
#configure_transport ⇒ Object
63 64 65 66 |
# File 'lib/inspec/runner.rb', line 63 def configure_transport @backend = Inspec::Backend.create(@conf) @test_collector.backend = @backend end |
#eval_with_virtual_profile(command) ⇒ Object
199 200 201 202 203 204 205 |
# File 'lib/inspec/runner.rb', line 199 def eval_with_virtual_profile(command) require 'fetchers/mock' add_target({ 'inspec.yml' => 'name: inspec-shell' }) our_profile = @target_profiles.first ctx = our_profile.runner_context ctx.load(command) end |
#load ⇒ Object
76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 |
# File 'lib/inspec/runner.rb', line 76 def load all_controls = [] @target_profiles.each do |profile| @test_collector.add_profile(profile) write_lockfile(profile) if @create_lockfile profile.locked_dependencies profile.load_libraries @attributes |= profile.runner_context.attributes all_controls += profile.collect_tests end all_controls.each do |rule| register_rule(rule) unless rule.nil? end end |
#load_attributes(options) ⇒ Object
determine all attributes before the execution, fetch data from secrets backend
116 117 118 119 120 121 122 123 124 125 126 127 128 |
# File 'lib/inspec/runner.rb', line 116 def load_attributes() attributes = {} # read endpoints for secrets eg. yml file secrets_targets = ['attrs'] unless secrets_targets.nil? secrets_targets.each do |target| secrets = Inspec::SecretsBackend.resolve(target) # merge hash values attributes = attributes.merge(secrets.attributes) unless secrets.nil? || secrets.attributes.nil? end end ['attributes'] = attributes end |
#register_rules(ctx) ⇒ Object
189 190 191 192 193 194 195 196 197 |
# File 'lib/inspec/runner.rb', line 189 def register_rules(ctx) new_tests = false ctx.rules.each do |rule_id, rule| next if block_given? && !(yield rule_id, rule) new_tests = true register_rule(rule) end new_tests end |
#reset ⇒ Object
68 69 70 71 72 73 74 |
# File 'lib/inspec/runner.rb', line 68 def reset @test_collector.reset @target_profiles.each do |profile| profile.runner_context.rules = {} end @rules = [] end |
#run(with = nil) ⇒ Object
93 94 95 96 97 |
# File 'lib/inspec/runner.rb', line 93 def run(with = nil) Inspec::Log.debug "Starting run with targets: #{@target_profiles.map(&:to_s)}" load run_tests(with) end |
#run_tests(with = nil) ⇒ Object
111 112 113 |
# File 'lib/inspec/runner.rb', line 111 def run_tests(with = nil) @test_collector.run(with) end |
#supports_profile?(profile) ⇒ Boolean
166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 |
# File 'lib/inspec/runner.rb', line 166 def supports_profile?(profile) return true if @ignore_supports if !profile.supports_runtime? fail 'This profile requires InSpec version '\ "#{profile..inspec_requirement}. You are running "\ "InSpec v#{Inspec::VERSION}.\n" end if !profile.supports_os? fail "This OS/platform (#{@backend.os[:name]}) is not supported by this profile." end true end |
#tests ⇒ Object
59 60 61 |
# File 'lib/inspec/runner.rb', line 59 def tests @test_collector.tests end |
#write_lockfile(profile) ⇒ Object
99 100 101 102 103 104 105 106 107 108 109 |
# File 'lib/inspec/runner.rb', line 99 def write_lockfile(profile) return false if !profile.writable? if profile.lockfile_exists? Inspec::Log.debug "Using existing lockfile #{profile.lockfile_path}" else Inspec::Log.debug "Creating lockfile: #{profile.lockfile_path}" lockfile = profile.generate_lockfile File.write(profile.lockfile_path, lockfile.to_yaml) end end |