Split up integration tests into individual files

tests_integration/tests/spool/__init__.py

@@ -0,0 +1 @@
+"""Tests for the spool API."""

tests_integration/tests/spool/test_add.py

@@ -0,0 +1,182 @@
+"""Integration tests for the Spool API endpoint."""
+
+from typing import Any
+
+import httpx
+import pytest
+
+from tests.conftest import length_from_weight
+
+URL = "http://spoolman:8000"
+
+
+def test_add_spool_remaining_weight(random_filament: dict[str, Any]):
+    """Test adding a spool to the database."""
+    # Execute
+    remaining_weight = 750
+    location = "The Pantry"
+    lot_nr = "123456789"
+    comment = "abcdefghåäö"
+    archived = True
+    result = httpx.post(
+        f"{URL}/api/v1/spool",
+        json={
+            "first_used": "2023-01-02T12:00:00+01:00",
+            "last_used": "2023-01-02T11:00:00Z",
+            "filament_id": random_filament["id"],
+            "remaining_weight": remaining_weight,
+            "location": location,
+            "lot_nr": lot_nr,
+            "comment": comment,
+            "archived": archived,
+        },
+    )
+    result.raise_for_status()
+
+    # Verify
+    used_weight = random_filament["weight"] - remaining_weight
+    used_length = length_from_weight(
+        weight=used_weight,
+        density=random_filament["density"],
+        diameter=random_filament["diameter"],
+    )
+    remaining_length = length_from_weight(
+        weight=remaining_weight,
+        density=random_filament["density"],
+        diameter=random_filament["diameter"],
+    )
+
+    spool = result.json()
+    assert spool == {
+        "id": spool["id"],
+        "registered": spool["registered"],
+        "first_used": "2023-01-02T11:00:00",
+        "last_used": "2023-01-02T11:00:00",
+        "filament": random_filament,
+        "remaining_weight": pytest.approx(remaining_weight),
+        "used_weight": pytest.approx(used_weight),
+        "remaining_length": pytest.approx(remaining_length),
+        "used_length": pytest.approx(used_length),
+        "location": location,
+        "lot_nr": lot_nr,
+        "comment": comment,
+        "archived": archived,
+    }
+
+    # Clean up
+    httpx.delete(f"{URL}/api/v1/spool/{spool['id']}").raise_for_status()
+
+
+def test_add_spool_used_weight(random_filament: dict[str, Any]):
+    """Test adding a spool to the database."""
+    # Execute
+    first_used = "2023-01-01T00:00:00"
+    last_used = "2023-01-02T00:00:00"
+    used_weight = 250
+    location = "The Pantry"
+    lot_nr = "123456789"
+    comment = "abcdefghåäö"
+    archived = True
+    result = httpx.post(
+        f"{URL}/api/v1/spool",
+        json={
+            "first_used": first_used,
+            "last_used": last_used,
+            "filament_id": random_filament["id"],
+            "used_weight": used_weight,
+            "location": location,
+            "lot_nr": lot_nr,
+            "comment": comment,
+            "archived": archived,
+        },
+    )
+    result.raise_for_status()
+
+    # Verify
+    remaining_weight = random_filament["weight"] - used_weight
+    used_length = length_from_weight(
+        weight=used_weight,
+        density=random_filament["density"],
+        diameter=random_filament["diameter"],
+    )
+    remaining_length = length_from_weight(
+        weight=remaining_weight,
+        density=random_filament["density"],
+        diameter=random_filament["diameter"],
+    )
+
+    spool = result.json()
+    assert spool == {
+        "id": spool["id"],
+        "registered": spool["registered"],
+        "first_used": first_used,
+        "last_used": last_used,
+        "filament": random_filament,
+        "remaining_weight": pytest.approx(remaining_weight),
+        "used_weight": pytest.approx(used_weight),
+        "remaining_length": pytest.approx(remaining_length),
+        "used_length": pytest.approx(used_length),
+        "location": location,
+        "lot_nr": lot_nr,
+        "comment": comment,
+        "archived": archived,
+    }
+
+    # Clean up
+    httpx.delete(f"{URL}/api/v1/spool/{spool['id']}").raise_for_status()
+
+
+def test_add_spool_required(random_filament: dict[str, Any]):
+    """Test adding a spool with only the required fields to the database."""
+    # Execute
+    used_weight = 250
+    result = httpx.post(
+        f"{URL}/api/v1/spool",
+        json={
+            "filament_id": random_filament["id"],
+            "used_weight": used_weight,
+        },
+    )
+    result.raise_for_status()
+
+    # Verify
+    remaining_weight = random_filament["weight"] - used_weight
+    used_length = length_from_weight(
+        weight=used_weight,
+        density=random_filament["density"],
+        diameter=random_filament["diameter"],
+    )
+    remaining_length = length_from_weight(
+        weight=remaining_weight,
+        density=random_filament["density"],
+        diameter=random_filament["diameter"],
+    )
+
+    spool = result.json()
+    assert spool == {
+        "id": spool["id"],
+        "registered": spool["registered"],
+        "filament": random_filament,
+        "used_weight": pytest.approx(used_weight),
+        "remaining_weight": pytest.approx(remaining_weight),
+        "used_length": pytest.approx(used_length),
+        "remaining_length": pytest.approx(remaining_length),
+        "archived": False,
+    }
+
+    # Clean up
+    httpx.delete(f"{URL}/api/v1/spool/{spool['id']}").raise_for_status()
+
+
+def test_add_spool_both_used_and_remaining_weight(random_filament: dict[str, Any]):
+    """Test adding a spool to the database."""
+    # Execute
+    result = httpx.post(
+        f"{URL}/api/v1/spool",
+        json={
+            "filament_id": random_filament["id"],
+            "remaining_weight": 750,
+            "used_weight": 250,
+        },
+    )
+    assert result.status_code == 400  # Cannot set both used and remaining weight

tests_integration/tests/spool/test_delete.py

@@ -0,0 +1,43 @@
+"""Integration tests for the Spool API endpoint."""
+
+from typing import Any
+
+import httpx
+
+URL = "http://spoolman:8000"
+
+
+def test_delete_spool(random_filament: dict[str, Any]):
+    """Test deleting a spool from the database."""
+    # Setup
+    result = httpx.post(
+        f"{URL}/api/v1/spool",
+        json={
+            "filament_id": random_filament["id"],
+            "remaining_weight": 1000,
+            "location": "The Pantry",
+            "lot_nr": "123456789",
+        },
+    )
+    result.raise_for_status()
+    spool = result.json()
+
+    # Execute
+    httpx.delete(f"{URL}/api/v1/spool/{spool['id']}").raise_for_status()
+
+    # Verify
+    result = httpx.get(f"{URL}/api/v1/spool/{spool['id']}")
+    assert result.status_code == 404
+
+
+def test_delete_spool_not_found():
+    """Test deleting a spool that does not exist."""
+    # Execute
+    result = httpx.delete(f"{URL}/api/v1/spool/123456789")
+
+    # Verify
+    assert result.status_code == 404
+    message = result.json()["message"].lower()
+    assert "spool" in message
+    assert "id" in message
+    assert "123456789" in message

tests_integration/tests/spool/test_find.py

@@ -0,0 +1,167 @@
+"""Integration tests for the Spool API endpoint."""
+
+from typing import Any
+
+import httpx
+
+URL = "http://spoolman:8000"
+
+
+def test_find_spools(random_filament: dict[str, Any]):  # noqa: PLR0915
+    """Test finding spools in the database."""
+    # Setup
+    result = httpx.post(
+        f"{URL}/api/v1/spool",
+        json={
+            "filament_id": random_filament["id"],
+            "remaining_weight": 1000,
+            "location": "The Pantry",
+            "lot_nr": "123456789",
+        },
+    )
+    result.raise_for_status()
+    spool_1 = result.json()
+
+    result = httpx.post(
+        f"{URL}/api/v1/spool",
+        json={
+            "filament_id": random_filament["id"],
+            "remaining_weight": 1000,
+            "location": "Living Room",
+            "lot_nr": "987654321",
+        },
+    )
+    result.raise_for_status()
+    spool_2 = result.json()
+
+    result = httpx.post(
+        f"{URL}/api/v1/spool",
+        json={
+            "filament_id": random_filament["id"],
+            "remaining_weight": 1000,
+            "archived": True,
+        },
+    )
+    result.raise_for_status()
+    spool_3 = result.json()
+
+    added_spools_by_id = {
+        spool_1["id"]: spool_1,
+        spool_2["id"]: spool_2,
+        spool_3["id"]: spool_3,
+    }
+
+    # Execute - find all spools
+    result = httpx.get(f"{URL}/api/v1/spool")
+    result.raise_for_status()
+
+    # Verify
+    spools = result.json()
+    assert len(spools) == 2
+    for spool in spools:
+        assert spool == added_spools_by_id[spool["id"]]
+        assert spool["archived"] is False
+
+    # Execute - find all spools, including archived
+    result = httpx.get(f"{URL}/api/v1/spool?allow_archived=true")
+    result.raise_for_status()
+
+    # Verify
+    spools = result.json()
+    assert len(spools) == 3
+    for spool in spools:
+        assert spool == added_spools_by_id[spool["id"]]
+
+    # Execute - find spools by filament name
+    result = httpx.get(
+        f"{URL}/api/v1/spool",
+        params={"filament_name": random_filament["name"]},
+    )
+    result.raise_for_status()
+
+    # Verify
+    spools = result.json()
+    assert len(spools) == 2
+    for spool in spools:
+        assert spool == added_spools_by_id[spool["id"]]
+
+    # Execute - find spools by filament id
+    result = httpx.get(
+        f"{URL}/api/v1/spool",
+        params={"filament_id": random_filament["id"]},
+    )
+    result.raise_for_status()
+
+    # Verify
+    spools = result.json()
+    assert len(spools) == 2
+    for spool in spools:
+        assert spool == added_spools_by_id[spool["id"]]
+
+    # Execute - find spools by filament material
+    result = httpx.get(
+        f"{URL}/api/v1/spool",
+        params={"filament_material": random_filament["material"]},
+    )
+    result.raise_for_status()
+
+    # Verify
+    spools = result.json()
+    assert len(spools) == 2
+    for spool in spools:
+        assert spool == added_spools_by_id[spool["id"]]
+
+    # Execute - find spools by filament vendor name
+    result = httpx.get(
+        f"{URL}/api/v1/spool",
+        params={"vendor_name": random_filament["vendor"]["name"]},
+    )
+    result.raise_for_status()
+
+    # Verify
+    spools = result.json()
+    assert len(spools) == 2
+    for spool in spools:
+        assert spool == added_spools_by_id[spool["id"]]
+
+    # Execute - find spools by filament vendor id
+    result = httpx.get(
+        f"{URL}/api/v1/spool",
+        params={"vendor_id": random_filament["vendor"]["id"]},
+    )
+    result.raise_for_status()
+
+    # Verify
+    spools = result.json()
+    assert len(spools) == 2
+    for spool in spools:
+        assert spool == added_spools_by_id[spool["id"]]
+
+    # Execute - find spools by location
+    result = httpx.get(
+        f"{URL}/api/v1/spool",
+        params={"location": "The Pantry"},
+    )
+    result.raise_for_status()
+
+    # Verify
+    spools = result.json()
+    assert len(spools) == 1
+    assert spools[0] == added_spools_by_id[spool_1["id"]]
+
+    # Execute - find spools by lot nr
+    result = httpx.get(
+        f"{URL}/api/v1/spool",
+        params={"lot_nr": "123456789"},
+    )
+    result.raise_for_status()
+
+    # Verify
+    spools = result.json()
+    assert len(spools) == 1
+    assert spools[0] == added_spools_by_id[spool_1["id"]]
+
+    # Clean up
+    httpx.delete(f"{URL}/api/v1/spool/{spool_1['id']}").raise_for_status()
+    httpx.delete(f"{URL}/api/v1/spool/{spool_2['id']}").raise_for_status()
+    httpx.delete(f"{URL}/api/v1/spool/{spool_3['id']}").raise_for_status()

tests_integration/tests/spool/test_get.py

@@ -0,0 +1,57 @@
+"""Integration tests for the Spool API endpoint."""
+
+from typing import Any
+
+import httpx
+
+URL = "http://spoolman:8000"
+
+
+def test_get_spool(random_filament: dict[str, Any]):
+    """Test getting a spool from the database."""
+    # Setup
+    first_used = "2023-01-01T00:00:00"
+    last_used = "2023-01-02T00:00:00"
+    remaining_weight = 750
+    location = "The Pantry"
+    lot_nr = "123456789"
+    comment = "abcdefghåäö"
+    archived = True
+    result = httpx.post(
+        f"{URL}/api/v1/spool",
+        json={
+            "first_used": first_used,
+            "last_used": last_used,
+            "filament_id": random_filament["id"],
+            "remaining_weight": remaining_weight,
+            "location": location,
+            "lot_nr": lot_nr,
+            "comment": comment,
+            "archived": archived,
+        },
+    )
+    result.raise_for_status()
+    spool = result.json()
+
+    # Execute
+    result = httpx.get(f"{URL}/api/v1/spool/{spool['id']}")
+    result.raise_for_status()
+
+    # Verify
+    assert result.json() == spool
+
+    # Clean up
+    httpx.delete(f"{URL}/api/v1/spool/{spool['id']}").raise_for_status()
+
+
+def test_get_spool_not_found():
+    """Test getting a spool that does not exist."""
+    # Execute
+    result = httpx.get(f"{URL}/api/v1/spool/123456789")
+
+    # Verify
+    assert result.status_code == 404
+    message = result.json()["message"].lower()
+    assert "spool" in message
+    assert "id" in message
+    assert "123456789" in message

tests_integration/tests/spool/test_update.py

@@ -0,0 +1,114 @@
+"""Integration tests for the Spool API endpoint."""
+
+from typing import Any
+
+import httpx
+import pytest
+
+from tests.conftest import length_from_weight
+
+URL = "http://spoolman:8000"
+
+
+def test_update_spool(random_filament: dict[str, Any]):
+    """Test updating a spool in the database."""
+    # Setup
+    result = httpx.post(
+        f"{URL}/api/v1/spool",
+        json={
+            "filament_id": random_filament["id"],
+            "remaining_weight": 1000,
+            "location": "The Pantry",
+            "lot_nr": "123456789",
+        },
+    )
+    result.raise_for_status()
+    spool = result.json()
+
+    # Execute
+    first_used = "2023-01-01T12:00:00+02:00"
+    last_used = "2023-01-02T12:00:00+02:00"
+    remaining_weight = 750
+    location = "Living Room"
+    lot_nr = "987654321"
+    comment = "abcdefghåäö"
+    archived = True
+    result = httpx.patch(
+        f"{URL}/api/v1/spool/{spool['id']}",
+        json={
+            "first_used": first_used,
+            "last_used": last_used,
+            "remaining_weight": remaining_weight,
+            "location": location,
+            "lot_nr": lot_nr,
+            "comment": comment,
+            "archived": archived,
+        },
+    )
+    result.raise_for_status()
+
+    # Verify
+    used_weight = random_filament["weight"] - remaining_weight
+    used_length = length_from_weight(
+        weight=used_weight,
+        density=random_filament["density"],
+        diameter=random_filament["diameter"],
+    )
+    remaining_length = length_from_weight(
+        weight=remaining_weight,
+        density=random_filament["density"],
+        diameter=random_filament["diameter"],
+    )
+
+    spool = result.json()
+    assert spool["first_used"] == "2023-01-01T10:00:00"
+    assert spool["last_used"] == "2023-01-02T10:00:00"
+    assert spool["remaining_weight"] == pytest.approx(remaining_weight)
+    assert spool["used_weight"] == pytest.approx(used_weight)
+    assert spool["remaining_length"] == pytest.approx(remaining_length)
+    assert spool["used_length"] == pytest.approx(used_length)
+    assert spool["location"] == location
+    assert spool["lot_nr"] == lot_nr
+    assert spool["comment"] == comment
+    assert spool["archived"] == archived
+
+    # Clean up
+    httpx.delete(f"{URL}/api/v1/spool/{spool['id']}").raise_for_status()
+
+
+def test_update_spool_both_used_and_remaining_weight(random_filament: dict[str, Any]):
+    """Test updating a spool in the database."""
+    # Setup
+    result = httpx.post(
+        f"{URL}/api/v1/spool",
+        json={"filament_id": random_filament["id"]},
+    )
+    result.raise_for_status()
+    spool = result.json()
+
+    # Execute
+    result = httpx.patch(
+        f"{URL}/api/v1/spool/{spool['id']}",
+        json={
+            "remaining_weight": 750,
+            "used_weight": 250,
+        },
+    )
+    assert result.status_code == 400  # Cannot update both used and remaining weight
+
+    # Clean up
+    httpx.delete(f"{URL}/api/v1/spool/{spool['id']}").raise_for_status()
+
+
+def test_update_spool_not_found(random_filament: dict[str, Any]):
+    """Test updating a spool that does not exist."""
+    # Execute
+    result = httpx.patch(
+        f"{URL}/api/v1/spool/123456789",
+        json={"filament_id": random_filament["id"]},
+    )
+    assert result.status_code == 404
+    message = result.json()["message"].lower()
+    assert "spool" in message
+    assert "id" in message
+    assert "123456789" in message

tests_integration/tests/spool/test_use.py

@@ -0,0 +1,163 @@
+"""Integration tests for the Spool API endpoint."""
+
+import asyncio
+import math
+from typing import Any
+
+import httpx
+import pytest
+
+URL = "http://spoolman:8000"
+
+
+@pytest.mark.parametrize("use_weight", [0, 0.05, -0.05, 1500])  # 1500 is big enough to use all filament
+def test_use_spool_weight(random_filament: dict[str, Any], use_weight: float):
+    """Test using a spool in the database."""
+    # Setup
+    filament_net_weight = random_filament["weight"]
+    start_weight = 1000
+    result = httpx.post(
+        f"{URL}/api/v1/spool",
+        json={
+            "filament_id": random_filament["id"],
+            "remaining_weight": start_weight,
+        },
+    )
+    result.raise_for_status()
+    spool = result.json()
+
+    # Execute
+    result = httpx.put(
+        f"{URL}/api/v1/spool/{spool['id']}/use",
+        json={
+            "use_weight": use_weight,
+        },
+    )
+    result.raise_for_status()
+
+    # Verify
+    spool = result.json()
+    # remaining_weight should be clamped so it's never negative, but used_weight should not be clamped to the net weight
+    assert spool["used_weight"] == pytest.approx(max(use_weight, 0))
+    assert spool["remaining_weight"] == pytest.approx(min(max(start_weight - use_weight, 0), filament_net_weight))
+
+    # Clean up
+    httpx.delete(f"{URL}/api/v1/spool/{spool['id']}").raise_for_status()
+
+
+@pytest.mark.parametrize("use_length", [0, 10, -10, 500e3])  # 500e3 is big enough to use all the filament
+def test_use_spool_length(random_filament: dict[str, Any], use_length: float):
+    """Test using a spool in the database."""
+    # Setup
+    filament_net_weight = random_filament["weight"]
+    start_weight = 1000
+    result = httpx.post(
+        f"{URL}/api/v1/spool",
+        json={
+            "filament_id": random_filament["id"],
+            "remaining_weight": start_weight,
+        },
+    )
+    result.raise_for_status()
+    spool = result.json()
+
+    # Execute
+    result = httpx.put(
+        f"{URL}/api/v1/spool/{spool['id']}/use",
+        json={
+            "use_length": use_length,
+        },
+    )
+    result.raise_for_status()
+
+    # Verify
+    spool = result.json()
+    use_weight = (
+        random_filament["density"] * (use_length * 1e-1) * math.pi * ((random_filament["diameter"] * 1e-1 / 2) ** 2)
+    )
+    # remaining_weight should be clamped so it's never negative, but used_weight should not be clamped to the net weight
+    assert spool["used_weight"] == pytest.approx(max(use_weight, 0))
+    assert spool["remaining_weight"] == pytest.approx(min(max(start_weight - use_weight, 0), filament_net_weight))
+
+    # Clean up
+    httpx.delete(f"{URL}/api/v1/spool/{spool['id']}").raise_for_status()
+
+
+def test_use_spool_weight_and_length(random_filament: dict[str, Any]):
+    """Test using a spool in the database."""
+    # Setup
+    result = httpx.post(
+        f"{URL}/api/v1/spool",
+        json={"filament_id": random_filament["id"]},
+    )
+    result.raise_for_status()
+    spool = result.json()
+
+    # Execute
+    result = httpx.put(
+        f"{URL}/api/v1/spool/{spool['id']}/use",
+        json={
+            "use_weight": 0.05,
+            "use_length": 10,
+        },
+    )
+    assert result.status_code == 400  # Cannot use both weight and length
+
+    # Clean up
+    httpx.delete(f"{URL}/api/v1/spool/{spool['id']}").raise_for_status()
+
+
+def test_use_spool_not_found():
+    """Test using a spool that does not exist."""
+    # Execute
+    result = httpx.put(
+        f"{URL}/api/v1/spool/123456789/use",
+        json={"use_weight": 0.05},
+    )
+    assert result.status_code == 404
+    message = result.json()["message"].lower()
+    assert "spool" in message
+    assert "id" in message
+    assert "123456789" in message
+
+
+@pytest.mark.asyncio()
+async def test_use_spool_concurrent(random_filament: dict[str, Any]):
+    """Test using a spool with many concurrent requests."""
+    # Setup
+    start_weight = 1000
+    result = httpx.post(  # noqa: ASYNC100
+        f"{URL}/api/v1/spool",
+        json={
+            "filament_id": random_filament["id"],
+            "remaining_weight": start_weight,
+        },
+    )
+    result.raise_for_status()
+    spool = result.json()
+
+    # Execute
+    requests = 100
+    used_weight = 0.5
+    async with httpx.AsyncClient() as client:
+        await asyncio.gather(
+            *(
+                client.put(
+                    f"{URL}/api/v1/spool/{spool['id']}/use",
+                    json={
+                        "use_weight": used_weight,
+                    },
+                    timeout=60,
+                )
+                for _ in range(requests)
+            ),
+        )
+
+    # Verify
+    result = httpx.get(f"{URL}/api/v1/spool/{spool['id']}")  # noqa: ASYNC100
+    result.raise_for_status()
+    spool = result.json()
+    assert spool["remaining_weight"] == pytest.approx(start_weight - (used_weight * requests))
+
+    # Clean up
+    httpx.delete(f"{URL}/api/v1/spool/{spool['id']}").raise_for_status()  # noqa: ASYNC100