-
Notifications
You must be signed in to change notification settings - Fork 0
/
try-manual.html
3137 lines (2865 loc) · 321 KB
/
try-manual.html
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
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<!DOCTYPE html>
<html xmlns='http://www.w3.org/1999/xhtml' xml:lang='en' lang='en'>
<head>
<title>Try Manual
</title>
<link type='text/css' href='style.css' rel='stylesheet'>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="viewport" content="width=device-width">
<script src="jquery.min.js"></script>
<script src="toc.min.js"></script>
<script type="text/x-mathjax-config">
MathJax.Hub.Config({
tex2jax: {
inlineMath: [['$','$']],
processEscapes: true
}
});
</script>
<script async src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.7/MathJax.js?config=TeX-MML-AM_CHTML">
</script>
</head>
<body>
<div id="content-container">
<div id="toc">
<div id="toc-header"><ul><li><a href="index.html">PAX World</a></li></ul></div>
<div id="page-toc">
</div>
<div id="toc-footer"><ul><li><a href="https://github.com/melisgl/mgl-pax">[generated by MGL-PAX]</a></li></ul></div>
</div>
<div id="content">
<p><a id="x-28TRY-3A-40TRY-MANUAL-20MGL-PAX-3ASECTION-29"></a>
<a id="TRY:@TRY-MANUAL%20MGL-PAX:SECTION"></a></p>
<p><span class="outer-navigation"><span class="navigation"> <a href="#%22try%22%20ASDF%2FSYSTEM:SYSTEM" title=""try" ASDF/SYSTEM:SYSTEM">→</a> <a href="try-manual.html" title="Try Manual">↺</a> <a href="https://github.com/melisgl/try/blob/599bb1bc08bb74fc77136dba1f22318486596baa/src/manual.lisp#L5">λ</a></span></span></p>
<h1><a href="try-manual.html">Try Manual</a></h1>
<h2>Table of Contents</h2>
<ul>
<li><a href="#%22try%22%20ASDF%2FSYSTEM:SYSTEM" title=""try" ASDF/SYSTEM:SYSTEM">1 The try ASDF System</a></li>
<li><a href="#TRY:@TRY%2FLINKS%20MGL-PAX:SECTION" title="Links">2 Links</a></li>
<li><a href="#TRY:@TRY%2FTUTORIAL%20MGL-PAX:SECTION" title="Tutorial">3 Tutorial</a></li>
<li><a href="#TRY:@TRY%2FEMACS%20MGL-PAX:SECTION" title="Emacs Integration">4 Emacs Integration</a>
<ul>
<li><a href="#TRY:@TRY%2FEMACS-SETUP%20MGL-PAX:SECTION" title="Emacs Setup">4.1 Emacs Setup</a></li>
</ul></li>
<li><a href="#TRY:@TRY%2FEVENTS%20MGL-PAX:SECTION" title="Events">5 Events</a>
<ul>
<li><a href="#TRY:@TRY%2FMIDDLE-LAYER-OF-EVENTS%20MGL-PAX:SECTION" title="Middle Layer of Events">5.1 Middle Layer of Events</a></li>
<li><a href="#TRY:@TRY%2FCONCRETE-EVENTS%20MGL-PAX:SECTION" title="Concrete Events">5.2 Concrete Events</a></li>
<li><a href="#TRY:@TRY%2FEVENT-GLUE%20MGL-PAX:SECTION" title="Event Glue">5.3 Event Glue</a></li>
<li><a href="#TRY:@TRY%2FPRINTING-EVENTS%20MGL-PAX:SECTION" title="Printing Events">5.4 Printing Events</a></li>
<li><a href="#TRY:@TRY%2FEVENT-RESTARTS%20MGL-PAX:SECTION" title="Event Restarts">5.5 Event Restarts</a></li>
<li><a href="#TRY:@TRY%2FOUTCOMES%20MGL-PAX:SECTION" title="Outcomes">5.6 Outcomes</a>
<ul>
<li><a href="#TRY:@TRY%2FOUTCOME-RESTARTS%20MGL-PAX:SECTION" title="Outcome Restarts">5.6.1 Outcome Restarts</a></li>
<li><a href="#TRY:@TRY%2FCHECKS%20MGL-PAX:SECTION" title="Checks">5.6.2 Checks</a></li>
<li><a href="#TRY:@TRY%2FTRIALS%20MGL-PAX:SECTION" title="Trials">5.6.3 Trials</a></li>
</ul></li>
<li><a href="#TRY:@TRY%2FERRORS%20MGL-PAX:SECTION" title="Errors">5.7 Errors</a></li>
<li><a href="#TRY:@TRY%2FCATEGORIES%20MGL-PAX:SECTION" title="Categories">5.8 Categories</a></li>
</ul></li>
<li><a href="#TRY:@TRY%2FIS%20MGL-PAX:SECTION" title="The `is` Macro">6 The <code>is</code> Macro</a>
<ul>
<li><a href="#TRY:@TRY%2FFORMAT-SPECIFIER-FORMS%20MGL-PAX:SECTION" title="Format Specifier Forms">6.1 Format Specifier Forms</a></li>
<li><a href="#TRY:@TRY%2FCAPTURES%20MGL-PAX:SECTION" title="Captures">6.2 Captures</a>
<ul>
<li><a href="#TRY:@TRY%2FAUTOMATIC-CAPTURES%20MGL-PAX:SECTION" title="Automatic Captures">6.2.1 Automatic Captures</a></li>
<li><a href="#TRY:@TRY%2FEXPLICIT-CAPTURES%20MGL-PAX:SECTION" title="Explicit Captures">6.2.2 Explicit Captures</a></li>
</ul></li>
</ul></li>
<li><a href="#TRY:@TRY%2FCHECK-LIBRARY%20MGL-PAX:SECTION" title="Check Library">7 Check Library</a>
<ul>
<li><a href="#TRY:@TRY%2FCHECKING-CONDITIONS%20MGL-PAX:SECTION" title="Checking Conditions">7.1 Checking Conditions</a></li>
<li><a href="#TRY:@TRY%2FMISC-CHECKS%20MGL-PAX:SECTION" title="Miscellaneous Checks">7.2 Miscellaneous Checks</a></li>
<li><a href="#TRY:@TRY%2FCHECK-UTILITIES%20MGL-PAX:SECTION" title="Check Utilities">7.3 Check Utilities</a>
<ul>
<li><a href="#TRY:@TRY%2FCOMPARING-FLOATS%20MGL-PAX:SECTION" title="Comparing Floats">7.3.1 Comparing Floats</a></li>
</ul></li>
</ul></li>
<li><a href="#TRY:@TRY%2FTESTS%20MGL-PAX:SECTION" title="Tests">8 Tests</a>
<ul>
<li><a href="#TRY:@TRY%2FIMPLICIT-TRY%20MGL-PAX:SECTION" title="Calling Test Functions">8.1 Calling Test Functions</a></li>
<li><a href="#TRY:@TRY%2FEXPLICIT-TRY%20MGL-PAX:SECTION" title="Explicit `try`">8.2 Explicit <code>try</code></a>
<ul>
<li><a href="#TRY:@TRY%2FTESTABLES%20MGL-PAX:SECTION" title="Testables">8.2.1 Testables</a></li>
<li><a href="#TRY:@TRY%2FIMPLICIT-TRY-IMPLEMENTATION%20MGL-PAX:SECTION" title="Implementation of Implicit `try`">8.2.2 Implementation of Implicit <code>try</code></a></li>
</ul></li>
<li><a href="#TRY:@TRY%2FPRINT%20MGL-PAX:SECTION" title="Printing Events">8.3 Printing Events</a></li>
<li><a href="#TRY:@TRY%2FCOUNT%20MGL-PAX:SECTION" title="Counting Events">8.4 Counting Events</a></li>
<li><a href="#TRY:@TRY%2FCOLLECT%20MGL-PAX:SECTION" title="Collecting Events">8.5 Collecting Events</a></li>
<li><a href="#TRY:@TRY%2FRERUN%20MGL-PAX:SECTION" title="Rerunning Trials">8.6 Rerunning Trials</a></li>
<li><a href="#TRY:@TRY%2FREPLAY%20MGL-PAX:SECTION" title="Reprocessing Trials">8.7 Reprocessing Trials</a></li>
</ul></li>
<li><a href="#TRY:@TRY%2FIMPLEMENTATION-NOTES%20MGL-PAX:SECTION" title="Implementation Notes">9 Implementation Notes</a></li>
<li><a href="#TRY:@TRY%2FGLOSSARY%20MGL-PAX:SECTION" title="Glossary">10 Glossary</a></li>
</ul>
<h6>[in package TRY]</h6>
<p><a id="x-28-22try-22-20ASDF-2FSYSTEM-3ASYSTEM-29"></a>
<a id="%22try%22%20ASDF%2FSYSTEM:SYSTEM"></a></p>
<p><span class="outer-navigation"><span class="navigation"> <a href="try-manual.html" title="Try Manual">←</a> <a href="try-manual.html" title="Try Manual">↑</a> <a href="#TRY:@TRY%2FLINKS%20MGL-PAX:SECTION" title="Links">→</a> <a href="#%22try%22%20ASDF%2FSYSTEM:SYSTEM" title=""try" ASDF/SYSTEM:SYSTEM">↺</a> <a href="https://github.com/melisgl/try/blob/599bb1bc08bb74fc77136dba1f22318486596baa/try.asd#L1">λ</a></span></span></p>
<h2><a href="#%22try%22%20ASDF%2FSYSTEM:SYSTEM">1 The try ASDF System</a></h2>
<ul>
<li>Version: 0.0.1</li>
<li>Description: Try is an extensible test framework with equal support
for interactive and non-interactive workflows.</li>
<li>Long Description: Try stays as close to normal Lisp evaluation
rules as possible. Tests are functions that record the checks they
perform as events. These events provide the means of customization
of what to debug, print, rerun. There is a single fundamental check,
the extensible <a href="#TRY:IS%20MGL-PAX:MACRO" title="TRY:IS MGL-PAX:MACRO"><code>is</code></a> macro. Everything else is built on top.</li>
<li>Licence: MIT, see COPYING.</li>
<li>Author: Gábor Melis</li>
<li>Mailto: <a href="mailto:mega@retes.hu" >mega@retes.hu</a></li>
<li>Homepage: <a href="http://melisgl.github.io/try" >http://melisgl.github.io/try</a></li>
<li>Bug tracker: <a href="https://github.com/melisgl/try/issues" >https://github.com/melisgl/try/issues</a></li>
<li>Source control: <a href="https://github.com/melisgl/try.git" >GIT</a></li>
</ul>
<p><a id="x-28TRY-3A-40TRY-2FLINKS-20MGL-PAX-3ASECTION-29"></a>
<a id="TRY:@TRY%2FLINKS%20MGL-PAX:SECTION"></a></p>
<p><span class="outer-navigation"><span class="navigation"> <a href="#%22try%22%20ASDF%2FSYSTEM:SYSTEM" title=""try" ASDF/SYSTEM:SYSTEM">←</a> <a href="try-manual.html" title="Try Manual">↑</a> <a href="#TRY:@TRY%2FTUTORIAL%20MGL-PAX:SECTION" title="Tutorial">→</a> <a href="#TRY:@TRY%2FLINKS%20MGL-PAX:SECTION" title="Links">↺</a> <a href="https://github.com/melisgl/try/blob/599bb1bc08bb74fc77136dba1f22318486596baa/src/manual.lisp#L17">λ</a></span></span></p>
<h2><a href="#TRY:@TRY%2FLINKS%20MGL-PAX:SECTION">2 Links</a></h2>
<p>Here is the <a href="https://github.com/melisgl/try" >official repository</a>
and the <a href="http://melisgl.github.io/mgl-pax-world/try-manual.html" >HTML
documentation</a>
for the latest version.</p>
<p><a id="x-28TRY-3A-40TRY-2FTUTORIAL-20MGL-PAX-3ASECTION-29"></a>
<a id="TRY:@TRY%2FTUTORIAL%20MGL-PAX:SECTION"></a></p>
<p><span class="outer-navigation"><span class="navigation"> <a href="#TRY:@TRY%2FLINKS%20MGL-PAX:SECTION" title="Links">←</a> <a href="try-manual.html" title="Try Manual">↑</a> <a href="#TRY:@TRY%2FEMACS%20MGL-PAX:SECTION" title="Emacs Integration">→</a> <a href="#TRY:@TRY%2FTUTORIAL%20MGL-PAX:SECTION" title="Tutorial">↺</a> <a href="https://github.com/melisgl/try/blob/599bb1bc08bb74fc77136dba1f22318486596baa/src/manual.lisp#L23">λ</a></span></span></p>
<h2><a href="#TRY:@TRY%2FTUTORIAL%20MGL-PAX:SECTION">3 Tutorial</a></h2>
<p>Try is a library for unit testing with equal support for
interactive and non-interactive workflows. Tests are functions, and
almost everything else is a condition, whose types feature
prominently in parameterization.</p>
<p>Try is is what we get if we make tests functions and build a test
framework on top of the condition system as
<a href="https://common-lisp.net/project/stefil/index-old.shtml" >Stefil</a> did
but also address the issue of rerunning and replaying, make the
<a href="#TRY:IS%20MGL-PAX:MACRO" title="TRY:IS MGL-PAX:MACRO"><code>is</code></a> check more capable, use the types of the condition hierarchy
to parameterize what to debug, print, rerun, and finally document
the whole thing.</p>
<h5>Looking for Truth</h5>
<p><a href="#TRY:@TRY%2FIS%20MGL-PAX:SECTION" title="The `is` Macro">The <code>is</code> Macro</a> is a replacement for <a href="http://www.lispworks.com/documentation/HyperSpec/Body/m_assert.htm" title="ASSERT (MGL-PAX:CLHS MGL-PAX:MACRO)"><code>cl:assert</code></a>, that can capture values of
subforms to provide context to failures:</p>
<pre><code><span class="code"><span class="paren1">(<span class="code">is <span class="paren2">(<span class="code">= <span class="paren3">(<span class="code">1+ 5</span>)</span> 0</span>)</span></span>)</span>
.. debugger invoked on UNEXPECTED-RESULT-FAILURE:
.. UNEXPECTED-FAILURE in check:
.. <span class="paren1">(<span class="code">IS <span class="paren2">(<span class="code">= #1=<span class="paren3">(<span class="code">1+ 5</span>)</span> 0</span>)</span></span>)</span>
.. where
.. #1# = 6</span></code></pre>
<p>This is a <a href="pax-manual.html" title="PAX Manual">PAX</a> <a href="pax-manual.html#MGL-PAX:@TRANSCRIPTS%20MGL-PAX:SECTION" title="Transcripts">transcript</a>,
output is prefixed with <code>..</code>. Readable and unreadable return values
are prefixed with <code>=></code> and <code>==></code>, respectively.</p>
<p>Note the <code>#n#</code> syntax due to <a href="http://www.lispworks.com/documentation/HyperSpec/Body/v_pr_cir.htm" title="*PRINT-CIRCLE* (MGL-PAX:CLHS VARIABLE)"><code>*print-circle*</code></a>.</p>
<h5>Checking Multiple Values</h5>
<p><code>is</code> <a href="#TRY:@TRY%2FAUTOMATIC-CAPTURES%20MGL-PAX:SECTION" title="Automatic Captures">automatically captures</a> values of
arguments to functions like <a href="http://www.lispworks.com/documentation/HyperSpec/Body/f_1pl_1_.htm" title="1+ (MGL-PAX:CLHS FUNCTION)"><code>1+</code></a> in the above example. Values of
other interesting subforms can be <a href="#TRY:@TRY%2FEXPLICIT-CAPTURES%20MGL-PAX:SECTION" title="Explicit Captures">explicitly
captured</a>. <code>is</code> supports capturing multiple
values and can be taught <a href="#TRY:@TRY%2FWRITING-AUTOMATIC-CAPTURE-RULES%20MGL-PAX:SECTION" title="Writing Automatic Capture Rules">how to deal with macros</a>. The combination of these
features allows <a href="#TRY:MATCH-VALUES%20MGL-PAX:MACRO" title="TRY:MATCH-VALUES MGL-PAX:MACRO"><code>match-values</code></a> to be implementable as tiny extension:</p>
<pre><code><span class="code"><span class="paren1">(<span class="code">is <span class="paren2">(<span class="code">match-values <span class="paren3">(<span class="code">values <span class="paren4">(<span class="code">1+ 5</span>)</span> <span class="string">"sdf"</span></span>)</span>
<span class="paren3">(<span class="code">= * 0</span>)</span>
<span class="paren3">(<span class="code">string= * <span class="string">"sdf"</span></span>)</span></span>)</span></span>)</span>
.. debugger invoked on UNEXPECTED-RESULT-FAILURE:
.. UNEXPECTED-FAILURE in check:
.. <span class="paren1">(<span class="code">IS
.. <span class="paren2">(<span class="code">MATCH-VALUES #1=<span class="paren3">(<span class="code">VALUES <span class="paren4">(<span class="code">1+ 5</span>)</span> #2=<span class="string">"sdf"</span></span>)</span>
.. <span class="paren3">(<span class="code">= * 0</span>)</span>
.. <span class="paren3">(<span class="code">STRING= * <span class="string">"sdf"</span></span>)</span></span>)</span></span>)</span>
.. where
.. #1# == 6
.. #2#</span></code></pre>
<p>In the body of <code>match-values</code>, <code>*</code> is bound to
successive return values of some form, here <code>(values (1+ 5) "sdf")</code>.
<code>match-values</code> comes with an automatic rewrite rule that captures the
values of this form, which are printed above as <code>#1# == 6 #2#</code>. <code>is</code>
is flexible enough that all other checks (<a href="#TRY:SIGNALS%20MGL-PAX:MACRO" title="TRY:SIGNALS MGL-PAX:MACRO"><code>signals</code></a>, <a href="#TRY:SIGNALS-NOT%20MGL-PAX:MACRO" title="TRY:SIGNALS-NOT MGL-PAX:MACRO"><code>signals-not</code></a>,
<a href="#TRY:INVOKES-DEBUGGER%20MGL-PAX:MACRO" title="TRY:INVOKES-DEBUGGER MGL-PAX:MACRO"><code>invokes-debugger</code></a>, <a href="#TRY:INVOKES-DEBUGGER-NOT%20MGL-PAX:MACRO" title="TRY:INVOKES-DEBUGGER-NOT MGL-PAX:MACRO"><code>invokes-debugger-not</code></a>, <a href="#TRY:FAILS%20MGL-PAX:MACRO" title="TRY:FAILS MGL-PAX:MACRO"><code>fails</code></a>, and <a href="#TRY:IN-TIME%20MGL-PAX:MACRO" title="TRY:IN-TIME MGL-PAX:MACRO"><code>in-time</code></a> are built
on top of it.</p>
<h5>Writing Tests</h5>
<p>Beyond <code>is</code>, a fancy <code>assert</code>, Try provides tests, which are Lisp
functions that record their execution in <a href="#TRY:TRIAL%20CLASS" title="TRY:TRIAL CLASS"><code>trial</code></a> objects. Let's define
a test and run it:</p>
<pre><code><span class="code"><span class="paren1">(<span class="code"><i><span class="symbol">deftest</span></i> should-work <span class="paren2">(<span class="code"></span>)</span>
<span class="paren2">(<span class="code">is t</span>)</span></span>)</span>
<span class="paren1">(<span class="code">should-work</span>)</span>
.. SHOULD-WORK <span class="comment">; TRIAL-START
</span>.. ⋅ <span class="paren1">(<span class="code">IS T</span>)</span> <span class="comment">; EXPECTED-RESULT-SUCCESS
</span>.. ⋅ SHOULD-WORK ⋅1 <span class="comment">; EXPECTED-VERDICT-SUCCESS
</span>..
==> #<TRIAL <span class="paren1">(<span class="code">SHOULD-WORK</span>)</span> EXPECTED-SUCCESS 0.000s ⋅1></span></code></pre>
<p>Try is driven by conditions, and the comments to the right give the
type of the condition that is printed on that line. The <code>⋅</code>
character marks successes.</p>
<p>We could have run our test with <code>(try 'should-work)</code> as well, which
does pretty much the same thing except it defaults to never entering
the debugger, whereas calling a test function directly enters the
debugger on events whose type matches the type in the variable
<a href="#TRY:*DEBUG*%20VARIABLE" title="TRY:*DEBUG* VARIABLE"><code>*debug*</code></a>.</p>
<pre><code><span class="code"><span class="paren1">(<span class="code">try 'should-work</span>)</span>
.. SHOULD-WORK
.. ⋅ <span class="paren1">(<span class="code">IS T</span>)</span>
.. ⋅ SHOULD-WORK ⋅1
..
==> #<TRIAL <span class="paren1">(<span class="code">SHOULD-WORK</span>)</span> EXPECTED-SUCCESS 0.000s ⋅1></span></code></pre>
<h5>Test Suites</h5>
<p>Test suites are just tests that call other tests.</p>
<pre><code><span class="code"><span class="paren1">(<span class="code"><i><span class="symbol">deftest</span></i> my-suite <span class="paren2">(<span class="code"></span>)</span>
<span class="paren2">(<span class="code">should-work</span>)</span>
<span class="paren2">(<span class="code">is <span class="paren3">(<span class="code">= <span class="paren4">(<span class="code">foo</span>)</span> 5</span>)</span></span>)</span></span>)</span>
<span class="paren1">(<span class="code"><i><span class="symbol">defun</span></i> foo <span class="paren2">(<span class="code"></span>)</span>
4</span>)</span>
<span class="paren1">(<span class="code">try 'my-suite</span>)</span>
.. MY-SUITE <span class="comment">; TRIAL-START
</span>.. SHOULD-WORK <span class="comment">; TRIAL-START
</span>.. ⋅ <span class="paren1">(<span class="code">IS T</span>)</span> <span class="comment">; EXPECTED-RESULT-SUCCESS
</span>.. ⋅ SHOULD-WORK ⋅1 <span class="comment">; EXPECTED-VERDICT-SUCCESS
</span>.. ⊠ <span class="paren1">(<span class="code">IS <span class="paren2">(<span class="code">= #1=<span class="paren3">(<span class="code">FOO</span>)</span> 5</span>)</span></span>)</span> <span class="comment">; UNEXPECTED-RESULT-FAILURE
</span>.. where
.. #1# = 4
.. ⊠ MY-SUITE ⊠1 ⋅1 <span class="comment">; UNEXPECTED-VERDICT-FAILURE
</span>..
==> #<TRIAL <span class="paren1">(<span class="code">MY-SUITE</span>)</span> UNEXPECTED-FAILURE 0.000s ⊠1 ⋅1></span></code></pre>
<p><code>⊠</code> marks <a href="#TRY:UNEXPECTED-FAILURE%20TYPE" title="TRY:UNEXPECTED-FAILURE TYPE"><code>unexpected-failure</code></a>s. Note how the failure of <code>(is (= (foo)
5))</code> caused <code>my-suite</code> to fail as well. Finally, the <code>⊠1</code> and the
<code>⋅1</code> in the <code>trial</code>'s printed representation are the <a href="#TRY:@TRY%2FCOUNT%20MGL-PAX:SECTION" title="Counting Events">event
counts</a>.</p>
<h5>Filtering Output</h5>
<p>To focus on the important bits, we can print only the <a href="#TRY:UNEXPECTED%20CONDITION" title="TRY:UNEXPECTED CONDITION"><code>unexpected</code></a>
events:</p>
<pre><code><span class="code"><span class="paren1">(<span class="code">try 'my-suite <span class="keyword">:print</span> 'unexpected</span>)</span>
.. MY-SUITE
.. ⊠ <span class="paren1">(<span class="code">IS <span class="paren2">(<span class="code">= #1=<span class="paren3">(<span class="code">FOO</span>)</span> 5</span>)</span></span>)</span>
.. where
.. #1# = 4
.. ⊠ MY-SUITE ⊠1 ⋅1
..
==> #<TRIAL <span class="paren1">(<span class="code">MY-SUITE</span>)</span> UNEXPECTED-FAILURE 0.000s ⊠1 ⋅1></span></code></pre>
<p>Note that <code>should-work</code> is still run, and its check's success is
counted as evidenced by<code>⋅1</code>. The above effect can also be achieved
without running the tests again with <a href="#TRY:REPLAY-EVENTS%20FUNCTION" title="TRY:REPLAY-EVENTS FUNCTION"><code>replay-events</code></a>.</p>
<h5>Debugging</h5>
<p>Let's figure out what went wrong:</p>
<pre><code><span class="code"><span class="paren1">(<span class="code">my-suite</span>)</span>
<span class="comment">;;; Here the debugger is invoked:
</span>UNEXPECTED-FAILURE in check:
<span class="paren1">(<span class="code">IS <span class="paren2">(<span class="code">= #1=<span class="paren3">(<span class="code">FOO</span>)</span> 5</span>)</span></span>)</span>
where
#1# = 4
Restarts:
0: [RECORD-EVENT] Record the event and continue.
1: [FORCE-EXPECTED-SUCCESS] Change outcome to TRY:EXPECTED-RESULT-SUCCESS.
2: [FORCE-UNEXPECTED-SUCCESS] Change outcome to TRY:UNEXPECTED-RESULT-SUCCESS.
3: [FORCE-EXPECTED-FAILURE] Change outcome to TRY:EXPECTED-RESULT-FAILURE.
4: [ABORT-CHECK] Change outcome to TRY:RESULT-ABORT*.
5: [SKIP-CHECK] Change outcome to TRY:RESULT-SKIP.
6: [RETRY-CHECK] Retry check.
7: [ABORT-TRIAL] Record the event and abort trial TRY::MY-SUITE.
8: [SKIP-TRIAL] Record the event and skip trial TRY::MY-SUITE.
9: [RETRY-TRIAL] Record the event and retry trial TRY::MY-SUITE.
10: [SET-TRY-DEBUG] Supply a new value for :DEBUG of TRY:TRY.
11: [RETRY] Retry SLIME interactive evaluation request.</span></code></pre>
<p>In the <a href="https://common-lisp.net/project/slime/doc/html/" >SLIME</a>
debugger, we press <code>v</code> on the frame of the call to <code>my-suite</code> to
navigate to its definition, realize what the problem is and fix
<code>foo</code>:</p>
<pre><code><span class="code"><span class="paren1">(<span class="code"><i><span class="symbol">defun</span></i> foo <span class="paren2">(<span class="code"></span>)</span>
5</span>)</span></span></code></pre>
<p>Now, we select the <a href="#TRY:RETRY-TRIAL%20FUNCTION" title="TRY:RETRY-TRIAL FUNCTION"><code>retry-trial</code></a> restart, and on the retry
<code>my-suite</code> passes. The full output is:</p>
<pre><code><span class="code">MY-SUITE
SHOULD-WORK
⋅ <span class="paren1">(<span class="code">IS T</span>)</span>
⋅ SHOULD-WORK ⋅1
WARNING: redefining TRY::FOO in DEFUN
⊠ <span class="paren1">(<span class="code">IS <span class="paren2">(<span class="code">= #1=<span class="paren3">(<span class="code">FOO</span>)</span> 5</span>)</span></span>)</span>
where
#1# = 4
MY-SUITE retry #1
SHOULD-WORK
⋅ <span class="paren1">(<span class="code">IS T</span>)</span>
⋅ SHOULD-WORK ⋅1
⋅ <span class="paren1">(<span class="code">IS <span class="paren2">(<span class="code">= <span class="paren3">(<span class="code">FOO</span>)</span> 5</span>)</span></span>)</span>
⋅ MY-SUITE ⋅2</span></code></pre>
<h5>Rerunning Stuff</h5>
<p>Instead of working interactively, one can fix the failing test and
rerun it. Now, let's fix <code>my-suite</code> and rerun it:</p>
<pre><code><span class="code"><span class="paren1">(<span class="code"><i><span class="symbol">deftest</span></i> my-suite <span class="paren2">(<span class="code"></span>)</span>
<span class="paren2">(<span class="code">should-work</span>)</span>
<span class="paren2">(<span class="code">is nil</span>)</span></span>)</span>
<span class="paren1">(<span class="code">try 'my-suite</span>)</span>
.. MY-SUITE
.. SHOULD-WORK
.. ⋅ <span class="paren1">(<span class="code">IS T</span>)</span>
.. ⋅ SHOULD-WORK ⋅1
.. ⊠ <span class="paren1">(<span class="code">IS NIL</span>)</span>
.. ⊠ MY-SUITE ⊠1 ⋅1
..
==> #<TRIAL <span class="paren1">(<span class="code">MY-SUITE</span>)</span> UNEXPECTED-FAILURE 0.000s ⊠1 ⋅1>
<span class="paren1">(<span class="code"><i><span class="symbol">deftest</span></i> my-suite <span class="paren2">(<span class="code"></span>)</span>
<span class="paren2">(<span class="code">should-work</span>)</span>
<span class="paren2">(<span class="code">is t</span>)</span></span>)</span>
<span class="paren1">(<span class="code">try !</span>)</span>
.. MY-SUITE
.. ⋅ <span class="paren1">(<span class="code">IS T</span>)</span>
.. ⋅ MY-SUITE ⋅1
..
==> #<TRIAL <span class="paren1">(<span class="code">MY-SUITE</span>)</span> EXPECTED-SUCCESS 0.004s ⋅1></span></code></pre>
<p>Here, <a href="#TRY:%21%20VARIABLE" title="TRY:! VARIABLE"><code>!</code></a> refers to the most recent <code>trial</code> returned by <a href="#TRY:TRY%20FUNCTION" title="TRY:TRY FUNCTION"><code>try</code></a>. When a
trial is passed to <code>try</code> or is <a href="http://www.lispworks.com/documentation/HyperSpec/Body/f_funcal.htm" title="FUNCALL (MGL-PAX:CLHS FUNCTION)"><code>funcall</code></a>ed, trials in it that match
the type in <code>try</code>'s <code>rerun</code> argument are rerun (here, <code>unexpected</code> by
default). <code>should-work</code> and its check are <a href="#TRY:EXPECTED-SUCCESS%20TYPE" title="TRY:EXPECTED-SUCCESS TYPE"><code>expected-success</code></a>es,
hence they don't match <code>unexpected</code> and are not <a href="#TRY:@TRY%2FRERUN%20MGL-PAX:SECTION" title="Rerunning Trials">rerun</a>.</p>
<h5>Conditional Execution</h5>
<p>Conditional execution can be achieved simply testing the <code>trial</code>
object returned by <a href="#TRY:@TRY%2FTESTS%20MGL-PAX:SECTION" title="Tests">Tests</a>.</p>
<pre><code><span class="code"><span class="paren1">(<span class="code"><i><span class="symbol">deftest</span></i> my-suite <span class="paren2">(<span class="code"></span>)</span>
<span class="paren2">(<span class="code">when <span class="paren3">(<span class="code">passedp <span class="paren4">(<span class="code">should-work</span>)</span></span>)</span>
<span class="paren3">(<span class="code">is t <span class="keyword">:msg</span> <span class="string">"a test that depends on SHOULD-WORK"</span></span>)</span>
<span class="paren3">(<span class="code">when <span class="paren4">(<span class="code">is nil</span>)</span>
<span class="paren4">(<span class="code">is nil <span class="keyword">:msg</span> <span class="string">"never run"</span></span>)</span></span>)</span></span>)</span></span>)</span></span></code></pre>
<h5>Skipping</h5>
<p>Sometimes, we do not know up front that a test should not be
executed. Calling <a href="#TRY:SKIP-TRIAL%20FUNCTION" title="TRY:SKIP-TRIAL FUNCTION"><code>skip-trial</code></a> unwinds from the <a href="#TRY:CURRENT-TRIAL%20FUNCTION" title="TRY:CURRENT-TRIAL FUNCTION"><code>current-trial</code></a> and sets
it skipped.</p>
<pre><code><span class="code"><span class="paren1">(<span class="code"><i><span class="symbol">deftest</span></i> my-suite <span class="paren2">(<span class="code"></span>)</span>
<span class="paren2">(<span class="code">is t</span>)</span>
<span class="paren2">(<span class="code">skip-trial</span>)</span>
<span class="paren2">(<span class="code">is nil</span>)</span></span>)</span>
<span class="paren1">(<span class="code">my-suite</span>)</span>
==> #<TRIAL <span class="paren1">(<span class="code">MY-SUITE</span>)</span> SKIP 0.000s ⋅1></span></code></pre>
<p>In the above, <code>(is t)</code> was executed, but <code>(is nil)</code> was not.</p>
<h5>Expecting Outcomes</h5>
<pre><code><span class="code"><span class="paren1">(<span class="code"><i><span class="symbol">deftest</span></i> known-broken <span class="paren2">(<span class="code"></span>)</span>
<span class="paren2">(<span class="code"><i><span class="symbol">with-failure-expected</span></i> <span class="paren3">(<span class="code">t</span>)</span>
<span class="paren3">(<span class="code">is nil</span>)</span></span>)</span></span>)</span>
<span class="paren1">(<span class="code">known-broken</span>)</span>
.. KNOWN-BROKEN
.. × <span class="paren1">(<span class="code">IS NIL</span>)</span>
.. ⋅ KNOWN-BROKEN ×1
..
==> #<TRIAL <span class="paren1">(<span class="code">KNOWN-BROKEN</span>)</span> EXPECTED-SUCCESS 0.000s ×1></span></code></pre>
<p><code>×</code> marks <a href="#TRY:EXPECTED-FAILURE%20TYPE" title="TRY:EXPECTED-FAILURE TYPE"><code>expected-failure</code></a>s. <code>(with-skip (t) ...)</code> makes all checks
successes and failures <a href="#TRY:EXPECTED%20CONDITION" title="TRY:EXPECTED CONDITION"><code>expected</code></a>, which are counted in their own
<a href="#TRY:*CATEGORIES*%20VARIABLE" title="TRY:*CATEGORIES* VARIABLE"><code>*categories*</code></a> by default but don't make the enclosing tests to fail.
Also see <a href="#TRY:WITH-EXPECTED-OUTCOME%20MGL-PAX:MACRO" title="TRY:WITH-EXPECTED-OUTCOME MGL-PAX:MACRO"><code>with-expected-outcome</code></a>.</p>
<h5>Running Tests on Definition</h5>
<p>With <a href="#TRY:*RUN-DEFTEST-WHEN*%20VARIABLE" title="TRY:*RUN-DEFTEST-WHEN* VARIABLE"><code>*run-deftest-when*</code></a>, tests on in various <a href="http://www.lispworks.com/documentation/HyperSpec/Body/s_eval_w.htm" title="EVAL-WHEN (MGL-PAX:CLHS MGL-PAX:MACRO)"><code>eval-when</code></a> situations.
To run tests on evaluation, as in SLIME <code>C-M-x</code>, <code>slime-eval-defun</code>:</p>
<pre><code><span class="code"><span class="paren1">(<span class="code"><i><span class="symbol">setq</span></i> <span class="special">*run-deftest-when*</span> <span class="keyword">:execute</span></span>)</span>
<span class="paren1">(<span class="code"><i><span class="symbol">deftest</span></i> some-test <span class="paren2">(<span class="code"></span>)</span>
<span class="paren2">(<span class="code">is t</span>)</span></span>)</span>
.. SOME-TEST
.. ⋅ <span class="paren1">(<span class="code">IS T</span>)</span>
.. ⋅ SOME-TEST ⋅1
..
=> SOME-TEST
<span class="paren1">(<span class="code"><i><span class="symbol">setq</span></i> <span class="special">*run-deftest-when*</span> nil</span>)</span></span></code></pre>
<h5>Fixtures</h5>
<p>There is no direct support for fixtures in Try. One can easily write
macros like the following.</p>
<pre><code><span class="code"><span class="paren1">(<span class="code"><i><span class="symbol">defvar</span></i> <span class="special">*server*</span> nil</span>)</span>
<span class="paren1">(<span class="code"><i><span class="symbol">defmacro</span></i> <i><span class="symbol">with-xxx</span></i> <span class="paren2">(<span class="code">&body body</span>)</span>
`<span class="paren2">(<span class="code"><i><span class="symbol">flet</span></i> <span class="paren3">(<span class="code"><span class="paren4">(<span class="code">,<i><span class="symbol">with-xxx-body</span></i> <span class="paren5">(<span class="code"></span>)</span>
,@body</span>)</span></span>)</span>
<span class="paren3">(<span class="code"><i><span class="symbol">if</span></i> <span class="special">*server*</span>
<span class="paren4">(<span class="code"><i><span class="symbol">with-xxx-body</span></i></span>)</span>
<span class="paren4">(<span class="code"><i><span class="symbol">with-server</span></i> <span class="paren5">(<span class="code">make-expensive-server</span>)</span>
<span class="paren5">(<span class="code"><i><span class="symbol">with-xxx-body</span></i></span>)</span></span>)</span></span>)</span></span>)</span></span>)</span></span></code></pre>
<p>Plus, with support for selectively <a href="#TRY:@TRY%2FRERUN%20MGL-PAX:SECTION" title="Rerunning Trials">Rerunning Trials</a>, the need for fixtures
is lessened.</p>
<h5>Packages</h5>
<p>The suggested way of writing tests is to call test functions
explicitly:</p>
<pre><code><span class="code"><span class="paren1">(<span class="code"><i><span class="symbol">defpackage</span></i> <span class="keyword">:some-test-package</span>
<span class="paren2">(<span class="code"><span class="keyword">:use</span> <span class="keyword">#:common-lisp</span> <span class="keyword">#:try</span></span>)</span></span>)</span>
<span class="paren1">(<span class="code">in-package <span class="keyword">:some-test-package</span></span>)</span>
<span class="paren1">(<span class="code"><i><span class="symbol">deftest</span></i> test-all <span class="paren2">(<span class="code"></span>)</span>
<span class="paren2">(<span class="code">test-this</span>)</span>
<span class="paren2">(<span class="code">test-that</span>)</span></span>)</span>
<span class="paren1">(<span class="code"><i><span class="symbol">deftest</span></i> test-this <span class="paren2">(<span class="code"></span>)</span>
<span class="paren2">(<span class="code">test-this/more</span>)</span></span>)</span>
<span class="paren1">(<span class="code"><i><span class="symbol">deftest</span></i> test-this/more <span class="paren2">(<span class="code"></span>)</span>
<span class="paren2">(<span class="code">is t</span>)</span></span>)</span>
<span class="paren1">(<span class="code"><i><span class="symbol">deftest</span></i> test-that <span class="paren2">(<span class="code"></span>)</span>
<span class="paren2">(<span class="code">is t</span>)</span></span>)</span>
<span class="paren1">(<span class="code"><i><span class="symbol">deftest</span></i> not-called <span class="paren2">(<span class="code"></span>)</span>
<span class="paren2">(<span class="code">is t</span>)</span></span>)</span>
<span class="paren1">(<span class="code"><i><span class="symbol">defun</span></i> test <span class="paren2">(<span class="code"></span>)</span>
<span class="paren2">(<span class="code">warn-on-tests-not-run <span class="paren3">(<span class="code"><span class="paren4">(<span class="code">find-package <span class="keyword">:some-test-package</span></span>)</span></span>)</span>
<span class="paren3">(<span class="code">try 'test-all</span>)</span></span>)</span></span>)</span>
<span class="paren1">(<span class="code">test</span>)</span>
.. TEST-ALL
.. TEST-THIS
.. TEST-THIS/MORE
.. ⋅ <span class="paren1">(<span class="code">IS T</span>)</span>
.. ⋅ TEST-THIS/MORE ⋅1
.. ⋅ TEST-THIS ⋅1
.. TEST-THAT
.. ⋅ <span class="paren1">(<span class="code">IS T</span>)</span>
.. ⋅ TEST-THAT ⋅1
.. ⋅ TEST-ALL ⋅2
.. WARNING: Test NOT-CALLED not run.
==> #<TRIAL <span class="paren1">(<span class="code">TEST-ALL</span>)</span> EXPECTED-SUCCESS 0.012s ⋅2></span></code></pre>
<p>Note how the <code>test</code> function uses <a href="#TRY:WARN-ON-TESTS-NOT-RUN%20MGL-PAX:MACRO" title="TRY:WARN-ON-TESTS-NOT-RUN MGL-PAX:MACRO"><code>warn-on-tests-not-run</code></a> to catch any
tests defined in <code>some-test-package</code> that were not run. Tests can be
deleted by <a href="http://www.lispworks.com/documentation/HyperSpec/Body/f_fmakun.htm" title="FMAKUNBOUND (MGL-PAX:CLHS FUNCTION)"><code>fmakunbound</code></a>, <a href="http://www.lispworks.com/documentation/HyperSpec/Body/f_uninte.htm" title="UNINTERN (MGL-PAX:CLHS FUNCTION)"><code>unintern</code></a>, or by redefining the function with
<a href="http://www.lispworks.com/documentation/HyperSpec/Body/m_defun.htm" title="DEFUN (MGL-PAX:CLHS MGL-PAX:MACRO)"><code>defun</code></a>. Tests defined in a given package can be listed with
<a href="#TRY:LIST-PACKAGE-TESTS%20FUNCTION" title="TRY:LIST-PACKAGE-TESTS FUNCTION"><code>list-package-tests</code></a>.</p>
<p>This style allows higher level tests to establish the dynamic
environment necessary for lower level tests.</p>
<p><a id="x-28TRY-3A-40TRY-2FEMACS-20MGL-PAX-3ASECTION-29"></a>
<a id="TRY:@TRY%2FEMACS%20MGL-PAX:SECTION"></a></p>
<p><span class="outer-navigation"><span class="navigation"> <a href="#TRY:@TRY%2FTUTORIAL%20MGL-PAX:SECTION" title="Tutorial">←</a> <a href="try-manual.html" title="Try Manual">↑</a> <a href="#TRY:@TRY%2FEMACS-SETUP%20MGL-PAX:SECTION" title="Emacs Setup">→</a> <a href="#TRY:@TRY%2FEMACS%20MGL-PAX:SECTION" title="Emacs Integration">↺</a> <a href="https://github.com/melisgl/try/blob/599bb1bc08bb74fc77136dba1f22318486596baa/src/manual.lisp#L418">λ</a></span></span></p>
<h2><a href="#TRY:@TRY%2FEMACS%20MGL-PAX:SECTION">4 Emacs Integration</a></h2>
<p>The Elisp <code>mgl-try</code> interactive command runs a Try test and
displays its output in a <code>lisp-mode</code> buffer with minor modes
<code>outline-mode</code> and <code>mgl-try-mode</code>. It is assumed that the lisp is
running under <a href="https://slime.common-lisp.dev/" >Slime</a>. In the
buffer,</p>
<ul>
<li><p>use <code>M-.</code> to visit a test function;</p></li>
<li><p>move between <a href="#TRY:UNEXPECTED%20CONDITION" title="TRY:UNEXPECTED CONDITION"><code>unexpected</code></a> events with keys <code>p</code> and <code>n</code>;</p></li>
<li><p>move between events which are not <a href="#TRY:EXPECTED-SUCCESS%20TYPE" title="TRY:EXPECTED-SUCCESS TYPE"><code>expected-success</code></a>es with <code>P</code>
and <code>N</code>;</p></li>
<li><p>rerun the most recent trial (<a href="#TRY:%21%20VARIABLE" title="TRY:! VARIABLE"><code>try:!</code></a>) with <code>r</code> (subject to the
filtering described <a href="#TRY:@TRY%2FRERUN%20MGL-PAX:SECTION" title="Rerunning Trials">Rerunning Trials</a>);</p></li>
<li><p>rerun the most recently finished test with <code>R</code> (and all tests it
calls);</p></li>
<li><p>run an arbitrary test with <code>t</code> (defaults to symbol under point);</p></li>
<li><p>some low-level outline mode commands are also given convenient
bindings:</p>
<pre><code><tab> outline-cycle
C-p outline-previous-visible-heading
C-n outline-next-visible-heading
U outline-up-heading
</code></pre></li>
</ul>
<p><a id="x-28TRY-3A-40TRY-2FEMACS-SETUP-20MGL-PAX-3ASECTION-29"></a>
<a id="TRY:@TRY%2FEMACS-SETUP%20MGL-PAX:SECTION"></a></p>
<p><span class="outer-navigation"><span class="navigation"> <a href="#TRY:@TRY%2FEMACS%20MGL-PAX:SECTION" title="Emacs Integration">←</a> <a href="#TRY:@TRY%2FEMACS%20MGL-PAX:SECTION" title="Emacs Integration">↑</a> <a href="#TRY:@TRY%2FEVENTS%20MGL-PAX:SECTION" title="Events">→</a> <a href="#TRY:@TRY%2FEMACS-SETUP%20MGL-PAX:SECTION" title="Emacs Setup">↺</a> <a href="https://github.com/melisgl/try/blob/599bb1bc08bb74fc77136dba1f22318486596baa/src/manual.lisp#L449">λ</a></span></span></p>
<h3><a href="#TRY:@TRY%2FEMACS-SETUP%20MGL-PAX:SECTION">4.1 Emacs Setup</a></h3>
<p>Load <code>src/mgl-try.el</code> in Emacs.</p>
<p>If you installed Try with Quicklisp, the location of <code>mgl-try.el</code>
may change with updates, and you may want to copy the current
version of <code>mgl-try.el</code> to a stable location:</p>
<pre><code>(try:install-try-elisp "~/quicklisp/")
</code></pre>
<p>Then, assuming the Elisp file is in the quicklisp directory, add
something like this to your <code>.emacs</code>:</p>
<pre><code><span class="code"><span class="paren1">(<span class="code"><a href="http://www.gnu.org/software/emacs/elisp-manual/html_node/elisp_196.html#IDX517" class="symbol">load</a> <span class="string">"~/quicklisp/mgl-try.el"</span></span>)</span></span></code></pre>
<p><a id="x-28TRY-3AINSTALL-TRY-ELISP-20FUNCTION-29"></a>
<a id="TRY:INSTALL-TRY-ELISP%20FUNCTION"></a></p>
<ul>
<li><p><span class=reference-bullet><span class=reference><span class="locative-type"><a href="https://github.com/melisgl/try/blob/599bb1bc08bb74fc77136dba1f22318486596baa/src/manual.lisp#L466">[function]</a></span> <span class="reference-object"><a href="#TRY:INSTALL-TRY-ELISP%20FUNCTION" >install-try-elisp</a></span></span> <span class="locative-args">target-dir</span></span></p>
<p>Copy <code>mgl-try.el</code> distributed with this package to <code>target-dir</code>.</p></li>
</ul>
<p><a id="x-28TRY-3A-40TRY-2FEVENTS-20MGL-PAX-3ASECTION-29"></a>
<a id="TRY:@TRY%2FEVENTS%20MGL-PAX:SECTION"></a></p>
<p><span class="outer-navigation"><span class="navigation"> <a href="#TRY:@TRY%2FEMACS-SETUP%20MGL-PAX:SECTION" title="Emacs Setup">←</a> <a href="try-manual.html" title="Try Manual">↑</a> <a href="#TRY:@TRY%2FMIDDLE-LAYER-OF-EVENTS%20MGL-PAX:SECTION" title="Middle Layer of Events">→</a> <a href="#TRY:@TRY%2FEVENTS%20MGL-PAX:SECTION" title="Events">↺</a> <a href="https://github.com/melisgl/try/blob/599bb1bc08bb74fc77136dba1f22318486596baa/src/events.lisp#L5">λ</a></span></span></p>
<h2><a href="#TRY:@TRY%2FEVENTS%20MGL-PAX:SECTION">5 Events</a></h2>
<p>Try is built around events implemented as <a href="http://www.lispworks.com/documentation/HyperSpec/Body/e_cnd.htm" title="CONDITION (MGL-PAX:CLHS CONDITION)"><code>condition</code></a>s.
Matching the types of events to <a href="#TRY:*DEBUG*%20VARIABLE" title="TRY:*DEBUG* VARIABLE"><code>*debug*</code></a>, <a href="#TRY:*COUNT*%20VARIABLE" title="TRY:*COUNT* VARIABLE"><code>*count*</code></a>, <a href="#TRY:*COLLECT*%20VARIABLE" title="TRY:*COLLECT* VARIABLE"><code>*collect*</code></a>, <a href="#TRY:*RERUN*%20VARIABLE" title="TRY:*RERUN* VARIABLE"><code>*rerun*</code></a>,
<a href="#TRY:*PRINT*%20VARIABLE" title="TRY:*PRINT* VARIABLE"><code>*print*</code></a>, and <a href="#TRY:*DESCRIBE*%20VARIABLE" title="TRY:*DESCRIBE* VARIABLE"><code>*describe*</code></a> is what gives Try its flexibility.</p>
<p><a id="x-28TRY-3A-40TRY-2FMIDDLE-LAYER-OF-EVENTS-20MGL-PAX-3ASECTION-29"></a>
<a id="TRY:@TRY%2FMIDDLE-LAYER-OF-EVENTS%20MGL-PAX:SECTION"></a></p>
<p><span class="outer-navigation"><span class="navigation"> <a href="#TRY:@TRY%2FEVENTS%20MGL-PAX:SECTION" title="Events">←</a> <a href="#TRY:@TRY%2FEVENTS%20MGL-PAX:SECTION" title="Events">↑</a> <a href="#TRY:@TRY%2FCONCRETE-EVENTS%20MGL-PAX:SECTION" title="Concrete Events">→</a> <a href="#TRY:@TRY%2FMIDDLE-LAYER-OF-EVENTS%20MGL-PAX:SECTION" title="Middle Layer of Events">↺</a> <a href="https://github.com/melisgl/try/blob/599bb1bc08bb74fc77136dba1f22318486596baa/src/events.lisp#L18">λ</a></span></span></p>
<h3><a href="#TRY:@TRY%2FMIDDLE-LAYER-OF-EVENTS%20MGL-PAX:SECTION">5.1 Middle Layer of Events</a></h3>
<p>The event hierarchy is fairly involved, so let's start in the middle.
The condition <a href="#TRY:EVENT%20CONDITION" title="TRY:EVENT CONDITION"><code>event</code></a> has 4 disjoint subclasses:</p>
<ul>
<li><p><a href="#TRY:TRIAL-START%20CONDITION" title="TRY:TRIAL-START CONDITION"><code>trial-start</code></a>, which corresponds to the entry to a test (see
<a href="#TRY:@TRY%2FTESTS%20MGL-PAX:SECTION" title="Tests">Tests</a>),</p></li>
<li><p><a href="#TRY:VERDICT%20CONDITION" title="TRY:VERDICT CONDITION"><code>verdict</code></a>, the <a href="#TRY:OUTCOME%20CONDITION" title="TRY:OUTCOME CONDITION"><code>outcome</code></a> of a <a href="#TRY:TRIAL%20CLASS" title="TRY:TRIAL CLASS"><code>trial</code></a>,</p></li>
<li><p><a href="#TRY:RESULT%20CONDITION" title="TRY:RESULT CONDITION"><code>result</code></a>, the <code>outcome</code> of a check (see <a href="#TRY:@TRY%2FCHECKS%20MGL-PAX:SECTION" title="Checks">Checks</a>), and</p></li>
<li><p><a href="#TRY:ERROR*%20CONDITION" title="TRY:ERROR* CONDITION"><code>error*</code></a>, an unexpected <code>cl:error</code>(<a href="http://www.lispworks.com/documentation/HyperSpec/Body/e_error.htm" title="ERROR (MGL-PAX:CLHS CONDITION)"><code>0</code></a> <a href="http://www.lispworks.com/documentation/HyperSpec/Body/f_error.htm" title="ERROR (MGL-PAX:CLHS FUNCTION)"><code>1</code></a>) or unadorned <a href="http://www.lispworks.com/documentation/HyperSpec/Body/26_glo_n.htm#non-local_exit" title=""non-local exit" (MGL-PAX:CLHS MGL-PAX:GLOSSARY-TERM)">non-local exit</a>.</p></li>
</ul>
<pre><code><span class="code"><span class="paren1">(<span class="code"><i><span class="symbol">let</span></i> <span class="paren2">(<span class="code"><span class="comment">;; We don't want to debug nor print a backtrace for the error below.
</span> <span class="paren3">(<span class="code"><span class="special">*debug*</span> nil</span>)</span>
<span class="paren3">(<span class="code"><span class="special">*describe*</span> nil</span>)</span></span>)</span>
<span class="comment">;; signals TRIAL-START / VERDICT-ABORT* on entry / exit
</span> <span class="paren2">(<span class="code"><i><span class="symbol">with-test</span></i> <span class="paren3">(<span class="code">demo</span>)</span>
<span class="comment">;; signals EXPECTED-RESULT-SUCCESS
</span> <span class="paren3">(<span class="code">is t</span>)</span>
<span class="comment">;; signals UNHANDLED-ERROR with a nested CL:ERROR
</span> <span class="paren3">(<span class="code">error <span class="string">"xxx"</span></span>)</span></span>)</span></span>)</span>
.. DEMO <span class="comment">; TRIAL-START
</span>.. ⋅ <span class="paren1">(<span class="code">IS T</span>)</span> <span class="comment">; EXPECTED-RESULT-SUCCESS (⋅)
</span>.. ⊟ "xxx" <span class="paren1">(<span class="code">SIMPLE-ERROR</span>)</span> <span class="comment">; UNHANDLED-ERROR (⊟)
</span>.. ⊟ DEMO ⊟1 ⋅1 <span class="comment">; VERDICT-ABORT* (⊟)
</span>..
==> #<TRIAL <span class="paren1">(<span class="code"><i><span class="symbol">WITH-TEST</span></i> <span class="paren2">(<span class="code">DEMO</span>)</span></span>)</span> ABORT* 0.004s ⊟1 ⋅1></span></code></pre>
<p><a id="x-28TRY-3A-40TRY-2FCONCRETE-EVENTS-20MGL-PAX-3ASECTION-29"></a>
<a id="TRY:@TRY%2FCONCRETE-EVENTS%20MGL-PAX:SECTION"></a></p>
<p><span class="outer-navigation"><span class="navigation"> <a href="#TRY:@TRY%2FMIDDLE-LAYER-OF-EVENTS%20MGL-PAX:SECTION" title="Middle Layer of Events">←</a> <a href="#TRY:@TRY%2FEVENTS%20MGL-PAX:SECTION" title="Events">↑</a> <a href="#TRY:@TRY%2FEVENT-GLUE%20MGL-PAX:SECTION" title="Event Glue">→</a> <a href="#TRY:@TRY%2FCONCRETE-EVENTS%20MGL-PAX:SECTION" title="Concrete Events">↺</a> <a href="https://github.com/melisgl/try/blob/599bb1bc08bb74fc77136dba1f22318486596baa/src/events.lisp#L50">λ</a></span></span></p>
<h3><a href="#TRY:@TRY%2FCONCRETE-EVENTS%20MGL-PAX:SECTION">5.2 Concrete Events</a></h3>
<p>The non-abstract condition classes of events that are actually
signalled are called concrete.</p>
<p><a href="#TRY:TRIAL-START%20CONDITION" title="TRY:TRIAL-START CONDITION"><code>trial-start</code></a> is a concrete event class. <a href="#TRY:RESULT%20CONDITION" title="TRY:RESULT CONDITION"><code>result</code></a>s and <a href="#TRY:VERDICT%20CONDITION" title="TRY:VERDICT CONDITION"><code>verdict</code></a>s have six
concrete subclasses:</p>
<ul>
<li><p><a href="#TRY:EXPECTED-RESULT-SUCCESS%20CONDITION" title="TRY:EXPECTED-RESULT-SUCCESS CONDITION"><code>expected-result-success</code></a>, <a href="#TRY:UNEXPECTED-RESULT-SUCCESS%20CONDITION" title="TRY:UNEXPECTED-RESULT-SUCCESS CONDITION"><code>unexpected-result-success</code></a>,
<a href="#TRY:EXPECTED-RESULT-FAILURE%20CONDITION" title="TRY:EXPECTED-RESULT-FAILURE CONDITION"><code>expected-result-failure</code></a>, <a href="#TRY:UNEXPECTED-RESULT-FAILURE%20CONDITION" title="TRY:UNEXPECTED-RESULT-FAILURE CONDITION"><code>unexpected-result-failure</code></a>,
<a href="#TRY:RESULT-SKIP%20CONDITION" title="TRY:RESULT-SKIP CONDITION"><code>result-skip</code></a>, <a href="#TRY:RESULT-ABORT*%20CONDITION" title="TRY:RESULT-ABORT* CONDITION"><code>result-abort*</code></a></p></li>
<li><p><a href="#TRY:EXPECTED-VERDICT-SUCCESS%20CONDITION" title="TRY:EXPECTED-VERDICT-SUCCESS CONDITION"><code>expected-verdict-success</code></a>, <a href="#TRY:UNEXPECTED-VERDICT-SUCCESS%20CONDITION" title="TRY:UNEXPECTED-VERDICT-SUCCESS CONDITION"><code>unexpected-verdict-success</code></a>,
<a href="#TRY:EXPECTED-VERDICT-FAILURE%20CONDITION" title="TRY:EXPECTED-VERDICT-FAILURE CONDITION"><code>expected-verdict-failure</code></a>, <a href="#TRY:UNEXPECTED-VERDICT-FAILURE%20CONDITION" title="TRY:UNEXPECTED-VERDICT-FAILURE CONDITION"><code>unexpected-verdict-failure</code></a>,
<a href="#TRY:VERDICT-SKIP%20CONDITION" title="TRY:VERDICT-SKIP CONDITION"><code>verdict-skip</code></a>, <a href="#TRY:VERDICT-ABORT*%20CONDITION" title="TRY:VERDICT-ABORT* CONDITION"><code>verdict-abort*</code></a></p></li>
</ul>
<p><a href="#TRY:ERROR*%20CONDITION" title="TRY:ERROR* CONDITION"><code>error*</code></a> is an abstract class with two concrete subclasses:</p>
<ul>
<li><p><a href="#TRY:UNHANDLED-ERROR%20CONDITION" title="TRY:UNHANDLED-ERROR CONDITION"><code>unhandled-error</code></a>, signalled when a <code>cl:error</code>(<a href="http://www.lispworks.com/documentation/HyperSpec/Body/e_error.htm" title="ERROR (MGL-PAX:CLHS CONDITION)"><code>0</code></a> <a href="http://www.lispworks.com/documentation/HyperSpec/Body/f_error.htm" title="ERROR (MGL-PAX:CLHS FUNCTION)"><code>1</code></a>) reaches the handler set
up by <a href="#TRY:DEFTEST%20MGL-PAX:MACRO" title="TRY:DEFTEST MGL-PAX:MACRO"><code>deftest</code></a> or <a href="#TRY:WITH-TEST%20MGL-PAX:MACRO" title="TRY:WITH-TEST MGL-PAX:MACRO"><code>with-test</code></a>, or when the debugger is invoked.</p></li>
<li><p><a href="#TRY:NLX%20CONDITION" title="TRY:NLX CONDITION"><code>nlx</code></a>, signalled when no error was detected by the handler, but the
trial finishes with a <a href="http://www.lispworks.com/documentation/HyperSpec/Body/26_glo_n.htm#non-local_exit" title=""non-local exit" (MGL-PAX:CLHS MGL-PAX:GLOSSARY-TERM)">non-local exit</a>.</p></li>
</ul>
<p>These are the 15 concrete event classes.</p>
<p><a id="x-28TRY-3A-40TRY-2FEVENT-GLUE-20MGL-PAX-3ASECTION-29"></a>
<a id="TRY:@TRY%2FEVENT-GLUE%20MGL-PAX:SECTION"></a></p>
<p><span class="outer-navigation"><span class="navigation"> <a href="#TRY:@TRY%2FCONCRETE-EVENTS%20MGL-PAX:SECTION" title="Concrete Events">←</a> <a href="#TRY:@TRY%2FEVENTS%20MGL-PAX:SECTION" title="Events">↑</a> <a href="#TRY:@TRY%2FPRINTING-EVENTS%20MGL-PAX:SECTION" title="Printing Events">→</a> <a href="#TRY:@TRY%2FEVENT-GLUE%20MGL-PAX:SECTION" title="Event Glue">↺</a> <a href="https://github.com/melisgl/try/blob/599bb1bc08bb74fc77136dba1f22318486596baa/src/events.lisp#L76">λ</a></span></span></p>
<h3><a href="#TRY:@TRY%2FEVENT-GLUE%20MGL-PAX:SECTION">5.3 Event Glue</a></h3>
<p>These condition classes group various bits of the
<a href="#TRY:@TRY%2FCONCRETE-EVENTS%20MGL-PAX:SECTION" title="Concrete Events">Concrete Events</a> and the <a href="#TRY:@TRY%2FMIDDLE-LAYER-OF-EVENTS%20MGL-PAX:SECTION" title="Middle Layer of Events">Middle Layer of Events</a> for ease of
reference.</p>
<p>Concrete event classes except <a href="#TRY:TRIAL-START%20CONDITION" title="TRY:TRIAL-START CONDITION"><code>trial-start</code></a> are subclasses of
hyphen-separated words in their name. For example,
<a href="#TRY:UNEXPECTED-RESULT-FAILURE%20CONDITION" title="TRY:UNEXPECTED-RESULT-FAILURE CONDITION"><code>unexpected-result-failure</code></a> inherits from <a href="#TRY:UNEXPECTED%20CONDITION" title="TRY:UNEXPECTED CONDITION"><code>unexpected</code></a>, <a href="#TRY:RESULT%20CONDITION" title="TRY:RESULT CONDITION"><code>result</code></a>, and
<a href="#TRY:FAILURE%20CONDITION" title="TRY:FAILURE CONDITION"><code>failure</code></a>, so it matches types such as <code>unexpected</code> or <code>(and unexpected
result)</code>.</p>
<p><a id="x-28TRY-3AEVENT-20CONDITION-29"></a>
<a id="TRY:EVENT%20CONDITION"></a></p>
<ul>
<li><p><span class=reference-bullet><span class=reference><span class="locative-type"><a href="https://github.com/melisgl/try/blob/599bb1bc08bb74fc77136dba1f22318486596baa/src/events.lisp#L118">[condition]</a></span> <span class="reference-object"><a href="#TRY:EVENT%20CONDITION" >event</a></span></span></span></p>
<p>Common abstract superclass of all events in Try.</p></li>
</ul>
<p><a id="x-28TRY-3AEXPECTED-20CONDITION-29"></a>
<a id="TRY:EXPECTED%20CONDITION"></a></p>
<ul>
<li><p><span class=reference-bullet><span class=reference><span class="locative-type"><a href="https://github.com/melisgl/try/blob/599bb1bc08bb74fc77136dba1f22318486596baa/src/events.lisp#L124">[condition]</a></span> <span class="reference-object"><a href="#TRY:EXPECTED%20CONDITION" >expected</a></span></span> <span class="locative-args"><a href="#TRY:EVENT%20CONDITION" title="TRY:EVENT CONDITION">event</a></span></span></p>
<p>Concrete condition classes with <code>expected</code> in their
name are subclasses of <code>expected</code>. <a href="#TRY:SKIP%20CONDITION" title="TRY:SKIP CONDITION"><code>skip</code></a> is also a subclass of
<code>expected</code>.</p></li>
</ul>
<p><a id="x-28TRY-3AUNEXPECTED-20CONDITION-29"></a>
<a id="TRY:UNEXPECTED%20CONDITION"></a></p>
<ul>
<li><p><span class=reference-bullet><span class=reference><span class="locative-type"><a href="https://github.com/melisgl/try/blob/599bb1bc08bb74fc77136dba1f22318486596baa/src/events.lisp#L129">[condition]</a></span> <span class="reference-object"><a href="#TRY:UNEXPECTED%20CONDITION" >unexpected</a></span></span> <span class="locative-args"><a href="#TRY:EVENT%20CONDITION" title="TRY:EVENT CONDITION">event</a></span></span></p>
<p>Concrete condition classes with <code>unexpected</code> in their
name are subclasses of <code>unexpected</code>. <a href="#TRY:ABORT*%20CONDITION" title="TRY:ABORT* CONDITION"><code>abort*</code></a> is also a subclass of
<code>unexpected</code>.</p></li>
</ul>
<p><a id="x-28TRY-3ASUCCESS-20CONDITION-29"></a>
<a id="TRY:SUCCESS%20CONDITION"></a></p>
<ul>
<li><p><span class=reference-bullet><span class=reference><span class="locative-type"><a href="https://github.com/melisgl/try/blob/599bb1bc08bb74fc77136dba1f22318486596baa/src/events.lisp#L134">[condition]</a></span> <span class="reference-object"><a href="#TRY:SUCCESS%20CONDITION" >success</a></span></span> <span class="locative-args"><a href="#TRY:EVENT%20CONDITION" title="TRY:EVENT CONDITION">event</a></span></span></p>
<p>See <a href="#TRY:@TRY%2FCHECKS%20MGL-PAX:SECTION" title="Checks">Checks</a> and <a href="#TRY:@TRY%2FTRIAL-VERDICTS%20MGL-PAX:SECTION" title="Trial Verdicts">Trial Verdicts</a> for how
<code>success</code> or <a href="#TRY:FAILURE%20CONDITION" title="TRY:FAILURE CONDITION"><code>failure</code></a> is decided.</p></li>
</ul>
<p><a id="x-28TRY-3AFAILURE-20CONDITION-29"></a>
<a id="TRY:FAILURE%20CONDITION"></a></p>
<ul>
<li><p><span class=reference-bullet><span class=reference><span class="locative-type"><a href="https://github.com/melisgl/try/blob/599bb1bc08bb74fc77136dba1f22318486596baa/src/events.lisp#L138">[condition]</a></span> <span class="reference-object"><a href="#TRY:FAILURE%20CONDITION" >failure</a></span></span> <span class="locative-args"><a href="#TRY:EVENT%20CONDITION" title="TRY:EVENT CONDITION">event</a></span></span></p>
<p>See <a href="#TRY:SUCCESS%20CONDITION" title="TRY:SUCCESS CONDITION"><code>success</code></a>.</p></li>
</ul>
<p><a id="x-28TRY-3ADISMISSAL-20CONDITION-29"></a>
<a id="TRY:DISMISSAL%20CONDITION"></a></p>
<ul>
<li><p><span class=reference-bullet><span class=reference><span class="locative-type"><a href="https://github.com/melisgl/try/blob/599bb1bc08bb74fc77136dba1f22318486596baa/src/events.lisp#L141">[condition]</a></span> <span class="reference-object"><a href="#TRY:DISMISSAL%20CONDITION" >dismissal</a></span></span> <span class="locative-args"><a href="#TRY:EVENT%20CONDITION" title="TRY:EVENT CONDITION">event</a></span></span></p>
<p>The third possibility after <a href="#TRY:SUCCESS%20CONDITION" title="TRY:SUCCESS CONDITION"><code>success</code></a> and <a href="#TRY:FAILURE%20CONDITION" title="TRY:FAILURE CONDITION"><code>failure</code></a>.
Either <a href="#TRY:SKIP%20CONDITION" title="TRY:SKIP CONDITION"><code>skip</code></a> or <a href="#TRY:ABORT*%20CONDITION" title="TRY:ABORT* CONDITION"><code>abort*</code></a>.</p></li>
</ul>
<p><a id="x-28TRY-3AABORT-2A-20CONDITION-29"></a>
<a id="TRY:ABORT*%20CONDITION"></a></p>
<ul>
<li><p><span class=reference-bullet><span class=reference><span class="locative-type"><a href="https://github.com/melisgl/try/blob/599bb1bc08bb74fc77136dba1f22318486596baa/src/events.lisp#L145">[condition]</a></span> <span class="reference-object"><a href="#TRY:ABORT*%20CONDITION" >abort*</a></span></span> <span class="locative-args"><a href="#TRY:UNEXPECTED%20CONDITION" title="TRY:UNEXPECTED CONDITION">unexpected</a></span></span></p>
<p><a href="#TRY:RESULT-ABORT*%20CONDITION" title="TRY:RESULT-ABORT* CONDITION"><code>result-abort*</code></a>, <a href="#TRY:VERDICT-ABORT*%20CONDITION" title="TRY:VERDICT-ABORT* CONDITION"><code>verdict-abort*</code></a> or <a href="#TRY:ERROR*%20CONDITION" title="TRY:ERROR* CONDITION"><code>error*</code></a>.</p></li>
</ul>
<p><a id="x-28TRY-3ASKIP-20CONDITION-29"></a>
<a id="TRY:SKIP%20CONDITION"></a></p>
<ul>
<li><p><span class=reference-bullet><span class=reference><span class="locative-type"><a href="https://github.com/melisgl/try/blob/599bb1bc08bb74fc77136dba1f22318486596baa/src/outcome.lisp#L128">[condition]</a></span> <span class="reference-object"><a href="#TRY:SKIP%20CONDITION" >skip</a></span></span> <span class="locative-args"><a href="#TRY:EXPECTED%20CONDITION" title="TRY:EXPECTED CONDITION">expected</a> <a href="#TRY:DISMISSAL%20CONDITION" title="TRY:DISMISSAL CONDITION">dismissal</a></span></span></p>
<p><a href="#TRY:RESULT-SKIP%20CONDITION" title="TRY:RESULT-SKIP CONDITION"><code>result-skip</code></a> or <a href="#TRY:VERDICT-SKIP%20CONDITION" title="TRY:VERDICT-SKIP CONDITION"><code>verdict-skip</code></a>.</p></li>
</ul>
<p><a id="x-28TRY-3ALEAF-20CONDITION-29"></a>
<a id="TRY:LEAF%20CONDITION"></a></p>
<ul>
<li><p><span class=reference-bullet><span class=reference><span class="locative-type"><a href="https://github.com/melisgl/try/blob/599bb1bc08bb74fc77136dba1f22318486596baa/src/events.lisp#L121">[condition]</a></span> <span class="reference-object"><a href="#TRY:LEAF%20CONDITION" >leaf</a></span></span> <span class="locative-args"><a href="#TRY:EVENT%20CONDITION" title="TRY:EVENT CONDITION">event</a></span></span></p>
<p><a href="#TRY:RESULT%20CONDITION" title="TRY:RESULT CONDITION"><code>result</code></a> or <a href="#TRY:ERROR*%20CONDITION" title="TRY:ERROR* CONDITION"><code>error*</code></a>.</p></li>
</ul>
<p><a id="x-28TRY-3AEXPECTED-SUCCESS-20TYPE-29"></a>
<a id="TRY:EXPECTED-SUCCESS%20TYPE"></a></p>
<ul>
<li><p><span class=reference-bullet><span class=reference><span class="locative-type"><a href="https://github.com/melisgl/try/blob/599bb1bc08bb74fc77136dba1f22318486596baa/src/events.lisp#L149">[type]</a></span> <span class="reference-object"><a href="#TRY:EXPECTED-SUCCESS%20TYPE" >expected-success</a></span></span></span></p>
<p>A shorthand for <code>(and expected success)</code>.</p></li>
</ul>
<p><a id="x-28TRY-3AUNEXPECTED-SUCCESS-20TYPE-29"></a>
<a id="TRY:UNEXPECTED-SUCCESS%20TYPE"></a></p>
<ul>
<li><p><span class=reference-bullet><span class=reference><span class="locative-type"><a href="https://github.com/melisgl/try/blob/599bb1bc08bb74fc77136dba1f22318486596baa/src/events.lisp#L152">[type]</a></span> <span class="reference-object"><a href="#TRY:UNEXPECTED-SUCCESS%20TYPE" >unexpected-success</a></span></span></span></p>
<p>A shorthand for <code>(and unexpected success)</code>.</p></li>
</ul>
<p><a id="x-28TRY-3AEXPECTED-FAILURE-20TYPE-29"></a>
<a id="TRY:EXPECTED-FAILURE%20TYPE"></a></p>
<ul>
<li><p><span class=reference-bullet><span class=reference><span class="locative-type"><a href="https://github.com/melisgl/try/blob/599bb1bc08bb74fc77136dba1f22318486596baa/src/events.lisp#L155">[type]</a></span> <span class="reference-object"><a href="#TRY:EXPECTED-FAILURE%20TYPE" >expected-failure</a></span></span></span></p>
<p>A shorthand for <code>(and expected failure)</code>.</p></li>
</ul>
<p><a id="x-28TRY-3AUNEXPECTED-FAILURE-20TYPE-29"></a>
<a id="TRY:UNEXPECTED-FAILURE%20TYPE"></a></p>
<ul>
<li><p><span class=reference-bullet><span class=reference><span class="locative-type"><a href="https://github.com/melisgl/try/blob/599bb1bc08bb74fc77136dba1f22318486596baa/src/events.lisp#L158">[type]</a></span> <span class="reference-object"><a href="#TRY:UNEXPECTED-FAILURE%20TYPE" >unexpected-failure</a></span></span></span></p>
<p>A shorthand for <code>(and unexpected failure)</code>.</p></li>
</ul>
<p><a id="x-28TRY-3APASS-20TYPE-29"></a>
<a id="TRY:PASS%20TYPE"></a></p>
<ul>
<li><p><span class=reference-bullet><span class=reference><span class="locative-type"><a href="https://github.com/melisgl/try/blob/599bb1bc08bb74fc77136dba1f22318486596baa/src/events.lisp#L162">[type]</a></span> <span class="reference-object"><a href="#TRY:PASS%20TYPE" >pass</a></span></span></span></p>
<p>An <a href="#TRY:OUTCOME%20CONDITION" title="TRY:OUTCOME CONDITION"><code>outcome</code></a> that's not an <a href="#TRY:ABORT*%20CONDITION" title="TRY:ABORT* CONDITION"><code>abort*</code></a> or an <a href="#TRY:UNEXPECTED%20CONDITION" title="TRY:UNEXPECTED CONDITION"><code>unexpected</code></a> <a href="#TRY:FAILURE%20CONDITION" title="TRY:FAILURE CONDITION"><code>failure</code></a>.</p></li>
</ul>
<p><a id="x-28TRY-3AFAIL-20TYPE-29"></a>
<a id="TRY:FAIL%20TYPE"></a></p>
<ul>
<li><p><span class=reference-bullet><span class=reference><span class="locative-type"><a href="https://github.com/melisgl/try/blob/599bb1bc08bb74fc77136dba1f22318486596baa/src/events.lisp#L165">[type]</a></span> <span class="reference-object"><a href="#TRY:FAIL%20TYPE" >fail</a></span></span></span></p>
<p>An <a href="#TRY:ABORT*%20CONDITION" title="TRY:ABORT* CONDITION"><code>abort*</code></a> or an <a href="#TRY:UNEXPECTED%20CONDITION" title="TRY:UNEXPECTED CONDITION"><code>unexpected</code></a> <a href="#TRY:FAILURE%20CONDITION" title="TRY:FAILURE CONDITION"><code>failure</code></a>.</p></li>
</ul>
<p><a id="x-28TRY-3A-40TRY-2FPRINTING-EVENTS-20MGL-PAX-3ASECTION-29"></a>
<a id="TRY:@TRY%2FPRINTING-EVENTS%20MGL-PAX:SECTION"></a></p>
<p><span class="outer-navigation"><span class="navigation"> <a href="#TRY:@TRY%2FEVENT-GLUE%20MGL-PAX:SECTION" title="Event Glue">←</a> <a href="#TRY:@TRY%2FEVENTS%20MGL-PAX:SECTION" title="Events">↑</a> <a href="#TRY:@TRY%2FEVENT-RESTARTS%20MGL-PAX:SECTION" title="Event Restarts">→</a> <a href="#TRY:@TRY%2FPRINTING-EVENTS%20MGL-PAX:SECTION" title="Printing Events">↺</a> <a href="https://github.com/melisgl/try/blob/599bb1bc08bb74fc77136dba1f22318486596baa/src/events.lisp#L170">λ</a></span></span></p>
<h3><a href="#TRY:@TRY%2FPRINTING-EVENTS%20MGL-PAX:SECTION">5.4 Printing Events</a></h3>
<p><a id="x-28TRY-3A-2AEVENT-PRINT-BINDINGS-2A-20VARIABLE-29"></a>
<a id="TRY:*EVENT-PRINT-BINDINGS*%20VARIABLE"></a></p>
<ul>
<li><p><span class=reference-bullet><span class=reference><span class="locative-type"><a href="https://github.com/melisgl/try/blob/599bb1bc08bb74fc77136dba1f22318486596baa/src/events.lisp#L173">[variable]</a></span> <span class="reference-object"><a href="#TRY:*EVENT-PRINT-BINDINGS*%20VARIABLE" >*event-print-bindings*</a></span></span> <span class="locative-args">((*print-circle* t))</span></span></p>
<p><a href="#TRY:EVENT%20CONDITION" title="TRY:EVENT CONDITION"><code>event</code></a>s are conditions signalled in code that may change printer
variables such as <a href="http://www.lispworks.com/documentation/HyperSpec/Body/v_pr_cir.htm" title="*PRINT-CIRCLE* (MGL-PAX:CLHS VARIABLE)"><code>*print-circle*</code></a>, <a href="http://www.lispworks.com/documentation/HyperSpec/Body/v_pr_lev.htm" title="*PRINT-LENGTH* (MGL-PAX:CLHS VARIABLE)"><code>*print-length*</code></a>, etc. To control
how events are printed, the list of variable bindings in
<code>*event-print-bindings*</code> is established whenever an <code>event</code> is printed
as if with:</p>
<pre><code><span class="code"><span class="paren1">(<span class="code"><i><span class="symbol">progv</span></i> <span class="paren2">(<span class="code">mapcar #'first <span class="special">*event-print-bindings*</span></span>)</span>
<span class="paren2">(<span class="code">mapcar #'second <span class="special">*event-print-bindings*</span></span>)</span>
...</span>)</span></span></code></pre>
<p>The default value ensures that shared structure is recognized (see
<a href="#TRY:@TRY%2FCAPTURES%20MGL-PAX:SECTION" title="Captures">Captures</a>). If the <code>#n#</code> syntax feels cumbersome, then change
this variable.</p></li>
</ul>
<p><a id="x-28TRY-3A-40TRY-2FEVENT-RESTARTS-20MGL-PAX-3ASECTION-29"></a>
<a id="TRY:@TRY%2FEVENT-RESTARTS%20MGL-PAX:SECTION"></a></p>
<p><span class="outer-navigation"><span class="navigation"> <a href="#TRY:@TRY%2FPRINTING-EVENTS%20MGL-PAX:SECTION" title="Printing Events">←</a> <a href="#TRY:@TRY%2FEVENTS%20MGL-PAX:SECTION" title="Events">↑</a> <a href="#TRY:@TRY%2FOUTCOMES%20MGL-PAX:SECTION" title="Outcomes">→</a> <a href="#TRY:@TRY%2FEVENT-RESTARTS%20MGL-PAX:SECTION" title="Event Restarts">↺</a> <a href="https://github.com/melisgl/try/blob/599bb1bc08bb74fc77136dba1f22318486596baa/src/events.lisp#L209">λ</a></span></span></p>
<h3><a href="#TRY:@TRY%2FEVENT-RESTARTS%20MGL-PAX:SECTION">5.5 Event Restarts</a></h3>
<p>Only <a href="#TRY:RECORD-EVENT%20FUNCTION" title="TRY:RECORD-EVENT FUNCTION"><code>record-event</code></a> is applicable to all <a href="#TRY:EVENT%20CONDITION" title="TRY:EVENT CONDITION"><code>event</code></a>s. See
<a href="#TRY:@TRY%2FCHECK-RESTARTS%20MGL-PAX:SECTION" title="Check Restarts">Check Restarts</a>, <a href="#TRY:@TRY%2FTRIAL-RESTARTS%20MGL-PAX:SECTION" title="Trial Restarts">Trial Restarts</a> for more.</p>
<p><a id="x-28TRY-3ARECORD-EVENT-20FUNCTION-29"></a>
<a id="TRY:RECORD-EVENT%20FUNCTION"></a></p>
<ul>
<li><p><span class=reference-bullet><span class=reference><span class="locative-type"><a href="https://github.com/melisgl/try/blob/599bb1bc08bb74fc77136dba1f22318486596baa/src/events.lisp#L214">[function]</a></span> <span class="reference-object"><a href="#TRY:RECORD-EVENT%20FUNCTION" >record-event</a></span></span> <span class="locative-args">&optional condition</span></span></p>
<p>This restart is always the first restart available when an <a href="#TRY:EVENT%20CONDITION" title="TRY:EVENT CONDITION"><code>event</code></a> is
signalled running under <a href="#TRY:TRY%20FUNCTION" title="TRY:TRY FUNCTION"><code>try</code></a> (i.e. there is a <a href="#TRY:CURRENT-TRIAL%20FUNCTION" title="TRY:CURRENT-TRIAL FUNCTION"><code>current-trial</code></a>). <code>try</code>
always invokes <code>record-event</code> when handling events.</p></li>
</ul>
<p><a id="x-28TRY-3A-40TRY-2FOUTCOMES-20MGL-PAX-3ASECTION-29"></a>
<a id="TRY:@TRY%2FOUTCOMES%20MGL-PAX:SECTION"></a></p>
<p><span class="outer-navigation"><span class="navigation"> <a href="#TRY:@TRY%2FEVENT-RESTARTS%20MGL-PAX:SECTION" title="Event Restarts">←</a> <a href="#TRY:@TRY%2FEVENTS%20MGL-PAX:SECTION" title="Events">↑</a> <a href="#TRY:@TRY%2FOUTCOME-RESTARTS%20MGL-PAX:SECTION" title="Outcome Restarts">→</a> <a href="#TRY:@TRY%2FOUTCOMES%20MGL-PAX:SECTION" title="Outcomes">↺</a> <a href="https://github.com/melisgl/try/blob/599bb1bc08bb74fc77136dba1f22318486596baa/src/outcome.lisp#L3">λ</a></span></span></p>
<h3><a href="#TRY:@TRY%2FOUTCOMES%20MGL-PAX:SECTION">5.6 Outcomes</a></h3>
<p><a id="x-28TRY-3AOUTCOME-20CONDITION-29"></a>
<a id="TRY:OUTCOME%20CONDITION"></a></p>
<ul>
<li><p><span class=reference-bullet><span class=reference><span class="locative-type"><a href="https://github.com/melisgl/try/blob/599bb1bc08bb74fc77136dba1f22318486596baa/src/outcome.lisp#L12">[condition]</a></span> <span class="reference-object"><a href="#TRY:OUTCOME%20CONDITION" >outcome</a></span></span> <span class="locative-args"><a href="#TRY:EVENT%20CONDITION" title="TRY:EVENT CONDITION">event</a></span></span></p>
<p>An <code>outcome</code> is the resolution of either a <a href="#TRY:TRIAL%20CLASS" title="TRY:TRIAL CLASS"><code>trial</code></a> or a
check (see <a href="#TRY:@TRY%2FCHECKS%20MGL-PAX:SECTION" title="Checks">Checks</a>), corresponding to subclasses <a href="#TRY:VERDICT%20CONDITION" title="TRY:VERDICT CONDITION"><code>verdict</code></a> and
<a href="#TRY:RESULT%20CONDITION" title="TRY:RESULT CONDITION"><code>result</code></a>.</p></li>
</ul>
<p><a id="x-28TRY-3AWITH-EXPECTED-OUTCOME-20MGL-PAX-3AMACRO-29"></a>
<a id="TRY:WITH-EXPECTED-OUTCOME%20MGL-PAX:MACRO"></a></p>
<ul>
<li><p><span class=reference-bullet><span class=reference><span class="locative-type"><a href="https://github.com/melisgl/try/blob/599bb1bc08bb74fc77136dba1f22318486596baa/src/outcome.lisp#L20">[macro]</a></span> <span class="reference-object"><a href="#TRY:WITH-EXPECTED-OUTCOME%20MGL-PAX:MACRO" >with-expected-outcome</a></span></span> <span class="locative-args">(expected-type) &body body</span></span></p>
<p>When an <a href="#TRY:OUTCOME%20CONDITION" title="TRY:OUTCOME CONDITION"><code>outcome</code></a> is to be signalled, <code>expected-type</code> determines
whether it's going to be <a href="#TRY:EXPECTED%20CONDITION" title="TRY:EXPECTED CONDITION"><code>expected</code></a>. The concrete <code>outcome</code> classes are
<code>{expected,unexpected}-{result,verdict}-{success,failure}</code> (see
<a href="#TRY:@TRY%2FEVENTS%20MGL-PAX:SECTION" title="Events">Events</a>), of which <a href="#TRY:RESULT%20CONDITION" title="TRY:RESULT CONDITION"><code>result</code></a> or <a href="#TRY:VERDICT%20CONDITION" title="TRY:VERDICT CONDITION"><code>verdict</code></a> and <a href="#TRY:SUCCESS%20CONDITION" title="TRY:SUCCESS CONDITION"><code>success</code></a> or <a href="#TRY:FAILURE%20CONDITION" title="TRY:FAILURE CONDITION"><code>failure</code></a> are
already known. If a <code>result</code> <code>failure</code> is to be signalled, then the
moral equivalent of <code>(subtypep '(and result failure) expected-type)</code>
is evaluated and depending on whether it's true,
<a href="#TRY:EXPECTED-RESULT-FAILURE%20CONDITION" title="TRY:EXPECTED-RESULT-FAILURE CONDITION"><code>expected-result-failure</code></a> or <a href="#TRY:UNEXPECTED-RESULT-FAILURE%20CONDITION" title="TRY:UNEXPECTED-RESULT-FAILURE CONDITION"><code>unexpected-result-failure</code></a> is signalled.</p>
<p>By default, <code>success</code> is expected. The following example shows how to
expect both <code>success</code> and <code>failure</code> for <code>result</code>s, while requiring
<code>verdict</code>s to succeed:</p>
<pre><code><span class="code"><span class="paren1">(<span class="code"><i><span class="symbol">let</span></i> <span class="paren2">(<span class="code"><span class="paren3">(<span class="code"><span class="special">*debug*</span> nil</span>)</span></span>)</span>
<span class="paren2">(<span class="code"><i><span class="symbol">with-expected-outcome</span></i> <span class="paren3">(<span class="code">'<span class="paren4">(<span class="code">or result <span class="paren5">(<span class="code">and verdict success</span>)</span></span>)</span></span>)</span>
<span class="paren3">(<span class="code"><i><span class="symbol">with-test</span></i> <span class="paren4">(<span class="code">t1</span>)</span>
<span class="paren4">(<span class="code">is nil</span>)</span></span>)</span></span>)</span></span>)</span>
.. T1
.. × <span class="paren1">(<span class="code">IS NIL</span>)</span>
.. ⋅ T1 ×1
..
==> #<TRIAL <span class="paren1">(<span class="code"><i><span class="symbol">WITH-TEST</span></i> <span class="paren2">(<span class="code">T1</span>)</span></span>)</span> EXPECTED-SUCCESS 0.000s ×1></span></code></pre>
<p>This is equivalent to <code>(with-failure-expected () ...)</code>. To make
result failures expected but result successes unexpected:</p>
<pre><code><span class="code"><span class="paren1">(<span class="code"><i><span class="symbol">let</span></i> <span class="paren2">(<span class="code"><span class="paren3">(<span class="code"><span class="special">*debug*</span> nil</span>)</span></span>)</span>
<span class="paren2">(<span class="code"><i><span class="symbol">with-expected-outcome</span></i> <span class="paren3">(<span class="code">'<span class="paren4">(<span class="code">or <span class="paren5">(<span class="code">and result failure</span>)</span> <span class="paren5">(<span class="code">and verdict success</span>)</span></span>)</span></span>)</span>
<span class="paren3">(<span class="code"><i><span class="symbol">with-test</span></i> <span class="paren4">(<span class="code">t1</span>)</span>
<span class="paren4">(<span class="code">is t</span>)</span>
<span class="paren4">(<span class="code">is nil</span>)</span></span>)</span></span>)</span></span>)</span>
.. T1
.. ⊡ <span class="paren1">(<span class="code">IS T</span>)</span>
.. × <span class="paren1">(<span class="code">IS NIL</span>)</span>
.. ⋅ T1 ⊡1 ×1
..
==> #<TRIAL <span class="paren1">(<span class="code"><i><span class="symbol">WITH-TEST</span></i> <span class="paren2">(<span class="code">T1</span>)</span></span>)</span> EXPECTED-SUCCESS 0.000s ⊡1 ×1></span></code></pre>
<p>This is equivalent to <code>(with-failure-expected ('failure) ...)</code>. The
final example leaves result failures unexpected but makes both
verdict successes and failures expected:</p>
<pre><code><span class="code"><span class="paren1">(<span class="code"><i><span class="symbol">let</span></i> <span class="paren2">(<span class="code"><span class="paren3">(<span class="code"><span class="special">*debug*</span> nil</span>)</span></span>)</span>
<span class="paren2">(<span class="code"><i><span class="symbol">with-expected-outcome</span></i> <span class="paren3">(<span class="code">'<span class="paren4">(<span class="code">or <span class="paren5">(<span class="code">and result success</span>)</span> verdict</span>)</span></span>)</span>
<span class="paren3">(<span class="code"><i><span class="symbol">with-test</span></i> <span class="paren4">(<span class="code">t1</span>)</span>
<span class="paren4">(<span class="code">is nil</span>)</span></span>)</span></span>)</span></span>)</span>
.. T1
.. ⊠ <span class="paren1">(<span class="code">IS NIL</span>)</span>
.. × T1 ⊠1
..
==> #<TRIAL <span class="paren1">(<span class="code"><i><span class="symbol">WITH-TEST</span></i> <span class="paren2">(<span class="code">T1</span>)</span></span>)</span> EXPECTED-FAILURE 0.004s ⊠1></span></code></pre></li>
</ul>
<p><a id="x-28TRY-3AWITH-FAILURE-EXPECTED-20MGL-PAX-3AMACRO-29"></a>
<a id="TRY:WITH-FAILURE-EXPECTED%20MGL-PAX:MACRO"></a></p>
<ul>
<li><p><span class=reference-bullet><span class=reference><span class="locative-type"><a href="https://github.com/melisgl/try/blob/599bb1bc08bb74fc77136dba1f22318486596baa/src/outcome.lisp#L81">[macro]</a></span> <span class="reference-object"><a href="#TRY:WITH-FAILURE-EXPECTED%20MGL-PAX:MACRO" >with-failure-expected</a></span></span> <span class="locative-args">(&optional (result-expected-type t) (verdict-expected-type ''success)) &body body</span></span></p>
<p>A convenience macro on top of <a href="#TRY:WITH-EXPECTED-OUTCOME%20MGL-PAX:MACRO" title="TRY:WITH-EXPECTED-OUTCOME MGL-PAX:MACRO"><code>with-expected-outcome</code></a>,
<code>with-failure-expected</code> expects <a href="#TRY:VERDICT%20CONDITION" title="TRY:VERDICT CONDITION"><code>verdict</code></a>s to have <code>verdict-expected-type</code>
and <a href="#TRY:RESULT%20CONDITION" title="TRY:RESULT CONDITION"><code>result</code></a>s to have <code>result-expected-type</code>. A simple
<code>(with-failure-expected () ...)</code> makes all <code>result</code> <a href="#TRY:SUCCESS%20CONDITION" title="TRY:SUCCESS CONDITION"><code>success</code></a>es and
<a href="#TRY:FAILURE%20CONDITION" title="TRY:FAILURE CONDITION"><code>failure</code></a>s <a href="#TRY:EXPECTED%20CONDITION" title="TRY:EXPECTED CONDITION"><code>expected</code></a>. <code>(with-failure-expected ('failure) ..)</code> expects
<code>failure</code>s only, and any <code>success</code>es will be <a href="#TRY:UNEXPECTED%20CONDITION" title="TRY:UNEXPECTED CONDITION"><code>unexpected</code></a>.</p></li>
</ul>
<p><a id="x-28TRY-3AWITH-SKIP-20MGL-PAX-3AMACRO-29"></a>
<a id="TRY:WITH-SKIP%20MGL-PAX:MACRO"></a></p>
<ul>
<li><p><span class=reference-bullet><span class=reference><span class="locative-type"><a href="https://github.com/melisgl/try/blob/599bb1bc08bb74fc77136dba1f22318486596baa/src/outcome.lisp#L131">[macro]</a></span> <span class="reference-object"><a href="#TRY:WITH-SKIP%20MGL-PAX:MACRO" >with-skip</a></span></span> <span class="locative-args">(&optional (skip t)) &body body</span></span></p>
<p><code>with-skip</code> skips checks and trials. It forces an immediate
<a href="#TRY:SKIP-TRIAL%20FUNCTION" title="TRY:SKIP-TRIAL FUNCTION"><code>skip-trial</code></a> whenever a trial is started (which turns into a
<a href="#TRY:VERDICT-SKIP%20CONDITION" title="TRY:VERDICT-SKIP CONDITION"><code>verdict-skip</code></a>) and makes checks (without intervening trials, of
course) evaluate normally but signal <a href="#TRY:RESULT-SKIP%20CONDITION" title="TRY:RESULT-SKIP CONDITION"><code>result-skip</code></a>. <code>skip</code> is <code>nil</code>
cancels the effect of any enclosing <code>with-skip</code> with <code>skip</code> true.</p></li>
</ul>
<p><a id="x-28TRY-3A-40TRY-2FOUTCOME-RESTARTS-20MGL-PAX-3ASECTION-29"></a>
<a id="TRY:@TRY%2FOUTCOME-RESTARTS%20MGL-PAX:SECTION"></a></p>
<p><span class="outer-navigation"><span class="navigation"> <a href="#TRY:@TRY%2FOUTCOMES%20MGL-PAX:SECTION" title="Outcomes">←</a> <a href="#TRY:@TRY%2FOUTCOMES%20MGL-PAX:SECTION" title="Outcomes">↑</a> <a href="#TRY:@TRY%2FCHECKS%20MGL-PAX:SECTION" title="Checks">→</a> <a href="#TRY:@TRY%2FOUTCOME-RESTARTS%20MGL-PAX:SECTION" title="Outcome Restarts">↺</a> <a href="https://github.com/melisgl/try/blob/599bb1bc08bb74fc77136dba1f22318486596baa/src/outcome.lisp#L245">λ</a></span></span></p>
<h4><a href="#TRY:@TRY%2FOUTCOME-RESTARTS%20MGL-PAX:SECTION">5.6.1 Outcome Restarts</a></h4>
<p><a id="x-28TRY-3AFORCE-EXPECTED-SUCCESS-20FUNCTION-29"></a>
<a id="TRY:FORCE-EXPECTED-SUCCESS%20FUNCTION"></a></p>
<ul>
<li><p><span class=reference-bullet><span class=reference><span class="locative-type"><a href="https://github.com/melisgl/try/blob/599bb1bc08bb74fc77136dba1f22318486596baa/src/outcome.lisp#L251">[function]</a></span> <span class="reference-object"><a href="#TRY:FORCE-EXPECTED-SUCCESS%20FUNCTION" >force-expected-success</a></span></span> <span class="locative-args">&optional condition</span></span></p>
<p>Change the type of the <a href="#TRY:OUTCOME%20CONDITION" title="TRY:OUTCOME CONDITION"><code>outcome</code></a> being signalled to <a href="#TRY:EXPECTED%20CONDITION" title="TRY:EXPECTED CONDITION"><code>expected</code></a> and
<a href="#TRY:SUCCESS%20CONDITION" title="TRY:SUCCESS CONDITION"><code>success</code></a>. If the original condition is a <a href="#TRY:RESULT%20CONDITION" title="TRY:RESULT CONDITION"><code>result</code></a>, then this will be
<a href="#TRY:EXPECTED-RESULT-SUCCESS%20CONDITION" title="TRY:EXPECTED-RESULT-SUCCESS CONDITION"><code>expected-result-success</code></a>, if it is a <a href="#TRY:VERDICT%20CONDITION" title="TRY:VERDICT CONDITION"><code>verdict</code></a>, then
<a href="#TRY:EXPECTED-VERDICT-SUCCESS%20CONDITION" title="TRY:EXPECTED-VERDICT-SUCCESS CONDITION"><code>expected-verdict-success</code></a>.</p></li>
</ul>
<p><a id="x-28TRY-3AFORCE-UNEXPECTED-SUCCESS-20FUNCTION-29"></a>
<a id="TRY:FORCE-UNEXPECTED-SUCCESS%20FUNCTION"></a></p>
<ul>
<li><p><span class=reference-bullet><span class=reference><span class="locative-type"><a href="https://github.com/melisgl/try/blob/599bb1bc08bb74fc77136dba1f22318486596baa/src/outcome.lisp#L259">[function]</a></span> <span class="reference-object"><a href="#TRY:FORCE-UNEXPECTED-SUCCESS%20FUNCTION" >force-unexpected-success</a></span></span> <span class="locative-args">&optional condition</span></span></p>
<p>Change the type of <a href="#TRY:OUTCOME%20CONDITION" title="TRY:OUTCOME CONDITION"><code>outcome</code></a> being signalled to <a href="#TRY:UNEXPECTED%20CONDITION" title="TRY:UNEXPECTED CONDITION"><code>unexpected</code></a> and
<a href="#TRY:SUCCESS%20CONDITION" title="TRY:SUCCESS CONDITION"><code>success</code></a>.</p></li>
</ul>
<p><a id="x-28TRY-3AFORCE-EXPECTED-FAILURE-20FUNCTION-29"></a>
<a id="TRY:FORCE-EXPECTED-FAILURE%20FUNCTION"></a></p>
<ul>
<li><p><span class=reference-bullet><span class=reference><span class="locative-type"><a href="https://github.com/melisgl/try/blob/599bb1bc08bb74fc77136dba1f22318486596baa/src/outcome.lisp#L265">[function]</a></span> <span class="reference-object"><a href="#TRY:FORCE-EXPECTED-FAILURE%20FUNCTION" >force-expected-failure</a></span></span> <span class="locative-args">&optional condition</span></span></p>
<p>Change the type of <a href="#TRY:OUTCOME%20CONDITION" title="TRY:OUTCOME CONDITION"><code>outcome</code></a> being signalled to <a href="#TRY:EXPECTED%20CONDITION" title="TRY:EXPECTED CONDITION"><code>expected</code></a> and
<a href="#TRY:FAILURE%20CONDITION" title="TRY:FAILURE CONDITION"><code>failure</code></a>.</p></li>
</ul>
<p><a id="x-28TRY-3AFORCE-UNEXPECTED-FAILURE-20FUNCTION-29"></a>
<a id="TRY:FORCE-UNEXPECTED-FAILURE%20FUNCTION"></a></p>
<ul>
<li><p><span class=reference-bullet><span class=reference><span class="locative-type"><a href="https://github.com/melisgl/try/blob/599bb1bc08bb74fc77136dba1f22318486596baa/src/outcome.lisp#L271">[function]</a></span> <span class="reference-object"><a href="#TRY:FORCE-UNEXPECTED-FAILURE%20FUNCTION" >force-unexpected-failure</a></span></span> <span class="locative-args">&optional condition</span></span></p>
<p>Change the type of <a href="#TRY:OUTCOME%20CONDITION" title="TRY:OUTCOME CONDITION"><code>outcome</code></a> being signalled to <a href="#TRY:UNEXPECTED%20CONDITION" title="TRY:UNEXPECTED CONDITION"><code>unexpected</code></a> and
<a href="#TRY:FAILURE%20CONDITION" title="TRY:FAILURE CONDITION"><code>failure</code></a>.</p></li>
</ul>
<p><a id="x-28TRY-3A-40TRY-2FCHECKS-20MGL-PAX-3ASECTION-29"></a>
<a id="TRY:@TRY%2FCHECKS%20MGL-PAX:SECTION"></a></p>
<p><span class="outer-navigation"><span class="navigation"> <a href="#TRY:@TRY%2FOUTCOME-RESTARTS%20MGL-PAX:SECTION" title="Outcome Restarts">←</a> <a href="#TRY:@TRY%2FOUTCOMES%20MGL-PAX:SECTION" title="Outcomes">↑</a> <a href="#TRY:@TRY%2FCHECK-RESTARTS%20MGL-PAX:SECTION" title="Check Restarts">→</a> <a href="#TRY:@TRY%2FCHECKS%20MGL-PAX:SECTION" title="Checks">↺</a> <a href="https://github.com/melisgl/try/blob/599bb1bc08bb74fc77136dba1f22318486596baa/src/outcome.lisp#L278">λ</a></span></span></p>
<h4><a href="#TRY:@TRY%2FCHECKS%20MGL-PAX:SECTION">5.6.2 Checks</a></h4>
<p>Checks are like <a href="http://www.lispworks.com/documentation/HyperSpec/Body/m_assert.htm" title="ASSERT (MGL-PAX:CLHS MGL-PAX:MACRO)"><code>cl:assert</code></a>s, they check whether some condition holds
and signal an <a href="#TRY:OUTCOME%20CONDITION" title="TRY:OUTCOME CONDITION"><code>outcome</code></a>. The outcome signalled for checks is a
subclass of <a href="#TRY:RESULT%20CONDITION" title="TRY:RESULT CONDITION"><code>result</code></a>.</p>
<p>Take, for example, <code>(is (= x 5))</code>. Depending on whether <code>x</code> is
indeed 5, some kind of <code>result</code> <a href="#TRY:SUCCESS%20CONDITION" title="TRY:SUCCESS CONDITION"><code>success</code></a> or <a href="#TRY:FAILURE%20CONDITION" title="TRY:FAILURE CONDITION"><code>failure</code></a> will be signalled.
<a href="#TRY:WITH-EXPECTED-OUTCOME%20MGL-PAX:MACRO" title="TRY:WITH-EXPECTED-OUTCOME MGL-PAX:MACRO"><code>with-expected-outcome</code></a> determines whether it's <a href="#TRY:EXPECTED%20CONDITION" title="TRY:EXPECTED CONDITION"><code>expected</code></a> or
<a href="#TRY:UNEXPECTED%20CONDITION" title="TRY:UNEXPECTED CONDITION"><code>unexpected</code></a>, and we have one of <a href="#TRY:EXPECTED-RESULT-SUCCESS%20CONDITION" title="TRY:EXPECTED-RESULT-SUCCESS CONDITION"><code>expected-result-success</code></a>,
<a href="#TRY:UNEXPECTED-RESULT-SUCCESS%20CONDITION" title="TRY:UNEXPECTED-RESULT-SUCCESS CONDITION"><code>unexpected-result-success</code></a>, <a href="#TRY:EXPECTED-RESULT-FAILURE%20CONDITION" title="TRY:EXPECTED-RESULT-FAILURE CONDITION"><code>expected-result-failure</code></a>,
<a href="#TRY:UNEXPECTED-RESULT-FAILURE%20CONDITION" title="TRY:UNEXPECTED-RESULT-FAILURE CONDITION"><code>unexpected-result-failure</code></a> to signal. Furthermore, if <a href="#TRY:WITH-SKIP%20MGL-PAX:MACRO" title="TRY:WITH-SKIP MGL-PAX:MACRO"><code>with-skip</code></a> is in
effect, then <a href="#TRY:RESULT-SKIP%20CONDITION" title="TRY:RESULT-SKIP CONDITION"><code>result-skip</code></a> is signalled.</p>
<p>The result is signalled with <code>#'signal</code> if it is a <a href="#TRY:PASS%20TYPE" title="TRY:PASS TYPE"><code>pass</code></a>, else it's
signalled with <code>#'error</code>. This distinction matters only if the event
is not handled, which is never the case in a <a href="#TRY:TRIAL%20CLASS" title="TRY:TRIAL CLASS"><code>trial</code></a>. Standalone
checks though - those that are not enclosed by a trial - invoke the
debugger on <code>result</code>s which are not of type <a href="#TRY:PASS%20TYPE" title="TRY:PASS TYPE"><code>pass</code></a>.</p>
<p>The signalled <code>result</code> is not final until <a href="#TRY:RECORD-EVENT%20FUNCTION" title="TRY:RECORD-EVENT FUNCTION"><code>record-event</code></a> is invoked on
it, and it can be changed with the <a href="#TRY:@TRY%2FOUTCOME-RESTARTS%20MGL-PAX:SECTION" title="Outcome Restarts">Outcome Restarts</a> and the
<a href="#TRY:@TRY%2FCHECK-RESTARTS%20MGL-PAX:SECTION" title="Check Restarts">Check Restarts</a>.</p>
<p><a id="x-28TRY-3ARESULT-20CONDITION-29"></a>
<a id="TRY:RESULT%20CONDITION"></a></p>
<ul>
<li><span class=reference-bullet><span class=reference><span class="locative-type"><a href="https://github.com/melisgl/try/blob/599bb1bc08bb74fc77136dba1f22318486596baa/src/result.lisp#L3">[condition]</a></span> <span class="reference-object"><a href="#TRY:RESULT%20CONDITION" >result</a></span></span> <span class="locative-args"><a href="#TRY:LEAF%20CONDITION" title="TRY:LEAF CONDITION">leaf</a> <a href="#TRY:OUTCOME%20CONDITION" title="TRY:OUTCOME CONDITION">outcome</a></span></span></li>
</ul>
<p><a id="x-28TRY-3AEXPECTED-RESULT-SUCCESS-20CONDITION-29"></a>
<a id="TRY:EXPECTED-RESULT-SUCCESS%20CONDITION"></a></p>
<ul>
<li><span class=reference-bullet><span class=reference><span class="locative-type"><a href="https://github.com/melisgl/try/blob/599bb1bc08bb74fc77136dba1f22318486596baa/src/result.lisp#L15">[condition]</a></span> <span class="reference-object"><a href="#TRY:EXPECTED-RESULT-SUCCESS%20CONDITION" >expected-result-success</a></span></span> <span class="locative-args"><a href="#TRY:EXPECTED%20CONDITION" title="TRY:EXPECTED CONDITION">expected</a> <a href="#TRY:RESULT%20CONDITION" title="TRY:RESULT CONDITION">result</a> <a href="#TRY:SUCCESS%20CONDITION" title="TRY:SUCCESS CONDITION">success</a></span></span></li>
</ul>
<p><a id="x-28TRY-3AUNEXPECTED-RESULT-SUCCESS-20CONDITION-29"></a>
<a id="TRY:UNEXPECTED-RESULT-SUCCESS%20CONDITION"></a></p>
<ul>
<li><span class=reference-bullet><span class=reference><span class="locative-type"><a href="https://github.com/melisgl/try/blob/599bb1bc08bb74fc77136dba1f22318486596baa/src/result.lisp#L16">[condition]</a></span> <span class="reference-object"><a href="#TRY:UNEXPECTED-RESULT-SUCCESS%20CONDITION" >unexpected-result-success</a></span></span> <span class="locative-args"><a href="#TRY:UNEXPECTED%20CONDITION" title="TRY:UNEXPECTED CONDITION">unexpected</a> <a href="#TRY:RESULT%20CONDITION" title="TRY:RESULT CONDITION">result</a> <a href="#TRY:SUCCESS%20CONDITION" title="TRY:SUCCESS CONDITION">success</a></span></span></li>
</ul>
<p><a id="x-28TRY-3AEXPECTED-RESULT-FAILURE-20CONDITION-29"></a>
<a id="TRY:EXPECTED-RESULT-FAILURE%20CONDITION"></a></p>
<ul>
<li><span class=reference-bullet><span class=reference><span class="locative-type"><a href="https://github.com/melisgl/try/blob/599bb1bc08bb74fc77136dba1f22318486596baa/src/result.lisp#L17">[condition]</a></span> <span class="reference-object"><a href="#TRY:EXPECTED-RESULT-FAILURE%20CONDITION" >expected-result-failure</a></span></span> <span class="locative-args"><a href="#TRY:EXPECTED%20CONDITION" title="TRY:EXPECTED CONDITION">expected</a> <a href="#TRY:RESULT%20CONDITION" title="TRY:RESULT CONDITION">result</a> <a href="#TRY:FAILURE%20CONDITION" title="TRY:FAILURE CONDITION">failure</a></span></span></li>
</ul>
<p><a id="x-28TRY-3AUNEXPECTED-RESULT-FAILURE-20CONDITION-29"></a>
<a id="TRY:UNEXPECTED-RESULT-FAILURE%20CONDITION"></a></p>
<ul>
<li><span class=reference-bullet><span class=reference><span class="locative-type"><a href="https://github.com/melisgl/try/blob/599bb1bc08bb74fc77136dba1f22318486596baa/src/result.lisp#L18">[condition]</a></span> <span class="reference-object"><a href="#TRY:UNEXPECTED-RESULT-FAILURE%20CONDITION" >unexpected-result-failure</a></span></span> <span class="locative-args"><a href="#TRY:UNEXPECTED%20CONDITION" title="TRY:UNEXPECTED CONDITION">unexpected</a> <a href="#TRY:RESULT%20CONDITION" title="TRY:RESULT CONDITION">result</a> <a href="#TRY:FAILURE%20CONDITION" title="TRY:FAILURE CONDITION">failure</a></span></span></li>
</ul>
<p><a id="x-28TRY-3ARESULT-SKIP-20CONDITION-29"></a>
<a id="TRY:RESULT-SKIP%20CONDITION"></a></p>
<ul>
<li><span class=reference-bullet><span class=reference><span class="locative-type"><a href="https://github.com/melisgl/try/blob/599bb1bc08bb74fc77136dba1f22318486596baa/src/result.lisp#L19">[condition]</a></span> <span class="reference-object"><a href="#TRY:RESULT-SKIP%20CONDITION" >result-skip</a></span></span> <span class="locative-args"><a href="#TRY:RESULT%20CONDITION" title="TRY:RESULT CONDITION">result</a> <a href="#TRY:SKIP%20CONDITION" title="TRY:SKIP CONDITION">skip</a></span></span></li>
</ul>
<p><a id="x-28TRY-3ARESULT-ABORT-2A-20CONDITION-29"></a>
<a id="TRY:RESULT-ABORT*%20CONDITION"></a></p>
<ul>
<li><span class=reference-bullet><span class=reference><span class="locative-type"><a href="https://github.com/melisgl/try/blob/599bb1bc08bb74fc77136dba1f22318486596baa/src/result.lisp#L20">[condition]</a></span> <span class="reference-object"><a href="#TRY:RESULT-ABORT*%20CONDITION" >result-abort*</a></span></span> <span class="locative-args"><a href="#TRY:RESULT%20CONDITION" title="TRY:RESULT CONDITION">result</a> <a href="#TRY:ABORT*%20CONDITION" title="TRY:ABORT* CONDITION">abort*</a> <a href="#TRY:DISMISSAL%20CONDITION" title="TRY:DISMISSAL CONDITION">dismissal</a></span></span></li>
</ul>
<p><a id="x-28TRY-3A-40TRY-2FCHECK-RESTARTS-20MGL-PAX-3ASECTION-29"></a>
<a id="TRY:@TRY%2FCHECK-RESTARTS%20MGL-PAX:SECTION"></a></p>
<p><span class="outer-navigation"><span class="navigation"> <a href="#TRY:@TRY%2FCHECKS%20MGL-PAX:SECTION" title="Checks">←</a> <a href="#TRY:@TRY%2FCHECKS%20MGL-PAX:SECTION" title="Checks">↑</a> <a href="#TRY:@TRY%2FTRIALS%20MGL-PAX:SECTION" title="Trials">→</a> <a href="#TRY:@TRY%2FCHECK-RESTARTS%20MGL-PAX:SECTION" title="Check Restarts">↺</a> <a href="https://github.com/melisgl/try/blob/599bb1bc08bb74fc77136dba1f22318486596baa/src/outcome.lisp#L309">λ</a></span></span></p>
<h5><a href="#TRY:@TRY%2FCHECK-RESTARTS%20MGL-PAX:SECTION">Check Restarts</a></h5>
<p><a id="x-28TRY-3AABORT-CHECK-20FUNCTION-29"></a>
<a id="TRY:ABORT-CHECK%20FUNCTION"></a></p>
<ul>
<li><p><span class=reference-bullet><span class=reference><span class="locative-type"><a href="https://github.com/melisgl/try/blob/599bb1bc08bb74fc77136dba1f22318486596baa/src/outcome.lisp#L314">[function]</a></span> <span class="reference-object"><a href="#TRY:ABORT-CHECK%20FUNCTION" >abort-check</a></span></span> <span class="locative-args">&optional condition</span></span></p>
<p>Change the <a href="#TRY:OUTCOME%20CONDITION" title="TRY:OUTCOME CONDITION"><code>outcome</code></a> of the check being signalled to <a href="#TRY:RESULT-ABORT*%20CONDITION" title="TRY:RESULT-ABORT* CONDITION"><code>result-abort*</code></a>.
<code>result-abort*</code>, being <code>(not pass)</code>, will cause the check to return
<code>nil</code> if <a href="#TRY:RECORD-EVENT%20FUNCTION" title="TRY:RECORD-EVENT FUNCTION"><code>record-event</code></a> is invoked on it.</p></li>
</ul>
<p><a id="x-28TRY-3ASKIP-CHECK-20FUNCTION-29"></a>
<a id="TRY:SKIP-CHECK%20FUNCTION"></a></p>
<ul>
<li><p><span class=reference-bullet><span class=reference><span class="locative-type"><a href="https://github.com/melisgl/try/blob/599bb1bc08bb74fc77136dba1f22318486596baa/src/outcome.lisp#L321">[function]</a></span> <span class="reference-object"><a href="#TRY:SKIP-CHECK%20FUNCTION" >skip-check</a></span></span> <span class="locative-args">&optional condition</span></span></p>
<p>Change the <a href="#TRY:OUTCOME%20CONDITION" title="TRY:OUTCOME CONDITION"><code>outcome</code></a> of the check being signalled to <a href="#TRY:RESULT-SKIP%20CONDITION" title="TRY:RESULT-SKIP CONDITION"><code>result-skip</code></a>.
<code>result-skip</code>, being a <a href="#TRY:PASS%20TYPE" title="TRY:PASS TYPE"><code>pass</code></a>, will cause the check to return <code>t</code> if
<code>continue</code>(<a href="http://www.lispworks.com/documentation/HyperSpec/Body/f_abortc.htm" title="CONTINUE (MGL-PAX:CLHS FUNCTION)"><code>0</code></a> <a href="http://www.lispworks.com/documentation/HyperSpec/Body/r_contin.htm" title="CONTINUE (MGL-PAX:CLHS RESTART)"><code>1</code></a>) or <a href="#TRY:RECORD-EVENT%20FUNCTION" title="TRY:RECORD-EVENT FUNCTION"><code>record-event</code></a> is invoked on it.</p></li>
</ul>
<p><a id="x-28TRY-3ARETRY-CHECK-20FUNCTION-29"></a>
<a id="TRY:RETRY-CHECK%20FUNCTION"></a></p>
<ul>
<li><p><span class=reference-bullet><span class=reference><span class="locative-type"><a href="https://github.com/melisgl/try/blob/599bb1bc08bb74fc77136dba1f22318486596baa/src/outcome.lisp#L328">[function]</a></span> <span class="reference-object"><a href="#TRY:RETRY-CHECK%20FUNCTION" >retry-check</a></span></span> <span class="locative-args">&optional condition</span></span></p>
<p>Initiate a <a href="http://www.lispworks.com/documentation/HyperSpec/Body/26_glo_n.htm#non-local_exit" title=""non-local exit" (MGL-PAX:CLHS MGL-PAX:GLOSSARY-TERM)">non-local exit</a> to go reevaluate the forms
wrapped by the check without signalling an <a href="#TRY:OUTCOME%20CONDITION" title="TRY:OUTCOME CONDITION"><code>outcome</code></a>.</p></li>
</ul>
<p><a id="x-28TRY-3A-40TRY-2FTRIALS-20MGL-PAX-3ASECTION-29"></a>
<a id="TRY:@TRY%2FTRIALS%20MGL-PAX:SECTION"></a></p>
<p><span class="outer-navigation"><span class="navigation"> <a href="#TRY:@TRY%2FCHECK-RESTARTS%20MGL-PAX:SECTION" title="Check Restarts">←</a> <a href="#TRY:@TRY%2FOUTCOMES%20MGL-PAX:SECTION" title="Outcomes">↑</a> <a href="#TRY:@TRY%2FTRIAL-EVENTS%20MGL-PAX:SECTION" title="Trial Events">→</a> <a href="#TRY:@TRY%2FTRIALS%20MGL-PAX:SECTION" title="Trials">↺</a> <a href="https://github.com/melisgl/try/blob/599bb1bc08bb74fc77136dba1f22318486596baa/src/trial.lisp#L5">λ</a></span></span></p>
<h4><a href="#TRY:@TRY%2FTRIALS%20MGL-PAX:SECTION">5.6.3 Trials</a></h4>
<p><a id="x-28TRY-3ATRIAL-20CLASS-29"></a>
<a id="TRY:TRIAL%20CLASS"></a></p>
<ul>
<li><p><span class=reference-bullet><span class=reference><span class="locative-type"><a href="https://github.com/melisgl/try/blob/599bb1bc08bb74fc77136dba1f22318486596baa/src/trial.lisp#L14">[class]</a></span> <span class="reference-object"><a href="#TRY:TRIAL%20CLASS" >trial</a></span></span> <span class="locative-args">sb-mop:funcallable-standard-object</span></span></p>
<p>Trials are records of calls to tests (see
<a href="#TRY:@TRY%2FCOUNT%20MGL-PAX:SECTION" title="Counting Events">Counting Events</a>, <a href="#TRY:@TRY%2FCOLLECT%20MGL-PAX:SECTION" title="Collecting Events">Collecting Events</a>). Their behaviour as <a href="#TRY:@FUNCALLABLE-INSTANCE%20MGL-PAX:GLOSSARY-TERM" title="funcallable instance">funcallable instance</a>s
is explained in <a href="#TRY:@TRY%2FRERUN%20MGL-PAX:SECTION" title="Rerunning Trials">Rerunning Trials</a>.</p>
<p>There are three ways to acquire a <code>trial</code> object: by calling
<a href="#TRY:CURRENT-TRIAL%20FUNCTION" title="TRY:CURRENT-TRIAL FUNCTION"><code>current-trial</code></a>, through the lexical binding of the symbol that names
the test or through the return value of a test:</p>
<pre><code><span class="code"><span class="paren1">(<span class="code"><i><span class="symbol">deftest</span></i> xxx <span class="paren2">(<span class="code"></span>)</span>
<span class="paren2">(<span class="code">prin1 xxx</span>)</span></span>)</span>
<span class="paren1">(<span class="code">xxx</span>)</span>
.. #<TRIAL <span class="paren1">(<span class="code">XXX</span>)</span> RUNNING>
==> #<TRIAL <span class="paren1">(<span class="code">XXX</span>)</span> EXPECTED-SUCCESS 0.000s></span></code></pre>
<p><code>with-trial</code> can also provide access to its <code>trial</code>:</p>
<pre><code><span class="code"><span class="paren1">(<span class="code"><i><span class="symbol">with-test</span></i> <span class="paren2">(<span class="code">t0</span>)</span>
<span class="paren2">(<span class="code">prin1 t0</span>)</span></span>)</span>
.. #<TRIAL <span class="paren1">(<span class="code"><i><span class="symbol">WITH-TEST</span></i> <span class="paren2">(<span class="code">T0</span>)</span></span>)</span> RUNNING>
==> #<TRIAL <span class="paren1">(<span class="code"><i><span class="symbol">WITH-TEST</span></i> <span class="paren2">(<span class="code">T0</span>)</span></span>)</span> EXPECTED-SUCCESS 0.000s></span></code></pre>
<p><code>trial</code>s are not to be instantiated by client code.</p></li>
</ul>
<p><a id="x-28TRY-3ACURRENT-TRIAL-20FUNCTION-29"></a>
<a id="TRY:CURRENT-TRIAL%20FUNCTION"></a></p>
<ul>
<li><p><span class=reference-bullet><span class=reference><span class="locative-type"><a href="https://github.com/melisgl/try/blob/599bb1bc08bb74fc77136dba1f22318486596baa/src/trial.lisp#L168">[function]</a></span> <span class="reference-object"><a href="#TRY:CURRENT-TRIAL%20FUNCTION" >current-trial</a></span></span></span></p>
<p><a href="#TRY:TRIAL%20CLASS" title="TRY:TRIAL CLASS"><code>trial</code></a>s, like the calls to tests they stand for, nest. <code>current-trial</code>
returns the innermost trial. If there is no currently running test,
then an error is signalled. The returned trial is <a href="#TRY:RUNNINGP%20FUNCTION" title="TRY:RUNNINGP FUNCTION"><code>runningp</code></a>.</p></li>
</ul>
<p><a id="x-28TRY-3A-40TRY-2FTRIAL-EVENTS-20MGL-PAX-3ASECTION-29"></a>
<a id="TRY:@TRY%2FTRIAL-EVENTS%20MGL-PAX:SECTION"></a></p>
<p><span class="outer-navigation"><span class="navigation"> <a href="#TRY:@TRY%2FTRIALS%20MGL-PAX:SECTION" title="Trials">←</a> <a href="#TRY:@TRY%2FTRIALS%20MGL-PAX:SECTION" title="Trials">↑</a> <a href="#TRY:@TRY%2FTRIAL-VERDICTS%20MGL-PAX:SECTION" title="Trial Verdicts">→</a> <a href="#TRY:@TRY%2FTRIAL-EVENTS%20MGL-PAX:SECTION" title="Trial Events">↺</a> <a href="https://github.com/melisgl/try/blob/599bb1bc08bb74fc77136dba1f22318486596baa/src/trial-event.lisp#L5">λ</a></span></span></p>
<h5><a href="#TRY:@TRY%2FTRIAL-EVENTS%20MGL-PAX:SECTION">Trial Events</a></h5>
<p><a id="x-28TRY-3ATRIAL-EVENT-20CONDITION-29"></a>
<a id="TRY:TRIAL-EVENT%20CONDITION"></a></p>
<ul>
<li><p><span class=reference-bullet><span class=reference><span class="locative-type"><a href="https://github.com/melisgl/try/blob/599bb1bc08bb74fc77136dba1f22318486596baa/src/trial-event.lisp#L17">[condition]</a></span> <span class="reference-object"><a href="#TRY:TRIAL-EVENT%20CONDITION" >trial-event</a></span></span> <span class="locative-args"><a href="#TRY:EVENT%20CONDITION" title="TRY:EVENT CONDITION">event</a></span></span></p>
<p>A <code>trial-event</code> is either a <a href="#TRY:TRIAL-START%20CONDITION" title="TRY:TRIAL-START CONDITION"><code>trial-start</code></a> or a
<a href="#TRY:VERDICT%20CONDITION" title="TRY:VERDICT CONDITION"><code>verdict</code></a>.</p></li>
</ul>
<p><a id="x-28TRY-3ATRIAL-20-28MGL-PAX-3AREADER-20TRY-3ATRIAL-EVENT-29-29"></a>
<a id="TRY:TRIAL%20%28MGL-PAX:READER%20TRY:TRIAL-EVENT%29"></a></p>
<ul>
<li><span class=reference-bullet><span class=reference><span class="locative-type"><a href="https://github.com/melisgl/try/blob/599bb1bc08bb74fc77136dba1f22318486596baa/src/trial-event.lisp#L17">[reader]</a></span> <span class="reference-object"><a href="#TRY:TRIAL%20%28MGL-PAX:READER%20TRY:TRIAL-EVENT%29" >trial</a></span></span> <span class="locative-args">trial-event (:trial)</span></span></li>
</ul>
<p><a id="x-28TRY-3ATRIAL-START-20CONDITION-29"></a>
<a id="TRY:TRIAL-START%20CONDITION"></a></p>
<ul>
<li><p><span class=reference-bullet><span class=reference><span class="locative-type"><a href="https://github.com/melisgl/try/blob/599bb1bc08bb74fc77136dba1f22318486596baa/src/trial-event.lisp#L24">[condition]</a></span> <span class="reference-object"><a href="#TRY:TRIAL-START%20CONDITION" >trial-start</a></span></span> <span class="locative-args"><a href="#TRY:TRIAL-EVENT%20CONDITION" title="TRY:TRIAL-EVENT CONDITION">trial-event</a></span></span></p>
<p><code>trial-start</code> is signalled when a test function
(see <a href="#TRY:@TRY%2FTESTS%20MGL-PAX:SECTION" title="Tests">Tests</a>) is entered and a <a href="#TRY:TRIAL%20CLASS" title="TRY:TRIAL CLASS"><code>trial</code></a> is started, it is already
the <a href="#TRY:CURRENT-TRIAL%20FUNCTION" title="TRY:CURRENT-TRIAL FUNCTION"><code>current-trial</code></a>, and the <a href="#TRY:@TRY%2FTRIAL-RESTARTS%20MGL-PAX:SECTION" title="Trial Restarts">Trial Restarts</a> are available. It is
also signalled when a trial is retried:</p>
<pre><code><span class="code"><span class="paren1">(<span class="code"><i><span class="symbol">let</span></i> <span class="paren2">(<span class="code"><span class="paren3">(<span class="code"><span class="special">*print*</span> nil</span>)</span>
<span class="paren3">(<span class="code">n 0</span>)</span></span>)</span>
<span class="paren2">(<span class="code"><i><span class="symbol">with-test</span></i> <span class="paren3">(<span class="code"></span>)</span>
<span class="paren3">(<span class="code">handler-bind <span class="paren4">(<span class="code"><span class="paren5">(<span class="code">trial-start <span class="paren6">(<span class="code"><i><span class="symbol">lambda</span></i> <span class="paren1">(<span class="code">c</span>)</span>
<span class="paren1">(<span class="code">format t <span class="string">"TRIAL-START for ~S retry#~S~%"</span>
<span class="paren2">(<span class="code">test-name <span class="paren3">(<span class="code">trial c</span>)</span></span>)</span>
<span class="paren2">(<span class="code">n-retries <span class="paren3">(<span class="code">trial c</span>)</span></span>)</span></span>)</span></span>)</span></span>)</span></span>)</span>