0.22.3: Failure to apply Gitlab MR if project is set to "Pipelines must succeed"

[rhysm]

Community Note

• Please vote on this issue by adding a 👍 reaction to the original issue to help the community and maintainers prioritize this request. Searching for pre-existing feature requests helps us consolidate datapoints for identical requirements into a single place, thank you!
• Please do not leave "+1" or other comments that do not add relevant new information or questions, they generate extra noise for issue followers and do not help prioritize the request.
• If you are interested in working on this issue or have submitted a pull request, please leave a comment.

---

Overview of the Issue

Since upgrading to 0.22.3 and with the introduction of this change 71738f1 it seems that merge requests in Gitlab cannot be applied if "Pipelines must succeed" is enabled for the project.

Before running apply and with all other CI stages successful the status of the MR from GitLab is:

  "merge_status": "can_be_merged",
  "detailed_merge_status": "mergeable",

Shortly after issuing the apply command the status is updated to:

  "merge_status": "can_be_merged",
  "detailed_merge_status": "ci_still_running",

I think Atlantis own "external" CI job status is being reported as in progress so when Atlantis checks the MR the status is no longer "mergeable" as it expects.

Reproduction Steps

1. Raise MR in GitLab project with "Pipelines must succeed" enabled
2. Run atlantis plan
3. Run atlantis apply
4. Atlantis should fail to apply here

Logs

Failure running apply operation: Pull request must be mergeable before running apply.

Environment details

Gitlab 15.8
Atlantis 0.22.3

[nitrocode]

Ah this was caused by merging this pr 2960 because the new go-gitlab module required changes due to deprecations. See the 0.77.0 to 0.78.0 changes.

• fix(deps): update module github.com/xanzy/go-gitlab to v0.78.0 in go.mod #2960

atlantis/server/events/vcs/gitlab_client.go

Lines 224 to 230 in 71738f1

	if mr.DetailedMergeStatus == "mergeable" &&
	mr.ApprovalsBeforeMerge <= 0 &&
	mr.BlockingDiscussionsResolved &&
	!mr.WorkInProgress &&
	(allowSkippedPipeline || !isPipelineSkipped) {
	return true, nil
	}

Should we also check for ci_still_running?

- 	if mr.DetailedMergeStatus == "mergeable" &&
+	if (mr.DetailedMergeStatus == "mergeable" || mr.DetailedMergeStatus == "ci_still_running") && 

Or

- 	if mr.DetailedMergeStatus == "mergeable" &&
+	if mr.DetailedMergeStatus == "ci_still_running" && 

Please see if you can look through the changes to spot the bug if you have the time

[rhysm]

Should we also check for ci_still_running?

- 	if mr.DetailedMergeStatus == "mergeable" &&
+	if (mr.DetailedMergeStatus == "mergeable" || mr.DetailedMergeStatus == "ci_still_running") && 

Yeah I think that will work as the earlier code checks the actual pipeline statuses for success. The old merge_status field would be set to mergeable even if CI was still running.

[nitrocode]

@rhysm let's try it. I put in a pr for it. Could you give it a shot when you get a chance and see if it resolves the issue for you?

[nitrocode]

@rhysm there are other statuses too. Are you sure checking for only mergeable or ci_still_running is enough?

https://github.com/xanzy/go-gitlab/blob/ce77452fb9df815b6f9dbaf8b64f52b152a55ba5/deployments_merge_requests_test.go#L33-L45

[rhysm]

@nitrocode apologies for the delay, had some unrelated issues that meant I couldn't fully test.

I have tested that branch and things seem to be working fine. I have also had a look over those additional statuses and I think if the MR was in any of those other statuses then we would not want the MR to be applied, so mergeable or ci_still_running is enough.

[nitrocode]

Thank you for confirming @rhysm . I received approval for the change and it merged resulting in a new dev tag image. Please use the latest image and it should resolve your issue until the next official release.

https://github.com/runatlantis/atlantis/pkgs/container/atlantis

[zerog2k]

can you tell if this is fixed in v0.23.3 ?
I'm running into this same problem on gitlab ee 14.10.5, after upgrading from v0.17.0 (it was working on 0.17.0)
with apply_requirements: [approved, mergeable]
("pipelines must succeed" is checked on my repo)

[zerog2k]

ok, my issue is a separate (but related) bug - created #3258