From 18acd7860be1d3a561acf486c0acac66325f4d9b Mon Sep 17 00:00:00 2001
From: Casper <casperklein@users.noreply.github.com>
Date: Thu, 5 May 2022 12:58:00 +0200
Subject: [PATCH] Run sedfile tests in container (#2569)

---
 target/bin/sedfile | 14 ++-------
 test/sedfile.bats  | 71 ++++++++++++++++++++++++++++------------------
 2 files changed, 47 insertions(+), 38 deletions(-)

diff --git a/target/bin/sedfile b/target/bin/sedfile
index 6b550bff..78369a49 100755
--- a/target/bin/sedfile
+++ b/target/bin/sedfile
@@ -9,19 +9,11 @@
 # Is a file change expected? --> use 'sedfile --strict -i'
 # Is a file change only on the first container run expected? --> use 'sedfile -i'
 
-if [[ -e /usr/local/bin/helpers/log.sh ]]
-then
-  # shellcheck source=../scripts/helpers/log.sh
-  source /usr/local/bin/helpers/log.sh
-else
-  # when running BATS (unit tests), this file is not located
-  # inside a container; as a consequence, we need to source
-  # from a different location
-  source target/scripts/helpers/log.sh
-fi
-
 set -ueo pipefail
 
+# shellcheck source=../scripts/helpers/log.sh
+source /usr/local/bin/helpers/log.sh
+
 function __usage { echo "Usage: ${0} -i <replace/delete operation> <file>" ; }
 
 HASHTOOL='sha1sum'
diff --git a/test/sedfile.bats b/test/sedfile.bats
index 4cc3ee89..1880a17f 100644
--- a/test/sedfile.bats
+++ b/test/sedfile.bats
@@ -1,71 +1,88 @@
 load 'test_helper/common'
 
+CONTAINER='sedfile'
+TEST_FILE='/tmp/sedfile-test.txt'
+
 # prepare tests
 function setup_file() {
-  export CONTAINER_START FILE SEDFILE
-  FILE=$(mktemp /tmp/sedfile-test.XXX)
-  SEDFILE="/tmp/sedfile"
+  local PRIVATE_CONFIG
+  PRIVATE_CONFIG="$(duplicate_config_for_container . )"
 
-  # workaround, /CONTAINER_START cannot be used (permission denied)
-  CONTAINER_START="/tmp/CONTAINER_START"
-  cp -a "target/bin/sedfile" "${SEDFILE}"
-  sed -i "s|/CONTAINER_START|${CONTAINER_START}|" "${SEDFILE}"
+  docker run -d --name "${CONTAINER}" \
+  -v "${PRIVATE_CONFIG}":/tmp/docker-mailserver \
+  -h mail.my-domain.com "${NAME}"
 
+  wait_for_finished_setup_in_container "${CONTAINER}"
+}
+
+function setup() {
   # create test file
-  echo 'foo bar' > "${FILE}"
+  docker exec "${CONTAINER}" bash -c 'echo "foo bar" > "'"${TEST_FILE}"'"'
 }
 
 @test "checking sedfile parameter count" {
-  run ${SEDFILE}
+  run docker exec "${CONTAINER}" sedfile
   assert_failure
   assert_output --partial 'At least three parameters must be given'
 }
 
 @test "checking sedfile substitute success" {
   # change 'bar' to 'baz'
-  run ${SEDFILE} -i 's|bar|baz|' "${FILE}"
+  run docker exec "${CONTAINER}" sedfile -i 's|bar|baz|' "${TEST_FILE}"
   assert_success
-  assert_output ""
+  assert_output ''
 
   # file modified?
-  run test "$(< "${FILE}")" == 'foo baz'
+  run docker exec "${CONTAINER}" cat "${TEST_FILE}"
   assert_success
+  assert_output 'foo baz'
 }
 
-@test "checking sedfile substitute failure" {
-  run ${SEDFILE} -i 's|bar|baz|' "${FILE}"
+@test "checking sedfile substitute failure (on first container start)" {
+  # delete marker
+  run docker exec "${CONTAINER}" rm '/CONTAINER_START'
+  assert_success
+
+  # try to change 'baz' to 'something' and fail
+  run docker exec "${CONTAINER}" sedfile -i 's|baz|something|' "${TEST_FILE}"
   assert_failure
-  assert_output --partial "No difference after call to 'sed' in 'sedfile' (sed -i s|bar|baz| /tmp/sedfile-test"
+  assert_output --partial "No difference after call to 'sed' in 'sedfile' (sed -i s|baz|something| /tmp/sedfile-test.txt)"
 
   # file unchanged?
-  run test "$(< "${FILE}")" == 'foo baz'
+  run docker exec "${CONTAINER}" cat "${TEST_FILE}"
+  assert_success
+  assert_output 'foo bar'
+
+  # recreate marker
+  run docker exec "${CONTAINER}" touch '/CONTAINER_START'
   assert_success
 }
 
-@test "checking sedfile silent failure on substitute" {
-  # create marker to simulate a container restart
-  date > "${CONTAINER_START}"
-
-  run ${SEDFILE} -i 's|bar|baz|' "${FILE}"
+@test "checking sedfile silent failure on substitute (when DMS was restarted)" {
+  # try to change 'baz' to 'something' and fail silently
+  run docker exec "${CONTAINER}" sedfile -i 's|baz|something|' "${TEST_FILE}"
   assert_success
-  assert_output ""
+  assert_output ''
 
   # file unchanged?
-  run test "$(< "${FILE}")" == 'foo baz'
+  run docker exec "${CONTAINER}" cat "${TEST_FILE}"
   assert_success
+  assert_output 'foo bar'
 }
 
 @test "checking sedfile substitude failure (strict)" {
-  run ${SEDFILE} --strict -i 's|bar|baz|' "${FILE}"
+  # try to change 'baz' to 'something' and fail
+  run docker exec "${CONTAINER}" sedfile --strict -i 's|baz|something|' "${TEST_FILE}"
   assert_failure
-  assert_output --partial "No difference after call to 'sed' in 'sedfile' (sed -i s|bar|baz| /tmp/sedfile-test"
+  assert_output --partial "No difference after call to 'sed' in 'sedfile' (sed -i s|baz|something| /tmp/sedfile-test.txt)"
 
   # file unchanged?
-  run test "$(< "${FILE}")" == 'foo baz'
+  run docker exec "${CONTAINER}" cat "${TEST_FILE}"
   assert_success
+  assert_output 'foo bar'
 }
 
 # clean up
 function teardown_file() {
-  rm -f "${CONTAINER_START}" "${FILE}" "${SEDFILE}"
+  docker rm -f "${CONTAINER}"
 }