version 1.5, 2012/09/01 19:28:12
|
version 1.9, 2013/02/16 12:36:23
|
Line 1
|
Line 1
|
[[!meta title="Kyua: An introduction for NetBSD users"]] |
[[!meta title="Kyua: An introduction for NetBSD users"]] |
|
|
|
**Contents** |
|
|
[[!toc levels=2]] |
[[!toc levels=2]] |
|
|
The [Automated Testing Framework](ATF), or ATF for short, is a software |
The [Automated Testing Framework](ATF), or ATF for short, is a software |
Line 33 test suite so that you can experiment wi
|
Line 36 test suite so that you can experiment wi
|
with it and provide feedback early on. |
with it and provide feedback early on. |
|
|
**If you would like more details on how the import of Kyua into NetBSD will |
**If you would like more details on how the import of Kyua into NetBSD will |
happen, please see [Kyua: The way into NetBSD](import).** |
happen, please see [[Kyua: The way into NetBSD|/kyua/import]].** |
|
|
# What's in the name? |
# What's in the name? |
|
|
Line 111 results into a single report. At the mo
|
Line 114 results into a single report. At the mo
|
also lower the barrier of entry to writing test programs for NetBSD, as |
also lower the barrier of entry to writing test programs for NetBSD, as |
using the ATF libraries will become optional. |
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 |
## Lua configuration files |
|
|
Kyua has two kind of configuration files: the Kyuafiles, which are the |
Kyua has two kind of configuration files: the Kyuafiles, which are the |
Line 172 components exist in pkgsrc, and are:
|
Line 182 components exist in pkgsrc, and are:
|
* pkgsrc/devel/atf: The ATF tools, namely atf-run and atf-report. These |
* pkgsrc/devel/atf: The ATF tools, namely atf-run and atf-report. These |
are deprecated and this package should eventually disappear. |
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 |
* pkgsrc/devel/kyua-cli: The Kyua command-line interface, which provides a |
superset of the functionality of atf-run and atf-report. |
superset of the functionality of atf-run and atf-report. |
|
|
Line 191 The easiest (but also the least "future-
|
Line 207 The easiest (but also the least "future-
|
suite with Kyua is to use the backwards compatibility ATF tools provided by |
suite with Kyua is to use the backwards compatibility ATF tools provided by |
the kyua-atf-compat module. First of all, install the package: |
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 |
$ make install && make clean |
|
|
And then, running the test suite is as easy as: |
And then, running the test suite is as easy as: |
Line 229 at these steps.
|
Line 245 at these steps.
|
|
|
To get started, install the Kyua packages: |
To get started, install the Kyua packages: |
|
|
$ cd /usr/pkgsrc/deve/kyua-cli |
$ cd /usr/pkgsrc/devel/kyua-cli |
$ make install && make clean |
$ make install && make clean |
$ cd /usr/pkgsrc/deve/kyua-atf-compat |
$ cd /usr/pkgsrc/devel/kyua-atf-compat |
$ make install && make clean |
$ make install && make clean |
|
|
Once this is done, configure Kyua in the same way ATF is configured "out of |
Once this is done, configure Kyua in the same way ATF is configured "out of |