X-Git-Url: http://git.marmaro.de/?p=mmh;a=blobdiff_plain;f=test%2FREADME;h=e37a4eec7b1f194b39701148056f3c392bfdec48;hp=94b5ab1597806cda3b14407e1a767704ef06103a;hb=88b2142594d5ea1e8385dae5eca81eed1018c555;hpb=da2ccd847bcb978a51b946e934ac91a2af7347fa diff --git a/test/README b/test/README index 94b5ab1..e37a4ee 100644 --- a/test/README +++ b/test/README @@ -1,30 +1,25 @@ -nmh unit test suite. +Mmh test suite. - - The testcases are not maintained in mmh, currently. - Thus, they likely are broken. --meillo 2012-04 - - -The purpose of these tests is to verify the functionality of the nmh +The purpose of these tests is to verify the functionality of the mmh commands. The goal of the suite is to create an environment where testing -nmh commands is easy and useful. Each test is a shell script, and is +mmh commands is easy and useful. Each test is a shell script, and is launched via the 'sh' command. The script should run the test and report the result by one of: * for a test pass: exit with status 0 * where a test has been skipped (perhaps because it depends on an - external program which can't be found): print "Test $0 SKIP (reason)" - and exit with status 120 + external program which can't be found) execute: `test_skip "reason"'. + (test_skip() is defined in common.sh; it exits with status 120) * for a test fail: exit with some status other than 0 or 120 The Suite is arranged as such: setup-test - Create the unit test framework. This will re-generate your configure + Create the test framework. This will re-generate your configure script and make files. teardown-test - Remove the temporary files created as part of the unit tests. + Remove the temporary files created as part of the tests. runtest Run a single test. @@ -34,8 +29,8 @@ runalltests tests Directory containing the tests. All files found in this and all - subsequent directories which have the name test-* will be treated as a - single test. + sub-directories which have the name test-* will be treated as one + test each. Complex tests may be given their own directory as long as there is a file named 'test-*' in the directory which will launch the test.