Module: Inspec::Reporters

Defined in:
lib/inspec/reporters.rb,
lib/inspec/reporters/cli.rb,
lib/inspec/reporters/base.rb,
lib/inspec/reporters/json.rb,
lib/inspec/reporters/junit.rb,
lib/inspec/reporters/automate.rb,
lib/inspec/reporters/json_min.rb

Defined Under Namespace

Classes: Automate, Base, CLI, Json, JsonMin, Junit

Class Method Summary collapse

Class Method Details

.render(reporter, run_data) ⇒ Object 



9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
 
# File 'lib/inspec/reporters.rb', line 9

def self.render(reporter, run_data)
  name, config = reporter.dup
  config[:run_data] = run_data
  case name
  when 'cli'
    reporter = Inspec::Reporters::CLI.new(config)
  when 'json'
    reporter = Inspec::Reporters::Json.new(config)
  when 'json-min'
    reporter = Inspec::Reporters::JsonMin.new(config)
  when 'junit'
    reporter = Inspec::Reporters::Junit.new(config)
  when 'automate'
    reporter = Inspec::Reporters::Automate.new(config)
  else
    raise NotImplementedError, "'#{name}' is not a valid reporter type."
  end

  # optional send_report method on reporter
  return reporter.send_report if defined?(reporter.send_report)

  reporter.render
  output = reporter.rendered_output

  if config['file']
    # create destination directory if it does not exist
    dirname = File.dirname(config['file'])
    FileUtils.mkdir_p(dirname) unless File.directory?(dirname)

    File.write(config['file'], output)
  elsif config['stdout'] == true
    print output
    STDOUT.flush
  end
end

.report(reporter, run_data) ⇒ Object 



45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
 
# File 'lib/inspec/reporters.rb', line 45

def self.report(reporter, run_data)
  name, config = reporter.dup
  config[:run_data] = run_data
  case name
  when 'json'
    reporter = Inspec::Reporters::Json.new(config)
  when 'json-min'
    reporter = Inspec::Reporters::JsonMin.new(config)
  else
    # use base run_data hash for any other report
    return run_data
  end

  reporter.report
end