Alberto Bertogli
ab2a6e7eb3
In Go 1.25.11/1.26.4, net/textproto error formatting was changed, and now the message is quoted. This is to protect from general string injections. See https://go-review.googlesource.com/c/go/+/778182 and ec1c380418ec6a0da28d4519872e2b81ba9152ba. After this change, the error strings from net/textproto (and net/smtp which uses it) now include quotes. For chasquid, the only user-observable change in the server is that the errors included in the DSN messages are now quoted, which should not be a problem. However, some of the tests which validate error strings need to be adjusted. The patch also updates go.mod to set the Go version to match this new minimum.
Testing
Go tests
All Go packages have their own test suite, which provides easy and portable tests with decent enough coverage.
Integration tests
In the test/ directory there is a set of end to end integration tests,
written usually in a combination of bash and Python 3.
They're not expected to be portable, as that gets impractical very quickly, but should be usable in most Linux environments.
They provide critical coverage and integration tests for real life scenarios, as well as interactions with other software (like Exim or Dovecot).
Dependencies
The tests depend on the following things being installed on the system (listed as Debian package, for consistency):
msmtputil-linux(for/usr/bin/setsid)
Some individual tests have additional dependencies, and the tests are skipped if the dependencies are not found:
t-02-eximExim interaction tests:gettext-base(for/usr/bin/envsubst)- The
eximbinary available somewhere, but it doesn't have to be installed. There's a scriptget-exim4-debian.shto get it from the archives.
t-11-dovecotDovecot interaction tests:dovecot
t-15-driusan_dkimDKIM integration tests:- The
dkimsign dkimverify dkimkeygenbinaries, from driusan/dkim (no Debian package yet).
- The
t-18-haproxyHAProxy integration tests:haproxy
t-19-dkimpy: dkimpy integration tests:python3-dkim
t-23-prometheus: Prometheus integration tests:prometheus promtool
For some tests, python >= 3.5 is required; they will be skipped if it's not available.
Most tests depend on the
$HOSTALIASES
environment variable being functional, and will be skipped if it isn't. This
works by default in most Linux systems, but note that the use of
systemd-resolved can prevent it from working properly.
Stress tests
Also in the test/ directory there is a set of stress tests, which generate
load against chasquid to measure performance and resource consumption.
While they are not exhaustive, they are useful to catch regressions and track improvements on the main code paths.
Fuzz tests
Some Go packages also have instrumentation to run fuzz testing against them, using the Go native fuzzing support.
This is critical for packages that handle sensitive user input, such as authentication encoding, aliases files, or username normalization.
Command-line tool tests
Each command-line tool has their own set of tests, see the test.sh file on
their corresponding directories.
Docker
The test/Dockerfile can be used to set up a suitable isolated environment to
run the integration and stress tests.
This is very useful for automated tests, or running the integration tests in constrained or non supported environments.
Automated tests
There are two sets of automated tests which are run on every commit to upstream, and also weekly:
-
Github Actions, configured in the
.githubdirectory, runs the Go tests, the integration tests, checks for vulnerabilities, and finally also builds the public Docker images. -
Cirrus CI, configured in the
.cirrus.ymlfile, runs Go tests on FreeBSD.
Coverage
The test/cover.sh script runs the integration tests in coverage mode, and
produces a code coverage report in HTML format, for ease of analysis.
The target is to keep coverage of the chasquid binary above 90%.