1AUGPARSE(1) Augeas AUGPARSE(1)
2
3
4
6 augparse - execute an Augeas module
7
9 augparse [OPTIONS] MODULE
10
12 Execute an Augeas module, most commonly to evaluate the tests it
13 contains.
14
16 -I 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 --nostdinc
23 Do not search any of the default directories for modules. When this
24 option is set, only directories specified explicitly with -I or
25 specified in AUGEAS_LENS_LIB will be searched for modules.
26
27 --notypecheck
28 Do not perform lens type checks. Only use this option during lens
29 development and make sure you typecheck lenses when you are done
30 developing - you should never use a lens that hasn't been
31 typechecked. This option is sometimes useful when you are working
32 on unit tests for a lens to speed up the time it takes to
33 repeatedly run and fix tests.
34
35 --version
36 Print version information and exit.
37
38 -h Display this help and exit
39
41 To run the tests in lenses/tests/test_foo.aug and use modules from the
42 directory lenses, run
43
44 augparse -I lenses lenses/tests/test_foo.aug
45
47 Tests can appear as top-level forms anywhere in a module. Generally,
48 the tests for a module lenses/foo.aug are kept in a separate file,
49 usually in lenses/tests/test_foo.aug.
50
51 There are two different kinds of tests that Augeas can run: get and put
52 tests. The syntax for get tests is
53
54 test LENS get STRING = RESULT
55
56 which applies the get direction of the lens LENS to STRING and compares
57 it with the given RESULT. RESULT can either be a tree literal, the
58 symbol ? to print the result of applying LENS to STRING, or the symbol
59 * to indicate that the test should produce an exception.
60
61 The syntax for put tests is
62
63 test LENS put STRING after COMMANDS = RESULT
64
65 which first applies the get direction of the lens LENS to STRING, then
66 applies the given COMMANDS to the resulting tree, and finally
67 transforms the modified tree back to a string using the put direction
68 of LENS. The resulting string is then compared to RESULT, which can be
69 a string, the symbol ? to print the result of applying LENS to STRING,
70 or the symbol * to indicate that the test should produce an exception.
71
73 Augeas project homepage <http://www.augeas.net/>
74
75 augtool
76
77
78
79Augeas 0.10.0 2012-11-02 AUGPARSE(1)