1 \input texinfo @c -*-texinfo-*-
3 @setfilename etest.info
4 @settitle Emacs Testing Framework
8 * ETest: (etest). The Emacs Testing Framework
12 Copyright @copyright{} 2008 Philip Jackson.
14 Permission is granted to copy, distribute and/or modify this document
15 under the terms of the GNU Free Documentation License, Version 1.1 or
16 any later version published by the Free Software Foundation; with no
17 Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A
18 copy of the license is included in the section entitled "GNU Free
19 Documentation License".
24 @title ETest - The Emacs Testing Framework
27 @vskip 0pt plus 1filll
36 @node Top, Introduction, (dir), (dir)
40 * Introduction:: Introduction to ETest.
41 * Fetching ETest:: How to download ETest.
42 * Installation:: How to get emacs to wear ETest.
43 * Usage:: How to use ETest.
44 * The results buffer:: Display of test results.
45 * The Tests:: Functions available for testing.
49 @node Introduction, Fetching ETest, Top, Top
52 ETest (or etest, if you like) is the Emacs Testing Framework. It is a
53 small modular system for writing unit tests in Emacs Lisp.
55 At time of writing ETest consists of two files. @file{etest.el}
56 provides the core test functionality. It defines the function
57 (actually, macro) @code{etest} which is usually one's entrance into a
58 test run. The file @file{etest-result-mode.el} adds functions that
59 allow the visualisation of a run with syntax highlighting, folding and
62 @node Fetching ETest, Installation, Introduction, Top
63 @chapter Fetching ETest
65 At the time of writing you must download ETest using git:
67 @code{git clone http://repo.or.cz/r/ETest.git etest}
69 Though it will always be bleeding edge @code{master} should always be
70 in a @emph{working} state.
72 @node Installation, Usage, Fetching ETest, Top
75 To install ETest use one of the following methods:
77 @section Compiling ETest
79 Once you've fetched ETest change into the new directory and run
80 @code{make} if all goes well run @code{make install} (you may need
81 escalated privileges for this step).
83 @section Manual Installation
85 If you don't want to byte-compile for some reason then you can just
86 copy the @code{.el} files into a directory in your @var{load-path}.
88 If you would rather add the unpacked library @emph{to} your load path
89 then the following will work assuming the etest directory is in your
93 (add-to-list 'load-path "~/etest")
96 @node Usage, The results buffer, Installation, Top
99 First you must evaluate @code{(require 'etest)} then you can start
100 using the @code{etest} macro.
102 Using ETest is very simple. Once you have installed the modules then
103 you can simply run your first test like this:
110 This should pop up a results buffer showing you the outcome of the
111 run. In this case all should be ok because, well, 1 is a pass
112 according to the @code{ok} test.
115 * Example working practice:: How one might use etest.
118 @node Example working practice
119 @section Example working practice
121 Generally (at least the way I work) is to have a @code{.etest} file
122 which matches all but the extension of the filename of the file I am
123 to test. So if I were testing a file called @code{find-cmd.el} I would
124 write my tests in a file called @code{find-cmd.etest} (in the same
125 directory as @code{find-cmd.el}) and then when I hit @kbd{C-c t} (in
126 @code{emacs-lisp-mode}) the run would happen and the results pop up in
127 their normal fashion.
129 Thanks to @file{etest-execute.el} there are several options for the
130 location of an etest file (one at a time). In order of execution they
133 1. The buffer local variable @code{etest-file} is set to the filename
136 2. A matching etest file is in the directories listed in
137 @code{etest-load-path}.
139 3. A matching etest file is in the current working directory
140 (@code{default-directory}).
142 @node The results buffer, The Tests, Usage, Top
143 @chapter The results buffer
145 The results buffer is where you can see (and manipulate) the results
146 of a test run in a human friendly format. It will always popup when
147 etest is run and let you know how things went.
150 * Example output:: What the output looks like.
151 * Bindings:: What commands you have at your disposal.
154 @node Example output, Bindings, The results buffer, The results buffer
155 @section Example output
157 Given the hypothetical tests:
161 ("Numeric comparisons"
163 (ok (> 1 0) "one is more than 0")
164 (ok (< 1 0) "one is less than 0"))
167 (ok (< 1 -5.2) "one is less than 5.2"))))
171 Once run give us the following in the results buffer:
174 * Numeric comparisons
176 ok ................ one is more than 0
178 not ok ............ one is less than 0
181 ok ................ (ok (> 10 9.99))
183 not ok ............ one is less than 5.2
188 All headings are foldable as are comments.
190 @node Bindings, , Example output, The results buffer
196 Bury this results buffer.
198 @findex etest-rm-etest-rm-cycle-comments
199 Shift the values in @code{etest-rm-comment-visibility-types} and use
200 the @code{car} of that list to determine the visibility of comments.
202 @findex etest-rm-toggle-headline
203 Toggle the visibility of a heading or test comment.
206 @node The Tests, , The results buffer, Top
209 Tests are always run within the @code{etest} form and usually always
210 evaluate their arguments. Tests will always have a defined number of
211 required arguments (for example @code{ok} requires one argument. Each
212 test also allows for one optional argument which is a custom
213 documentation string. If this argument is omitted then ETest will
214 generate one in its place. So, for example, if you used
215 @code{(etest (ok 1))} the doc string would be @code{"(ok 1)"} if you used
216 @code{(etest (ok 1 "Foo"))} the doc string would be @code{"Foo"}.
219 * Test Structure:: Basic structure of tests.
220 * Builtin Simple Tests:: Boolean checks.
221 * Builtin Equality Tests:: Are two things similar?
222 * Builtin Error Tests:: Test exception handling.
223 * Builtin String Tests:: Check a string matches an RE.
224 * Defining your own tests:: Extend ETest.
227 @node Test Structure, Builtin Simple Tests, The Tests, The Tests
228 @section Test Structure
230 Tests can be grouped within headings by simply using a string as the
231 first element of a form like this:
240 You can nest headings to your hearts content.
242 This will produce a set of results that follow the same hierarchical
243 pattern as the tests themselves. For example the above produces the
248 (:result t :comments "got: '1'" :doc "(ok 1)")))
252 The output in the results buffer is:
256 ok ................. (ok 1)
260 @node Builtin Simple Tests, Builtin Equality Tests, Test Structure, The Tests
261 @section Builtin Simple Tests
263 These basic tests allow you, basically, to check if a value is either
268 @code{ok} will only pass if its argument produces a non-nil result.
277 @code{null} will only pass if its argument produces a nil result.
284 @node Builtin Equality Tests, Builtin Error Tests, Builtin Simple Tests, The Tests
285 @section Builtin Equality Tests
287 The following functions map to their lisp counterparts and so don't
288 really require much explanation. Evaluate each of the examples to
291 Each take two forms which, post evaluation, are the objects to
304 (etest (eql 1.1 1.1))
311 (etest (equal '(1 2) '(1 2)))
315 @node Builtin Error Tests, Builtin String Tests, Builtin Equality Tests, The Tests
316 @section Builtin Error Tests
318 These two functions each take one form.
322 This test will pass if an exception is raised. For example, cause a
323 divide by zero error (@code{(arith-error)}):
326 (etest (error (/ 1 0)))
332 This test will pass if no exception is raised. For example, a valid
333 division will not raise an error:
336 (etest (noerror (/ 0 1)))
340 @node Builtin String Tests, Defining your own tests, Builtin Error Tests, The Tests
341 @section Builtin String Tests
345 @code{like} takes two arguments a string and a regexp to test it against:
348 (etest (like "Hello" "^H\\(e\\)"))
352 Produces this in the results buffer:
355 ok .................. (like "Hello" "^H\\(e\\)")
361 The grouping within the regular expression only affects the comments.
363 @node Defining your own tests, , Builtin String Tests, The Tests
364 @section Defining your own tests
366 Defining your own tests is fairly trivial and where ETest becomes
369 Each test must return a plist that has @code{:result} and, optionally,
370 @code{:comments} in it.
372 @code{:result} represents whether the test passed or failed non-nil
373 for a pass and nil for a fail.
375 The optional @code{:comments} are newline separated strings that might
376 help the user in their diagnosis of a problem. Comments should follow
377 the conventions set by the 'builtin' tests using keywords such as
380 To have ETest recognise the test as valid the @code{deftest} function
381 should be used. For example if I wanted to create a function that
382 took two arguments and tested the first was numerically greater than
383 the other I might do this:
386 (defun etest-greater-than (one two)
387 (let* ((res (> one two)))
389 :comments (unless res
390 (format "one: '%d'\ntwo: '%d'" one two)))))
394 We let emacs take care of type errors (and any other type of error)
395 which is what all of the builtins do. Also it's worth noting that if
396 you want your arguments evaling you have to do it yourself.
398 Now we let ETest know this new function exists:
401 (deftest '(> 2) 'etest-greater-than)
405 So, the new function will be called @code{>}, it will take two arguments
406 and it calls maps to @code{etest-greater-than}.
409 (deftest '(> 2) 'etest-greater-than)
413 Now you can mix @code{>} with other tests:
418 (> 1 2 "one is more than two"))
422 Which in the results buffer produces:
425 ok .................. (ok "something")
427 not ok .............. one is more than two