Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 22, 2022
Merged

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 11 additions & 29 deletions tests/functional/conftest.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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")
Expand Down Expand Up @@ -49,8 +47,6 @@ 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)

# Ensure everything has been reset
start_time = time.perf_counter()

Expand All @@ -60,15 +56,15 @@ def wait_for_list_size(
"""Wait for the list() length to be no greater than expected maximum or fail
test if timeout is exceeded"""
logging.info(f"Checking {description!r} has no more than {max_length} items")
for count in range(max_iterations):
for count in range(helpers.MAX_ITERATIONS):
items = rest_manager.list()
if len(items) <= max_length:
break
logging.info(
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 = (
Expand Down Expand Up @@ -280,10 +276,7 @@ def group(gl):

yield group

try:
group.delete()
except gitlab.exceptions.GitlabDeleteError as e:
print(f"Group already deleted: {e}")
helpers.safe_delete(group)


@pytest.fixture(scope="module")
Expand All @@ -296,10 +289,7 @@ def project(gl):

yield project

try:
project.delete()
except gitlab.exceptions.GitlabDeleteError as e:
print(f"Project already deleted: {e}")
helpers.safe_delete(project)


@pytest.fixture(scope="function")
Expand Down Expand Up @@ -327,7 +317,7 @@ def _merge_request(*, source_branch: str):
assert result is True, "sidekiq process should have terminated but did not"

project.refresh() # Gets us the current default branch
project.branches.create(
mr_branch = project.branches.create(
{"branch": source_branch, "ref": project.default_branch}
)
# NOTE(jlvillal): Must create a commit in the new branch before we can
Expand Down Expand Up @@ -359,18 +349,13 @@ def _merge_request(*, source_branch: str):
time.sleep(0.5)
assert mr.merge_status != "checking"

to_delete.append((mr.iid, source_branch))
to_delete.extend([mr, mr_branch])
return mr

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
for object in to_delete:
helpers.safe_delete(object)


@pytest.fixture(scope="module")
Expand Down Expand Up @@ -434,11 +419,8 @@ def user(gl):

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(user, hard_delete=True)


@pytest.fixture(scope="module")
Expand Down
39 changes: 39 additions & 0 deletions tests/functional/helpers.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
import logging
import time

import pytest

import gitlab.base

SLEEP_INTERVAL = 0.5
TIMEOUT = 60 # seconds before timeout will occur
MAX_ITERATIONS = int(TIMEOUT / SLEEP_INTERVAL)


def safe_delete(
object: gitlab.base.RESTObject,
*,
hard_delete: bool = False,
) -> None:
"""Ensure the object specified can not be retrieved. If object still exists after
timeout period, fail the test"""
manager = object.manager
for index in range(MAX_ITERATIONS):
try:
object = manager.get(object.get_id())
except gitlab.exceptions.GitlabGetError:
return

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

time.sleep(SLEEP_INTERVAL)
pytest.fail(f"{object!r} was not deleted")