fstests: add fio perf results support
[xfstests-dev.git] / 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 python sqlite3
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 python sqlite
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              - setenv PERF_CONFIGNAME to a arbitrary string to be used for
97                identifying the test setup for running perf tests.  This should
98                be different for each type of performance test you wish to run so
99                that relevant results are compared.  For example 'spinningrust'
100                for configurations that use spinning disks and 'nvme' for tests
101                using nvme drives.
102
103         - or add a case to the switch in common/config assigning
104           these variables based on the hostname of your test
105           machine
106         - or add these variables to a file called local.config and keep that
107           file in your workarea.
108
109     - if testing xfsdump, make sure the tape devices have a
110       tape which can be overwritten.
111           
112     - make sure $TEST_DEV is a mounted XFS partition
113     - make sure that $SCRATCH_DEV or $SCRATCH_DEV_POOL contains nothing useful
114     
115 Running tests:
116
117     - cd xfstests
118     - By default the tests suite will run xfs tests:
119     - ./check '*/001' '*/002' '*/003'
120     - ./check '*/06?'
121     - Groups of tests maybe ran by: ./check -g [group(s)]
122       See the 'group' file for details on groups
123     - To randomize test order: ./check -r [test(s)]
124     - You can explicitly specify NFS/CIFS/OVERLAY, otherwise
125       the filesystem type will be autodetected from $TEST_DEV:
126         - for running nfs tests: ./check -nfs [test(s)]
127         - for running cifs/smb3 tests: ./check -cifs [test(s)]
128         - for overlay tests: ./check -overlay [test(s)]
129           The TEST and SCRATCH partitions should be pre-formatted
130           with another base fs, where the overlay dirs will be created
131
132     
133     The check script tests the return value of each script, and
134     compares the output against the expected output. If the output
135     is not as expected, a diff will be output and an .out.bad file
136     will be produced for the failing test.
137     
138     Unexpected console messages, crashes and hangs may be considered
139     to be failures but are not necessarily detected by the QA system.
140
141 __________________________ 
142 ADDING TO THE FSQA SUITE
143 __________________________
144
145
146 Creating new tests scripts:
147
148     Use the "new" script.
149
150 Test script environment:
151
152     When developing a new test script keep the following things in
153     mind.  All of the environment variables and shell procedures are
154     available to the script once the "common/rc" file has been
155     sourced.
156
157      1. The tests are run from an arbitrary directory.  If you want to
158         do operations on an XFS filesystem (good idea, eh?), then do
159         one of the following:
160
161         (a) Create directories and files at will in the directory
162             $TEST_DIR ... this is within an XFS filesystem and world
163             writeable.  You should cleanup when your test is done,
164             e.g. use a _cleanup shell procedure in the trap ... see
165             001 for an example.  If you need to know, the $TEST_DIR
166             directory is within the filesystem on the block device
167             $TEST_DEV.
168
169         (b) mkfs a new XFS filesystem on $SCRATCH_DEV, and mount this
170             on $SCRATCH_MNT. Call the the _require_scratch function 
171             on startup if you require use of the scratch partition.
172             _require_scratch does some checks on $SCRATCH_DEV & 
173             $SCRATCH_MNT and makes sure they're unmounted. You should 
174             cleanup when your test is done, and in particular unmount 
175             $SCRATCH_MNT.
176             Tests can make use of $SCRATCH_LOGDEV and $SCRATCH_RTDEV
177             for testing external log and realtime volumes - however,
178             these tests need to simply "pass" (e.g. cat $seq.out; exit
179             - or default to an internal log) in the common case where
180             these variables are not set.
181
182      2. You can safely create temporary files that are not part of the
183         filesystem tests (e.g. to catch output, prepare lists of things
184         to do, etc.) in files named $tmp.<anything>.  The standard test
185         script framework created by "new" will initialize $tmp and
186         cleanup on exit.
187
188      3. By default, tests are run as the same uid as the person
189         executing the control script "check" that runs the test scripts.
190
191      4. Some other useful shell procedures:
192
193         _get_fqdn               - echo the host's fully qualified
194                                   domain name
195
196         _get_pids_by_name       - one argument is a process name, and
197                                   return all of the matching pids on
198                                   standard output
199
200         _within_tolerance       - fancy numerical "close enough is good
201                                   enough" filter for deterministic
202                                   output ... see comments in
203                                   common/filter for an explanation
204
205         _filter_date            - turn ctime(3) format dates into the
206                                   string DATE for deterministic
207                                   output
208
209         _cat_passwd,            - dump the content of the password
210         _cat_group                or group file (both the local file
211                                   and the content of the NIS database
212                                   if it is likely to be present)
213
214      5. General recommendations, usage conventions, etc.:
215         - When the content of the password or group file is
216           required, get it using the _cat_passwd and _cat_group
217           functions, to ensure NIS information is included if NIS
218           is active.
219         - When calling getfacl in a test, pass the "-n" argument so
220           that numeric rather than symbolic identifiers are used in
221           the output.
222         - When creating a new test, it is possible to enter a custom name
223           for the file. Filenames are in form NNN-custom-name, where NNN
224           is automatically added by the ./new script as an unique ID,
225           and "custom-name" is the optional string entered into a prompt
226           in the ./new script. It can contain only alphanumeric characters
227           and dash. Note the "NNN-" part is added automatically.
228
229 Verified output:
230
231     Each test script has a name, e.g. 007, and an associated
232     verified output, e.g. 007.out.
233
234     It is important that the verified output is deterministic, and
235     part of the job of the test script is to filter the output to
236     make this so.  Examples of the sort of things that need filtering:
237
238     - dates
239     - pids
240     - hostnames
241     - filesystem names
242     - timezones
243     - variable directory contents
244     - imprecise numbers, especially sizes and times
245
246 Pass/failure:
247
248     The script "check" may be used to run one or more tests.
249
250     Test number $seq is deemed to "pass" when:
251     (a) no "core" file is created,
252     (b) the file $seq.notrun is not created,
253     (c) the exit status is 0, and
254     (d) the output matches the verified output.
255
256     In the "not run" case (b), the $seq.notrun file should contain a
257     short one-line summary of why the test was not run.  The standard
258     output is not checked, so this can be used for a more verbose
259     explanation and to provide feedback when the QA test is run
260     interactively.
261
262
263     To force a non-zero exit status use:
264         status=1
265         exit
266
267     Note that:
268         exit 1
269     won't have the desired effect because of the way the exit trap
270     works.
271
272     The recent pass/fail history is maintained in the file "check.log".
273     The elapsed time for the most recent pass for each test is kept
274     in "check.time".
275
276     The compare-failures script in tools/ may be used to compare failures
277     across multiple runs, given files containing stdout from those runs.
278
279 __________________
280 SUBMITTING PATCHES
281 __________________
282
283 Send patches to the fstests mailing list at fstests@vger.kernel.org.