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

JohnVillalovos · JohnVillalovos · commit 3633850b1d35 · 2022-06-29T18:20:00.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
@@ -191,6 +191,33 @@ def _wait(timeout=30, step=0.5):
     return _wait
 
 
+def wait_for_deleted(
+    *,
+    pg_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 _ in range(max_iterations):
+        try:
+            object = pg_manager.get(object_id)
+        except gitlab.exceptions.GitlabGetError:
+            return
+        try:
+            if hard_delete:
+                object.delete(hard_delete=True)
+            else:
+                object.delete()
+        except gitlab.exceptions.GitlabDeleteError:
+            pass
+        time.sleep(SLEEP_INTERVAL)
+    pytest.fail(f"{description} {object_id} was not deleted")
+
+
 @pytest.fixture(scope="session")
 def gitlab_config(check_is_alive, docker_ip, docker_services, temp_dir, fixture_dir):
     config_file = temp_dir / "python-gitlab.cfg"
@@ -277,6 +304,7 @@ def group(gl):
         "path": f"group-{_id}",
     }
     group = gl.groups.create(data)
+    group_id = group.id
 
     yield group
 
@@ -285,6 +313,8 @@ def group(gl):
     except gitlab.exceptions.GitlabDeleteError as e:
         print(f"Group already deleted: {e}")
 
+    wait_for_deleted(pg_manager=gl.groups, object_id=group_id, description="Group")
+
 
 @pytest.fixture(scope="module")
 def project(gl):
@@ -293,6 +323,7 @@ def project(gl):
     name = f"test-project-{_id}"
 
     project = gl.projects.create(name=name)
+    project_id = project.id
 
     yield project
 
@@ -301,6 +332,10 @@ def project(gl):
     except gitlab.exceptions.GitlabDeleteError as e:
         print(f"Project already deleted: {e}")
 
+    wait_for_deleted(
+        pg_manager=gl.projects, object_id=project_id, description="Project"
+    )
+
 
 @pytest.fixture(scope="function")
 def merge_request(project, wait_for_sidekiq):
@@ -372,6 +407,18 @@ def _merge_request(*, source_branch: str):
             # Ignore if branch was already deleted
             pass
 
+    for mr_iid, source_branch in to_delete:
+        wait_for_deleted(
+            pg_manager=project.mergerequests,
+            object_id=mr_iid,
+            description="Project mergerequest",
+        )
+        wait_for_deleted(
+            pg_manager=project.branches,
+            object_id=source_branch,
+            description="Project branch",
+        )
+
 
 @pytest.fixture(scope="module")
 def project_file(project):
@@ -431,6 +478,7 @@ def user(gl):
     password = "fakepassword"
 
     user = gl.users.create(email=email, username=username, name=name, password=password)
+    user_id = user.id
 
     yield user
 
@@ -440,6 +488,10 @@ def user(gl):
     except gitlab.exceptions.GitlabDeleteError as e:
         print(f"User already deleted: {e}")
 
+    wait_for_deleted(
+        pg_manager=gl.users, object_id=user_id, description="User", hard_delete=True
+    )
+
 
 @pytest.fixture(scope="module")
 def issue(project):
