augparse(1)

1AUGPARSE(1)                         Augeas                         AUGPARSE(1)
2
3
4

NAME

6       augparse - execute an Augeas module
7

SYNOPSIS

9       augparse [OPTIONS] MODULE
10

DESCRIPTION

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

OPTIONS

16       -I, --include=DIR
17           Add DIR to the module loadpath. Can be given multiple times. The
18           directories set here are searched before any directories specified
19           in the AUGEAS_LENS_LIB environment variable, and before the default
20           directory /usr/share/augeas/lenses.
21
22       -t, --trace
23           Print a trace of the modules that are being loaded.
24
25       --nostdinc
26           Do not search any of the default directories for modules. When this
27           option is set, only directories specified explicitly with -I or
28           specified in AUGEAS_LENS_LIB will be searched for modules.
29
30       --notypecheck
31           Do not perform lens type checks. Only use this option during lens
32           development and make sure you typecheck lenses when you are done
33           developing - you should never use a lens that hasn't been
34           typechecked. This option is sometimes useful when you are working
35           on unit tests for a lens to speed up the time it takes to
36           repeatedly run and fix tests.
37
38       --version
39           Print version information and exit.
40
41       -h  Display this help and exit
42

EXAMPLES

44       To run the tests in lenses/tests/test_foo.aug and use modules from the
45       directory lenses, run
46
47           augparse -I lenses lenses/tests/test_foo.aug
48

TESTS

50       Tests can appear as top-level forms anywhere in a module. Generally,
51       the tests for a module lenses/foo.aug are kept in a separate file,
52       usually in lenses/tests/test_foo.aug.
53
54       There are two different kinds of tests that Augeas can run: get and put
55       tests. The syntax for get tests is
56
57           test LENS get STRING = RESULT
58
59       which applies the get direction of the lens LENS to STRING and compares
60       it with the given RESULT. RESULT can either be a tree literal, the
61       symbol ? to print the result of applying LENS to STRING, or the symbol
62       * to indicate that the test should produce an exception.
63
64       The syntax for put tests is
65
66           test LENS put STRING after COMMANDS = RESULT
67
68       which first applies the get direction of the lens LENS to STRING, then
69       applies the given COMMANDS to the resulting tree, and finally
70       transforms the modified tree back to a string using the put direction
71       of LENS. The resulting string is then compared to RESULT, which can be
72       a string, the symbol ? to print the result of applying LENS to STRING,
73       or the symbol * to indicate that the test should produce an exception.
74

AUTHOR

76       David Lutterkort <lutter@watzmann.net>
77

COPYRIGHT AND LICENSE

79       Copyright 2007-2016 David Lutterkort
80
81       Augeas (and augparse) are distributed under the GNU Lesser General
82       Public License (LGPL)
83