Only check for partial equality (#238)

* Only check for partial equality

* comment

Co-authored-by: Ubuntu <diego.ardila@scale.com>

Author: ardila

tests/helpers.py

@@ -546,3 +546,21 @@ def create_predictions(
     ]
     dataset.upload_predictions(model, predictions)
     return predictions
+
+
+def assert_partial_equality(expected, result, base_keys=[]):
+    """Used to check partial equality of two json-like dictionaries.
+
+    This means that all the keys/values in the expected dict must be present in the result dict,
+    but the result dict may contain additional keys.
+    """
+    for key, value in expected.items():
+        # If value is a dict, recurse.
+        keys = base_keys + [key]
+        if isinstance(value, dict):
+            assert_partial_equality(value, result[key], keys)
+        else:
+            address = ".".join(keys)
+            assert (
+                result[key] == value
+            ), f"{address} is not equal: {result[key]} != {value}"

tests/test_annotation.py

@@ -27,6 +27,7 @@
     assert_box_annotation_matches_dict,
     assert_category_annotation_matches_dict,
     assert_multicategory_annotation_matches_dict,
+    assert_partial_equality,
     assert_polygon_annotation_matches_dict,
     assert_segmentation_annotation_matches_dict,
     reference_id_from_url,
@@ -743,8 +744,9 @@ def test_default_category_gt_upload_async(dataset):
         asynchronous=True,
     )
     job.sleep_until_complete()
+    result = job.status()
 
-    assert job.status() == {
+    expected = {
         "job_id": job.job_id,
         "status": "Completed",
         "message": {
@@ -761,6 +763,7 @@ def test_default_category_gt_upload_async(dataset):
         "completed_steps": 1,
         "total_steps": 1,
     }
+    assert_partial_equality(expected, result)
 
 
 @pytest.mark.integration
@@ -781,7 +784,9 @@ def test_non_existent_taxonomy_category_gt_upload_async(dataset):
     except JobError:
         assert error_msg in job.errors()[-1]
 
-    assert job.status() == {
+    result = job.status()
+
+    expected = {
         "job_id": job.job_id,
         "status": "Errored",
         "message": {
@@ -791,3 +796,5 @@ def test_non_existent_taxonomy_category_gt_upload_async(dataset):
         "completed_steps": 1,
         "total_steps": 1,
     }
+
+    assert_partial_equality(expected, result)