README

   1 _______________________
   2 BUILDING THE FSQA SUITE
   3 _______________________
   4
   5 Building Linux:
   6         - cd into the xfstests directory
   7         - run make
   8         - run make install
   9
  10 Building IRIX:
  11         - cd into the xfstests directory
  12         - set the ROOT and TOOLROOT env variables for IRIX appropriately
  13         - run ./make_irix
  14
  15 ______________________
  16 USING THE FSQA SUITE
  17 ______________________
  18
  19 Preparing system for tests (IRIX and Linux):
  20
  21     - compile XFS into your kernel or load XFS modules
  22     - install user tools including mkfs.xfs, xfs_db & xfs_bmap
  23     - If you wish to run the udf components of the suite install
  24       mkfs_udf and udf_db for IRIX and mkudffs for Linux. Also download and
  25       build the Philips UDF Verification Software from
  26       http://www.extra.research.philips.com/udf/, then copy the udf_test
  27       binary to xfstests/src/. If you wish to disable UDF verification test
  28       set the environment variable DISABLE_UDF_TEST to 1.
  29
  30
  31     - create one or two partitions to use for testing
  32         - one TEST partition
  33             - format as XFS, mount & optionally populate with
  34               NON-IMPORTANT stuff
  35         - one SCRATCH partition (optional)
  36             - leave empty and expect this partition to be clobbered
  37               by some tests.  If this is not provided, many tests will
  38               not be run.
  39               (SCRATCH and TEST must be two DIFFERENT partitions)
  40               OR
  41         - for btrfs only: some btrfs test cases will need 3 or more independent
  42               SCRATCH disks which should be set using SCRATCH_DEV_POOL (for eg:
  43               SCRATCH_DEV_POOL="/dev/sda /dev/sdb /dev/sdc") with which
  44               SCRATCH_DEV should be unused by the tester, and for the legacy
  45               support SCRATCH_DEV will be set to the first disk of the
  46               SCRATCH_DEV_POOL by xfstests script.
  47
  48     - setup your environment
  49         - setenv TEST_DEV "device containing TEST PARTITION"
  50         - setenv TEST_DIR "mount point of TEST PARTITION"
  51         - optionally:
  52              - setenv SCRATCH_DEV "device containing SCRATCH PARTITION" OR
  53                (btrfs only) setenv SCRATCH_DEV_POOL "to 3 or more SCRATCH disks for
  54                testing btrfs raid concepts"
  55              - setenv SCRATCH_MNT "mount point for SCRATCH PARTITION"
  56              - setenv TAPE_DEV "tape device for testing xfsdump"
  57              - setenv RMT_TAPE_DEV "remote tape device for testing xfsdump"
  58              - setenv RMT_IRIXTAPE_DEV "remote IRIX tape device for testing xfsdump"
  59              - setenv SCRATCH_LOGDEV "device for scratch-fs external log"
  60              - setenv SCRATCH_RTDEV "device for scratch-fs realtime data"
  61              - setenv TEST_LOGDEV "device for test-fs external log"
  62              - setenv TEST_RTDEV "device for test-fs realtime data"
  63              - if TEST_LOGDEV and/or TEST_RTDEV, these will always be used.
  64              - if SCRATCH_LOGDEV and/or SCRATCH_RTDEV, the USE_EXTERNAL
  65                environment variable set to "yes" will enable their use.
  66         - or add a case to the switch in common.config assigning
  67           these variables based on the hostname of your test
  68           machine
  69         - or add these variables to a file called local.config and keep that
  70           file in your workarea.
  71
  72     - if testing xfsdump, make sure the tape devices have a
  73       tape which can be overwritten.
  74
  75     - make sure $TEST_DEV is a mounted XFS partition
  76     - make sure that $SCRATCH_DEV or $SCRATCH_DEV_POOL contains nothing useful
  77
  78 Running tests:
  79
  80     - cd xfstests
  81     - By default the tests suite will run xfs tests:
  82     - ./check 001 002 003 ... or you can explicitly run a filesystem:
  83       ./check -xfs [test(s)]
  84     - You can run a range of tests: ./check 067-078
  85     - Groups of tests maybe ran by: ./check -g [group(s)]
  86       See the 'group' file for details on groups
  87     - for udf tests: ./check -udf [test(s)]
  88       Running all the udf tests: ./check -udf -g udf
  89     - for running nfs tests: ./check -nfs [test(s)]
  90     - To randomize test order: ./check -r [test(s)]
  91
  92
  93     The check script tests the return value of each script, and
  94     compares the output against the expected output. If the output
  95     is not as expected, a diff will be output and an .out.bad file
  96     will be produced for the failing test.
  97
  98     Unexpected console messages, crashes and hangs may be considered
  99     to be failures but are not necessarily detected by the QA system.
 100
 101 __________________________
 102 ADDING TO THE FSQA SUITE
 103 __________________________
 104
 105
 106 Creating new tests scripts:
 107
 108     Use the "new" script.
 109
 110 Test script environment:
 111
 112     When developing a new test script keep the following things in
 113     mind.  All of the environment variables and shell procedures are
 114     available to the script once the "common.rc" file has been
 115     sourced.
 116
 117      1. The tests are run from an arbitrary directory.  If you want to
 118         do operations on an XFS filesystem (good idea, eh?), then do
 119         one of the following:
 120
 121         (a) Create directories and files at will in the directory
 122             $TEST_DIR ... this is within an XFS filesystem and world
 123             writeable.  You should cleanup when your test is done,
 124             e.g. use a _cleanup shell procedure in the trap ... see
 125             001 for an example.  If you need to know, the $TEST_DIR
 126             directory is within the filesystem on the block device
 127             $TEST_DEV.
 128
 129         (b) mkfs a new XFS filesystem on $SCRATCH_DEV, and mount this
 130             on $SCRATCH_MNT. Call the the _require_scratch function
 131             on startup if you require use of the scratch partition.
 132             _require_scratch does some checks on $SCRATCH_DEV &
 133             $SCRATCH_MNT and makes sure they're unmounted. You should
 134             cleanup when your test is done, and in particular unmount
 135             $SCRATCH_MNT.
 136             Tests can make use of $SCRATCH_LOGDEV and $SCRATCH_RTDEV
 137             for testing external log and realtime volumes - however,
 138             these tests need to simply "pass" (e.g. cat $seq.out; exit
 139             - or default to an internal log) in the common case where
 140             these variables are not set.
 141
 142      2. You can safely create temporary files that are not part of the
 143         filesystem tests (e.g. to catch output, prepare lists of things
 144         to do, etc.) in files named $tmp.<anything>.  The standard test
 145         script framework created by "new" will initialize $tmp and
 146         cleanup on exit.
 147
 148      3. By default, tests are run as the same uid as the person
 149         executing the control script "check" that runs the test scripts.
 150
 151         If you need to be root, add a call to the shell procedure
 152         _need_to_be_root ... this will do nothing or exit with an
 153         error message depending on your current uid.
 154
 155      4. Some other useful shell procedures:
 156
 157         _get_fqdn               - echo the host's fully qualified
 158                                   domain name
 159
 160         _get_pids_by_name       - one argument is a process name, and
 161                                   return all of the matching pids on
 162                                   standard output
 163
 164         _within_tolerance       - fancy numerical "close enough is good
 165                                   enough" filter for deterministic
 166                                   output ... see comments in
 167                                   common.filter for an explanation
 168
 169         _filter_date            - turn ctime(3) format dates into the
 170                                   string DATE for deterministic
 171                                   output
 172
 173         _cat_passwd,            - dump the content of the password
 174         _cat_group                or group file (both the local file
 175                                   and the content of the NIS database
 176                                   if it is likely to be present)
 177
 178      4. General recommendations, usage conventions, etc.:
 179         - When the content of the password or group file is
 180           required, get it using the _cat_passwd and _cat_group
 181           functions, to ensure NIS information is included if NIS
 182           is active.
 183         - When calling getfacl in a test, pass the "-n" argument so
 184           that numeric rather than symbolic identifiers are used in
 185           the output.
 186
 187 Verified output:
 188
 189     Each test script has a numerical name, e.g. 007, and an associated
 190     verified output, e.g. 007.out.
 191
 192     It is important that the verified output is deterministic, and
 193     part of the job of the test script is to filter the output to
 194     make this so.  Examples of the sort of things that need filtering:
 195
 196     - dates
 197     - pids
 198     - hostnames
 199     - filesystem names
 200     - timezones
 201     - variable directory contents
 202     - imprecise numbers, especially sizes and times
 203
 204     Use the "remake" script to recreate the verified output for one
 205     or more tests.
 206
 207 Pass/failure:
 208
 209     The script "check" may be used to run one or more tests.
 210
 211     Test number $seq is deemed to "pass" when:
 212     (a) no "core" file is created,
 213     (b) the file $seq.notrun is not created,
 214     (c) the exit status is 0, and
 215     (d) the output matches the verified output.
 216
 217     In the "not run" case (b), the $seq.notrun file should contain a
 218     short one-line summary of why the test was not run.  The standard
 219     output is not checked, so this can be used for a more verbose
 220     explanation and to provide feedback when the QA test is run
 221     interactively.
 222
 223
 224     To force a non-zero exit status use:
 225         status=1
 226         exit
 227
 228     Note that:
 229         exit 1
 230     won't have the desired effect because of the way the exit trap
 231     works.
 232
 233     The recent pass/fail history is maintained in the file "check.log".
 234     The elapsed time for the most recent pass for each test is kept
 235     in "check.time".