Class: Inspec::Runner

Inherits:
Object
  • Object
show all
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

Instance Method Summary collapse

Constructor Details

#initialize(conf = {}) ⇒ Runner

Returns a new instance of Runner.



35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
 
# File 'lib/inspec/runner.rb', line 35

def initialize(conf = {})
  @rules = []
  @conf = conf.dup
  @conf[:logger] ||= Logger.new(nil)
  @target_profiles = []
  @controls = @conf[:controls] || []
  @depends = @conf[:depends] || []
  @ignore_supports = @conf[:ignore_supports]
  @create_lockfile = @conf[:create_lockfile]
  @cache = Inspec::Cache.new(@conf[:vendor_cache])

  # parse any ad-hoc runners reporter formats
  # this has to happen before we load the test_collector
  @conf = Inspec::BaseCLI.parse_reporters(@conf) if @conf[:type].nil?

  @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.



34
35
36
 
# File 'lib/inspec/runner.rb', line 34

def attributes
  @attributes
end

#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

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



188
189
190
191
192
193
194
195
196
 
# File 'lib/inspec/runner.rb', line 188

def add_target(target, _opts = [])
  profile = Inspec::Profile.for_target(target,
                                       vendor_cache: @cache,
                                       backend: @backend,
                                       controls: @controls,
                                       attributes: @conf[:attributes])
  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.



217
218
219
 
# File 'lib/inspec/runner.rb', line 217

def all_rules
  @rules
end

#configure_transport ⇒ Object 



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

def configure_transport
  @backend = Inspec::Backend.create(@conf)
  @test_collector.backend = @backend
end

#eval_with_virtual_profile(command) ⇒ Object 



231
232
233
234
235
236
237
238
239
240
241
242
243
244
 
# File 'lib/inspec/runner.rb', line 231

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

  # Load local profile dependencies. This is used in inspec shell
  # to provide access to local profiles that add resources.
  @depends
    .map { |x| Inspec::Profile.for_path(x, { profile_context: ctx }) }
    .each(&:load_libraries)

  ctx.load(command)
end

#load ⇒ Object 



79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/inspec/runner.rb', line 79

def load
  all_controls = []

  @target_profiles.each do |profile|
    @test_collector.add_profile(profile)
    write_lockfile(profile) if @create_lockfile
    profile.locked_dependencies
    profile_context = profile.load_libraries

    profile_context.dependencies.list.values.each do |requirement|
      @test_collector.add_profile(requirement.profile)
    end

    @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



139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
 
# File 'lib/inspec/runner.rb', line 139

def load_attributes(options)
  options[:attributes] ||= {}

  secrets_targets = options[:attrs]
  return options[:attributes] if secrets_targets.nil?

  secrets_targets.each do |target|
    validate_attributes_file_readability!(target)

    secrets = Inspec::SecretsBackend.resolve(target)
    if secrets.nil?
      raise Inspec::Exceptions::SecretsBackendNotFound,
            "Cannot find parser for attributes file '#{target}'. " \
            'Check to make sure file has the appropriate extension.'
    end

    next if secrets.attributes.nil?
    options[:attributes].merge!(secrets.attributes)
  end

  options[:attributes]
end

#register_rules(ctx) ⇒ Object 



221
222
223
224
225
226
227
228
229
 
# File 'lib/inspec/runner.rb', line 221

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 



107
108
109
110
111
112
113
 
# File 'lib/inspec/runner.rb', line 107

def render_output(run_data)
  return if @conf['reporter'].nil?

  @conf['reporter'].each do |reporter|
    Inspec::Reporters.render(reporter, run_data)
  end
end

#report ⇒ Object 



115
116
117
 
# File 'lib/inspec/runner.rb', line 115

def report
  Inspec::Reporters.report(@conf['reporter'].first, @run_data)
end

#reset ⇒ Object 



71
72
73
74
75
76
77
 
# File 'lib/inspec/runner.rb', line 71

def reset
  @test_collector.reset
  @target_profiles.each do |profile|
    profile.runner_context.rules = {}
  end
  @rules = []
end

#run(with = nil) ⇒ Object 



101
102
103
104
105
 
# File 'lib/inspec/runner.rb', line 101

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 



131
132
133
134
135
136
 
# File 'lib/inspec/runner.rb', line 131

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

Returns:

  • (Boolean) 


198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
 
# File 'lib/inspec/runner.rb', line 198

def supports_profile?(profile)
  return true if @ignore_supports

  if !profile.supports_runtime?
    raise 'This profile requires InSpec version '\
         "#{profile.metadata.inspec_requirement}. You are running "\
         "InSpec v#{Inspec::VERSION}.\n"
  end

  if !profile.supports_platform?
    raise "This OS/platform (#{@backend.platform.name}/#{@backend.platform.release}) is not supported by this profile."
  end

  true
end

#tests ⇒ Object 



62
63
64
 
# File 'lib/inspec/runner.rb', line 62

def tests
  @test_collector.tests
end

#write_lockfile(profile) ⇒ Object 



119
120
121
122
123
124
125
126
127
128
129
 
# File 'lib/inspec/runner.rb', line 119

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