feat(cli): add support for global CI lint

nejch · JohnVillalovos · commit 3f67c4b0fb0b · 2022-07-05T09:19:34.000-07:00
diff --git a/gitlab/client.py b/gitlab/client.py
@@ -126,6 +126,8 @@ def __init__(
 
         self.broadcastmessages = objects.BroadcastMessageManager(self)
         """See :class:`~gitlab.v4.objects.BroadcastMessageManager`"""
+        self.ci_lint = objects.CiLintManager(self)
+        """See :class:`~gitlab.v4.objects.CiLintManager`"""
         self.deploykeys = objects.DeployKeyManager(self)
         """See :class:`~gitlab.v4.objects.DeployKeyManager`"""
         self.deploytokens = objects.DeployTokenManager(self)
@@ -397,6 +399,11 @@ def lint(self, content: str, **kwargs: Any) -> Tuple[bool, List[str]]:
         Returns:
             (True, []) if the file is valid, (False, errors(list)) otherwise
         """
+        utils.warn(
+            "`lint()` is deprecated and will be removed in a future version.\n"
+            "Please use `ci_lint.create()` instead.",
+            category=DeprecationWarning,
+        )
         post_data = {"content": content}
         data = self.http_post("/ci/lint", post_data=post_data, **kwargs)
         if TYPE_CHECKING:
diff --git a/gitlab/v4/objects/ci_lint.py b/gitlab/v4/objects/ci_lint.py
@@ -9,6 +9,25 @@
 from gitlab.mixins import CreateMixin, GetWithoutIdMixin
 from gitlab.types import RequiredOptional
 
+__all__ = [
+    "CiLint",
+    "CiLintManager",
+    "ProjectCiLint",
+    "ProjectCiLintManager",
+]
+
+
+class CiLint(RESTObject):
+    _id_attr = None
+
+
+class CiLintManager(CreateMixin, RESTManager):
+    _path = "/ci/lint"
+    _obj_cls = CiLint
+    _create_attrs = RequiredOptional(
+        required=("content",), optional=("include_merged_yaml", "include_jobs")
+    )
+
 
 class ProjectCiLint(RESTObject):
     pass
diff --git a/gitlab/v4/objects/projects.py b/gitlab/v4/objects/projects.py
@@ -38,7 +38,7 @@
 from .badges import ProjectBadgeManager  # noqa: F401
 from .boards import ProjectBoardManager  # noqa: F401
 from .branches import ProjectBranchManager, ProjectProtectedBranchManager  # noqa: F401
-from .ci_lint import ProjectCiLint, ProjectCiLintManager  # noqa: F401
+from .ci_lint import ProjectCiLintManager  # noqa: F401
 from .clusters import ProjectClusterManager  # noqa: F401
 from .commits import ProjectCommitManager  # noqa: F401
 from .container_registry import ProjectRegistryRepositoryManager  # noqa: F401
@@ -102,8 +102,6 @@
     "ProjectRemoteMirrorManager",
     "ProjectStorage",
     "ProjectStorageManager",
-    "ProjectCiLint",
-    "ProjectCiLintManager",
 ]
 
 
@@ -165,7 +163,7 @@ class Project(RefreshMixin, SaveMixin, ObjectDeleteMixin, RepositoryMixin, RESTO
     badges: ProjectBadgeManager
     boards: ProjectBoardManager
     branches: ProjectBranchManager
-    ci_lint: "ProjectCiLintManager"
+    ci_lint: ProjectCiLintManager
     clusters: ProjectClusterManager
     commits: ProjectCommitManager
     customattributes: ProjectCustomAttributeManager
diff --git a/tests/unit/objects/test_ci_lint.py b/tests/unit/objects/test_ci_lint.py
@@ -1,7 +1,15 @@
 import pytest
 import responses
 
-ci_lint_get_content = {
+gitlab_ci_yml = """---
+:test_job:
+  :script: echo 1
+"""
+
+ci_lint_create_content = {"status": "valid", "errors": [], "warnings": []}
+
+
+project_ci_lint_content = {
     "valid": True,
     "merged_yaml": "---\n:test_job:\n  :script: echo 1\n",
     "errors": [],
@@ -10,40 +18,54 @@
 
 
 @pytest.fixture
-def resp_get_ci_lint():
+def resp_create_ci_lint():
+    with responses.RequestsMock() as rsps:
+        rsps.add(
+            method=responses.POST,
+            url="http://localhost/api/v4/ci/lint",
+            json=ci_lint_create_content,
+            content_type="application/json",
+            status=200,
+        )
+        yield rsps
+
+
+@pytest.fixture
+def resp_get_project_ci_lint():
     with responses.RequestsMock() as rsps:
         rsps.add(
             method=responses.GET,
             url="http://localhost/api/v4/projects/1/ci/lint",
-            json=ci_lint_get_content,
+            json=project_ci_lint_content,
             content_type="application/json",
             status=200,
         )
         yield rsps
 
 
 @pytest.fixture
-def resp_create_ci_lint():
+def resp_create_project_ci_lint():
     with responses.RequestsMock() as rsps:
         rsps.add(
             method=responses.POST,
             url="http://localhost/api/v4/projects/1/ci/lint",
-            json=ci_lint_get_content,
+            json=project_ci_lint_content,
             content_type="application/json",
             status=200,
         )
         yield rsps
 
 
-def test_project_ci_lint_get(project, resp_get_ci_lint):
+def test_ci_lint_create(gl, resp_create_ci_lint):
+    lint_result = gl.ci_lint.create({"content": gitlab_ci_yml})
+    assert lint_result.status == "valid"
+
+
+def test_project_ci_lint_get(project, resp_get_project_ci_lint):
     lint_result = project.ci_lint.get()
     assert lint_result.valid is True
 
 
-def test_project_ci_lint_create(project, resp_create_ci_lint):
-    gitlab_ci_yml = """---
-:test_job:
-  :script: echo 1
-"""
+def test_project_ci_lint_create(project, resp_create_project_ci_lint):
     lint_result = project.ci_lint.create({"content": gitlab_ci_yml})
     assert lint_result.valid is True
