Puppet Function: simplib::debug::stacktrace

Defined in:
lib/puppet/functions/simplib/debug/stacktrace.rb
Function type:
Ruby 4.x API

Overview

simplib::debug::stacktrace(Optional[Boolean] $print) ⇒ Array

Prints out a stacktrace of all files loaded up until the point where this function was called

WARNING: Uses EXPERIMENTAL features from Puppet, may break at any time.

Parameters:

  • print (Optional[Boolean]) —

    Whether or not to print to the visual output

Returns:

  • (Array) —

    The stack trace



5
6
7
8
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
 
# File 'lib/puppet/functions/simplib/debug/stacktrace.rb', line 5

Puppet::Functions.create_function(:'simplib::debug::stacktrace', Puppet::Functions::InternalFunction) do
  # @param print
  #   Whether or not to print to the visual output
  #
  # @return [Array]
  #   The stack trace
  dispatch :stacktrace do
    scope_param
    optional_param 'Boolean', :print
  end

  def stacktrace(_scope, print = true)
    stack_trace = Puppet::Pops::PuppetStack.stacktrace.map { |x| x.join(':') }

    if print
      msg = [
        'Simplib::Debug::Stacktrace:',
        '    => ' + stack_trace.join("\n    => "),
      ].join("\n")

      # This is only required when rspec is loaded
      if defined?(RSpec)
        $stderr.puts(msg)
      end

      Puppet.warning(msg)
    end

    stack_trace
  end
end