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
-
#backend ⇒ Object
readonly
Returns the value of attribute backend.
-
#rules ⇒ Object
readonly
Returns the value of attribute rules.
-
#target_profiles ⇒ Object
Returns the value of attribute target_profiles.
-
#test_collector ⇒ Object
Returns the value of attribute test_collector.
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.
- #attributes ⇒ Object
- #configure_transport ⇒ Object
- #eval_with_virtual_profile(command) ⇒ Object
-
#initialize(conf = {}) ⇒ Runner
constructor
A new instance of Runner.
- #load ⇒ Object
- #register_rules(ctx) ⇒ Object
- #render_output(run_data) ⇒ Object
- #report ⇒ 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.
44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 |
# File 'lib/inspec/runner.rb', line 44 def initialize(conf = {}) @rules = [] # If we were handed a Hash config (by audit cookbook or kitchen-inspec), # upgrade it to a proper config. This handles a lot of config finalization, # like reporter parsing. @conf = conf.is_a?(Hash) ? Inspec::Config.new(conf) : conf @conf[:logger] ||= Logger.new(nil) @target_profiles = [] @controls = @conf[:controls] || [] @depends = @conf[:depends] || [] @create_lockfile = @conf[:create_lockfile] @cache = Inspec::Cache.new(@conf[:vendor_cache]) @test_collector = @conf.delete(:test_collector) || begin RunnerRspec.new(@conf) end if @conf[:waiver_file] waivers = @conf.delete(:waiver_file) @conf[:input_file] ||= [] @conf[:input_file].concat waivers end # About reading inputs: # @conf gets passed around a lot, eventually to # Inspec::InputRegistry.register_external_inputs. # # @conf may contain the key :attributes or :inputs, which is to be a Hash # of values passed in from the Runner API. # This is how kitchen-inspec and the audit_cookbook pass in inputs. # # @conf may contain the key :attrs or :input_file, which is to be an Array # of file paths, each a YAML file. This how --input-file works. configure_transport end |
Instance Attribute Details
#backend ⇒ Object (readonly)
Returns the value of attribute backend.
34 35 36 |
# File 'lib/inspec/runner.rb', line 34 def backend @backend end |
#rules ⇒ Object (readonly)
Returns the value of attribute rules.
34 35 36 |
# File 'lib/inspec/runner.rb', line 34 def rules @rules end |
#target_profiles ⇒ Object
Returns the value of attribute target_profiles.
35 36 37 |
# File 'lib/inspec/runner.rb', line 35 def target_profiles @target_profiles end |
#test_collector ⇒ Object
Returns the value of attribute test_collector.
37 38 39 |
# File 'lib/inspec/runner.rb', line 37 def test_collector @test_collector 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 inputs) 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
197 198 199 200 201 202 203 204 205 206 |
# File 'lib/inspec/runner.rb', line 197 def add_target(target, _opts = []) profile = Inspec::Profile.for_target(target, vendor_cache: @cache, backend: @backend, controls: @controls, runner_conf: @conf) raise "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.
221 222 223 |
# File 'lib/inspec/runner.rb', line 221 def all_rules @rules end |
#attributes ⇒ Object
39 40 41 42 |
# File 'lib/inspec/runner.rb', line 39 def attributes Inspec.deprecate(:rename_attributes_to_inputs, "Don't call runner.attributes, call runner.inputs") inputs end |
#configure_transport ⇒ Object
85 86 87 88 |
# File 'lib/inspec/runner.rb', line 85 def configure_transport @backend = Inspec::Backend.create(@conf) @test_collector.backend = @backend end |
#eval_with_virtual_profile(command) ⇒ Object
236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 |
# File 'lib/inspec/runner.rb', line 236 def eval_with_virtual_profile(command) require "inspec/fetcher/mock" add_target({ "inspec.yml" => "name: inspec-shell" }) our_profile = @target_profiles.first ctx = our_profile.runner_context # Load local profile dependencies. This is used in inspec shell # to provide access to local profiles that add resources. @depends.each do |dep| # support for windows paths dep = dep.tr('\\', "/") Inspec::Profile.for_path(dep, { profile_context: ctx }).load_libraries end ctx.load(command) end |
#load ⇒ Object
98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 |
# File 'lib/inspec/runner.rb', line 98 def load all_controls = [] @target_profiles.each do |profile| @test_collector.add_profile(profile) next unless profile.supports_platform? write_lockfile(profile) if @create_lockfile profile.locked_dependencies profile_context = profile.load_libraries profile_context.dependencies.list.values.each do |requirement| unless requirement.profile.supports_platform? Inspec::Log.warn "Skipping profile: '#{requirement.profile.name}'" \ " on unsupported platform: '#{@backend.platform.name}/#{@backend.platform.release}'." next end @test_collector.add_profile(requirement.profile) end begin tests = profile.collect_tests all_controls += tests unless tests.nil? rescue Inspec::Exceptions::ProfileLoadFailed => e Inspec::Log.error "Failed to load profile #{profile.name}: #{e}" profile. e.to_s next end end all_controls.each do |rule| register_rule(rule) unless rule.nil? end end |
#register_rules(ctx) ⇒ Object
225 226 227 228 229 230 231 232 233 234 |
# File 'lib/inspec/runner.rb', line 225 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 |
#render_output(run_data) ⇒ Object
139 140 141 142 143 144 145 146 |
# File 'lib/inspec/runner.rb', line 139 def render_output(run_data) return if @conf["reporter"].nil? @conf["reporter"].each do |reporter| result = Inspec::Reporters.render(reporter, run_data) raise Inspec::ReporterError, "Error generating reporter '#{reporter[0]}'" if result == false end end |
#report ⇒ Object
148 149 150 |
# File 'lib/inspec/runner.rb', line 148 def report Inspec::Reporters.report(@conf["reporter"].first, @run_data) end |
#reset ⇒ Object
90 91 92 93 94 95 96 |
# File 'lib/inspec/runner.rb', line 90 def reset @test_collector.reset @target_profiles.each do |profile| profile.runner_context.rules = {} end @rules = [] end |
#run(with = nil) ⇒ Object
133 134 135 136 137 |
# File 'lib/inspec/runner.rb', line 133 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
164 165 166 167 168 169 |
# File 'lib/inspec/runner.rb', line 164 def run_tests(with = nil) @run_data = @test_collector.run(with) # dont output anything if we want a report render_output(@run_data) unless @conf["report"] @test_collector.exit_code end |
#supports_profile?(profile) ⇒ Boolean
208 209 210 211 212 213 214 215 216 |
# File 'lib/inspec/runner.rb', line 208 def supports_profile?(profile) unless profile.supports_runtime? raise "This profile requires #{Inspec::Dist::PRODUCT_NAME} version "\ "#{profile..inspec_requirement}. You are running "\ "#{Inspec::Dist::PRODUCT_NAME} v#{Inspec::VERSION}.\n" end true end |
#tests ⇒ Object
81 82 83 |
# File 'lib/inspec/runner.rb', line 81 def tests @test_collector.tests end |
#write_lockfile(profile) ⇒ Object
152 153 154 155 156 157 158 159 160 161 162 |
# File 'lib/inspec/runner.rb', line 152 def write_lockfile(profile) return false unless 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 |