NotificationsYou must be signed in to change notification settings
Fork673
Star2.4k

Commit569de2a

committed

feat(objects): add Project CI Lint support

Add support for validating a project's CI configuration [1][1]https://docs.gitlab.com/ee/api/lint.html#validate-a-projects-ci-configuration

1 parent3df404c commit569de2aCopy full SHA for 569de2a

File tree

3 files changed

+69

-0

lines changed

docs/gl_objects
- projects.rst
gitlab/v4/objects
- projects.py
tests/unit/objects
- test_projects.py

3 files changed

+69

-0

lines changed

`‎docs/gl_objects/projects.rst`

Lines changed: 23 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -819,6 +819,29 @@ Get total fetches in last 30 days of a project::`
`819`	`819`
`820`	`820`	`total_fetches = project.additionalstatistics.get().fetches['total']`
`821`	`821`
	`822`	`+Project CI Lint`
	`823`	`+=============================`
	`824`	`+`
	`825`	`+Reference`
	`826`	`+---------`
	`827`	`+`
	`828`	`+* v4 API:`
	`829`	`+`
	`830`	+ +:class:`gitlab.v4.objects.ProjectCiLint`
	`831`	+ +:class:`gitlab.v4.objects.ProjectCiLintManager`
	`832`	+ +:attr:`gitlab.v4.objects.Project.ci_lint`
	`833`	`+`
	`834`	`+* GitLab API: https://docs.gitlab.com/ee/api/lint.html#validate-a-projects-ci-configuration`
	`835`	`+`
	`836`	`+Examples`
	`837`	`+---------`
	`838`	`+`
	`839`	`+Validate a project's CI configuration::`
	`840`	`+`
	`841`	`+ lint_result = project.ci_lint.get()`
	`842`	`+ assert lint_result.valid is True # Test that the .gitlab-ci.yml is valid`
	`843`	`+ print(lint_result.merged_yaml) # Print the merged YAML file`
	`844`	`+`
`822`	`845`	`Project storage`
`823`	`846`	`=============================`
`824`	`847`

`‎gitlab/v4/objects/projects.py`

Lines changed: 22 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,8 @@`
	`1`	`+"""`
	`2`	`+GitLab API:`
	`3`	`+https://docs.gitlab.com/ee/api/projects.html`
	`4`	`+https://docs.gitlab.com/ee/api/lint.html#validate-a-projects-ci-configuration`
	`5`	`+"""`
`1`	`6`	`fromtypingimport (`
`2`	`7`	`Any,`
`3`	`8`	`Callable,`
`@@ -97,6 +102,8 @@`
`97`	`102`	`"ProjectRemoteMirrorManager",`
`98`	`103`	`"ProjectStorage",`
`99`	`104`	`"ProjectStorageManager",`
	`105`	`+"ProjectCiLint",`
	`106`	`+"ProjectCiLintManager",`
`100`	`107`	`]`
`101`	`108`
`102`	`109`
`@@ -158,6 +165,7 @@ class Project(RefreshMixin, SaveMixin, ObjectDeleteMixin, RepositoryMixin, RESTO`
`158`	`165`	`badges:ProjectBadgeManager`
`159`	`166`	`boards:ProjectBoardManager`
`160`	`167`	`branches:ProjectBranchManager`
	`168`	`+ci_lint:"ProjectCiLintManager"`
`161`	`169`	`clusters:ProjectClusterManager`
`162`	`170`	`commits:ProjectCommitManager`
`163`	`171`	`customattributes:ProjectCustomAttributeManager`
`@@ -1055,3 +1063,17 @@ class ProjectStorageManager(GetWithoutIdMixin, RESTManager):`
`1055`	`1063`
`1056`	`1064`	`defget(self,**kwargs:Any)->ProjectStorage:`
`1057`	`1065`	`returncast(ProjectStorage,super().get(**kwargs))`
	`1066`	`+`
	`1067`	`+`
	`1068`	`+classProjectCiLint(RESTObject):`
	`1069`	`+pass`
	`1070`	`+`
	`1071`	`+`
	`1072`	`+classProjectCiLintManager(GetWithoutIdMixin,RESTManager):`
	`1073`	`+_path="/projects/{project_id}/ci/lint"`
	`1074`	`+_obj_cls=ProjectCiLint`
	`1075`	`+_from_parent_attrs= {"project_id":"id"}`
	`1076`	`+# https://docs.gitlab.com/ee/api/lint.html#validate-a-projects-ci-configuration`
	`1077`	`+`
	`1078`	`+defget(self,**kwargs:Any)->ProjectCiLint:`
	`1079`	`+returncast(ProjectCiLint,super().get(**kwargs))`

`‎tests/unit/objects/test_projects.py`

Lines changed: 24 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -82,6 +82,12 @@`
`82`	`82`	`"status":"created",`
`83`	`83`	`"source":"trigger",`
`84`	`84`	`}`
	`85`	`+ci_lint_get_content= {`
	`86`	`+"valid":True,`
	`87`	`+"merged_yaml":"---\n:test_job:\n :script: echo 1\n",`
	`88`	`+"errors": [],`
	`89`	`+"warnings": [],`
	`90`	`+}`
`85`	`91`
`86`	`92`
`87`	`93`	`@pytest.fixture`
`@@ -541,6 +547,19 @@ def resp_artifact():`
`541`	`547`	`yieldrsps`
`542`	`548`
`543`	`549`
	`550`	`+@pytest.fixture`
	`551`	`+defresp_ci_lint():`
	`552`	`+withresponses.RequestsMock()asrsps:`
	`553`	`+rsps.add(`
	`554`	`+method=responses.GET,`
	`555`	`+url="http://localhost/api/v4/projects/1/ci/lint",`
	`556`	`+json=ci_lint_get_content,`
	`557`	`+content_type="application/json",`
	`558`	`+status=200,`
	`559`	`+ )`
	`560`	`+yieldrsps`
	`561`	`+`
	`562`	`+`
`544`	`563`	`deftest_get_project(gl,resp_get_project):`
`545`	`564`	`data=gl.projects.get(1)`
`546`	`565`	`assertisinstance(data,Project)`
`@@ -756,3 +775,8 @@ def test_project_pull_mirror(project, resp_start_pull_mirroring_project):`
`756`	`775`	`deftest_project_snapshot(project,resp_snapshot_project):`
`757`	`776`	`tar_file=project.snapshot()`
`758`	`777`	`assertisinstance(tar_file,bytes)`
	`778`	`+`
	`779`	`+`
	`780`	`+deftest_project_ci_lint_get(project,resp_ci_lint):`
	`781`	`+lint_result=project.ci_lint.get()`
	`782`	`+assertlint_result.validisTrue`

0 commit comments

Comments

(0)

Movatterモバイル変換

Navigation Menu

Search code, repositories, users, issues, pull requests...

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Commit569de2a

File tree

3 files changed

3 files changed

`‎docs/gl_objects/projects.rst`

`‎gitlab/v4/objects/projects.py`

`‎tests/unit/objects/test_projects.py`

0 commit comments