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
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
|
<html>
<head>
<title>test-is API reference (clojure-contrib)</title>
<link href="static/favicon.png" rel="icon" />
<link href="static/favicon.png" rel="shortcut icon" />
<link media="all" type="text/css" href="static/clojure.css" rel="stylesheet" />
<link media="all" type="text/css" href="static/wiki.css" rel="stylesheet" />
<link media="all" type="text/css" href="static/internal.css" rel="stylesheet" />
<!-- TODO: are we using these (from clojure.org)? If so, add the files -->
<script src="file/view/code_highlighter.js" type="text/javascript"></script>
<script src="file/view/clojure.js" type="text/javascript"></script>
<style>.menuWrapper{height: 36px;}</style>
<!--[if lte IE 6]>
<link rel="stylesheet" href="http://www.wikispaces.com/_/2009051601/s/internal_ie.css" type="text/css" />
<![endif]-->
</head>
<!--
This document was auto-generated from the source by the clojure autodoc system.
To report errors or ask questions about the overall documentation structure, formatting,
etc., contact Tom Faulhaber (google mail name: tomfaulhaber).
For errors in the documentation of a particular namespace, contact the author of that
namespace.
-->
<body>
<div id="AllContentContainer">
<div id="Header">
<a id="Logo" href="index.html"><img alt="Clojure" height="100" width="100" src="static/clojure-icon.gif" /></a>
<h1><a title="page header title" id="page-header" href="index.html">Clojure-contrib API Reference</a></h1>
</div>
<div id="leftcolumn"><div style="text-align: center;"></div>
<div class="menu">
<div class="WikiCustomNav WikiElement wiki">
<div class="BranchTOC">
<a class="wiki_link" href="#">Branches</a>
<ul id="left-sidebar-branch-list">
<li><a href="index.html" class="wiki_link">master</a></li><li><a href="branch-1.1.x/index.html" class="wiki_link">1.1.x</a></li>
</ul>
</div>
<a class="wiki_link" href="index.html">Overview</a><br />
<a class="wiki_link" href="api-index.html">API Index</a><br />
<a class="wiki_link" href="#">Namespaces:</a>
<ul id="left-sidebar-list">
<li><a href="accumulators-api.html" class="wiki_link">accumulators</a></li><li><a href="agent-utils-api.html" class="wiki_link">agent-utils</a></li><li><a href="apply-macro-api.html" class="wiki_link">apply-macro</a></li><li><a href="base64-api.html" class="wiki_link">base64</a></li><li><a href="classpath-api.html" class="wiki_link">classpath</a></li><li><a href="combinatorics-api.html" class="wiki_link">combinatorics</a></li><li><a href="command-line-api.html" class="wiki_link">command-line</a></li><li><a href="complex-numbers-api.html" class="wiki_link">complex-numbers</a></li><li><a href="cond-api.html" class="wiki_link">cond</a></li><li><a href="condition-api.html" class="wiki_link">condition</a></li><li><a href="core-api.html" class="wiki_link">core</a></li><li><a href="dataflow-api.html" class="wiki_link">dataflow</a></li><li><a href="datalog-api.html" class="wiki_link">datalog</a></li><li><a href="def-api.html" class="wiki_link">def</a></li><li><a href="duck-streams-api.html" class="wiki_link">duck-streams</a></li><li><a href="error-kit-api.html" class="wiki_link">error-kit</a></li><li><a href="except-api.html" class="wiki_link">except</a></li><li><a href="fcase-api.html" class="wiki_link">fcase</a></li><li><a href="find-namespaces-api.html" class="wiki_link">find-namespaces</a></li><li><a href="fnmap-api.html" class="wiki_link">fnmap</a></li><li><a href="gen-html-docs-api.html" class="wiki_link">gen-html-docs</a></li><li><a href="generic.arithmetic-api.html" class="wiki_link">generic.arithmetic</a></li><li><a href="generic.collection-api.html" class="wiki_link">generic.collection</a></li><li><a href="generic.comparison-api.html" class="wiki_link">generic.comparison</a></li><li><a href="generic.functor-api.html" class="wiki_link">generic.functor</a></li><li><a href="generic.math-functions-api.html" class="wiki_link">generic.math-functions</a></li><li><a href="graph-api.html" class="wiki_link">graph</a></li><li><a href="greatest-least-api.html" class="wiki_link">greatest-least</a></li><li><a href="http.agent-api.html" class="wiki_link">http.agent</a></li><li><a href="http.connection-api.html" class="wiki_link">http.connection</a></li><li><a href="import-static-api.html" class="wiki_link">import-static</a></li><li><a href="io-api.html" class="wiki_link">io</a></li><li><a href="jar-api.html" class="wiki_link">jar</a></li><li><a href="java-utils-api.html" class="wiki_link">java-utils</a></li><li><a href="javadoc.browse-api.html" class="wiki_link">javadoc.browse</a></li><li><a href="jmx-api.html" class="wiki_link">jmx</a></li><li><a href="json-api.html" class="wiki_link">json</a></li><li><a href="lazy-seqs-api.html" class="wiki_link">lazy-seqs</a></li><li><a href="lazy-xml-api.html" class="wiki_link">lazy-xml</a></li><li><a href="logging-api.html" class="wiki_link">logging</a></li><li><a href="macro-utils-api.html" class="wiki_link">macro-utils</a></li><li><a href="macros-api.html" class="wiki_link">macros</a></li><li><a href="map-utils-api.html" class="wiki_link">map-utils</a></li><li><a href="math-api.html" class="wiki_link">math</a></li><li><a href="miglayout-api.html" class="wiki_link">miglayout</a></li><li><a href="mmap-api.html" class="wiki_link">mmap</a></li><li><a href="mock-api.html" class="wiki_link">mock</a></li><li><a href="monadic-io-streams-api.html" class="wiki_link">monadic-io-streams</a></li><li><a href="monads-api.html" class="wiki_link">monads</a></li><li><a href="ns-utils-api.html" class="wiki_link">ns-utils</a></li><li><a href="pprint-api.html" class="wiki_link">pprint</a></li><li><a href="probabilities.finite-distributions-api.html" class="wiki_link">probabilities.finite-distributions</a></li><li><a href="probabilities.monte-carlo-api.html" class="wiki_link">probabilities.monte-carlo</a></li><li><a href="probabilities.random-numbers-api.html" class="wiki_link">probabilities.random-numbers</a></li><li><a href="profile-api.html" class="wiki_link">profile</a></li><li><a href="properties-api.html" class="wiki_link">properties</a></li><li><a href="prxml-api.html" class="wiki_link">prxml</a></li><li><a href="reflect-api.html" class="wiki_link">reflect</a></li><li><a href="repl-ln-api.html" class="wiki_link">repl-ln</a></li><li><a href="repl-utils-api.html" class="wiki_link">repl-utils</a></li><li><a href="seq-api.html" class="wiki_link">seq</a></li><li><a href="seq-utils-api.html" class="wiki_link">seq-utils</a></li><li><a href="server-socket-api.html" class="wiki_link">server-socket</a></li><li><a href="set-api.html" class="wiki_link">set</a></li><li><a href="shell-api.html" class="wiki_link">shell</a></li><li><a href="shell-out-api.html" class="wiki_link">shell-out</a></li><li><a href="singleton-api.html" class="wiki_link">singleton</a></li><li><a href="sql-api.html" class="wiki_link">sql</a></li><li><a href="str-utils-api.html" class="wiki_link">str-utils</a></li><li><a href="str-utils2-api.html" class="wiki_link">str-utils2</a></li><li><a href="stream-utils-api.html" class="wiki_link">stream-utils</a></li><li><a href="string-api.html" class="wiki_link">string</a></li><li><a href="strint-api.html" class="wiki_link">strint</a></li><li><a href="swing-utils-api.html" class="wiki_link">swing-utils</a></li><li><a href="test-is-api.html" class="wiki_link">test-is</a></li><li><a href="trace-api.html" class="wiki_link">trace</a></li><li><a href="types-api.html" class="wiki_link">types</a></li><li><a href="with-ns-api.html" class="wiki_link">with-ns</a></li><li><a href="zip-filter-api.html" class="wiki_link">zip-filter</a></li>
</ul>
</div>
</div>
</div>
<div id="rightcolumn">
<div id="Content">
<div class="contentBox"><div class="innerContentBox">
<div id="content_view" class="wiki wikiPage">
<div id="right-sidebar"><div id="toc">
<h1 class="nopad">Table of Contents</h1>
<div style="margin-left: 1em;" class="toc-section">
<a href="#toc0">Overview</a>
<div style="margin-left: 1em;" class="toc-entry">
<a href="#clojure.contrib.test-is/*load-tests*">*load-tests*</a>
</div><div style="margin-left: 1em;" class="toc-entry">
<a href="#clojure.contrib.test-is/*stack-trace-depth*">*stack-trace-depth*</a>
</div><div style="margin-left: 1em;" class="toc-entry">
<a href="#clojure.contrib.test-is/apply-template">apply-template</a>
</div><div style="margin-left: 1em;" class="toc-entry">
<a href="#clojure.contrib.test-is/are">are</a>
</div><div style="margin-left: 1em;" class="toc-entry">
<a href="#clojure.contrib.test-is/assert-any">assert-any</a>
</div><div style="margin-left: 1em;" class="toc-entry">
<a href="#clojure.contrib.test-is/assert-predicate">assert-predicate</a>
</div><div style="margin-left: 1em;" class="toc-entry">
<a href="#clojure.contrib.test-is/compose-fixtures">compose-fixtures</a>
</div><div style="margin-left: 1em;" class="toc-entry">
<a href="#clojure.contrib.test-is/deftest">deftest</a>
</div><div style="margin-left: 1em;" class="toc-entry">
<a href="#clojure.contrib.test-is/deftest-">deftest-</a>
</div><div style="margin-left: 1em;" class="toc-entry">
<a href="#clojure.contrib.test-is/do-template">do-template</a>
</div><div style="margin-left: 1em;" class="toc-entry">
<a href="#clojure.contrib.test-is/file-position">file-position</a>
</div><div style="margin-left: 1em;" class="toc-entry">
<a href="#clojure.contrib.test-is/find-holes">find-holes</a>
</div><div style="margin-left: 1em;" class="toc-entry">
<a href="#clojure.contrib.test-is/find-pure-exprs">find-pure-exprs</a>
</div><div style="margin-left: 1em;" class="toc-entry">
<a href="#clojure.contrib.test-is/find-symbols">find-symbols</a>
</div><div style="margin-left: 1em;" class="toc-entry">
<a href="#clojure.contrib.test-is/flatten-map">flatten-map</a>
</div><div style="margin-left: 1em;" class="toc-entry">
<a href="#clojure.contrib.test-is/function?">function?</a>
</div><div style="margin-left: 1em;" class="toc-entry">
<a href="#clojure.contrib.test-is/get-possibly-unbound-var">get-possibly-unbound-var</a>
</div><div style="margin-left: 1em;" class="toc-entry">
<a href="#clojure.contrib.test-is/inc-report-counter">inc-report-counter</a>
</div><div style="margin-left: 1em;" class="toc-entry">
<a href="#clojure.contrib.test-is/is">is</a>
</div><div style="margin-left: 1em;" class="toc-entry">
<a href="#clojure.contrib.test-is/join-fixtures">join-fixtures</a>
</div><div style="margin-left: 1em;" class="toc-entry">
<a href="#clojure.contrib.test-is/report">report</a>
</div><div style="margin-left: 1em;" class="toc-entry">
<a href="#clojure.contrib.test-is/run-all-tests">run-all-tests</a>
</div><div style="margin-left: 1em;" class="toc-entry">
<a href="#clojure.contrib.test-is/run-tests">run-tests</a>
</div><div style="margin-left: 1em;" class="toc-entry">
<a href="#clojure.contrib.test-is/set-test">set-test</a>
</div><div style="margin-left: 1em;" class="toc-entry">
<a href="#clojure.contrib.test-is/successful?">successful?</a>
</div><div style="margin-left: 1em;" class="toc-entry">
<a href="#clojure.contrib.test-is/template?">template?</a>
</div><div style="margin-left: 1em;" class="toc-entry">
<a href="#clojure.contrib.test-is/test-all-vars">test-all-vars</a>
</div><div style="margin-left: 1em;" class="toc-entry">
<a href="#clojure.contrib.test-is/test-ns">test-ns</a>
</div><div style="margin-left: 1em;" class="toc-entry">
<a href="#clojure.contrib.test-is/test-var">test-var</a>
</div><div style="margin-left: 1em;" class="toc-entry">
<a href="#clojure.contrib.test-is/testing">testing</a>
</div><div style="margin-left: 1em;" class="toc-entry">
<a href="#clojure.contrib.test-is/testing-contexts-str">testing-contexts-str</a>
</div><div style="margin-left: 1em;" class="toc-entry">
<a href="#clojure.contrib.test-is/testing-vars-str">testing-vars-str</a>
</div><div style="margin-left: 1em;" class="toc-entry">
<a href="#clojure.contrib.test-is/try-expr">try-expr</a>
</div><div style="margin-left: 1em;" class="toc-entry">
<a href="#clojure.contrib.test-is/use-fixtures">use-fixtures</a>
</div><div style="margin-left: 1em;" class="toc-entry">
<a href="#clojure.contrib.test-is/with-test">with-test</a>
</div><div style="margin-left: 1em;" class="toc-entry">
<a href="#clojure.contrib.test-is/with-test-out">with-test-out</a>
</div>
<br />
</div>
</div>
</div>
<div id="content-tag"><h1 id="overview">API for <span id="namespace-name">test-is</span>
<span id="branch-name">(master branch)</span></h1>
by <span id="author">Stuart Sierra</span><br />
<br />Usage:
<pre>
(ns your-namespace
(:require <span id="long-name">clojure.contrib.test-is</span>))
</pre><pre>
</pre><h2>Overview</h2>
<pre id="namespace-docstr">Backwards-compatibility for clojure.contrib.test-is
The clojure.contrib.test-is library moved from Contrib into the
Clojure distribution as clojure.test.
This happened on or around clojure-contrib Git commit
82cf0409d0fcb71be477ebfc4da18ee2128a2ad1 on June 25, 2009.
This file makes the clojure.test interface available under the old
namespace clojure.contrib.test-is.
This includes support for the old syntax of the 'are' macro.
This was suggested by Howard Lewis Ship in ticket #26,
<a href="http://www.assembla.com/spaces/clojure-contrib/tickets/26">http://www.assembla.com/spaces/clojure-contrib/tickets/26</a></pre>
<br />
<h2>Public Variables and Functions</h2>
<div id="var-entry">
<br />
<hr />
<h2 id="clojure.contrib.test-is/*load-tests*">*load-tests*</h2>
<span id="var-type">var</span><br />
<pre id="var-usage"></pre>
<pre id="var-docstr">True by default. If set to false, no test functions will
be created by deftest, set-test, or with-test. Use this to omit
tests when compiling or loading production code.</pre>
<span class="var-added"><span id="content">Added in clojure-contrib version 1.1</span><br /></span>
</div><div id="var-entry">
<br />
<hr />
<h2 id="clojure.contrib.test-is/*stack-trace-depth*">*stack-trace-depth*</h2>
<span id="var-type">var</span><br />
<pre id="var-usage"></pre>
<pre id="var-docstr">The maximum depth of stack traces to print when an Exception
is thrown during a test. Defaults to nil, which means print the
complete stack trace.</pre>
<span class="var-added"><span id="content">Added in clojure-contrib version 1.1</span><br /></span>
</div><div id="var-entry">
<br />
<hr />
<h2 id="clojure.contrib.test-is/apply-template">apply-template</h2>
<span id="var-type">function</span><br />
<pre id="var-usage">Usage: (apply-template expr values)
</pre>
<pre id="var-docstr">Replaces _1, _2, _3, etc. in expr with corresponding elements of
values. Returns the modified expression. For use in macros.</pre>
<a href="http://github.com/richhickey/clojure-contrib/blob/2ede388a9267d175bfaa7781ee9d57532eb4f20f/src/main/clojure/clojure/contrib/test_is.clj#L76" id="var-source">Source</a>
</div><div id="var-entry">
<br />
<hr />
<h2 id="clojure.contrib.test-is/are">are</h2>
<span id="var-type">macro</span><br />
<pre id="var-usage">Usage: (are expr & args)
</pre>
<pre id="var-docstr">Checks multiple assertions with a template expression.
See clojure.contrib.template/do-template for an explanation of
templates.
Example: (are (= _1 _2)
2 (+ 1 1)
4 (* 2 2))
Expands to:
(do (is (= 2 (+ 1 1)))
(is (= 4 (* 2 2))))
Note: This breaks some reporting features, such as line numbers.</pre>
<a href="http://github.com/richhickey/clojure-contrib/blob/2ede388a9267d175bfaa7781ee9d57532eb4f20f/src/main/clojure/clojure/contrib/test_is.clj#L104" id="var-source">Source</a>
</div><div id="var-entry">
<br />
<hr />
<h2 id="clojure.contrib.test-is/assert-any">assert-any</h2>
<span id="var-type">function</span><br />
<pre id="var-usage">Usage: (assert-any msg form)
</pre>
<pre id="var-docstr">Returns generic assertion code for any test, including macros, Java
method calls, or isolated symbols.</pre>
<span class="var-added"><span id="content">Added in clojure-contrib version 1.1</span><br /></span>
</div><div id="var-entry">
<br />
<hr />
<h2 id="clojure.contrib.test-is/assert-predicate">assert-predicate</h2>
<span id="var-type">function</span><br />
<pre id="var-usage">Usage: (assert-predicate msg form)
</pre>
<pre id="var-docstr">Returns generic assertion code for any functional predicate. The
'expected' argument to 'report' will contains the original form, the
'actual' argument will contain the form with all its sub-forms
evaluated. If the predicate returns false, the 'actual' form will
be wrapped in (not...).</pre>
<span class="var-added"><span id="content">Added in clojure-contrib version 1.1</span><br /></span>
</div><div id="var-entry">
<br />
<hr />
<h2 id="clojure.contrib.test-is/compose-fixtures">compose-fixtures</h2>
<span id="var-type">function</span><br />
<pre id="var-usage">Usage: (compose-fixtures f1 f2)
</pre>
<pre id="var-docstr">Composes two fixture functions, creating a new fixture function
that combines their behavior.</pre>
<span class="var-added"><span id="content">Added in clojure-contrib version 1.1</span><br /></span>
</div><div id="var-entry">
<br />
<hr />
<h2 id="clojure.contrib.test-is/deftest">deftest</h2>
<span id="var-type">macro</span><br />
<pre id="var-usage">Usage: (deftest name & body)
</pre>
<pre id="var-docstr">Defines a test function with no arguments. Test functions may call
other tests, so tests may be composed. If you compose tests, you
should also define a function named test-ns-hook; run-tests will
call test-ns-hook instead of testing all vars.
Note: Actually, the test body goes in the :test metadata on the var,
and the real function (the value of the var) calls test-var on
itself.
When *load-tests* is false, deftest is ignored.</pre>
<span class="var-added"><span id="content">Added in clojure-contrib version 1.1</span><br /></span>
</div><div id="var-entry">
<br />
<hr />
<h2 id="clojure.contrib.test-is/deftest-">deftest-</h2>
<span id="var-type">macro</span><br />
<pre id="var-usage">Usage: (deftest- name & body)
</pre>
<pre id="var-docstr">Like deftest but creates a private var.</pre>
<span class="var-added"><span id="content">Added in clojure-contrib version 1.1</span><br /></span>
</div><div id="var-entry">
<br />
<hr />
<h2 id="clojure.contrib.test-is/do-template">do-template</h2>
<span id="var-type">macro</span><br />
<pre id="var-usage">Usage: (do-template expr & args)
</pre>
<pre id="var-docstr">Repeatedly evaluates template expr (in a do block) using values in
args. args are grouped by the number of holes in the template.
Example: (do-template (check _1 _2) :a :b :c :d)
expands to (do (check :a :b) (check :c :d))</pre>
<a href="http://github.com/richhickey/clojure-contrib/blob/2ede388a9267d175bfaa7781ee9d57532eb4f20f/src/main/clojure/clojure/contrib/test_is.clj#L87" id="var-source">Source</a>
</div><div id="var-entry">
<br />
<hr />
<h2 id="clojure.contrib.test-is/file-position">file-position</h2>
<span id="var-type">function</span><br />
<pre id="var-usage">Usage: (file-position n)
</pre>
<pre id="var-docstr">Returns a vector [filename line-number] for the nth call up the
stack.</pre>
<span class="var-added"><span id="content">Added in clojure-contrib version 1.1</span><br /></span>
</div><div id="var-entry">
<br />
<hr />
<h2 id="clojure.contrib.test-is/find-holes">find-holes</h2>
<span id="var-type">function</span><br />
<pre id="var-usage">Usage: (find-holes form)
</pre>
<pre id="var-docstr">Recursively finds all symbols starting with _ in form.</pre>
<a href="http://github.com/richhickey/clojure-contrib/blob/2ede388a9267d175bfaa7781ee9d57532eb4f20f/src/main/clojure/clojure/contrib/test_is.clj#L51" id="var-source">Source</a>
</div><div id="var-entry">
<br />
<hr />
<h2 id="clojure.contrib.test-is/find-pure-exprs">find-pure-exprs</h2>
<span id="var-type">function</span><br />
<pre id="var-usage">Usage: (find-pure-exprs form)
</pre>
<pre id="var-docstr">Recursively finds all sub-expressions in form that do not contain
any symbols starting with _</pre>
<a href="http://github.com/richhickey/clojure-contrib/blob/2ede388a9267d175bfaa7781ee9d57532eb4f20f/src/main/clojure/clojure/contrib/test_is.clj#L57" id="var-source">Source</a>
</div><div id="var-entry">
<br />
<hr />
<h2 id="clojure.contrib.test-is/find-symbols">find-symbols</h2>
<span id="var-type">function</span><br />
<pre id="var-usage">Usage: (find-symbols form)
</pre>
<pre id="var-docstr">Recursively finds all symbols in form.</pre>
<a href="http://github.com/richhickey/clojure-contrib/blob/2ede388a9267d175bfaa7781ee9d57532eb4f20f/src/main/clojure/clojure/contrib/test_is.clj#L46" id="var-source">Source</a>
</div><div id="var-entry">
<br />
<hr />
<h2 id="clojure.contrib.test-is/flatten-map">flatten-map</h2>
<span id="var-type">function</span><br />
<pre id="var-usage">Usage: (flatten-map m)
</pre>
<pre id="var-docstr">Transforms a map into a vector like [key value key value].</pre>
<a href="http://github.com/richhickey/clojure-contrib/blob/2ede388a9267d175bfaa7781ee9d57532eb4f20f/src/main/clojure/clojure/contrib/test_is.clj#L65" id="var-source">Source</a>
</div><div id="var-entry">
<br />
<hr />
<h2 id="clojure.contrib.test-is/function?">function?</h2>
<span id="var-type">function</span><br />
<pre id="var-usage">Usage: (function? x)
</pre>
<pre id="var-docstr">Returns true if argument is a function or a symbol that resolves to
a function (not a macro).</pre>
<span class="var-added"><span id="content">Added in clojure-contrib version 1.1</span><br /></span>
</div><div id="var-entry">
<br />
<hr />
<h2 id="clojure.contrib.test-is/get-possibly-unbound-var">get-possibly-unbound-var</h2>
<span id="var-type">function</span><br />
<pre id="var-usage">Usage: (get-possibly-unbound-var v)
</pre>
<pre id="var-docstr">Like var-get but returns nil if the var is unbound.</pre>
<span class="var-added"><span id="content">Added in clojure-contrib version 1.1</span><br /></span>
</div><div id="var-entry">
<br />
<hr />
<h2 id="clojure.contrib.test-is/inc-report-counter">inc-report-counter</h2>
<span id="var-type">function</span><br />
<pre id="var-usage">Usage: (inc-report-counter name)
</pre>
<pre id="var-docstr">Increments the named counter in *report-counters*, a ref to a map.
Does nothing if *report-counters* is nil.</pre>
<span class="var-added"><span id="content">Added in clojure-contrib version 1.1</span><br /></span>
</div><div id="var-entry">
<br />
<hr />
<h2 id="clojure.contrib.test-is/is">is</h2>
<span id="var-type">macro</span><br />
<pre id="var-usage">Usage: (is form)
(is form msg)
</pre>
<pre id="var-docstr">Generic assertion macro. 'form' is any predicate test.
'msg' is an optional message to attach to the assertion.
Example: (is (= 4 (+ 2 2)) "Two plus two should be 4")
Special forms:
(is (thrown? c body)) checks that an instance of c is thrown from
body, fails if not; then returns the thing thrown.
(is (thrown-with-msg? c re body)) checks that an instance of c is
thrown AND that the message on the exception matches (with
re-find) the regular expression re.</pre>
<span class="var-added"><span id="content">Added in clojure-contrib version 1.1</span><br /></span>
</div><div id="var-entry">
<br />
<hr />
<h2 id="clojure.contrib.test-is/join-fixtures">join-fixtures</h2>
<span id="var-type">function</span><br />
<pre id="var-usage">Usage: (join-fixtures fixtures)
</pre>
<pre id="var-docstr">Composes a collection of fixtures, in order. Always returns a valid
fixture function, even if the collection is empty.</pre>
<span class="var-added"><span id="content">Added in clojure-contrib version 1.1</span><br /></span>
</div><div id="var-entry">
<br />
<hr />
<h2 id="clojure.contrib.test-is/report">report</h2>
<span id="var-type">multimethod</span><br />
<pre id="var-usage">No usage documentation available</pre>
<pre id="var-docstr">Generic reporting function, may be overridden to plug in
different report formats (e.g., TAP, JUnit). Assertions such as
'is' call 'report' to indicate results. The argument given to
'report' will be a map with a :type key. See the documentation at
the top of test_is.clj for more information on the types of
arguments for 'report'.</pre>
<span class="var-added"><span id="content">Added in clojure-contrib version 1.1</span><br /></span>
</div><div id="var-entry">
<br />
<hr />
<h2 id="clojure.contrib.test-is/run-all-tests">run-all-tests</h2>
<span id="var-type">function</span><br />
<pre id="var-usage">Usage: (run-all-tests)
(run-all-tests re)
</pre>
<pre id="var-docstr">Runs all tests in all namespaces; prints results.
Optional argument is a regular expression; only namespaces with
names matching the regular expression (with re-matches) will be
tested.</pre>
<span class="var-added"><span id="content">Added in clojure-contrib version 1.1</span><br /></span>
</div><div id="var-entry">
<br />
<hr />
<h2 id="clojure.contrib.test-is/run-tests">run-tests</h2>
<span id="var-type">function</span><br />
<pre id="var-usage">Usage: (run-tests)
(run-tests & namespaces)
</pre>
<pre id="var-docstr">Runs all tests in the given namespaces; prints results.
Defaults to current namespace if none given. Returns a map
summarizing test results.</pre>
<span class="var-added"><span id="content">Added in clojure-contrib version 1.1</span><br /></span>
</div><div id="var-entry">
<br />
<hr />
<h2 id="clojure.contrib.test-is/set-test">set-test</h2>
<span id="var-type">macro</span><br />
<pre id="var-usage">Usage: (set-test name & body)
</pre>
<pre id="var-docstr">Experimental.
Sets :test metadata of the named var to a fn with the given body.
The var must already exist. Does not modify the value of the var.
When *load-tests* is false, set-test is ignored.</pre>
<span class="var-added"><span id="content">Added in clojure-contrib version 1.1</span><br /></span>
</div><div id="var-entry">
<br />
<hr />
<h2 id="clojure.contrib.test-is/successful?">successful?</h2>
<span id="var-type">function</span><br />
<pre id="var-usage">Usage: (successful? summary)
</pre>
<pre id="var-docstr">Returns true if the given test summary indicates all tests
were successful, false otherwise.</pre>
<span class="var-added"><span id="content">Added in clojure-contrib version 1.1</span><br /></span>
</div><div id="var-entry">
<br />
<hr />
<h2 id="clojure.contrib.test-is/template?">template?</h2>
<span id="var-type">function</span><br />
<pre id="var-usage">Usage: (template? form)
</pre>
<pre id="var-docstr">Returns true if form is a valid template expression.</pre>
<a href="http://github.com/richhickey/clojure-contrib/blob/2ede388a9267d175bfaa7781ee9d57532eb4f20f/src/main/clojure/clojure/contrib/test_is.clj#L71" id="var-source">Source</a>
</div><div id="var-entry">
<br />
<hr />
<h2 id="clojure.contrib.test-is/test-all-vars">test-all-vars</h2>
<span id="var-type">function</span><br />
<pre id="var-usage">Usage: (test-all-vars ns)
</pre>
<pre id="var-docstr">Calls test-var on every var interned in the namespace, with fixtures.</pre>
<span class="var-added"><span id="content">Added in clojure-contrib version 1.1</span><br /></span>
</div><div id="var-entry">
<br />
<hr />
<h2 id="clojure.contrib.test-is/test-ns">test-ns</h2>
<span id="var-type">function</span><br />
<pre id="var-usage">Usage: (test-ns ns)
</pre>
<pre id="var-docstr">If the namespace defines a function named test-ns-hook, calls that.
Otherwise, calls test-all-vars on the namespace. 'ns' is a
namespace object or a symbol.
Internally binds *report-counters* to a ref initialized to
*inital-report-counters*. Returns the final, dereferenced state of
*report-counters*.</pre>
<span class="var-added"><span id="content">Added in clojure-contrib version 1.1</span><br /></span>
</div><div id="var-entry">
<br />
<hr />
<h2 id="clojure.contrib.test-is/test-var">test-var</h2>
<span id="var-type">function</span><br />
<pre id="var-usage">Usage: (test-var v)
</pre>
<pre id="var-docstr">If v has a function in its :test metadata, calls that function,
with *testing-vars* bound to (conj *testing-vars* v).</pre>
<span class="var-added"><span id="content">Added in clojure-contrib version 1.1</span><br /></span>
</div><div id="var-entry">
<br />
<hr />
<h2 id="clojure.contrib.test-is/testing">testing</h2>
<span id="var-type">macro</span><br />
<pre id="var-usage">Usage: (testing string & body)
</pre>
<pre id="var-docstr">Adds a new string to the list of testing contexts. May be nested,
but must occur inside a test function (deftest).</pre>
<span class="var-added"><span id="content">Added in clojure-contrib version 1.1</span><br /></span>
</div><div id="var-entry">
<br />
<hr />
<h2 id="clojure.contrib.test-is/testing-contexts-str">testing-contexts-str</h2>
<span id="var-type">function</span><br />
<pre id="var-usage">Usage: (testing-contexts-str)
</pre>
<pre id="var-docstr">Returns a string representation of the current test context. Joins
strings in *testing-contexts* with spaces.</pre>
<span class="var-added"><span id="content">Added in clojure-contrib version 1.1</span><br /></span>
</div><div id="var-entry">
<br />
<hr />
<h2 id="clojure.contrib.test-is/testing-vars-str">testing-vars-str</h2>
<span id="var-type">function</span><br />
<pre id="var-usage">Usage: (testing-vars-str)
</pre>
<pre id="var-docstr">Returns a string representation of the current test. Renders names
in *testing-vars* as a list, then the source file and line of
current assertion.</pre>
<span class="var-added"><span id="content">Added in clojure-contrib version 1.1</span><br /></span>
</div><div id="var-entry">
<br />
<hr />
<h2 id="clojure.contrib.test-is/try-expr">try-expr</h2>
<span id="var-type">macro</span><br />
<pre id="var-usage">Usage: (try-expr msg form)
</pre>
<pre id="var-docstr">Used by the 'is' macro to catch unexpected exceptions.
You don't call this.</pre>
<span class="var-added"><span id="content">Added in clojure-contrib version 1.1</span><br /></span>
</div><div id="var-entry">
<br />
<hr />
<h2 id="clojure.contrib.test-is/use-fixtures">use-fixtures</h2>
<span id="var-type">multimethod</span><br />
<pre id="var-usage">No usage documentation available</pre>
<pre id="var-docstr">Wrap test runs in a fixture function to perform setup and
teardown. Using a fixture-type of :each wraps every test
individually, while:once wraps the whole run in a single function.</pre>
<span class="var-added"><span id="content">Added in clojure-contrib version 1.1</span><br /></span>
</div><div id="var-entry">
<br />
<hr />
<h2 id="clojure.contrib.test-is/with-test">with-test</h2>
<span id="var-type">macro</span><br />
<pre id="var-usage">Usage: (with-test definition & body)
</pre>
<pre id="var-docstr">Takes any definition form (that returns a Var) as the first argument.
Remaining body goes in the :test metadata function for that Var.
When *load-tests* is false, only evaluates the definition, ignoring
the tests.</pre>
<span class="var-added"><span id="content">Added in clojure-contrib version 1.1</span><br /></span>
</div><div id="var-entry">
<br />
<hr />
<h2 id="clojure.contrib.test-is/with-test-out">with-test-out</h2>
<span id="var-type">macro</span><br />
<pre id="var-usage">Usage: (with-test-out & body)
</pre>
<pre id="var-docstr">Runs body with *out* bound to the value of *test-out*.</pre>
<span class="var-added"><span id="content">Added in clojure-contrib version 1.1</span><br /></span>
</div>
</div>
</div>
</div>
</div>
</div>
<div id="foot">
<div style="text-align: center;" id="copyright">Copyright 2007-2009 by Rich Hickey and the various contributors</div>
</div>
</div>
<div id="DesignedBy">Logo & site design by <a title="Visit Tom Hickey's website." href="http://www.tomhickey.com">Tom Hickey</a>.<br />
Clojure auto-documentation system by Tom Faulhaber.</div>
</div>
<!-- /AllContentContainer -->
</body>
</html>
|
