git.marmaro.de Git - mmh/blob - test/README

   1 nmh unit test suite.
   2
   3 The purpose of these tests is to verify the functionality of the nmh
   4 commands.  The goal of the suite is to create an environment where testing
   5 nmh commands is easy and useful.  Each test is a shell script, and is
   6 launched via the 'sh' command. The script should run the test and report
   7 the result by one of:
   8
   9   * for a test pass: exit with status 0
  10   * where a test has been skipped (perhaps because it depends on an
  11     external program which can't be found): print "Test $0 SKIP (reason)"
  12     and exit with status 120
  13   * for a test fail: exit with some status other than 0 or 120
  14
  15 The Suite is arranged as such:
  16
  17 setup-test
  18     Create the unit test framework.  This will re-generate your configure
  19     script and make files.
  20
  21 teardown-test
  22     Remove the temporary files created as part of the unit tests.
  23
  24 runtest
  25     Run a single test.
  26
  27 runalltests
  28     Run all tests in the suite
  29
  30 tests
  31     Directory containing the tests.  All files found in this and all
  32     subsequent directories which have the name test-* will be treated as a
  33     single test.
  34
  35 Complex tests may be given their own directory as long as there is a file
  36 named 'test-*' in the directory which will launch the test.