feat validator for rig/session compatibility (#991)

* feat validator for rig/session compatibility

* linters

Author: mekhlakapoor

docs/source/example_workflow/example_workflow.py

@@ -1,20 +1,14 @@
-import pandas as pd
 import os
 
+import pandas as pd
 from aind_data_schema_models.modalities import Modality
 from aind_data_schema_models.organizations import Organization
 from aind_data_schema_models.pid_names import PIDName
 from aind_data_schema_models.platforms import Platform
 
 from aind_data_schema.core.data_description import Funding, RawDataDescription
-from aind_data_schema.core.subject import Subject, Species, BreedingInfo, Housing
-from aind_data_schema.core.procedures import (
-    NanojectInjection,
-    Procedures,
-    Surgery,
-    ViralMaterial,
-    Perfusion,
-)
+from aind_data_schema.core.procedures import NanojectInjection, Perfusion, Procedures, Surgery, ViralMaterial
+from aind_data_schema.core.subject import BreedingInfo, Housing, Species, Subject
 
 sessions_df = pd.read_excel("example_workflow.xlsx", sheet_name="sessions")
 mice_df = pd.read_excel("example_workflow.xlsx", sheet_name="mice")
@@ -34,7 +28,6 @@
 
 # loop through all of the sessions
 for session_idx, session in sessions_df.iterrows():
-
     # our data always contains planar optical physiology and behavior videos
     d = RawDataDescription(
         modality=[Modality.POPHYS, Modality.BEHAVIOR_VIDEOS],

src/aind_data_schema/core/metadata.py

@@ -18,6 +18,7 @@
 from aind_data_schema.core.rig import Rig
 from aind_data_schema.core.session import Session
 from aind_data_schema.core.subject import Subject
+from aind_data_schema.utils.compatibility_check import RigSessionCompatibility
 
 
 class MetadataStatus(Enum):
@@ -232,3 +233,11 @@ def validate_ecephys_metadata(self):
         ):
             raise ValueError("Injection is missing injection_materials.")
         return self
+
+    @model_validator(mode="after")
+    def validate_rig_session_compatibility(self):
+        """Validator for metadata"""
+        if self.rig and self.session:
+            check = RigSessionCompatibility(self.rig, self.session)
+            check.run_compatibility_check()
+        return self

tests/test_metadata.py

@@ -10,6 +10,7 @@
 from pydantic import ValidationError
 from pydantic import __version__ as pyd_version
 
+from aind_data_schema.components.devices import MousePlatform
 from aind_data_schema.core.acquisition import Acquisition
 from aind_data_schema.core.data_description import DataDescription
 from aind_data_schema.core.instrument import Instrument
@@ -205,6 +206,29 @@ def test_validate_ecephys_metadata(self):
             )
         self.assertIn("Injection is missing injection_materials.", str(context.exception))
 
+    def test_validate_rig_session_compatibility(self):
+        """Tests that rig/session compatibility validator works as expected"""
+        mouse_platform = MousePlatform.model_construct(name="platform1")
+        rig = Rig.model_construct(rig_id="123_EPHYS1_20220101", mouse_platform=mouse_platform)
+        session = Session.model_construct(rig_id="123_EPHYS2_20230101", mouse_platform_name="platform2")
+        with self.assertRaises(ValueError) as context:
+            Metadata(
+                name="ecephys_655019_2023-04-03_18-17-09",
+                location="bucket",
+                data_description=DataDescription.model_construct(
+                    label="some label", platform=Ecephys, creation_time=time(12, 12, 12)
+                ),
+                subject=Subject.model_construct(),
+                procedures=Procedures.model_construct(),
+                rig=rig,
+                processing=Processing.model_construct(),
+                session=session,
+            )
+        self.assertIn(
+            "Rig ID in session 123_EPHYS2_20230101 does not match the rig's 123_EPHYS1_20220101.",
+            str(context.exception),
+        )
+
 
 if __name__ == "__main__":
     unittest.main()