Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

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

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

feat(cli): add support for global CI lint#2128

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Merged
JohnVillalovos merged 4 commits intomainfromfeat/ci-lint-cli
Jul 5, 2022
Merged
Show file tree
Hide file tree
Changes fromall commits
Commits
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletionsdocs/api-objects.rst
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -13,6 +13,7 @@ API examples
gl_objects/branches
gl_objects/clusters
gl_objects/messages
gl_objects/ci_lint
gl_objects/commits
gl_objects/deploy_keys
gl_objects/deploy_tokens
Expand Down
42 changes: 42 additions & 0 deletionsdocs/cli-examples.rst
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,6 +6,48 @@ CLI examples

For a complete list of objects and actions available, see :doc:`/cli-objects`.

CI Lint
-------

Lint a CI YAML configuration from a string:

.. note::

To see output, you will need to use the ``-v``/``--verbose`` flag.

.. code-block:: console

$ gitlab --verbose ci-lint create --content \
"---
test:
script:
- echo hello
"

Lint a CI YAML configuration from a file (see :ref:`cli_from_files`):

.. code-block:: console

$ gitlab --verbose ci-lint create --content @.gitlab-ci.yml

Lint a project's CI YAML configuration:

.. code-block:: console

$ gitlab --verbose project-ci-lint create --project-id group/my-project --content @.gitlab-ci.yml

Lint a project's current CI YAML configuration:

.. code-block:: console

$ gitlab --verbose project-ci-lint get --project-id group/my-project

Lint a project's current CI YAML configuration on a specific branch:

.. code-block:: console

$ gitlab --verbose project-ci-lint get --project-id group/my-project --ref my-branch

Projects
--------

Expand Down
2 changes: 2 additions & 0 deletionsdocs/cli-usage.rst
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -288,6 +288,8 @@ Example:

$ gitlab -o yaml -f id,permissions -g elsewhere -c /tmp/gl.cfg project list

.. _cli_from_files:

Reading values from files
-------------------------

Expand Down
53 changes: 53 additions & 0 deletionsdocs/gl_objects/ci_lint.rst
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
#######
CI Lint
#######

Reference
---------

* v4 API:

+ :class:`gitlab.v4.objects.CiLint`
+ :class:`gitlab.v4.objects.CiLintManager`
+ :attr:`gitlab.Gitlab.ci_lint`
+ :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

Examples
---------

Validate a CI YAML configuration::

gitlab_ci_yml = """.api_test:
rules:
- if: $CI_PIPELINE_SOURCE=="merge_request_event"
changes:
- src/api/*
deploy:
extends:
- .api_test
rules:
- when: manual
allow_failure: true
script:
- echo "hello world"
"""
lint_result = gl.ci_lint.create({"content": gitlab_ci_yml})

print(lint_result.status) # Print the status of the CI YAML
print(lint_result.merged_yaml) # Print the merged YAML file

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

Validate a CI YAML configuration with a namespace::

lint_result = project.ci_lint.create({"content": gitlab_ci_yml})
assert lint_result.valid is True # Test that the .gitlab-ci.yml is valid
print(lint_result.merged_yaml) # Print the merged YAML file
43 changes: 0 additions & 43 deletionsdocs/gl_objects/projects.rst
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -819,49 +819,6 @@ 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

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

Validate a CI YAML configuration with a namespace::

gitlab_ci_yml = """.api_test:
rules:
- if: $CI_PIPELINE_SOURCE=="merge_request_event"
changes:
- src/api/*
deploy:
extends:
- .api_test
rules:
- when: manual
allow_failure: true
script:
- echo "hello world"
"""
lint_result = project.ci_lint.create({"content": gitlab_ci_yml})
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
=============================

Expand Down
7 changes: 7 additions & 0 deletionsgitlab/client.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -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)
Expand DownExpand Up@@ -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:
Expand Down
1 change: 1 addition & 0 deletionsgitlab/v4/objects/__init__.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -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 *
Expand Down
45 changes: 45 additions & 0 deletionsgitlab/v4/objects/ci_lint.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
"""
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
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


class ProjectCiLintManager(GetWithoutIdMixin, CreateMixin, RESTManager):
_path = "/projects/{project_id}/ci/lint"
_obj_cls = ProjectCiLint
_from_parent_attrs = {"project_id": "id"}
_create_attrs = RequiredOptional(
required=("content",), optional=("dry_run", "include_jobs", "ref")
)

def get(self, **kwargs: Any) -> ProjectCiLint:
return cast(ProjectCiLint, super().get(**kwargs))
21 changes: 2 additions & 19 deletionsgitlab/v4/objects/projects.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -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,
Expand DownExpand Up@@ -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 ProjectCiLintManager # noqa: F401
from .clusters import ProjectClusterManager # noqa: F401
from .commits import ProjectCommitManager # noqa: F401
from .container_registry import ProjectRegistryRepositoryManager # noqa: F401
Expand DownExpand Up@@ -102,8 +102,6 @@
"ProjectRemoteMirrorManager",
"ProjectStorage",
"ProjectStorageManager",
"ProjectCiLint",
"ProjectCiLintManager",
]


Expand DownExpand Up@@ -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
Expand DownExpand Up@@ -1063,18 +1061,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))
71 changes: 71 additions & 0 deletionstests/unit/objects/test_ci_lint.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
import pytest
import responses

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": [],
"warnings": [],
}


@pytest.fixture
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=project_ci_lint_content,
content_type="application/json",
status=200,
)
yield rsps


@pytest.fixture
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=project_ci_lint_content,
content_type="application/json",
status=200,
)
yield rsps


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_project_ci_lint):
lint_result = project.ci_lint.create({"content": gitlab_ci_yml})
assert lint_result.valid is True
Loading
[8]ページ先頭
©2009-2025 Movatter.jp