Puppet Function: is_absolute_path

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

Overview

is_absolute_path() ⇒ Any

Returns boolean true if the string represents an absolute path in the filesystem. This function works for windows and unix style paths.

The following values will return true:

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

The following values will return false:

is_absolute_path(true)
is_absolute_path('../var/lib/puppet')
is_absolute_path('var/lib/puppet')
$undefined = undef
is_absolute_path($undefined)

Returns:

  • (Any) 


2
3
4
5
6
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
 
# File 'puppet/modules/stdlib/lib/puppet/parser/functions/is_absolute_path.rb', line 2

newfunction(:is_absolute_path, :type => :rvalue, :arity => 1, :doc => <<-'ENDHEREDOC') do |args|
  Returns boolean true if the string represents an absolute path in the filesystem.  This function works
  for windows and unix style paths.

  The following values will return true:

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

  The following values will return false:

      is_absolute_path(true)
      is_absolute_path('../var/lib/puppet')
      is_absolute_path('var/lib/puppet')
      $undefined = undef
      is_absolute_path($undefined)

ENDHEREDOC
  function_deprecation([:is_absolute_path, 'This method is deprecated, please use the stdlib validate_legacy function, with Stdlib::Compat::Absolute_path. There is further documentation for validate_legacy function in the README.'])
  require 'puppet/util'

  path = args[0]
  # This logic was borrowed from
  # [lib/puppet/file_serving/base.rb](https://github.com/puppetlabs/puppet/blob/master/lib/puppet/file_serving/base.rb)
  # Puppet 2.7 and beyond will have Puppet::Util.absolute_path? Fall back to a back-ported implementation otherwise.
  if Puppet::Util.respond_to?(:absolute_path?) then
    value = (Puppet::Util.absolute_path?(path, :posix) or Puppet::Util.absolute_path?(path, :windows))
  else
    # This code back-ported from 2.7.x's lib/puppet/util.rb Puppet::Util.absolute_path?
    # Determine in a platform-specific way whether a path is absolute. This
    # defaults to the local platform if none is specified.
    # Escape once for the string literal, and once for the regex.
    slash = '[\\\\/]'
    name = '[^\\\\/]+'
    regexes = {
      :windows => %r!^(([A-Z]:#{slash})|(#{slash}#{slash}#{name}#{slash}#{name})|(#{slash}#{slash}\?#{slash}#{name}))!i,
      :posix => %r!^/!
    }
    value = (!!(path =~ regexes[:posix])) || (!!(path =~ regexes[:windows]))
  end
  value
end