Lock file create and remove improvements (#2183)

* changed the locking function to better support multiple servers running at once and sharing the same config

* helper function testing now runs inside of container

Co-authored-by: Brennan Kinney <5098581+polarathene@users.noreply.github.com>

test/helper-functions.bats

@@ -0,0 +1,43 @@
+load 'test_helper/common'
+
+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 .)"
+    docker run -d --name mail_helper_functions \
+        --cap-add=NET_ADMIN \
+        -v "${PRIVATE_CONFIG}":/tmp/docker-mailserver \
+        -v "$(pwd)/test/test-files":/tmp/docker-mailserver-test:ro \
+        -e ENABLE_FETCHMAIL=1 \
+        -e DMS_DEBUG=0 \
+        -h mail.my-domain.com -t "${NAME}"
+    wait_for_finished_setup_in_container mail_helper_functions
+}
+
+function teardown_file() {
+    docker rm -f mail_helper_functions
+}
+
+@test "first" {
+    skip 'this test must come first to reliably identify when to run setup_file'
+}
+
+@test "check helper-functions.sh: _sanitize_ipv4_to_subnet_cidr" {
+    run docker exec mail_helper_functions bash -c ". /usr/local/bin/helper-functions.sh; _sanitize_ipv4_to_subnet_cidr 255.255.255.255/0"
+    assert_output "0.0.0.0/0"
+    run docker exec mail_helper_functions bash -c ". /usr/local/bin/helper-functions.sh; _sanitize_ipv4_to_subnet_cidr 192.168.255.14/20"
+    assert_output "192.168.240.0/20"
+    run docker exec mail_helper_functions bash -c ". /usr/local/bin/helper-functions.sh; _sanitize_ipv4_to_subnet_cidr 192.168.255.14/32"
+    assert_output "192.168.255.14/32"
+}
+
+@test "last" {
+    skip 'this test is only there to reliably mark the end for the teardown_file'
+}

test/helper_functions.bats

@@ -1,15 +0,0 @@
-load 'test_helper/bats-support/load'
-load 'test_helper/bats-assert/load'
-
-# load the helper function into current context
-# shellcheck source=../target/scripts/helper-functions.sh
-. ./target/scripts/helper-functions.sh
-
-@test "check helper function: _sanitize_ipv4_to_subnet_cidr" {
-    output=$(_sanitize_ipv4_to_subnet_cidr 255.255.255.255/0)
-    assert_output "0.0.0.0/0"
-    output=$(_sanitize_ipv4_to_subnet_cidr 192.168.255.14/20)
-    assert_output "192.168.240.0/20"
-    output=$(_sanitize_ipv4_to_subnet_cidr 192.168.255.14/32)
-    assert_output "192.168.255.14/32"
-}

test/mail_changedetector.bats

@@ -0,0 +1,94 @@
+load 'test_helper/common'
+
+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 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'
+}