chore: simplify functional tests

JohnVillalovos · JohnVillalovos · commit 2aaf3958a199 · 2021-05-23T21:06:56.000-07:00
Add a helper function to have less code duplication in the functional
testing.
diff --git a/tools/functional/api/test_merge_requests.py b/tools/functional/api/test_merge_requests.py
@@ -100,13 +100,21 @@ def test_merge_request_merge(project):
         mr.merge()
 
 
-def test_merge_request_should_remove_source_branch(
-    project: gitlab.v4.objects.Project, wait_for_sidekiq
+def merge_request_create_helper(
+    *,
+    project: gitlab.v4.objects.Project,
+    source_branch: str,
+    wait_for_sidekiq,
+    branch_will_be_deleted: bool,
+    **kwargs,
 ):
-    """Test to ensure https://github.com/python-gitlab/python-gitlab/issues/1120
-    is fixed"""
+    # Wait for processes to be done before we start...
+    # 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"
 
-    source_branch = "remove_source_branch"
     project.branches.create({"branch": source_branch, "ref": "master"})
 
     # NOTE(jlvillal): Must create a commit in the new branch before we can
@@ -143,73 +151,63 @@ def test_merge_request_should_remove_source_branch(
     # Ensure we can get the MR branch
     project.branches.get(source_branch)
 
-    mr.merge(should_remove_source_branch=True)
+    mr.merge(**kwargs)
 
     result = wait_for_sidekiq(timeout=60)
     assert result is True, "sidekiq process should have terminated but did not"
 
-    # Ensure we can NOT get the MR branch
-    with pytest.raises(gitlab.exceptions.GitlabGetError):
-        project.branches.get(source_branch)
+    # Wait until it is merged
+    mr_iid = mr.iid
+    for _ in range(60):
+        mr = project.mergerequests.get(mr_iid)
+        if mr.merged_at is not None:
+            break
+        time.sleep(0.5)
+    assert mr.merged_at is not None
+    time.sleep(0.5)
 
-    mr = project.mergerequests.get(mr.iid)
-    assert mr.merged_at is not None  # Now is merged
+    if branch_will_be_deleted:
+        # Ensure we can NOT get the MR branch
+        with pytest.raises(gitlab.exceptions.GitlabGetError):
+            project.branches.get(source_branch)
 
 
-def test_merge_request_large_commit_message(
+def test_merge_request_should_remove_source_branch(
     project: gitlab.v4.objects.Project, wait_for_sidekiq
 ):
-    """Test to ensure https://github.com/python-gitlab/python-gitlab/issues/1452
-    is fixed"""
-    source_branch = "large_commit_message"
-    project.branches.create({"branch": source_branch, "ref": "master"})
+    """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"""
 
-    # NOTE(jlvillal): Must create a commit in the new branch before we can
-    # create an MR that will work.
-    project.files.create(
-        {
-            "file_path": f"README.{source_branch}",
-            "branch": source_branch,
-            "content": "Initial content",
-            "commit_message": "New commit in new branch",
-        }
-    )
+    source_branch = "remove_source_branch"
 
-    mr = project.mergerequests.create(
-        {
-            "source_branch": source_branch,
-            "target_branch": "master",
-            "title": "Large Commit Message",
-            "remove_source_branch": True,
-        }
+    merge_request_create_helper(
+        project=project,
+        source_branch=source_branch,
+        wait_for_sidekiq=wait_for_sidekiq,
+        branch_will_be_deleted=True,
+        should_remove_source_branch=True,
     )
 
-    result = wait_for_sidekiq(timeout=60)
-    assert result is True, "sidekiq process should have terminated but did not"
-
-    mr_iid = mr.iid
-    for _ in range(60):
-        mr = project.mergerequests.get(mr_iid)
-        if mr.merge_status != "checking":
-            break
-        time.sleep(0.5)
-    assert mr.merge_status != "checking"
 
-    # Ensure we can get the MR branch
-    project.branches.get(source_branch)
-
-    commit_message = "large_message\r\n" * 1_000
-    assert len(commit_message) > 10_000
-    assert mr.merged_at is None  # Not yet merged
-
-    mr.merge(merge_commit_message=commit_message, should_remove_source_branch=True)
-
-    result = wait_for_sidekiq(timeout=60)
-    assert result is True, "sidekiq process should have terminated but did not"
+def test_merge_request_large_commit_message(
+    project: gitlab.v4.objects.Project, wait_for_sidekiq
+):
+    """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
+    cause an error: 414 Request too large
+    """
+    source_branch = "large_commit_message"
 
-    # Ensure we can NOT get the MR branch
-    with pytest.raises(gitlab.exceptions.GitlabGetError):
-        project.branches.get(source_branch)
+    merge_commit_message = "large_message\r\n" * 1_000
+    assert len(merge_commit_message) > 10_000
 
-    mr = project.mergerequests.get(mr.iid)
-    assert mr.merged_at is not None  # Now is merged
+    merge_request_create_helper(
+        project=project,
+        source_branch=source_branch,
+        wait_for_sidekiq=wait_for_sidekiq,
+        branch_will_be_deleted=False,
+        merge_commit_message=merge_commit_message,
+    )
