[CONFIG] [Docker] building process re-organized.

Author: Gonzalo Diaz

.github/workflows/docker-image.yml

@@ -17,9 +17,11 @@ jobs:
       - uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4
       - name: Build the Docker image
         run: make compose/rebuild
-      - name: Run static checks in Docker image
+      - name: Lint in Docker image
         run: make compose/lint
-      - name: Run test in Docker image
+      - name: Test in Docker image
+        run: make compose/test
+      - name: Run in Docker image
         run: make compose/run
       - name: Tag Docker image
         run: >

Dockerfile

@@ -4,6 +4,8 @@ FROM python:3.12.4-alpine3.20 AS base
 ENV WORKDIR=/app
 WORKDIR ${WORKDIR}
 
+RUN apk add --update --no-cache make
+
 ###############################################################################
 FROM base AS lint
 
@@ -35,34 +37,51 @@ COPY ./requirements.txt ${WORKDIR}/
 COPY ./setup.cfg ${WORKDIR}/
 COPY ./Makefile ${WORKDIR}/
 
+# code linting conf
+COPY ./.pylintrc ${WORKDIR}/
+COPY ./.coveragerc ${WORKDIR}/
+COPY ./setup.cfg ${WORKDIR}/
+
 # markdownlint conf
 COPY ./.markdownlint.yaml ${WORKDIR}/
 
 # yamllint conf
 COPY ./.yamllint ${WORKDIR}/
 COPY ./.yamlignore ${WORKDIR}/
 
-# pylint and covergae
-COPY ./.pylintrc ${WORKDIR}/
-COPY ./.coveragerc ${WORKDIR}/
-
 CMD ["make", "lint"]
 
 ###############################################################################
 FROM base AS development
 
-RUN apk add --update --no-cache make
+COPY ./Makefile ${WORKDIR}/
+COPY ./requirements.txt ${WORKDIR}/
+COPY ./setup.cfg ${WORKDIR}/
 
-###############################################################################
-FROM development AS builder
+RUN make dependencies
 
 COPY ./src ${WORKDIR}/src
-COPY ./requirements.txt ${WORKDIR}/
-COPY ./Makefile ${WORKDIR}/
-COPY ./setup.cfg ${WORKDIR}/
+
 RUN ls -alh
 
-RUN pip install -r requirements.txt
+# CMD []
+
+###############################################################################
+FROM development AS builder
+
+ENV WORKDIR=/app
+WORKDIR ${WORKDIR}
+
+RUN apk add --update --no-cache rsync
+
+RUN rsync -av --prune-empty-dirs \
+  --exclude '*_test.py' \
+  --exclude '*.pyc' \
+  --exclude '.venv' \
+  --exclude '__pycache__' \
+  src/ build/
+
+# CMD []
 
 ###############################################################################
 ### In testing stage, can't use USER, due permissions issue
@@ -78,27 +97,36 @@ ENV BRUTEFORCE=false
 WORKDIR /app
 
 COPY ./.coveragerc ${WORKDIR}/
+COPY ./setup.cfg ${WORKDIR}/
+
 RUN ls -alh
 
-CMD ["make", "test", "-e", "{DEBUG}"]
+CMD ["make", "test"]
 
 ###############################################################################
 ### In production stage
 ## in the production phase, "good practices" such as
 ## WORKDIR and USER are maintained
 ##
-FROM builder AS production
+FROM python:3.12.4-alpine3.20 AS production
 
 ENV LOG_LEVEL=INFO
 ENV BRUTEFORCE=false
+ENV WORKDIR=/app
+WORKDIR ${WORKDIR}
 
 RUN adduser -D worker
 RUN mkdir -p /app
 RUN chown worker:worker /app
 
-WORKDIR /app
+RUN apk add --update --no-cache make
+COPY ./Makefile ${WORKDIR}/
+
+COPY --from=builder /app/build/ ${WORKDIR}/
 
 RUN ls -alh
 
 USER worker
-CMD ["make", "test", "-e", "{DEBUG}"]
+CMD ["make", "run"]
+
+# checkov:skip= CKV_DOCKER_2: production image isn't a service process (yet)

Makefile

@@ -82,7 +82,15 @@ test/styling: dependencies
 	${RUNTIME_TOOL} -m pycodestyle --statistics src/
 
 format:
-	autopep8 --in-place --recursive --aggressive --aggressive --verbose src/
+	${RUNTIME_TOOL} -m autopep8 --in-place --recursive --aggressive --aggressive --verbose src/
+
+build: env
+	rsync -av --prune-empty-dirs \
+  --exclude '*_test.py' \
+  --exclude '*.pyc' \
+  --exclude '.venv' \
+  --exclude '__pycache__' \
+  src/ build/
 
 test: env dependencies
 	${RUNTIME_TOOL} -m coverage run -m \
@@ -113,17 +121,20 @@ clean:
 	rm -fr .pytest_cache
 	rm -fr htmlcov
 	rm -fr coverage
+	rm -fr build
 	find . -path "*/*.pyc" -delete -print
 	find . -path "*/*.pyo" -delete -print
 	find . -path "*/__pycache__" -type d -print -exec rm -fr {} ';'
 
 compose/build: env
 	docker-compose --profile lint build
 	docker-compose --profile testing build
+	docker-compose --profile production build
 
 compose/rebuild: env
 	docker-compose --profile lint build --no-cache
 	docker-compose --profile testing build --no-cache
+	docker-compose --profile production build --no-cache
 
 compose/lint/markdown: compose/build
 	docker-compose --profile lint run --rm algorithm-exercises-py-lint make lint/markdown
@@ -139,7 +150,13 @@ compose/test/static: compose/build
 
 compose/lint: compose/lint/markdown compose/lint/yaml compose/test/styling compose/test/static
 
+compose/test: compose/build
+	docker-compose --profile testing run --rm algorithm-exercises-py-test make test
+
 compose/run: compose/build
-	docker-compose --profile testing run --rm algorithm-exercises-py make test
+	docker-compose --profile production run --rm algorithm-exercises-py make run
 
 all: lint coverage
+
+run:
+	ls -alh

compose.yaml

@@ -1,8 +1,8 @@
 ---
 
 services:
-  algorithm-exercises-py:
-    image: algorithm-exercises-py:latest
+  algorithm-exercises-py-test:
+    image: algorithm-exercises-py:test
     build:
       context: .
       target: testing
@@ -37,6 +37,16 @@ services:
       - ./:/app
     profiles: ["development"]
 
+  algorithm-exercises-py:
+    image: algorithm-exercises-py:latest
+    build:
+      context: .
+      target: production
+    environment:
+      LOG_LEVEL: ${LOG_LEVEL:-INFO}  ## (1) ## INFO | DEBUG
+      BRUTEFORCE: ${BRUTEFORCE:-false}  ## (1) ## true | false
+    profiles: ["production"]
+
 ## REFERENCES:
 ## (1) Passing Environment variable with fallback value:
 ##    https://stackoverflow.com/a/70772707/6366150