mirror of
https://github.com/docker-mailserver/docker-mailserver.git
synced 2024-01-19 02:48:50 +00:00
2cd534a1ab
These updates support running tests that have been relocated into `serial` and `parallel/set*` directories. - `make tests` now calls the two make targets beneath it. The only difference is that `serial` continues the "1 test at a time" approach used prior to this PR, while the `parallel` target increases the `--jobs` arg to run multiple tests concurrently (_configured by `PARALLEL_JOBS`_). - The `test/%` target leverages Bash syntax magic to ease running single tests without providing the exact path. - This syntax also supports providing multiple test names (eg: `make test/clamav,template`) to run. - `**` (globstar) allows for future improvements that can group multiple test files into sub-directories by their scope (eg: anti-spam, ssl, etc). --- chore: Add `shopt -s globstar` to other targets I realized that other targets should have this as well in case it is not set. It is better to be more explicit here than to have weird errors due to `**` not expanding properly. --- fix(Makefile): Add back `.PHONY` targets I encountered `make` telling me the target was already up-to-date, which of course is nonsense. I therefore added back the `.PHONY` targets to ensure tests are always run. --- docs: Added instructions for running a single test See https://github.com/docker-mailserver/docker-mailserver/pull/2857/files#r1008582760
74 lines
2.6 KiB
Makefile
74 lines
2.6 KiB
Makefile
SHELL := /bin/bash
|
|
.SHELLFLAGS += -e -u -o pipefail
|
|
|
|
PARALLEL_JOBS ?= 2
|
|
export REPOSITORY_ROOT := $(CURDIR)
|
|
export IMAGE_NAME ?= mailserver-testing:ci
|
|
export NAME ?= $(IMAGE_NAME)
|
|
|
|
.PHONY: ALWAYS_RUN
|
|
|
|
# -----------------------------------------------
|
|
# --- Generic Targets ---------------------------
|
|
# -----------------------------------------------
|
|
|
|
all: lint build backup generate-accounts tests clean
|
|
|
|
build:
|
|
@ DOCKER_BUILDKIT=1 docker build \
|
|
--tag $(IMAGE_NAME) \
|
|
--build-arg VCS_VERSION=$(shell git rev-parse --short HEAD) \
|
|
--build-arg VCS_REVISION=$(shell cat VERSION) \
|
|
.
|
|
|
|
generate-accounts: ALWAYS_RUN
|
|
@ cp test/config/templates/postfix-accounts.cf test/config/postfix-accounts.cf
|
|
@ cp test/config/templates/dovecot-masters.cf test/config/dovecot-masters.cf
|
|
|
|
backup:
|
|
# if backup directory exist, clean hasn't been called, therefore
|
|
# we shouldn't overwrite it. It still contains the original content.
|
|
-@ [[ ! -d testconfig.bak ]] && cp -rp test/config testconfig.bak || :
|
|
|
|
clean:
|
|
# remove test containers and restore test/config directory
|
|
-@ [[ -d testconfig.bak ]] && { sudo rm -rf test/config ; mv testconfig.bak test/config ; } || :
|
|
-@ for CONTAINER in $$(docker ps -a --filter name='^dms-test-.*|^mail_.*|^hadolint$$|^eclint$$|^shellcheck$$' | sed 1d | cut -f 1-1 -d ' '); do docker rm -f $${CONTAINER}; done
|
|
-@ while read -r LINE; do [[ $${LINE} =~ test/.+ ]] && sudo rm -rf $${LINE}; done < .gitignore
|
|
|
|
# -----------------------------------------------
|
|
# --- Tests ------------------------------------
|
|
# -----------------------------------------------
|
|
|
|
tests: ALWAYS_RUN
|
|
# See https://github.com/docker-mailserver/docker-mailserver/pull/2857#issuecomment-1312724303
|
|
# on why `generate-accounts` is run before each set (TODO/FIXME)
|
|
@ $(MAKE) generate-accounts tests/serial
|
|
@ $(MAKE) generate-accounts tests/parallel/set1
|
|
@ $(MAKE) generate-accounts tests/parallel/set2
|
|
@ $(MAKE) generate-accounts tests/parallel/set3
|
|
|
|
tests/serial: ALWAYS_RUN
|
|
@ shopt -s globstar ; ./test/bats/bin/bats --timing --jobs 1 test/$@/**.bats
|
|
|
|
tests/parallel/set%: ALWAYS_RUN
|
|
@ shopt -s globstar ; ./test/bats/bin/bats --timing --jobs $(PARALLEL_JOBS) test/$@/**.bats
|
|
|
|
test/%: ALWAYS_RUN
|
|
@ shopt -s globstar nullglob ; ./test/bats/bin/bats --timing test/tests/**/{$*,}.bats
|
|
|
|
# -----------------------------------------------
|
|
# --- Lints -------------------------------------
|
|
# -----------------------------------------------
|
|
|
|
lint: eclint hadolint shellcheck
|
|
|
|
hadolint:
|
|
@ ./test/linting/lint.sh hadolint
|
|
|
|
shellcheck:
|
|
@ ./test/linting/lint.sh shellcheck
|
|
|
|
eclint:
|
|
@ ./test/linting/lint.sh eclint
|