-
Notifications
You must be signed in to change notification settings - Fork 42
Quickstart
Julio Merino edited this page Apr 13, 2015
·
1 revision
Visit Installation for details on how to install from binary packages (if available) or from sources.
- A
Kyuafile
is used as input to the kyua command-line utility. The Kyuafile specifies other test programs to run as part of the test suite. The other test programs can be implemented in C, C++, shell script, or any other programming language. - This document describes the [[
Kyuafile
format|http://manned.org/kyuafile.5]]. - Comments in
Kyuafile
s start with double hyphens, -- , and continue to the end of the line. (Kyuafile
s are Lua scripts.) - A Kyuafile must be in the same directory as the test program which it calls. A single
Kyuafile
may invoke multiple test programs, but all the test programs specified in the Kyuafile must be in the same directory as theKyuafile
. - A Kyuafile may include
Kyuafile
s from other directories. This is how a singleKyuafile
can be used to drive test programs in multiple directories.
- A plain test is a simple program which can be written in any programming language. The output of the program does not need to follow any format.
- A plain test can only have a single test case in one program.
- Refer to: Writing a plain test
- The Automated Test Framework (ATF) provides APIs in C, C++, and Bourne shell script for writing test programs.
- An ATF test program can have multiple test cases in one program.
- Refer to:
- The Test Anything Protocol (TAP) specifies a text format for test programs to communicate with a test harness.
- The kyua TAP interface can be used to run test programs which use TAP.
- Refer to:
To execute a test suite, cd
to the directory that contains a Kyuafile and type:
kyua test
More details are in kyua-test(1).
After executing a test suite, you can generate a test report.
-
To generate a plain text test report, see kyua-report(1) and type:
kyua report
-
To generate an HTML test report, see kyua-report-html(1) and type:
kyua report-html
-
To generate a JUnit XML test report, see kyua-report-junit(1) and type:
kyua report-junit