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 test the tools from the dpkg build-tree, use the «test» target. If you
  13 want instead to test the installed programs use the «installtest» target.
  14
  15 To test with the compiler sanitizer «configure ---enable-compiler-sanitizer»,
  16 and run the tests normally.
  17
  18 The DPKG_TESTSUITE_OPTIONS environment/make variable can be used to change
  19 the behavior of the test runs, the following options are currently
  20 supported:
  21
  22 * as-root
  23
  24   WARNING: This runs the tests in privileged mode, and will write to your
  25   current root filesystem. If you are uncertain of the consequences, run
  26   it at least on a chroot, or isolated in a virtual machine.
  27
  28 * test-all
  29
  30   This runs all tests, including manual and failing ones.
  31
  32 * debug
  33
  34   This makes dpkg print lots of debug output.
  35
  36 The configuration file ‘.pkg-tests.conf’ can be used to set permanent
  37 parameters. For example:
  38
  39   ,-- .pkg-tests.conf --
  40   |DPKG_TESTSUITE_OPTIONS := debug
  41   `--
  42
  43 Test-suite layout
  44 -----------------
  45
  46 The tests are split into logical units, testing a specific characteristic.
  47 To add a new test please check Test.mk and Makefile on the topdir, and some
  48 of the current tests. Patches welcome!
  49
  50 Future plans
  51 ------------
  52
  53 There's lots of tests that are still missing, we are adding new ones when
  54 we stumble over regressions, when adding new functionality, and as time
  55 permits for existing functionality.
  56
  57 The idea is for this to progressively be integrated into the autotools
  58 autotest suite under src/at/, and be run as part of “make check”. Some
  59 changes to dpkg would need to be implemented first.