test(backend): smoke and endpoint tests (#693)

* test/refactor: remove unused drone endpoints and tests

* refactor: remove unused projects endpoint

* test: update  drone test file ensuring that the drone altitude is fetched correctly

* test: add more smoke tests

* test: fix conftest to return an AuthUser as expected by the endpoints

* build: necessary changes to Dockerfile and compose.test.yaml to allow just command to work correctly

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* build: add healthcheck to stop race condition in CI

* build: optimise backend test command

* test: remove flaky test

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* revert: restore drone routes

* build: use Docker Buildkit

* build: restore old compose.test.yaml

---------

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

Author: stanleypliu

compose.test.yaml

@@ -1,5 +1,4 @@
 # compose.test.yaml
-
 name: dtm-test
 
 volumes:

src/backend/Dockerfile

@@ -1,3 +1,4 @@
+# syntax=docker/dockerfile:1
 # ARG for the base image
 ARG PYTHON_IMG_TAG=3.11
 

src/backend/app/projects/project_routes.py

@@ -959,6 +959,8 @@ async def get_uploaded_parts(
         )
 
 
+# Endpoint not used in production but useful to keep around just for testing the
+# queue
 @router.post("/test/arq_task")
 async def test(redis_pool: ArqRedis = Depends(get_redis_pool)):
     try:
@@ -980,16 +982,3 @@ async def test(redis_pool: ArqRedis = Depends(get_redis_pool)):
             status_code=HTTPStatus.INTERNAL_SERVER_ERROR,
             detail=f"Failed to enqueue task: {str(e)}",
         )
-
-
-@router.post("/projects/{project_id}/count-tasks")
-async def start_task_count(
-    project_id: uuid.UUID, redis: ArqRedis = Depends(get_redis_pool)
-):
-    """Start an async task to count project tasks"""
-    job = await redis.enqueue_job(
-        "count_project_tasks",
-        str(project_id),
-        _queue_name="default_queue",
-    )
-    return {"job_id": job.job_id}

src/backend/tests/conftest.py

@@ -31,20 +31,19 @@ async def db() -> AsyncConnection:
 
 @pytest_asyncio.fixture(scope="function")
 async def auth_user(db) -> AuthUser:
-    """Create a test user."""
-    db_user = await DbUser.get_or_create_user(
-        db,
-        AuthUser(
-            id="101039844375937810000",
-            email="admin@hotosm.org",
-            name="admin",
-            profile_img="",
-            role=UserRole.PROJECT_CREATOR,
-            is_superuser=True,
-        ),
+    """Create a test user and return the AuthUser model."""
+    user_to_create = AuthUser(
+        id="101039844375937810000",
+        email="admin@hotosm.org",
+        name="admin",
+        profile_img="",
+        role=UserRole.PROJECT_CREATOR.name,
+        is_superuser=True,
     )
-    db_user.is_superuser = True
-    return db_user
+    # Ensure the user exists in the DB for endpoints that need it
+    await DbUser.get_or_create_user(db, user_to_create)
+    # Return the AuthUser object, which has .role and .email, as expected by login_required
+    return user_to_create
 
 
 @pytest_asyncio.fixture(scope="function")

src/backend/tests/test_drones_routes.py

@@ -4,26 +4,15 @@
 
 
 @pytest.mark.asyncio
-async def test_create_drone(client, drone_info):
-    """Create a new project."""
-    response = await client.post("/drones/create-drone", json=drone_info)
+async def test_get_drone_altitude_by_country(client):
+    """Test getting drone altitude by country."""
+    country = "canada"
+    response = await client.get(f"/api/drones/drone-altitude/{country}/")
     assert response.status_code == HTTPStatus.OK
 
     return response.json()
 
 
-@pytest.mark.asyncio
-async def test_read_drone(client, drone_info):
-    """Test retrieving a drone record."""
-    response = await client.post("/api/drones/create-drone", json=drone_info)
-    assert response.status_code == HTTPStatus.OK
-    drone_id = response.json().get("drone_id")
-    response = await client.get(f"/api/drones/{drone_id}")
-    assert response.status_code == HTTPStatus.OK
-    drone_data = response.json()
-    assert drone_data.get("model") == drone_info["model"]
-
-
 if __name__ == "__main__":
     """Main func if file invoked directly."""
     pytest.main()

src/backend/tests/test_gcp_routes.py

@@ -0,0 +1,17 @@
+import pytest
+
+from app.models.enums import HTTPStatus
+
+
+@pytest.mark.asyncio
+async def test_find_images_for_a_project(client, create_test_project):
+    """Smoke test for finding images in a project that contain a point."""
+    project_id = create_test_project
+    point_data = {"longitude": 0.0, "latitude": 0.0}
+
+    response = await client.post(
+        f"/api/gcp/find-project-images/?project_id={project_id}",
+        json=point_data,
+    )
+
+    assert response.status_code == HTTPStatus.OK

src/backend/tests/test_projects_routes.py

@@ -63,6 +63,31 @@ async def test_upload_project_task_boundaries(client, create_test_project):
     return response.json()
 
 
+@pytest.mark.asyncio
+async def test_read_projects(client):
+    """Test reading all projects."""
+    response = await client.get("/api/projects/")
+    assert response.status_code == 200
+    assert "results" in response.json()
+
+
+@pytest.mark.asyncio
+async def test_read_project(client, create_test_project):
+    """Test reading a single project."""
+    project_id = create_test_project
+    response = await client.get(f"/api/projects/{project_id}")
+    assert response.status_code == 200
+    assert response.json()["id"] == project_id
+
+
+@pytest.mark.asyncio
+async def test_read_project_centroids(client):
+    """Test reading project centroids."""
+    response = await client.get("/api/projects/centroids")
+    assert response.status_code == 200
+    assert isinstance(response.json(), list)
+
+
 if __name__ == "__main__":
     """Main func if file invoked directly."""
     pytest.main()

src/backend/tests/test_tasks_routes.py

@@ -1,12 +1,10 @@
-import uuid
-
 import pytest
 
 
 @pytest.mark.asyncio
-async def test_read_task(client):
-    task_id = uuid.uuid4()
-    response = await client.get(f"/api/tasks/{task_id}")
+async def test_list_tasks(client):
+    """Test listing tasks for the authenticated user."""
+    response = await client.get("/api/tasks/")
     assert response.status_code == 200
 
 

src/backend/tests/test_users_routes.py

@@ -1,29 +1,33 @@
-from datetime import datetime, timedelta
-
-import jwt
 import pytest
-import pytest_asyncio
 from loguru import logger as log
 
-from app.config import settings
 from app.users.user_deps import create_reset_password_token
 
 
-@pytest_asyncio.fixture(scope="function")
-def token(auth_user):
-    """Create a reset password token for a given user."""
-    payload = {
-        "sub": auth_user.email_address,
-        "exp": datetime.utcnow()
-        + timedelta(minutes=settings.RESET_PASSWORD_TOKEN_EXPIRE_MINUTES),
-    }
-    return jwt.encode(payload, settings.SECRET_KEY, algorithm=settings.ALGORITHM)
+@pytest.mark.asyncio
+async def test_my_info(client):
+    """Test the /my-info/ endpoint to ensure a logged-in user can fetch their data."""
+    response = await client.get("/api/users/my-info/")
+    assert response.status_code == 200
+    user_info = response.json()
+
+    assert user_info["email_address"] == "admin@hotosm.org"
+
+
+@pytest.mark.asyncio
+async def test_refresh_token(client):
+    """Test the /refresh-token endpoint to ensure a new access token can be obtained."""
+    response = await client.get("/api/users/refresh-token")
+    assert response.status_code == 200
+    token_data = response.json()
+    assert "access_token" in token_data
+    assert "refresh_token" in token_data
 
 
 @pytest.mark.asyncio
 async def test_reset_password_success(client, auth_user):
     """Test successful password reset using a valid token."""
-    token = create_reset_password_token(auth_user.email_address)
+    token = create_reset_password_token(auth_user.email)
     new_password = "QPassword@12334"
 
     response = await client.post(

tasks/test/Justfile

@@ -27,17 +27,13 @@ default:
 # Test backend
 [no-cd]
 backend:
-    just build backend
-
-    # Start services
     {{docker}} compose -f compose.test.yaml build backend
 
-    {{docker}} compose -f compose.test.yaml up --detach db redis minio nodeodm
+    {{docker}} compose -f compose.test.yaml up --detach db redis minio nodeodm arq-worker
 
+    {{docker}} compose -f compose.test.yaml run --rm createbuckets
     {{docker}} compose -f compose.test.yaml run --rm migrations
 
-    {{docker}} compose -f compose.test.yaml up --detach
-
     {{docker}} compose -f compose.test.yaml run --rm backend pytest
 
     {{docker}} compose -f compose.test.yaml down