git » chasquid » commit 0c9d153

docs: Update to reflect coverage changes, and add links

author Alberto Bertogli
2023-05-16 09:50:26 UTC
committer Alberto Bertogli
2023-05-16 09:50:26 UTC
parent e85ad54a73a11ef912a44a6e92b09536bed8b855

docs: Update to reflect coverage changes, and add links

This patch updates to reflect the recent changes around
coverage testing, specifically we no longer have coverage issues with
fatal/non-zero exits, so remove that section from the docs.

Also while at it, add links to the software we reference, for

test/ +6 -8

diff --git a/test/ b/test/
index 2c05144..5635655 100644
--- a/test/
+++ b/test/
@@ -30,18 +30,20 @@ as Debian package, for consistency):
 Some individual tests have additional dependencies, and the tests are skipped
 if the dependencies are not found:
-- `t-02-exim` Exim interaction tests:
+- `t-02-exim` [Exim]( interaction tests:
     - `gettext-base` (for `/usr/bin/envsubst`)
     - The `exim` binary available somewhere, but it doesn't have to be
       installed.  There's a script `` to get it from the
-- `t-11-dovecot` Dovecot interaction tests:
+- `t-11-dovecot` [Dovecot]( interaction tests:
     - `dovecot`
 - `t-15-driusan_dkim` DKIM integration tests:
     - The `dkimsign dkimverify dkimkeygen` binaries, from
       [driusan/dkim]( (no Debian package yet).
-- `t-18-haproxy` HAProxy integration tests:
+- `t-18-haproxy` [HAProxy]( integration tests:
     - `haproxy`
+- `t-19-dkimpy`: [dkimpy]( integration tests:
+    - `python3-dkim`
 For some tests, python >= 3.5 is required; they will be skipped if it's not
@@ -89,7 +91,7 @@ constrained or non supported environments.
 ## Automated tests
 There are two sets of automated tests which are run on every commit to
-upstream, and weekly:
+upstream, and also weekly:
 * [Github Actions](,
   configured in the `.github` directory, runs the Go tests, the integration
@@ -105,8 +107,4 @@ upstream, and weekly:
 The `test/` script runs the integration tests in coverage mode, and
 produces a code coverage report in HTML format, for ease of analysis.
-Unfortunately, exiting with any of the *Fatal* functions does not save
-coverage output. Those paths are very important to test, but don't expect to
-see them reflected in the coverage report for now.
 The target is to keep coverage of the `chasquid` binary above 90%.