mirror of
https://github.com/docker-mailserver/docker-mailserver.git
synced 2024-01-19 02:48:50 +00:00
5254f7c658
Removes duplicate logic from `check-for-changes.sh` that is used/maintained elsewhere to avoid risk of problems, as this code is already starting to diverge / rot. --- Previously the change detection support has had code added for rebuilding config upon change detection which is the same as code run during startup scripts. Unfortunately over time this has fallen out of sync. Mostly the startup scripts would get maintenance and the contributor and reviewers may not have been aware of the duplicate code handled by `check-for-changes.sh`. That code was starting to diverge in addition to some changes in structure (_eg: relay host logic seems interleaved here vs separated out in startup scripts_). I wanted to address this before it risks becoming a much bigger headache. Rather than bloat `helper-functions.sh` further, I've added a `helpers/` folder extracting relevant common logic between startup scripts and `changedetector`. If you want to follow that process I've kept scoped commits to make those diffs easier. Some minor changes/improvements were added but nothing significant. --- - chore: Extract relay host logic to new `relay.sh` helper - chore: Extract `/etc/postfix/sasl_passwd` logic to new `sasl.sh` helper - chore: Extract `postfix-accounts.cf` logic to new `accounts.sh` helper - chore: Extract `/etc/aliases` logic to new `aliases.sh` helper - chore: Extract `/etc/postfix/vhost` logic to new `postfix.sh` helper - chore: Add inline docs for Postfix configs > These are possibly more verbose than needed and can be reduced at a later stage. > They are helpful during this refactor process while investigating that everything is handled correctly. `accounts.sh`: - Add note regarding potential bug for bare domain setups with `/etc/postfix/vhost` and `mydestination` sharing same domain value. `relay.sh`: - Remove the tabs for a single space delimiter, revised associated comment. - Add PR reference for original `_populate_relayhost_map` implementation which has some useful details. Co-authored-by: Georg Lauterbach <44545919+georglauterbach@users.noreply.github.com> Co-authored-by: Casper <casperklein@users.noreply.github.com>
99 lines
4.1 KiB
Bash
99 lines
4.1 KiB
Bash
load '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() {
|
|
run_setup_file_if_necessary
|
|
}
|
|
|
|
function teardown() {
|
|
run_teardown_file_if_necessary
|
|
}
|
|
|
|
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 DMS_DEBUG=1 \
|
|
-h mail.my-domain.com -t "${NAME}"
|
|
wait_for_finished_setup_in_container mail_changedetector_one
|
|
|
|
docker run -d --name mail_changedetector_two \
|
|
-v "${PRIVATE_CONFIG}":/tmp/docker-mailserver \
|
|
-v "$(pwd)/test/test-files":/tmp/docker-mailserver-test:ro \
|
|
-e DMS_DEBUG=1 \
|
|
-h mail.my-domain.com -t "${NAME}"
|
|
wait_for_finished_setup_in_container mail_changedetector_two
|
|
}
|
|
|
|
function teardown_file() {
|
|
docker rm -f mail_changedetector_one
|
|
docker rm -f mail_changedetector_two
|
|
}
|
|
|
|
# this test must come first to reliably identify when to run setup_file
|
|
@test "first" {
|
|
skip 'Starting testing of changedetector'
|
|
}
|
|
|
|
@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 15
|
|
run docker exec mail_changedetector_one /bin/bash -c "supervisorctl tail changedetector"
|
|
assert_output --partial "postfix: stopped"
|
|
assert_output --partial "postfix: started"
|
|
assert_output --partial "Change detected"
|
|
assert_output --partial "Removed lock"
|
|
run docker exec mail_changedetector_two /bin/bash -c "supervisorctl tail changedetector"
|
|
assert_output --partial "postfix: stopped"
|
|
assert_output --partial "postfix: started"
|
|
assert_output --partial "Change detected"
|
|
assert_output --partial "Removed lock"
|
|
}
|
|
|
|
@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 "check-for-changes.sh.lock exists"
|
|
run docker exec mail_changedetector_two /bin/bash -c "supervisorctl tail changedetector"
|
|
assert_output --partial "check-for-changes.sh.lock exists"
|
|
# 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 "check-for-changes.sh.lock exists"
|
|
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 "check-for-changes.sh.lock exists"
|
|
sleep 65
|
|
run docker exec mail_changedetector_one /bin/bash -c "supervisorctl tail -3000 changedetector"
|
|
assert_output --partial "Removed stale lock"
|
|
}
|
|
|
|
# this test is only there to reliably mark the end for the teardown_file
|
|
@test "last" {
|
|
skip 'Finished testing of changedetector'
|
|
}
|