mirror of
https://github.com/tomav/docker-mailserver.git
synced 2024-07-07 16:41:06 +02:00
b58165762a
With `reload` a change detection event during local testing can be processed in less than a second according to logs. Previously this was 5+ seconds (_plus additional downtime for Postfix/Dovecot to become available again_).
In the past it was apparently an issue to use `<service> reload` due to a concern with the PID for wrapper scripts that `supervisorctl` managed, thus `supervisorctl <service> restart` had been used. Past discussions with maintainers suggest this is not likely an issue anymore, and `reload` should be fine to switch to now 👍
---
**NOTE:** It may not be an issue in the CI, but on _**local systems running tests may risk failure in `setup-cli.bats` from a false positive**_ due to 1 second polling window of the test helper method, and a change event being possible to occur entirely between the two checks undetected by the current approach.
If this is a problem, we may need to think of a better way to catch the change. The `letsencrypt` test counts how many change events are expected to have been processed, and this could technically be leveraged by the test helper too.
---
**NOTE:** These two lines (_with regex pattern for postfix_) are output in the terminal when using the services respective `reload` commands:
```
postfix/master.*: reload -- version .*, configuration /etc/postfix
dovecot: master: Warning: SIGHUP received - reloading configuration
```
I wasn't sure how to match them as they did not appear in the `changedetector` log (_**EDIT:** they appear in the main log output, eg `docker logs <container name>`_).
Instead I've just monitored the `changedetector` log messages, which should be ok for logic that previously needed to ensure Dovecot / Postfix was back up after the `restart` was issued.
---
Commit history:
* chore: Change events `reload` Dovecot and Postfix instead of `restart`
Reloading is faster than restarting the processes.
Restarting is a bit heavy handed here and may no longer be necessary for general usage?
* tests: Adapt tests to support service `reload` instead of `restart`
* chore: Additional logging for debugging change event logs
* fix: Wait on change detection, then verify directory created
Change detection is too fast now (0-1 seconds vs 5+).
Directory being waited on here was created near the end of a change event, reducing that time to detect a change by the utility method further.
We can instead check that the directory exists after the change detection event is completed.
* chore: Keep using the maildir polling check
We don't presently use remote storage in tests, but it might be relevant in future when testing NFS.
This at least avoids any confusing failure happening when that scenario is tested.
88 lines
4.0 KiB
Bash
88 lines
4.0 KiB
Bash
load "${REPOSITORY_ROOT}/test/test_helper/common"
|
|
|
|
# Note if tests fail asserting against `supervisorctl tail changedetector` output,
|
|
# use `supervisorctl tail -<num bytes> changedetector` instead to increase log output.
|
|
# Default `<num bytes>` appears to be around 1500.
|
|
|
|
function setup_file() {
|
|
local PRIVATE_CONFIG
|
|
PRIVATE_CONFIG=$(duplicate_config_for_container . mail_changedetector_one)
|
|
|
|
docker run -d --name mail_changedetector_one \
|
|
-v "${PRIVATE_CONFIG}":/tmp/docker-mailserver \
|
|
-v "$(pwd)/test/test-files":/tmp/docker-mailserver-test:ro \
|
|
-e LOG_LEVEL=trace \
|
|
-h mail.my-domain.com -t "${NAME}"
|
|
|
|
docker run -d --name mail_changedetector_two \
|
|
-v "${PRIVATE_CONFIG}":/tmp/docker-mailserver \
|
|
-v "$(pwd)/test/test-files":/tmp/docker-mailserver-test:ro \
|
|
-e LOG_LEVEL=trace \
|
|
-h mail.my-domain.com -t "${NAME}"
|
|
|
|
wait_for_finished_setup_in_container mail_changedetector_one
|
|
wait_for_finished_setup_in_container mail_changedetector_two
|
|
}
|
|
|
|
function teardown_file() {
|
|
docker rm -f mail_changedetector_one
|
|
docker rm -f mail_changedetector_two
|
|
}
|
|
|
|
@test "checking changedetector: servers are ready" {
|
|
wait_for_service mail_changedetector_one changedetector
|
|
wait_for_service mail_changedetector_two changedetector
|
|
}
|
|
|
|
@test "checking changedetector: can detect changes & between two containers using same config" {
|
|
echo "" >> "$(private_config_path mail_changedetector_one)/postfix-accounts.cf"
|
|
sleep 25
|
|
|
|
run docker exec mail_changedetector_one /bin/bash -c 'supervisorctl tail -3000 changedetector'
|
|
assert_output --partial 'Change detected'
|
|
assert_output --partial 'Reloading services due to detected changes'
|
|
assert_output --partial 'Removed lock'
|
|
assert_output --partial 'Completed handling of detected change'
|
|
|
|
run docker exec mail_changedetector_two /bin/bash -c 'supervisorctl tail -3000 changedetector'
|
|
assert_output --partial 'Change detected'
|
|
assert_output --partial 'Reloading services due to detected changes'
|
|
assert_output --partial 'Removed lock'
|
|
assert_output --partial 'Completed handling of detected change'
|
|
}
|
|
|
|
@test "checking changedetector: lock file found, blocks, and doesn't get prematurely removed" {
|
|
run docker exec mail_changedetector_two /bin/bash -c "supervisorctl stop changedetector"
|
|
docker exec mail_changedetector_one /bin/bash -c "touch /tmp/docker-mailserver/check-for-changes.sh.lock"
|
|
echo "" >> "$(private_config_path mail_changedetector_one)/postfix-accounts.cf"
|
|
run docker exec mail_changedetector_two /bin/bash -c "supervisorctl start changedetector"
|
|
sleep 15
|
|
|
|
run docker exec mail_changedetector_one /bin/bash -c "supervisorctl tail changedetector"
|
|
assert_output --partial "another execution of 'check-for-changes.sh' is happening"
|
|
run docker exec mail_changedetector_two /bin/bash -c "supervisorctl tail changedetector"
|
|
assert_output --partial "another execution of 'check-for-changes.sh' is happening"
|
|
|
|
# Ensure starting a new check-for-changes.sh instance (restarting here) doesn't delete the lock
|
|
docker exec mail_changedetector_two /bin/bash -c "rm -f /var/log/supervisor/changedetector.log"
|
|
run docker exec mail_changedetector_two /bin/bash -c "supervisorctl restart changedetector"
|
|
sleep 5
|
|
run docker exec mail_changedetector_two /bin/bash -c "supervisorctl tail changedetector"
|
|
refute_output --partial "another execution of 'check-for-changes.sh' is happening"
|
|
refute_output --partial "Removed lock"
|
|
}
|
|
|
|
@test "checking changedetector: lock stale and cleaned up" {
|
|
docker rm -f mail_changedetector_two
|
|
docker exec mail_changedetector_one /bin/bash -c "touch /tmp/docker-mailserver/check-for-changes.sh.lock"
|
|
echo "" >> "$(private_config_path mail_changedetector_one)/postfix-accounts.cf"
|
|
sleep 15
|
|
|
|
run docker exec mail_changedetector_one /bin/bash -c "supervisorctl tail changedetector"
|
|
assert_output --partial "another execution of 'check-for-changes.sh' is happening"
|
|
sleep 65
|
|
|
|
run docker exec mail_changedetector_one /bin/bash -c "supervisorctl tail -3000 changedetector"
|
|
assert_output --partial "removing stale lock file"
|
|
}
|