tests/README.txt

   1 General guide
   2 =============
   3
   4 The default behavior is to add the source directory to the import path.
   5 Developers are expected to build the extension libraries in place with:
   6
   7 python setup.py build_ext -i
   8
   9 See the section on flags on how to customize this behavior.
  10
  11 Typical use cases
  12 =================
  13
  14 Test modules end with _test.py suffix. Each test module may be
  15 executed on its own and will produce high verbosity output.
  16
  17 The runtests.py script may be used to run all test modules
  18 or a subset of them.
  19
  20 Run all tests (modules that end in _test.py):
  21         python runtest.py
  22
  23 To run one test you can execute the file itself:
  24         python seqdb_test.py
  25
  26 Other way to run one test is via the runtest script:
  27         python runtest.py seqdb_test.py
  28
  29 Run two tests:
  30         python runtest.py seqdb_test.py sequence_test.py
  31
  32 Run all tests excluding seqdb_test:
  33         python runtest.py -x seqdb_test.py
  34
  35 Change verbosity levels:
  36         python runtest.py -v 2
  37
  38 You may use full file names, or module names.
  39
  40 Flags
  41 =====
  42
  43 To see the flags execute the script with the -h flag
  44
  45         python runtest.py -h
  46
  47 Usage: runtest.py [options]
  48
  49 Options:
  50   -h, --help            show this help message and exit
  51   -n, --nopath          do not alter the python import path
  52   -b, --buildpath       use the platform specific build directory
  53   -s, --strict          stops testing after a test suite fails
  54   -x, --exclude         excludes the files that are listed
  55   -v VERBOSITY, --verbosity=VERBOSITY
  56                         sets the verbosity (0, 1, or 2)
  57   --coverage            runs figleaf and collects the coverage information
  58   --performance         runs the performance tests (not implemented)
  59
  60 These options are only used internally:
  61
  62   --port=PORT           sets the port information for the XMLRPC server
  63   --pygrdatapath=PYGRDATAPATH
  64                         sets the pygraphdata path for the XMLRPC server
  65   --downloadDB=DOWNLOADDB
  66                         sets the downloadDB shelve for the XMLRPC server
  67   --resources=RESOURCES
  68                         sets the downloadable resources, separate multiple
  69                         ones with a : symbol
  70
  71 Notes
  72 =====
  73   - The lowest (0) verbosity turns off DEBUG level messages
  74   - The test specific connection information is read out from the
  75    mysql.cnf file in the tests2 directory (for now it is last resort
  76    but should be the primary way)
  77   - The main test runner will delete the temp directory before each run.
  78   - Each test module must implement the get_suite() function that returns
  79   a unittest test suite
  80   - Import the pathfix module at the start of each test module to alter the
  81   import path. This module will parse and apply the command line variables.