Feat/easier maintenance (#115)

- [Feature] : Dockerfile Templatization
- [Feature] : Add support for build and test image with Docker and Podman
- [Fix] : Curl updated to > 8.x for Alpine >= 3.17
- [Fix] : Workflow setup-bats action for Node version deprecation

Author: zebby76

.github/workflows/docker-build.yml

@@ -54,6 +54,10 @@ jobs:
           restore-keys: |
             ${{ runner.os }}-buildx-
 
+      - name: Create Dockerfile
+        run: |
+          make Dockerfile
+
       - name: Build "${{ steps.prep.outputs.docker-image-name }}" Docker Image
         id: build
         uses: docker/build-push-action@v4

.github/workflows/docker-release.yml

@@ -84,6 +84,10 @@ jobs:
             type=raw,value=${{ needs.init.outputs.version-minor }}-${{ matrix.image-variant }}
             type=raw,value=${{ needs.init.outputs.version-major }}-${{ matrix.image-variant }}
 
+      - name: Create Dockerfile
+        run: |
+          make Dockerfile
+
       - name: Build "${{ needs.init.outputs.docker-image-name }}:${{ needs.init.outputs.github-ci-sha-short }}-${{ matrix.image-variant }}" Docker Image
         id: build
         uses: docker/build-push-action@v4
@@ -133,7 +137,7 @@ jobs:
           chmod 777 test/demo/skeleton
 
       - name: Setup BATS testing framework
-        uses: mig4/setup-bats@v1
+        uses: zebby76/setup-bats@v1
         with:
           bats-version: 1.2.1
 
@@ -178,6 +182,7 @@ jobs:
         env:
           DOCKER_IMAGE_NAME: ${{ needs.init.outputs.docker-image-name }}:${{ needs.init.outputs.github-ci-sha-short }}-${{ matrix.image-variant }}
           EMS_VERSION: ${{ needs.init.outputs.version-patch }}
+          CONTAINER_ENGINE: docker
         run: |
           docker network create docker_default
           docker pull appropriate/curl:latest
@@ -387,4 +392,4 @@ jobs:
       - uses: joutvhu/delete-artifact@v1
         with:
           name: |
-            ${{ matrix.image-variant }}
+            ${{ matrix.image-variant }}

.gitignore

@@ -1,2 +1,2 @@
-local.txt
-test/demo
+test/demo
+Dockerfile

Dockerfile

@@ -0,0 +1,4 @@
+ARG VERSION_ARG=""
+ARG RELEASE_ARG=""
+ARG BUILD_DATE_ARG=""
+ARG VCS_REF_ARG=""

Dockerfiles/Args.m4

@@ -0,0 +1,9 @@
+ENV ELASTICMS_VERSION=${VERSION_ARG:-5.1.2} \
+    ELASTICMS_DOWNLOAD_URL="https://github.com/ems-project/elasticms-web/archive"
+
+RUN echo "Download and install ElastiCMS ..." \
+    && mkdir -p /opt/src \
+    && curl -sSfLk ${ELASTICMS_DOWNLOAD_URL}/${ELASTICMS_VERSION}.tar.gz \
+       | tar -xzC /opt/src --strip-components=1 \
+    && COMPOSER_MEMORY_LIMIT=-1 composer -vvvv install --no-interaction --no-suggest --no-scripts --working-dir /opt/src -o  \
+    && rm -rf /opt/src/bootstrap/cache/* /opt/src/.env /opt/src/.env.dist

Dockerfiles/Builder.m4

@@ -0,0 +1,33 @@
+LABEL be.fgov.elasticms.web.build-date=$BUILD_DATE_ARG \
+      be.fgov.elasticms.web.name="elasticms-web" \
+      be.fgov.elasticms.web.description="Website Skeleton of the ElasticMS suite." \
+      be.fgov.elasticms.web.url="https://hub.docker.com/repository/docker/elasticms/website-skeleton" \
+      be.fgov.elasticms.web.vcs-ref=$VCS_REF_ARG \
+      be.fgov.elasticms.web.vcs-url="https://github.com/ems-project/elasticms-web-docker" \
+      be.fgov.elasticms.web.vendor="[email protected]" \
+      be.fgov.elasticms.web.version="$VERSION_ARG" \
+      be.fgov.elasticms.web.release="$RELEASE_ARG" \
+      be.fgov.elasticms.web.schema-version="1.0"
+
+USER root
+
+COPY bin/ /opt/bin/container-entrypoint.d/
+COPY etc/ /usr/local/etc/
+COPY --from=builder /opt/src /opt/src
+
+ENV APP_DISABLE_DOTENV=true
+ENV EMS_METRIC_PORT="9090"
+
+RUN echo -e "\nListen ${EMS_METRIC_PORT}\n" >> /etc/apache2/httpd.conf \
+    && echo "Setup permissions on filesystem for non-privileged user ..." \
+    && chmod -Rf +x /opt/bin \
+    && chown -Rf ${PUID:-1001}:0 /opt \
+    && chmod -R ug+rw /opt \
+    && find /opt -type d -exec chmod ug+x {} \;
+
+USER ${PUID:-1001}
+
+EXPOSE ${EMS_METRIC_PORT}/tcp
+
+HEALTHCHECK --start-period=10s --interval=1m --timeout=5s --retries=5 \
+        CMD curl --fail --header "Host: default.localhost" http://localhost:9000/index.php || exit 1

Dockerfiles/Common.m4

@@ -0,0 +1,19 @@
+# syntax=docker/dockerfile:1.3
+FROM docker.io/elasticms/base-php:8.1-apache-dev as builder
+
+# include(Args.m4)
+# include(Builder.m4)
+
+FROM docker.io/elasticms/base-php:8.1-apache as prd
+
+LABEL be.fgov.elasticms.web.environment="prd"
+
+# include(Args.m4)
+# include(Common.m4)
+
+FROM docker.io/elasticms/base-php:8.1-apache-dev as dev
+
+LABEL be.fgov.elasticms.web.environment="dev"
+
+# include(Args.m4)
+# include(Common.m4)

Dockerfiles/Dockerfile.in

@@ -5,6 +5,9 @@ ifneq (,$(wildcard ./.build.env))
     export
 endif
 
+LIB = ./Dockerfiles
+DOCKERFILE=Dockerfile.in
+
 GIT_HASH ?= $(shell git log --format="%h" -n 1)
 BUILD_DATE ?= $(shell date -u +'%Y-%m-%dT%H:%M:%SZ')
 
@@ -14,11 +17,14 @@ ELASTICMS_WEB_VERSION ?= 5.0.0
 # Default Docker image name (if no .build.env file provided)
 DOCKER_IMAGE_NAME ?= docker.io/elasticms/website-skeleton
 
+CONTAINER_ENGINE ?= docker
+CONTAINER_TARGET_IMAGE_FORMAT ?= docker
+
 _BUILD_ARGS_TARGET ?= prd
 _BUILD_ARGS_TAG ?= latest
 
 .DEFAULT_GOAL := help
-.PHONY: help build build-dev build-all test test-dev test-all
+.PHONY: help build build-dev build-all test test-dev test-all Dockerfile
 
 help: # Show help for each of the Makefile recipes.
 	@grep -E '^[a-zA-Z0-9 -]+:.*#'  Makefile | sort | while read -r l; do printf "\033[1;32m$$(echo $$l | cut -f 1 -d':')\033[00m:$$(echo $$l | cut -f 2- -d'#')\n"; done
@@ -38,14 +44,27 @@ _build-%:
 		-e _BUILD_ARGS_TAG="${ELASTICMS_WEB_VERSION}-$*" \
 		-e _BUILD_ARGS_TARGET="$*"
 
-_builder:
-	@docker build \
-		--build-arg VERSION_ARG="${ELASTICMS_WEB_VERSION}" \
-		--build-arg RELEASE_ARG="${_BUILD_ARGS_TAG}" \
-		--build-arg BUILD_DATE_ARG="${BUILD_DATE}" \
-		--build-arg VCS_REF_ARG="${GIT_HASH}" \
-		--target ${_BUILD_ARGS_TARGET} \
-		--tag ${DOCKER_IMAGE_NAME}:${_BUILD_ARGS_TAG} .
+_builder: _dockerfile
+    ifeq ($(CONTAINER_ENGINE),podman)
+		@echo "Building $(CONTAINER_TARGET_IMAGE_FORMAT) image format with buildah"
+		@buildah bud --no-cache --pull-always --force-rm --squash \
+			--build-arg VERSION_ARG="${ELASTICMS_WEB_VERSION}" \
+			--build-arg RELEASE_ARG="${_BUILD_ARGS_TAG}" \
+			--build-arg BUILD_DATE_ARG="${BUILD_DATE}" \
+			--build-arg VCS_REF_ARG="${GIT_HASH}" \
+			--format ${CONTAINER_TARGET_IMAGE_FORMAT} \
+			--target ${_BUILD_ARGS_TARGET} \
+			--tag ${DOCKER_IMAGE_NAME}:${_BUILD_ARGS_TAG} .
+    else
+		@echo "Building $(CONTAINER_TARGET_IMAGE_FORMAT) image format with docker"
+		@docker build --no-cache --force-rm --progress=plain \
+			--build-arg VERSION_ARG="${ELASTICMS_WEB_VERSION}" \
+			--build-arg RELEASE_ARG="${_BUILD_ARGS_TAG}" \
+			--build-arg BUILD_DATE_ARG="${BUILD_DATE}" \
+			--build-arg VCS_REF_ARG="${GIT_HASH}" \
+			--target ${_BUILD_ARGS_TARGET} \
+			--tag ${DOCKER_IMAGE_NAME}:${_BUILD_ARGS_TAG} .
+    endif
 
 test: # Test [elasticms-website-skeleton] [prd] variant Docker images
 	@$(MAKE) -s _tester-prd
@@ -58,9 +77,17 @@ test-all: # Test [elasticms-website-skeleton] [prd,dev] variant Docker images
 	@$(MAKE) -s _tester-dev
 
 _tester-%: 
+	@echo "Test image with $(CONTAINER_ENGINE) container engine"
 	@$(MAKE) -s _tester \
 		-e DOCKER_IMAGE_NAME="${DOCKER_IMAGE_NAME}:${ELASTICMS_WEB_VERSION}-$*" \
-		-e EMS_VERSION="${ELASTICMS_WEB_VERSION}"
+		-e EMS_VERSION="${ELASTICMS_WEB_VERSION}" \
+		-e CONTAINER_ENGINE="${CONTAINER_ENGINE}"
 
 _tester:
-	@bats test/tests.bats
+	@bats test/tests.bats
+
+Dockerfile: # generate Dockerfile
+	@$(MAKE) -s _dockerfile
+
+_dockerfile: $(LIB)/*.m4
+	sed -e 's/# include(\(.*\))/include(\1)/g' $(LIB)/$(DOCKERFILE) | m4 -I $(LIB) > $(DOCKERFILE:.in=)