README

   1 _______________________
   2 BUILDING THE FSQA SUITE
   3 _______________________
   4
   5 - cd into the xfstests directory
   6 - install prerequisite packages
   7   For example, for Ubuntu:
   8         sudo apt-get install xfslibs-dev uuid-dev libtool-bin \
   9         e2fsprogs automake gcc libuuid1 quota attr libattr1-dev make \
  10         libacl1-dev libaio-dev xfsprogs libgdbm-dev gawk fio dbench \
  11         uuid-runtime
  12   For Fedora, RHEL, or CentOS:
  13         yum install acl attr automake bc dbench dump e2fsprogs fio \
  14         gawk gcc indent libtool lvm2 make psmisc quota sed \
  15         xfsdump xfsprogs \
  16         libacl-devel libattr-devel libaio-devel libuuid-devel \
  17         xfsprogs-devel btrfs-progs-devel
  18         (Older distributions may require xfsprogs-qa-devel as well.)
  19         (Note that for RHEL and CentOS, you may need the EPEL repo.)
  20 - run make
  21 - run make install
  22 - create fsgqa test user ("sudo useradd fsgqa")
  23 - create 123456-fsgqa test user ("sudo useradd 123456-fsgqa")
  24
  25 ______________________
  26 USING THE FSQA SUITE
  27 ______________________
  28
  29 Preparing system for tests:
  30
  31     - compile XFS into your kernel or load XFS modules
  32     - install administrative tools specific to the filesystem you wish to test
  33     - If you wish to run the udf components of the suite install
  34       mkudffs. Also download and build the Philips UDF Verification Software
  35       from http://www.extra.research.philips.com/udf/, then copy the udf_test
  36       binary to xfstests/src/. If you wish to disable UDF verification test
  37       set the environment variable DISABLE_UDF_TEST to 1.
  38
  39
  40     - create one or two partitions to use for testing
  41         - one TEST partition
  42             - format as XFS, mount & optionally populate with
  43               NON-IMPORTANT stuff
  44         - one SCRATCH partition (optional)
  45             - leave empty and expect this partition to be clobbered
  46               by some tests.  If this is not provided, many tests will
  47               not be run.
  48               (SCRATCH and TEST must be two DIFFERENT partitions)
  49               OR
  50         - for btrfs only: some btrfs test cases will need 3 or more independent
  51               SCRATCH disks which should be set using SCRATCH_DEV_POOL (for eg:
  52               SCRATCH_DEV_POOL="/dev/sda /dev/sdb /dev/sdc") with which
  53               SCRATCH_DEV should be unused by the tester, and for the legacy
  54               support SCRATCH_DEV will be set to the first disk of the
  55               SCRATCH_DEV_POOL by xfstests script.
  56
  57     - setup your environment
  58         Quick start:
  59         - copy local.config.example to local.config and edit as needed
  60         Or:
  61         - setenv TEST_DEV "device containing TEST PARTITION"
  62         - setenv TEST_DIR "mount point of TEST PARTITION"
  63         - optionally:
  64              - setenv SCRATCH_DEV "device containing SCRATCH PARTITION" OR
  65                (btrfs only) setenv SCRATCH_DEV_POOL "to 3 or more SCRATCH disks for
  66                testing btrfs raid concepts"
  67              - setenv SCRATCH_MNT "mount point for SCRATCH PARTITION"
  68              - setenv TAPE_DEV "tape device for testing xfsdump"
  69              - setenv RMT_TAPE_DEV "remote tape device for testing xfsdump"
  70              - setenv RMT_IRIXTAPE_DEV "remote IRIX tape device for testing xfsdump"
  71              - setenv SCRATCH_LOGDEV "device for scratch-fs external log"
  72              - setenv SCRATCH_RTDEV "device for scratch-fs realtime data"
  73              - setenv TEST_LOGDEV "device for test-fs external log"
  74              - setenv TEST_RTDEV "device for test-fs realtime data"
  75              - if TEST_LOGDEV and/or TEST_RTDEV, these will always be used.
  76              - if SCRATCH_LOGDEV and/or SCRATCH_RTDEV, the USE_EXTERNAL
  77                environment variable set to "yes" will enable their use.
  78              - setenv DIFF_LENGTH "number of diff lines to print from a failed test",
  79                by default 10, set to 0 to print the full diff
  80              - setenv FSTYP "the filesystem you want to test", the filesystem
  81                type is devised from the TEST_DEV device, but you may want to
  82                override it; if unset, the default is 'xfs'
  83              - setenv FSSTRESS_AVOID and/or FSX_AVOID, which contain options
  84                added to the end of fsstresss and fsx invocations, respectively,
  85                in case you wish to exclude certain operational modes from these
  86                tests.
  87              - set TEST_XFS_REPAIR_REBUILD=1 to have _check_xfs_filesystem
  88                run xfs_repair -n to check the filesystem; xfs_repair to rebuild
  89                metadata indexes; and xfs_repair -n (a third time) to check the
  90                results of the rebuilding.
  91              - xfs_scrub, if present, will always check the test and scratch
  92                filesystems if they are still online at the end of the test.
  93                It is no longer necessary to set TEST_XFS_SCRUB.
  94              - setenv LOGWRITES_DEV to a block device to use for power fail
  95                testing.
  96
  97         - or add a case to the switch in common/config assigning
  98           these variables based on the hostname of your test
  99           machine
 100         - or add these variables to a file called local.config and keep that
 101           file in your workarea.
 102
 103     - if testing xfsdump, make sure the tape devices have a
 104       tape which can be overwritten.
 105
 106     - make sure $TEST_DEV is a mounted XFS partition
 107     - make sure that $SCRATCH_DEV or $SCRATCH_DEV_POOL contains nothing useful
 108
 109 Running tests:
 110
 111     - cd xfstests
 112     - By default the tests suite will run xfs tests:
 113     - ./check '*/001' '*/002' '*/003'
 114     - ./check '*/06?'
 115     - Groups of tests maybe ran by: ./check -g [group(s)]
 116       See the 'group' file for details on groups
 117     - To randomize test order: ./check -r [test(s)]
 118     - You can explicitly specify NFS/CIFS/OVERLAY, otherwise
 119       the filesystem type will be autodetected from $TEST_DEV:
 120         - for running nfs tests: ./check -nfs [test(s)]
 121         - for running cifs/smb3 tests: ./check -cifs [test(s)]
 122         - for overlay tests: ./check -overlay [test(s)]
 123           The TEST and SCRATCH partitions should be pre-formatted
 124           with another base fs, where the overlay dirs will be created
 125
 126
 127     The check script tests the return value of each script, and
 128     compares the output against the expected output. If the output
 129     is not as expected, a diff will be output and an .out.bad file
 130     will be produced for the failing test.
 131
 132     Unexpected console messages, crashes and hangs may be considered
 133     to be failures but are not necessarily detected by the QA system.
 134
 135 __________________________
 136 ADDING TO THE FSQA SUITE
 137 __________________________
 138
 139
 140 Creating new tests scripts:
 141
 142     Use the "new" script.
 143
 144 Test script environment:
 145
 146     When developing a new test script keep the following things in
 147     mind.  All of the environment variables and shell procedures are
 148     available to the script once the "common/rc" file has been
 149     sourced.
 150
 151      1. The tests are run from an arbitrary directory.  If you want to
 152         do operations on an XFS filesystem (good idea, eh?), then do
 153         one of the following:
 154
 155         (a) Create directories and files at will in the directory
 156             $TEST_DIR ... this is within an XFS filesystem and world
 157             writeable.  You should cleanup when your test is done,
 158             e.g. use a _cleanup shell procedure in the trap ... see
 159             001 for an example.  If you need to know, the $TEST_DIR
 160             directory is within the filesystem on the block device
 161             $TEST_DEV.
 162
 163         (b) mkfs a new XFS filesystem on $SCRATCH_DEV, and mount this
 164             on $SCRATCH_MNT. Call the the _require_scratch function
 165             on startup if you require use of the scratch partition.
 166             _require_scratch does some checks on $SCRATCH_DEV &
 167             $SCRATCH_MNT and makes sure they're unmounted. You should
 168             cleanup when your test is done, and in particular unmount
 169             $SCRATCH_MNT.
 170             Tests can make use of $SCRATCH_LOGDEV and $SCRATCH_RTDEV
 171             for testing external log and realtime volumes - however,
 172             these tests need to simply "pass" (e.g. cat $seq.out; exit
 173             - or default to an internal log) in the common case where
 174             these variables are not set.
 175
 176      2. You can safely create temporary files that are not part of the
 177         filesystem tests (e.g. to catch output, prepare lists of things
 178         to do, etc.) in files named $tmp.<anything>.  The standard test
 179         script framework created by "new" will initialize $tmp and
 180         cleanup on exit.
 181
 182      3. By default, tests are run as the same uid as the person
 183         executing the control script "check" that runs the test scripts.
 184
 185      4. Some other useful shell procedures:
 186
 187         _get_fqdn               - echo the host's fully qualified
 188                                   domain name
 189
 190         _get_pids_by_name       - one argument is a process name, and
 191                                   return all of the matching pids on
 192                                   standard output
 193
 194         _within_tolerance       - fancy numerical "close enough is good
 195                                   enough" filter for deterministic
 196                                   output ... see comments in
 197                                   common/filter for an explanation
 198
 199         _filter_date            - turn ctime(3) format dates into the
 200                                   string DATE for deterministic
 201                                   output
 202
 203         _cat_passwd,            - dump the content of the password
 204         _cat_group                or group file (both the local file
 205                                   and the content of the NIS database
 206                                   if it is likely to be present)
 207
 208      5. General recommendations, usage conventions, etc.:
 209         - When the content of the password or group file is
 210           required, get it using the _cat_passwd and _cat_group
 211           functions, to ensure NIS information is included if NIS
 212           is active.
 213         - When calling getfacl in a test, pass the "-n" argument so
 214           that numeric rather than symbolic identifiers are used in
 215           the output.
 216         - When creating a new test, it is possible to enter a custom name
 217           for the file. Filenames are in form NNN-custom-name, where NNN
 218           is automatically added by the ./new script as an unique ID,
 219           and "custom-name" is the optional string entered into a prompt
 220           in the ./new script. It can contain only alphanumeric characters
 221           and dash. Note the "NNN-" part is added automatically.
 222
 223 Verified output:
 224
 225     Each test script has a name, e.g. 007, and an associated
 226     verified output, e.g. 007.out.
 227
 228     It is important that the verified output is deterministic, and
 229     part of the job of the test script is to filter the output to
 230     make this so.  Examples of the sort of things that need filtering:
 231
 232     - dates
 233     - pids
 234     - hostnames
 235     - filesystem names
 236     - timezones
 237     - variable directory contents
 238     - imprecise numbers, especially sizes and times
 239
 240 Pass/failure:
 241
 242     The script "check" may be used to run one or more tests.
 243
 244     Test number $seq is deemed to "pass" when:
 245     (a) no "core" file is created,
 246     (b) the file $seq.notrun is not created,
 247     (c) the exit status is 0, and
 248     (d) the output matches the verified output.
 249
 250     In the "not run" case (b), the $seq.notrun file should contain a
 251     short one-line summary of why the test was not run.  The standard
 252     output is not checked, so this can be used for a more verbose
 253     explanation and to provide feedback when the QA test is run
 254     interactively.
 255
 256
 257     To force a non-zero exit status use:
 258         status=1
 259         exit
 260
 261     Note that:
 262         exit 1
 263     won't have the desired effect because of the way the exit trap
 264     works.
 265
 266     The recent pass/fail history is maintained in the file "check.log".
 267     The elapsed time for the most recent pass for each test is kept
 268     in "check.time".
 269
 270     The compare-failures script in tools/ may be used to compare failures
 271     across multiple runs, given files containing stdout from those runs.
 272
 273 __________________
 274 SUBMITTING PATCHES
 275 __________________
 276
 277 Send patches to the fstests mailing list at fstests@vger.kernel.org.