Introduce a CPT backend version

Version information is compiled at build time using a Python script, producing
a transient JSON file that will be copied into the backend container for
access at runtime via `GET /api/version`.

Author: dbutenhof

.github/workflows/build-push.yaml

@@ -3,7 +3,6 @@ on:
   push:
     branches:
       - main
-      - revamp
 
 jobs:
   build:
@@ -12,6 +11,9 @@ jobs:
 
     steps:
     - uses: actions/checkout@v2
+    - uses: actions/setup-python@v4
+      with:
+        python-version: "3.11"
 
     - name: Build Frontend Image
       id: build-front
@@ -33,6 +35,9 @@ jobs:
         username: ${{ secrets.QUAY_USER }}
         password: ${{ secrets.QUAY_TOKEN }}
 
+    - name: Generate version file
+      run: scripts/version.py
+
     - name: Build Backend Image
       id: build-back
       uses: redhat-actions/buildah-build@v2

.github/workflows/release-build-push.yaml

@@ -12,6 +12,9 @@ jobs:
 
     steps:
     - uses: actions/checkout@v2
+    - uses: actions/setup-python@v4
+      with:
+        python-version: "3.11"
 
     - name: Build Frontend Image
       id: build-front
@@ -33,6 +36,9 @@ jobs:
         username: ${{ secrets.QUAY_USER }}
         password: ${{ secrets.QUAY_TOKEN }}
 
+    - name: Generate version file
+      run: scripts/version.py
+
     - name: Build Backend Image
       id: build-back
       uses: redhat-actions/buildah-build@v2

backend/.gitignore

@@ -1,6 +1,7 @@
 **/.idea
 **/*.cfg
 ocpperf.toml
+version.json
 **/*.csv
 **/*.json
 

backend/VERSION

@@ -0,0 +1 @@
+0.1.0

backend/app/api/api.py

@@ -1,3 +1,5 @@
+import json
+from pathlib import Path
 from fastapi import APIRouter
 
 from app.api.v1.endpoints.ocp import results
@@ -34,8 +36,8 @@
 router.include_router(telcoGraphs.router, tags=["telco"])
 
 # OLS endpoints
-router.include_router(olsJobs.router, tags=['ols'])
-router.include_router(olsGraphs.router, tags=['ols'])
+router.include_router(olsJobs.router, tags=["ols"])
+router.include_router(olsGraphs.router, tags=["ols"])
 
 # Jira endpoints
 router.include_router(jira.router, tags=["jira"])
@@ -45,3 +47,55 @@
 
 # OCM endpoint
 router.include_router(ocmJobs.router, tags=["ocm"])
+
+
+@router.get(
+    "/api/version",
+    summary="Get CPT aggregator version",
+    description=(
+        "Return information about the CPT aggregator build, "
+        "including the version, the last commit SHA, "
+        "the branch on which this aggregator was built, "
+        "and the build date, along with a list of the 10 most recent commits"
+    ),
+    responses={
+        200: {
+            "content": {
+                "application/json": {
+                    "example": {
+                        "version": "0.1.0",
+                        "sha": "xxxxxx",
+                        "branch": "main",
+                        "display_version": "v0.1.0-xxxxxx (main)",
+                        "date": "2025-04-16T19:36:55.179192+00:00",
+                        "changes": [
+                            {
+                                "sha": "xyzzy",
+                                "author": "Easter Bunny",
+                                "email": "bunny_the@example.com",
+                                "date": "2025-04-14T14:52:38-04:00",
+                                "title": "Add an easter egg",
+                            }
+                        ],
+                    },
+                }
+            },
+        }
+    },
+)
+async def version():
+    """Return CPT aggregator version information
+
+    A version.json file is created at build time; this API will
+    fetch it, and return it. If the file doesn't exist, or can't
+    be read, return a minimal placeholder rather than fail.
+    """
+    version = Path("version.json")
+    v = {"version": "0.0.0-none", "changes": []}
+    try:
+        if version.is_file():
+            with version.open() as vf:
+                v = json.load(vf)
+    except Exception as exc:
+        print(f"Unable to read {str(version)}: {str(exc)!r}")
+    return v

backend/backend.containerfile

@@ -10,6 +10,7 @@ COPY app/ /backend/app
 COPY scripts/ /backend/scripts
 COPY pyproject.toml /backend
 COPY poetry.lock /backend
+COPY version.json /backend
 
 WORKDIR /backend
 

backend/scripts/start-reload.sh

@@ -1,3 +1,3 @@
 #!/usr/bin/bash
-
+scripts/version.py
 uvicorn --reload --host="0.0.0.0" --port=8000 --forwarded-allow-ips='*' --proxy-headers app.main:app

backend/scripts/start.sh

@@ -1,3 +1,2 @@
 #!/usr/bin/bash
-
 poetry run uvicorn --host="0.0.0.0" --port=8000 --forwarded-allow-ips='*' --proxy-headers app.main:app

backend/scripts/version.py

@@ -0,0 +1,60 @@
+#!/usr/bin/env python3
+
+"""Create version information JSON file
+
+This file is created at build time and copied into the backend container so
+that we can include information that's not available at runtime.
+"""
+from datetime import datetime, timezone
+import json
+from pathlib import Path
+import sys
+import subprocess
+from typing import Optional
+
+
+def do(cmd: list[str]) -> list[str]:
+    result = subprocess.run(cmd, text=True, capture_output=True)
+    if result.returncode != 0:
+        raise Exception(f"Command {' '.join(cmd)!r} failed: {result.stderr}")
+    return [line.strip() for line in result.stdout.split("\n") if line.strip()]
+
+
+def getone(cmd: list[str], if_none: Optional[str] = None) -> str:
+    res = do(cmd)
+    if if_none is not None and len(res) == 0:
+        return if_none
+    if len(res) != 1:
+        raise Exception(f"Command {' '.join(cmd)!r} returned {len(res)} lines: {res}")
+    return res[0]
+
+
+def main():
+    top = Path(getone(["git", "rev-parse", "--show-toplevel"]))
+    backend = top / "backend"
+    version = (backend / "VERSION").read_text().strip()
+    sha = getone(["git", "rev-parse", "--short", "HEAD"])
+    branch = getone(["git", "branch", "--show-current"], if_none="HEAD")
+    display = f"v{version}-{sha} ({branch})"
+    print(f"VERSION: {display}")
+    log = do(["git", "log", "-n10", "--format=%h###%aN###%aE###%aI###%s"])
+    fields = ("sha", "author", "email", "date", "title")
+    vj = {
+        "version": version,
+        "sha": sha,
+        "branch": branch,
+        "display_version": display,
+        "date": datetime.now(tz=timezone.utc).isoformat(),
+        "changes": [{f: v for f, v in zip(fields, l.split("###"))} for l in log],
+    }
+    with (backend / "version.json").open("w") as verfile:
+        json.dump(vj, fp=verfile)
+    return 0
+
+
+if __name__ == "__main__":
+    try:
+        sys.exit(main())
+    except Exception as exc:
+        print(f"Failed with {str(exc)!r}", file=sys.stderr)
+        sys.exit(1)

backend/tests/e2e_backend.sh

@@ -1,22 +1,29 @@
 #!/bin/bash
 set -e
 
+TOP=$(git rev-parse --show-toplevel)
+BACKEND=${TOP}/backend
+cd ${BACKEND}
+
+echo "generating version file"
+scripts/version.py
+
 echo "building backend image"
-podman build -f backend/backend.containerfile --tag backend ./backend
+podman build -f backend.containerfile --tag backend .
 
 echo "building backend functional test image"
-podman build -f backend/tests/functional.containerfile --tag functional ./backend
+podman build -f tests/functional.containerfile --tag functional .
 
 export POD_NAME="e2e"
 
 echo "cleaning up and recreating pod"
 podman pod rm -f ${POD_NAME}
 podman pod create --name=${POD_NAME} --publish 127.0.0.1:8000:8000 --publish 127.0.0.1:3000:3000
 
-./backend/tests/opensearch_ocp.sh
+./tests/opensearch_ocp.sh
 echo "seeding db"
 podman run --rm --pod=${POD_NAME} --entrypoint python3 functional tests/db_seed.py
 echo "deploying backend"
 podman run -d --pod=${POD_NAME} \
-  -v "$(pwd)/backend/tests/ocpperf_test.toml:/backend/ocpperf.toml:z" \
+  -v "${BACKEND}/tests/ocpperf_test.toml:/backend/ocpperf.toml:z" \
   --name=back backend