--- wikisrc/kyua.mdwn 2012/09/01 19:32:25 1.6 +++ wikisrc/kyua.mdwn 2013/02/16 12:36:23 1.9 @@ -1,4 +1,7 @@ [[!meta title="Kyua: An introduction for NetBSD users"]] + +**Contents** + [[!toc levels=2]] The [Automated Testing Framework](ATF), or ATF for short, is a software @@ -111,6 +114,13 @@ results into a single report. At the mo also lower the barrier of entry to writing test programs for NetBSD, as using the ATF libraries will become optional. +These interfaces are implemented as independent binaries, called testers, +that are fully scriptable. The testers are provided in the `kyua-testers` +package. The idea behind having these as independent programs is to +restrict the OS-specific code to a small subset of Kyua written in C, and +thus to allow the higher-level layers to be written in other languages +(possibly Lua). + ## Lua configuration files Kyua has two kind of configuration files: the Kyuafiles, which are the @@ -172,6 +182,12 @@ components exist in pkgsrc, and are: * pkgsrc/devel/atf: The ATF tools, namely atf-run and atf-report. These are deprecated and this package should eventually disappear. +* pkgsrc/devel/kyua-testers: The Kyua testers, which provide the + `kyua-atf-tester` and `kyua-plain-tester` helper binaries. These + binaries implement the logic to execute test cases in an isolated manner + and to expose the test programs using a common and abstract command-line + interface. + * pkgsrc/devel/kyua-cli: The Kyua command-line interface, which provides a superset of the functionality of atf-run and atf-report. @@ -191,7 +207,7 @@ The easiest (but also the least "future- suite with Kyua is to use the backwards compatibility ATF tools provided by the kyua-atf-compat module. First of all, install the package: - $ cd /usr/pkgsrc/deve/kyua-atf-compat + $ cd /usr/pkgsrc/devel/kyua-atf-compat $ make install && make clean And then, running the test suite is as easy as: @@ -229,9 +245,9 @@ at these steps. To get started, install the Kyua packages: - $ cd /usr/pkgsrc/deve/kyua-cli + $ cd /usr/pkgsrc/devel/kyua-cli $ make install && make clean - $ cd /usr/pkgsrc/deve/kyua-atf-compat + $ cd /usr/pkgsrc/devel/kyua-atf-compat $ make install && make clean Once this is done, configure Kyua in the same way ATF is configured "out of