xref: /freebsd/share/doc/pjdfstest/README (revision 7431dfd4580e850375fe5478d92ec770344db098)
1pjdfstest test suite execution is integrated into kyua. This README describes
2how to use pjdfstest in the default configuration (kyua work directory), and
3with a specific filesystem path.
4
5Method 1. Executing with default configuration (kyua work directory)
6
7    1. Elevate privileges:
8       % su -
9    2. cd to the tests directory:
10       % cd /usr/tests/sys/pjdfstest
11    3. Run kyua:
12       % kyua test
13
14   Executing the commands as shown above will run pjdfstest in the kyua work
15   directory. The kyua work directory defaults to a random generated path under
16   /tmp; please see TMPDIR in kyua(1) for more details on how the temporary path
17   is chosen with kyua.
18
19Method 2. Executing with a specific filesystem path (in this case /mnt)
20
21    1. Elevate privileges:
22       % su -
23    2. cd to the tests directory:
24       % cd /usr/tests/sys/pjdfstest
25    3. Run kyua:
26       % env PJDFSTEST_TEST_PATH=/mnt kyua test
27
28   WARNING: the above method violates the test program isolation algorithm
29   described in kyua(1); as such, $PJDFSTEST_TEST_PATH must be cleaned up after
30   executing the testcases.
31
32   It's highly recommended that $PJDFSTEST_TEST_PATH be pointed to a sandboxed
33   filesystem, e.g. a small UFS-formatted memory disk or ZFS dataset with
34   quotas enabled, so the filesystem can be easily destroyed after the test
35   execution is complete, and the testcases are properly bounded both in terms
36   of time and space.
37