Puppet Function: validate_augeas

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

Summary

Perform validation of a string using an Augeas lens

Overview

validate_augeas() ⇒ Any

The first argument of this function should be a string to test, and the second argument should be the name of the Augeas lens to use. If Augeas fails to parse the string with the lens, the compilation will abort with a parse error.

A third argument can be specified, listing paths which should not be found in the file. The `$file` variable points to the location of the temporary file being tested in the Augeas tree.

Examples:

*Usage*


If you want to make sure your passwd content never contains
a user `foo`, you could write:

  validate_augeas($passwdcontent, 'Passwd.lns', ['$file/foo'])

If you wanted to ensure that no users used the '/bin/barsh' shell,
you could use:

  validate_augeas($passwdcontent, 'Passwd.lns', ['$file/*[shell="/bin/barsh"]']

If a fourth argument is specified, this will be the error message raised and
seen by the user.

A helpful error message can be returned like this:

  validate_augeas($sudoerscontent, 'Sudoers.lns', [], 'Failed to validate sudoers content with Augeas')

Returns:

  • (Any) —

    validate string using an Augeas lens



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
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'vendor_modules/stdlib/lib/puppet/parser/functions/validate_augeas.rb', line 9

newfunction(:validate_augeas, doc: <<-DOC
  @summary
    Perform validation of a string using an Augeas lens

  The first argument of this function should be a string to
  test, and the second argument should be the name of the Augeas lens to use.
  If Augeas fails to parse the string with the lens, the compilation will
  abort with a parse error.

  A third argument can be specified, listing paths which should
  not be found in the file. The `$file` variable points to the location
  of the temporary file being tested in the Augeas tree.

  @return
    validate string using an Augeas lens

  @example **Usage**

    If you want to make sure your passwd content never contains
    a user `foo`, you could write:

      validate_augeas($passwdcontent, 'Passwd.lns', ['$file/foo'])

    If you wanted to ensure that no users used the '/bin/barsh' shell,
    you could use:

      validate_augeas($passwdcontent, 'Passwd.lns', ['$file/*[shell="/bin/barsh"]']

    If a fourth argument is specified, this will be the error message raised and
    seen by the user.

    A helpful error message can be returned like this:

      validate_augeas($sudoerscontent, 'Sudoers.lns', [], 'Failed to validate sudoers content with Augeas')

  DOC
) do |args|
  unless Puppet.features.augeas?
    raise Puppet::ParseError, 'validate_augeas(): this function requires the augeas feature. See http://docs.puppetlabs.com/guides/augeas.html#pre-requisites for how to activate it.'
  end

  if (args.length < 2) || (args.length > 4)
    raise Puppet::ParseError, "validate_augeas(): wrong number of arguments (#{args.length}; must be 2, 3, or 4)"
  end

  msg = args[3] || "validate_augeas(): Failed to validate content against #{args[1].inspect}"

  require 'augeas'
  aug = Augeas.open(nil, nil, Augeas::NO_MODL_AUTOLOAD)
  begin
    content = args[0]

    # Test content in a temporary file
    tmpfile = Tempfile.new('validate_augeas')
    begin
      tmpfile.write(content)
    ensure
      tmpfile.close
    end

    # Check for syntax
    lens = args[1]
    aug.transform(
      lens: lens,
      name: 'Validate_augeas',
      incl: tmpfile.path,
    )
    aug.load!

    unless aug.match("/augeas/files#{tmpfile.path}//error").empty?
      error = aug.get("/augeas/files#{tmpfile.path}//error/message")
      msg += " with error: #{error}"
      raise Puppet::ParseError, msg
    end

    # Launch unit tests
    tests = args[2] || []
    aug.defvar('file', "/files#{tmpfile.path}")
    tests.each do |t|
      msg += " testing path #{t}"
      raise Puppet::ParseError, msg unless aug.match(t).empty?
    end
  ensure
    aug.close
    tmpfile.unlink
  end
end