refactor: streamline CI configuration and Docker image build process

Author: mmicu

.github/workflows/ci.yaml

@@ -31,7 +31,6 @@ jobs:
         run: |
           ec --version
 
-
   test-python-versions:
     runs-on: ubuntu-24.04
     steps:
@@ -44,9 +43,14 @@ jobs:
       - name: run testsuite verifying against all python versions
         shell: bash
         run: |
-          # only test the local package, since we assume that we only
-          # upload to PyPI once we are certain that the local package is fine
+          # Only test the local package, since we assume that we only
+          # upload to PyPI once we are certain that the local package is fine.
           export TEST_LOCAL_PKG=true
           export TEST_PYPI_PKG=false
 
-          make test
+          # The same commands are defined in the `Makefile` and used for local development.
+          # We added them here to simplify the building process of the Docker
+          # image that points to `python:2.7-slim`.
+          # For such image, `apt-get` was not working as expected.
+          flake8 --ignore E501 setup.py
+          bash run-tests.sh

Dockerfile

@@ -5,9 +5,7 @@ ARG IMAGE=3.13-slim
 
 
 FROM python:$IMAGE AS pybase
-RUN apt-get update                         \
-    && apt-get install -y make             \
-    && python -m pip install --upgrade pip
+RUN python -m pip install --upgrade pip
 
 # separate the obtaining of the requirements from the actual test, so we can use build caching for the first step
 FROM pybase as tester

Makefile

@@ -5,8 +5,8 @@ help:
 	@echo "  - clean        : Remove generated files."
 	@echo "  - coding-style : Run coding style tools."
 	@echo "  - publish      : Publish package to PyPI."
+	@echo "  - quick-test   : Run coding style tools and only the test for the latest python and the current git revision."
 	@echo "  - test         : Run coding style tools and tests."
-	@echo "  - quicktest    : Run coding style tools and only the test for the latest python and the current git revision."
 
 .PHONY: all
 all: help
@@ -24,11 +24,11 @@ publish: clean test
 	@python3 setup.py sdist
 	@twine upload dist/*
 
+.PHONY: quick-test
+quick-test: coding-style
+	docker build -t ec-quick-test .
+	docker run ec-quick-test ec -version
+
 .PHONY: test
 test: coding-style
 	@bash run-tests.sh
-
-.PHONY: quicktest
-quicktest: coding-style
-	docker build -t quicktest .
-	docker run quicktest ec -version

run-tests.sh

@@ -2,34 +2,10 @@
 
 set -e
 
-PY_DOCKER_IMAGES=()
-if [ -n "$TEST_PY_VERSION" ]; then
-	PY_VERSIONS+=("$TEST_PY_VERSION")
-else
-	PY_VERSIONS+=("2.7")
-	PY_VERSIONS+=("3.7")
-	PY_VERSIONS+=("3.8")
-	PY_VERSIONS+=("3.9")
-	PY_VERSIONS+=("3.10")
-	PY_VERSIONS+=("3.11")
-	PY_VERSIONS+=("3.12")
-	PY_VERSIONS+=("3.13")
-fi
-
-PY_PACKAGES=()
-if [ -z "$TEST_LOCAL_PKG" ] || [ "$TEST_LOCAL_PKG" = "true" ]; then
-	PY_PACKAGES+=("local")
-fi
-if [ -z "$TEST_PYPI_PKG" ] || [ "$TEST_PYPI_PKG" = "true" ]; then
-	PY_PACKAGES+=("editorconfig-checker")
-fi
-
-
 build_docker_image_and_run() {
     local py_docker_image="$1"
     local package="$2"
 
-    # Build
     local docker_image="editorconfig-checker-$py_docker_image-$package:latest"
 
     docker_package="$package"
@@ -46,20 +22,38 @@ build_docker_image_and_run() {
         --build-arg "PACKAGE=$docker_package" \
         .
 
-    # Run `editorconfig-checker`
     docker run --rm "$docker_image" ec -version
 }
 
 main() {
     echo -e "Running tests...\n\n"
 
-    for py_version in "${PY_VERSIONS[@]}"; do
-        for package in "${PY_PACKAGES[@]}"; do
-            echo "Building docker image with python version $py_version and $package package. It could take some time..."
-            build_docker_image_and_run "$py_version-slim" "$package"
+    local py_versions=()
+    if [ -n "$TEST_PY_VERSION" ]; then
+        py_versions+=("$TEST_PY_VERSION")
+    else
+        py_versions+=("2.7")
+        py_versions+=("3.7")
+        py_versions+=("3.8")
+        py_versions+=("3.9")
+        py_versions+=("3.10")
+        py_versions+=("3.11")
+        py_versions+=("3.12")
+        py_versions+=("3.13")
+    fi
 
-            # docker image rm "$docker_image" &> /dev/null
+    local py_packages=()
+    if [ -z "$TEST_LOCAL_PKG" ] || [ "$TEST_LOCAL_PKG" = "true" ]; then
+        py_packages+=("local")
+    fi
+    if [ -z "$TEST_PYPI_PKG" ] || [ "$TEST_PYPI_PKG" = "true" ]; then
+        py_packages+=("editorconfig-checker")
+    fi
 
+    for py_version in "${py_versions[@]}"; do
+        for package in "${py_packages[@]}"; do
+            echo "Building docker image with Python version $py_version and $package package. It could take some time..."
+            build_docker_image_and_run "$py_version-slim" "$package"
             echo -e "\n"
         done
     done