test(api): Point out old opentrons.protocol_engine.state test conve…

…ntions more consistently (#17018)
Opentrons · Dec 4, 2024 · 57fbf35 · 57fbf35
1 parent 02a7bfa
commit 57fbf35
Show file tree

Hide file tree

Showing 16 changed files with 80 additions and 18 deletions.
diff --git a/...gine/state/test_addressable_area_store.py → .../state/test_addressable_area_store_old.py b/...gine/state/test_addressable_area_store.py → .../state/test_addressable_area_store_old.py
@@ -1,8 +1,8 @@
 """Addressable area state store tests.
 
 DEPRECATED: Testing AddressableAreaStore independently of AddressableAreaView is no
-longer helpful. Add new tests to test_addressable_area_state.py, where they can be
-tested together.
+longer helpful. Try to add new tests to test_addressable_area_state.py, where they can be
+tested together, treating AddressableAreaState as a private implementation detail.
 """
 
 import pytest

diff --git a/...ngine/state/test_addressable_area_view.py → ...e/state/test_addressable_area_view_old.py b/...ngine/state/test_addressable_area_view.py → ...e/state/test_addressable_area_view_old.py
@@ -1,8 +1,8 @@
 """Addressable area state view tests.
 
 DEPRECATED: Testing AddressableAreaView independently of AddressableAreaStore is no
-longer helpful. Add new tests to test_addressable_area_state.py, where they can be
-tested together.
+longer helpful. Try to add new tests to test_addressable_area_state.py, where they can be
+tested together, treating AddressableAreaState as a private implementation detail.
 """
 
 import inspect

diff --git a/api/tests/opentrons/protocol_engine/state/test_command_store_old.py b/api/tests/opentrons/protocol_engine/state/test_command_store_old.py
@@ -1,7 +1,8 @@
 """Tests for CommandStore.
 
 DEPRECATED: Testing CommandStore independently of CommandView is no longer helpful.
-Add new tests to test_command_state.py, where they can be tested together.
+Try to add new tests to test_command_state.py, where they can be tested together,
+treating CommandState as a private implementation detail.
 """
 
 

diff --git a/api/tests/opentrons/protocol_engine/state/test_command_view_old.py b/api/tests/opentrons/protocol_engine/state/test_command_view_old.py
@@ -1,7 +1,8 @@
 """Tests for CommandView.
 
 DEPRECATED: Testing CommandView independently of CommandStore is no longer helpful.
-Add new tests to test_command_state.py, where they can be tested together.
+Try to add new tests to test_command_state.py, where they can be tested together,
+treating CommandState as a private implementation detail.
 """
 
 

diff --git a/...otocol_engine/state/test_labware_store.py → ...ol_engine/state/test_labware_store_old.py b/...otocol_engine/state/test_labware_store.py → ...ol_engine/state/test_labware_store_old.py
@@ -1,4 +1,9 @@
-"""Labware state store tests."""
+"""Labware state store tests.
+
+DEPRECATED: Testing LabwareStore independently of LabwareView is no
+longer helpful. Try to add new tests to test_labware_state.py, where they can be
+tested together, treating LabwareState as a private implementation detail.
+"""
 from typing import Optional
 from opentrons.protocol_engine.state import update_types
 import pytest

diff --git a/...rotocol_engine/state/test_labware_view.py → ...col_engine/state/test_labware_view_old.py b/...rotocol_engine/state/test_labware_view.py → ...col_engine/state/test_labware_view_old.py
@@ -1,4 +1,9 @@
-"""Labware state store tests."""
+"""Labware state store tests.
+
+DEPRECATED: Testing LabwareView independently of LabwareStore is no
+longer helpful. Try to add new tests to test_labware_state.py, where they can be
+tested together, treating LabwareState as a private implementation detail.
+"""
 import pytest
 from datetime import datetime
 from typing import Dict, Optional, cast, ContextManager, Any, Union, NamedTuple, List

diff --git a/...l_engine/state/test_liquid_class_store.py → ...gine/state/test_liquid_class_store_old.py b/...l_engine/state/test_liquid_class_store.py → ...gine/state/test_liquid_class_store_old.py
@@ -1,4 +1,9 @@
-"""Liquid state store tests."""
+"""Liquid state store tests.
+
+DEPRECATED: Testing LiquidClassStore independently of LiquidClassView is no
+longer helpful. Try to add new tests to test_liquid_class_state.py, where they can be
+tested together, treating LiquidClassState as a private implementation detail.
+"""
 import pytest
 
 from opentrons_shared_data.liquid_classes.liquid_class_definition import (

diff --git a/...ol_engine/state/test_liquid_class_view.py → ...ngine/state/test_liquid_class_view_old.py b/...ol_engine/state/test_liquid_class_view.py → ...ngine/state/test_liquid_class_view_old.py
@@ -1,4 +1,9 @@
-"""Liquid view tests."""
+"""Liquid view tests.
+
+DEPRECATED: Testing LiquidClassView independently of LiquidClassStore is no
+longer helpful. Try to add new tests to test_liquid_class_state.py, where they can be
+tested together, treating LiquidClassState as a private implementation detail.
+"""
 import pytest
 
 from opentrons_shared_data.liquid_classes.liquid_class_definition import (

diff --git a/...rotocol_engine/state/test_liquid_store.py → ...col_engine/state/test_liquid_store_old.py b/...rotocol_engine/state/test_liquid_store.py → ...col_engine/state/test_liquid_store_old.py
@@ -1,4 +1,9 @@
-"""Liquid state store tests."""
+"""Liquid state store tests.
+
+DEPRECATED: Testing LiquidStore independently of LiquidView is no longer helpful.
+Try to add new tests to test_liquid_state.py, where they can be tested together,
+treating LiquidState as a private implementation detail.
+"""
 import pytest
 from opentrons.protocol_engine.state.liquids import LiquidStore
 from opentrons.protocol_engine import Liquid

diff --git a/...protocol_engine/state/test_liquid_view.py → ...ocol_engine/state/test_liquid_view_old.py b/...protocol_engine/state/test_liquid_view.py → ...ocol_engine/state/test_liquid_view_old.py
@@ -1,4 +1,9 @@
-"""Liquid view tests."""
+"""Liquid view tests.
+
+DEPRECATED: Testing LiquidView independently of LiquidStore is no longer helpful.
+Try to add new tests to test_liquid_state.py, where they can be tested together,
+treating LiquidState as a private implementation detail.
+"""
 import pytest
 
 from opentrons.protocol_engine.state.liquids import LiquidState, LiquidView

diff --git a/...rotocol_engine/state/test_module_store.py → ...col_engine/state/test_module_store_old.py b/...rotocol_engine/state/test_module_store.py → ...col_engine/state/test_module_store_old.py
@@ -1,4 +1,9 @@
-"""Module state store tests."""
+"""Module state store tests.
+
+DEPRECATED: Testing ModuleStore independently of ModuleView is no longer helpful.
+Try to add new tests to test_module_state.py, where they can be tested together,
+treating ModuleState as a private implementation detail.
+"""
 from typing import List, Set, cast, Dict, Optional
 
 import pytest

diff --git a/...protocol_engine/state/test_module_view.py → ...ocol_engine/state/test_module_view_old.py b/...protocol_engine/state/test_module_view.py → ...ocol_engine/state/test_module_view_old.py
@@ -1,4 +1,9 @@
-"""Tests for module state accessors in the protocol engine state store."""
+"""Tests for module state accessors in the protocol engine state store.
+
+DEPRECATED: Testing ModuleView independently of ModuleView is no longer helpful.
+Try to add new tests to test_module_state.py, where they can be tested together,
+treating ModuleState as a private implementation detail.
+"""
 import pytest
 from math import isclose
 from pytest_lazyfixture import lazy_fixture  # type: ignore[import-untyped]

diff --git a/...otocol_engine/state/test_pipette_store.py → ...ol_engine/state/test_pipette_store_old.py b/...otocol_engine/state/test_pipette_store.py → ...ol_engine/state/test_pipette_store_old.py
@@ -1,4 +1,9 @@
-"""Tests for pipette state changes in the protocol_engine state store."""
+"""Tests for pipette state changes in the protocol_engine state store.
+
+DEPRECATED: Testing PipetteStore independently of PipetteView is no longer helpful.
+Try to add new tests to test_pipette_state.py, where they can be tested together,
+treating PipetteState as a private implementation detail.
+"""
 import pytest
 
 from opentrons_shared_data.pipette.types import PipetteNameType

diff --git a/...rotocol_engine/state/test_pipette_view.py → ...col_engine/state/test_pipette_view_old.py b/...rotocol_engine/state/test_pipette_view.py → ...col_engine/state/test_pipette_view_old.py
@@ -1,4 +1,9 @@
-"""Tests for pipette state accessors in the protocol_engine state store."""
+"""Tests for pipette state accessors in the protocol_engine state store.
+
+DEPRECATED: Testing PipetteView independently of PipetteStore is no longer helpful.
+Try to add new tests to test_pipette_state.py, where they can be tested together,
+treating PipetteState as a private implementation detail.
+"""
 
 from collections import OrderedDict
 from typing import cast, Dict, List, Optional, Tuple, NamedTuple

diff --git a/.../protocol_engine/state/test_well_store.py → ...tocol_engine/state/test_well_store_old.py b/.../protocol_engine/state/test_well_store.py → ...tocol_engine/state/test_well_store_old.py
@@ -1,4 +1,9 @@
-"""Well state store tests."""
+"""Well state store tests.
+
+DEPRECATED: Testing WellStore independently of WellView is no longer helpful.
+Try to add new tests to well_state.py, where they can be tested together,
+treating WellState as a private implementation detail.
+"""
 
 import pytest
 from datetime import datetime

diff --git a/...s/protocol_engine/state/test_well_view.py → ...otocol_engine/state/test_well_view_old.py b/...s/protocol_engine/state/test_well_view.py → ...otocol_engine/state/test_well_view_old.py
@@ -1,4 +1,9 @@
-"""Well view tests."""
+"""Well view tests.
+
+DEPRECATED: Testing WellView independently of WellStore is no longer helpful.
+Try to add new tests to test_well_state.py, where they can be tested together,
+treating WellState as a private implementation detail.
+"""
 from datetime import datetime
 from opentrons.protocol_engine.types import (
     LoadedVolumeInfo,