python-gitlab 4.9.0__tar.gz → 4.10.0__tar.gz

{python_gitlab-4.9.0 → python_gitlab-4.10.0}/CHANGELOG.md

@@ -1,5 +1,65 @@
 # CHANGELOG
 
+## v4.10.0 (2024-08-28)
+
+### Chore
+
+* chore(release): track tags for renovate ([`d600444`](https://github.com/python-gitlab/python-gitlab/commit/d6004449ad5aaaf2132318a78523818996ec3e21))
+
+* chore(deps): update python-semantic-release/upload-to-gh-release digest to 17c75b7 ([`12caaa4`](https://github.com/python-gitlab/python-gitlab/commit/12caaa496740cb15e6220511751b7a20e2d29d07))
+
+* chore(deps): update dependency types-setuptools to v73 ([`d55c045`](https://github.com/python-gitlab/python-gitlab/commit/d55c04502bee0fb42e2ef359cde3bc1b4b510b1a))
+
+* chore(deps): update all non-major dependencies ([`2ade0d9`](https://github.com/python-gitlab/python-gitlab/commit/2ade0d9f4922226143e2e3835a7449fde9c49d66))
+
+* chore(deps): update gitlab/gitlab-ee docker tag to v17.3.1-ee.0 ([`3fdd130`](https://github.com/python-gitlab/python-gitlab/commit/3fdd130a8e87137e5a048d5cb78e43aa476c8f34))
+
+* chore(deps): update all non-major dependencies ([`0578bf0`](https://github.com/python-gitlab/python-gitlab/commit/0578bf07e7903037ffef6558e914766b6cf6f545))
+
+* chore(deps): update gitlab/gitlab-ee docker tag to v17.3.0-ee.0 ([`e5a46f5`](https://github.com/python-gitlab/python-gitlab/commit/e5a46f57de166f94e01f5230eb6ad91f319791e4))
+
+* chore(deps): update dependency myst-parser to v4 ([`930d4a2`](https://github.com/python-gitlab/python-gitlab/commit/930d4a21b8afed833b4b2e6879606bbadaee19a1))
+
+* chore(deps): update dependency sphinx to v8 ([`cb65ffb`](https://github.com/python-gitlab/python-gitlab/commit/cb65ffb6957bf039f35926d01f15db559e663915))
+
+* chore(deps): update gitlab/gitlab-ee docker tag to v17.2.2-ee.0 ([`b2275f7`](https://github.com/python-gitlab/python-gitlab/commit/b2275f767dd620c6cb2c27b0470f4e8151c76550))
+
+* chore(deps): update all non-major dependencies ([`31786a6`](https://github.com/python-gitlab/python-gitlab/commit/31786a60da4b9a10dec0eab3a0b078aa1e94d809))
+
+### Documentation
+
+* docs(faq): correct the attribute fetching example
+
+There is an example about object attributes in the FAQ. It shows how to
+properly fetch all attributes of all projects, by using list() followed
+by a get(id) call.
+
+Unfortunately this example used a wrong variable name, which caused it
+not to work and which could have made it slightly confusing to readers.
+This commit fixes that, by changing the variable name.
+
+Now the example uses one variable for two Python objects. As they
+correspond to the same GitLab object and the intended behavior is to
+obtain that very object, just with all attributes, this is fine and is
+probably what readers will find most useful in this context. ([`43a16ac`](https://github.com/python-gitlab/python-gitlab/commit/43a16ac17ce78cf18e0fc10fa8229f052eed3946))
+
+### Feature
+
+* feat(api): project/group hook test triggering
+
+Add the ability to trigger tests of project and group hooks.
+
+Fixes #2924 ([`9353f54`](https://github.com/python-gitlab/python-gitlab/commit/9353f5406d6762d09065744bfca360ccff36defe))
+
+### Test
+
+* test(cli): allow up to 30 seconds for a project export
+
+Before we allowed a maximum of around 15 seconds for the
+project-export. Often times the CI was failing with this value.
+
+Change it to a maximum of around 30 seconds. ([`bdc155b`](https://github.com/python-gitlab/python-gitlab/commit/bdc155b716ef63ef1398ee1e6f5ca67da1109c13))
+
 ## v4.9.0 (2024-08-06)
 
 ### Chore

{python_gitlab-4.9.0 → python_gitlab-4.10.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: python-gitlab
-Version: 4.9.0
+Version: 4.10.0
 Summary: A python wrapper for the GitLab API
 Author-email: Gauvain Pocentek <gauvain@pocentek.net>
 Maintainer-email: John Villalovos <john@sodarock.com>, Max Wittig <max.wittig@siemens.com>, Nejc Habjan <nejc.habjan@siemens.com>, Roger Meier <r.meier@siemens.com>

{python_gitlab-4.9.0 → python_gitlab-4.10.0}/docs/faq.rst

@@ -58,7 +58,7 @@ To retrieve an object with all attributes, use a ``get()`` call.
 
 Example with projects::
 
-    for projects in gl.projects.list():
+    for project in gl.projects.list():
         # Retrieve project object with all attributes
         project = gl.projects.get(project.id)
 

{python_gitlab-4.9.0 → python_gitlab-4.10.0}/docs/gl_objects/groups.rst

@@ -89,7 +89,7 @@ Remove a group::
     group.delete()
 
 Restore a Group marked for deletion (Premium only):::
-    
+
     group.restore()
 
 
@@ -368,9 +368,9 @@ SAML group links
 
 Add a SAML group link to an existing GitLab group::
 
-    saml_link = group.saml_group_links.create({ 
-        "saml_group_name": "<your_saml_group_name>", 
-        "access_level": <chosen_access_level> 
+    saml_link = group.saml_group_links.create({
+        "saml_group_name": "<your_saml_group_name>",
+        "access_level": <chosen_access_level>
     })
 
 List a group's SAML group links::
@@ -419,6 +419,10 @@ Update a group hook::
     hook.push_events = 0
     hook.save()
 
+Test a group hook::
+
+    hook.test("push_events")
+
 Delete a group hook::
 
     group.hooks.delete(hook_id)

{python_gitlab-4.9.0 → python_gitlab-4.10.0}/docs/gl_objects/projects.rst

@@ -353,7 +353,7 @@ Import the project using file stored on a remote URL::
     output = gl.projects.remote_import(
         url="https://whatever.com/url/file.tar.gz",
         path="my_new_remote_project",
-        name="My New Remote Project", 
+        name="My New Remote Project",
         namespace="my-group",
         override_params={'visibility': 'private'},
     )
@@ -367,7 +367,7 @@ Import the project using file stored on AWS S3::
         file_key="aws-file-key",
         access_key_id="aws-access-key-id",
         secret_access_key="secret-access-key",
-        name="My New Remote Project", 
+        name="My New Remote Project",
         namespace="my-group",
         override_params={'visibility': 'private'},
     )
@@ -449,7 +449,7 @@ Get file details from headers, without fetching its entire content::
     print(headers["X-Gitlab-Size"])
 
 Get a raw file::
-    
+
     raw_content = project.files.raw(file_path='README.rst', ref='main')
     print(raw_content)
     with open('/tmp/raw-download.txt', 'wb') as f:
@@ -689,6 +689,10 @@ Update a project hook::
     hook.push_events = 0
     hook.save()
 
+Test a project hook::
+
+    hook.test("push_events")
+
 Delete a project hook::
 
     project.hooks.delete(hook_id)

{python_gitlab-4.9.0 → python_gitlab-4.10.0}/gitlab/_version.py

@@ -3,4 +3,4 @@ __copyright__ = "Copyright 2013-2019 Gauvain Pocentek, 2019-2023 python-gitlab t
 __email__ = "gauvainpocentek@gmail.com"
 __license__ = "LGPL3"
 __title__ = "python-gitlab"
-__version__ = "4.9.0"
+__version__ = "4.10.0"

{python_gitlab-4.9.0 → python_gitlab-4.10.0}/gitlab/exceptions.py

@@ -316,6 +316,10 @@ class GitlabDeploymentApprovalError(GitlabOperationError):
     pass
 
 
+class GitlabHookTestError(GitlabOperationError):
+    pass
+
+
 # For an explanation of how these type-hints work see:
 # https://mypy.readthedocs.io/en/stable/generics.html#declaring-decorators
 #
@@ -370,6 +374,7 @@ __all__ = [
     "GitlabGetError",
     "GitlabGroupTransferError",
     "GitlabHeadError",
+    "GitlabHookTestError",
     "GitlabHousekeepingError",
     "GitlabHttpError",
     "GitlabImportError",

{python_gitlab-4.9.0 → python_gitlab-4.10.0}/gitlab/v4/objects/hooks.py

@@ -1,5 +1,6 @@
 from typing import Any, cast, Union
 
+from gitlab import exceptions as exc
 from gitlab.base import RESTManager, RESTObject
 from gitlab.mixins import CRUDMixin, NoUpdateMixin, ObjectDeleteMixin, SaveMixin
 from gitlab.types import RequiredOptional
@@ -31,6 +32,20 @@ class HookManager(NoUpdateMixin, RESTManager):
 class ProjectHook(SaveMixin, ObjectDeleteMixin, RESTObject):
     _repr_attr = "url"
 
+    @exc.on_http_error(exc.GitlabHookTestError)
+    def test(self, trigger: str) -> None:
+        """
+        Test a Project Hook
+
+        Args:
+            trigger: Type of trigger event to test
+
+        Raises:
+            GitlabHookTestError: If the hook test attempt failed
+        """
+        path = f"{self.manager.path}/{self.encoded_id}/test/{trigger}"
+        self.manager.gitlab.http_post(path)
+
 
 class ProjectHookManager(CRUDMixin, RESTManager):
     _path = "/projects/{project_id}/hooks"
@@ -78,6 +93,20 @@ class ProjectHookManager(CRUDMixin, RESTManager):
 class GroupHook(SaveMixin, ObjectDeleteMixin, RESTObject):
     _repr_attr = "url"
 
+    @exc.on_http_error(exc.GitlabHookTestError)
+    def test(self, trigger: str) -> None:
+        """
+        Test a Group Hook
+
+        Args:
+            trigger: Type of trigger event to test
+
+        Raises:
+            GitlabHookTestError: If the hook test attempt failed
+        """
+        path = f"{self.manager.path}/{self.encoded_id}/test/{trigger}"
+        self.manager.gitlab.http_post(path)
+
 
 class GroupHookManager(CRUDMixin, RESTManager):
     _path = "/groups/{group_id}/hooks"

{python_gitlab-4.9.0 → python_gitlab-4.10.0}/python_gitlab.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: python-gitlab
-Version: 4.9.0
+Version: 4.10.0
 Summary: A python wrapper for the GitLab API
 Author-email: Gauvain Pocentek <gauvain@pocentek.net>
 Maintainer-email: John Villalovos <john@sodarock.com>, Max Wittig <max.wittig@siemens.com>, Nejc Habjan <nejc.habjan@siemens.com>, Roger Meier <r.meier@siemens.com>

{python_gitlab-4.9.0 → python_gitlab-4.10.0}/requirements-docs.txt

@@ -1,6 +1,6 @@
 -r requirements.txt
-furo==2024.7.18
+furo==2024.8.6
 jinja2==3.1.4
-myst-parser==3.0.1
-sphinx==7.4.7
+myst-parser==4.0.0
+sphinx==8.0.2
 sphinxcontrib-autoprogram==0.1.9

{python_gitlab-4.9.0 → python_gitlab-4.10.0}/requirements-lint.txt

@@ -1,13 +1,13 @@
 -r requirements.txt
 argcomplete==2.0.0
 black==24.8.0
-commitizen==3.28.0
+commitizen==3.29.0
 flake8==7.1.1
 isort==5.13.2
-mypy==1.11.1
+mypy==1.11.2
 pylint==3.2.6
 pytest==8.3.2
 responses==0.25.3
-types-PyYAML==6.0.12.20240724
+types-PyYAML==6.0.12.20240808
 types-requests==2.32.0.20240712
-types-setuptools==71.1.0.20240726
+types-setuptools==73.0.0.20240822

{python_gitlab-4.9.0 → python_gitlab-4.10.0}/requirements-test.txt

@@ -5,6 +5,6 @@ pytest-console-scripts==1.4.1
 pytest-cov==5.0.0
 pytest-github-actions-annotate-failures==0.2.0
 pytest==8.3.2
-PyYaml==6.0.1
+PyYaml==6.0.2
 responses==0.25.3
 wheel==0.44.0

{python_gitlab-4.9.0 → python_gitlab-4.10.0}/tests/functional/cli/test_cli_projects.py

@@ -40,7 +40,7 @@ def project_export(project):
         time.sleep(0.5)
         export.refresh()
         count += 1
-        if count == 30:
+        if count >= 60:
             raise Exception("Project export taking too much time")
 
     return export

{python_gitlab-4.9.0 → python_gitlab-4.10.0}/tests/functional/fixtures/.env

@@ -1,2 +1,2 @@
 GITLAB_IMAGE=gitlab/gitlab-ee
-GITLAB_TAG=17.2.1-ee.0
+GITLAB_TAG=17.3.1-ee.0

{python_gitlab-4.9.0 → python_gitlab-4.10.0}/tests/unit/objects/test_hooks.py

@@ -9,6 +9,7 @@ import re
 import pytest
 import responses
 
+import gitlab
 from gitlab.v4.objects import GroupHook, Hook, ProjectHook
 
 hooks_content = [
@@ -89,6 +90,58 @@ def resp_hook_update():
         yield rsps
 
 
+@pytest.fixture
+def resp_hook_test():
+    with responses.RequestsMock() as rsps:
+        hook_pattern = re.compile(
+            r"http://localhost/api/v4/((groups|projects)/1/|)hooks/1"
+        )
+        test_pattern = re.compile(
+            r"http://localhost/api/v4/((groups|projects)/1/|)hooks/1/test/[a-z_]+"
+        )
+        rsps.add(
+            method=responses.GET,
+            url=hook_pattern,
+            json=hook_content,
+            content_type="application/json",
+            status=200,
+        )
+        rsps.add(
+            method=responses.POST,
+            url=test_pattern,
+            json={"message": "201 Created"},
+            content_type="application/json",
+            status=201,
+        )
+        yield rsps
+
+
+@pytest.fixture
+def resp_hook_test_error():
+    with responses.RequestsMock() as rsps:
+        hook_pattern = re.compile(
+            r"http://localhost/api/v4/((groups|projects)/1/|)hooks/1"
+        )
+        test_pattern = re.compile(
+            r"http://localhost/api/v4/((groups|projects)/1/|)hooks/1/test/[a-z_]+"
+        )
+        rsps.add(
+            method=responses.GET,
+            url=hook_pattern,
+            json=hook_content,
+            content_type="application/json",
+            status=200,
+        )
+        rsps.add(
+            method=responses.POST,
+            url=test_pattern,
+            json={"message": "<html>error</html>"},
+            content_type="application/json",
+            status=422,
+        )
+        yield rsps
+
+
 @pytest.fixture
 def resp_hook_delete():
     with responses.RequestsMock() as rsps:
@@ -174,6 +227,17 @@ def test_delete_group_hook(group, resp_hook_delete):
     group.hooks.delete(1)
 
 
+def test_test_group_hook(group, resp_hook_test):
+    hook = group.hooks.get(1)
+    hook.test("push_events")
+
+
+def test_test_error_group_hook(group, resp_hook_test_error):
+    hook = group.hooks.get(1)
+    with pytest.raises(gitlab.exceptions.GitlabHookTestError):
+        hook.test("push_events")
+
+
 def test_list_project_hooks(project, resp_hooks_list):
     hooks = project.hooks.list()
     assert hooks[0].id == 1