Puppet Function: get_module_path

Defined in:
puppet/modules/stdlib/lib/puppet/parser/functions/get_module_path.rb
Function type:
Ruby 3.x API

Overview

get_module_path() ⇒ Any

Returns the absolute path of the specified module for the current environment.

Example:

$module_path = get_module_path('stdlib')

Returns:

  • (Any) 


2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
 
# File 'puppet/modules/stdlib/lib/puppet/parser/functions/get_module_path.rb', line 2

newfunction(:get_module_path, :type =>:rvalue, :doc => <<-EOT
  Returns the absolute path of the specified module for the current
  environment.

  Example:
    $module_path = get_module_path('stdlib')
EOT
) do |args|
  raise(Puppet::ParseError, "get_module_path(): Wrong number of arguments, expects one") unless args.size == 1
  if module_path = Puppet::Module.find(args[0], compiler.environment.to_s)
    module_path.path
  else
    raise(Puppet::ParseError, "Could not find module #{args[0]} in environment #{compiler.environment}")
  end
end