add test and ci

Author: vincentsarago

.github/codecov.yml

@@ -0,0 +1,8 @@
+comment: off
+
+coverage:
+    status:
+        project:
+            default:
+                target: auto
+                threshold: 5

.github/dependabot.yml

@@ -0,0 +1,14 @@
+# Set update schedule for GitHub Actions
+
+version: 2
+updates:
+
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      # Check for updates to GitHub Actions every week
+      interval: "weekly"
+    groups:
+      all:
+        patterns:
+        - "*"

.github/workflows/ci.yml

@@ -0,0 +1,57 @@
+name: CI
+
+# On every pull request, but only on push to main
+on:
+  push:
+    branches:
+    - main
+    tags:
+    - '*'
+    paths:
+      # Only run test and docker publish if somde code have changed
+      - 'pyproject.toml'
+      - 'setup.py'
+      - 'stac_fastapi/**'
+      - 'tests/**'
+      - '.pre-commit-config.yaml'
+      - '.github/workflows/ci.yml'
+  pull_request:
+env:
+  LATEST_PY_VERSION: '3.13'
+
+jobs:
+  tests:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ['3.9', '3.10', '3.11', '3.12', '3.13']
+
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          python -m pip install .["test"]
+
+      - name: Run pre-commit
+        if: ${{ matrix.python-version == env.LATEST_PY_VERSION }}
+        run: |
+          python -m pip install pre-commit
+          pre-commit run --all-files
+
+      - name: Run tests
+        run: python -m pytest --cov stac_fastapi_html --cov-report xml --cov-report term-missing --asyncio-mode=strict
+
+      - name: Upload Results
+        if: ${{ matrix.python-version == env.LATEST_PY_VERSION }}
+        uses: codecov/codecov-action@v5
+        with:
+          file: ./coverage.xml
+          flags: unittests
+          name: ${{ matrix.python-version }}
+          fail_ci_if_error: false

setup.py

@@ -6,17 +6,20 @@
     desc = f.read()
 
 install_requires = [
-    "stac-fastapi.api",
+    "starlette",
     "jinja2>=2.11.2,<4.0.0",
 ]
 
 extra_reqs = {
-    "dev": [
+    "test": [
         "pytest",
         "pytest-cov",
         "pytest-asyncio",
         "httpx",
+    ],
+    "dev": [
         "pre-commit",
+        "bump-my-version",
     ],
 }
 

stac_fastapi/html/middleware.py

@@ -1,16 +1,19 @@
 """stac-fastapi HTML middlewares."""
 
+from __future__ import annotations
+
 import json
 import re
 from dataclasses import dataclass, field
-from typing import Any, List, Optional
+from typing import TYPE_CHECKING, Any, List, Optional
 
 import jinja2
-from stac_pydantic.shared import MimeTypes
 from starlette.datastructures import MutableHeaders
 from starlette.requests import Request
 from starlette.templating import Jinja2Templates
-from starlette.types import ASGIApp, Message, Receive, Scope, Send
+
+if TYPE_CHECKING:
+    from starlette.types import ASGIApp, Message, Receive, Scope, Send
 
 jinja2_env = jinja2.Environment(
     loader=jinja2.ChoiceLoader(
@@ -46,6 +49,9 @@ def preferred_encoding(accept: str) -> Optional[List[str]]:
     """
     accept_values = {}
     for m in accept.replace(" ", "").split(","):
+        if not m:
+            continue
+
         values = m.split(";")
         if len(values) == 1:
             name = values[0]
@@ -78,6 +84,7 @@ class HTMLRenderMiddleware:
 
     app: ASGIApp
     templates: Jinja2Templates = field(default_factory=lambda: DEFAULT_TEMPLATES)
+    endpoints_names: dict[str, str] = field(default_factory=lambda: ENDPOINT_TEMPLATES)
 
     def create_html_response(
         self,
@@ -89,7 +96,7 @@ def create_html_response(
         **kwargs: Any,
     ) -> bytes:
         """Create Template response."""
-        router_prefix = request.app.state.router_prefix
+        router_prefix = getattr(request.app.state, "router_prefix", None)
 
         urlpath = request.url.path
         if root_path := request.app.root_path:
@@ -167,23 +174,25 @@ async def send_as_html(message: Message):
             request = Request(scope, receive=receive)
             pref_encoding = preferred_encoding(request.headers.get("accept", "")) or []
 
-            output_type: Optional[MimeTypes] = None
+            encode_to_html = False
             if request.query_params.get("f", "") == "html":
-                output_type = MimeTypes.html
-            elif "text/html" in pref_encoding and not request.query_params.get("f", ""):
-                output_type = MimeTypes.html
-
-            if start_message["status"] == 200 and output_type:
-                headers = MutableHeaders(scope=start_message)
-                if tpl := ENDPOINT_TEMPLATES.get(scope["route"].name):
-                    headers["content-type"] = "text/html"
+                encode_to_html = True
+            elif (
+                "text/html" in pref_encoding or "*" in pref_encoding
+            ) and not request.query_params.get("f", ""):
+                encode_to_html = True
+
+            if start_message["status"] == 200 and encode_to_html:
+                # NOTE: `scope["route"]` seems to be specific to FastAPI application
+                if tpl := self.endpoints_names.get(scope["route"].name):
                     body = self.create_html_response(
                         request,
                         json.loads(body.decode()),
                         template_name=tpl,
                         title=scope["route"].name,
                     )
-                    headers["Content-Encoding"] = "text/html"
+                    headers = MutableHeaders(scope=start_message)
+                    headers["Content-Type"] = "text/html"
                     headers["Content-Length"] = str(len(body))
 
             # Send http.response.start

tests/conftest.py

@@ -0,0 +1,26 @@
+{
+    "$id": "http://127.0.0.1:8000//collections/my_collection/queryables",
+    "type": "object",
+    "title": "STAC Queryables.",
+    "$schema": "http://json-schema.org/draft-07/schema#",
+    "properties": {
+      "id": {
+        "$ref": "https://schemas.stacspec.org/v1.0.0/item-spec/json-schema/item.json#/definitions/core/allOf/2/properties/id",
+        "title": "Item ID",
+        "description": "Item identifier"
+      },
+      "datetime": {
+        "type": "string",
+        "title": "Acquired",
+        "format": "date-time",
+        "pattern": "(+00:00|Z)$",
+        "description": "Datetime"
+      },
+      "geometry": {
+        "$ref": "https://geojson.org/schema/Feature.json",
+        "title": "Item Geometry",
+        "description": "Item Geometry"
+      }
+    },
+    "additionalProperties": true
+}

tests/fixtures/collection_queryables.json

@@ -0,0 +1,65 @@
+{
+    "collections": [
+      {
+        "id": "my_collection",
+        "type": "Collection",
+        "links": [
+          {
+            "rel": "items",
+            "type": "application/geo+json",
+            "href": "http://127.0.0.1:8000/collections/my_collection/items"
+          },
+          {
+            "rel": "parent",
+            "type": "application/json",
+            "href": "http://127.0.0.1:8000/"
+          },
+          {
+            "rel": "root",
+            "type": "application/json",
+            "href": "http://127.0.0.1:8000/"
+          },
+          {
+            "rel": "self",
+            "type": "application/json",
+            "href": "http://127.0.0.1:8000/collections/my_collection"
+          },
+          {
+            "rel": "license",
+            "href": "https://creativecommons.org/licenses/publicdomain/",
+            "title": "public domain"
+          },
+          {
+            "rel": "http://www.opengis.net/def/rel/ogc/1.0/queryables",
+            "type": "application/schema+json",
+            "title": "Queryables",
+            "href": "http://127.0.0.1:8000/collections/my_collection/queryables"
+          }
+        ],
+        "extent": {
+          "spatial": {
+            "bbox": [[]]
+          },
+          "temporal": {
+            "interval": [[]]
+          }
+        },
+        "license": "public-domain",
+        "description": "My Collection",
+        "stac_version": "1.0.0"
+      }
+    ],
+    "links": [
+      {
+        "rel": "root",
+        "type": "application/json",
+        "href": "http://127.0.0.1:8000/"
+      },
+      {
+        "rel": "self",
+        "type": "application/json",
+        "href": "http://127.0.0.1:8000/collections"
+      }
+    ],
+    "numberReturned": 1
+}

tests/fixtures/collections.json

@@ -0,0 +1,32 @@
+{
+    "conformsTo": [
+      "http://www.opengis.net/spec/cql2/1.0/conf/basic-cql2",
+      "http://www.opengis.net/spec/cql2/1.0/conf/cql2-json",
+      "http://www.opengis.net/spec/cql2/1.0/conf/cql2-text",
+      "http://www.opengis.net/spec/ogcapi-common-2/1.0/conf/simple-query",
+      "http://www.opengis.net/spec/ogcapi-features-1/1.0/conf/core",
+      "http://www.opengis.net/spec/ogcapi-features-1/1.0/conf/geojson",
+      "http://www.opengis.net/spec/ogcapi-features-1/1.0/conf/oas30",
+      "http://www.opengis.net/spec/ogcapi-features-3/1.0/conf/features-filter",
+      "http://www.opengis.net/spec/ogcapi-features-3/1.0/conf/filter",
+      "https://api.stacspec.org/v1.0.0-rc.1/collection-search",
+      "https://api.stacspec.org/v1.0.0-rc.1/collection-search#fields",
+      "https://api.stacspec.org/v1.0.0-rc.1/collection-search#filter",
+      "https://api.stacspec.org/v1.0.0-rc.1/collection-search#free-text",
+      "https://api.stacspec.org/v1.0.0-rc.1/collection-search#query",
+      "https://api.stacspec.org/v1.0.0-rc.1/collection-search#sort",
+      "https://api.stacspec.org/v1.0.0-rc.2/item-search#filter",
+      "https://api.stacspec.org/v1.0.0/collections",
+      "https://api.stacspec.org/v1.0.0/collections/extensions/transaction",
+      "https://api.stacspec.org/v1.0.0/core",
+      "https://api.stacspec.org/v1.0.0/item-search",
+      "https://api.stacspec.org/v1.0.0/item-search#fields",
+      "https://api.stacspec.org/v1.0.0/item-search#query",
+      "https://api.stacspec.org/v1.0.0/item-search#sort",
+      "https://api.stacspec.org/v1.0.0/ogcapi-features",
+      "https://api.stacspec.org/v1.0.0/ogcapi-features#fields",
+      "https://api.stacspec.org/v1.0.0/ogcapi-features#query",
+      "https://api.stacspec.org/v1.0.0/ogcapi-features#sort",
+      "https://api.stacspec.org/v1.0.0/ogcapi-features/extensions/transaction"
+    ]
+}