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