ci: ci cd to build and push image

Author: rebecamurillo

.dockerignore

@@ -0,0 +1,92 @@
+# Version control
+.git
+.gitignore
+.github
+
+# Python cache and bytecode
+__pycache__/
+*.py[cod]
+*$py.class
+*.so
+.Python
+*.egg
+*.egg-info
+dist/
+build/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.manifest
+*.spec
+.pytest_cache/
+.mypy_cache/
+.ruff_cache/
+.coverage
+.coverage.*
+htmlcov/
+
+# Virtual environments
+env/
+venv/
+ENV/
+.venv
+pipenv/
+
+# Environment files and secrets
+.env
+.env.*
+!.env.example
+
+# Development and analysis files
+*.ipynb
+.ipynb_checkpoints/
+notebooks/
+demo_*.ipynb
+
+# Documentation
+docs/
+build_docs.py
+specs/
+*.md
+!README.md
+
+# Tests
+tests/
+pytest.ini
+.pytest_cache/
+
+# IDE and editors
+.vscode/
+.idea/
+*.swp
+*.swo
+*.swn
+.DS_Store
+Thumbs.db
+
+# Data and outputs
+data/output/
+*.csv
+*.json
+!kpis.json
+!measures.json
+!living_labs_data.json
+!kpi_groups.json
+!kpi_groups_mcda_goals.json
+
+# Build and package files
+*.whl
+*.tar.gz
+
+# Other
+*.log
+.pipenv/
+Pipfile
+Pipfile.lock
+LICENSE
+imact-analysis-queries/

.github/workflows/docker-build.yml

@@ -0,0 +1,94 @@
+name: Build and Push Docker image to GitLab Registry
+
+on:
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  packages: read
+
+env:
+  IMAGE_NAME: inocs-sum-odp-impact-api
+  REGISTRY: ${{ secrets.GITLAB_REGISTRY }}
+  PROJECT_PATH: ${{ vars.GITLAB_PROJECT_PATH }}
+
+jobs:
+  test:
+    name: Run Tests
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.13"
+
+      - name: Install pipenv
+        run: pip install pipenv
+
+      - name: Install dependencies
+        run: pipenv install --dev
+
+      - name: Run tests
+        run: pipenv run pytest
+
+  version:
+    name: Extract Version
+    runs-on: ubuntu-latest
+    needs: test
+    outputs:
+      version: ${{ steps.get_version.outputs.version }}
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Extract version from __version__.py
+        id: get_version
+        run: |
+          VERSION=$(python3 -c "exec(open('src/sum_impact_assessment/__version__.py').read()); print(__version__)")
+          echo "version=$VERSION" >> $GITHUB_OUTPUT
+          echo "Extracted version: $VERSION"
+
+  build:
+    name: Build and Push Docker Image
+    runs-on: ubuntu-latest
+    needs: [test, version]
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v3
+
+      - name: Log in to GitLab Container Registry
+        run: echo "${{ secrets.GITLAB_PASSWORD }}" | docker login ${{ env.REGISTRY }} -u ${{ secrets.GITLAB_USER }} --password-stdin
+
+      - name: Build and push Docker image
+        uses: docker/build-push-action@v6
+        with:
+          context: .
+          file: ./Dockerfile
+          push: true
+          tags: |
+            ${{ env.REGISTRY }}/${{ env.PROJECT_PATH }}/${{ env.IMAGE_NAME }}:${{ needs.version.outputs.version }}
+            ${{ env.REGISTRY }}/${{ env.PROJECT_PATH }}/${{ env.IMAGE_NAME }}:latest
+          cache-from: type=registry,ref=${{ env.REGISTRY }}/${{ env.PROJECT_PATH }}/${{ env.IMAGE_NAME }}:latest
+          cache-to: type=inline
+
+      - name: Image Summary
+        run: |
+          echo "### Docker Image Built Successfully! :rocket:" >> $GITHUB_STEP_SUMMARY
+          echo "" >> $GITHUB_STEP_SUMMARY
+          echo "**Version:** \`${{ needs.version.outputs.version }}\`" >> $GITHUB_STEP_SUMMARY
+          echo "**Registry:** \`${{ env.REGISTRY }}\`" >> $GITHUB_STEP_SUMMARY
+          echo "**Image Tags:**" >> $GITHUB_STEP_SUMMARY
+          echo "- \`${{ env.REGISTRY }}/${{ env.PROJECT_PATH }}/${{ env.IMAGE_NAME }}:${{ needs.version.outputs.version }}\`" >> $GITHUB_STEP_SUMMARY
+          echo "- \`${{ env.REGISTRY }}/${{ env.PROJECT_PATH }}/${{ env.IMAGE_NAME }}:latest\`" >> $GITHUB_STEP_SUMMARY
+
+      - name: Logout
+        run: docker logout ${{ env.REGISTRY }}

Dockerfile

@@ -0,0 +1,47 @@
+# Multi-stage Dockerfile for SUM Impact Assessment API
+# Stage 1: Builder - prepare dependencies
+FROM python:3.13-slim AS builder
+
+WORKDIR /app
+
+# Copy requirements file
+COPY requirements.txt .
+
+# Install dependencies in a virtual environment
+RUN pip install --no-cache-dir --upgrade pip && \
+    pip install --no-cache-dir -r requirements.txt
+
+# Stage 2: Runtime - minimal production image
+FROM python:3.13-slim
+
+WORKDIR /app
+
+# Install runtime dependencies (curl for health checks)
+RUN apt-get update && \
+    apt-get install -y --no-install-recommends curl && \
+    rm -rf /var/lib/apt/lists/*
+
+# Copy installed packages from builder
+COPY --from=builder /usr/local/lib/python3.13/site-packages /usr/local/lib/python3.13/site-packages
+COPY --from=builder /usr/local/bin /usr/local/bin
+
+# Create non-root user
+RUN useradd -m -u 1000 appuser && \
+    chown -R appuser:appuser /app
+
+# Copy application code
+COPY --chown=appuser:appuser src/ ./src/
+COPY --chown=appuser:appuser run_api.py .
+
+# Switch to non-root user
+USER appuser
+
+# Expose API port
+EXPOSE 8000
+
+# Health check using the /health endpoint
+HEALTHCHECK --interval=30s --timeout=3s --start-period=5s --retries=3 \
+    CMD curl -f http://localhost:8000/health || exit 1
+
+# Run the FastAPI application with uvicorn
+CMD ["python", "-m", "uvicorn", "src.sum_impact_assessment.api.main:app", "--host", "0.0.0.0", "--port", "8000"]

Pipfile

@@ -1,3 +1,7 @@
+# IMPORTANT: After installing new packages with 'pipenv install <package>',
+# regenerate requirements.txt for Docker builds by running:
+# pipenv requirements > requirements.txt
+
 [[source]]
 url = "https://pypi.org/simple"
 verify_ssl = true

README.md

@@ -175,3 +175,134 @@ curl http://localhost:8000/health
 curl http://localhost:8000/kpis
 ```
 
+## Build and Push Docker Image
+
+The project includes CI/CD automation to build and publish Docker images to GitLab Container Registry.
+
+### Version Management
+
+The API version is managed through semantic versioning in `src/sum_impact_assessment/__version__.py`:
+
+```python
+__version__ = "0.0.0"  # MAJOR.MINOR.PATCH
+```
+
+**To release a new version:**
+
+1. Update the version number in `src/sum_impact_assessment/__version__.py`
+2. Commit the version change
+3. Trigger the Docker build workflow (see below)
+
+Follow [semantic versioning](https://semver.org/) guidelines:
+- **MAJOR**: Breaking changes
+- **MINOR**: New features, backward compatible
+- **PATCH**: Bug fixes, backward compatible
+
+### Requirements Management
+
+The project uses `pipenv` for dependency management but generates `requirements.txt` for Docker builds.
+
+**After installing new packages:**
+
+```bash
+# Install a new package
+pipenv install <package-name>
+
+# Regenerate requirements.txt for Docker
+pipenv requirements > requirements.txt
+
+# Commit both Pipfile.lock and requirements.txt
+git add Pipfile.lock requirements.txt
+git commit -m "Add <package-name> dependency"
+```
+
+> **Important:** Always regenerate `requirements.txt` after modifying dependencies to keep Docker builds in sync.
+
+### Manual Docker Build (Local)
+
+Build and test the Docker image locally before pushing to registry:
+
+```bash
+# Build the image
+docker build -t sum-impact-api:local .
+
+# Run the container
+docker run -p 8000:8000 \
+  -e DB_HOST=host.docker.internal \
+  -e DB_PORT=3306 \
+  -e DB_USER=your_user \
+  -e DB_PASSWORD=your_password \
+  -e DB_NAME=sum_odp \
+  sum-impact-api:local
+
+# Test the health endpoint
+curl http://localhost:8000/health
+```
+
+### CI/CD Workflow (GitHub Actions)
+
+The project uses GitHub Actions to automatically build and push Docker images to GitLab Container Registry.
+
+**Workflow file:** `.github/workflows/docker-build.yml`
+
+**Prerequisites:**
+
+Configure the following secrets and variables in your GitHub repository:
+
+**Secrets (Settings → Secrets and variables → Actions → Secrets):**
+- `GITLAB_REGISTRY` - GitLab Container Registry URL (e.g., `registry.gitlab.com`)
+- `GITLAB_USER` - GitLab username or deploy token username
+- `GITLAB_PASSWORD` - GitLab access token or deploy token password
+
+**Variables (Settings → Secrets and variables → Actions → Variables):**
+- `GITLAB_PROJECT_PATH` - GitLab project path (e.g., `inria/sum-odp`)
+
+**Trigger the workflow:**
+
+1. Go to **Actions** tab in GitHub repository
+2. Select **"Build and Push Docker image to GitLab Registry"**
+3. Click **"Run workflow"**
+4. Select branch and click **"Run workflow"**
+
+**Workflow steps:**
+
+1. **Test** - Runs full test suite with pytest
+2. **Version** - Extracts version from `__version__.py`
+3. **Build** - Builds multi-stage Docker image and pushes with two tags:
+   - `<registry>/<project>/<image>:<version>` (e.g., `registry.gitlab.com/inria/sum-odp/inocs-sum-odp-api:0.0.0`)
+   - `<registry>/<project>/<image>:latest`
+
+**Pull the image from GitLab:**
+
+```bash
+# Login to GitLab Container Registry
+docker login registry.gitlab.com
+
+# Pull specific version
+docker pull registry.gitlab.com/inria/sum-odp/inocs-sum-odp-api:0.0.0
+
+# Pull latest
+docker pull registry.gitlab.com/inria/sum-odp/inocs-sum-odp-api:latest
+```
+
+### Docker Image Details
+
+**Base image:** `python:3.13-slim`
+
+**Features:**
+- Multi-stage build for optimized image size
+- Non-root user (`appuser`) for security
+- Health check on `/health` endpoint
+- Exposed port: `8000`
+- Automatic dependency installation from `requirements.txt`
+
+**Environment variables:**
+
+All configuration is done via environment variables. See `.env.example` for available options.
+
+**Image tags:**
+
+- `<version>` - Immutable version tag (e.g., `0.0.0`, `1.2.3`)
+- `latest` - Always points to the most recent build
+
+