Inicio Explorar Ayuda
Iniciar sesión
levovix
/
Nim
espejo de https://github.com/nim-lang/Nim
Seguir 1
Destacar 0
Fork 1
Archivos Incidencias 0 Wiki
Árbol: a82d075c2f
Ramas Etiquetas
Nim
/
unittest.html

unittest.html 85 KB
Histórico Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911 
  1. <?xml version="1.0" encoding="utf-8" ?>
    2. 

  2. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
    3. 

  3. <!--  This file is generated by Nim. -->
    4. 

  4. <html xmlns="https://www.w3.org/1999/xhtml" xml:lang="en" lang="en" data-theme="auto">
    5. 

  5. <head>
    6. 

  6. <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    7. 

  7. <meta name="viewport" content="width=device-width, initial-scale=1.0">
    8. 

  8. <title>std/unittest</title>
    9. 

  9. 

  10. <!-- Google fonts -->
    11. 

  11. <link href='https://fonts.googleapis.com/css?family=Lato:400,600,900' rel='stylesheet' type='text/css'/>
    12. 

  12. <link href='https://fonts.googleapis.com/css?family=Source+Code+Pro:400,500,600' rel='stylesheet' type='text/css'/>
    13. 

  13. 

  14. <!-- Favicon -->
    15. 

  15. <link rel="shortcut icon" href="data:image/x-icon;base64,AAABAAEAEBAAAAEAIABoBAAAFgAAACgAAAAQAAAAIAAAAAEAIAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AAAAAAUAAAAF////AP///wD///8A////AP///wD///8A////AP///wD///8A////AAAAAAIAAABbAAAAlQAAAKIAAACbAAAAmwAAAKIAAACVAAAAWwAAAAL///8A////AP///wD///8A////AAAAABQAAADAAAAAYwAAAA3///8A////AP///wD///8AAAAADQAAAGMAAADAAAAAFP///wD///8A////AP///wAAAACdAAAAOv///wD///8A////AP///wD///8A////AP///wD///8AAAAAOgAAAJ3///8A////AP///wAAAAAnAAAAcP///wAAAAAoAAAASv///wD///8A////AP///wAAAABKAAAAKP///wAAAABwAAAAJ////wD///8AAAAAgQAAABwAAACIAAAAkAAAAJMAAACtAAAAFQAAABUAAACtAAAAkwAAAJAAAACIAAAAHAAAAIH///8A////AAAAAKQAAACrAAAAaP///wD///8AAAAARQAAANIAAADSAAAARf///wD///8AAAAAaAAAAKsAAACk////AAAAADMAAACcAAAAnQAAABj///8A////AP///wAAAAAYAAAAGP///wD///8A////AAAAABgAAACdAAAAnAAAADMAAAB1AAAAwwAAAP8AAADpAAAAsQAAAE4AAAAb////AP///wAAAAAbAAAATgAAALEAAADpAAAA/wAAAMMAAAB1AAAAtwAAAOkAAAD/AAAA/wAAAP8AAADvAAAA3gAAAN4AAADeAAAA3gAAAO8AAAD/AAAA/wAAAP8AAADpAAAAtwAAAGUAAAA/AAAA3wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAADfAAAAPwAAAGX///8A////AAAAAEgAAADtAAAAvwAAAL0AAADGAAAA7wAAAO8AAADGAAAAvQAAAL8AAADtAAAASP///wD///8A////AP///wD///8AAAAAO////wD///8A////AAAAAIcAAACH////AP///wD///8AAAAAO////wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A//8AAP//AAD4HwAA7/cAAN/7AAD//wAAoYUAAJ55AACf+QAAh+EAAAAAAADAAwAA4AcAAP5/AAD//wAA//8AAA=="/>
    16. 

  16. <link rel="icon" type="image/png" sizes="32x32" href="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACAAAAAgCAYAAABzenr0AAAABmJLR0QA/wD/AP+gvaeTAAAACXBIWXMAAA3XAAAN1wFCKJt4AAAAB3RJTUUH4QQQEwksSS9ZWwAAAk1JREFUWMPtll2ITVEUx39nn/O7Y5qR8f05wtCUUr6ZIS++8pEnkZInPImneaCQ5METNdOkeFBKUhMPRIkHKfEuUZSUlGlKPN2TrgfncpvmnntnmlEyq1Z7t89/rf9a6+y99oZxGZf/XeIq61EdtgKXgdXA0xrYAvBjOIF1AI9zvjcC74BSpndrJPkBWDScTF8Aa4E3wDlgHbASaANmVqlcCnwHvgDvgVfAJ+AikAAvgfVZwLnSVZHZaOuKoQi3ZOMi4NkYkpe1p4J7A8BpYAD49hfIy/oqG0+hLomiKP2L5L+1ubn5115S+3OAn4EnwBlgMzCjyt6ZAnQCJ4A7wOs88iRJHvw50HoujuPBoCKwHWiosy8MdfZnAdcHk8dxXFJ3VQbQlCTJvRBCGdRbD4M6uc5glpY3eAihpN5S5w12diSEcCCEcKUO4ljdr15T76ur1FDDLIQQ3qv71EdDOe3Kxj3leRXyk+pxdWnFWod6Wt2bY3de3aSuUHcPBVimHs7mK9WrmeOF6lR1o9qnzskh2ar2qm1qizpfXaPeVGdlmGN5pb09qMxz1Xb1kLqgzn1RyH7JUXW52lr5e/Kqi9qpto7V1atuUzfnARrV7jEib1T76gG2qxdGmXyiekkt1GswPTtek0aBfJp6YySGBfWg2tPQ0FAYgf1stUfdmdcjarbYJEniKIq6gY/Aw+zWHAC+p2labGpqiorFYgGYCEzN7oQdQClN07O1/EfDyGgC0ALMBdYAi4FyK+4H3gLPsxfR1zRNi+NP7nH5J+QntnXe5B5mpfQAAAAASUVORK5CYII=">
    17. 

  17. 

  18. <!-- CSS -->
    19. 

  19. <link rel="stylesheet" type="text/css" href="nimdoc.out.css?v=2.3.1">
    20. 

  20. 

  21. <!-- JS -->
    22. 

  22. <script type="text/javascript" src="dochack.js?v=2.3.1"></script>
    23. 

  23. </head>
    24. 

  24. <body>
    25. 

  25.   <div class="document" id="documentId">
    26. 

  26.     <div class="container">
    27. 

  27.       <h1 class="title">std/unittest</h1>
    28. 

  28.       <div class="row">
    29. 

  29.   <div class="three columns">
    30. 

  30.     <div class="theme-select-wrapper">
    31. 

  31.       <label for="theme-select">Theme:&nbsp;</label>
    32. 

  32.       <select id="theme-select" onchange="setTheme(this.value)">
    33. 

  33.         <option value="auto">🌗 Match OS</option>
    34. 

  34.         <option value="dark">🌑 Dark</option>
    35. 

  35.         <option value="light">🌕 Light</option>
    36. 

  36.       </select>
    37. 

  37.     </div>
    38. 

  38.     <div id="global-links">
    39. 

  39.       <ul class="simple-boot">
    40. 

  40.         <li><a href="manual.html">Manual</a></li>
    41. 

  41.         <li><a href="lib.html">Standard library</a></li>
    42. 

  42.         <li> <a id="indexLink" href="theindex.html">Index</a></li>
    43. 

  43.         <li><a href="compiler/theindex.html">Compiler docs</a></li>
    44. 

  44.         <li><a href="https://nim-lang.github.io/fusion/theindex.html">Fusion docs</a></li>
    45. 

  45.         <li><a href="https://nim-lang.github.io/Nim/">devel</a>, <a href="https://nim-lang.org/documentation.html">stable</a></li>
    46. 

  46.       </ul>
    47. 

  47.     </div>
    48. 

  48.     <div id="searchInputDiv">
    49. 

  49.       Search: <input type="search" id="searchInput"
    50. 

  50.         oninput="search()" />
    51. 

  51.     </div>
    52. 

  52.     
    53. 

  53.     <ul class="simple simple-toc" id="toc-list">
    54. 

  54.   <li><a class="reference" id="testament_toc" href="#testament">Testament</a></li>
    55. 

  55. <li><a class="reference" id="running-a-single-test_toc" href="#running-a-single-test">Running a single test</a></li>
    56. 

  56. <li><a class="reference" id="running-a-single-test-suite_toc" href="#running-a-single-test-suite">Running a single test suite</a></li>
    57. 

  57. <li><a class="reference" id="selecting-tests-by-pattern_toc" href="#selecting-tests-by-pattern">Selecting tests by pattern</a></li>
    58. 

  58. <li><a class="reference" id="examples_toc" href="#examples">Examples</a></li>
    59. 

  59. <li><a class="reference" id="limitationsslashbugs_toc" href="#limitationsslashbugs">Limitations/Bugs</a></li>
    60. 

  60. <li>
    61. 

  61.   <a class="reference reference-toplevel" href="#6" id="56">Imports</a>
    62. 

  62. </li>
    63. 

  63. <li>
    64. 

  64.   <details open>
    65. 

  65.     <summary><a class="reference reference-toplevel" href="#7" id="57">Types</a></summary>
    66. 

  66.     <ul class="simple simple-toc-section">
    67. 

  67.       <li><a class="reference" href="#ConsoleOutputFormatter" title="ConsoleOutputFormatter = ref object of OutputFormatter
    68. 

  68.   ## Have test results printed in color.
    69. 

  69.   ## Default is `auto` depending on `isatty(stdout)`, or override it with
    70. 

  70.   ## `-d:nimUnittestColor:auto|on|off`.
    71. 

  71.   ## 
    72. 

  72.   ## Deprecated: Setting the environment variable `NIMTEST_COLOR` to `always`
    73. 

  73.   ## or `never` changes the default for the non-js target to true or false respectively.
    74. 

  74.   ## Deprecated: the environment variable `NIMTEST_NO_COLOR`, when set, changes the
    75. 

  75.   ## default to true, if `NIMTEST_COLOR` is undefined.
    76. 

  76.   ## Set the verbosity of test results.
    77. 

  77.   ## Default is `PRINT_ALL`, or override with:
    78. 

  78.   ## `-d:nimUnittestOutputLevel:PRINT_ALL|PRINT_FAILURES|PRINT_NONE`.
    79. 

  79.   ## 
    80. 

  80.   ## Deprecated: the `NIMTEST_OUTPUT_LVL` environment variable is set for the non-js target.">ConsoleOutputFormatter</a></li>
    81. 

  81. <li><a class="reference" href="#JUnitOutputFormatter" title="JUnitOutputFormatter = ref object of OutputFormatter">JUnitOutputFormatter</a></li>
    82. 

  82. <li><a class="reference" href="#OutputFormatter" title="OutputFormatter = ref object of RootObj">OutputFormatter</a></li>
    83. 

  83. <li><a class="reference" href="#OutputLevel" title="OutputLevel = enum
    84. 

  84.   PRINT_ALL,                ## Print as much as possible.
    85. 

  85.   PRINT_FAILURES,           ## Print only the failed tests.
    86. 

  86.   PRINT_NONE                 ## Print nothing.">OutputLevel</a></li>
    87. 

  87. <li><a class="reference" href="#TestResult" title="TestResult = object
    88. 

  88.   suiteName*: string ## Name of the test suite that contains this test case.
    89. 

  89.                      ## Can be ``nil`` if the test case is not in a suite.
    90. 

  90.   testName*: string          ## Name of the test case
    91. 

  91.   status*: TestStatus">TestResult</a></li>
    92. 

  92. <li><a class="reference" href="#TestStatus" title="TestStatus = enum
    93. 

  93.   OK, FAILED, SKIPPED">TestStatus</a></li>
    94. 

  94. 

  95.     </ul>
    96. 

  96.   </details>
    97. 

  97. </li>
    98. 

  98. <li>
    99. 

  99.   <details open>
    100. 

  100.     <summary><a class="reference reference-toplevel" href="#8" id="58">Vars</a></summary>
    101. 

  101.     <ul class="simple simple-toc-section">
    102. 

  102.       <li><a class="reference" href="#abortOnError" title="abortOnError {.threadvar.}: bool">abortOnError</a></li>
    103. 

  103. 

  104.     </ul>
    105. 

  105.   </details>
    106. 

  106. </li>
    107. 

  107. <li>
    108. 

  108.   <details open>
    109. 

  109.     <summary><a class="reference reference-toplevel" href="#12" id="62">Procs</a></summary>
    110. 

  110.     <ul class="simple simple-toc-section">
    111. 

  111.       <ul class="simple nested-toc-section">addOutputFormatter
    112. 

  112.   <li><a class="reference" href="#addOutputFormatter%2COutputFormatter" title="addOutputFormatter(formatter: OutputFormatter)">addOutputFormatter(formatter: OutputFormatter)</a></li>
    113. 

  113. 

  114. </ul>
    115. 

  115. <ul class="simple nested-toc-section">checkpoint
    116. 

  116.   <li><a class="reference" href="#checkpoint%2Cstring" title="checkpoint(msg: string)">checkpoint(msg: string)</a></li>
    117. 

  117. 

  118. </ul>
    119. 

  119. <ul class="simple nested-toc-section">close
    120. 

  120.   <li><a class="reference" href="#close%2CJUnitOutputFormatter" title="close(formatter: JUnitOutputFormatter)">close(formatter: JUnitOutputFormatter)</a></li>
    121. 

  121. 

  122. </ul>
    123. 

  123. <ul class="simple nested-toc-section">defaultConsoleFormatter
    124. 

  124.   <li><a class="reference" href="#defaultConsoleFormatter" title="defaultConsoleFormatter(): ConsoleOutputFormatter">defaultConsoleFormatter(): ConsoleOutputFormatter</a></li>
    125. 

  125. 

  126. </ul>
    127. 

  127. <ul class="simple nested-toc-section">delOutputFormatter
    128. 

  128.   <li><a class="reference" href="#delOutputFormatter%2COutputFormatter" title="delOutputFormatter(formatter: OutputFormatter)">delOutputFormatter(formatter: OutputFormatter)</a></li>
    129. 

  129. 

  130. </ul>
    131. 

  131. <ul class="simple nested-toc-section">disableParamFiltering
    132. 

  132.   <li><a class="reference" href="#disableParamFiltering" title="disableParamFiltering()">disableParamFiltering()</a></li>
    133. 

  133. 

  134. </ul>
    135. 

  135. <ul class="simple nested-toc-section">newConsoleOutputFormatter
    136. 

  136.   <li><a class="reference" href="#newConsoleOutputFormatter%2COutputLevel" title="newConsoleOutputFormatter(outputLevel: OutputLevel = outputLevelDefault;
    137. 

  137.                           colorOutput = true): ConsoleOutputFormatter">newConsoleOutputFormatter(outputLevel: OutputLevel = outputLevelDefault;
    138. 

  138.                           colorOutput = true): ConsoleOutputFormatter</a></li>
    139. 

  139. 

  140. </ul>
    141. 

  141. <ul class="simple nested-toc-section">newJUnitOutputFormatter
    142. 

  142.   <li><a class="reference" href="#newJUnitOutputFormatter%2CStream" title="newJUnitOutputFormatter(stream: Stream): JUnitOutputFormatter">newJUnitOutputFormatter(stream: Stream): JUnitOutputFormatter</a></li>
    143. 

  143. 

  144. </ul>
    145. 

  145. <ul class="simple nested-toc-section">resetOutputFormatters
    146. 

  146.   <li><a class="reference" href="#resetOutputFormatters" title="resetOutputFormatters()">resetOutputFormatters()</a></li>
    147. 

  147. 

  148. </ul>
    149. 

  149. 

  150.     </ul>
    151. 

  151.   </details>
    152. 

  152. </li>
    153. 

  153. <li>
    154. 

  154.   <details open>
    155. 

  155.     <summary><a class="reference reference-toplevel" href="#14" id="64">Methods</a></summary>
    156. 

  156.     <ul class="simple simple-toc-section">
    157. 

  157.       <ul class="simple nested-toc-section">failureOccurred
    158. 

  158.   <li><a class="reference" href="#failureOccurred.e%2CConsoleOutputFormatter%2Cseq%5Bstring%5D%2Cstring" title="failureOccurred(formatter: ConsoleOutputFormatter; checkpoints: seq[string];
    159. 

  159.                 stackTrace: string)">failureOccurred(formatter: ConsoleOutputFormatter; checkpoints: seq[string];
    160. 

  160.                 stackTrace: string)</a></li>
    161. 

  161. <li><a class="reference" href="#failureOccurred.e%2CJUnitOutputFormatter%2Cseq%5Bstring%5D%2Cstring" title="failureOccurred(formatter: JUnitOutputFormatter; checkpoints: seq[string];
    162. 

  162.                 stackTrace: string)">failureOccurred(formatter: JUnitOutputFormatter; checkpoints: seq[string];
    163. 

  163.                 stackTrace: string)</a></li>
    164. 

  164. <li><a class="reference" href="#failureOccurred.e%2COutputFormatter%2Cseq%5Bstring%5D%2Cstring" title="failureOccurred(formatter: OutputFormatter; checkpoints: seq[string];
    165. 

  165.                 stackTrace: string)">failureOccurred(formatter: OutputFormatter; checkpoints: seq[string];
    166. 

  166.                 stackTrace: string)</a></li>
    167. 

  167. 

  168. </ul>
    169. 

  169. <ul class="simple nested-toc-section">suiteEnded
    170. 

  170.   <li><a class="reference" href="#suiteEnded.e%2CConsoleOutputFormatter" title="suiteEnded(formatter: ConsoleOutputFormatter)">suiteEnded(formatter: ConsoleOutputFormatter)</a></li>
    171. 

  171. <li><a class="reference" href="#suiteEnded.e%2CJUnitOutputFormatter" title="suiteEnded(formatter: JUnitOutputFormatter)">suiteEnded(formatter: JUnitOutputFormatter)</a></li>
    172. 

  172. <li><a class="reference" href="#suiteEnded.e%2COutputFormatter" title="suiteEnded(formatter: OutputFormatter)">suiteEnded(formatter: OutputFormatter)</a></li>
    173. 

  173. 

  174. </ul>
    175. 

  175. <ul class="simple nested-toc-section">suiteStarted
    176. 

  176.   <li><a class="reference" href="#suiteStarted.e%2CConsoleOutputFormatter%2Cstring" title="suiteStarted(formatter: ConsoleOutputFormatter; suiteName: string)">suiteStarted(formatter: ConsoleOutputFormatter; suiteName: string)</a></li>
    177. 

  177. <li><a class="reference" href="#suiteStarted.e%2CJUnitOutputFormatter%2Cstring" title="suiteStarted(formatter: JUnitOutputFormatter; suiteName: string)">suiteStarted(formatter: JUnitOutputFormatter; suiteName: string)</a></li>
    178. 

  178. <li><a class="reference" href="#suiteStarted.e%2COutputFormatter%2Cstring" title="suiteStarted(formatter: OutputFormatter; suiteName: string)">suiteStarted(formatter: OutputFormatter; suiteName: string)</a></li>
    179. 

  179. 

  180. </ul>
    181. 

  181. <ul class="simple nested-toc-section">testEnded
    182. 

  182.   <li><a class="reference" href="#testEnded.e%2CConsoleOutputFormatter%2CTestResult" title="testEnded(formatter: ConsoleOutputFormatter; testResult: TestResult)">testEnded(formatter: ConsoleOutputFormatter; testResult: TestResult)</a></li>
    183. 

  183. <li><a class="reference" href="#testEnded.e%2CJUnitOutputFormatter%2CTestResult" title="testEnded(formatter: JUnitOutputFormatter; testResult: TestResult)">testEnded(formatter: JUnitOutputFormatter; testResult: TestResult)</a></li>
    184. 

  184. <li><a class="reference" href="#testEnded.e%2COutputFormatter%2CTestResult" title="testEnded(formatter: OutputFormatter; testResult: TestResult)">testEnded(formatter: OutputFormatter; testResult: TestResult)</a></li>
    185. 

  185. 

  186. </ul>
    187. 

  187. <ul class="simple nested-toc-section">testStarted
    188. 

  188.   <li><a class="reference" href="#testStarted.e%2CConsoleOutputFormatter%2Cstring" title="testStarted(formatter: ConsoleOutputFormatter; testName: string)">testStarted(formatter: ConsoleOutputFormatter; testName: string)</a></li>
    189. 

  189. <li><a class="reference" href="#testStarted.e%2CJUnitOutputFormatter%2Cstring" title="testStarted(formatter: JUnitOutputFormatter; testName: string)">testStarted(formatter: JUnitOutputFormatter; testName: string)</a></li>
    190. 

  190. <li><a class="reference" href="#testStarted.e%2COutputFormatter%2Cstring" title="testStarted(formatter: OutputFormatter; testName: string)">testStarted(formatter: OutputFormatter; testName: string)</a></li>
    191. 

  191. 

  192. </ul>
    193. 

  193. 

  194.     </ul>
    195. 

  195.   </details>
    196. 

  196. </li>
    197. 

  197. <li>
    198. 

  198.   <details open>
    199. 

  199.     <summary><a class="reference reference-toplevel" href="#17" id="67">Macros</a></summary>
    200. 

  200.     <ul class="simple simple-toc-section">
    201. 

  201.       <ul class="simple nested-toc-section">check
    202. 

  202.   <li><a class="reference" href="#check.m%2Cuntyped" title="check(conditions: untyped): untyped">check(conditions: untyped): untyped</a></li>
    203. 

  203. 

  204. </ul>
    205. 

  205. <ul class="simple nested-toc-section">expect
    206. 

  206.   <li><a class="reference" href="#expect.m%2Cvarargs%5Btyped%5D%2Cuntyped" title="expect(exceptions: varargs[typed]; body: untyped): untyped">expect(exceptions: varargs[typed]; body: untyped): untyped</a></li>
    207. 

  207. 

  208. </ul>
    209. 

  209. 

  210.     </ul>
    211. 

  211.   </details>
    212. 

  212. </li>
    213. 

  213. <li>
    214. 

  214.   <details open>
    215. 

  215.     <summary><a class="reference reference-toplevel" href="#18" id="68">Templates</a></summary>
    216. 

  216.     <ul class="simple simple-toc-section">
    217. 

  217.       <ul class="simple nested-toc-section">fail
    218. 

  218.   <li><a class="reference" href="#fail.t" title="fail()">fail()</a></li>
    219. 

  219. 

  220. </ul>
    221. 

  221. <ul class="simple nested-toc-section">require
    222. 

  222.   <li><a class="reference" href="#require.t%2Cuntyped" title="require(conditions: untyped)">require(conditions: untyped)</a></li>
    223. 

  223. 

  224. </ul>
    225. 

  225. <ul class="simple nested-toc-section">skip
    226. 

  226.   <li><a class="reference" href="#skip.t" title="skip()">skip()</a></li>
    227. 

  227. 

  228. </ul>
    229. 

  229. <ul class="simple nested-toc-section">suite
    230. 

  230.   <li><a class="reference" href="#suite.t%2C%2C" title="suite(name, body)">suite(name, body)</a></li>
    231. 

  231. 

  232. </ul>
    233. 

  233. <ul class="simple nested-toc-section">test
    234. 

  234.   <li><a class="reference" href="#test.t%2C%2C" title="test(name, body)">test(name, body)</a></li>
    235. 

  235. 

  236. </ul>
    237. 

  237. 

  238.     </ul>
    239. 

  239.   </details>
    240. 

  240. </li>
    241. 

  241. 

  242. </ul>
    243. 

  243. 

  244.   </div>
    245. 

  245.   <div class="nine columns" id="content">
    246. 

  246.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/unittest.nim#L1" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    247. 

  247. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/unittest.nim#L1" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    248. 

  248. 

  249.     <div id="tocRoot"></div>
    250. 

  250.     
    251. 

  251.     <p class="module-desc"><table class="docinfo" frame="void" rules="none"><col class="docinfo-name" /><col class="docinfo-content" /><tbody valign="top"><tr><th class="docinfo-name">Author:</th><td>Zahary Karadjov</td></tr>
    252. 

  252. </tbody></table><p>This module implements boilerplate to make unit testing easy.</p>
    253. 

  253. <p>The test status and name is printed after any output or traceback.</p>
    254. 

  254. <p>Tests can be nested, however failure of a nested test will not mark the parent test as failed. Setup and teardown are inherited. Setup can be overridden locally.</p>
    255. 

  255. <p>Compiled test files as well as <tt class="docutils literal"><span class="pre"><span class="Identifier">nim</span> <span class="Identifier">c</span> <span class="Operator">-</span><span class="Identifier">r</span> <span class="Operator">&lt;</span><span class="Identifier">testfile</span><span class="Operator">.</span><span class="Identifier">nim</span><span class="Operator">&gt;</span></span></tt> exit with 0 for success (no failed tests) or 1 for failure.</p>
    256. 

  256. 

  257. <h1><a class="toc-backref" id="testament" href="#testament">Testament</a></h1><p>Instead of <tt class="docutils literal"><span class="pre"><span class="Identifier">unittest</span></span></tt>, please consider using <a class="reference external" href="testament.html">the Testament tool</a> which offers process isolation for your tests.</p>
    258. 

  258. <p>Alternatively using <tt class="docutils literal"><span class="pre"><span class="Keyword">when</span> <span class="Identifier">isMainModule</span><span class="Punctuation">:</span> <span class="Identifier">doAssert</span> <span class="Identifier">conditionHere</span></span></tt> is usually a much simpler solution for testing purposes.</p>
    259. 

  259. 

  260. <h1><a class="toc-backref" id="running-a-single-test" href="#running-a-single-test">Running a single test</a></h1><p>Specify the test name as a command line argument.</p>
    261. 

  261. <p><pre class="listing"><span class="program">nim</span> <span class="option">c</span> <span class="option">-r</span> <span class="option">test</span> <span class="option">&quot;my test name&quot;</span> <span class="option">&quot;another test&quot;</span></pre></p>
    262. 

  262. <p>Multiple arguments can be used.</p>
    263. 

  263. 

  264. <h1><a class="toc-backref" id="running-a-single-test-suite" href="#running-a-single-test-suite">Running a single test suite</a></h1><p>Specify the suite name delimited by <tt class="docutils literal"><span class="pre"><span class="StringLit">&quot;::&quot;</span></span></tt>.</p>
    265. 

  265. <p><pre class="listing"><span class="program">nim</span> <span class="option">c</span> <span class="option">-r</span> <span class="option">test</span> <span class="option">&quot;my test name::&quot;</span></pre></p>
    266. 

  266. 

  267. <h1><a class="toc-backref" id="selecting-tests-by-pattern" href="#selecting-tests-by-pattern">Selecting tests by pattern</a></h1><p>A single <tt class="docutils literal"><span class="pre">&quot;*&quot;</span></tt> can be used for globbing.</p>
    268. 

  268. <p>Delimit the end of a suite name with <tt class="docutils literal"><span class="pre"><span class="StringLit">&quot;::&quot;</span></span></tt>.</p>
    269. 

  269. <p>Tests matching <strong>any</strong> of the arguments are executed.</p>
    270. 

  270. <p><pre class="listing"><span class="program">nim</span> <span class="option">c</span> <span class="option">-r</span> <span class="option">test</span> <span class="option">fast_suite::mytest1</span> <span class="option">fast_suite::mytest2</span>
    271. 

  271. <span class="program">nim</span> <span class="option">c</span> <span class="option">-r</span> <span class="option">test</span> <span class="option">&quot;fast_suite::mytest*&quot;</span>
    272. 

  272. <span class="program">nim</span> <span class="option">c</span> <span class="option">-r</span> <span class="option">test</span> <span class="option">&quot;auth*::&quot;</span> <span class="option">&quot;crypto::hashing*&quot;</span>
    273. 

  273. <span class="Comment"># Run suites starting with 'bug #' and standalone tests starting with '#'</span>
    274. 

  274. <span class="program">nim</span> <span class="option">c</span> <span class="option">-r</span> <span class="option">test</span> <span class="option">'bug #*::'</span> <span class="option">'::#*'</span></pre></p>
    275. 

  275. 

  276. <h1><a class="toc-backref" id="examples" href="#examples">Examples</a></h1><p><pre class="listing"><span class="Identifier">suite</span> <span class="StringLit">&quot;description for this stuff&quot;</span><span class="Punctuation">:</span>
    277. 

  277.   <span class="Identifier">echo</span> <span class="StringLit">&quot;suite setup: run once before the tests&quot;</span>
    278. 

  278.   
    279. 

  279.   <span class="Identifier">setup</span><span class="Punctuation">:</span>
    280. 

  280.     <span class="Identifier">echo</span> <span class="StringLit">&quot;run before each test&quot;</span>
    281. 

  281.   
    282. 

  282.   <span class="Identifier">teardown</span><span class="Punctuation">:</span>
    283. 

  283.     <span class="Identifier">echo</span> <span class="StringLit">&quot;run after each test&quot;</span>
    284. 

  284.   
    285. 

  285.   <span class="Identifier">test</span> <span class="StringLit">&quot;essential truths&quot;</span><span class="Punctuation">:</span>
    286. 

  286.     <span class="Comment"># give up and stop if this fails</span>
    287. 

  287.     <span class="Identifier">require</span><span class="Punctuation">(</span><span class="Identifier">true</span><span class="Punctuation">)</span>
    288. 

  288.   
    289. 

  289.   <span class="Identifier">test</span> <span class="StringLit">&quot;slightly less obvious stuff&quot;</span><span class="Punctuation">:</span>
    290. 

  290.     <span class="Comment"># print a nasty message and move on, skipping</span>
    291. 

  291.     <span class="Comment"># the remainder of this block</span>
    292. 

  292.     <span class="Identifier">check</span><span class="Punctuation">(</span><span class="DecNumber">1</span> <span class="Operator">!=</span> <span class="DecNumber">1</span><span class="Punctuation">)</span>
    293. 

  293.     <span class="Identifier">check</span><span class="Punctuation">(</span><span class="StringLit">&quot;asd&quot;</span><span class="Punctuation">[</span><span class="DecNumber">2</span><span class="Punctuation">]</span> <span class="Operator">==</span> <span class="CharLit">'d'</span><span class="Punctuation">)</span>
    294. 

  294.   
    295. 

  295.   <span class="Identifier">test</span> <span class="StringLit">&quot;out of bounds error is thrown on bad access&quot;</span><span class="Punctuation">:</span>
    296. 

  296.     <span class="Keyword">let</span> <span class="Identifier">v</span> <span class="Operator">=</span> <span class="Operator">@</span><span class="Punctuation">[</span><span class="DecNumber">1</span><span class="Punctuation">,</span> <span class="DecNumber">2</span><span class="Punctuation">,</span> <span class="DecNumber">3</span><span class="Punctuation">]</span>  <span class="Comment"># you can do initialization here</span>
    297. 

  297.     <span class="Identifier">expect</span><span class="Punctuation">(</span><span class="Identifier">IndexDefect</span><span class="Punctuation">)</span><span class="Punctuation">:</span>
    298. 

  298.       <span class="Keyword">discard</span> <span class="Identifier">v</span><span class="Punctuation">[</span><span class="DecNumber">4</span><span class="Punctuation">]</span>
    299. 

  299.   
    300. 

  300.   <span class="Identifier">echo</span> <span class="StringLit">&quot;suite teardown: run once after the tests&quot;</span></pre></p>
    301. 

  301. 

  302. <h1><a class="toc-backref" id="limitationsslashbugs" href="#limitationsslashbugs">Limitations/Bugs</a></h1><p>Since <tt class="docutils literal"><span class="pre"><span class="Identifier">check</span></span></tt> will rewrite some expressions for supporting checkpoints (namely assigns expressions to variables), some type conversions are not supported. For example <tt class="docutils literal"><span class="pre"><span class="Identifier">check</span> <span class="FloatNumber">4.0</span> <span class="Operator">==</span> <span class="DecNumber">2</span> <span class="Operator">+</span> <span class="DecNumber">2</span></span></tt> won't work. But <tt class="docutils literal"><span class="pre"><span class="Identifier">doAssert</span> <span class="FloatNumber">4.0</span> <span class="Operator">==</span> <span class="DecNumber">2</span> <span class="Operator">+</span> <span class="DecNumber">2</span></span></tt> works. Make sure both sides of the operator (such as <tt class="docutils literal"><span class="pre"><span class="Operator">==</span></span></tt>, <tt class="docutils literal"><span class="pre"><span class="Operator">&gt;=</span></span></tt> and so on) have the same type. </p>
    303. 

  303. </p>
    304. 

  304.     <div class="section" id="6">
    305. 

  305.   <h1><a class="toc-backref" href="#6">Imports</a></h1>
    306. 

  306.   <dl class="item">
    307. 

  307.     <a class="reference external" href="since.html">since</a>, <a class="reference external" href="exitprocs.html">exitprocs</a>, <a class="reference external" href="assertions.html">assertions</a>, <a class="reference external" href="syncio.html">syncio</a>, <a class="reference external" href="macros.html">macros</a>, <a class="reference external" href="strutils.html">strutils</a>, <a class="reference external" href="streams.html">streams</a>, <a class="reference external" href="times.html">times</a>, <a class="reference external" href="sets.html">sets</a>, <a class="reference external" href="sequtils.html">sequtils</a>, <a class="reference external" href="os.html">os</a>, <a class="reference external" href="terminal.html">terminal</a>
    308. 

  308.   </dl>
    309. 

  309. </div>
    310. 

  310. <div class="section" id="7">
    311. 

  311.   <h1><a class="toc-backref" href="#7">Types</a></h1>
    312. 

  312.   <dl class="item">
    313. 

  313.     <div id="ConsoleOutputFormatter">
    314. 

  314.   <dt><pre><a href="unittest.html#ConsoleOutputFormatter"><span class="Identifier">ConsoleOutputFormatter</span></a> <span class="Other">=</span> <span class="Keyword">ref</span> <span class="Keyword">object</span> <span class="Keyword">of</span> <a href="unittest.html#OutputFormatter"><span class="Identifier">OutputFormatter</span></a>
    315. 

  315.   <span class="Comment">## Have test results printed in color.</span>
    316. 

  316.   <span class="Comment">## Default is `auto` depending on `isatty(stdout)`, or override it with</span>
    317. 

  317.   <span class="Comment">## `-d:nimUnittestColor:auto|on|off`.</span>
    318. 

  318.   <span class="Comment">## </span>
    319. 

  319.   <span class="Comment">## Deprecated: Setting the environment variable `NIMTEST_COLOR` to `always`</span>
    320. 

  320.   <span class="Comment">## or `never` changes the default for the non-js target to true or false respectively.</span>
    321. 

  321.   <span class="Comment">## Deprecated: the environment variable `NIMTEST_NO_COLOR`, when set, changes the</span>
    322. 

  322.   <span class="Comment">## default to true, if `NIMTEST_COLOR` is undefined.</span>
    323. 

  323.   <span class="Comment">## Set the verbosity of test results.</span>
    324. 

  324.   <span class="Comment">## Default is `PRINT_ALL`, or override with:</span>
    325. 

  325.   <span class="Comment">## `-d:nimUnittestOutputLevel:PRINT_ALL|PRINT_FAILURES|PRINT_NONE`.</span>
    326. 

  326.   <span class="Comment">## </span>
    327. 

  327.   <span class="Comment">## Deprecated: the `NIMTEST_OUTPUT_LVL` environment variable is set for the non-js target.</span></pre></dt>
    328. 

  328.   <dd>
    329. 

  329.     
    330. 

  330.     
    331. 

  331.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/unittest.nim#L145" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    332. 

  332. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/unittest.nim#L145" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    333. 

  333. 

  334.   </dd>
    335. 

  335. </div>
    336. 

  336. <div id="JUnitOutputFormatter">
    337. 

  337.   <dt><pre><a href="unittest.html#JUnitOutputFormatter"><span class="Identifier">JUnitOutputFormatter</span></a> <span class="Other">=</span> <span class="Keyword">ref</span> <span class="Keyword">object</span> <span class="Keyword">of</span> <a href="unittest.html#OutputFormatter"><span class="Identifier">OutputFormatter</span></a></pre></dt>
    338. 

  338.   <dd>
    339. 

  339.     
    340. 

  340.     
    341. 

  341.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/unittest.nim#L164" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    342. 

  342. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/unittest.nim#L164" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    343. 

  343. 

  344.   </dd>
    345. 

  345. </div>
    346. 

  346. <div id="OutputFormatter">
    347. 

  347.   <dt><pre><a href="unittest.html#OutputFormatter"><span class="Identifier">OutputFormatter</span></a> <span class="Other">=</span> <span class="Keyword">ref</span> <span class="Keyword">object</span> <span class="Keyword">of</span> <a href="system.html#RootObj"><span class="Identifier">RootObj</span></a></pre></dt>
    348. 

  348.   <dd>
    349. 

  349.     
    350. 

  350.     
    351. 

  351.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/unittest.nim#L143" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    352. 

  352. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/unittest.nim#L143" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    353. 

  353. 

  354.   </dd>
    355. 

  355. </div>
    356. 

  356. <div id="OutputLevel">
    357. 

  357.   <dt><pre><a href="unittest.html#OutputLevel"><span class="Identifier">OutputLevel</span></a> <span class="Other">=</span> <span class="Keyword">enum</span>
    358. 

  358.   <span class="Identifier">PRINT_ALL</span><span class="Other">,</span>                <span class="Comment">## Print as much as possible.</span>
    359. 

  359.   <span class="Identifier">PRINT_FAILURES</span><span class="Other">,</span>           <span class="Comment">## Print only the failed tests.</span>
    360. 

  360.   <span class="Identifier">PRINT_NONE</span>                 <span class="Comment">## Print nothing.</span></pre></dt>
    361. 

  361.   <dd>
    362. 

  362.     
    363. 

  363.     The output verbosity of the tests.
    364. 

  364.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/unittest.nim#L130" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    365. 

  365. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/unittest.nim#L130" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    366. 

  366. 

  367.   </dd>
    368. 

  368. </div>
    369. 

  369. <div id="TestResult">
    370. 

  370.   <dt><pre><a href="unittest.html#TestResult"><span class="Identifier">TestResult</span></a> <span class="Other">=</span> <span class="Keyword">object</span>
    371. 

  371.   <span class="Identifier">suiteName</span><span class="Operator">*</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a> <span class="Comment">## Name of the test suite that contains this test case.</span>
    372. 

  372.                      <span class="Comment">## Can be ``nil`` if the test case is not in a suite.</span>
    373. 

  373.   <span class="Identifier">testName</span><span class="Operator">*</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a>          <span class="Comment">## Name of the test case</span>
    374. 

  374.   <span class="Identifier">status</span><span class="Operator">*</span><span class="Other">:</span> <a href="unittest.html#TestStatus"><span class="Identifier">TestStatus</span></a></pre></dt>
    375. 

  375.   <dd>
    376. 

  376.     
    377. 

  377.     
    378. 

  378.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/unittest.nim#L135" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    379. 

  379. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/unittest.nim#L135" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    380. 

  380. 

  381.   </dd>
    382. 

  382. </div>
    383. 

  383. <div id="TestStatus">
    384. 

  384.   <dt><pre><a href="unittest.html#TestStatus"><span class="Identifier">TestStatus</span></a> <span class="Other">=</span> <span class="Keyword">enum</span>
    385. 

  385.   <span class="Identifier">OK</span><span class="Other">,</span> <span class="Identifier">FAILED</span><span class="Other">,</span> <span class="Identifier">SKIPPED</span></pre></dt>
    386. 

  386.   <dd>
    387. 

  387.     
    388. 

  388.     The status of a test when it is done.
    389. 

  389.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/unittest.nim#L125" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    390. 

  390. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/unittest.nim#L125" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    391. 

  391. 

  392.   </dd>
    393. 

  393. </div>
    394. 

  394. 

  395.   </dl>
    396. 

  396. </div>
    397. 

  397. <div class="section" id="8">
    398. 

  398.   <h1><a class="toc-backref" href="#8">Vars</a></h1>
    399. 

  399.   <dl class="item">
    400. 

  400.     <div id="abortOnError">
    401. 

  401.   <dt><pre><a href="unittest.html#abortOnError"><span class="Identifier">abortOnError</span></a> {.<span class="Identifier">threadvar</span>.}<span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a></pre></dt>
    402. 

  402.   <dd>
    403. 

  403.     
    404. 

  404.     <p>Set to true in order to quit immediately on fail. Default is false, or override with <tt class="docutils literal"><span class="pre"><span class="Operator">-</span><span class="Identifier">d</span><span class="Punctuation">:</span><span class="Identifier">nimUnittestAbortOnError</span><span class="Punctuation">:</span><span class="Identifier">on</span><span class="Operator">|</span><span class="Identifier">off</span></span></tt>.</p>
    405. 

  405. <p>Deprecated: can also override depending on whether <tt class="docutils literal"><span class="pre"><span class="Identifier">NIMTEST_ABORT_ON_ERROR</span></span></tt> environment variable is set.</p>
    406. 

  406. 

  407.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/unittest.nim#L171" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    408. 

  408. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/unittest.nim#L171" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    409. 

  409. 

  410.   </dd>
    411. 

  411. </div>
    412. 

  412. 

  413.   </dl>
    414. 

  414. </div>
    415. 

  415. <div class="section" id="12">
    416. 

  416.   <h1><a class="toc-backref" href="#12">Procs</a></h1>
    417. 

  417.   <dl class="item">
    418. 

  418.     <div id="addOutputFormatter-procs-all">
    419. 

  419.   <div id="addOutputFormatter,OutputFormatter">
    420. 

  420.   <dt><pre><span class="Keyword">proc</span> <a href="#addOutputFormatter%2COutputFormatter"><span class="Identifier">addOutputFormatter</span></a><span class="Other">(</span><span class="Identifier">formatter</span><span class="Other">:</span> <a href="unittest.html#OutputFormatter"><span class="Identifier">OutputFormatter</span></a><span class="Other">)</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
    421. 

  421.     <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    422. 

  422.   <dd>
    423. 

  423.     
    424. 

  424.     
    425. 

  425.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/unittest.nim#L213" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    426. 

  426. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/unittest.nim#L213" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    427. 

  427. 

  428.   </dd>
    429. 

  429. </div>
    430. 

  430. 

  431. </div>
    432. 

  432. <div id="checkpoint-procs-all">
    433. 

  433.   <div id="checkpoint,string">
    434. 

  434.   <dt><pre><span class="Keyword">proc</span> <a href="#checkpoint%2Cstring"><span class="Identifier">checkpoint</span></a><span class="Other">(</span><span class="Identifier">msg</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">)</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    435. 

  435.   <dd>
    436. 

  436.     
    437. 

  437.     <p>Set a checkpoint identified by <tt class="docutils literal"><span class="pre"><span class="Identifier">msg</span></span></tt>. Upon test failure all checkpoints encountered so far are printed out. Example:</p>
    438. 

  438. <p><pre class="listing"><span class="Identifier">checkpoint</span><span class="Punctuation">(</span><span class="StringLit">&quot;Checkpoint A&quot;</span><span class="Punctuation">)</span>
    439. 

  439. <span class="Identifier">check</span><span class="Punctuation">(</span><span class="Punctuation">(</span><span class="DecNumber">42</span><span class="Punctuation">,</span> <span class="StringLit">&quot;the Answer to life and everything&quot;</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="Punctuation">(</span><span class="DecNumber">1</span><span class="Punctuation">,</span> <span class="StringLit">&quot;a&quot;</span><span class="Punctuation">)</span><span class="Punctuation">)</span>
    440. 

  440. <span class="Identifier">checkpoint</span><span class="Punctuation">(</span><span class="StringLit">&quot;Checkpoint B&quot;</span><span class="Punctuation">)</span></pre></p>
    441. 

  441. <p>outputs &quot;Checkpoint A&quot; once it fails.</p>
    442. 

  442. 

  443.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/unittest.nim#L581" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    444. 

  444. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/unittest.nim#L581" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    445. 

  445. 

  446.   </dd>
    447. 

  447. </div>
    448. 

  448. 

  449. </div>
    450. 

  450. <div id="close-procs-all">
    451. 

  451.   <div id="close,JUnitOutputFormatter">
    452. 

  452.   <dt><pre><span class="Keyword">proc</span> <a href="#close%2CJUnitOutputFormatter"><span class="Identifier">close</span></a><span class="Other">(</span><span class="Identifier">formatter</span><span class="Other">:</span> <a href="unittest.html#JUnitOutputFormatter"><span class="Identifier">JUnitOutputFormatter</span></a><span class="Other">)</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">IOError</span><span class="Other">,</span> <span class="Identifier">OSError</span><span class="Other">]</span><span class="Other">,</span>
    453. 

  453.     <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">WriteIOEffect</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    454. 

  454.   <dd>
    455. 

  455.     
    456. 

  456.     Completes the report and closes the underlying stream.
    457. 

  457.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/unittest.nim#L336" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    458. 

  458. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/unittest.nim#L336" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    459. 

  459. 

  460.   </dd>
    461. 

  461. </div>
    462. 

  462. 

  463. </div>
    464. 

  464. <div id="defaultConsoleFormatter-procs-all">
    465. 

  465.   <div id="defaultConsoleFormatter">
    466. 

  466.   <dt><pre><span class="Keyword">proc</span> <a href="#defaultConsoleFormatter"><span class="Identifier">defaultConsoleFormatter</span></a><span class="Other">(</span><span class="Other">)</span><span class="Other">:</span> <a href="unittest.html#ConsoleOutputFormatter"><span class="Identifier">ConsoleOutputFormatter</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">ValueError</span><span class="Other">]</span><span class="Other">,</span>
    467. 

  467.     <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">ReadEnvEffect</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    468. 

  468.   <dd>
    469. 

  469.     
    470. 

  470.     
    471. 

  471.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/unittest.nim#L252" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    472. 

  472. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/unittest.nim#L252" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    473. 

  473. 

  474.   </dd>
    475. 

  475. </div>
    476. 

  476. 

  477. </div>
    478. 

  478. <div id="delOutputFormatter-procs-all">
    479. 

  479.   <div id="delOutputFormatter,OutputFormatter">
    480. 

  480.   <dt><pre><span class="Keyword">proc</span> <a href="#delOutputFormatter%2COutputFormatter"><span class="Identifier">delOutputFormatter</span></a><span class="Other">(</span><span class="Identifier">formatter</span><span class="Other">:</span> <a href="unittest.html#OutputFormatter"><span class="Identifier">OutputFormatter</span></a><span class="Other">)</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
    481. 

  481.     <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    482. 

  482.   <dd>
    483. 

  483.     
    484. 

  484.     
    485. 

  485.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/unittest.nim#L216" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    486. 

  486. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/unittest.nim#L216" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    487. 

  487. 

  488.   </dd>
    489. 

  489. </div>
    490. 

  490. 

  491. </div>
    492. 

  492. <div id="disableParamFiltering-procs-all">
    493. 

  493.   <div id="disableParamFiltering">
    494. 

  494.   <dt><pre><span class="Keyword">proc</span> <a href="#disableParamFiltering"><span class="Identifier">disableParamFiltering</span></a><span class="Other">(</span><span class="Other">)</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    495. 

  495.   <dd>
    496. 

  496.     
    497. 

  497.     disables filtering tests with the command line params
    498. 

  498.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/unittest.nim#L785" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    499. 

  499. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/unittest.nim#L785" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    500. 

  500. 

  501.   </dd>
    502. 

  502. </div>
    503. 

  503. 

  504. </div>
    505. 

  505. <div id="newConsoleOutputFormatter-procs-all">
    506. 

  506.   <div id="newConsoleOutputFormatter,OutputLevel">
    507. 

  507.   <dt><pre><span class="Keyword">proc</span> <a href="#newConsoleOutputFormatter%2COutputLevel"><span class="Identifier">newConsoleOutputFormatter</span></a><span class="Other">(</span><span class="Identifier">outputLevel</span><span class="Other">:</span> <a href="unittest.html#OutputLevel"><span class="Identifier">OutputLevel</span></a> <span class="Other">=</span> <span class="Identifier">outputLevelDefault</span><span class="Other">;</span>
    508. 

  508.                                <span class="Identifier">colorOutput</span> <span class="Other">=</span> <span class="Identifier">true</span><span class="Other">)</span><span class="Other">:</span> <a href="unittest.html#ConsoleOutputFormatter"><span class="Identifier">ConsoleOutputFormatter</span></a> {.
    509. 

  509.     <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    510. 

  510.   <dd>
    511. 

  511.     
    512. 

  512.     
    513. 

  513.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/unittest.nim#L223" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    514. 

  514. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/unittest.nim#L223" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    515. 

  515. 

  516.   </dd>
    517. 

  517. </div>
    518. 

  518. 

  519. </div>
    520. 

  520. <div id="newJUnitOutputFormatter-procs-all">
    521. 

  521.   <div id="newJUnitOutputFormatter,Stream">
    522. 

  522.   <dt><pre><span class="Keyword">proc</span> <a href="#newJUnitOutputFormatter%2CStream"><span class="Identifier">newJUnitOutputFormatter</span></a><span class="Other">(</span><span class="Identifier">stream</span><span class="Other">:</span> <a href="streams.html#Stream"><span class="Identifier">Stream</span></a><span class="Other">)</span><span class="Other">:</span> <a href="unittest.html#JUnitOutputFormatter"><span class="Identifier">JUnitOutputFormatter</span></a> {.
    523. 

  523.     <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">IOError</span><span class="Other">,</span> <span class="Identifier">OSError</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">WriteIOEffect</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    524. 

  524.   <dd>
    525. 

  525.     
    526. 

  526.     Creates a formatter that writes report to the specified stream in JUnit format. The <tt class="docutils literal"><span class="pre">stream</span></tt> is NOT closed automatically when the test are finished, because the formatter has no way to know when all tests are finished. You should invoke formatter.close() to finalize the report.
    527. 

  527.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/unittest.nim#L321" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    528. 

  528. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/unittest.nim#L321" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    529. 

  529. 

  530.   </dd>
    531. 

  531. </div>
    532. 

  532. 

  533. </div>
    534. 

  534. <div id="resetOutputFormatters-procs-all">
    535. 

  535.   <div id="resetOutputFormatters">
    536. 

  536.   <dt><pre><span class="Keyword">proc</span> <a href="#resetOutputFormatters"><span class="Identifier">resetOutputFormatters</span></a><span class="Other">(</span><span class="Other">)</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    537. 

  537.   <dd>
    538. 

  538.     
    539. 

  539.     
    540. 

  540.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/unittest.nim#L220" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    541. 

  541. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/unittest.nim#L220" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    542. 

  542. 

  543.   </dd>
    544. 

  544. </div>
    545. 

  545. 

  546. </div>
    547. 

  547. 

  548.   </dl>
    549. 

  549. </div>
    550. 

  550. <div class="section" id="14">
    551. 

  551.   <h1><a class="toc-backref" href="#14">Methods</a></h1>
    552. 

  552.   <dl class="item">
    553. 

  553.     <div id="failureOccurred-methods-all">
    554. 

  554.   <div id="failureOccurred.e,ConsoleOutputFormatter,seq[string],string">
    555. 

  555.   <dt><pre><span class="Keyword">method</span> <a href="#failureOccurred.e%2CConsoleOutputFormatter%2Cseq%5Bstring%5D%2Cstring"><span class="Identifier">failureOccurred</span></a><span class="Other">(</span><span class="Identifier">formatter</span><span class="Other">:</span> <a href="unittest.html#ConsoleOutputFormatter"><span class="Identifier">ConsoleOutputFormatter</span></a><span class="Other">;</span>
    556. 

  556.                        <span class="Identifier">checkpoints</span><span class="Other">:</span> <a href="system.html#seq"><span class="Identifier">seq</span></a><span class="Other">[</span><a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">stackTrace</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">)</span> {.
    557. 

  557.     <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    558. 

  558.   <dd>
    559. 

  559.     
    560. 

  560.     
    561. 

  561.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/unittest.nim#L274" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    562. 

  562. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/unittest.nim#L274" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    563. 

  563. 

  564.   </dd>
    565. 

  565. </div>
    566. 

  566. <div id="failureOccurred.e,JUnitOutputFormatter,seq[string],string">
    567. 

  567.   <dt><pre><span class="Keyword">method</span> <a href="#failureOccurred.e%2CJUnitOutputFormatter%2Cseq%5Bstring%5D%2Cstring"><span class="Identifier">failureOccurred</span></a><span class="Other">(</span><span class="Identifier">formatter</span><span class="Other">:</span> <a href="unittest.html#JUnitOutputFormatter"><span class="Identifier">JUnitOutputFormatter</span></a><span class="Other">;</span>
    568. 

  568.                        <span class="Identifier">checkpoints</span><span class="Other">:</span> <a href="system.html#seq"><span class="Identifier">seq</span></a><span class="Other">[</span><a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">stackTrace</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">)</span> {.
    569. 

  569.     <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    570. 

  570.   <dd>
    571. 

  571.     
    572. 

  572.     <tt class="docutils literal"><span class="pre">stackTrace</span></tt> is provided only if the failure occurred due to an exception. <tt class="docutils literal"><span class="pre">checkpoints</span></tt> is never <tt class="docutils literal"><span class="pre">nil</span></tt>.
    573. 

  573.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/unittest.nim#L349" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    574. 

  574. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/unittest.nim#L349" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    575. 

  575. 

  576.   </dd>
    577. 

  577. </div>
    578. 

  578. <div id="failureOccurred.e,OutputFormatter,seq[string],string">
    579. 

  579.   <dt><pre><span class="Keyword">method</span> <a href="#failureOccurred.e%2COutputFormatter%2Cseq%5Bstring%5D%2Cstring"><span class="Identifier">failureOccurred</span></a><span class="Other">(</span><span class="Identifier">formatter</span><span class="Other">:</span> <a href="unittest.html#OutputFormatter"><span class="Identifier">OutputFormatter</span></a><span class="Other">;</span> <span class="Identifier">checkpoints</span><span class="Other">:</span> <a href="system.html#seq"><span class="Identifier">seq</span></a><span class="Other">[</span><a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">]</span><span class="Other">;</span>
    580. 

  580.                        <span class="Identifier">stackTrace</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">)</span> {.<span class="Identifier">base</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
    581. 

  581.     <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    582. 

  582.   <dd>
    583. 

  583.     
    584. 

  584.     <tt class="docutils literal"><span class="pre">stackTrace</span></tt> is provided only if the failure occurred due to an exception. <tt class="docutils literal"><span class="pre">checkpoints</span></tt> is never <tt class="docutils literal"><span class="pre">nil</span></tt>.
    585. 

  585.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/unittest.nim#L203" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    586. 

  586. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/unittest.nim#L203" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    587. 

  587. 

  588.   </dd>
    589. 

  589. </div>
    590. 

  590. 

  591. </div>
    592. 

  592. <div id="suiteEnded-methods-all">
    593. 

  593.   <div id="suiteEnded.e,ConsoleOutputFormatter">
    594. 

  594.   <dt><pre><span class="Keyword">method</span> <a href="#suiteEnded.e%2CConsoleOutputFormatter"><span class="Identifier">suiteEnded</span></a><span class="Other">(</span><span class="Identifier">formatter</span><span class="Other">:</span> <a href="unittest.html#ConsoleOutputFormatter"><span class="Identifier">ConsoleOutputFormatter</span></a><span class="Other">)</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
    595. 

  595.     <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    596. 

  596.   <dd>
    597. 

  597.     
    598. 

  598.     
    599. 

  599.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/unittest.nim#L303" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    600. 

  600. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/unittest.nim#L303" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    601. 

  601. 

  602.   </dd>
    603. 

  603. </div>
    604. 

  604. <div id="suiteEnded.e,JUnitOutputFormatter">
    605. 

  605.   <dt><pre><span class="Keyword">method</span> <a href="#suiteEnded.e%2CJUnitOutputFormatter"><span class="Identifier">suiteEnded</span></a><span class="Other">(</span><span class="Identifier">formatter</span><span class="Other">:</span> <a href="unittest.html#JUnitOutputFormatter"><span class="Identifier">JUnitOutputFormatter</span></a><span class="Other">)</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">IOError</span><span class="Other">,</span> <span class="Identifier">OSError</span><span class="Other">]</span><span class="Other">,</span>
    606. 

  606.     <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">WriteIOEffect</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    607. 

  607.   <dd>
    608. 

  608.     
    609. 

  609.     
    610. 

  610.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/unittest.nim#L398" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    611. 

  611. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/unittest.nim#L398" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    612. 

  612. 

  613.   </dd>
    614. 

  614. </div>
    615. 

  615. <div id="suiteEnded.e,OutputFormatter">
    616. 

  616.   <dt><pre><span class="Keyword">method</span> <a href="#suiteEnded.e%2COutputFormatter"><span class="Identifier">suiteEnded</span></a><span class="Other">(</span><span class="Identifier">formatter</span><span class="Other">:</span> <a href="unittest.html#OutputFormatter"><span class="Identifier">OutputFormatter</span></a><span class="Other">)</span> {.<span class="Identifier">base</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
    617. 

  617.     <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    618. 

  618.   <dd>
    619. 

  619.     
    620. 

  620.     
    621. 

  621.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/unittest.nim#L210" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    622. 

  622. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/unittest.nim#L210" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    623. 

  623. 

  624.   </dd>
    625. 

  625. </div>
    626. 

  626. 

  627. </div>
    628. 

  628. <div id="suiteStarted-methods-all">
    629. 

  629.   <div id="suiteStarted.e,ConsoleOutputFormatter,string">
    630. 

  630.   <dt><pre><span class="Keyword">method</span> <a href="#suiteStarted.e%2CConsoleOutputFormatter%2Cstring"><span class="Identifier">suiteStarted</span></a><span class="Other">(</span><span class="Identifier">formatter</span><span class="Other">:</span> <a href="unittest.html#ConsoleOutputFormatter"><span class="Identifier">ConsoleOutputFormatter</span></a><span class="Other">;</span> <span class="Identifier">suiteName</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">)</span> {.
    631. 

  631.     <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">IOError</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">WriteIOEffect</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    632. 

  632.   <dd>
    633. 

  633.     
    634. 

  634.     
    635. 

  635.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/unittest.nim#L262" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    636. 

  636. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/unittest.nim#L262" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    637. 

  637. 

  638.   </dd>
    639. 

  639. </div>
    640. 

  640. <div id="suiteStarted.e,JUnitOutputFormatter,string">
    641. 

  641.   <dt><pre><span class="Keyword">method</span> <a href="#suiteStarted.e%2CJUnitOutputFormatter%2Cstring"><span class="Identifier">suiteStarted</span></a><span class="Other">(</span><span class="Identifier">formatter</span><span class="Other">:</span> <a href="unittest.html#JUnitOutputFormatter"><span class="Identifier">JUnitOutputFormatter</span></a><span class="Other">;</span> <span class="Identifier">suiteName</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">)</span> {.
    642. 

  642.     <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">IOError</span><span class="Other">,</span> <span class="Identifier">OSError</span><span class="Other">,</span> <span class="Identifier">ValueError</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">WriteIOEffect</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    643. 

  643.   <dd>
    644. 

  644.     
    645. 

  645.     
    646. 

  646.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/unittest.nim#L341" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    647. 

  647. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/unittest.nim#L341" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    648. 

  648. 

  649.   </dd>
    650. 

  650. </div>
    651. 

  651. <div id="suiteStarted.e,OutputFormatter,string">
    652. 

  652.   <dt><pre><span class="Keyword">method</span> <a href="#suiteStarted.e%2COutputFormatter%2Cstring"><span class="Identifier">suiteStarted</span></a><span class="Other">(</span><span class="Identifier">formatter</span><span class="Other">:</span> <a href="unittest.html#OutputFormatter"><span class="Identifier">OutputFormatter</span></a><span class="Other">;</span> <span class="Identifier">suiteName</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">)</span> {.<span class="Identifier">base</span><span class="Other">,</span>
    653. 

  653.     <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    654. 

  654.   <dd>
    655. 

  655.     
    656. 

  656.     
    657. 

  657.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/unittest.nim#L199" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    658. 

  658. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/unittest.nim#L199" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    659. 

  659. 

  660.   </dd>
    661. 

  661. </div>
    662. 

  662. 

  663. </div>
    664. 

  664. <div id="testEnded-methods-all">
    665. 

  665.   <div id="testEnded.e,ConsoleOutputFormatter,TestResult">
    666. 

  666.   <dt><pre><span class="Keyword">method</span> <a href="#testEnded.e%2CConsoleOutputFormatter%2CTestResult"><span class="Identifier">testEnded</span></a><span class="Other">(</span><span class="Identifier">formatter</span><span class="Other">:</span> <a href="unittest.html#ConsoleOutputFormatter"><span class="Identifier">ConsoleOutputFormatter</span></a><span class="Other">;</span> <span class="Identifier">testResult</span><span class="Other">:</span> <a href="unittest.html#TestResult"><span class="Identifier">TestResult</span></a><span class="Other">)</span> {.
    667. 

  667.     <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">IOError</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">WriteIOEffect</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    668. 

  668.   <dd>
    669. 

  669.     
    670. 

  670.     
    671. 

  671.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/unittest.nim#L282" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    672. 

  672. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/unittest.nim#L282" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    673. 

  673. 

  674.   </dd>
    675. 

  675. </div>
    676. 

  676. <div id="testEnded.e,JUnitOutputFormatter,TestResult">
    677. 

  677.   <dt><pre><span class="Keyword">method</span> <a href="#testEnded.e%2CJUnitOutputFormatter%2CTestResult"><span class="Identifier">testEnded</span></a><span class="Other">(</span><span class="Identifier">formatter</span><span class="Other">:</span> <a href="unittest.html#JUnitOutputFormatter"><span class="Identifier">JUnitOutputFormatter</span></a><span class="Other">;</span> <span class="Identifier">testResult</span><span class="Other">:</span> <a href="unittest.html#TestResult"><span class="Identifier">TestResult</span></a><span class="Other">)</span> {.
    678. 

  678.     <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">IOError</span><span class="Other">,</span> <span class="Identifier">OSError</span><span class="Other">,</span> <span class="Identifier">ValueError</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">TimeEffect</span><span class="Other">,</span> <span class="Identifier">WriteIOEffect</span><span class="Other">]</span><span class="Other">,</span>
    679. 

  679.     <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    680. 

  680.   <dd>
    681. 

  681.     
    682. 

  682.     
    683. 

  683.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/unittest.nim#L357" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    684. 

  684. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/unittest.nim#L357" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    685. 

  685. 

  686.   </dd>
    687. 

  687. </div>
    688. 

  688. <div id="testEnded.e,OutputFormatter,TestResult">
    689. 

  689.   <dt><pre><span class="Keyword">method</span> <a href="#testEnded.e%2COutputFormatter%2CTestResult"><span class="Identifier">testEnded</span></a><span class="Other">(</span><span class="Identifier">formatter</span><span class="Other">:</span> <a href="unittest.html#OutputFormatter"><span class="Identifier">OutputFormatter</span></a><span class="Other">;</span> <span class="Identifier">testResult</span><span class="Other">:</span> <a href="unittest.html#TestResult"><span class="Identifier">TestResult</span></a><span class="Other">)</span> {.<span class="Identifier">base</span><span class="Other">,</span>
    690. 

  690.     <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    691. 

  691.   <dd>
    692. 

  692.     
    693. 

  693.     
    694. 

  694.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/unittest.nim#L208" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    695. 

  695. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/unittest.nim#L208" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    696. 

  696. 

  697.   </dd>
    698. 

  698. </div>
    699. 

  699. 

  700. </div>
    701. 

  701. <div id="testStarted-methods-all">
    702. 

  702.   <div id="testStarted.e,ConsoleOutputFormatter,string">
    703. 

  703.   <dt><pre><span class="Keyword">method</span> <a href="#testStarted.e%2CConsoleOutputFormatter%2Cstring"><span class="Identifier">testStarted</span></a><span class="Other">(</span><span class="Identifier">formatter</span><span class="Other">:</span> <a href="unittest.html#ConsoleOutputFormatter"><span class="Identifier">ConsoleOutputFormatter</span></a><span class="Other">;</span> <span class="Identifier">testName</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">)</span> {.
    704. 

  704.     <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    705. 

  705.   <dd>
    706. 

  706.     
    707. 

  707.     
    708. 

  708.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/unittest.nim#L271" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    709. 

  709. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/unittest.nim#L271" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    710. 

  710. 

  711.   </dd>
    712. 

  712. </div>
    713. 

  713. <div id="testStarted.e,JUnitOutputFormatter,string">
    714. 

  714.   <dt><pre><span class="Keyword">method</span> <a href="#testStarted.e%2CJUnitOutputFormatter%2Cstring"><span class="Identifier">testStarted</span></a><span class="Other">(</span><span class="Identifier">formatter</span><span class="Other">:</span> <a href="unittest.html#JUnitOutputFormatter"><span class="Identifier">JUnitOutputFormatter</span></a><span class="Other">;</span> <span class="Identifier">testName</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">)</span> {.
    715. 

  715.     <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">TimeEffect</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    716. 

  716.   <dd>
    717. 

  717.     
    718. 

  718.     
    719. 

  719.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/unittest.nim#L344" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    720. 

  720. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/unittest.nim#L344" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    721. 

  721. 

  722.   </dd>
    723. 

  723. </div>
    724. 

  724. <div id="testStarted.e,OutputFormatter,string">
    725. 

  725.   <dt><pre><span class="Keyword">method</span> <a href="#testStarted.e%2COutputFormatter%2Cstring"><span class="Identifier">testStarted</span></a><span class="Other">(</span><span class="Identifier">formatter</span><span class="Other">:</span> <a href="unittest.html#OutputFormatter"><span class="Identifier">OutputFormatter</span></a><span class="Other">;</span> <span class="Identifier">testName</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">)</span> {.<span class="Identifier">base</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">gcsafe</span><span class="Other">,</span>
    726. 

  726.     <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    727. 

  727.   <dd>
    728. 

  728.     
    729. 

  729.     
    730. 

  730.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/unittest.nim#L201" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    731. 

  731. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/unittest.nim#L201" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    732. 

  732. 

  733.   </dd>
    734. 

  734. </div>
    735. 

  735. 

  736. </div>
    737. 

  737. 

  738.   </dl>
    739. 

  739. </div>
    740. 

  740. <div class="section" id="17">
    741. 

  741.   <h1><a class="toc-backref" href="#17">Macros</a></h1>
    742. 

  742.   <dl class="item">
    743. 

  743.     <div id="check-macros-all">
    744. 

  744.   <div id="check.m,untyped">
    745. 

  745.   <dt><pre><span class="Keyword">macro</span> <a href="#check.m%2Cuntyped"><span class="Identifier">check</span></a><span class="Other">(</span><span class="Identifier">conditions</span><span class="Other">:</span> <a href="system.html#untyped"><span class="Identifier">untyped</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#untyped"><span class="Identifier">untyped</span></a></pre></dt>
    746. 

  746.   <dd>
    747. 

  747.     
    748. 

  748.     Verify if a statement or a list of statements is true. A helpful error message and set checkpoints are printed out on failure (if <tt class="docutils literal"><span class="pre">outputLevel</span></tt> is not <tt class="docutils literal"><span class="pre">PRINT_NONE</span></tt>).
    749. 

  749. <p><strong class="examples_text">Example:</strong></p>
    750. 

  750. <pre class="listing"><span class="Keyword">import</span> <span class="Identifier">std</span><span class="Operator">/</span><span class="Identifier">strutils</span>
    751. 

  751. 

  752. <span class="Identifier">check</span><span class="Punctuation">(</span><span class="StringLit">&quot;AKB48&quot;</span><span class="Operator">.</span><span class="Identifier">toLowerAscii</span><span class="Punctuation">(</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;akb48&quot;</span><span class="Punctuation">)</span>
    753. 

  753. 

  754. <span class="Keyword">let</span> <span class="Identifier">teams</span> <span class="Operator">=</span> <span class="Punctuation">{</span><span class="Punctuation">'</span><span class="Identifier">A</span><span class="CharLit">', '</span><span class="Identifier">K</span><span class="CharLit">', '</span><span class="Identifier">B</span><span class="CharLit">', '</span><span class="DecNumber">4'</span><span class="Punctuation">,</span> <span class="CharLit">'8'</span><span class="Punctuation">}</span>
    755. 

  755. 

  756. <span class="Identifier">check</span><span class="Punctuation">:</span>
    757. 

  757.   <span class="StringLit">&quot;AKB48&quot;</span><span class="Operator">.</span><span class="Identifier">toLowerAscii</span><span class="Punctuation">(</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;akb48&quot;</span>
    758. 

  758.   <span class="CharLit">'C'</span> <span class="Keyword">notin</span> <span class="Identifier">teams</span></pre>
    759. 

  759.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/unittest.nim#L642" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    760. 

  760. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/unittest.nim#L642" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    761. 

  761. 

  762.   </dd>
    763. 

  763. </div>
    764. 

  764. 

  765. </div>
    766. 

  766. <div id="expect-macros-all">
    767. 

  767.   <div id="expect.m,varargs[typed],untyped">
    768. 

  768.   <dt><pre><span class="Keyword">macro</span> <a href="#expect.m%2Cvarargs%5Btyped%5D%2Cuntyped"><span class="Identifier">expect</span></a><span class="Other">(</span><span class="Identifier">exceptions</span><span class="Other">:</span> <a href="system.html#varargs"><span class="Identifier">varargs</span></a><span class="Other">[</span><a href="system.html#typed"><span class="Identifier">typed</span></a><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">body</span><span class="Other">:</span> <a href="system.html#untyped"><span class="Identifier">untyped</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#untyped"><span class="Identifier">untyped</span></a></pre></dt>
    769. 

  769.   <dd>
    770. 

  770.     
    771. 

  771.     Test if <tt class="docutils literal"><span class="pre"><span class="Identifier">body</span></span></tt> raises an exception found in the passed <tt class="docutils literal"><span class="pre"><span class="Identifier">exceptions</span></span></tt>. The test passes if the raised exception is part of the acceptable exceptions. Otherwise, it fails.
    772. 

  772. <p><strong class="examples_text">Example:</strong></p>
    773. 

  773. <pre class="listing"><span class="Keyword">import</span> <span class="Identifier">std</span><span class="Operator">/</span><span class="Punctuation">[</span><span class="Identifier">math</span><span class="Punctuation">,</span> <span class="Identifier">random</span><span class="Punctuation">,</span> <span class="Identifier">strutils</span><span class="Punctuation">]</span>
    774. 

  774. <span class="Keyword">proc</span> <span class="Identifier">defectiveRobot</span><span class="Punctuation">(</span><span class="Punctuation">)</span> <span class="Operator">=</span>
    775. 

  775.   <span class="Identifier">randomize</span><span class="Punctuation">(</span><span class="Punctuation">)</span>
    776. 

  776.   <span class="Keyword">case</span> <span class="Identifier">rand</span><span class="Punctuation">(</span><span class="FloatNumber">1.</span><span class="Operator">.</span><span class="DecNumber">4</span><span class="Punctuation">)</span>
    777. 

  777.   <span class="Keyword">of</span> <span class="DecNumber">1</span><span class="Punctuation">:</span> <span class="Keyword">raise</span> <span class="Identifier">newException</span><span class="Punctuation">(</span><span class="Identifier">OSError</span><span class="Punctuation">,</span> <span class="StringLit">&quot;CANNOT COMPUTE!&quot;</span><span class="Punctuation">)</span>
    778. 

  778.   <span class="Keyword">of</span> <span class="DecNumber">2</span><span class="Punctuation">:</span> <span class="Keyword">discard</span> <span class="Identifier">parseInt</span><span class="Punctuation">(</span><span class="StringLit">&quot;Hello World!&quot;</span><span class="Punctuation">)</span>
    779. 

  779.   <span class="Keyword">of</span> <span class="DecNumber">3</span><span class="Punctuation">:</span> <span class="Keyword">raise</span> <span class="Identifier">newException</span><span class="Punctuation">(</span><span class="Identifier">IOError</span><span class="Punctuation">,</span> <span class="StringLit">&quot;I can't do that Dave.&quot;</span><span class="Punctuation">)</span>
    780. 

  780.   <span class="Keyword">else</span><span class="Punctuation">:</span> <span class="Identifier">assert</span> <span class="DecNumber">2</span> <span class="Operator">+</span> <span class="DecNumber">2</span> <span class="Operator">==</span> <span class="DecNumber">5</span>
    781. 

  781. 

  782. <span class="Identifier">expect</span> <span class="Identifier">IOError</span><span class="Punctuation">,</span> <span class="Identifier">OSError</span><span class="Punctuation">,</span> <span class="Identifier">ValueError</span><span class="Punctuation">,</span> <span class="Identifier">AssertionDefect</span><span class="Punctuation">:</span>
    783. 

  783.   <span class="Identifier">defectiveRobot</span><span class="Punctuation">(</span><span class="Punctuation">)</span></pre>
    784. 

  784.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/unittest.nim#L746" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    785. 

  785. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/unittest.nim#L746" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    786. 

  786. 

  787.   </dd>
    788. 

  788. </div>
    789. 

  789. 

  790. </div>
    791. 

  791. 

  792.   </dl>
    793. 

  793. </div>
    794. 

  794. <div class="section" id="18">
    795. 

  795.   <h1><a class="toc-backref" href="#18">Templates</a></h1>
    796. 

  796.   <dl class="item">
    797. 

  797.     <div id="fail-templates-all">
    798. 

  798.   <div id="fail.t">
    799. 

  799.   <dt><pre><span class="Keyword">template</span> <a href="#fail.t"><span class="Identifier">fail</span></a><span class="Other">(</span><span class="Other">)</span></pre></dt>
    800. 

  800.   <dd>
    801. 

  801.     
    802. 

  802.     <p>Print out the checkpoints encountered so far and quit if <tt class="docutils literal"><span class="pre">abortOnError</span></tt> is true. Otherwise, erase the checkpoints and indicate the test has failed (change exit code and test status). This template is useful for debugging, but is otherwise mostly used internally. Example:</p>
    803. 

  803. <p><pre class="listing"><span class="Identifier">checkpoint</span><span class="Punctuation">(</span><span class="StringLit">&quot;Checkpoint A&quot;</span><span class="Punctuation">)</span>
    804. 

  804. <span class="Identifier">complicatedProcInThread</span><span class="Punctuation">(</span><span class="Punctuation">)</span>
    805. 

  805. <span class="Identifier">fail</span><span class="Punctuation">(</span><span class="Punctuation">)</span></pre></p>
    806. 

  806. <p>outputs &quot;Checkpoint A&quot; before quitting.</p>
    807. 

  807. 

  808.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/unittest.nim#L595" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    809. 

  809. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/unittest.nim#L595" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    810. 

  810. 

  811.   </dd>
    812. 

  812. </div>
    813. 

  813. 

  814. </div>
    815. 

  815. <div id="require-templates-all">
    816. 

  816.   <div id="require.t,untyped">
    817. 

  817.   <dt><pre><span class="Keyword">template</span> <a href="#require.t%2Cuntyped"><span class="Identifier">require</span></a><span class="Other">(</span><span class="Identifier">conditions</span><span class="Other">:</span> <a href="system.html#untyped"><span class="Identifier">untyped</span></a><span class="Other">)</span></pre></dt>
    818. 

  818.   <dd>
    819. 

  819.     
    820. 

  820.     Same as <tt class="docutils literal"><span class="pre"><span class="Identifier">check</span></span></tt> except any failed test causes the program to quit immediately. Any teardown statements are not executed and the failed test output is not generated.
    821. 

  821.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/unittest.nim#L736" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    822. 

  822. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/unittest.nim#L736" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    823. 

  823. 

  824.   </dd>
    825. 

  825. </div>
    826. 

  826. 

  827. </div>
    828. 

  828. <div id="skip-templates-all">
    829. 

  829.   <div id="skip.t">
    830. 

  830.   <dt><pre><span class="Keyword">template</span> <a href="#skip.t"><span class="Identifier">skip</span></a><span class="Other">(</span><span class="Other">)</span></pre></dt>
    831. 

  831.   <dd>
    832. 

  832.     
    833. 

  833.     <p>Mark the test as skipped. Should be used directly in case when it is not possible to perform test for reasons depending on outer environment, or certain application logic conditions or configurations. The test code is still executed.</p>
    834. 

  834. <p><pre class="listing"><span class="Keyword">if</span> <span class="Keyword">not</span> <span class="Identifier">isGLContextCreated</span><span class="Punctuation">(</span><span class="Punctuation">)</span><span class="Punctuation">:</span>
    835. 

  835.   <span class="Identifier">skip</span><span class="Punctuation">(</span><span class="Punctuation">)</span></pre></p>
    836. 

  836. 

  837.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/unittest.nim#L627" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    838. 

  838. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/unittest.nim#L627" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    839. 

  839. 

  840.   </dd>
    841. 

  841. </div>
    842. 

  842. 

  843. </div>
    844. 

  844. <div id="suite-templates-all">
    845. 

  845.   <div id="suite.t,,">
    846. 

  846.   <dt><pre><span class="Keyword">template</span> <a href="#suite.t%2C%2C"><span class="Identifier">suite</span></a><span class="Other">(</span><span class="Identifier">name</span><span class="Other">,</span> <span class="Identifier">body</span><span class="Other">)</span> {.<span class="Identifier">dirty</span>.}</pre></dt>
    847. 

  847.   <dd>
    848. 

  848.     
    849. 

  849.     <p>Declare a test suite identified by <tt class="docutils literal"><span class="pre"><span class="Identifier">name</span></span></tt> with optional <tt class="docutils literal"><span class="pre">setup</span></tt> and/or <tt class="docutils literal"><span class="pre">teardown</span></tt> section.</p>
    850. 

  850. <p>A test suite is a series of one or more related tests sharing a common fixture (<tt class="docutils literal"><span class="pre">setup</span></tt>, <tt class="docutils literal"><span class="pre">teardown</span></tt>). The fixture is executed for EACH test.</p>
    851. 

  851. <p><pre class="listing"><span class="Identifier">suite</span> <span class="StringLit">&quot;test suite for addition&quot;</span><span class="Punctuation">:</span>
    852. 

  852.   <span class="Identifier">setup</span><span class="Punctuation">:</span>
    853. 

  853.     <span class="Keyword">let</span> <span class="Identifier">result</span> <span class="Operator">=</span> <span class="DecNumber">4</span>
    854. 

  854.   
    855. 

  855.   <span class="Identifier">test</span> <span class="StringLit">&quot;2 + 2 = 4&quot;</span><span class="Punctuation">:</span>
    856. 

  856.     <span class="Identifier">check</span><span class="Punctuation">(</span><span class="DecNumber">2</span><span class="Operator">+</span><span class="DecNumber">2</span> <span class="Operator">==</span> <span class="Identifier">result</span><span class="Punctuation">)</span>
    857. 

  857.   
    858. 

  858.   <span class="Identifier">test</span> <span class="StringLit">&quot;(2 + -2) != 4&quot;</span><span class="Punctuation">:</span>
    859. 

  859.     <span class="Identifier">check</span><span class="Punctuation">(</span><span class="DecNumber">2</span> <span class="Operator">+</span> <span class="Operator">-</span><span class="DecNumber">2</span> <span class="Operator">!=</span> <span class="Identifier">result</span><span class="Punctuation">)</span>
    860. 

  860.   
    861. 

  861.   <span class="Comment"># No teardown needed</span></pre></p>
    862. 

  862. <p>The suite will run the individual test cases in the order in which they were listed. With default global settings the above code prints:</p>
    863. 

  863. <pre>[Suite] test suite for addition
    864. 

  864.   [OK] 2 + 2 = 4
    865. 

  865.   [OK] (2 + -2) != 4</pre>
    866. 

  866. 

  867.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/unittest.nim#L468" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    868. 

  868. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/unittest.nim#L468" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    869. 

  869. 

  870.   </dd>
    871. 

  871. </div>
    872. 

  872. 

  873. </div>
    874. 

  874. <div id="test-templates-all">
    875. 

  875.   <div id="test.t,,">
    876. 

  876.   <dt><pre><span class="Keyword">template</span> <a href="#test.t%2C%2C"><span class="Identifier">test</span></a><span class="Other">(</span><span class="Identifier">name</span><span class="Other">,</span> <span class="Identifier">body</span><span class="Other">)</span> {.<span class="Identifier">dirty</span>.}</pre></dt>
    877. 

  877.   <dd>
    878. 

  878.     
    879. 

  879.     <p>Define a single test case identified by <tt class="docutils literal"><span class="pre"><span class="Identifier">name</span></span></tt>.</p>
    880. 

  880. <p><pre class="listing"><span class="Identifier">test</span> <span class="StringLit">&quot;roses are red&quot;</span><span class="Punctuation">:</span>
    881. 

  881.   <span class="Keyword">let</span> <span class="Identifier">roses</span> <span class="Operator">=</span> <span class="StringLit">&quot;red&quot;</span>
    882. 

  882.   <span class="Identifier">check</span><span class="Punctuation">(</span><span class="Identifier">roses</span> <span class="Operator">==</span> <span class="StringLit">&quot;red&quot;</span><span class="Punctuation">)</span></pre></p>
    883. 

  883. <p>The above code outputs:</p>
    884. 

  884. <pre>[OK] roses are red</pre>
    885. 

  885. 

  886.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/unittest.nim#L527" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    887. 

  887. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/unittest.nim#L527" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    888. 

  888. 

  889.   </dd>
    890. 

  890. </div>
    891. 

  891. 

  892. </div>
    893. 

  893. 

  894.   </dl>
    895. 

  895. </div>
    896. 

  896. 

  897.   </div>
    898. 

  898. </div>
    899. 

  899. 

  900.       <div class="twelve-columns footer">
    901. 

  901.         <span class="nim-sprite"></span>
    902. 

  902.         <br>
    903. 

  903.         <small style="color: var(--hint);">Made with Nim. Generated: 2025-03-25 06:49:24 UTC</small>
    904. 

  904.       </div>
    905. 

  905.     </div>
    906. 

  906.   </div>
    907. 

  907.       <script defer data-domain="nim-lang.org" src="https://plausible.io/js/plausible.js"></script>
    908. 

  908.     
    909. 

  909. </body>
    910. 

  910. </html>
    911. 

  911.