3rdparty/modules/stdlib/lib/puppet/parser/functions/get_module_path.rb

   1 #
   2 # get_module_path.rb
   3 #
   4 module Puppet::Parser::Functions
   5   newfunction(:get_module_path, :type => :rvalue, :doc => <<-DOC
   6     @summary
   7       Returns the absolute path of the specified module for the current
   8       environment.
   9
  10     @return
  11       Returns the absolute path of the specified module for the current
  12       environment.
  13
  14     @example Example Usage:
  15       $module_path = get_module_path('stdlib')
  16
  17     > *Note:*
  18       that since Puppet 5.4.0 the  built-in
  19       [`module_directory`](https://puppet.com/docs/puppet/latest/function.html#module_directory)
  20       function in Puppet does the same thing and will return the path to the first found module
  21       if given multiple values or an array.
  22   DOC
  23              ) do |args|
  24     raise(Puppet::ParseError, 'get_module_path(): Wrong number of arguments, expects one') unless args.size == 1
  25     module_path = Puppet::Module.find(args[0], compiler.environment.to_s)
  26     raise(Puppet::ParseError, "Could not find module #{args[0]} in environment #{compiler.environment}") unless module_path
  27     module_path.path
  28   end
  29 end