AUGPARSE

NAME

augparse − execute an Augeas module

SYNOPSIS

augparse [ OPTIONS ] MODULE

DESCRIPTION

Execute an Augeas module, most commonly to evaluate the tests it contains.

OPTIONS

−I DIR

Add DIR to the module loadpath. Can be given multiple times. The directories set here are searched before any directories specified in the AUGEAS_LENS_LIB environment variable, and before the default directory /usr/share/augeas/lenses.

EXAMPLES

To run the tests in lenses/tests/test_foo.aug and use modules from the directory lenses, run

augparse −I lenses lenses/tests/test_foo.aug

TESTS

Tests can appear as top-level forms anywhere in a module. Generally, the tests for a module lenses/foo.aug are kept in a separate file, usually in lenses/tests/test_foo.aug.

There are two different kinds of tests that Augeas can run: get and put tests. The syntax for get tests is

test LENS get STRING = RESULT

which applies the get direction of the lens LENS to STRING and compares it with the given RESULT . RESULT can either be a tree literal, the symbol ? to print the result of applying LENS to STRING , or the symbol * to indicate that the test should produce an exception.

The syntax for put tests is

test LENS put STRING after COMMANDS = RESULT

which first applies the get direction of the lens LENS to STRING , then applies the given COMMANDS to the resulting tree, and finally transforms the modified tree back to a string using the put direction of LENS . The resulting string is then compared to RESULT , which can be a string, the symbol ? to print the result of applying LENS to STRING , or the symbol * to indicate that the test should produce an exception.

SEE ALSO

Augeas project homepage <http://www.augeas.net/>

augtool