tests/README

   1
   2 This directory contains the (non-doctest) testcode for pyutils (i.e. unit tests
   3 and integration tests).  It also contains a couple of helpers to run the tests.
   4
   5 The easiest way to run the tests is, from within this tests/ directory, run:
   6
   7     ./run_tests_serially.sh -a
   8
   9 If you only want to run a subset of the tests (e.g. all doctests only) run:
  10
  11     ./run_tests_serially.sh -d
  12
  13 As you can tell from the name, this shell script runs the tests in serial.
  14 If you want to go faster (and put more load on your machine), try:
  15
  16     ./run_tests.py --all
  17
  18 Or:
  19
  20     ./run_tests.py -d
  21
  22 Both of these runners store test output under ./test_output.
  23
  24 Both of them can optionally use coverage (pip install coverage) to generate a
  25 code coverage report:
  26
  27     ./run_tests.py --all --coverage
  28
  29 I use ./run_tests.py --all --coverage as a .git/hooks/pre-commit-hook.