xref: /freebsd/share/doc/pjdfstest/README (revision d0b2dbfa0ecf2bbc9709efc5e20baf8e4b44bbbf)
1The pjdfstest test suite is normally run by kyua.  It requires kyua 0.11 or
2newer. This README describes how to use pjdfstest in the default configuration
3(kyua work directory), with a specific filesystem path, and with prove(1).
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 TMPDIR=/mnt kyua test
27
28   Note that if HOME is undefined, this will result in kyua's logfile being
29   placed in TMPDIR, which may not be what you want.  You can always use
30   --logfile to explicitly select the log location.
31
32Method 3. Executing pjdfstest with prove
33
34    1. Elevate privileges:
35       % su -
36    2. cd to the temporary directory of your choice
37       % cd /mnt
38    3. Invoke a specific test manually
39       % prove -rv /usr/tests/sys/pjdfstest/chmod/00
40