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