tests/README

   1 dpkg functional test-suite
   2 ~~~~~~~~~~~~~~~~~~~~~~~~~~
   3
   4 How to run
   5 ----------
   6
   7 There's a brief usage information when invoking “make” on the topdir.
   8
   9 You probably want to use something like eatmydata to run the tests, it
  10 affects the performance significantly.
  11
  12 To use the tools from the dpkg build-tree, set DPKG_BUILDTREE accordingly.
  13
  14 The DPKG_TESTSUITE_OPTIONS environment/make variable can be used to change
  15 the behaviour of the test runs, the following options are currently
  16 supported:
  17
  18 * as-root
  19
  20   WARNING: This runs the tests in privileged mode, and will write to your
  21   current root filesystem. If you are uncertain of the consequences, run
  22   it at least on a chroot, or isolated in a virtual machine.
  23
  24 * test-all
  25
  26   This runs all tests, including manual and failing ones.
  27
  28 * debug
  29
  30   This makes dpkg print lots of debug output.
  31
  32 The configuration file ‘.pkg-tests.conf’ can be used to set permanent
  33 parameters. For example:
  34
  35   ,-- .pkg-tests.conf --
  36   |DPKG_TESTSUITE_OPTIONS := debug
  37   `--
  38
  39 Test-suite layout
  40 -----------------
  41
  42 The tests are split into logical units, testing a specific characteristic.
  43 To add a new test please check Test.mk and Makefile on the topdir, and some
  44 of the current tests. Patches welcome!
  45
  46 Future plans
  47 ------------
  48
  49 There's lots of tests that are still missing, we are adding new ones when
  50 we stumble over regressions, when adding new functionality, and as time
  51 permits for existing functionality.
  52
  53 The idea is for this to progressively be integrated into the autotools
  54 autotest suite under src/at/, and be run as part of “make check”. Some
  55 changes to dpkg would need to be implemented first.