test_basic.awk

Basic example on how to write unit tests

#!/usr/bin/env -S gawk -E
@include "test"
 
BEGIN {
    test::runTests()
    # By default:
    # - The testing functions like test::assertEq() can also be called
    #   like @assertEq() as they are imported into the awk namespace
    # - The functions test_* are recognized as tests
}
 
# Write your functions, or @include them instead
func div(x, y) {
    return x/y
}
 
# Write test_* functions
func test_div() {
    # Write a description for the test
    test::it("divides a number over another");
 
    # Write assertions
    test::assertEq(div(4, 2), 2);
    test::assertNe(div(4, 2), 1);
    test::assertApprox(div(0.3, 3), 0.1);
}
 
# More sample assertions
func test_types() {
    test::it("recognizes types");
    test::assertTruthy(1);
    test::assertTruthy("abc");
    test::assertFalsy(0);
    test::assertFalsy("");
    test::assertTrue(mkbool(1));
    test::assertFalse(mkbool(0));
    test::assertType("abc", "string");
    test::assertType(@/abc/, "regexp");
}