On Fri, Jul 21, 2017 at 07:16:34AM -0500, Eric Blake wrote:
On 07/21/2017 04:34 AM, Stefan Hajnoczi wrote:
There is not much getting started documentation for qemu-iotests. This
patch explains how to create a new test and covers the overall testing
approach.
Cc: Ishani Chugh <address@hidden>
Signed-off-by: Stefan Hajnoczi <address@hidden>
---
+3. Assign groups to the test
+
+Add your test to the ./group file. This file is the index of tests and assigns
+them to functional groups like "rw" for read-write tests. Most tests belong to
+the "rw" and "auto" groups. "auto" means the test runs when ./check is invoked
+without a -g argument.
+
+Consider adding your test to the "quick" group if it executes quickly (<1s).
We have several tests going up to 5s (and I have a patch pending to
remove two tests that took longer) - I think 1s is a bit on the short
end for still classifying a test as quick.
I'm happy to accept any number blessed by Kevin. I do think that 1
second is a safe maximum and no one should get in trouble for adding a
test that takes 1 second to the "quick" group.
+This group is run by "make check-block" and is often included as part of build
+tests in continuous integration systems.
It would still be nice to have 'make check' run 'make check-block'...
but that's independent of this patch.
Yes, there is a separate discussion about that on the list right now.
Hopefully it will be added back.
+Once you are happy with the test output it can be used as the golden master
+with "mv <test-number>.out.bad <test-number>.out". Rerun the test to verify
+that it passes.
+
+Congratulations, you've created a new test!
Maybe a reminder to 'git add' the new files, then submit the patch?
I thought about this too but decided not to get into the git and patch
submission business. I carefully worded it to be about "creating" tests
rather than "adding" them to qemu.git because I wanted to limit the
scope of this README :).