Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
127 changes: 56 additions & 71 deletions .github/workflows/backend_ci.yml
Original file line number Diff line number Diff line change
@@ -1,91 +1,70 @@
# week07/.github/workflows/backend_ci.yml

name: Backend CI - Test, Build and Push Images to ACR

# Trigger the workflow on pushes to the 'main' branch
# You can also add 'pull_request:' to run on PRs
on:
# Manual trigger
workflow_dispatch:

# Automatically on pushes to main branch
push:
branches:
- main
paths: # Only trigger if changes are in backend directories
paths:
- 'backend/**'
- '.github/workflows/backend_ci.yml' # Trigger if this workflow file changes
- '.github/workflows/backend_ci.yml'

# Define global environment variables that can be used across jobs
env:
# ACR Login Server (e.g., myregistry.azurecr.io)
# This needs to be set as a GitHub Repository Secret
ACR_LOGIN_SERVER: ${{ secrets.ACR_LOGIN_SERVER }}
# Dynamically generate image tags based on Git SHA and GitHub Run ID
# This provides unique, traceable tags for each image build
# Keep using the secret you already created
REGISTRY_LOGIN_SERVER: ${{ secrets.REGISTRY_LOGIN_SERVER }}
IMAGE_TAG: ${{ github.sha }}-${{ github.run_id }}

jobs:
# Job 1: Run tests and linting for all backend services
test_and_lint_backends:
runs-on: ubuntu-latest # Use a GitHub-hosted runner
runs-on: ubuntu-latest

services:
# Product DB container
product_db:
image: postgres:15
env:
POSTGRES_USER: postgres
POSTGRES_PASSWORD: postgres
POSTGRES_DB: products
# Make pg_isready available so the service is healthy before tests run
options: >-
--health-cmd "pg_isready -U postgres"
--health-interval 10s
--health-timeout 5s
--health-retries 5
ports:
- 5432:5432

# Order DB

order_db:
image: postgres:15
env:
POSTGRES_USER: postgres
POSTGRES_PASSWORD: postgres
POSTGRES_DB: orders
ports:
- 5433:5432
options: >-
--health-cmd "pg_isready -U postgres"
--health-interval 10s
--health-timeout 5s
--health-retries 5
ports:
- 5433:5432

steps:
# 1. Checkout the repository code to the runner
- name: Checkout repository
uses: actions/checkout@v4 # Action to check out your repository code
uses: actions/checkout@v4

# 2. Set up Python environment
- name: Set up Python 3.10
uses: actions/setup-python@v5 # Action to set up Python environment
- name: Set up Python
uses: actions/setup-python@v5
with:
python-version: '3.10'
python-version: '3.11'

# 3. Install dependencies and run code quality checks
- name: Install dependencies
run: | # Use a multi-line script to install pip dependencies
pip install --upgrade pip
# Loop through each backend service folder
run: |
python -m pip install --upgrade pip
for req in backend/*/requirements.txt; do
echo "Installing $req"
pip install -r "$req"
done
# Install CI tools
pip install pytest httpx

# 5. Run tests for product service
- name: Run product_service tests
working-directory: backend/product_service
env:
Expand All @@ -94,10 +73,8 @@ jobs:
POSTGRES_DB: products
POSTGRES_USER: postgres
POSTGRES_PASSWORD: postgres
run: |
pytest tests --maxfail=1 --disable-warnings -q

# 6. Run tests for order service
run: pytest tests --maxfail=1 --disable-warnings -q

- name: Run order_service tests
working-directory: backend/order_service
env:
Expand All @@ -106,41 +83,49 @@ jobs:
POSTGRES_DB: orders
POSTGRES_USER: postgres
POSTGRES_PASSWORD: postgres
run: |
pytest tests --maxfail=1 --disable-warnings -q
run: pytest tests --maxfail=1 --disable-warnings -q

# Job 2: Build and Push Docker Images (runs only if tests pass)
build_and_push_images:
runs-on: ubuntu-latest
needs: test_and_lint_backends
env:
REGISTRY: ${{ secrets.REGISTRY_LOGIN_SERVER }}

steps:
- name: Checkout repository
uses: actions/checkout@v4

# Azure login using a Service Principal secret
- name: Azure Login
uses: azure/login@v1
with:
creds: ${{ secrets.AZURE_CREDENTIALS }} # Needs to be set as a GitHub Secret (Service Principal JSON)

# Login to Azure Container Registry (ACR)
- name: Login to Azure Container Registry
run: az acr login --name ${{ env.ACR_LOGIN_SERVER }}

# Build and Push Docker image for Product Service
- name: Build and Push Product Service Image
run: |
docker build -t ${{ env.ACR_LOGIN_SERVER }}/product_service:latest ./backend/product_service/
docker push ${{ env.ACR_LOGIN_SERVER }}/product_service:latest

# Build and Push Docker image for Order Service
- name: Build and Push Order Service Image
run: |
docker build -t ${{ env.ACR_LOGIN_SERVER }}/order_service:latest ./backend/order_service/
docker push ${{ env.ACR_LOGIN_SERVER }}/order_service:latest

# Logout from Azure for security (runs even if image push fails)
- name: Logout from Azure
run: az logout
if: always()
- name: Checkout repository
uses: actions/checkout@v4

- name: Azure Login (Service Principal)
uses: azure/login@v1
with:
creds: ${{ secrets.AZURE_CREDENTIALS }}

# Derive the ACR registry name (e.g., shrikesh) from login server (e.g., shrikesh.azurecr.io)
- name: Derive ACR name
id: derive
run: |
REGISTRY="${{ env.REGISTRY }}"
NAME=${REGISTRY%%.azurecr.io}
echo "ACR_NAME=$NAME" >> "$GITHUB_ENV"
echo "Using ACR name: $NAME"

- name: Login to Azure Container Registry
run: az acr login --name "$ACR_NAME"

- name: Build and Push Product Service
run: |
docker build -t ${{ env.REGISTRY }}/product_service:latest ./backend/product_service/
docker tag ${{ env.REGISTRY }}/product_service:latest ${{ env.REGISTRY }}/product_service:${{ env.IMAGE_TAG }}
docker push ${{ env.REGISTRY }}/product_service:latest
docker push ${{ env.REGISTRY }}/product_service:${{ env.IMAGE_TAG }}

- name: Build and Push Order Service
run: |
docker build -t ${{ env.REGISTRY }}/order_service:latest ./backend/order_service/
docker tag ${{ env.REGISTRY }}/order_service:latest ${{ env.REGISTRY }}/order_service:${{ env.IMAGE_TAG }}
docker push ${{ env.REGISTRY }}/order_service:latest
docker push ${{ env.REGISTRY }}/order_service:${{ env.IMAGE_TAG }}

- name: Logout from Azure
if: always()
run: az logout