Command unit tests.

Opentrons · Oct 14, 2024 · 9a23aee · 9a23aee
1 parent 0c193b6
commit 9a23aee
Show file tree

Hide file tree

Showing 2 changed files with 155 additions and 18 deletions.
diff --git a/api/tests/opentrons/protocol_engine/commands/test_drop_tip.py b/api/tests/opentrons/protocol_engine/commands/test_drop_tip.py
@@ -1,6 +1,8 @@
 """Test drop tip commands."""
+from datetime import datetime
+
 import pytest
-from decoy import Decoy
+from decoy import Decoy, matchers
 
 from opentrons.protocol_engine import (
     DropTipWellLocation,
@@ -9,17 +11,22 @@
     WellOffset,
     DeckPoint,
 )
-from opentrons.protocol_engine.state import update_types
-from opentrons.protocol_engine.state.state import StateView
-from opentrons.protocol_engine.execution import MovementHandler, TipHandler
-from opentrons.types import Point
-
-from opentrons.protocol_engine.commands.command import SuccessData
+from opentrons.protocol_engine.commands.command import DefinedErrorData, SuccessData
 from opentrons.protocol_engine.commands.drop_tip import (
     DropTipParams,
     DropTipResult,
     DropTipImplementation,
 )
+from opentrons.protocol_engine.commands.pipetting_common import (
+    TipPhysicallyAttachedError,
+)
+from opentrons.protocol_engine.errors.exceptions import TipAttachedError
+from opentrons.protocol_engine.resources.model_utils import ModelUtils
+from opentrons.protocol_engine.state import update_types
+from opentrons.protocol_engine.state.state import StateView
+from opentrons.protocol_engine.execution import MovementHandler, TipHandler
+
+from opentrons.types import Point
 
 
 @pytest.fixture
@@ -40,6 +47,12 @@ def mock_tip_handler(decoy: Decoy) -> TipHandler:
     return decoy.mock(cls=TipHandler)
 
 
+@pytest.fixture
+def mock_model_utils(decoy: Decoy) -> ModelUtils:
+    """Get a mock ModelUtils."""
+    return decoy.mock(cls=ModelUtils)
+
+
 def test_drop_tip_params_defaults() -> None:
     """A drop tip should use a `WellOrigin.DROP_TIP` by default."""
     default_params = DropTipParams.parse_obj(
@@ -72,12 +85,14 @@ async def test_drop_tip_implementation(
     mock_state_view: StateView,
     mock_movement_handler: MovementHandler,
     mock_tip_handler: TipHandler,
+    mock_model_utils: ModelUtils,
 ) -> None:
     """A DropTip command should have an execution implementation."""
     subject = DropTipImplementation(
         state_view=mock_state_view,
         movement=mock_movement_handler,
         tip_handler=mock_tip_handler,
+        model_utils=mock_model_utils,
     )
 
     params = DropTipParams(
@@ -141,12 +156,14 @@ async def test_drop_tip_with_alternating_locations(
     mock_state_view: StateView,
     mock_movement_handler: MovementHandler,
     mock_tip_handler: TipHandler,
+    mock_model_utils: ModelUtils,
 ) -> None:
     """It should drop tip at random location within the labware every time."""
     subject = DropTipImplementation(
         state_view=mock_state_view,
         movement=mock_movement_handler,
         tip_handler=mock_tip_handler,
+        model_utils=mock_model_utils,
     )
     params = DropTipParams(
         pipetteId="abc",
@@ -205,3 +222,76 @@ async def test_drop_tip_with_alternating_locations(
             ),
         ),
     )
+
+
+async def test_tip_attached_error(
+    decoy: Decoy,
+    mock_state_view: StateView,
+    mock_movement_handler: MovementHandler,
+    mock_tip_handler: TipHandler,
+    mock_model_utils: ModelUtils,
+) -> None:
+    """A DropTip command should have an execution implementation."""
+    subject = DropTipImplementation(
+        state_view=mock_state_view,
+        movement=mock_movement_handler,
+        tip_handler=mock_tip_handler,
+        model_utils=mock_model_utils,
+    )
+
+    params = DropTipParams(
+        pipetteId="abc",
+        labwareId="123",
+        wellName="A3",
+        wellLocation=DropTipWellLocation(offset=WellOffset(x=1, y=2, z=3)),
+    )
+
+    decoy.when(
+        mock_state_view.pipettes.get_is_partially_configured(pipette_id="abc")
+    ).then_return(False)
+
+    decoy.when(
+        mock_state_view.geometry.get_checked_tip_drop_location(
+            pipette_id="abc",
+            labware_id="123",
+            well_location=DropTipWellLocation(offset=WellOffset(x=1, y=2, z=3)),
+            partially_configured=False,
+        )
+    ).then_return(WellLocation(offset=WellOffset(x=4, y=5, z=6)))
+
+    decoy.when(
+        await mock_movement_handler.move_to_well(
+            pipette_id="abc",
+            labware_id="123",
+            well_name="A3",
+            well_location=WellLocation(offset=WellOffset(x=4, y=5, z=6)),
+        )
+    ).then_return(Point(x=111, y=222, z=333))
+    decoy.when(
+        await mock_tip_handler.drop_tip(pipette_id="abc", home_after=None)
+    ).then_raise(TipAttachedError("Egads!"))
+
+    decoy.when(mock_model_utils.generate_id()).then_return("error-id")
+    decoy.when(mock_model_utils.get_timestamp()).then_return(
+        datetime(year=1, month=2, day=3)
+    )
+
+    result = await subject.execute(params)
+
+    assert result == DefinedErrorData(
+        public=TipPhysicallyAttachedError.construct(
+            id="error-id",
+            createdAt=datetime(year=1, month=2, day=3),
+            wrappedErrors=[matchers.Anything()],
+        ),
+        state_update=update_types.StateUpdate(
+            pipette_location=update_types.PipetteLocationUpdate(
+                pipette_id="abc",
+                new_location=update_types.Well(
+                    labware_id="123",
+                    well_name="A3",
+                ),
+                new_deck_point=DeckPoint(x=111, y=222, z=333),
+            ),
+        ),
+    )
diff --git a/api/tests/opentrons/protocol_engine/commands/test_drop_tip_in_place.py b/api/tests/opentrons/protocol_engine/commands/test_drop_tip_in_place.py
@@ -1,19 +1,25 @@
 """Test drop tip in place commands."""
-from opentrons.protocol_engine.state.update_types import (
-    PipetteTipStateUpdate,
-    StateUpdate,
-)
-import pytest
-from decoy import Decoy
+from datetime import datetime
 
-from opentrons.protocol_engine.execution import TipHandler
+import pytest
+from decoy import Decoy, matchers
 
-from opentrons.protocol_engine.commands.command import SuccessData
+from opentrons.protocol_engine.commands.pipetting_common import (
+    TipPhysicallyAttachedError,
+)
+from opentrons.protocol_engine.commands.command import DefinedErrorData, SuccessData
 from opentrons.protocol_engine.commands.drop_tip_in_place import (
     DropTipInPlaceParams,
     DropTipInPlaceResult,
     DropTipInPlaceImplementation,
 )
+from opentrons.protocol_engine.errors.exceptions import TipAttachedError
+from opentrons.protocol_engine.execution import TipHandler
+from opentrons.protocol_engine.resources.model_utils import ModelUtils
+from opentrons.protocol_engine.state.update_types import (
+    PipetteTipStateUpdate,
+    StateUpdate,
+)
 
 
 @pytest.fixture
@@ -22,13 +28,21 @@ def mock_tip_handler(decoy: Decoy) -> TipHandler:
     return decoy.mock(cls=TipHandler)
 
 
-async def test_drop_tip_implementation(
+@pytest.fixture
+def mock_model_utils(decoy: Decoy) -> ModelUtils:
+    """Get a mock ModelUtils."""
+    return decoy.mock(cls=ModelUtils)
+
+
+async def test_success(
     decoy: Decoy,
     mock_tip_handler: TipHandler,
+    mock_model_utils: ModelUtils,
 ) -> None:
     """A DropTip command should have an execution implementation."""
-    subject = DropTipInPlaceImplementation(tip_handler=mock_tip_handler)
-
+    subject = DropTipInPlaceImplementation(
+        tip_handler=mock_tip_handler, model_utils=mock_model_utils
+    )
     params = DropTipInPlaceParams(pipetteId="abc", homeAfter=False)
 
     result = await subject.execute(params)
@@ -45,3 +59,36 @@ async def test_drop_tip_implementation(
         await mock_tip_handler.drop_tip(pipette_id="abc", home_after=False),
         times=1,
     )
+
+
+async def test_tip_attached_error(
+    decoy: Decoy,
+    mock_tip_handler: TipHandler,
+    mock_model_utils: ModelUtils,
+) -> None:
+    """A DropTip command should have an execution implementation."""
+    subject = DropTipInPlaceImplementation(
+        tip_handler=mock_tip_handler, model_utils=mock_model_utils
+    )
+
+    params = DropTipInPlaceParams(pipetteId="abc", homeAfter=False)
+
+    decoy.when(
+        await mock_tip_handler.drop_tip(pipette_id="abc", home_after=False)
+    ).then_raise(TipAttachedError("Egads!"))
+
+    decoy.when(mock_model_utils.generate_id()).then_return("error-id")
+    decoy.when(mock_model_utils.get_timestamp()).then_return(
+        datetime(year=1, month=2, day=3)
+    )
+
+    result = await subject.execute(params)
+
+    assert result == DefinedErrorData(
+        public=TipPhysicallyAttachedError.construct(
+            id="error-id",
+            createdAt=datetime(year=1, month=2, day=3),
+            wrappedErrors=[matchers.Anything()],
+        ),
+        state_update=StateUpdate(),
+    )