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              - setenv DIFF_LENGTH "number of diff lines to print from a failed test",
  67                by default 10, set to 0 to print the full diff
  68         - or add a case to the switch in common/config assigning
  69           these variables based on the hostname of your test
  70           machine
  71         - or add these variables to a file called local.config and keep that
  72           file in your workarea.
  73
  74     - if testing xfsdump, make sure the tape devices have a
  75       tape which can be overwritten.
  76
  77     - make sure $TEST_DEV is a mounted XFS partition
  78     - make sure that $SCRATCH_DEV or $SCRATCH_DEV_POOL contains nothing useful
  79
  80 Running tests:
  81
  82     - cd xfstests
  83     - By default the tests suite will run xfs tests:
  84     - ./check 001 002 003 ... or you can explicitly run a filesystem:
  85       ./check -xfs [test(s)]
  86     - You can run a range of tests: ./check 067-078
  87     - Groups of tests maybe ran by: ./check -g [group(s)]
  88       See the 'group' file for details on groups
  89     - for udf tests: ./check -udf [test(s)]
  90       Running all the udf tests: ./check -udf -g udf
  91     - for running nfs tests: ./check -nfs [test(s)]
  92     - To randomize test order: ./check -r [test(s)]
  93
  94
  95     The check script tests the return value of each script, and
  96     compares the output against the expected output. If the output
  97     is not as expected, a diff will be output and an .out.bad file
  98     will be produced for the failing test.
  99
 100     Unexpected console messages, crashes and hangs may be considered
 101     to be failures but are not necessarily detected by the QA system.
 102
 103 __________________________
 104 ADDING TO THE FSQA SUITE
 105 __________________________
 106
 107
 108 Creating new tests scripts:
 109
 110     Use the "new" script.
 111
 112 Test script environment:
 113
 114     When developing a new test script keep the following things in
 115     mind.  All of the environment variables and shell procedures are
 116     available to the script once the "common/rc" file has been
 117     sourced.
 118
 119      1. The tests are run from an arbitrary directory.  If you want to
 120         do operations on an XFS filesystem (good idea, eh?), then do
 121         one of the following:
 122
 123         (a) Create directories and files at will in the directory
 124             $TEST_DIR ... this is within an XFS filesystem and world
 125             writeable.  You should cleanup when your test is done,
 126             e.g. use a _cleanup shell procedure in the trap ... see
 127             001 for an example.  If you need to know, the $TEST_DIR
 128             directory is within the filesystem on the block device
 129             $TEST_DEV.
 130
 131         (b) mkfs a new XFS filesystem on $SCRATCH_DEV, and mount this
 132             on $SCRATCH_MNT. Call the the _require_scratch function
 133             on startup if you require use of the scratch partition.
 134             _require_scratch does some checks on $SCRATCH_DEV &
 135             $SCRATCH_MNT and makes sure they're unmounted. You should
 136             cleanup when your test is done, and in particular unmount
 137             $SCRATCH_MNT.
 138             Tests can make use of $SCRATCH_LOGDEV and $SCRATCH_RTDEV
 139             for testing external log and realtime volumes - however,
 140             these tests need to simply "pass" (e.g. cat $seq.out; exit
 141             - or default to an internal log) in the common case where
 142             these variables are not set.
 143
 144      2. You can safely create temporary files that are not part of the
 145         filesystem tests (e.g. to catch output, prepare lists of things
 146         to do, etc.) in files named $tmp.<anything>.  The standard test
 147         script framework created by "new" will initialize $tmp and
 148         cleanup on exit.
 149
 150      3. By default, tests are run as the same uid as the person
 151         executing the control script "check" that runs the test scripts.
 152
 153         If you need to be root, add a call to the shell procedure
 154         _need_to_be_root ... this will do nothing or exit with an
 155         error message depending on your current uid.
 156
 157      4. Some other useful shell procedures:
 158
 159         _get_fqdn               - echo the host's fully qualified
 160                                   domain name
 161
 162         _get_pids_by_name       - one argument is a process name, and
 163                                   return all of the matching pids on
 164                                   standard output
 165
 166         _within_tolerance       - fancy numerical "close enough is good
 167                                   enough" filter for deterministic
 168                                   output ... see comments in
 169                                   common/filter for an explanation
 170
 171         _filter_date            - turn ctime(3) format dates into the
 172                                   string DATE for deterministic
 173                                   output
 174
 175         _cat_passwd,            - dump the content of the password
 176         _cat_group                or group file (both the local file
 177                                   and the content of the NIS database
 178                                   if it is likely to be present)
 179
 180      5. General recommendations, usage conventions, etc.:
 181         - When the content of the password or group file is
 182           required, get it using the _cat_passwd and _cat_group
 183           functions, to ensure NIS information is included if NIS
 184           is active.
 185         - When calling getfacl in a test, pass the "-n" argument so
 186           that numeric rather than symbolic identifiers are used in
 187           the output.
 188
 189 Verified output:
 190
 191     Each test script has a numerical name, e.g. 007, and an associated
 192     verified output, e.g. 007.out.
 193
 194     It is important that the verified output is deterministic, and
 195     part of the job of the test script is to filter the output to
 196     make this so.  Examples of the sort of things that need filtering:
 197
 198     - dates
 199     - pids
 200     - hostnames
 201     - filesystem names
 202     - timezones
 203     - variable directory contents
 204     - imprecise numbers, especially sizes and times
 205
 206     Use the "remake" script to recreate the verified output for one
 207     or more tests.
 208
 209 Pass/failure:
 210
 211     The script "check" may be used to run one or more tests.
 212
 213     Test number $seq is deemed to "pass" when:
 214     (a) no "core" file is created,
 215     (b) the file $seq.notrun is not created,
 216     (c) the exit status is 0, and
 217     (d) the output matches the verified output.
 218
 219     In the "not run" case (b), the $seq.notrun file should contain a
 220     short one-line summary of why the test was not run.  The standard
 221     output is not checked, so this can be used for a more verbose
 222     explanation and to provide feedback when the QA test is run
 223     interactively.
 224
 225
 226     To force a non-zero exit status use:
 227         status=1
 228         exit
 229
 230     Note that:
 231         exit 1
 232     won't have the desired effect because of the way the exit trap
 233     works.
 234
 235     The recent pass/fail history is maintained in the file "check.log".
 236     The elapsed time for the most recent pass for each test is kept
 237     in "check.time".