Oct 31, 2022 · Oct 30, 2022
diff --git a/docs/gl_objects/merge_requests.rst b/docs/gl_objects/merge_requests.rst

    mr.merge()

 Cancel a MRwhenthebuild succeeds::
 Schedule a MRto merge afterthepipeline(s) succeed::

    mr.merge(merge_when_pipeline_succeeds=True)

 Cancel a MR from merging when the pipeline succeeds::

    # Cancel a MR from being merged that had been previously set to
    # 'merge_when_pipeline_succeeds=True'
    mr.cancel_merge_when_pipeline_succeeds()

 List commits of a MR::
diff --git a/gitlab/v4/objects/merge_requests.py b/gitlab/v4/objects/merge_requests.py

    @cli.register_custom_action("ProjectMergeRequest")
    @exc.on_http_error(exc.GitlabMROnBuildSuccessError)
    def cancel_merge_when_pipeline_succeeds(
        self, **kwargs: Any
    ) -> "ProjectMergeRequest":
    def cancel_merge_when_pipeline_succeeds(self, **kwargs: Any) -> Dict[str, str]:
        """Cancel merge when the pipeline succeeds.

        Args:
                request

        Returns:
 ProjectMergeRequest
 dict of the parsed json returned by the server
        """

        path = (
            f"{self.manager.path}/{self.encoded_id}/cancel_merge_when_pipeline_succeeds"
        )
        server_data = self.manager.gitlab.http_put(path, **kwargs)
        server_data = self.manager.gitlab.http_post(path, **kwargs)
        # 2022-10-30: The docs at
        # https://docs.gitlab.com/ee/api/merge_requests.html#cancel-merge-when-pipeline-succeeds
        # are incorrect in that the return value is actually just:
        #   {'status': 'success'}  for a successful cancel.
        if TYPE_CHECKING:
            assert isinstance(server_data, dict)
        self._update_attrs(server_data)
        return ProjectMergeRequest(self.manager, server_data)
        return server_data

    @cli.register_custom_action("ProjectMergeRequest")
    @exc.on_http_error(exc.GitlabListError)
diff --git a/tests/functional/api/test_merge_requests.py b/tests/functional/api/test_merge_requests.py
    assert mr.reset_approvals()


 def test_cancel_merge_when_pipeline_succeeds(project, merge_request, wait_for_sidekiq):
    mr = merge_request(source_branch="test_merge_request_merge", create_pipeline=True)
    # Set to merge when the pipeline succeeds, which should never happen
    mr.merge(merge_when_pipeline_succeeds=True)
    wait_for_sidekiq(timeout=60)

    mr = project.mergerequests.get(mr.iid)
    assert mr.merged_at is None
    assert mr.merge_when_pipeline_succeeds is True
    cancel = mr.cancel_merge_when_pipeline_succeeds()
    assert cancel == {"status": "success"}


 def test_merge_request_merge(project, merge_request, wait_for_sidekiq):
    mr = merge_request(source_branch="test_merge_request_merge")
    mr.merge()
    wait_for_sidekiq(timeout=60)

    mr = project.mergerequests.get(mr.iid)
    assert mr.merged_at is not None
    assert mr.merge_when_pipeline_succeeds is False
    with pytest.raises(gitlab.GitlabMRClosedError):
        # Two merge attempts should raise GitlabMRClosedError
        mr.merge()
diff --git a/tests/functional/conftest.py b/tests/functional/conftest.py

    to_delete = []

    def _merge_request(*, source_branch: str):
    def _merge_request(*, source_branch: str, create_pipeline: bool = False):
        # 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
                "commit_message": "New commit in new branch",
            }
        )
        if create_pipeline:
            project.files.create(
                {
                    "file_path": ".gitlab-ci.yml",
                    "branch": source_branch,
                    "content": """
 test:
  rules:
    - if: '$CI_PIPELINE_SOURCE == "merge_request_event"'
  script:
    - sleep 24h  # We don't expect this to finish
 """,
                    "commit_message": "Add a simple pipeline",
                }
            )
        mr = project.mergerequests.create(
            {
                "source_branch": source_branch,
Original file line number	Diff line number	Diff line change
Expand Up		@@ -122,8 +122,14 @@ Accept a MR::

		mr.merge()

		Cancel a MRwhenthebuild succeeds::
		Schedule a MRto merge afterthepipeline(s) succeed::

		mr.merge(merge_when_pipeline_succeeds=True)

		Cancel a MR from merging when the pipeline succeeds::

		# Cancel a MR from being merged that had been previously set to
		# 'merge_when_pipeline_succeeds=True'
		mr.cancel_merge_when_pipeline_succeeds()

		List commits of a MR::
Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -165,9 +165,7 @@ class ProjectMergeRequest(

		@cli.register_custom_action("ProjectMergeRequest")
		@exc.on_http_error(exc.GitlabMROnBuildSuccessError)
		def cancel_merge_when_pipeline_succeeds(
		self, **kwargs: Any
		) -> "ProjectMergeRequest":
		def cancel_merge_when_pipeline_succeeds(self, **kwargs: Any) -> Dict[str, str]:
JohnVillalovos marked this conversation as resolved. Show resolvedHide resolved
		"""Cancel merge when the pipeline succeeds.

		Args:
Expand All		@@ -179,17 +177,20 @@ def cancel_merge_when_pipeline_succeeds(
		request

		Returns:
		ProjectMergeRequest
		dict of the parsed json returned by the server
		"""

		path = (
		f"{self.manager.path}/{self.encoded_id}/cancel_merge_when_pipeline_succeeds"
		)
		server_data = self.manager.gitlab.http_put(path, **kwargs)
		server_data = self.manager.gitlab.http_post(path, **kwargs)
		# 2022-10-30: The docs at
		# https://docs.gitlab.com/ee/api/merge_requests.html#cancel-merge-when-pipeline-succeeds
		# are incorrect in that the return value is actually just:
		# {'status': 'success'} for a successful cancel.
		if TYPE_CHECKING:
		assert isinstance(server_data, dict)
		self._update_attrs(server_data)
		return ProjectMergeRequest(self.manager, server_data)
		return server_data

		@cli.register_custom_action("ProjectMergeRequest")
		@exc.on_http_error(exc.GitlabListError)
Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -181,11 +181,27 @@ def test_merge_request_reset_approvals(gitlab_url, project, wait_for_sidekiq):
		assert mr.reset_approvals()


		def test_cancel_merge_when_pipeline_succeeds(project, merge_request, wait_for_sidekiq):
		mr = merge_request(source_branch="test_merge_request_merge", create_pipeline=True)
		# Set to merge when the pipeline succeeds, which should never happen
		mr.merge(merge_when_pipeline_succeeds=True)
		wait_for_sidekiq(timeout=60)

		mr = project.mergerequests.get(mr.iid)
nejch marked this conversation as resolved. Show resolvedHide resolved
		assert mr.merged_at is None
		assert mr.merge_when_pipeline_succeeds is True
nejch marked this conversation as resolved. Show resolvedHide resolved
		cancel = mr.cancel_merge_when_pipeline_succeeds()
		assert cancel == {"status": "success"}


		def test_merge_request_merge(project, merge_request, wait_for_sidekiq):
		mr = merge_request(source_branch="test_merge_request_merge")
		mr.merge()
		wait_for_sidekiq(timeout=60)

		mr = project.mergerequests.get(mr.iid)
		assert mr.merged_at is not None
		assert mr.merge_when_pipeline_succeeds is False
		with pytest.raises(gitlab.GitlabMRClosedError):
		# Two merge attempts should raise GitlabMRClosedError
		mr.merge()
Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -379,7 +379,7 @@ def merge_request(project, wait_for_sidekiq):

		to_delete = []

		def _merge_request(*, source_branch: str):
		def _merge_request(*, source_branch: str, create_pipeline: bool = False):
		# 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
Expand All		@@ -401,6 +401,21 @@ def _merge_request(*, source_branch: str):
		"commit_message": "New commit in new branch",
		}
		)
		if create_pipeline:
		project.files.create(
		{
		"file_path": ".gitlab-ci.yml",
		"branch": source_branch,
		"content": """
		test:
		rules:
		- if: '$CI_PIPELINE_SOURCE == "merge_request_event"'
		script:
		- sleep 24h # We don't expect this to finish
		""",
		"commit_message": "Add a simple pipeline",
		}
		)
nejch marked this conversation as resolved. Show resolvedHide resolved nejch marked this conversation as resolved. Show resolvedHide resolved
		mr = project.mergerequests.create(
		{
		"source_branch": source_branch,
Expand Down