File: tests.rst

package info (click to toggle)
kworkflow 20191112-1.2
  • links: PTS
  • area: main
  • in suites: bookworm, forky, sid, trixie
  • size: 2,836 kB
  • sloc: perl: 7,354; sh: 2,397; ansic: 80; python: 44; makefile: 38
file content (35 lines) | stat: -rw-r--r-- 1,013 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
===============
  About Tests
===============

Kw's tests rely on `shunit2`. The `run_tests.sh` script automatically detects
`shunit2` in `$PATH` in the case installed it via package. Alternatively, you
can have shunit2 source code in `tests/` (you can clone it from
https://github.com/kward/shunit2).

If you want to run all the tests, try:::

  run_tests.sh

List all available test files::

  run_tests.sh list

Or run individual test with::

  run_tests.sh test TESTFILE1 ...

Tests rely on some external files. These files are automatically downloaded
when you first try to run a test. You can, however, force `run_tests.sh` to
prepare the environment for running tests with::

  run_tests.sh prepare

Also, if you already have the test's environment prepared but want to update
the external files, you can use::

  run_tests.sh prepare -f|--force-update

.. note::
   `run_tests.sh` script must be run from the directory it is in,
   i.e. the root of the repository. Otherwise, it may not execute properly.