Merge branch 'python-gitlab:main' into feat/runner-new-registration

lgatellier · web-flow · commit 50bc02888119 · 2023-08-26T11:42:35.000+02:00
diff --git a/docs/faq.rst b/docs/faq.rst
@@ -42,7 +42,7 @@ Example::
 Not all items are returned from the API
 """""""""""""""""""""""""""""""""""""""
 
-If you've passed ``all=True`` (or ``--all`` via the CLI) to the API and still cannot see all items returned,
+If you've passed ``all=True`` to the API and still cannot see all items returned,
 use ``get_all=True`` (or ``--get-all`` via the CLI) instead. See :ref:`pagination` for more details.
 
 Common errors
diff --git a/docs/gl_objects/pipelines_and_jobs.rst b/docs/gl_objects/pipelines_and_jobs.rst
@@ -255,11 +255,6 @@ a branch or tag::
 
   project.artifacts.download(ref_name='main', job='build')
 
-.. attention::
-
-    An older method ``project.artifacts()`` is deprecated and will be
-    removed in a future version.
-
 .. warning::
 
    Artifacts are entirely stored in memory in this example.
@@ -305,11 +300,6 @@ Get a single artifact file by branch and job::
 
     project.artifacts.raw('branch', 'path/to/file', 'job')
 
-.. attention::
-
-    An older method ``project.artifact()`` is deprecated and will be
-    removed in a future version.
-
 Mark a job artifact as kept when expiration is set::
 
     build_or_job.keep_artifacts()
diff --git a/gitlab/client.py b/gitlab/client.py
@@ -402,32 +402,6 @@ def version(self) -> Tuple[str, str]:
 
         return cast(str, self._server_version), cast(str, self._server_revision)
 
-    @gitlab.exceptions.on_http_error(gitlab.exceptions.GitlabVerifyError)
-    def lint(self, content: str, **kwargs: Any) -> Tuple[bool, List[str]]:
-        """Validate a gitlab CI configuration.
-
-        Args:
-            content: The .gitlab-ci.yml content
-            **kwargs: Extra options to send to the server (e.g. sudo)
-
-        Raises:
-            GitlabAuthenticationError: If authentication is not correct
-            GitlabVerifyError: If the validation could not be done
-
-        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:
-            assert not isinstance(data, requests.Response)
-        return (data["status"] == "valid", data["errors"])
-
     @gitlab.exceptions.on_http_error(gitlab.exceptions.GitlabMarkdownError)
     def markdown(
         self, text: str, gfm: bool = False, project: Optional[str] = None, **kwargs: Any
@@ -869,7 +843,6 @@ def http_list(
         path: str,
         query_data: Optional[Dict[str, Any]] = None,
         *,
-        as_list: Optional[bool] = None,  # Deprecated in favor of `iterator`
         iterator: Optional[bool] = None,
         **kwargs: Any,
     ) -> Union["GitlabList", List[Dict[str, Any]]]:
@@ -896,23 +869,6 @@ def http_list(
         """
         query_data = query_data or {}
 
-        # Don't allow both `as_list` and `iterator` to be set.
-        if as_list is not None and iterator is not None:
-            raise ValueError(
-                "Only one of `as_list` or `iterator` can be used. "
-                "Use `iterator` instead of `as_list`. `as_list` is deprecated."
-            )
-
-        if as_list is not None:
-            iterator = not as_list
-            utils.warn(
-                message=(
-                    f"`as_list={as_list}` is deprecated and will be removed in a "
-                    f"future version. Use `iterator={iterator}` instead."
-                ),
-                category=DeprecationWarning,
-            )
-
         # Provide a `get_all`` param to avoid clashes with `all` API attributes.
         get_all = kwargs.pop("get_all", None)
 
@@ -926,8 +882,6 @@ def http_list(
 
         if iterator and page is not None:
             arg_used_message = f"iterator={iterator}"
-            if as_list is not None:
-                arg_used_message = f"as_list={as_list}"
             utils.warn(
                 message=(
                     f"`{arg_used_message}` and `page={page}` were both specified. "
diff --git a/gitlab/v4/cli.py b/gitlab/v4/cli.py
@@ -236,12 +236,6 @@ def _populate_sub_parser_by_class(
                 action="store_true",
                 help="Return all items from the server, without pagination.",
             )
-            sub_parser_action.add_argument(
-                "--all",
-                required=False,
-                action="store_true",
-                help="Deprecated. Use --get-all instead.",
-            )
 
         if action_name == "delete":
             if cls._id_attr is not None:
diff --git a/gitlab/v4/objects/artifacts.py b/gitlab/v4/objects/artifacts.py
@@ -25,30 +25,6 @@ class ProjectArtifactManager(RESTManager):
     _path = "/projects/{project_id}/jobs/artifacts"
     _from_parent_attrs = {"project_id": "id"}
 
-    @cli.register_custom_action(
-        "Project", ("ref_name", "job"), ("job_token",), custom_action="artifacts"
-    )
-    def __call__(
-        self,
-        *args: Any,
-        **kwargs: Any,
-    ) -> Optional[bytes]:
-        utils.warn(
-            message=(
-                "The project.artifacts() method is deprecated and will be removed in a "
-                "future version. Use project.artifacts.download() instead.\n"
-            ),
-            category=DeprecationWarning,
-        )
-        data = self.download(
-            *args,
-            **kwargs,
-        )
-        if TYPE_CHECKING:
-            assert data is not None
-            assert isinstance(data, bytes)
-        return data
-
     @exc.on_http_error(exc.GitlabDeleteError)
     def delete(self, **kwargs: Any) -> None:
         """Delete the project's artifacts on the server.
diff --git a/gitlab/v4/objects/commits.py b/gitlab/v4/objects/commits.py
@@ -155,6 +155,7 @@ class ProjectCommitManager(RetrieveMixin, CreateMixin, RESTManager):
         optional=("author_email", "author_name"),
     )
     _list_filters = (
+        "all",
         "ref_name",
         "since",
         "until",
diff --git a/gitlab/v4/objects/groups.py b/gitlab/v4/objects/groups.py
@@ -5,7 +5,7 @@
 import gitlab
 from gitlab import cli
 from gitlab import exceptions as exc
-from gitlab import types, utils
+from gitlab import types
 from gitlab.base import RESTManager, RESTObject
 from gitlab.mixins import (
     CreateMixin,
@@ -164,64 +164,6 @@ def search(
         path = f"/groups/{self.encoded_id}/search"
         return self.manager.gitlab.http_list(path, query_data=data, **kwargs)
 
-    @cli.register_custom_action("Group", ("cn", "group_access", "provider"))
-    @exc.on_http_error(exc.GitlabCreateError)
-    def add_ldap_group_link(
-        self, cn: str, group_access: int, provider: str, **kwargs: Any
-    ) -> None:
-        """Add an LDAP group link.
-
-        Args:
-            cn: CN of the LDAP group
-            group_access: Minimum access level for members of the LDAP
-                group
-            provider: LDAP provider for the LDAP group
-            **kwargs: Extra options to send to the server (e.g. sudo)
-
-        Raises:
-            GitlabAuthenticationError: If authentication is not correct
-            GitlabCreateError: If the server cannot perform the request
-        """
-        utils.warn(
-            message=(
-                "The add_ldap_group_link() method is deprecated and will be removed "
-                "in a future version. Use ldap_group_links.create() instead."
-            ),
-            category=DeprecationWarning,
-        )
-        path = f"/groups/{self.encoded_id}/ldap_group_links"
-        data = {"cn": cn, "group_access": group_access, "provider": provider}
-        self.manager.gitlab.http_post(path, post_data=data, **kwargs)
-
-    @cli.register_custom_action("Group", ("cn",), ("provider",))
-    @exc.on_http_error(exc.GitlabDeleteError)
-    def delete_ldap_group_link(
-        self, cn: str, provider: Optional[str] = None, **kwargs: Any
-    ) -> None:
-        """Delete an LDAP group link.
-
-        Args:
-            cn: CN of the LDAP group
-            provider: LDAP provider for the LDAP group
-            **kwargs: Extra options to send to the server (e.g. sudo)
-
-        Raises:
-            GitlabAuthenticationError: If authentication is not correct
-            GitlabDeleteError: If the server cannot perform the request
-        """
-        utils.warn(
-            message=(
-                "The delete_ldap_group_link() method is deprecated and will be "
-                "removed in a future version. Use ldap_group_links.delete() instead."
-            ),
-            category=DeprecationWarning,
-        )
-        path = f"/groups/{self.encoded_id}/ldap_group_links"
-        if provider is not None:
-            path += f"/{provider}"
-        path += f"/{cn}"
-        self.manager.gitlab.http_delete(path, **kwargs)
-
     @cli.register_custom_action("Group")
     @exc.on_http_error(exc.GitlabCreateError)
     def ldap_sync(self, **kwargs: Any) -> None:
diff --git a/gitlab/v4/objects/projects.py b/gitlab/v4/objects/projects.py
@@ -625,37 +625,6 @@ def transfer(self, to_namespace: Union[int, str], **kwargs: Any) -> None:
             path, post_data={"namespace": to_namespace}, **kwargs
         )
 
-    @cli.register_custom_action("Project", ("to_namespace",))
-    def transfer_project(self, *args: Any, **kwargs: Any) -> None:
-        utils.warn(
-            message=(
-                "The project.transfer_project() method is deprecated and will be "
-                "removed in a future version. Use project.transfer() instead."
-            ),
-            category=DeprecationWarning,
-        )
-        return self.transfer(*args, **kwargs)
-
-    @cli.register_custom_action("Project", ("ref_name", "artifact_path", "job"))
-    @exc.on_http_error(exc.GitlabGetError)
-    def artifact(
-        self,
-        *args: Any,
-        **kwargs: Any,
-    ) -> Optional[bytes]:
-        utils.warn(
-            message=(
-                "The project.artifact() method is deprecated and will be "
-                "removed in a future version. Use project.artifacts.raw() instead."
-            ),
-            category=DeprecationWarning,
-        )
-        data = self.artifacts.raw(*args, **kwargs)
-        if TYPE_CHECKING:
-            assert data is not None
-            assert isinstance(data, bytes)
-        return data
-
 
 class ProjectManager(CRUDMixin, RESTManager):
     _path = "/projects"
diff --git a/gitlab/v4/objects/releases.py b/gitlab/v4/objects/releases.py
@@ -50,9 +50,12 @@ class ProjectReleaseLinkManager(CRUDMixin, RESTManager):
     _obj_cls = ProjectReleaseLink
     _from_parent_attrs = {"project_id": "project_id", "tag_name": "tag_name"}
     _create_attrs = RequiredOptional(
-        required=("name", "url"), optional=("filepath", "link_type")
+        required=("name", "url"),
+        optional=("filepath", "direct_asset_path", "link_type"),
+    )
+    _update_attrs = RequiredOptional(
+        optional=("name", "url", "filepath", "direct_asset_path", "link_type")
     )
-    _update_attrs = RequiredOptional(optional=("name", "url", "filepath", "link_type"))
 
     def get(
         self, id: Union[str, int], lazy: bool = False, **kwargs: Any
diff --git a/tests/functional/api/test_gitlab.py b/tests/functional/api/test_gitlab.py
@@ -66,13 +66,6 @@ def test_markdown_in_project(gl, project):
     assert "foo" in html
 
 
-def test_lint(gl):
-    with pytest.deprecated_call():
-        success, errors = gl.lint("Invalid")
-    assert success is False
-    assert errors
-
-
 def test_sidekiq_queue_metrics(gl):
     out = gl.sidekiq.queue_metrics()
     assert isinstance(out, dict)
@@ -289,17 +282,3 @@ def test_list_iterator_true_nowarning(gl, recwarn):
     items = gl.gitlabciymls.list(iterator=True)
     assert not recwarn
     assert len(list(items)) > 20
-
-
-def test_list_as_list_false_warnings(gl):
-    """Using `as_list=False` will disable the UserWarning but cause a
-    DeprecationWarning"""
-    with pytest.warns(DeprecationWarning) as record:
-        items = gl.gitlabciymls.list(as_list=False)
-    assert len(record) == 1
-    assert len(list(items)) > 20
-
-
-def test_list_with_as_list_and_iterator_raises(gl):
-    with pytest.raises(ValueError, match="`as_list` or `iterator`"):
-        gl.gitlabciymls.list(as_list=False, iterator=True)
diff --git a/tests/functional/cli/test_cli_artifacts.py b/tests/functional/cli/test_cli_artifacts.py
@@ -77,29 +77,6 @@ def test_cli_project_artifact_download(gitlab_config, job_with_artifacts):
     assert is_zipfile(artifacts_zip)
 
 
-def test_cli_project_artifacts_warns_deprecated(gitlab_config, job_with_artifacts):
-    cmd = [
-        "gitlab",
-        "--config-file",
-        gitlab_config,
-        "project",
-        "artifacts",
-        "--id",
-        str(job_with_artifacts.pipeline["project_id"]),
-        "--ref-name",
-        job_with_artifacts.ref,
-        "--job",
-        job_with_artifacts.name,
-    ]
-
-    artifacts = subprocess.run(cmd, capture_output=True, check=True)
-    assert isinstance(artifacts.stdout, bytes)
-    assert b"DeprecationWarning" in artifacts.stderr
-
-    artifacts_zip = BytesIO(artifacts.stdout)
-    assert is_zipfile(artifacts_zip)
-
-
 def test_cli_project_artifact_raw(gitlab_config, job_with_artifacts):
     cmd = [
         "gitlab",
@@ -120,26 +97,3 @@ def test_cli_project_artifact_raw(gitlab_config, job_with_artifacts):
     artifacts = subprocess.run(cmd, capture_output=True, check=True)
     assert isinstance(artifacts.stdout, bytes)
     assert artifacts.stdout == b"test\n"
-
-
-def test_cli_project_artifact_warns_deprecated(gitlab_config, job_with_artifacts):
-    cmd = [
-        "gitlab",
-        "--config-file",
-        gitlab_config,
-        "project",
-        "artifact",
-        "--id",
-        str(job_with_artifacts.pipeline["project_id"]),
-        "--ref-name",
-        job_with_artifacts.ref,
-        "--job",
-        job_with_artifacts.name,
-        "--artifact-path",
-        "artifact.txt",
-    ]
-
-    artifacts = subprocess.run(cmd, capture_output=True, check=True)
-    assert isinstance(artifacts.stdout, bytes)
-    assert b"DeprecationWarning" in artifacts.stderr
-    assert artifacts.stdout == b"test\n"
diff --git a/tests/functional/cli/test_cli_repository.py b/tests/functional/cli/test_cli_repository.py
@@ -43,7 +43,15 @@ def test_list_all_commits(gitlab_cli, project):
     assert commit.id not in ret.stdout
 
     # Listing commits on other branches requires `all` parameter passed to the API
-    cmd = ["project-commit", "list", "--project-id", project.id, "--get-all", "--all"]
+    cmd = [
+        "project-commit",
+        "list",
+        "--project-id",
+        project.id,
+        "--get-all",
+        "--all",
+        "true",
+    ]
     ret_all = gitlab_cli(cmd)
     assert commit.id in ret_all.stdout
     assert len(ret_all.stdout) > len(ret.stdout)
diff --git a/tests/unit/objects/test_job_artifacts.py b/tests/unit/objects/test_job_artifacts.py
diff --git a/tests/unit/objects/test_projects.py b/tests/unit/objects/test_projects.py
diff --git a/tests/unit/test_gitlab_http_methods.py b/tests/unit/test_gitlab_http_methods.py

Original file line number	Diff line number	Diff line change
`@@ -155,6 +155,7 @@ class ProjectCommitManager(RetrieveMixin, CreateMixin, RESTManager):`
`155`	`155`	`optional=("author_email", "author_name"),`
`156`	`156`	`)`
`157`	`157`	`_list_filters = (`
	`158`	`+ "all",`
`158`	`159`	`"ref_name",`
`159`	`160`	`"since",`
`160`	`161`	`"until",`