test: strip out wait_for_sidekiq and use simple sleep

TimKnight-DWP · TimKnight-DWP · commit 215ddcce90e7 · 2024-02-12T11:49:29.000Z
diff --git a/tests/functional/api/test_lazy_objects.py b/tests/functional/api/test_lazy_objects.py
@@ -1,3 +1,5 @@
+import time
+
 import pytest
 
 import gitlab
@@ -27,9 +29,10 @@ def test_save_after_lazy_get_with_path(project, lazy_project):
     assert lazy_project.description == "A new description"
 
 
-def test_delete_after_lazy_get_with_path(gl, group, wait_for_sidekiq):
+def test_delete_after_lazy_get_with_path(gl, group):
     project = gl.projects.create({"name": "lazy_project", "namespace_id": group.id})
-    wait_for_sidekiq(timeout=60)
+    # Pause to let GL catch up (happens on hosted too, sometimes takes a while for server to be ready to merge)
+    time.sleep(5)
     lazy_project = gl.projects.get(project.path_with_namespace, lazy=True)
     lazy_project.delete()
 
diff --git a/tests/functional/api/test_merge_requests.py b/tests/functional/api/test_merge_requests.py
@@ -168,23 +168,24 @@ def test_project_merge_request_approval_rules(group, project):
     assert len(ars) == 0
 
 
-def test_merge_request_reset_approvals(gitlab_url, project, wait_for_sidekiq):
+def test_merge_request_reset_approvals(gitlab_url, project):
     bot = project.access_tokens.create({"name": "bot", "scopes": ["api"]})
     bot_gitlab = gitlab.Gitlab(gitlab_url, private_token=bot.token)
     bot_project = bot_gitlab.projects.get(project.id, lazy=True)
 
-    wait_for_sidekiq(timeout=60)
+    # Pause to let GL catch up (happens on hosted too, sometimes takes a while for server to be ready to merge)
+    time.sleep(5)
     mr = bot_project.mergerequests.list()[0]  # type: ignore[index]
     assert mr.reset_approvals()
 
 
-def test_cancel_merge_when_pipeline_succeeds(
-    project, merge_request_with_pipeline, wait_for_sidekiq
-):
-    wait_for_sidekiq(timeout=60)
+def test_cancel_merge_when_pipeline_succeeds(project, merge_request_with_pipeline):
+    # Pause to let GL catch up (happens on hosted too, sometimes takes a while for server to be ready to merge)
+    time.sleep(5)
     # Set to merge when the pipeline succeeds, which should never happen
     merge_request_with_pipeline.merge(merge_when_pipeline_succeeds=True)
-    wait_for_sidekiq(timeout=60)
+    # Pause to let GL catch up (happens on hosted too, sometimes takes a while for server to be ready to merge)
+    time.sleep(5)
 
     mr = project.mergerequests.get(merge_request_with_pipeline.iid)
     assert mr.merged_at is None
@@ -193,9 +194,10 @@ def test_cancel_merge_when_pipeline_succeeds(
     assert cancel == {"status": "success"}
 
 
-def test_merge_request_merge(project, merge_request, wait_for_sidekiq):
+def test_merge_request_merge(project, merge_request):
     merge_request.merge()
-    wait_for_sidekiq(timeout=60)
+    # Pause to let GL catch up (happens on hosted too, sometimes takes a while for server to be ready to merge)
+    time.sleep(5)
 
     mr = project.mergerequests.get(merge_request.iid)
     assert mr.merged_at is not None
@@ -205,15 +207,14 @@ def test_merge_request_merge(project, merge_request, wait_for_sidekiq):
         mr.merge()
 
 
-def test_merge_request_should_remove_source_branch(
-    project, merge_request, wait_for_sidekiq
-) -> None:
+def test_merge_request_should_remove_source_branch(project, merge_request) -> None:
     """Test to ensure
     https://github.com/python-gitlab/python-gitlab/issues/1120 is fixed.
     Bug reported that they could not use 'should_remove_source_branch' in
     mr.merge() call"""
     merge_request.merge(should_remove_source_branch=True)
-    wait_for_sidekiq(timeout=60)
+    # Pause to let GL catch up (happens on hosted too, sometimes takes a while for server to be ready to merge)
+    time.sleep(5)
 
     # Wait until it is merged
     mr = None
@@ -227,7 +228,8 @@ def test_merge_request_should_remove_source_branch(
     assert mr is not None
     assert mr.merged_at is not None
     time.sleep(0.5)
-    wait_for_sidekiq(timeout=60)
+    # Pause to let GL catch up (happens on hosted too, sometimes takes a while for server to be ready to merge)
+    time.sleep(5)
 
     # Ensure we can NOT get the MR branch
     with pytest.raises(gitlab.exceptions.GitlabGetError):
@@ -240,9 +242,7 @@ def test_merge_request_should_remove_source_branch(
         print("result:", pprint.pformat(result))
 
 
-def test_merge_request_large_commit_message(
-    project, merge_request, wait_for_sidekiq
-) -> None:
+def test_merge_request_large_commit_message(project, merge_request) -> None:
     """Test to ensure https://github.com/python-gitlab/python-gitlab/issues/1452
     is fixed.
     Bug reported that very long 'merge_commit_message' in mr.merge() would
@@ -255,7 +255,8 @@ def test_merge_request_large_commit_message(
         merge_commit_message=merge_commit_message, should_remove_source_branch=False
     )
 
-    wait_for_sidekiq(timeout=60)
+    # Pause to let GL catch up (happens on hosted too, sometimes takes a while for server to be ready to merge)
+    time.sleep(5)
 
     # Wait until it is merged
     mr = None
@@ -279,9 +280,7 @@ def test_merge_request_merge_ref(merge_request) -> None:
     assert response and "commit_id" in response
 
 
-def test_merge_request_merge_ref_should_fail(
-    project, merge_request, wait_for_sidekiq
-) -> None:
+def test_merge_request_merge_ref_should_fail(project, merge_request) -> None:
     # Create conflict
     project.files.create(
         {
@@ -291,7 +290,8 @@ def test_merge_request_merge_ref_should_fail(
             "commit_message": "Another commit in main branch",
         }
     )
-    wait_for_sidekiq(timeout=60)
+    # Pause to let GL catch up (happens on hosted too, sometimes takes a while for server to be ready to merge)
+    time.sleep(5)
 
     # Check for non-existing merge_ref for MR with conflicts
     with pytest.raises(gitlab.exceptions.GitlabGetError):
diff --git a/tests/functional/api/test_users.py b/tests/functional/api/test_users.py
@@ -4,6 +4,8 @@
 https://docs.gitlab.com/ee/api/users.html#delete-authentication-identity-from-user
 """
 
+import time
+
 import requests
 
 
@@ -60,7 +62,7 @@ def test_ban_user(gl, user):
     assert retrieved_user.state == "active"
 
 
-def test_delete_user(gl, wait_for_sidekiq):
+def test_delete_user(gl):
     new_user = gl.users.create(
         {
             "email": "delete-user@test.com",
@@ -71,7 +73,8 @@ def test_delete_user(gl, wait_for_sidekiq):
     )
 
     new_user.delete()
-    wait_for_sidekiq(timeout=60)
+    # Pause to let GL catch up (happens on hosted too, sometimes takes a while for server to be ready to merge)
+    time.sleep(5)
 
     assert new_user.id not in [user.id for user in gl.users.list()]
 
diff --git a/tests/functional/cli/test_cli_repository.py b/tests/functional/cli/test_cli_repository.py
@@ -77,12 +77,9 @@ def test_list_merge_request_commits(gitlab_cli, merge_request, project):
     assert ret.stdout
 
 
-def test_commit_merge_requests(gitlab_cli, project, merge_request, wait_for_sidekiq):
-    """This tests the `project-commit merge-requests` command and also tests
-    that we can print the result using the `json` formatter"""
-    # Merge the MR first
-    wait_for_sidekiq(timeout=60)
-
+def test_commit_merge_requests(gitlab_cli, project, merge_request):
+    # Pause to let GL catch up (happens on hosted too, sometimes takes a while for server to be ready to merge)
+    time.sleep(5)
     logging.info(f"MR status: {merge_request.state}")
     logging.info(f"MR merge status: {merge_request.detailed_merge_status}")
 
@@ -95,7 +92,8 @@ def test_commit_merge_requests(gitlab_cli, project, merge_request, wait_for_side
         time.sleep(5)
 
     merge_result = merge_request.merge(should_remove_source_branch=True)
-    wait_for_sidekiq(timeout=60)
+    # Pause to let GL catch up (happens on hosted too, sometimes takes a while for server to be ready to merge)
+    time.sleep(5)
 
     # Wait until it is merged
     mr = None
@@ -108,8 +106,8 @@ def test_commit_merge_requests(gitlab_cli, project, merge_request, wait_for_side
 
     assert mr is not None
     assert mr.merged_at is not None
-    time.sleep(0.5)
-    wait_for_sidekiq(timeout=60)
+    # Pause to let GL catch up (happens on hosted too, sometimes takes a while for server to be ready to merge)
+    time.sleep(5)
 
     commit_sha = merge_result["sha"]
     cmd = [
diff --git a/tests/functional/cli/test_cli_v4.py b/tests/functional/cli/test_cli_v4.py
@@ -231,7 +231,7 @@ def test_create_merge_request(gitlab_cli, project):
     assert ret.success
 
 
-def test_accept_request_merge(gitlab_cli, project, wait_for_sidekiq):
+def test_accept_request_merge(gitlab_cli, project):
     # MR needs at least 1 commit before we can merge
     mr = project.mergerequests.list()[0]
     file_data = {
@@ -241,8 +241,8 @@ def test_accept_request_merge(gitlab_cli, project, wait_for_sidekiq):
         "commit_message": "chore: test-cli-v4 change",
     }
     project.files.create(file_data)
+    # Pause to let GL catch up (happens on hosted too, sometimes takes a while for server to be ready to merge)
     time.sleep(30)
-    wait_for_sidekiq(timeout=60)
 
     logging.info(f"MR status: {mr.state}")
     logging.info(f"MR merge status: {mr.detailed_merge_status}")
@@ -260,10 +260,10 @@ def test_accept_request_merge(gitlab_cli, project, wait_for_sidekiq):
         ]
         gitlab_cli(approve_cmd)
 
+        # Pause to let GL catch up (happens on hosted too, sometimes takes a while for server to be ready to merge)
         time.sleep(5)
         logging.info(f"MR merge status: {mr.detailed_merge_status}")
 
-    time.sleep(0.5)
     approve_cmd = [
         "project-merge-request",
         "merge",
diff --git a/tests/functional/conftest.py b/tests/functional/conftest.py
@@ -208,42 +208,6 @@ def _check(
     return _check
 
 
-@pytest.fixture
-def wait_for_sidekiq(gl):
-    """
-    Return a helper function to wait until there are spare sidekiq processes.
-
-    Because not all Groups can be deleted immediately in GL 16, we will likely have busy Sidekiq jobs
-    set aside for their deletion in 1 days time.
-
-    Use this with asserts for slow tasks (group/project/user creation/deletion).
-
-    { ..., 'labels': [], 'concurrency': 20, 'busy': 3}
-    """
-
-    def _wait(timeout: int = 30, step: float = 0.5, allow_fail: bool = False) -> bool:
-        for count in range(timeout):
-            time.sleep(step)
-            processes = gl.sidekiq.process_metrics()["processes"]
-            busy_processes = 0
-            total_concurrency = 0
-            for process in processes:
-                busy_processes += process["busy"]
-                total_concurrency += process["concurrency"]
-
-            logging.info(f"Busy processes {busy_processes}")
-            #  If we have space concurrency in the process, continue
-            if busy_processes < total_concurrency:
-                logging.info("Spare sidekiq process found")
-                return True
-
-            logging.info(f"sidekiq busy {count} of {timeout}")
-        assert allow_fail, "sidekiq process should have terminated but did not."
-        return False
-
-    return _wait
-
-
 @pytest.fixture(scope="session")
 def gitlab_token(
     check_is_alive,
@@ -386,7 +350,7 @@ def project(gl):
 
 
 @pytest.fixture(scope="function")
-def make_merge_request(project, wait_for_sidekiq):
+def make_merge_request(project):
     """Fixture factory used to create a merge_request.
 
     It will create a branch, add a commit to the branch, and then create a
@@ -406,8 +370,8 @@ def _make_merge_request(*, source_branch: str, create_pipeline: bool = False):
         # NOTE(jlvillal): Sometimes the CI would give a "500 Internal Server
         # Error". Hoping that waiting until all other processes are done will
         # help with that.
-        result = wait_for_sidekiq(timeout=60)
-        assert result is True, "sidekiq process should have terminated but did not"
+        # Pause to let GL catch up (happens on hosted too, sometimes takes a while for server to be ready to merge)
+        time.sleep(30)
 
         project.refresh()  # Gets us the current default branch
         logging.info(f"Creating branch {source_branch}")
@@ -453,8 +417,9 @@ def _make_merge_request(*, source_branch: str, create_pipeline: bool = False):
                 "remove_source_branch": True,
             }
         )
-        result = wait_for_sidekiq(timeout=60)
-        assert result is True, "sidekiq process should have terminated but did not"
+
+        # Pause to let GL catch up (happens on hosted too, sometimes takes a while for server to be ready to merge)
+        time.sleep(5)
 
         mr_iid = mr.iid
         for _ in range(60):
