Class: Inspec::Telemetry::RunContextProbe

Inherits:
Object
  • Object
show all
Defined in:
lib/inspec/utils/telemetry/run_context_probe.rb

Overview

Guesses the run context of InSpec - how were we invoked? All stack values here are determined experimentally

Class Method Summary collapse

Class Method Details

.audit_cookbook?(stack) ⇒ Boolean

Returns:

  • (Boolean) 


26
27
28
29
 
# File 'lib/inspec/utils/telemetry/run_context_probe.rb', line 26

def self.audit_cookbook?(stack)
  stack_match(stack: stack, path: "chef/handler", label: "run_report_handlers") &&
    stack_match(stack: stack, path: "handler/audit_report", label: "report")
end

.guess_run_context(stack = nil) ⇒ Object 



7
8
9
10
11
12
13
14
 
# File 'lib/inspec/utils/telemetry/run_context_probe.rb', line 7

def self.guess_run_context(stack = nil)
  stack ||= caller_locations
  return "test-kitchen" if kitchen?(stack)
  return "cli" if run_by_thor?(stack)
  return "audit-cookbook" if audit_cookbook?(stack)

  "unknown"
end

.kitchen?(stack) ⇒ Boolean

Returns:

  • (Boolean) 


21
22
23
24
 
# File 'lib/inspec/utils/telemetry/run_context_probe.rb', line 21

def self.kitchen?(stack)
  stack_match(stack: stack, path: "kitchen/instance", label: "verify_action") &&
    stack_match(stack: stack, path: "kitchen/instance", label: "verify")
end

.run_by_thor?(stack) ⇒ Boolean

Returns:

  • (Boolean) 


16
17
18
19
 
# File 'lib/inspec/utils/telemetry/run_context_probe.rb', line 16

def self.run_by_thor?(stack)
  stack_match(stack: stack, path: "thor/command", label: "run") &&
    stack_match(stack: stack, path: "thor/invocation", label: "invoke_command")
end

.stack_match(stack: [], label: nil, path: nil) ⇒ Object 



31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
 
# File 'lib/inspec/utils/telemetry/run_context_probe.rb', line 31

def self.stack_match(stack: [], label: nil, path: nil)
  return false if stack.nil?

  stack.any? do |frame|
    if label && path
      frame.label == label && frame.absolute_path.include?(path)
    elsif label
      frame.label == label
    elsif path
      frame.absolute_path.include?(path)
    else
      false
    end
  end
end