ooc-check

ooc-check is a small unit testing utility library for ooc. It plays nicely with sam and only adds small helpers do assertions that print failures with an optional backtrace.

It is highly recommended to install rock's fancy backtrace extension to use this library.

Installation

It should be available via sam. Assuming you've added check to your Requires field in your usefile, sam get <yourapp>.use should get it. See sam's documentation for more details.

Usage

Add Requires: check to your usefile and run sam get or sam update to install or update your local copy of the library. This library is typically used only in tests.

ooc-check exposes a single class, Check, that offers the following methods and properties:

• new(name: String): create an instance with the specified name.
• failed?: gets or sets the failed flag.
• backtrace?: gets or sets whether a backtrace should be printed on failure.
• run(Func()): runs the provided function, handling the call to exit(1) automatically if any of the assertions fail, or if an uncaught exception is raised.
• isTrue?(b: Bool[, msg: String, args: ...]) -> Bool: asserts that the condition is true, and fails with the provided (optional) message. The test suite continues.
• isFalse?(b: Bool[, msg: String, args: ...]) -> Bool: asserts that the condition is false, and fails with the provided (optional) message. The test suite continues.
• isTrue!(b: Bool[, msg: String, args: ...]): same as isTrue? except that the test suite stops immediately if the assertion fails.
• isFalse!(b: Bool[, msg: String, args: ...]) -> Bool: same as isFalse? except that the test suite stops immediately if the assertion fails.

Corresponding helper functions are provided as top-level module functions (i.e. no instance of Check needed, the functions are proxies to an automatically created default Check instance).

Run tests using sam test. The special comments //! shouldfail and //! shouldcrash that sam recognizes still work as usual.

A failure with backtrace looks like this:

[FAIL] [864ms, 14ms] raise.ooc(crashed - exit code: 1)
>>>>>> check failed: this is an error
-------------------------------------
[fancy backtrace]
0     BacktraceHandler backtrace_impl()  in lang/Backtrace  (at /home/martin/src/ooc_libs/rock/sdk/lang/Backtrace.ooc:50) 
1     BacktraceHandler backtrace()       in lang/Backtrace  (at /home/martin/src/ooc_libs/rock/sdk/lang/Backtrace.ooc:243)
2     Exception getCurrentBacktrace()    in lang/Exception  (at /home/martin/src/ooc_libs/rock/sdk/lang/Exception.ooc:208)
3     Check _printFailure_impl()         in check           (at /home/martin/src/ooc_libs/ooc-check/source/check.ooc:73)  
4     Check _printFailure()              in check           (at /home/martin/src/ooc_libs/ooc-check/source/check.ooc:121) 
5     Check run_impl()                   in check           (at /home/martin/src/ooc_libs/ooc-check/source/check.ooc:15)  
6     Check run()                        in check           (at /home/martin/src/ooc_libs/ooc-check/source/check.ooc:85)  
7     run()                              in check           (at /home/martin/src/ooc_libs/ooc-check/source/check.ooc:84)  
8     raise_load()                       in                 (at /home/martin/src/ooc_libs/ooc-check/test/raise.ooc:11)    
9     main()                             in                 (at /home/martin/src/ooc_libs/ooc-check/test/raise.ooc:17)    
10    libc_start_main()                  in                 (at __libc_start_main:0)                                      
11    _start()                           in                 (at _start:0)                                                 

Example

import check

chk := Check new("math")

chk run(||
    chk isTrue?(1 + 1 == 2)
    chk isTrue?(3 > 2)
    chk isFalse!(1 == 1)
)

License

The BSD 3-Clause License. See the LICENSE file.