Zig Test
detect_test.zig
$ zig test detect_test.zig
Test [1/1] test "builtin.is_test"...
All 1 tests passed.
Zig has lazy top level declaration analysis, which means that if a function is not called, or otherwise used, it is not analyzed. This means that there may be an undiscovered compile error in a function because it is never called.
$ zig test unused_fn.zig
Test [1/1] test "unused function"...
All 1 tests passed.
Note that, while in and ReleaseSafe modes, emits a call to @panic, in and ReleaseSmall modes, it is really undefined behavior. The implementation of is as simple as:
This means that when testing in ReleaseFast or ReleaseSmall mode, assert
is not sufficient to check the result of a computation:
const std = @import("std");
const assert = std.debug.assert;
test "assert in release fast mode" {
assert(false);
Better practice for checking the output when testing is to use std.testing.expect
:
test.zig
$ zig test test.zig -O ReleaseFast
Test [2/1]
test "expect in release fast mode"... FAIL (TestUnexpectedResult)
0 passed; 0 skipped; 1 failed.
docgen_tmp/zig-cache/o/5f772ba34b67337c067e5630990ef24e/test /home/andy/Downloads/zig/build-release/zig
zig test
has a few command line parameters which affect the compilation. See zig --help
for a full list. The most interesting one is . This makes the test build only include tests whose name contains the supplied filter text. Again, thanks to lazy analysis, this can allow you to narrow a build to only a few functions in isolation.