chore: fixtures: after delete() wait to verify deleted

JohnVillalovos · JohnVillalovos · commit 41f94ebaba78 · 2022-07-03T19:29:54.000-07:00
In our fixtures that create:
  - groups
  - project merge requests
  - projects
  - users

They delete the created objects after use. Now wait to ensure the
objects are deleted before continuing as having unexpected objects
existing can impact some of our tests.
diff --git a/tests/functional/conftest.py b/tests/functional/conftest.py
@@ -9,9 +9,7 @@
 
 import gitlab
 import gitlab.base
-
-SLEEP_INTERVAL = 0.5
-TIMEOUT = 60  # seconds before timeout will occur
+from tests.functional import helpers
 
 
 @pytest.fixture(scope="session")
@@ -49,7 +47,7 @@ def reset_gitlab(gl):
             logging.info(f"Marking for deletion user: {user.username!r}")
             user.delete(hard_delete=True)
 
-    max_iterations = int(TIMEOUT / SLEEP_INTERVAL)
+    max_iterations = int(helpers.TIMEOUT / helpers.SLEEP_INTERVAL)
 
     # Ensure everything has been reset
     start_time = time.perf_counter()
@@ -68,7 +66,7 @@ def wait_for_list_size(
                 f"Iteration: {count} Waiting for {description!r} items to be deleted: "
                 f"{[x.name for x in items]}"
             )
-            time.sleep(SLEEP_INTERVAL)
+            time.sleep(helpers.SLEEP_INTERVAL)
 
         elapsed_time = time.perf_counter() - start_time
         error_message = (
@@ -277,13 +275,11 @@ def group(gl):
         "path": f"group-{_id}",
     }
     group = gl.groups.create(data)
+    group_id = group.id
 
     yield group
 
-    try:
-        group.delete()
-    except gitlab.exceptions.GitlabDeleteError as e:
-        print(f"Group already deleted: {e}")
+    helpers.safe_delete(manager=gl.groups, object_id=group_id, description="Group")
 
 
 @pytest.fixture(scope="module")
@@ -296,10 +292,9 @@ def project(gl):
 
     yield project
 
-    try:
-        project.delete()
-    except gitlab.exceptions.GitlabDeleteError as e:
-        print(f"Project already deleted: {e}")
+    helpers.safe_delete(
+        manager=gl.projects, object_id=project.id, description="Project"
+    )
 
 
 @pytest.fixture(scope="function")
@@ -365,12 +360,16 @@ def _merge_request(*, source_branch: str):
     yield _merge_request
 
     for mr_iid, source_branch in to_delete:
-        project.mergerequests.delete(mr_iid)
-        try:
-            project.branches.delete(source_branch)
-        except gitlab.exceptions.GitlabDeleteError:
-            # Ignore if branch was already deleted
-            pass
+        helpers.safe_delete(
+            manager=project.mergerequests,
+            object_id=mr_iid,
+            description="Project mergerequest",
+        )
+        helpers.safe_delete(
+            manager=project.branches,
+            object_id=source_branch,
+            description="Project branch",
+        )
 
 
 @pytest.fixture(scope="module")
@@ -431,14 +430,14 @@ def user(gl):
     password = "fakepassword"
 
     user = gl.users.create(email=email, username=username, name=name, password=password)
+    user_id = user.id
 
     yield user
 
-    try:
-        # Use `hard_delete=True` or a 'Ghost User' may be created.
-        user.delete(hard_delete=True)
-    except gitlab.exceptions.GitlabDeleteError as e:
-        print(f"User already deleted: {e}")
+    # Use `hard_delete=True` or a 'Ghost User' may be created.
+    helpers.safe_delete(
+        manager=gl.users, object_id=user_id, description="User", hard_delete=True
+    )
 
 
 @pytest.fixture(scope="module")
diff --git a/tests/functional/helpers.py b/tests/functional/helpers.py
@@ -0,0 +1,44 @@
+import logging
+import time
+
+import pytest
+
+import gitlab.base
+
+SLEEP_INTERVAL = 0.5
+TIMEOUT = 60  # seconds before timeout will occur
+
+
+def delete_object(
+    *, object: gitlab.base.RESTObject, index: int, hard_delete: bool = False
+):
+    if index:
+        logging.info(f"Attempt {index+1} to delete {object!r}.")
+    try:
+        if hard_delete:
+            object.delete(hard_delete=True)
+        else:
+            object.delete()
+    except gitlab.exceptions.GitlabDeleteError:
+        logging.info(f"{object!r} already deleted.")
+        pass
+
+
+def safe_delete(
+    *,
+    manager: gitlab.base.RESTManager,
+    object_id: int,
+    description: str,
+    hard_delete: bool = False,
+) -> None:
+    """Ensure the object specified can not be retrieved. If object still exists after
+    timeout period, fail the test"""
+    max_iterations = int(TIMEOUT / SLEEP_INTERVAL)
+    for index in range(max_iterations):
+        try:
+            object = manager.get(object_id)
+        except gitlab.exceptions.GitlabGetError:
+            return
+        delete_object(object=object, index=index, hard_delete=hard_delete)
+        time.sleep(SLEEP_INTERVAL)
+    pytest.fail(f"{description} {object!r} was not deleted")
