tests: Add documentation, make interactive debugging possible.
[gnupg.git] / tests / openpgp / README
1 #                                   Emacs, this is an -*- org -*- file.
2
3 * How to run the test suite
4 From your build directory, run
5
6   obj $ make -C tests/openpgp check
7
8 to run all tests or
9
10   obj $ make -C tests/openpgp check XTESTS=your-test.scm
11
12 to run a specific test (or any number of tests separated by spaces).
13
14 If you want to debug a test, add verbose=1 to see messages printed by
15 spawned programs to their standard error stream, verbose=2 to see what
16 programs are executed, or verbose=3 to see even more program output
17 and exit codes.
18
19 ** Passing options to the test driver
20
21 You can set TESTFLAGS to pass flags to 'run-tests.scm'.  For example,
22 to speed up the test suite when bisecting, do
23
24   obj $ make -C tests/openpgp check TESTFLAGS=--parallel
25
26 See below for the arguments supported by the driver.
27
28 ** Calling the test driver directly
29 This is a bit tricky because one needs to manually set some
30 environment variables.  We should make that easier.  See discussion
31 below.  From your build directory, do:
32
33   obj $ TMP=/tmp srcdir=<path to>/tests/openpgp \
34         GPGSCM_PATH=<path to>/tests/gpgscm:<path to>/tests/openpgp \
35         $(pwd)/tests/gpgscm/gpgscm [gpgscm args] \
36         run-tests.scm [test suite runner args]
37
38 *** Arguments supported by the test suite runner
39 The test suite runner supports four modes of operation,
40 {sequential,parallel}x{isolated,shared}.  You can select the mode of
41 operation using a combination of the flags --parallel, --sequential,
42 --shared, and --isolated.
43
44 By default the tests are run in sequential order, each one in a clean
45 environment.
46
47 You can specify the tests to run as positional arguments relative to
48 srcdir (e.g. just 'version.scm').  By default all tests listed in
49 run-tests.scm are executed.  Note that you do not have to specify
50 setup.scm and finish.scm, they are executed implicitly.
51
52 The test suite runner can be executed in any location that the current
53 user can write to.  It will create temporary files and directories,
54 but will in general clean up all of them.
55 *** Discussion of the various environment variables
56 **** srcdir
57 Must be set to the source of the openpgp test suite.  Used to locate
58 data files.
59 **** GPGSCM_PATH
60 Used to locate the Scheme library as well as code used by the test
61 suite.
62 **** BIN_PREFIX
63 The test suite does not hardcode any paths to tools.  If set it is
64 used to locate the tools to test, otherwise the test suite assumes to
65 be run from the build directory.
66 **** MKTDATA and GPG_PRESET_PASSPHRASE
67 These two tools are not installed by 'make install', hence we need to
68 explicitly override their position.  In fact, the location of any tool
69 used by the test suite can be overridden this way.  See defs.scm.
70 **** argv[0]
71 run-tests.scm depends on being able to re-exec gpgscm.  It uses
72 argv[0] for that.  Therefore you must use an absolute path to invoke
73 gpgscm.
74 * How to write tests
75 gpgscm provides a number of functions to aid you in writing tests, as
76 well as bindings to process management abstractions provided by GnuPG.
77 For the Scheme environment provided by TinySCHEME, see the TinySCHEME
78 manual that is included in tests/gpgscm/Manual.txt.
79
80 For a quick start, please have a look at various tests that are
81 already implemented, e.g. 'encrypt.scm'.
82 ** The test framework
83 The functions info, error, and skip display their first argument and
84 flush the output buffers.  error and skip will also terminate the
85 process, signaling that the test failed or should be skipped.
86
87 (for-each-p msg proc list) will display msg, and call proc with each
88 element of list while displaying the progress appropriately.
89 for-each-p' is similar, but accepts another callback before the 'list'
90 argument to format each item.  for-each-p can be safely nested, and
91 the inner progress indicator will be abbreviated using '.'.
92 ** Debugging tests
93
94 Say you are working on a new test called 'your-test.scm', you can run
95 it on its own using
96
97   obj $ make -C tests/openpgp check XTESTS=your-test.scm
98
99 but something isn't working as expected.  There are several little
100 gadgets that might help.  The first one is 'trace', a function that
101 prints the value given to it and evaluates to it.  E.g.
102
103   (trace (+ 2 3))
104
105 prints '5' and evaluates to 5.  Also, there is an 'assert' macro that
106 aborts the execution if its argument does not evaluate to a trueish
107 value.  Feel free to express invariants with it.
108
109 You can also get an interactive repl by dropping
110
111   (interactive-repl (current-environment))
112
113 anywhere you like.
114
115 ** Interfacing with gpg
116
117 defs.scm defines several convenience functions.  Say you want to parse
118 the colon output from gpg, there is gpg-with-colons that splits the
119 result at newlines and colons, so you can use the result like this:
120
121  (define (fpr some-key)
122    (list-ref (assoc "fpr" (gpg-with-colons
123                            `(--with-fingerprint
124                              --list-secret-keys ,some-key)))
125              9))
126
127 Or if you want to count all non-revoked uids for a given key, do
128
129  (define (count-uids-of-secret-key some-key)
130    (length (filter (lambda (x) (and (string=? "uid" (car x))
131                                     (string=? "u" (cadr x))))
132                    (gpg-with-colons
133                     `(--with-fingerprint
134                       --list-secret-keys ,some-key)))))
135
136 ** Temporary files
137 (lettmp <bindings> <body>) will create and delete temporary files that
138 you can use in <body>.  (with-temporary-working-directory <body>) will
139 create a temporary director, change to that, and clean it up after
140 executing <body>).
141
142 make-temporary-file will create a temporary file.  You can optionally
143 provide an argument to that function that will serve as tag so you can
144 distinguish the files for debugging.  remove-temporary-file will
145 delete a file created using make-temporary-file.
146
147 ** Monadic transformer and pipe support
148 Tests often perform sequential transformations on files, or connect
149 processes using pipes.  To aid you in this, the test framework
150 provides two monadic data structures.
151
152 (Currently, the implementation mashes the 'bind' operation together
153 with the application of the monad.  Also, there is no 'return'
154 operation.  I guess all of that could be implemented on top of
155 call/cc, but it isn't at the moment.)
156 *** pipe
157 The pipe monad constructs pipe lines.  It consists of a function
158 pipe:do that binds the functions together and manages the execution of
159 the child processes, a family of functions that act as sources, a
160 function to spawn processes, and a family of functions acting as
161 sinks.
162
163 Sources are pipe:open, pipe:defer, pipe:echo.  To spawn a process use
164 pipe:spawn, or the convenience function pipe:gpg.  To sink the data
165 use pipe:splice, or pipe:write-to.
166
167 Example:
168
169   (pipe:do
170     (pipe:echo "3\n1\n2\n")
171     (pipe:spawn '("/usr/bin/sort"))
172     (pipe:write-to "sorted" (logior O_WRONLY O_CREAT) #o600))
173
174 Caveats: Due to the single-threaded nature of gpgscm you cannot use
175 both a source and sink that is implemented in Scheme.  pipe:defer and
176 pipe:echo are executing in gpgscm, and so does pipe:splice.
177 *** tr
178 The transformer monad describes sequential file transformations.
179
180 There is one source function, tr:open.  To describe a transformation
181 using some process, use tr:spawn, tr:gpg, or tr:pipe-do.  There are
182 several sinks, although sink is not quite the right term, because the
183 data is not consumed, and hence one can use them at any position.  The
184 "sinks" are tr:write-to, tr:call-with-content, tr:assert-identity, and
185 tr:assert-weak-identity.
186
187 A somewhat contrived example demonstrating many functions is:
188
189   (tr:do
190     (tr:pipe-do
191       (pipe:echo "3\n1\n2\n")
192       (pipe:spawn '("/usr/bin/sort")))
193     (tr:write-to "reference")
194     (tr:call-with-content
195      (lambda (c)
196        (echo "currently, c contains" (string-length c) "bytes")))
197     (tr:spawn "" '("/usr/bin/gcc" -x c "-E" -o **out** **in**))
198     (tr:pipe-do
199       (pipe:spawn '("/bin/grep" -v "#")))
200     (tr:assert-identity "reference"))
201
202 Caveats: As a convenience, gpgscm allows one to specify command line
203 arguments as Scheme symbols.  Scheme symbols, however, are
204 case-insensitive, and get converted to lower case.  Therefore, the -E
205 argument must be given as a string in the example above.  Similarly,
206 you need to quote numerical values.
207 ** Process management
208 If you just need to execute a single command, there is (call-with-fds
209 cmdline infd outfd errfd) which executes cmdline with the given file
210 descriptors bound to it, and waits for its completion returning the
211 status code.  There is (call cmdline) which is similar, but calls the
212 command with a closed stdin, connecting stdout and stderr to stderr if
213 gpgscm is executed with --verbose.  (call-check cmdline) raises an
214 exception if the command does not return 0.
215
216 (call-popen cmdline input) calls a command, writes input to its stdin,
217 and returns any output from stdout, or raises an exception containing
218 stderr on failure.
219 * Sample messages