feat(objects): add Project CI Lint support

JohnVillalovos · JohnVillalovos · commit 3e8562dfae2f · 2022-05-29T10:06:34.000-07:00
Add support for validating a project's CI configuration [1] TODO: Add tests [1] https://docs.gitlab.com/ee/api/lint.html#validate-a-projects-ci-configuration
diff --git a/docs/gl_objects/projects.rst b/docs/gl_objects/projects.rst
@@ -784,6 +784,29 @@ Get total fetches in last 30 days of a project::
 
     total_fetches = project.additionalstatistics.get().fetches['total']
 
+Project CI Lint
+=============================
+
+Reference
+---------
+
+* v4 API:
+
+  + :class:`gitlab.v4.objects.ProjectCiLint`
+  + :class:`gitlab.v4.objects.ProjectCiLintManager`
+  + :attr:`gitlab.v4.objects.Project.ci_lint`
+
+* GitLab API: https://docs.gitlab.com/ee/api/lint.html#validate-a-projects-ci-configuration
+
+Examples
+---------
+
+Validate a project's CI configuration::
+
+    lint_result = project.ci_lint.get()
+    assert lint_result.valid is True  # Test that the .gitlab-ci.yml is valid
+    print(lint_result.merged_yaml)    # Print the merged YAML file
+
 Project storage
 =============================
 
diff --git a/gitlab/v4/objects/projects.py b/gitlab/v4/objects/projects.py
@@ -1,3 +1,8 @@
+"""
+GitLab API:
+https://docs.gitlab.com/ee/api/projects.html
+https://docs.gitlab.com/ee/api/lint.html#validate-a-projects-ci-configuration
+"""
 from typing import Any, Callable, cast, Dict, List, Optional, TYPE_CHECKING, Union
 
 import requests
@@ -83,6 +88,8 @@
     "ProjectRemoteMirrorManager",
     "ProjectStorage",
     "ProjectStorageManager",
+    "ProjectCiLint",
+    "ProjectCiLintManager",
 ]
 
 
@@ -144,6 +151,7 @@ class Project(RefreshMixin, SaveMixin, ObjectDeleteMixin, RepositoryMixin, RESTO
     badges: ProjectBadgeManager
     boards: ProjectBoardManager
     branches: ProjectBranchManager
+    ci_lint: "ProjectCiLintManager"
     clusters: ProjectClusterManager
     commits: ProjectCommitManager
     customattributes: ProjectCustomAttributeManager
@@ -1032,3 +1040,27 @@ def get(
         self, id: Optional[Union[int, str]] = None, **kwargs: Any
     ) -> Optional[ProjectStorage]:
         return cast(Optional[ProjectStorage], super().get(id=id, **kwargs))
+
+
+class ProjectCiLint(RESTObject):
+    pass
+
+
+class ProjectCiLintManager(GetWithoutIdMixin, RESTManager):
+    _path = "/projects/{project_id}/ci/lint"
+    _obj_cls = ProjectCiLint
+    _from_parent_attrs = {"project_id": "id"}
+    # https://docs.gitlab.com/ee/api/lint.html#validate-a-projects-ci-configuration
+
+    def get(
+        self, id: Optional[Union[int, str]] = None, **kwargs: Any
+    ) -> Optional[ProjectCiLint]:
+        if id is not None:
+            raise AttributeError("Unsupported attribute: id")
+
+        if TYPE_CHECKING:
+            assert self.path is not None
+        server_data = self.gitlab.http_get(self.path, **kwargs)
+        if TYPE_CHECKING:
+            assert isinstance(server_data, dict)
+        return self._obj_cls(self, server_data)
