Add circuit contributions (#325)

Author: eleftherioszisis

app/schemas/scientific_artifact.py

@@ -16,6 +16,7 @@
     LicenseCreateMixin,
     LicenseReadMixin,
 )
+from app.schemas.contribution import ContributionReadWithoutEntityMixin
 from app.schemas.subject import SubjectCreateMixin, SubjectReadMixin
 
 
@@ -45,6 +46,7 @@ class ScientificArtifactRead(
     CreationMixin,
     LicenseReadMixin,
     AssetsMixin,
+    ContributionReadWithoutEntityMixin,
 ):
     pass
 

app/service/circuit.py

@@ -7,6 +7,7 @@
 from app.db.model import (
     Agent,
     Circuit,
+    Contribution,
     Subject,
 )
 from app.dependencies.auth import UserContextDep, UserContextWithProjectIdDep
@@ -37,6 +38,8 @@ def _load(query: sa.Select):
         joinedload(Circuit.brain_region),
         joinedload(Circuit.created_by),
         joinedload(Circuit.updated_by),
+        selectinload(Circuit.contributions).joinedload(Contribution.agent),
+        selectinload(Circuit.contributions).joinedload(Contribution.role),
         selectinload(Circuit.assets),
         raiseload("*"),
     )

tests/conftest.py

@@ -62,6 +62,7 @@
     USER_SUB_ID_2,
     VIRTUAL_LAB_ID,
     ClientProxy,
+    add_contribution,
     add_db,
     assert_request,
     create_electrical_cell_recording_id_with_assets,
@@ -957,8 +958,8 @@ def circuit_json_data(brain_atlas_id, root_circuit, subject_id, brain_region_id,
 
 
 @pytest.fixture
-def circuit(db, circuit_json_data, person_id):
-    return add_db(
+def circuit(db, circuit_json_data, person_id, role_id):
+    circuit = add_db(
         db,
         Circuit(
             **circuit_json_data
@@ -969,6 +970,8 @@ def circuit(db, circuit_json_data, person_id):
             }
         ),
     )
+    add_contribution(db, circuit.id, person_id, role_id, person_id)
+    return circuit
 
 
 @pytest.fixture

tests/test_circuit.py

@@ -57,6 +57,7 @@ def test_create_one(client, circuit_json_data):
 def test_read_one(client, circuit, circuit_json_data):
     data = assert_request(client.get, url=f"{ROUTE}/{circuit.id}").json()
     _assert_read_response(data, circuit_json_data)
+    assert len(data["contributions"]) == 1
 
 
 def test_read_many(client, circuit, circuit_json_data):

tests/utils.py

@@ -11,6 +11,7 @@
 from app.db.model import (
     BrainRegion,
     BrainRegionHierarchy,
+    Contribution,
     ElectricalCellRecording,
     ElectricalRecordingStimulus,
     ETypeClass,
@@ -558,3 +559,16 @@ def check_creation_fields(data: dict):
     assert data["update_date"] == ANY
     assert data["created_by"]["id"] == ANY
     assert data["updated_by"]["id"] == ANY
+
+
+def add_contribution(db, entity_id, agent_id, role_id, created_by_id):
+    return add_db(
+        db,
+        Contribution(
+            agent_id=agent_id,
+            role_id=role_id,
+            entity_id=entity_id,
+            created_by_id=created_by_id,
+            updated_by_id=created_by_id,
+        ),
+    )