test(ci): Add common.sh utils

tests/lib/common.sh

@@ -0,0 +1,82 @@
+#!/usr/bin/env bash
+
+#---  ENV VARIABLE  ---------------------------------------------------------------------------------------------------
+#          NAME:  IMAGE_NAME
+#   DESCRIPTION:  The name and tag of the Docker image. Default: 'cdalvaro/docker-salt-master:latest'.
+#----------------------------------------------------------------------------------------------------------------------
+export IMAGE_NAME=${IMAGE_NAME:-'cdalvaro/docker-salt-master:latest'}
+
+#---  ENV VARIABLE  ---------------------------------------------------------------------------------------------------
+#          NAME:  CONTAINER_NAME
+#   DESCRIPTION:  The name of the container. Default: 'salt-master'.
+#----------------------------------------------------------------------------------------------------------------------
+export CONTAINER_NAME=salt-master
+
+#---  ENV VARIABLE  ---------------------------------------------------------------------------------------------------
+#          NAME:  PLATFORM
+#   DESCRIPTION:  The platform to run the tests on. Default: the current platform.
+#----------------------------------------------------------------------------------------------------------------------
+export PLATFORM=${PLATFORM:-$(docker version --format='{{.Server.Os}}/{{.Server.Arch}}')}
+
+#---  ENV VARIABLE  ---------------------------------------------------------------------------------------------------
+#          NAME:  BOOTUP_WAIT_SECONDS
+#   DESCRIPTION:  The number of seconds to wait for the container to boot up. Default: 60.
+#----------------------------------------------------------------------------------------------------------------------
+export BOOTUP_WAIT_SECONDS=${BOOTUP_WAIT_SECONDS:-60}
+
+#---  FUNCTION  -------------------------------------------------------------------------------------------------------
+#          NAME:  cleanup
+#   DESCRIPTION:  Clean up tasks.
+#----------------------------------------------------------------------------------------------------------------------
+function cleanup()
+{
+  echo "==> Removing ${CONTAINER_NAME} ..."
+  docker container rm --force "${CONTAINER_NAME}"
+}
+
+#---  FUNCTION  -------------------------------------------------------------------------------------------------------
+#          NAME:  master_log
+#   DESCRIPTION:  Print salt-master log.
+#----------------------------------------------------------------------------------------------------------------------
+function master_log()
+{
+  docker exec "${CONTAINER_NAME}" cat data/logs/salt/master
+}
+
+#---  FUNCTION  -------------------------------------------------------------------------------------------------------
+#          NAME:  wait_container
+#   DESCRIPTION:  Wait for the container to boot up.
+#----------------------------------------------------------------------------------------------------------------------
+function start_container_and_wait()
+{
+  # shellcheck disable=SC2206
+  local DOCKER_ARGS=( $@ )
+
+  docker run --rm --detach --name "${CONTAINER_NAME}" \
+  --publish 4505:4505 --publish 4506:4506 \
+  --platform "${PLATFORM}" ${DOCKER_ARGS[@]} \
+  "${IMAGE_NAME}" || return 1
+
+  echo "==> Waiting ${BOOTUP_WAIT_SECONDS} seconds for the container to be ready ..."
+  sleep "${BOOTUP_WAIT_SECONDS}"
+}
+
+#---  FUNCTION  -------------------------------------------------------------------------------------------------------
+#          NAME:  ok
+#   DESCRIPTION:  Print a successfull message.
+#----------------------------------------------------------------------------------------------------------------------
+function ok()
+{
+  echo "✅ $*"
+}
+
+#---  FUNCTION  -------------------------------------------------------------------------------------------------------
+#          NAME:  error
+#   DESCRIPTION:  Print an error message, show the salt-master log and exit with code 1.
+#----------------------------------------------------------------------------------------------------------------------
+function error()
+{
+  echo "🔥 $*"
+  master_log
+  return 1
+}