/usr/share/doc/ptester/tester.html is in cl-ptester 2.1.2-6.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 | <html><head><title>The Allegro CL Test harness</title></head><body><table border="0" width="100%" cellpadding="1" cellspacing="0"><tr><td colspan="2" bgcolor="#00FFFF"><table border="0" cellpadding="5" cellspacing="3"><tr><td align="left" bgcolor="#00FFFF"><a href="contents.htm"><b>ToC</b></a></td><td align="left" bgcolor="#00FFFF"><a href="introduction.htm"><b>DocOverview</b></a></td><td align="left" bgcolor="#00FFFF"><a href="cgide.htm"><b>CGDoc</b></a></td><td align="left" bgcolor="#00FFFF"><a href="release-notes.htm"><b>RelNotes</b></a></td><td align="left" bgcolor="#00FFFF"><a href="index.htm"><b>Index</b></a></td><td align="left" bgcolor="#00FFFF"><a href="permuted-index.htm"><b>PermutedIndex</b></a></td></tr></table></td><td align="right"><b>Allegro CL version 6.1</b><br><small><a href="introduction.htm#updates-s">Unrevised</a></small></td></tr></table><h1>The Allegro CL Test harness</h1><p>This document contains the following sections:</p><a href="#tester-api-1">1.0 The tester module API</a><br> <a href="#tester-vars-2">1.1 Test Harness Variables</a><br> <a href="#tester-macros-2">1.2 Test Harness Macros</a><br> <a href="#tester-examples-2">1.3 Examples</a><br><p>
ANSI Common Lisp contains no functionality designed specifically for
testing applications. Because testing is an essential part of
application development, Franz Inc. is making public the test harness
used internally for testing Allegro CL itself. (A test harness is a
collection of macros and variables associated with testing, along with
templates for test forms.)
</p><p>
The test harness facility was added to Allegro CL in release 6.0. (It
was available as a patch for release 5.0.1).
</p><p>
To use the test harness, you must load the
<i>tester.fasl</i> module. Do this by evaluating
</p><pre>
(require :tester)
</pre><hr><hr><h2><a name="tester-api-1">1.0 The tester module API</a></h2>
<p>
All of the following symbols are exported from the
<code>util.test</code> package.
</p>
<hr><h2><a name="tester-vars-2">1.1 Test Harness Variables</a></h2>
<p>
The test harness API includes the following variables, each described
fully on its own page and briefly here.
</p>
<ul>
<li>
<a href="pages/variables/util.test/s_break-on-test-failures_s.htm"><code>*break-on-test-failures*</code></a>:
If true, <a href="../ansicl/dictentr/break.htm"><b>break</b></a> is called when
a test fails.
</li>
<li>
<a href="pages/variables/util.test/s_error-protect-tests_s.htm"><code>*error-protect-tests*</code></a>: If true, errors
(other than in a test-error form) will be considered a failure and
testing continues.
</li>
<li>
<a href="pages/variables/util.test/s_test-errors_s.htm"><code>*test-errors*</code></a>:
The value is the number of test errors which have occurred.
</li>
<li>
<a href="pages/variables/util.test/s_test-successes_s.htm"><code>*test-successes*</code></a>:
The value is the number of test successes which have occurred.
</li>
<li>
<a href="pages/variables/util.test/s_test-unexpected-failures_s.htm"><code>*test-unexpected-failures*</code></a>:
The value is the number of unexpected test failures which have occurred.
</li>
</ul>
<hr><h2><a name="tester-macros-2">1.2 Test Harness Macros</a></h2>
<p>
These macros wrap around a form to be tested and supply the expected
value (for the test macro) or the expected behavior, which is encoded
in the macro name (e.g. test-error). For example:
</p>
<pre>
(test 1 (+ 0 1)) ;; (testing that the result of (+ 0 1) is
;; the fixnum 1)
(test-error (+ 1 "2")) ;; (testing that an error is
;; signaled when a string is
;; passed as an argument to +)
</pre>
<p>
Many more examples are given below.
</p>
<p>
<a href="pages/operators/util.test/with-tests.htm"><b>with-tests</b></a> wraps around
a collection of <strong>test</strong> or <strong>test-*</strong>
forms.
</p>
<p>
Note that many of the macros have <em>fail-info</em> and
<em>known-failure</em> keyword arguments.
</p>
<ul>
<li><em>fail-info</em>, if non-nil, should be a string that will be printed if the test
fails. Typical strings provide information about what is being tested, such as "This
is bug2075".</li>
<li><em>known-failure</em>, if non-nil, affects what is printed when the test fails or
succeeds. Thus a failure is reported as "Test failed: known failure: ..." and a
success as "Expected test failure for [...] did not occur."</li>
</ul>
<p>
Each macro is described briefly here and fully on its documentation page.
</p>
<ul>
<li>
<p>
<a href="pages/operators/util.test/test.htm"><b>test</b></a>
</p>
<p><b>Arguments: </b><i>
expected-value test-form
</i>&key <i></i> (<i>test</i> #'eql)<i> multiple-values fail-info known-failure</i><i>
</i></p>
<p>
Perform a single test and compare <i>expected-value</i>
with the value actually returned by <i>test-form</i>.
</p>
</li>
<li>
<p>
<a href="pages/operators/util.test/test-error.htm"><b>test-error</b></a>
</p>
<p><b>Arguments: </b><i>
form
</i>&key <i>announce catch-breaks fail-info known-failure</i> (<i>condition-type</i> 'simple-error)<i> include-subtypes format-control format-arguments</i><i>
</i></p>
<p>
Perform a single test to see whether
<i>form</i> signals an error.
</p>
</li>
<li>
<p>
<a href="pages/operators/util.test/test-no-error.htm"><b>test-no-error</b></a>
</p>
<p><b>Arguments: </b><i>
form
</i>&key <i>announce catch-breaks fail-info known-failure</i><i>
</i></p>
<p>
Perform a single test to see that
<i>form</i> does not signal an error.
</p>
</li>
<li>
<p>
<a href="pages/operators/util.test/test-warning.htm"><b>test-warning</b></a>
</p>
<p><b>Arguments: </b><i>
form
</i>&key <i>fail-info known-failure</i><i>
</i></p>
<p>
Perform a single test to see that
<i>form</i> signals a warning.
</p>
</li>
<li>
<p>
<a href="pages/operators/util.test/test-no-warning.htm"><b>test-no-warning</b></a>
</p>
<p><b>Arguments: </b><i>
form
</i>&key <i>fail-info known-failure</i><i>
</i></p>
<p>
Perform a single test to see that
<i>form</i> does not signal a warning.
</p>
</li>
<li>
<p>
<a href="pages/operators/util.test/with-tests.htm"><b>with-tests</b></a>
</p>
<p><b>Arguments: </b><i>
(</i>&key <i></i> (<i>name</i> "unnamed")<i>)
</i> &body <i>body</i><i>
</i></p>
<p>
Evaluates
<i>body</i>, which should be a list of test forms,
and reports on the results.
</p>
</li>
</ul>
<hr><h2><a name="tester-examples-2">1.3 Examples</a></h2>
<p>
The following are simple examples using the test harness. The test
forms themselves are trivial, and the purpose is to indicate the
behavior of the test harness macros.
</p>
<pre>
user(1): (require :tester)
; Fasl loading .../tester.fasl
t
user(2): (use-package :util.test)
t
user(3): (test 1 1)
t
user(4): (test 1 2)
* * * UNEXPECTED TEST FAILURE * * *
Test failed: 2
wanted: 1
got: 2
nil
user(5): (defun foo (x) x)
foo
user(6): (test 1 (foo 1))
t
user(7): (test 1 (foo 2))
* * * UNEXPECTED TEST FAILURE * * *
Test failed: (foo 2)
wanted: 1
got: 2
nil
user(8): (setq *break-on-test-failures* t)
t
user(9): (test 1 (foo 2))
* * * UNEXPECTED TEST FAILURE * * *
Test failed: (foo 2)
wanted: 1
got: 2
Break: *break-on-test-failures* is non-nil.
Restart actions (select using :continue):
0: return from break.
1: Return to Top Level (an "abort" restart)
2: Abort #<process Initial Lisp Listener>
[1c] user(10): :pop
user(11): (setq *break-on-test-failures* nil)
nil
user(12): (test 1 (error "foo"))
Error: foo
Restart actions (select using :continue):
0: Return to Top Level (an "abort" restart)
1: Abort #<process Initial Lisp Listener>
[1] user(13): :pop
user(14): (setq *error-protect-tests* t)
t
user(15): (test 1 (error "foo"))
Condition type: simple-error
Message: foo
* * * UNEXPECTED TEST FAILURE * * *
Test failed: (error "foo")
Reason: an error (of type `simple-error') was detected.
nil
user(16): (setq *error-protect-tests* nil)
nil
user(17): *test-errors*
4
user(18): *test-successes*
2
user(19): (test 1 2 :known-failure t)
Test failed: known failure: 2
wanted: 1
got: 2
nil
user(20): (test 1 (foo 1) :known-failure t)
Expected test failure for (foo 1) did not occur.
nil
user(21): (test 1 (foo 1) :known-failure t :fail-info "This is bug666.")
Expected test failure for (foo 1) did not occur.
Additional info: This is bug666.
nil
user(22): (test-error (error "foo"))
t
user(23): (test-no-error (error "foo"))
* * * UNEXPECTED TEST FAILURE * * *
Test failed: (error "foo")
Reason: detected an unexpected error of type `simple-error'.
nil
user(24): (test-error (car '(10)))
* * * UNEXPECTED TEST FAILURE * * *
Test failed: (car '(10))
Reason: expected but did not detect an error of type `condition'.
nil
user(25): (test-no-error (car '(10)))
t
user(26): (test-warning (warn "foo"))
t
user(27): (test-no-warning (warn "foo"))
* * * UNEXPECTED TEST FAILURE * * *
Test failed: (warn "foo")
wanted: no warning
got: a warning
nil
user(28): (test-warning (car '(10)))
* * * UNEXPECTED TEST FAILURE * * *
Test failed: (car '(10))
wanted: a warning
got: no warning
nil
user(29): (test-no-warning (car '(10)))
t
user(30): (test-error (error "foo: ~a" 10))
t
user(31): (test-error (error "foo: ~a" 10) :format-control "foo: ~a")
t
user(32): (test-error (error "foo: ~a" 10) :format-control "foo: ~a"
:format-arguments '(10))
t
user(33): (test-error (error "foo: ~a" 10) :format-control "foo: ~a")
* * * UNEXPECTED TEST FAILURE * * *
Test failed: (error "foo: ~a" 10)
Reason: the format-control was incorrect.
wanted: "~1@<foo: ~a~:@>"
got: "~1@<foo: ~a~:@>"
nil
user(34): (test-error (error "foo: ~a" 10) :format-control "foo: ~a"
:format-arguments '(11))
* * * UNEXPECTED TEST FAILURE * * *
Test failed: (error "foo: ~a" 10)
Reason: the format-arguments were incorrect.
wanted: (10)
got: (11)
nil
user(35): (test-error (error "foo: ~a" 10) :condition-type 'condition
:include-subtypes t)
t
user(36): (test-error (error "foo: ~a" 10) :condition-type 'simple-break
:include-subtypes t)
* * * UNEXPECTED TEST FAILURE * * *
Test failed: (error "foo: ~a" 10)
Reason: detected an incorrect condition type.
wanted: simple-break
got: #<standard-class simple-error>
nil
user(37): (test-error (break "foo: ~a" 10) :condition-type 'simple-break
:include-subtypes t)
Break: foo: 10
[condition type: simple-break]
Restart actions (select using :continue):
0: return from break.
1: Return to Top Level (an "abort" restart)
2: Abort #<process Initial Lisp Listener>
[1c] user(38): :pop
user(39): (test-error (break "foo: ~a" 10) :catch-breaks t
:condition-type 'simple-break :include-subtypes t)
t
</pre>
</body><hr><p><small>Copyright (c) 1998-2001, Franz Inc. Berkeley, CA., USA. All rights reserved.</small><br><small>Documentation for Allegro CL version 6.1 update # 1. This page was not revised.</small><br><small>Created 2001.12.15.</small></p><table border="0" width="100%" cellpadding="1" cellspacing="0"><tr><td colspan="2" bgcolor="#00FFFF"><table border="0" cellpadding="5" cellspacing="3"><tr><td align="left" bgcolor="#00FFFF"><a href="contents.htm"><b>ToC</b></a></td><td align="left" bgcolor="#00FFFF"><a href="introduction.htm"><b>DocOverview</b></a></td><td align="left" bgcolor="#00FFFF"><a href="cgide.htm"><b>CGDoc</b></a></td><td align="left" bgcolor="#00FFFF"><a href="release-notes.htm"><b>RelNotes</b></a></td><td align="left" bgcolor="#00FFFF"><a href="index.htm"><b>Index</b></a></td><td align="left" bgcolor="#00FFFF"><a href="permuted-index.htm"><b>PermutedIndex</b></a></td></tr></table></td><td align="right"><b>Allegro CL version 6.1</b><br><small><a href="introduction.htm#updates-s">Unrevised</a></small></td></tr></table></html>
|