Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

tests: run sedfile tests in container #2569

Merged
merged 6 commits into from
May 5, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 3 additions & 11 deletions target/bin/sedfile
Original file line number Diff line number Diff line change
Expand Up @@ -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'
Expand Down
71 changes: 44 additions & 27 deletions test/sedfile.bats
Original file line number Diff line number Diff line change
@@ -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 . )"

docker run -d --name "${CONTAINER}" \
-v "${PRIVATE_CONFIG}":/tmp/docker-mailserver \
-h mail.my-domain.com "${NAME}"

# 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}"
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'

@test "checking sedfile silent failure on substitute" {
# create marker to simulate a container restart
date > "${CONTAINER_START}"
# recreate marker
run docker exec "${CONTAINER}" touch '/CONTAINER_START'
assert_success
}

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}"
}