cleaner

Author: gast0xC

.github/workflows/bica-ci.yml

@@ -10,6 +10,29 @@ env:
   IMAGE_NAME: bica-backup
   TAG: test
 
+  # Docker network
+  DOCKER_NETWORK: bica-net
+
+  # PostgreSQL container related variables
+  POSTGRES_CONTAINER_NAME: postgres-db
+  POSTGRES_USER: myuser
+  POSTGRES_PASSWORD: mypass
+  POSTGRES_DB: mydatabase
+  POSTGRES_PORT: 5432
+
+  # Database backup related variables
+  DB_HOST: postgres-db
+  DB_PORT: 5432
+  DB_USER: myuser
+  DB_PASSWORD: mypass
+  DB_NAME: mydatabase
+
+  # Backup settings
+  BACKUP_DIR: /mnt/backups
+  RETENTION_DAYS: 7
+  ENCRYPT: true
+  ENCRYPT_PASS: MySecretKey
+
 jobs:
   build:
     name: Build Docker Image
@@ -47,34 +70,34 @@ jobs:
       - name: Load docker image
         run: docker load -i image.tar
 
-      - name: Create Docker network
-        run: docker network create bica-net || true
+      - name: Create Docker network (if not exists)
+        run: docker network create $DOCKER_NETWORK || true
 
       - name: Start PostgreSQL container
         run: |
-          docker run -d --name postgres-db --network bica-net \
-            -e POSTGRES_USER=myuser \
-            -e POSTGRES_PASSWORD=mypass \
-            -e POSTGRES_DB=mydatabase \
+          docker run -d --name $POSTGRES_CONTAINER_NAME --network $DOCKER_NETWORK \
+            -e POSTGRES_USER=$POSTGRES_USER \
+            -e POSTGRES_PASSWORD=$POSTGRES_PASSWORD \
+            -e POSTGRES_DB=$POSTGRES_DB \
             postgres:15
 
-      - name: Wait for Postgres to be ready
+      - name: Wait for PostgreSQL to be ready
         run: |
           for i in {1..30}; do
-            docker run --rm --network bica-net postgres:15 \
-              bash -c "PGPASSWORD=mypass pg_isready -h postgres-db -p 5432 -U myuser" && echo "Postgres is ready" && exit 0
-            echo "Waiting for Postgres... attempt $i"
+            docker run --rm --network $DOCKER_NETWORK postgres:15 \
+              bash -c "PGPASSWORD=$POSTGRES_PASSWORD pg_isready -h $POSTGRES_CONTAINER_NAME -p $POSTGRES_PORT -U $POSTGRES_USER" && echo "PostgreSQL is ready" && exit 0
+            echo "Waiting for PostgreSQL... attempt $i"
             sleep 2
           done
-          echo "Postgres did not become ready in time"
+          echo "PostgreSQL did not become ready in time"
           exit 1
 
       - name: Populate database with sample data
         run: |
-          docker run --rm --network bica-net \
-            -e PGPASSWORD=mypass \
+          docker run --rm --network $DOCKER_NETWORK \
+            -e PGPASSWORD=$POSTGRES_PASSWORD \
             postgres:15 \
-            psql -h postgres-db -U myuser -d mydatabase -c "
+            psql -h $POSTGRES_CONTAINER_NAME -U $POSTGRES_USER -d $POSTGRES_DB -c "
               CREATE TABLE IF NOT EXISTS users (
                 id SERIAL PRIMARY KEY,
                 username TEXT NOT NULL UNIQUE,
@@ -122,40 +145,40 @@ jobs:
 
       - name: Run encrypted backup
         run: |
-          docker run --rm --network bica-net \
+          docker run --rm --network $DOCKER_NETWORK \
             --entrypoint /backup.sh \
-            -e DB_HOST=postgres-db \
-            -e DB_PORT=5432 \
-            -e DB_USER=myuser \
-            -e DB_PASSWORD=mypass \
-            -e DB_NAME=mydatabase \
-            -e BACKUP_DIR=/mnt/backups \
-            -e RETENTION_DAYS=7 \
-            -e ENCRYPT=true \
-            -e ENCRYPT_PASS=MySecretKey \
-            -v ${{ github.workspace }}/backups:/mnt/backups \
+            -e DB_HOST=$DB_HOST \
+            -e DB_PORT=$DB_PORT \
+            -e DB_USER=$DB_USER \
+            -e DB_PASSWORD=$DB_PASSWORD \
+            -e DB_NAME=$DB_NAME \
+            -e BACKUP_DIR=$BACKUP_DIR \
+            -e RETENTION_DAYS=$RETENTION_DAYS \
+            -e ENCRYPT=$ENCRYPT \
+            -e ENCRYPT_PASS=$ENCRYPT_PASS \
+            -v ${{ github.workspace }}/backups:$BACKUP_DIR \
             $IMAGE_NAME:$TAG
 
-      - name: List backups
+      - name: List backup files
         run: ls -lh ./backups
 
-      - name: Upload encrypted backup
+      - name: Upload encrypted backup artifact
         uses: actions/upload-artifact@v4
         with:
           name: encrypted-backup
           path: ./backups/*.enc
 
-      - name: Cleanup
+      - name: Cleanup Docker resources
         run: |
-          docker rm -f postgres-db || true
-          docker network rm bica-net || true
+          docker rm -f $POSTGRES_CONTAINER_NAME || true
+          docker network rm $DOCKER_NETWORK || true
 
   decrypt-and-show:
     name: Decrypt backup and show pg_dump
     runs-on: ubuntu-latest
     needs: backup-encrypted
     steps:
-      - name: Prepare folder
+      - name: Prepare local backup folder
         run: mkdir -p ./backups
 
       - name: Download encrypted backup artifact
@@ -164,20 +187,20 @@ jobs:
           name: encrypted-backup
           path: ./backups
 
-      - name: Decrypt backup
+      - name: Decrypt backup files
         run: |
-          ENCRYPT_PASS=MySecretKey
+          ENCRYPT_PASS=$ENCRYPT_PASS
           for f in ./backups/*.enc; do
             openssl enc -aes-256-cbc -d -pbkdf2 -salt -in "$f" -out "${f%.enc}.tar.gz" -k "$ENCRYPT_PASS"
           done
 
-      - name: Extract decrypted tarball and show pg_dump
+      - name: Extract decrypted tarball and display first 40 lines of pg_dump
         run: |
           tar -xzf ./backups/*.tar.gz -C ./backups
           head -40 ./backups/db_backup.sql
 
   docker-publish:
-    name: Push to Docker Hub
+    name: Push Docker image to Docker Hub
     runs-on: ubuntu-latest
     needs: [decrypt-and-show]
     if: github.ref == 'refs/heads/main' && github.event_name == 'push'
@@ -187,16 +210,16 @@ jobs:
       - name: Setup Docker Buildx
         uses: docker/setup-buildx-action@v3
 
-      - name: Build image
+      - name: Build Docker image
         run: docker build -t $IMAGE_NAME:$TAG .
 
-      - name: Docker Login
+      - name: Docker login
         uses: docker/login-action@v3
         with:
           username: ${{ secrets.DOCKER_USERNAME }}
           password: ${{ secrets.DOCKER_PASSWORD }}
 
-      - name: Push image
+      - name: Push image to Docker Hub
         run: |
           docker tag $IMAGE_NAME:$TAG ${{ secrets.DOCKER_USERNAME }}/$IMAGE_NAME:latest
           docker push ${{ secrets.DOCKER_USERNAME }}/$IMAGE_NAME:latest