Puppet Function: validate_absolute_path

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

Summary

Validate the string represents an absolute path in the filesystem. This function works for windows and unix style paths.

Overview

validate_absolute_path() ⇒ Any

Examples:

*Usage*


The following values will pass:

    $my_path = 'C:/Program Files (x86)/Puppet Labs/Puppet'
    validate_absolute_path($my_path)
    $my_path2 = '/var/lib/puppet'
    validate_absolute_path($my_path2)
    $my_path3 = ['C:/Program Files (x86)/Puppet Labs/Puppet','C:/Program Files/Puppet Labs/Puppet']
    validate_absolute_path($my_path3)
    $my_path4 = ['/var/lib/puppet','/usr/share/puppet']
    validate_absolute_path($my_path4)

The following values will fail, causing compilation to abort:

    validate_absolute_path(true)
    validate_absolute_path('../var/lib/puppet')
    validate_absolute_path('var/lib/puppet')
    validate_absolute_path([ 'var/lib/puppet', '/var/foo' ])
    validate_absolute_path([ '/var/lib/puppet', 'var/foo' ])
    $undefined = undef
    validate_absolute_path($undefin

Returns:

  • (Any) —

    passes when the string is an absolute path or raise an error when it is not and fails compilation



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
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
 
# File 'vendor_modules/stdlib/lib/puppet/parser/functions/validate_absolute_path.rb', line 7

newfunction(:validate_absolute_path, doc: <<-DOC) do |args|
  @summary
    Validate the string represents an absolute path in the filesystem.  This function works
    for windows and unix style paths.

  @return
    passes when the string is an absolute path or raise an error when it is not and fails compilation

  @example **Usage**

    The following values will pass:

        $my_path = 'C:/Program Files (x86)/Puppet Labs/Puppet'
        validate_absolute_path($my_path)
        $my_path2 = '/var/lib/puppet'
        validate_absolute_path($my_path2)
        $my_path3 = ['C:/Program Files (x86)/Puppet Labs/Puppet','C:/Program Files/Puppet Labs/Puppet']
        validate_absolute_path($my_path3)
        $my_path4 = ['/var/lib/puppet','/usr/share/puppet']
        validate_absolute_path($my_path4)

    The following values will fail, causing compilation to abort:

        validate_absolute_path(true)
        validate_absolute_path('../var/lib/puppet')
        validate_absolute_path('var/lib/puppet')
        validate_absolute_path([ 'var/lib/puppet', '/var/foo' ])
        validate_absolute_path([ '/var/lib/puppet', 'var/foo' ])
        $undefined = undef
        validate_absolute_path($undefined)
  DOC

  require 'puppet/util'

  if args.empty?
    raise Puppet::ParseError, "validate_absolute_path(): wrong number of arguments (#{args.length}; must be > 0)"
  end

  args.each do |arg|
    # put arg to candidate var to be able to replace it
    candidates = arg
    # if arg is just a string with a path to test, convert it to an array
    # to avoid test code duplication
    unless arg.is_a?(Array)
      candidates = Array.new(1, arg)
    end
    # iterate over all paths within the candidates array
    candidates.each do |path|
      unless function_is_absolute_path([path])
        raise Puppet::ParseError, "#{path.inspect} is not an absolute path."
      end
    end
  end
end