Attempt to prevent intermittent failure TestGit/xxx/BranchProtectMerge/MergePR

[zeripath]

One of the repeated intermittent failures we see in testing is a failure due to
branches not being ready to merge.

Prior to the immediate queue implementation we would attempt to flush all the queues
and this would prevent the issue. However, the immediate queue is not flushable so
the flushall is not successful at preventing this.

This PR proposes an alternative solution - wait some time and try again up to 5 times.

If this fails then there is a genuine issue and we should fail.

Related #17719

Signed-off-by: Andrew Thornton [email protected]

[codecov-commenter]

Codecov Report

❗ No coverage uploaded for pull request base (main@b34923d). Click here to learn what that means.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main   #18451   +/-   ##
=======================================
  Coverage        ?   45.99%           
=======================================
  Files           ?      842           
  Lines           ?    93192           
  Branches        ?        0           
=======================================
  Hits            ?    42863           
  Misses          ?    43524           
  Partials        ?     6805           

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update b34923d...38970c5. Read the comment docs.

[wxiaoguang]

How about remove the duplicated code block.

func doAPIMergePullRequest(ctx APITestContext, owner, repo string, index int64) func(*testing.T) {
	return func(t *testing.T) {
		urlStr := fmt.Sprintf("/api/v1/repos/%s/%s/pulls/%d/merge?token=%s", owner, repo, index, ctx.Token)

		var req *http.Request
		var resp *httptest.ResponseRecorder
		for i := 0; i < 5; i++ {
			req = NewRequestWithJSON(t, http.MethodPost, urlStr, &forms.MergePullRequestForm{
				MergeMessageField: "doAPIMergePullRequest Merge",
				Do:                string(repo_model.MergeStyleMerge),
			})
			resp = ctx.Session.MakeRequest(t, req, NoExpectedStatus)
			if resp.Code != http.StatusMethodNotAllowed {
				break
			}
			err := api.APIError{}
			DecodeJSON(t, resp, &err)
			if !assert.EqualValues(t, "Please try again later", err.Message) {
				break
			}
			_ = queue.GetManager().FlushAll(context.Background(), 5*time.Second)
			<-time.After(1 * time.Second)
		}

		expected := ctx.ExpectedCode
		if expected == 0 {
			expected = 200
		}

		if !assert.EqualValues(t, expected, resp.Code,
			"Request: %s %s", req.Method, req.URL.String()) {
			logUnexpectedResponse(t, resp)
		}
	}
}

[zeripath]

@wxiaoguang done.