Changes test order and improves docstrings

Author: chrisk314

tests/integration/test_state_backend.py

@@ -98,11 +98,65 @@ async def state_backend(request: pytest.FixtureRequest) -> _t.AsyncIterator[Stat
         yield state_backend
 
 
+@pytest.mark.asyncio
+@pytest.mark.parametrize("with_components", [True, False])
+async def test_state_backend_upsert_process(
+    state_backend: StateBackend,
+    B_components: list[Component],
+    B_connectors: list[Connector],
+    C_components: list[Component],
+    C_connectors: list[Connector],
+    with_components: bool,
+) -> None:
+    """Tests `StateBackend.upsert_process` method.
+
+    Two processes are created to ensure no interference between them. Each process is upserted into
+    the state backend, and then retrieved. The retrieved data is compared to the process data
+    obtained from the process.dump method.
+    """
+    comp_b1, comp_b2 = B_components
+    conn_1, conn_2 = B_connectors
+
+    comp_c1, comp_c2 = C_components
+    conn_3, conn_4 = C_connectors
+
+    async with state_backend:
+        process_1 = LocalProcess(
+            name="P1", components=[comp_b1, comp_b2], connectors=[conn_1, conn_2]
+        )
+        await state_backend.upsert_process(process_1, with_components=with_components)
+
+        process_2 = LocalProcess(
+            name="P2", components=[comp_c1, comp_c2], connectors=[conn_3, conn_4]
+        )
+        await state_backend.upsert_process(process_2, with_components=with_components)
+
+        process_1_dict = process_1.dict()
+        process_2_dict = process_2.dict()
+        if not with_components:
+            process_1_dict["components"] = {comp.id: {} for comp in B_components}
+            process_1_dict["connectors"] = {conn.id: {} for conn in B_connectors}
+            process_2_dict["components"] = {comp.id: {} for comp in C_components}
+            process_2_dict["connectors"] = {conn.id: {} for conn in C_connectors}
+
+        assert await state_backend.get_process(process_1.id) == process_1_dict
+        assert await state_backend.get_process(process_2.id) == process_2_dict
+
+
 @pytest.mark.asyncio
 async def test_state_backend_upsert_component(
     state_backend: StateBackend, A_components: list[Component]
 ) -> None:
-    """Tests `StateBackend.upsert_component` method."""
+    """Tests `StateBackend.upsert_component` method.
+
+    Two `A` components are created and upserted into the state backend. The components are stepped
+    multiple times, with assertions verifying that the state backend reflects the correct state
+    before and after each upsert.
+
+    Note that the components must be a part of a process in the state backend before they can be
+    upserted. Hence, a `LocalProcess` is created and upserted into the state backend first. Method
+    tested separately.
+    """
     comp_a1, comp_a2 = A_components
 
     process = LocalProcess(name="P1", components=[comp_a1, comp_a2], connectors=[])
@@ -147,7 +201,15 @@ async def test_state_backend_upsert_component(
 async def test_state_backend_upsert_connector(
     state_backend: StateBackend, B_connectors: list[Connector]
 ) -> None:
-    """Tests `StateBackend.upsert_connector` method."""
+    """Tests `StateBackend.upsert_connector` method.
+
+    Two connectors are created and upserted into the state backend. The retrieved connector data is
+    compared to the original connector data to ensure correctness.
+
+    Note that the connectors must be a part of a process in the state backend before they can be
+    upserted. Hence, a `LocalProcess` is created and upserted into the state backend first. Method
+    tested separately.
+    """
     conn_1, conn_2 = B_connectors
 
     process = LocalProcess(name="P1", components=[], connectors=[conn_1, conn_2])
@@ -166,46 +228,6 @@ async def test_state_backend_upsert_connector(
         assert await state_backend.get_connector(conn_2.id) == conn_2.dict()
 
 
-@pytest.mark.asyncio
-@pytest.mark.parametrize("with_components", [True, False])
-async def test_state_backend_upsert_process(
-    state_backend: StateBackend,
-    B_components: list[Component],
-    B_connectors: list[Connector],
-    C_components: list[Component],
-    C_connectors: list[Connector],
-    with_components: bool,
-) -> None:
-    """Tests `StateBackend.upsert_process` method."""
-    comp_b1, comp_b2 = B_components
-    conn_1, conn_2 = B_connectors
-
-    comp_c1, comp_c2 = C_components
-    conn_3, conn_4 = C_connectors
-
-    async with state_backend:
-        process_1 = LocalProcess(
-            name="P1", components=[comp_b1, comp_b2], connectors=[conn_1, conn_2]
-        )
-        await state_backend.upsert_process(process_1, with_components=with_components)
-
-        process_2 = LocalProcess(
-            name="P2", components=[comp_c1, comp_c2], connectors=[conn_3, conn_4]
-        )
-        await state_backend.upsert_process(process_2, with_components=with_components)
-
-        process_1_dict = process_1.dict()
-        process_2_dict = process_2.dict()
-        if not with_components:
-            process_1_dict["components"] = {comp.id: {} for comp in B_components}
-            process_1_dict["connectors"] = {conn.id: {} for conn in B_connectors}
-            process_2_dict["components"] = {comp.id: {} for comp in C_components}
-            process_2_dict["connectors"] = {conn.id: {} for conn in C_connectors}
-
-        assert await state_backend.get_process(process_1.id) == process_1_dict
-        assert await state_backend.get_process(process_2.id) == process_2_dict
-
-
 @pytest.mark.asyncio
 async def test_state_backend_process_init(
     state_backend: StateBackend, B_components: list[Component], B_connectors: list[Connector]