misc: final Rspamd adjustments for v13 (#3599)

* outsource Rspamd ENVs into explicit helper

This will allow us to uniformly source the helper and get the values
from everywhere consistently. This is more than desirable since we will
be using these values not only for the Rspamd setup, but also for DKIM
management and during change-detection.

* integrate Rspamd into changedetection

We outsource one more function to reside in the helper script for Rspamd
so that we can call this function from the Rspamd setup and from the
changedetection functionality too.

* realize deprecation of old commands file for Rspamd

THIS IS A BREAKING CHANGE!

This change realizes the log message: "Using old file location now
(deprecated) - this will prevent startup in v13.0.0" Startup will now
fail.

* added '--force' option to Rspamd DKIM script

* use new helper to get ENVs for Rspamd in DKIM script

* remove the need for linking directories

This was unnecessary, as explained in
https://github.com/docker-mailserver/docker-mailserver/pull/3597#discussion_r1369413599

* Apply suggestions from code review

review by @polarathene

* apply more review feedback from @polarathene

- <https://github.com/docker-mailserver/docker-mailserver/pull/3599#discussion_r1370885519>
- <https://github.com/docker-mailserver/docker-mailserver/pull/3599#discussion_r1370904201>

* update documentation

---------

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

test/tests/parallel/set1/spam_virus/rspamd_dkim.bats

@@ -68,8 +68,14 @@ function teardown_file() { _default_teardown ; }
   local INITIAL_SHA512_SUM=$(_exec_in_container sha512sum "${SIGNING_CONF_FILE}")
 
   __create_key
+  assert_failure
+  assert_output --partial "Not overwriting existing files (use '--force' to overwrite existing files)"
+
+  # the same as before, but with the '--force' option
+  __create_key 'rsa' 'mail' "${DOMAIN_NAME}" '2048' '--force'
   __log_is_free_of_warnings_and_errors
   refute_output --partial "Supplying a default configuration ('${SIGNING_CONF_FILE}')"
+  assert_output --partial "Overwriting existing files as the '--force' option was supplied"
   assert_output --partial "'${SIGNING_CONF_FILE}' exists, not supplying a default"
   assert_output --partial "Finished DKIM key creation"
   local SECOND_SHA512_SUM=$(_exec_in_container sha512sum "${SIGNING_CONF_FILE}")
@@ -188,11 +194,15 @@ function __create_key() {
   local SELECTOR=${2:-mail}
   local DOMAIN=${3:-${DOMAIN_NAME}}
   local KEYSIZE=${4:-2048}
+  local FORCE=${5:-}
 
-  _run_in_container setup config dkim \
-    keytype "${KEYTYPE}"              \
-    keysize "${KEYSIZE}"              \
-    selector "${SELECTOR}"            \
+  # Not quoting is intended here as we would othewise provide
+  # the argument "''" (empty string), which would cause errors
+  # shellcheck disable=SC2086
+  _run_in_container setup config dkim ${FORCE} \
+    keytype "${KEYTYPE}"   \
+    keysize "${KEYSIZE}"   \
+    selector "${SELECTOR}" \
     domain "${DOMAIN}"
 }
 

test/tests/parallel/set1/spam_virus/rspamd_full.bats

@@ -66,12 +66,9 @@ function teardown_file() { _default_teardown ; }
   assert_output 'rspamd_milter = inet:localhost:11332'
 }
 
-@test "'/etc/rspamd/override.d/' is linked correctly" {
+@test "contents of '/etc/rspamd/override.d/' are copied" {
   local OVERRIDE_D='/etc/rspamd/override.d'
 
-  _run_in_container_bash "[[ -h ${OVERRIDE_D} ]]"
-  assert_success
-
   _run_in_container_bash "[[ -f ${OVERRIDE_D}/testmodule_complicated.conf ]]"
   assert_success
 }