Puppet Function: get_module_path

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

Summary

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

Overview

get_module_path() ⇒ Any

> Note:

that since Puppet 5.4.0 the  built-in
[`module_directory`](https://puppet.com/docs/puppet/latest/function.html#module_directory)
function in Puppet does the same thing and will return the path to the first found module
if given multiple values or an array.

Examples:

Example Usage:

$module_path = get_module_path('stdlib')

Returns:

  • (Any) —

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



7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
 
# File 'vendor_modules/stdlib/lib/puppet/parser/functions/get_module_path.rb', line 7

newfunction(:get_module_path, type: :rvalue, doc: <<-DOC
  @summary
    Returns the absolute path of the specified module for the current
    environment.

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

  @example Example Usage:
    $module_path = get_module_path('stdlib')

  > *Note:*
    that since Puppet 5.4.0 the  built-in
    [`module_directory`](https://puppet.com/docs/puppet/latest/function.html#module_directory)
    function in Puppet does the same thing and will return the path to the first found module
    if given multiple values or an array.
DOC
) do |args|
  raise(Puppet::ParseError, 'get_module_path(): Wrong number of arguments, expects one') unless args.size == 1
  module_path = Puppet::Module.find(args[0], compiler.environment.to_s)
  raise(Puppet::ParseError, "Could not find module #{args[0]} in environment #{compiler.environment}") unless module_path
  module_path.path
end