Puppet Function: stdlib::has_function

Defined in:
lib/puppet/functions/stdlib/has_function.rb
Function type:
Ruby 4.x API

Summary

Returns whether the Puppet runtime has access to a given function.

Overview

stdlib::has_function(String[1] $function_name) ⇒ Boolean

Determines whether the Puppet runtime has access to a function by the name provided.

Examples:

Using stdlib::has_function()

stdlib::has_function('stdlib::has_function') # true
stdlib::has_function('not_a_function') # false

Parameters:

  • function_name (String[1])

Returns:

  • (Boolean) 


16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
 
# File 'lib/puppet/functions/stdlib/has_function.rb', line 16

Puppet::Functions.create_function(:'stdlib::has_function', Puppet::Functions::InternalFunction) do
  dispatch :has_function do
    scope_param
    param 'String[1]', :function_name
    return_type 'Boolean'
  end

  def has_function(scope, function_name) # rubocop:disable Naming/PredicateName
    loaders = scope.compiler.loaders
    loader = loaders.private_environment_loader
    return true unless loader&.load(:function, function_name).nil?

    # If the loader cannot find the function it might be
    # a 3x-style function stubbed in on-the-fly for testing.
    func_3x = Puppet::Parser::Functions.function(function_name.to_sym)
    func_3x.is_a?(String) && !func_3x.empty?
  end
end