NAME

shtk_unittest_main — Standard test program entry point

LIBRARY

shtk_import unittest

SYNOPSIS

DESCRIPTION

The shtk_unittest_main function implements the standard entry point of a test program that uses the shtk_unittest(3) library. The shtk_unittest_main function runs all test cases registered within the test case and determines the correct exit condition for the test program.

In order to use shtk_unittest_main, test programs must either explicitly call the function from their main method as this:

main() { shtk_unittest_main "${@}"; }

Or the test program can be compiled with an override for the main method's name:

$ shtk build -m shtk_unittest_main module_test.sh

In general, prefer the latter mechanism.

RETURN VALUES

Returns 0 (true) if all executed test cases pass, or 1 (false) if any test fails.

SEE ALSO

shtk(3), shtk_unittest(3)

HISTORY

shtk_unittest_main first appeared in shtk 1.6.