tests(chore): Use REPOSITORY_ROOT export var from Makefile

Allows for using `load` with an absolute path instead of a relative one, which makes it possible to group tests into different directories. Parallel tests differ slightly, loading the newer `helper/common.bash` and `helper/setup.bash` files instead of the older `test_helper/common.bash` which serial tests continue to use.
2024-01-19 02:48:50 +00:00 · 2022-11-26 11:37:58 +13:00 · 2022-11-26 11:37:58 +13:00 · 835056d707
parent 2cd534a1ab
commit 835056d707
43 changed files with 50 additions and 49 deletions
--- a/test/test_helper/common.bash
+++ b/test/test_helper/common.bash
@ -1,7 +1,7 @@
 #!/bin/bash

-load 'test_helper/bats-support/load'
-load 'test_helper/bats-assert/load'
+load "${REPOSITORY_ROOT}/test/test_helper/bats-support/load"
+load "${REPOSITORY_ROOT}/test/test_helper/bats-assert/load"

 NAME=${NAME:-mailserver-testing:ci}

--- a/test/test_helper/tls.bash
+++ b/test/test_helper/tls.bash
@ -1,6 +1,6 @@
 #!/bin/bash

-load 'test_helper/common'
+load "${REPOSITORY_ROOT}/test/test_helper/common"

 # Helper methods for testing TLS.
 # `_should_*` methods are useful for common high-level functionality.
--- a/test/tests/parallel/set1/clamav.bats
+++ b/test/tests/parallel/set1/clamav.bats
@ -1,4 +1,5 @@
-load 'test_helper/common'
+load "${REPOSITORY_ROOT}/test/helper/setup"
+load "${REPOSITORY_ROOT}/test/helper/common"

 TEST_NAME_PREFIX='ClamAV:'
 CONTAINER_NAME='dms-test-clamav'
--- a/test/tests/parallel/set1/default_relay_host.bats
+++ b/test/tests/parallel/set1/default_relay_host.bats
@ -1,4 +1,5 @@
-load 'test_helper/common'
+load "${REPOSITORY_ROOT}/test/helper/setup"
+load "${REPOSITORY_ROOT}/test/helper/common"

 function setup() {
  local PRIVATE_CONFIG
--- a/test/tests/parallel/set2/spam_bounced.bats
+++ b/test/tests/parallel/set2/spam_bounced.bats
@ -1,6 +1,5 @@
-load 'test_helper/common'
-# Globals referenced from `test_helper/common`:
-# TEST_NAME
+load "${REPOSITORY_ROOT}/test/helper/setup"
+load "${REPOSITORY_ROOT}/test/helper/common"

 # Can run tests in parallel?: No
 # Shared static container name: TEST_NAME
--- a/test/tests/parallel/set3/dovecot_inet_protocol.bats
+++ b/test/tests/parallel/set3/dovecot_inet_protocol.bats
@ -1,4 +1,5 @@
-load 'test_helper/common'
+load "${REPOSITORY_ROOT}/test/helper/setup"
+load "${REPOSITORY_ROOT}/test/helper/common"

 function setup_file() {
  local PRIVATE_CONFIG
--- a/test/tests/parallel/set3/helper-functions.bats
+++ b/test/tests/parallel/set3/helper-functions.bats
@ -1,4 +1,5 @@
-load 'test_helper/common'
+load "${REPOSITORY_ROOT}/test/helper/setup"
+load "${REPOSITORY_ROOT}/test/helper/common"

 function setup_file() {
  local PRIVATE_CONFIG
--- a/test/tests/serial/mail_changedetector.bats
+++ b/test/tests/serial/mail_changedetector.bats
@ -1,4 +1,4 @@
-load 'test_helper/common'
+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.
--- a/test/tests/serial/mail_disabled_clamav_spamassassin.bats
+++ b/test/tests/serial/mail_disabled_clamav_spamassassin.bats
@ -1,4 +1,4 @@
-load 'test_helper/common'
+load "${REPOSITORY_ROOT}/test/test_helper/common"

 setup_file() {
  local PRIVATE_CONFIG
--- a/test/tests/serial/mail_dnsbl.bats
+++ b/test/tests/serial/mail_dnsbl.bats
@ -1,4 +1,4 @@
-load 'test_helper/common'
+load "${REPOSITORY_ROOT}/test/test_helper/common"

 CONTAINER="mail_dnsbl_enabled"
 CONTAINER2="mail_dnsbl_disabled"
--- a/test/tests/serial/mail_fail2ban.bats
+++ b/test/tests/serial/mail_fail2ban.bats
@ -1,4 +1,4 @@
-load 'test_helper/common'
+load "${REPOSITORY_ROOT}/test/test_helper/common"

 function setup_file() {
  local PRIVATE_CONFIG
--- a/test/tests/serial/mail_fetchmail.bats
+++ b/test/tests/serial/mail_fetchmail.bats
@ -1,4 +1,4 @@
-load 'test_helper/common'
+load "${REPOSITORY_ROOT}/test/test_helper/common"

 function setup_file() {
  local PRIVATE_CONFIG
--- a/test/tests/serial/mail_fetchmail_parallel.bats
+++ b/test/tests/serial/mail_fetchmail_parallel.bats
@ -1,4 +1,4 @@
-load 'test_helper/common'
+load "${REPOSITORY_ROOT}/test/test_helper/common"

 function setup_file() {
  local PRIVATE_CONFIG
--- a/test/tests/serial/mail_hostname.bats
+++ b/test/tests/serial/mail_hostname.bats
@ -1,4 +1,4 @@
-load 'test_helper/common'
+load "${REPOSITORY_ROOT}/test/test_helper/common"


 function setup_file() {
--- a/test/tests/serial/mail_lmtp_ip.bats
+++ b/test/tests/serial/mail_lmtp_ip.bats
@ -1,4 +1,4 @@
-load 'test_helper/common'
+load "${REPOSITORY_ROOT}/test/test_helper/common"

 setup_file() {
  local PRIVATE_CONFIG PRIVATE_ETC
--- a/test/tests/serial/mail_pop3.bats
+++ b/test/tests/serial/mail_pop3.bats
@ -1,4 +1,4 @@
-load 'test_helper/common'
+load "${REPOSITORY_ROOT}/test/test_helper/common"

 function setup_file() {
  local PRIVATE_CONFIG
--- a/test/tests/serial/mail_postfix_inet.bats
+++ b/test/tests/serial/mail_postfix_inet.bats
@ -1,4 +1,4 @@
-load 'test_helper/common'
+load "${REPOSITORY_ROOT}/test/test_helper/common"

 # Test case
 # ---------
--- a/test/tests/serial/mail_postscreen.bats
+++ b/test/tests/serial/mail_postscreen.bats
@ -1,4 +1,4 @@
-load 'test_helper/common'
+load "${REPOSITORY_ROOT}/test/test_helper/common"

 setup() {
  # Getting mail container IP
--- a/test/tests/serial/mail_privacy.bats
+++ b/test/tests/serial/mail_privacy.bats
@ -1,4 +1,4 @@
-load 'test_helper/common'
+load "${REPOSITORY_ROOT}/test/test_helper/common"

 function setup_file() {
  local PRIVATE_CONFIG
--- a/test/tests/serial/mail_quotas_disabled.bats
+++ b/test/tests/serial/mail_quotas_disabled.bats
@ -1,4 +1,4 @@
-load 'test_helper/common'
+load "${REPOSITORY_ROOT}/test/test_helper/common"

 # Test case
 # ---------
--- a/test/tests/serial/mail_smtponly.bats
+++ b/test/tests/serial/mail_smtponly.bats
@ -1,4 +1,4 @@
-load 'test_helper/common'
+load "${REPOSITORY_ROOT}/test/test_helper/common"

 function setup_file() {
  docker run --rm -d --name mail_smtponly \
--- a/test/tests/serial/mail_spam_junk_folder.bats
+++ b/test/tests/serial/mail_spam_junk_folder.bats
@ -1,4 +1,4 @@
-load 'test_helper/common'
+load "${REPOSITORY_ROOT}/test/test_helper/common"

 # Test case
 # ---------
--- a/test/tests/serial/mail_special_use_folders.bats
+++ b/test/tests/serial/mail_special_use_folders.bats
@ -1,4 +1,4 @@
-load 'test_helper/common'
+load "${REPOSITORY_ROOT}/test/test_helper/common"

 setup_file() {
  local PRIVATE_CONFIG
--- a/test/tests/serial/mail_ssl_letsencrypt.bats
+++ b/test/tests/serial/mail_ssl_letsencrypt.bats
@ -1,5 +1,5 @@
-load 'test_helper/common'
-load 'test_helper/tls'
+load "${REPOSITORY_ROOT}/test/test_helper/common"
+load "${REPOSITORY_ROOT}/test/test_helper/tls"

 # Globals referenced from `test_helper/common`:
 # TEST_NAME TEST_FQDN TEST_TMP_CONFIG
--- a/test/tests/serial/mail_ssl_manual.bats
+++ b/test/tests/serial/mail_ssl_manual.bats
@ -1,5 +1,5 @@
 #!/usr/bin/env bats
-load 'test_helper/common'
+load "${REPOSITORY_ROOT}/test/test_helper/common"

 function setup_file() {
  # Internal copies made by `start-mailserver.sh`:
--- a/test/tests/serial/mail_time.bats
+++ b/test/tests/serial/mail_time.bats
@ -1,4 +1,4 @@
-load 'test_helper/common'
+load "${REPOSITORY_ROOT}/test/test_helper/common"

 setup_file() {
  local PRIVATE_CONFIG
--- a/test/tests/serial/mail_tls_dhparams.bats
+++ b/test/tests/serial/mail_tls_dhparams.bats
@ -1,4 +1,4 @@
-load 'test_helper/common'
+load "${REPOSITORY_ROOT}/test/test_helper/common"

 # Test case
 # ---------
--- a/test/tests/serial/mail_undef_spam_subject.bats
+++ b/test/tests/serial/mail_undef_spam_subject.bats
@ -1,4 +1,4 @@
-load 'test_helper/common'
+load "${REPOSITORY_ROOT}/test/test_helper/common"

 function setup() {
  local PRIVATE_CONFIG
--- a/test/tests/serial/mail_with_imap.bats
+++ b/test/tests/serial/mail_with_imap.bats
@ -1,4 +1,4 @@
-load 'test_helper/common'
+load "${REPOSITORY_ROOT}/test/test_helper/common"

 setup_file() {
  local PRIVATE_CONFIG
--- a/test/tests/serial/mail_with_ldap.bats
+++ b/test/tests/serial/mail_with_ldap.bats
@ -1,4 +1,4 @@
-load 'test_helper/common'
+load "${REPOSITORY_ROOT}/test/test_helper/common"

 function setup_file() {
  pushd test/docker-openldap/ || return 1
--- a/test/tests/serial/mail_with_mdbox.bats
+++ b/test/tests/serial/mail_with_mdbox.bats
@ -1,4 +1,4 @@
-load 'test_helper/common'
+load "${REPOSITORY_ROOT}/test/test_helper/common"

 setup_file() {
  local PRIVATE_CONFIG
--- a/test/tests/serial/mail_with_postgrey.bats
+++ b/test/tests/serial/mail_with_postgrey.bats
@ -1,4 +1,4 @@
-load 'test_helper/common'
+load "${REPOSITORY_ROOT}/test/test_helper/common"

 function setup_file() {
  local PRIVATE_CONFIG
--- a/test/tests/serial/mail_with_postgrey_disabled_by_default.bats
+++ b/test/tests/serial/mail_with_postgrey_disabled_by_default.bats
@ -1,4 +1,4 @@
-load 'test_helper/common'
+load "${REPOSITORY_ROOT}/test/test_helper/common"

 function setup() {
  local PRIVATE_CONFIG
--- a/test/tests/serial/mail_with_relays.bats
+++ b/test/tests/serial/mail_with_relays.bats
@ -1,4 +1,4 @@
-load 'test_helper/common'
+load "${REPOSITORY_ROOT}/test/test_helper/common"

 function setup_file() {
  # We use a temporary config directory since we'll be dynamically editing
--- a/test/tests/serial/mail_with_sdbox.bats
+++ b/test/tests/serial/mail_with_sdbox.bats
@ -1,4 +1,4 @@
-load 'test_helper/common'
+load "${REPOSITORY_ROOT}/test/test_helper/common"

 setup_file() {
  local PRIVATE_CONFIG
--- a/test/tests/serial/no_container.bats
+++ b/test/tests/serial/no_container.bats
@ -1,4 +1,4 @@
-load 'test_helper/common'
+load "${REPOSITORY_ROOT}/test/test_helper/common"

 function setup_file() {
  # Fail early if the test image is already running:
--- a/test/tests/serial/open_dkim.bats
+++ b/test/tests/serial/open_dkim.bats
@ -1,4 +1,4 @@
-load 'test_helper/common'
+load "${REPOSITORY_ROOT}/test/test_helper/common"

 export IMAGE_NAME CONTAINER_NAME TEST_FILE

--- a/test/tests/serial/permit_docker.bats
+++ b/test/tests/serial/permit_docker.bats
@ -1,4 +1,4 @@
-load 'test_helper/common'
+load "${REPOSITORY_ROOT}/test/test_helper/common"

 NON_DEFAULT_DOCKER_MAIL_NETWORK_NAME=non-default-docker-mail-network
 setup_file() {
--- a/test/tests/serial/security_tls_cipherlists.bats
+++ b/test/tests/serial/security_tls_cipherlists.bats
@ -1,5 +1,5 @@
 #!/usr/bin/env bats
-load 'test_helper/common'
+load "${REPOSITORY_ROOT}/test/test_helper/common"
 # Globals ${BATS_TMPDIR} and ${NAME}
 # `${NAME}` defaults to `mailserver-testing:ci`

--- a/test/tests/serial/sedfile.bats
+++ b/test/tests/serial/sedfile.bats
@ -1,4 +1,4 @@
-load 'test_helper/common'
+load "${REPOSITORY_ROOT}/test/test_helper/common"

 CONTAINER='sedfile'
 TEST_FILE='/tmp/sedfile-test.txt'
--- a/test/tests/serial/setup-cli.bats
+++ b/test/tests/serial/setup-cli.bats
@ -1,4 +1,4 @@
-load 'test_helper/common'
+load "${REPOSITORY_ROOT}/test/test_helper/common"

 # Globals referenced from `test_helper/common`:
 # TEST_NAME (should match the filename, minus the bats extension)
--- a/test/tests/serial/test_helper.bats
+++ b/test/tests/serial/test_helper.bats
@ -1,6 +1,4 @@
-load 'test_helper/bats-support/load'
-load 'test_helper/bats-assert/load'
-load 'test_helper/common'
+load "${REPOSITORY_ROOT}/test/test_helper/common"

@test "repeat_until_success_or_timeout returns instantly on success" {
  SECONDS=0
--- a/test/tests/serial/tests.bats
+++ b/test/tests/serial/tests.bats
@ -1,4 +1,4 @@
-load 'test_helper/common'
+load "${REPOSITORY_ROOT}/test/test_helper/common"

 setup_file() {
  local PRIVATE_CONFIG