Wait_for_comnfirmed returns True if assets/events do not exist

Problem:
The filter criteria for the wait_for_confirmed method can return zero
if the user has made a mistake and this will correspond to an erroneous
True result.

Solution:
Check that the no of assets/events is > 0 before entering the wait_for
loop,

Signed-off-by: Paul Hewlett <phewlett76@gmail.com>

Author: eccles

archivist/assets.py

@@ -36,8 +36,10 @@
 from .constants import (
     ASSETS_SUBPATH,
     ASSETS_LABEL,
+    CONFIRMATION_STATUS,
 )
-from .confirm import wait_for_confirmation, wait_for_confirmed
+from .confirm import _wait_for_confirmation, _wait_for_confirmed
+from .errors import ArchivistNotFoundError
 
 
 #: Default page size - number of entities fetched in one REST GET in the
@@ -164,7 +166,7 @@ def create_from_data(self, data: Dict, *, confirm: bool = False) -> Asset:
         if not confirm:
             return asset
 
-        return wait_for_confirmation(self, asset["identity"])  # type: ignore
+        return _wait_for_confirmation(self, asset["identity"])  # type: ignore
 
     def wait_for_confirmation(self, identity: str) -> bool:
         """Wait for asset to be confirmed.
@@ -178,7 +180,7 @@ def wait_for_confirmation(self, identity: str) -> bool:
             True if asset is confirmed.
 
         """
-        return wait_for_confirmation(self, identity)
+        return _wait_for_confirmation(self, identity)
 
     def read(self, identity: str) -> Asset:
         """Read asset
@@ -236,7 +238,16 @@ def wait_for_confirmed(
             True if all assets are confirmed.
 
         """
-        return wait_for_confirmed(self, props=props, attrs=attrs)
+        # check that entities exist
+        newprops = deepcopy(props) if props else {}
+        newprops.pop(CONFIRMATION_STATUS, None)
+
+        LOGGER.debug("Count assets %s", newprops)
+        count = self.count(props=newprops, attrs=attrs)
+        if count == 0:
+            raise ArchivistNotFoundError("No assets exist")
+
+        return _wait_for_confirmed(self, props=newprops, attrs=attrs)
 
     def list(
         self,

archivist/confirm.py

@@ -50,7 +50,7 @@ def __on_giveup_confirmation(details):
     on_backoff=__backoff_handler,
     on_giveup=__on_giveup_confirmation,
 )
-def wait_for_confirmation(self, identity):
+def _wait_for_confirmation(self, identity):
     """docstring"""
     entity = self.read(identity)
 
@@ -89,12 +89,14 @@ def __on_giveup_confirmed(details):
     on_backoff=__backoff_handler,
     on_giveup=__on_giveup_confirmed,
 )
-def wait_for_confirmed(self, *, props=None, **kwargs) -> bool:
+def _wait_for_confirmed(self, *, props=None, **kwargs) -> bool:
     """docstring"""
+
+    # look for unconfirmed entities
     newprops = deepcopy(props) if props else {}
     newprops[CONFIRMATION_STATUS] = CONFIRMATION_PENDING
 
-    LOGGER.debug("Count unconfirmed assets %s", newprops)
+    LOGGER.debug("Count unconfirmed entities %s", newprops)
     count = self.count(props=newprops, **kwargs)
 
     if count == 0:
@@ -103,7 +105,7 @@ def wait_for_confirmed(self, *, props=None, **kwargs) -> bool:
         newprops[CONFIRMATION_STATUS] = CONFIRMATION_FAILED
         count = self.count(props=newprops, **kwargs)
         if count > 0:
-            raise ArchivistUnconfirmedError(f"There are {count} FAILED assets")
+            raise ArchivistUnconfirmedError(f"There are {count} FAILED entities")
 
         return True
 

archivist/events.py

@@ -34,9 +34,11 @@
     SEP,
     ASSETS_SUBPATH,
     ASSETS_WILDCARD,
+    CONFIRMATION_STATUS,
     EVENTS_LABEL,
 )
-from .confirm import wait_for_confirmation, wait_for_confirmed
+from .confirm import _wait_for_confirmation, _wait_for_confirmed
+from .errors import ArchivistNotFoundError
 
 
 #: Default page size - number of entities fetched in one REST GET in the
@@ -172,7 +174,7 @@ def create_from_data(self, asset_id: str, data: Dict, *, confirm=False) -> Event
         if not confirm:
             return event
 
-        return wait_for_confirmation(self, event["identity"])  # type: ignore
+        return _wait_for_confirmation(self, event["identity"])  # type: ignore
 
     def wait_for_confirmation(self, identity: str) -> bool:
         """Wait for event to be confirmed.
@@ -186,7 +188,7 @@ def wait_for_confirmation(self, identity: str) -> bool:
             True if event is confirmed.
 
         """
-        return wait_for_confirmation(self, identity)
+        return _wait_for_confirmation(self, identity)
 
     def read(self, identity: str) -> Event:
         """Read event
@@ -269,7 +271,18 @@ def wait_for_confirmed(
             True if all events are confirmed.
 
         """
-        return wait_for_confirmed(
+        # check that entities exist
+        newprops = deepcopy(props) if props else {}
+        newprops.pop(CONFIRMATION_STATUS, None)
+
+        LOGGER.debug("Count events %s", newprops)
+        count = self.count(
+            asset_id=asset_id, props=newprops, attrs=attrs, asset_attrs=asset_attrs
+        )
+        if count == 0:
+            raise ArchivistNotFoundError("No events exist")
+
+        return _wait_for_confirmed(
             self, asset_id=asset_id, props=props, attrs=attrs, asset_attrs=asset_attrs
         )
 

unittests/testassets.py

@@ -16,7 +16,7 @@
     HEADERS_TOTAL_COUNT,
     ROOT,
 )
-from archivist.errors import ArchivistUnconfirmedError
+from archivist.errors import ArchivistNotFoundError, ArchivistUnconfirmedError
 from archivist.storage_integrity import StorageIntegrity
 
 from .mock_response import MockResponse
@@ -415,7 +415,7 @@ def test_assets_wait_for_confirmed(self):
         Test asset counting
         """
         ## last call to get looks for FAILED assets
-        status = ("PENDING", "PENDING", "FAILED")
+        status = ("", "&confirmation_status=PENDING", "&confirmation_status=FAILED")
         with mock.patch.object(self.arch._session, "get") as mock_get:
             mock_get.side_effect = [
                 MockResponse(
@@ -442,13 +442,7 @@ def test_assets_wait_for_confirmed(self):
                 self.assertEqual(
                     tuple(a),
                     (
-                        (
-                            (
-                                f"url/{ROOT}/{SUBPATH}"
-                                "?page_size=1"
-                                f"&confirmation_status={status[i]}"
-                            ),
-                        ),
+                        ((f"url/{ROOT}/{SUBPATH}" "?page_size=1" f"{status[i]}"),),
                         {
                             "headers": {
                                 "content-type": "application/json",
@@ -462,6 +456,24 @@ def test_assets_wait_for_confirmed(self):
                     msg="GET method called incorrectly",
                 )
 
+    def test_assets_wait_for_confirmed_not_found(self):
+        """
+        Test asset counting
+        """
+        with mock.patch.object(self.arch._session, "get") as mock_get:
+            mock_get.side_effect = [
+                MockResponse(
+                    200,
+                    headers={HEADERS_TOTAL_COUNT: 0},
+                    assets=[
+                        RESPONSE_PENDING,
+                    ],
+                ),
+            ]
+
+            with self.assertRaises(ArchivistNotFoundError):
+                self.arch.assets.wait_for_confirmed()
+
     def test_assets_wait_for_confirmed_timeout(self):
         """
         Test asset counting

unittests/testevents.py

@@ -17,7 +17,7 @@
     HEADERS_REQUEST_TOTAL_COUNT,
     HEADERS_TOTAL_COUNT,
 )
-from archivist.errors import ArchivistUnconfirmedError
+from archivist.errors import ArchivistNotFoundError, ArchivistUnconfirmedError
 from archivist.events import Event, DEFAULT_PAGE_SIZE
 
 from .mock_response import MockResponse
@@ -651,7 +651,7 @@ def test_events_wait_for_confirmed(self):
         Test event counting
         """
         ## last call to get looks for FAILED assets
-        status = ("PENDING", "PENDING", "FAILED")
+        status = ("", "&confirmation_status=PENDING", "&confirmation_status=FAILED")
         with mock.patch.object(self.arch._session, "get") as mock_get:
             mock_get.side_effect = [
                 MockResponse(
@@ -684,7 +684,7 @@ def test_events_wait_for_confirmed(self):
                                 f"/{ASSETS_WILDCARD}"
                                 f"/{EVENTS_LABEL}"
                                 "?page_size=1"
-                                f"&confirmation_status={status[i]}"
+                                f"{status[i]}"
                             ),
                         ),
                         {
@@ -700,6 +700,24 @@ def test_events_wait_for_confirmed(self):
                     msg="GET method called incorrectly",
                 )
 
+    def test_events_wait_for_confirmed_not_found(self):
+        """
+        Test event counting
+        """
+        with mock.patch.object(self.arch._session, "get") as mock_get:
+            mock_get.side_effect = [
+                MockResponse(
+                    200,
+                    headers={HEADERS_TOTAL_COUNT: 0},
+                    assets=[
+                        RESPONSE_PENDING,
+                    ],
+                ),
+            ]
+
+            with self.assertRaises(ArchivistNotFoundError):
+                self.arch.events.wait_for_confirmed()
+
     def test_events_list(self):
         """
         Test event listing