Merge pull request #1 from mudhoney/feature/multiple-hgs-conversion

implement post hgs2hpc conversion api endpoints and tests for it

Author: dgarciabriseno

.github/workflows/build_and_push.yml

@@ -0,0 +1,44 @@
+name: Build and Push to Docker Hub
+
+on:
+  push:
+    branches: [ "main" ]
+    tags:
+      - v**
+
+jobs:
+  # Build and push containers to Docker Hub
+  docker:
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v4
+    - name: Set up QEMU
+      uses: docker/setup-qemu-action@v3
+    - name: Set up Docker Buildx
+      uses: docker/setup-buildx-action@v3
+    - name: Login to Docker Hub
+      uses: docker/login-action@v3
+      with:
+        username: ${{ secrets.DOCKERHUB_USERNAME }}
+        password: ${{ secrets.DOCKERHUB_TOKEN }}
+    - name: Docker meta
+      id: meta
+      uses: docker/metadata-action@v5
+      with:
+        images: dgarciabriseno/hv-coordinator
+        # generate Docker tags based on the tagged release
+        tags: type=semver,pattern={{version}}
+    - name: Build and push Docker images
+      uses: docker/build-push-action@v5.3.0
+      with:
+        # Build's context is the set of files located in the specified PATH or URL
+        context: app
+        # List of target platforms for build
+        platforms: linux/amd64,linux/arm64
+        # List of tags
+        tags: ${{ steps.meta.outputs.tags }}
+        labels: ${{ steps.meta.outputs.labels }}
+        # Only push containers on version tags
+        push: ${{ github.event_name == 'push' && github.ref_type == 'tag'}}

.github/workflows/workflow.yml

@@ -1,10 +1,6 @@
-name: Test and Deploy
+name: Test and Build
 
 on:
-  push:
-    branches: [ "main" ]
-    tags:
-      - v**
   pull_request:
     branches: [ "main" ]
 
@@ -60,7 +56,7 @@ jobs:
         retention-days: 30
 
 
-  # Build and push containers to docker
+  # Build Docker images to verify they can be built
   docker:
     runs-on: ubuntu-latest
 
@@ -71,28 +67,14 @@ jobs:
       uses: docker/setup-qemu-action@v3
     - name: Set up Docker Buildx
       uses: docker/setup-buildx-action@v3
-    - name: Login to Docker Hub
-      uses: docker/login-action@v3
-      with:
-        username: ${{ secrets.DOCKERHUB_USERNAME }}
-        password: ${{ secrets.DOCKERHUB_TOKEN }}
-    - name: Docker meta
-      id: meta
-      uses: docker/metadata-action@v5
-      with:
-        images: dgarciabriseno/hv-coordinator
-        # generate Docker tags based on the tagged release
-        tags: type=semver,pattern={{version}}
-    - name: Build and push Docker images
+    - name: Build Docker images
       uses: docker/build-push-action@v5.3.0
       with:
         # Build's context is the set of files located in the specified PATH or URL
         context: app
         # List of target platforms for build
         platforms: linux/amd64,linux/arm64
-        # List of tags
-        tags: ${{ steps.meta.outputs.tags }}
-        labels: ${{ steps.meta.outputs.labels }}
-        # Only push containers on version tags
-        push: ${{ github.event_name == 'push' && github.ref_type == 'tag'}}
+        # Don't push, just build to verify
+        push: false
+        tags: hv-coordinator:buildtest
 

app/main.py

@@ -47,6 +47,31 @@ def _hgs2hpc(params: Annotated[Hgs2HpcQueryParameters, Query()]):
     return {"x": coord.Tx.value, "y": coord.Ty.value}
 
 
+class Hgs2HpcCoordInput(HvBaseModel):
+    lat: float = Field(ge=-90, le=90)
+    lon: float
+    coord_time: AstropyTime
+
+
+class Hgs2HpcBatchInput(HvBaseModel):
+    coordinates: List[Hgs2HpcCoordInput]
+    target: AstropyTime
+
+
+@app.post(
+    "/hgs2hpc",
+    summary="Convert Heliographic Stonyhurst coordinate to Helioprojective coordinate in Helioviewer's POV",
+)
+def _hgs2hpc_post(params: Hgs2HpcBatchInput):
+    "Convert a latitude/longitude coordinate to the equivalent helioprojective coordinate at the given target time"
+    coords = map(
+        lambda c: hgs2hpc(c.lat, c.lon, c.coord_time, params.target), params.coordinates
+    )
+    return {
+        "coordinates": [{"x": coord.Tx.value, "y": coord.Ty.value} for coord in coords]
+    }
+
+
 class NormalizeHpcQueryParameters(HvBaseModel):
     x: float
     y: float

app/test/test_api.py

@@ -94,6 +94,117 @@ def test_hgs2hpc(client: TestClient):
     assert data["detail"][0]["loc"][1] == "lat"
 
 
+def test_hgs2hpc_post(client: TestClient):
+    """
+    Test POST /hgs2hpc endpoint with batch coordinate conversion
+    """
+    # Test valid batch request
+    batch_data = {
+        "coordinates": [
+            {"lat": 0.0, "lon": 0.0, "coord_time": "2012-01-01T00:00:00Z"},
+            {"lat": 10.0, "lon": 20.0, "coord_time": "2012-01-01T00:00:00Z"},
+        ],
+        "target": "2012-01-01T00:00:00Z",
+    }
+    response = client.post("/hgs2hpc", json=batch_data)
+    assert response.status_code == 200
+    data = response.json()
+    assert "coordinates" in data
+    assert len(data["coordinates"]) == 2
+    assert pytest.approx(data["coordinates"][0]["x"], abs=0.1) == 0
+    assert pytest.approx(data["coordinates"][0]["y"], abs=50) == 49.558
+    assert pytest.approx(data["coordinates"][1]["x"], abs=0.1) == 324.471
+    assert pytest.approx(data["coordinates"][1]["y"], abs=50) == 212.902
+
+    # Test with differential rotation (target time different from coord_time)
+    batch_data = {
+        "coordinates": [
+            {"lat": 0.0, "lon": 0.0, "coord_time": "2012-01-01T00:00:00Z"},
+        ],
+        "target": "2012-01-01T01:00:00Z",
+    }
+    response = client.post("/hgs2hpc", json=batch_data)
+    assert response.status_code == 200
+    data = response.json()
+    assert len(data["coordinates"]) == 1
+    # The x coordinate should move approximately 9 arcseconds
+    assert 9 < data["coordinates"][0]["x"] and data["coordinates"][0]["x"] < 10
+
+    # Test missing coordinates field
+    response = client.post("/hgs2hpc", json={"target": "2012-01-01T00:00:00Z"})
+    assert response.status_code == 422
+
+    # Test missing target field
+    response = client.post(
+        "/hgs2hpc",
+        json={
+            "coordinates": [
+                {"lat": 0.0, "lon": 0.0, "coord_time": "2012-01-01T00:00:00Z"}
+            ]
+        },
+    )
+    assert response.status_code == 422
+
+    # Test invalid latitude (> 90)
+    batch_data = {
+        "coordinates": [
+            {"lat": 90.1, "lon": 0.0, "coord_time": "2012-01-01T00:00:00Z"}
+        ],
+        "target": "2012-01-01T00:00:00Z",
+    }
+    response = client.post("/hgs2hpc", json=batch_data)
+    assert response.status_code == 422
+    data = response.json()
+    assert data["detail"][0]["loc"][-1] == "lat"
+
+    # Test invalid latitude (< -90)
+    batch_data = {
+        "coordinates": [
+            {"lat": -90.1, "lon": 0.0, "coord_time": "2012-01-01T00:00:00Z"}
+        ],
+        "target": "2012-01-01T00:00:00Z",
+    }
+    response = client.post("/hgs2hpc", json=batch_data)
+    assert response.status_code == 422
+    data = response.json()
+    assert data["detail"][0]["loc"][-1] == "lat"
+
+    # Test invalid time format
+    batch_data = {
+        "coordinates": [{"lat": 0.0, "lon": 0.0, "coord_time": "NotAValidTime"}],
+        "target": "2012-01-01T00:00:00Z",
+    }
+    response = client.post("/hgs2hpc", json=batch_data)
+    assert response.status_code == 422
+
+    # Test empty coordinates array
+    batch_data = {"coordinates": [], "target": "2012-01-01T00:00:00Z"}
+    response = client.post("/hgs2hpc", json=batch_data)
+    assert response.status_code == 200
+    data = response.json()
+    assert len(data["coordinates"]) == 0
+
+    # Test multiple coordinates with different coord_times
+    batch_data = {
+        "coordinates": [
+            {"lat": 11.0, "lon": 21.0, "coord_time": "2024-01-01T00:00:00"},
+            {"lat": 15.0, "lon": 26.0, "coord_time": "2025-01-01T00:00:00"},
+            {"lat": 11.0, "lon": 21.0, "coord_time": "2022-01-01T00:00:00"},
+        ],
+        "target": "2024-01-02T00:00:00",
+    }
+    response = client.post("/hgs2hpc", json=batch_data)
+    assert response.status_code == 200
+    data = response.json()
+    assert len(data["coordinates"]) == 3
+    # Verify all coordinates have x and y values
+    for coord in data["coordinates"]:
+        assert "x" in coord
+        assert "y" in coord
+        assert isinstance(coord["x"], (int, float))
+        assert isinstance(coord["y"], (int, float))
+
+
 def test_healthcheck(client: TestClient):
     assert client.get("/health-check").text == '"success"'
 
@@ -145,7 +256,7 @@ def test_gse_errors(client: TestClient):
     assert response.status_code == 422
 
     # Test invalid JSON
-    response = client.post("/gse2frame", data=b"invalid json")
+    response = client.post("/gse2frame", content=b"invalid json")
     assert response.status_code == 422
 
     # Test missing required field