feat: add validation via stac-api-validator

Includes a local validation script and a CI job.

Author: gadomski

.github/workflows/cicd.yaml

@@ -1,16 +1,16 @@
 name: stac-fastapi
 on:
   push:
-    branches: [ master ]
+    branches: [master]
   pull_request:
-    branches: [ master ]
+    branches: [master]
 
 jobs:
   test:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: [ '3.8', '3.9', '3.10']
+        python-version: ["3.8", "3.9", "3.10"]
     timeout-minutes: 10
 
     services:
@@ -118,9 +118,69 @@ jobs:
           POSTGRES_HOST_READER: localhost
           POSTGRES_HOST_WRITER: localhost
           POSTGRES_PORT: 5432
+
+  validate:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        backend: ["sqlalchemy", "pgstac"]
+    services:
+      pgstac:
+        image: ghcr.io/stac-utils/pgstac:v0.6.11
+        env:
+          POSTGRES_USER: username
+          POSTGRES_PASSWORD: password
+          POSTGRES_DB: postgis
+          PGUSER: username
+          PGPASSWORD: password
+          PGDATABASE: postgis
+        options: >-
+          --health-cmd pg_isready
+          --health-interval 10s
+          --health-timeout 5s
+          --health-retries 5
+        ports:
+          - 5432:5432
+    steps:
+      - name: Check out repository code
+        uses: actions/checkout@v3
+      - name: Setup Python
+        uses: actions/setup-python@v3
+        with:
+          python-version: "3.10"
+          cache: pip
+          cache-dependency-path: stac_fastapi/pgstac/setup.cfg
+      - name: Install stac-fastapi and stac-api-validator
+        run: pip install ./stac_fastapi/api ./stac_fastapi/types ./stac_fastapi/${{ matrix.backend }}[server] stac-api-validator==0.4.1
+      - name: Run migration
+        if: ${{ matrix.backend == 'sqlalchemy' }}
+        run: cd stac_fastapi/sqlalchemy && alembic upgrade head
+        env:
+          POSTGRES_USER: username
+          POSTGRES_PASS: password
+          POSTGRES_DBNAME: postgis
+          POSTGRES_HOST: localhost
+          POSTGRES_PORT: 5432
+      - name: Load data and validate
+        run: python -m stac_fastapi.${{ matrix.backend }}.app & ./scripts/wait-for-it.sh localhost:8080 && python ./scripts/ingest_joplin.py http://localhost:8080 && ./scripts/validate http://localhost:8080
+        env:
+          POSTGRES_USER: username
+          POSTGRES_PASS: password
+          POSTGRES_DBNAME: postgis
+          POSTGRES_HOST_READER: localhost
+          POSTGRES_HOST_WRITER: localhost
+          POSTGRES_PORT: 5432
+          PGUSER: username
+          PGPASSWORD: password
+          PGHOST: localhost
+          PGDATABASE: postgis
+          APP_HOST: 0.0.0.0
+          APP_PORT: 8080
+
   test-docs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v3
       - name: Test generating docs
-        run: make docs
+        run: make docs

scripts/validate

@@ -0,0 +1,28 @@
+#!/usr/bin/env sh
+#
+# Validate a STAC server using [stac-api-validator](https://github.com/stac-utils/stac-api-validator).
+#
+# Assumptions:
+#
+#   - You have stac-api-validator installed, e.g. via `pip install stac-api-validator`
+#   - You've loaded the joplin data, probably using `python ./scripts/ingest_joplin.py http://localhost:8080``
+#
+# Currently, item-search is not checked, because it crashes stac-api-validator (probably a problem on our side).
+
+set -e
+
+if [ $# -eq 0 ]; then
+    root_url=http://localhost:8080
+else
+    root_url="$1"
+fi
+geometry='{"type":"Polygon","coordinates":[[[-94.6884155,37.0595608],[-94.6884155,37.0332547],[-94.6554565,37.0332547],[-94.6554565,37.0595608],[-94.6884155,37.0595608]]]}'
+
+stac-api-validator --root-url "$root_url" \
+    --conformance core \
+    --conformance collections \
+    --collection joplin \
+    --conformance features \
+    --geometry "$geometry" \
+    --conformance filter
+    # --conformance item-search \   # currently breaks stac-api-validator