summaryrefslogtreecommitdiffstats
path: root/tests/README
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-27 09:40:31 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-27 09:40:31 +0000
commitb86570f63e533abcbcb97c2572e0e5732a96307b (patch)
treecabc83be691530ae685c45a8bc7620ccc0e1ebdf /tests/README
parentInitial commit. (diff)
downloaddpkg-b86570f63e533abcbcb97c2572e0e5732a96307b.tar.xz
dpkg-b86570f63e533abcbcb97c2572e0e5732a96307b.zip
Adding upstream version 1.20.13.upstream/1.20.13upstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to '')
-rw-r--r--tests/README57
1 files changed, 57 insertions, 0 deletions
diff --git a/tests/README b/tests/README
new file mode 100644
index 0000000..62c8b75
--- /dev/null
+++ b/tests/README
@@ -0,0 +1,57 @@
+dpkg functional test-suite
+~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+How to run
+----------
+
+After cloning the repository, you will need to run «./db-regen».
+
+There's a brief usage information when invoking “make” on the topdir.
+
+You probably want to use something like eatmydata to run the tests, it
+affects the performance significantly.
+
+To use the tools from the dpkg build-tree, set DPKG_BUILDTREE accordingly.
+
+The DPKG_TESTSUITE_OPTIONS environment/make variable can be used to change
+the behaviour of the test runs, the following options are currently
+supported:
+
+* as-root
+
+ WARNING: This runs the tests in privileged mode, and will write to your
+ current root filesystem. If you are uncertain of the consequences, run
+ it at least on a chroot, or isolated in a virtual machine.
+
+* test-all
+
+ This runs all tests, including manual and failing ones.
+
+* debug
+
+ This makes dpkg print lots of debug output.
+
+The configuration file ‘.pkg-tests.conf’ can be used to set permanent
+parameters. For example:
+
+ ,-- .pkg-tests.conf --
+ |DPKG_TESTSUITE_OPTIONS := debug
+ `--
+
+Test-suite layout
+-----------------
+
+The tests are split into logical units, testing a specific characteristic.
+To add a new test please check Test.mk and Makefile on the topdir, and some
+of the current tests. Patches welcome!
+
+Future plans
+------------
+
+There's lots of tests that are still missing, we are adding new ones when
+we stumble over regressions, when adding new functionality, and as time
+permits for existing functionality.
+
+The idea is for this to progressively be integrated into the autotools
+autotest suite under t-func/, and be run as part of “make check”. Some
+changes to dpkg would need to be implemented first.