match_state in api schema; allow patching of match_state; tests of same

WildMeOrg · Oct 17, 2023 · 04a5386 · 04a5386
1 parent fc27d37
commit 04a5386
Show file tree

Hide file tree

Showing 3 changed files with 27 additions and 0 deletions.
diff --git a/app/modules/sightings/parameters.py b/app/modules/sightings/parameters.py
@@ -49,6 +49,7 @@ class PatchSightingDetailsParameters(PatchJSONParameters):
         '/locationId',
         '/taxonomies',
         '/verbatimLocality',
+        '/match_state',
     )
 
     @classmethod
@@ -162,6 +163,17 @@ def replace(cls, obj, field, value, state):
             elif field == 'verbatimLocality':
                 obj.verbatim_locality = value
                 ret_val = True
+            elif field == 'match_state':
+                from app.modules.sightings.models import SightingMatchState
+
+                try:
+                    SightingMatchState(value)
+                except KeyError:
+                    raise HoustonException(
+                        log, f'match_state value passed ({value}) is invalid'
+                    )
+                obj.match_state = value
+                ret_val = True
 
         return ret_val
 

diff --git a/app/modules/sightings/schemas.py b/app/modules/sightings/schemas.py
@@ -216,6 +216,7 @@ class Meta(TimedSightingSchema.Meta):
             'assets',
             'featuredAssetGuid',
             'stage',
+            'match_state',
             'jobs',
             'creator',
             'time',

diff --git a/tests/modules/sightings/resources/test_create_sighting.py b/tests/modules/sightings/resources/test_create_sighting.py
@@ -137,11 +137,13 @@ def test_create_and_modify_and_delete_sighting(
         sighting_id,
         patch_data=[
             {'op': 'replace', 'path': '/locationId', 'value': region2_id},
+            {'op': 'replace', 'path': '/match_state', 'value': 'reviewed'},
         ],
     )
     # check that change was made
     response = sighting_utils.read_sighting(flask_app_client, researcher_1, sighting_id)
     assert response.json['locationId'] == region2_id
+    assert response.json['match_state'] == 'reviewed'
 
     new_configs = [{'algorithms': ['hotspotter_nosv']}]
     sighting_utils.patch_sighting(
@@ -177,6 +179,7 @@ def test_create_and_modify_and_delete_sighting(
         'featuredAssetGuid',
         'unreviewed_start_time',
         'creator',
+        'match_state',
         'curation_start_time',
         'detection_start_time',
     }
@@ -255,6 +258,17 @@ def test_create_and_modify_and_delete_sighting(
         expected_status_code=400,
     )
 
+    # invalid match_state
+    sighting_utils.patch_sighting(
+        flask_app_client,
+        researcher_1,
+        sighting_id,
+        patch_data=[
+            {'op': 'add', 'path': '/match_state', 'value': 'failure'},
+        ],
+        expected_status_code=409,
+    )
+
     # patch op=add will create a new (3rd) encounter
     sighting_utils.patch_sighting(
         flask_app_client,