ci: automate Docker image rebuild, test, and publish in GitHub Actions and GitLab CI (solves #20)

Author: aleksandr-kotlyar

.github/workflows/docker-image.yml

@@ -0,0 +1,87 @@
+name: Docker image CI
+
+on:
+  push:
+    branches:
+      - master
+    paths:
+      - Dockerfile
+      - requirements.txt
+      - Pipfile
+      - Pipfile.lock
+      - .github/workflows/docker-image.yml
+  pull_request:
+    paths:
+      - Dockerfile
+      - requirements.txt
+      - Pipfile
+      - Pipfile.lock
+      - .github/workflows/docker-image.yml
+
+concurrency:
+  group: docker-image-${{ github.ref }}
+  cancel-in-progress: true
+
+env:
+  IMAGE_NAME: ghcr.io/${{ github.repository }}
+
+jobs:
+  build-test-push:
+    name: Build, test and publish docker image
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v3
+
+      - name: Build image for tests
+        run: |
+          docker buildx build \
+            --load \
+            --cache-from type=gha \
+            --cache-to type=gha,mode=max \
+            --tag local-ci-image:${{ github.sha }} \
+            .
+
+      - name: Run tests inside built image
+        run: |
+          docker run --rm \
+            -v "${{ github.workspace }}:/app" \
+            -w /app \
+            local-ci-image:${{ github.sha }} \
+            pytest src/test/test_api.py
+
+      - name: Log in to GitHub Container Registry
+        if: github.event_name == 'push'
+        uses: docker/login-action@v3
+        with:
+          registry: ghcr.io
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Extract image metadata
+        if: github.event_name == 'push'
+        id: meta
+        uses: docker/metadata-action@v5
+        with:
+          images: ${{ env.IMAGE_NAME }}
+          tags: |
+            type=raw,value=latest
+            type=sha,prefix=sha-
+            type=raw,value=run-${{ github.run_number }}
+
+      - name: Build and push image
+        if: github.event_name == 'push'
+        uses: docker/build-push-action@v6
+        with:
+          context: .
+          push: true
+          tags: ${{ steps.meta.outputs.tags }}
+          labels: ${{ steps.meta.outputs.labels }}
+          cache-from: type=gha
+          cache-to: type=gha,mode=max

.github/workflows/test_api.yml

@@ -1,16 +1,27 @@
 on:
-  [push]
+  push:
+    paths:
+      - src/**
+      - requirements.txt
+      - pytest.ini
+      - .github/workflows/test_api.yml
+  pull_request:
+    paths:
+      - src/**
+      - requirements.txt
+      - pytest.ini
+      - .github/workflows/test_api.yml
 
 jobs:
   pytest:
     name: Pytest
     runs-on: ubuntu-latest
-    container:
-      image: docker.pkg.github.com/aleksandr-kotlyar/python_and_gitlab/python-3.7.6-alpine-req:ver-14-mimesis-4.1.2
-      credentials:
-        username: ${{ github.actor }}
-        password: ${{ secrets.TRAFFIC_TOKEN }}
     steps:
-    - uses: actions/checkout@v2
-    - run: pytest src/test/test_api.py
-      continue-on-error: true
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.7"
+      - run: |
+          python -m pip install --upgrade pip
+          pip install -r requirements.txt
+      - run: pytest src/test/test_api.py

.gitlab/build.yml

@@ -29,3 +29,29 @@ Build:
     DOCKERFILE_PATH: ".docker/$IMAGE_CATEGORY/Dockerfile"
     BUILD_CONTEXT: "."
     BUILD_ARG: "--build-arg ALLURE_VERSION=$ALLURE_VERSION"
+
+Auto:docker:rebuild:test:publish:
+  extends: .build
+  stage: build
+  variables:
+    DOCKERFILE_PATH: "Dockerfile"
+    BUILD_CONTEXT: "."
+    BUILD_ARG: ""
+    IMAGE_NAME_SHA: "$CI_REGISTRY_IMAGE:sha-$CI_COMMIT_SHORT_SHA"
+    IMAGE_NAME_LATEST: "$CI_REGISTRY_IMAGE:latest"
+    TEST_PATH: "src/test/test_api.py"
+  script:
+    - docker build $BUILD_ARG -f $DOCKERFILE_PATH -t $IMAGE_NAME_SHA $BUILD_CONTEXT
+    - docker run --rm -v "$CI_PROJECT_DIR:/app" -w /app $IMAGE_NAME_SHA pytest $TEST_PATH
+    - docker tag $IMAGE_NAME_SHA $IMAGE_NAME_LATEST
+    - docker push $IMAGE_NAME_SHA
+    - docker push $IMAGE_NAME_LATEST
+  rules:
+    - if: '$CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH'
+      changes:
+        - Dockerfile
+        - requirements.txt
+        - Pipfile
+        - Pipfile.lock
+        - .gitlab/.gitlab-ci.yml
+        - .gitlab/build.yml