fix: GitLab - use "approvals_left" instead of "approvals_before_merge" when checking if pull is mergeable #5049
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
CaioAugustoo
requested review from
GenPage,
lukemassa and
nitrocode
and removed request for
a team
CaioAugustoo
changed the title
|
Hi @CaioAugustoo, thanks for this. Some of the current GitLab tests are failing after your change. Can you take a look at these? New tests are also needed to cover this new code. |
X-Guardian
added
needs tests
X-Guardian
changed the title
|
@CaioAugustoo, please sign your coming to pass the DCO test. |
X-Guardian
requested changes
Jan 25, 2025
| @@ -816,6 +816,10 @@ func TestGitlabClient_PullIsMergeable(t *testing.T) { | |||
| case fmt.Sprintf("/api/v4/projects/runatlantis%%2Fatlantis/merge_requests/%v", defaultMr): | |||
| w.WriteHeader(http.StatusOK) | |||
| w.Write(pipelineSuccess) // nolint: errcheck | |||
| case fmt.Sprintf("/api/v4/projects/runatlantis%%2Fatlantis/merge_requests/%v/approvals", c.mrID): | |||
There was a problem hiding this comment.
Can you enhance the tests for this? It needs a test where approvals_left is 0 and another where approvals_left is greater than 0.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
what
Currently, Atlantis uses the
approvals_before_mergefield on GitLab client in order to check if MR is mergeable. But using that field is not correctly becauseapprovals_before_mergeis the configured number of approvals required for the MR and not the remaining number of approvals.This PR will fix that. Also, there is a related issue here.
why
In cases that GitLab users updates the
approvals_before_mergeon any MR, Atlantis will throwApply Failed: Pull request must be mergeable before running apply.error. You can read more here.tests
Tested locally
references
Relates to #4949