xref: /freebsd/share/examples/tests/README (revision 05248206)
121203fddSJulio Merino
221203fddSJulio MerinoThis directory contains sample test programs along the Makefile and
321203fddSJulio MerinoKyuafile logic to get them build and installed.
421203fddSJulio Merino
521203fddSJulio MerinoThe goal of these test programs is to illustrate, via simple and
621203fddSJulio Merinoheaviliy-commented code, how to construct test programs using all the
721203fddSJulio Merinosupported interfaces in the system.
821203fddSJulio Merino
921203fddSJulio MerinoIf you use any files in here as templates for your own code, please
1021203fddSJulio Merinoremove all comments while doing so and then write your own if necessary.
1121203fddSJulio Merino
1221203fddSJulio MerinoThe subdirectories here contain:
1321203fddSJulio Merino
1421203fddSJulio Merino* tests/: Regular directory containing the tests code.  Note that the
1521203fddSJulio Merino  apparently-redundant tests/tests/ path component here is expected for
1621203fddSJulio Merino  consistency reasons and required to get the right layout under
1721203fddSJulio Merino  /usr/tests/.
1821203fddSJulio Merino
1921203fddSJulio Merino* tests/atf/: Tests that use the ATF libraries, including atf-c, atf-c++
2021203fddSJulio Merino  and atf-sh.  See kyua-atf-interface(1) for details.
2121203fddSJulio Merino
2221203fddSJulio Merino* tests/plain/: Tests that do not use any testing framework.  See
2321203fddSJulio Merino  kyua-plain-interface(1) for details.
2421203fddSJulio Merino
2521203fddSJulio MerinoTo inspect the available sample test cases from an installed system:
2621203fddSJulio Merino
2721203fddSJulio Merino    $ kyua list -k /usr/tests/share/examples/tests/Kyuafile
2821203fddSJulio Merino
2921203fddSJulio MerinoTo run the full suite of sample test cases:
3021203fddSJulio Merino
3121203fddSJulio Merino    $ kyua test -k /usr/tests/share/examples/tests/Kyuafile
3221203fddSJulio Merino
3321203fddSJulio MerinoAnd to debug a specific failing test case, if any:
3421203fddSJulio Merino
3521203fddSJulio Merino    $ kyua debug -k /usr/tests/share/examples/tests/Kyuafile \
3621203fddSJulio Merino      atf/cp_test:simple
37