feat(functional): #2547 merge-train api for status and add mr

isaac-philip · JohnVillalovos · commit d1b3e2aec494 · 2025-04-17T09:27:42.000-07:00
Signed-off-by: Isaac Philip &lt;4974658+isaac-philip@users.noreply.github.com&gt;
diff --git a/gitlab/v4/objects/merge_trains.py b/gitlab/v4/objects/merge_trains.py
@@ -1,5 +1,6 @@
 from gitlab.base import RESTManager, RESTObject
-from gitlab.mixins import CRUDMixin, GetMixin, ListMixin
+from gitlab.mixins import GetMixin, ListMixin, UpdateMethod, UpdateMixin
+from gitlab.types import RequiredOptional
 
 __all__ = [
     "ProjectMergeTrain",
@@ -13,10 +14,15 @@ class ProjectMergeTrainMergeRequest(RESTObject):
     pass
 
 
-class ProjectMergeTrainMergeRequestManager(CRUDMixin, RESTManager):
+class ProjectMergeTrainMergeRequestManager(GetMixin, UpdateMixin, RESTManager):
     _path = "/projects/{project_id}/merge_trains/merge_requests"
     _obj_cls = ProjectMergeTrainMergeRequest
     _from_parent_attrs = {"project_id": "project_id"}
+    _update_method: UpdateMethod = UpdateMethod.POST
+
+    _update_attrs = RequiredOptional(
+        optional=("sha", "squash", "when_pipeline_succeeds"),
+    )
 
 
 class ProjectMergeTrain(RESTObject):
diff --git a/tests/unit/objects/test_merge_trains.py b/tests/unit/objects/test_merge_trains.py
@@ -46,6 +46,10 @@
     "duration": 70,
 }
 
+merge_train_update = mr_content.copy()
+merge_train_update["id"] = 123
+merge_train_update["pipeline"]["sha"] = "ef33a3zxc3"
+
 
 @pytest.fixture
 def resp_list_merge_trains():
@@ -65,26 +69,51 @@ def resp_merge_trains_merge_request_get():
     with responses.RequestsMock() as rsps:
         rsps.add(
             method=responses.GET,
-            url="http://localhost/api/v4/projects/1/merge_trains/merge_requests/123",
+            url="http://localhost/api/v4/projects/1/merge_trains/merge_requests/110",
             json=mr_content,
             content_type="application/json",
             status=200,
         )
         yield rsps
 
 
+@pytest.fixture
+def resp_merge_trains_merge_request_post():
+    with responses.RequestsMock() as rsps:
+        rsps.add(
+            method=responses.POST,
+            url="http://localhost/api/v4/projects/1/merge_trains/merge_requests/123",
+            json=[merge_train_update],
+            content_type="application/json",
+            status=200,
+        )
+        yield rsps
+
+
 def test_list_project_merge_requests(project, resp_list_merge_trains):
     merge_trains = project.merge_trains.list()
     assert isinstance(merge_trains[0], ProjectMergeTrain)
     assert merge_trains[0].id == mr_content["id"]
 
 
-def test_merge_trains_status_merge_request(
+def test_merge_trains_status_merge_request_get_status(
     project, resp_merge_trains_merge_request_get
 ):
-    # flow will be : project -> merge_trains : -> get merge_requests -> merge_request_iod
     merge_train_mr: ProjectMergeTrainMergeRequest = project.merge_trains.get(
         1, lazy=True
-    ).merge_requests.get(123)
+    ).merge_requests.get(110)
     assert isinstance(merge_train_mr, ProjectMergeTrainMergeRequest)
     assert merge_train_mr.get_id() == 110
+    assert merge_train_mr.pipeline.get("status") == mr_content["pipeline"]["status"]
+
+
+def test_merge_train_add_merge_request(project, resp_merge_trains_merge_request_post):
+    merge_train: ProjectMergeTrain = project.merge_trains.get(1, lazy=True)
+    merge_requests_update = merge_train.merge_requests.update(
+        123, new_data={"sha": "ef33a3zxc3"}
+    )
+    assert isinstance(merge_train, ProjectMergeTrain)
+    assert (
+        merge_requests_update[0]["pipeline"]["sha"]
+        == merge_train_update["pipeline"]["sha"]
+    )
