test(robot-server): Test compatibility with databases created in v6.0 (#11448)

Author: SyntaxColoring

robot-server/.flake8

@@ -35,3 +35,7 @@ per-file-ignores =
     tests/service/*:ANN,D
     tests/conftest.py:ANN,D
     tests/test_util.py:ANN,D
+
+# Ignore Python Protocol API files that are used as opaque test input.
+extend-exclude =
+    tests/integration/persistence_snapshots/

robot-server/mypy.ini

@@ -2,8 +2,22 @@
 plugins = pydantic.mypy, decoy.mypy, sqlalchemy.ext.mypy.plugin
 show_error_codes = True
 strict = True
-# TODO(mc, 2021-09-12): remove these exclusions
-exclude = tests/(robot|service/labware|service/legacy|service/notifications|service/pipette_offset|service/session|service/tip_length)
+
+# `(?x)` for a verbose regex (so it ignores whitespace and can have comments).
+exclude = (?x)(
+    tests/(
+      # TODO(mc, 2021-09-12): remove these exclusions
+      robot
+      | service/labware
+      | service/legacy
+      | service/notifications
+      | service/pipette_offset
+      | service/session
+      | service/tip_length
+    )
+    # Ignore Python Protocol API files that are used as opaque test input.
+    | tests/integration/persistence_snapshots
+  )
 
 [pydantic-mypy]
 init_forbid_extra = True

robot-server/tests/integration/dev_server.py

@@ -1,4 +1,5 @@
 from __future__ import annotations
+from pathlib import Path
 import subprocess
 import signal
 import sys
@@ -8,10 +9,16 @@
 
 
 class DevServer:
-    def __init__(self, port: str = "31950") -> None:
+    def __init__(
+        self, port: str = "31950", persistence_directory: Optional[Path] = None
+    ) -> None:
         """Initialize a dev server."""
         self.server_temp_directory: str = tempfile.mkdtemp()
-        self.persistence_directory: str = tempfile.mkdtemp()
+        self.persistence_directory: Path = (
+            persistence_directory
+            if persistence_directory is not None
+            else Path(tempfile.mkdtemp())
+        )
         self.port: str = port
 
     def __enter__(self) -> DevServer:
@@ -52,7 +59,9 @@ def start(self) -> None:
             env={
                 "OT_ROBOT_SERVER_DOT_ENV_PATH": "dev.env",
                 "OT_API_CONFIG_DIR": self.server_temp_directory,
-                "OT_ROBOT_SERVER_persistence_directory": self.persistence_directory,
+                "OT_ROBOT_SERVER_persistence_directory": str(
+                    self.persistence_directory
+                ),
             },
             stdin=subprocess.DEVNULL,
             # The server will log to its stdout or stderr.

robot-server/tests/integration/http_api/persistence/test_compatibility.py

@@ -0,0 +1,83 @@
+from pathlib import Path
+from typing import AsyncGenerator, Generator
+
+import pytest
+
+from tests.integration.dev_server import DevServer
+from tests.integration.robot_client import RobotClient
+
+
+# FIXME(mm, 2022-09-09): This assumes the current working directory is
+# the root project directory. See Jira RSS-104.
+_OLDER_PERSISTENCE_DIR = Path("tests/integration/persistence_snapshots/v6.0.1")
+
+_EXPECTED_PROTOCOL_COUNT = 4
+_EXPECTED_RUN_COUNT = 5
+
+
+# Module-scope to avoid the overhead of restarting the server between test functions.
+# This relies on the test functions only reading, never writing.
+@pytest.fixture(scope="module")
+def dev_server() -> Generator[DevServer, None, None]:
+    port = "15555"
+    with DevServer(
+        port=port,
+        persistence_directory=_OLDER_PERSISTENCE_DIR,
+    ) as server:
+        server.start()
+        yield server
+
+
+@pytest.fixture
+async def robot_client(dev_server: DevServer) -> AsyncGenerator[RobotClient, None]:
+    """Return a client to talk to a server that's using an old persistence dir."""
+    async with RobotClient.make(
+        host="http://localhost", port=dev_server.port, version="*"
+    ) as robot_client:
+        assert (
+            await robot_client.wait_until_alive()
+        ), "Dev Robot never became available."
+        yield robot_client
+
+
+async def test_protocols_and_analyses_available_from_older_persistence_dir(
+    robot_client: RobotClient,
+) -> None:
+    all_protocols = (await robot_client.get_protocols()).json()
+    all_protocol_ids = [p["id"] for p in all_protocols["data"]]
+
+    assert len(all_protocol_ids) == _EXPECTED_PROTOCOL_COUNT
+
+    for protocol_id in all_protocol_ids:
+        protocol = (await robot_client.get_protocol(protocol_id=protocol_id)).json()
+
+        analysis_ids = [s["id"] for s in protocol["data"]["analysisSummaries"]]
+        assert len(analysis_ids) >= 1
+        for analysis_id in analysis_ids:
+            await robot_client.get_analysis(
+                protocol_id=protocol_id, analysis_id=analysis_id
+            )
+
+
+async def test_runs_available_from_older_persistence_dir(
+    robot_client: RobotClient,
+) -> None:
+    all_runs = (await robot_client.get_runs()).json()
+    all_run_ids = [r["id"] for r in all_runs["data"]]
+
+    assert len(all_run_ids) == _EXPECTED_RUN_COUNT
+
+    for run_id in all_run_ids:
+        await robot_client.get_run(run_id=run_id)
+
+        all_command_summaries = (
+            await robot_client.get_run_commands(
+                run_id=run_id,
+                page_length=999999,  # Big enough to include all commands.
+            )
+        ).json()
+        assert len(all_command_summaries["data"]) > 0
+
+        # Ideally, we would also fetch full commands via
+        # `GET /runs/{run_id}/commands/{command_id}`.
+        # We skip it for performance. On my machine, it would take ~7 seconds.

robot-server/tests/integration/persistence_snapshots/README.md

@@ -0,0 +1,22 @@
+# Overview
+
+This directory has examples of what a real robot might have in its `robot-server` persistence directory. (See the environment variable `OT_ROBOT_SERVER_persistence_directory` for background.)
+
+These help with testing schema migration and backwards compatibility.
+
+# Snapshot notes
+
+## v6.0.1
+
+This snapshot comes from a v6.0.1 dev server (run with `make -C robot-server dev`).
+
+It includes these protocols, which were uploaded by manually issuing HTTP `POST` requests:
+
+* [simpleV6.json](https://github.com/Opentrons/opentrons/blob/4f9c72ab076692a377afc7245e857385935763a8/shared-data/protocol/fixtures/6/simpleV6.json)
+* [multipleTipracksWithTC.json](https://github.com/Opentrons/opentrons/blob/4f9c72ab076692a377afc7245e857385935763a8/shared-data/protocol/fixtures/6/multipleTipracksWithTC.json)
+* [tempAndMagModuleCommands.json](https://github.com/Opentrons/opentrons/blob/4f9c72ab076692a377afc7245e857385935763a8/shared-data/protocol/fixtures/6/tempAndMagModuleCommands.json)
+* [swift_smoke.py](https://github.com/Opentrons/opentrons/blob/4f9c72ab076692a377afc7245e857385935763a8/g-code-testing/g_code_test_data/protocol/protocols/slow/swift_smoke.py)
+
+The JSON protocols were chosen to cover a wide breadth of Protocol Engine commands.
+
+Each protocol has one completed analysis and one successful run. multipleTipracksWithTC.json also has one failed run from a mismatched pipette error.