refactor(objects): move ci lint to separate file

nejch · JohnVillalovos · commit 6491f1bbb68f · 2022-07-05T09:19:34.000-07:00
diff --git a/gitlab/v4/objects/__init__.py b/gitlab/v4/objects/__init__.py
@@ -25,6 +25,7 @@
 from .boards import *
 from .branches import *
 from .broadcast_messages import *
+from .ci_lint import *
 from .clusters import *
 from .commits import *
 from .container_registry import *
diff --git a/gitlab/v4/objects/ci_lint.py b/gitlab/v4/objects/ci_lint.py
@@ -0,0 +1,22 @@
+"""
+GitLab API:
+https://docs.gitlab.com/ee/api/lint.html
+"""
+
+from typing import Any, cast
+
+from gitlab.base import RESTManager, RESTObject
+from gitlab.mixins import CreateMixin, GetWithoutIdMixin
+
+
+class ProjectCiLint(RESTObject):
+    pass
+
+
+class ProjectCiLintManager(GetWithoutIdMixin, CreateMixin, RESTManager):
+    _path = "/projects/{project_id}/ci/lint"
+    _obj_cls = ProjectCiLint
+    _from_parent_attrs = {"project_id": "id"}
+
+    def get(self, **kwargs: Any) -> ProjectCiLint:
+        return cast(ProjectCiLint, super().get(**kwargs))
diff --git a/gitlab/v4/objects/projects.py b/gitlab/v4/objects/projects.py
@@ -1,7 +1,6 @@
 """
 GitLab API:
 https://docs.gitlab.com/ee/api/projects.html
-https://docs.gitlab.com/ee/api/lint.html
 """
 from typing import (
     Any,
@@ -39,6 +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 .clusters import ProjectClusterManager  # noqa: F401
 from .commits import ProjectCommitManager  # noqa: F401
 from .container_registry import ProjectRegistryRepositoryManager  # noqa: F401
@@ -1063,18 +1063,3 @@ class ProjectStorageManager(GetWithoutIdMixin, RESTManager):
 
     def get(self, **kwargs: Any) -> ProjectStorage:
         return cast(ProjectStorage, super().get(**kwargs))
-
-
-class ProjectCiLint(RESTObject):
-    pass
-
-
-class ProjectCiLintManager(GetWithoutIdMixin, CreateMixin, RESTManager):
-    """GitLab API: https://docs.gitlab.com/ee/api/lint.html"""
-
-    _path = "/projects/{project_id}/ci/lint"
-    _obj_cls = ProjectCiLint
-    _from_parent_attrs = {"project_id": "id"}
-
-    def get(self, **kwargs: Any) -> ProjectCiLint:
-        return cast(ProjectCiLint, super().get(**kwargs))
diff --git a/tests/unit/objects/test_ci_lint.py b/tests/unit/objects/test_ci_lint.py
@@ -0,0 +1,49 @@
+import pytest
+import responses
+
+ci_lint_get_content = {
+    "valid": True,
+    "merged_yaml": "---\n:test_job:\n  :script: echo 1\n",
+    "errors": [],
+    "warnings": [],
+}
+
+
+@pytest.fixture
+def resp_get_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,
+            content_type="application/json",
+            status=200,
+        )
+        yield rsps
+
+
+@pytest.fixture
+def resp_create_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,
+            content_type="application/json",
+            status=200,
+        )
+        yield rsps
+
+
+def test_project_ci_lint_get(project, resp_get_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
+"""
+    lint_result = project.ci_lint.create({"content": gitlab_ci_yml})
+    assert lint_result.valid is True
diff --git a/tests/unit/objects/test_projects.py b/tests/unit/objects/test_projects.py
@@ -82,12 +82,6 @@
     "status": "created",
     "source": "trigger",
 }
-ci_lint_get_content = {
-    "valid": True,
-    "merged_yaml": "---\n:test_job:\n  :script: echo 1\n",
-    "errors": [],
-    "warnings": [],
-}
 
 
 @pytest.fixture
@@ -547,32 +541,6 @@ def resp_artifact():
         yield rsps
 
 
-@pytest.fixture
-def resp_get_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,
-            content_type="application/json",
-            status=200,
-        )
-        yield rsps
-
-
-@pytest.fixture
-def resp_create_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,
-            content_type="application/json",
-            status=200,
-        )
-        yield rsps
-
-
 def test_get_project(gl, resp_get_project):
     data = gl.projects.get(1)
     assert isinstance(data, Project)
@@ -788,17 +756,3 @@ def test_project_pull_mirror(project, resp_start_pull_mirroring_project):
 def test_project_snapshot(project, resp_snapshot_project):
     tar_file = project.snapshot()
     assert isinstance(tar_file, bytes)
-
-
-def test_project_ci_lint_get(project, resp_get_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
-"""
-    lint_result = project.ci_lint.create({"content": gitlab_ci_yml})
-    assert lint_result.valid is True
