Merge pull request #1915 from kinbald/test-report-summary

nejch · web-flow · commit 79665841e5d9 · 2022-03-10T14:05:29.000+11:00
feat: add support for test report summary
diff --git a/docs/gl_objects/pipelines_and_jobs.rst b/docs/gl_objects/pipelines_and_jobs.rst
@@ -367,3 +367,27 @@ Examples
 Get the test report for a pipeline::
 
     test_report = pipeline.test_report.get()
+
+Pipeline test report summary
+============================
+
+Get a pipeline’s test report summary.
+
+Reference
+---------
+
+* v4 API
+
+  + :class:`gitlab.v4.objects.ProjectPipelineTestReportSummary`
+  + :class:`gitlab.v4.objects.ProjectPipelineTestReportSummaryManager`
+  + :attr:`gitlab.v4.objects.ProjectPipeline.test_report_summary`
+
+* GitLab API: https://docs.gitlab.com/ee/api/pipelines.html#get-a-pipelines-test-report-summary
+
+Examples
+--------
+
+Get the test report summary for a pipeline::
+
+    test_report_summary = pipeline.test_report_summary.get()
+
diff --git a/gitlab/v4/objects/pipelines.py b/gitlab/v4/objects/pipelines.py
@@ -35,6 +35,8 @@
     "ProjectPipelineScheduleManager",
     "ProjectPipelineTestReport",
     "ProjectPipelineTestReportManager",
+    "ProjectPipelineTestReportSummary",
+    "ProjectPipelineTestReportSummaryManager",
 ]
 
 
@@ -52,6 +54,7 @@ class ProjectPipeline(RefreshMixin, ObjectDeleteMixin, RESTObject):
     bridges: "ProjectPipelineBridgeManager"
     jobs: "ProjectPipelineJobManager"
     test_report: "ProjectPipelineTestReportManager"
+    test_report_summary: "ProjectPipelineTestReportSummaryManager"
     variables: "ProjectPipelineVariableManager"
 
     @cli.register_custom_action("ProjectPipeline")
@@ -251,3 +254,20 @@ def get(
         self, id: Optional[Union[int, str]] = None, **kwargs: Any
     ) -> Optional[ProjectPipelineTestReport]:
         return cast(Optional[ProjectPipelineTestReport], super().get(id=id, **kwargs))
+
+
+class ProjectPipelineTestReportSummary(RESTObject):
+    _id_attr = None
+
+
+class ProjectPipelineTestReportSummaryManager(GetWithoutIdMixin, RESTManager):
+    _path = "/projects/{project_id}/pipelines/{pipeline_id}/test_report_summary"
+    _obj_cls = ProjectPipelineTestReportSummary
+    _from_parent_attrs = {"project_id": "project_id", "pipeline_id": "id"}
+
+    def get(
+        self, id: Optional[Union[int, str]] = None, **kwargs: Any
+    ) -> Optional[ProjectPipelineTestReportSummary]:
+        return cast(
+            Optional[ProjectPipelineTestReportSummary], super().get(id=id, **kwargs)
+        )
diff --git a/tests/unit/objects/test_pipelines.py b/tests/unit/objects/test_pipelines.py
@@ -4,7 +4,11 @@
 import pytest
 import responses
 
-from gitlab.v4.objects import ProjectPipeline, ProjectPipelineTestReport
+from gitlab.v4.objects import (
+    ProjectPipeline,
+    ProjectPipelineTestReport,
+    ProjectPipelineTestReportSummary,
+)
 
 pipeline_content = {
     "id": 46,
@@ -66,6 +70,32 @@
 }
 
 
+test_report_summary_content = {
+    "total": {
+        "time": 1904,
+        "count": 3363,
+        "success": 3351,
+        "failed": 0,
+        "skipped": 12,
+        "error": 0,
+        "suite_error": None,
+    },
+    "test_suites": [
+        {
+            "name": "test",
+            "total_time": 1904,
+            "total_count": 3363,
+            "success_count": 3351,
+            "failed_count": 0,
+            "skipped_count": 12,
+            "error_count": 0,
+            "build_ids": [66004],
+            "suite_error": None,
+        }
+    ],
+}
+
+
 @pytest.fixture
 def resp_get_pipeline():
     with responses.RequestsMock() as rsps:
@@ -118,6 +148,19 @@ def resp_get_pipeline_test_report():
         yield rsps
 
 
+@pytest.fixture
+def resp_get_pipeline_test_report_summary():
+    with responses.RequestsMock() as rsps:
+        rsps.add(
+            method=responses.GET,
+            url="http://localhost/api/v4/projects/1/pipelines/1/test_report_summary",
+            json=test_report_summary_content,
+            content_type="application/json",
+            status=200,
+        )
+        yield rsps
+
+
 def test_get_project_pipeline(project, resp_get_pipeline):
     pipeline = project.pipelines.get(1)
     assert isinstance(pipeline, ProjectPipeline)
@@ -144,3 +187,13 @@ def test_get_project_pipeline_test_report(project, resp_get_pipeline_test_report
     assert isinstance(test_report, ProjectPipelineTestReport)
     assert test_report.total_time == 5
     assert test_report.test_suites[0]["name"] == "Secure"
+
+
+def test_get_project_pipeline_test_report_summary(
+    project, resp_get_pipeline_test_report_summary
+):
+    pipeline = project.pipelines.get(1, lazy=True)
+    test_report_summary = pipeline.test_report_summary.get()
+    assert isinstance(test_report_summary, ProjectPipelineTestReportSummary)
+    assert test_report_summary.total["count"] == 3363
+    assert test_report_summary.test_suites[0]["name"] == "test"
