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

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

@@ -1,5 +1,37 @@
 # CHANGELOG
 
+## v4.11.0 (2024-09-13)
+
+### Chore
+
+* chore(pre-commit): add deps ([`fe5e608`](https://github.com/python-gitlab/python-gitlab/commit/fe5e608bc6cc04863bd4d1d9dbe101fffd88e954))
+
+* chore(deps): update all non-major dependencies ([`fac8bf9`](https://github.com/python-gitlab/python-gitlab/commit/fac8bf9f3e2a0218f96337536d08dec9991bfc1a))
+
+* chore(deps): update dependency types-setuptools to v74 ([`bdfaddb`](https://github.com/python-gitlab/python-gitlab/commit/bdfaddb89ae7ba351bd3a21c6cecc528772db4de))
+
+* chore(deps): update all non-major dependencies ([`88c7529`](https://github.com/python-gitlab/python-gitlab/commit/88c75297377dd1f1106b5bc673946cebd563e0a1))
+
+### Documentation
+
+* docs(objects): fix typo in get latest pipeline ([`b9f5c12`](https://github.com/python-gitlab/python-gitlab/commit/b9f5c12d3ba6ca4e4321a81e7610d03fb4440c02))
+
+### Feature
+
+* feat(client): make retries configurable in GraphQL ([`145870e`](https://github.com/python-gitlab/python-gitlab/commit/145870e628ed3b648a0a29fc551a6f38469b684a))
+
+* feat(client): add retry handling to GraphQL client ([`8898c38`](https://github.com/python-gitlab/python-gitlab/commit/8898c38b97ed36d9ff8f2f20dee27ef1448b9f83))
+
+* feat(api): add exclusive GET attrs for /projects/:id/members ([`e637808`](https://github.com/python-gitlab/python-gitlab/commit/e637808bcb74498438109d7ed352071ebaa192d5))
+
+* feat: add a minimal GraphQL client ([`d6b1b0a`](https://github.com/python-gitlab/python-gitlab/commit/d6b1b0a962bbf0f4e0612067fc075dbdcbb772f8))
+
+* feat(api): add exclusive GET attrs for /groups/:id/members ([`d44ddd2`](https://github.com/python-gitlab/python-gitlab/commit/d44ddd2b00d78bb87ff6a4776e64e05e0c1524e1))
+
+### Refactor
+
+* refactor(client): move retry logic into utility ([`3235c48`](https://github.com/python-gitlab/python-gitlab/commit/3235c48328c2866f7d46597ba3c0c2488e6c375c))
+
 ## v4.10.0 (2024-08-28)
 
 ### Chore

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: python-gitlab
-Version: 4.10.0
+Version: 4.11.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>
@@ -34,6 +34,8 @@ Provides-Extra: autocompletion
 Requires-Dist: argcomplete<3,>=1.10.0; extra == "autocompletion"
 Provides-Extra: yaml
 Requires-Dist: PyYaml>=6.0.1; extra == "yaml"
+Provides-Extra: graphql
+Requires-Dist: gql[httpx]<4,>=3.5.0; extra == "graphql"
 
 python-gitlab
 =============

python_gitlab-4.11.0/docs/api-usage-graphql.rst

@@ -0,0 +1,52 @@
+############################
+Using the GraphQL API (beta)
+############################
+
+python-gitlab provides basic support for executing GraphQL queries and mutations.
+
+.. danger::
+
+   The GraphQL client is experimental and only provides basic support.
+   It does not currently support pagination, obey rate limits,
+   or attempt complex retries. You can use it to build simple queries and mutations.
+
+   It is currently unstable and its implementation may change. You can expect a more
+   mature client in one of the upcoming versions.
+
+The ``gitlab.GraphQL`` class
+==================================
+
+As with the REST client, you connect to a GitLab instance by creating a ``gitlab.GraphQL`` object:
+
+.. code-block:: python
+
+   import gitlab
+
+   # anonymous read-only access for public resources (GitLab.com)
+   gq = gitlab.GraphQL()
+
+   # anonymous read-only access for public resources (self-hosted GitLab instance)
+   gq = gitlab.GraphQL('https://gitlab.example.com')
+
+   # personal access token or OAuth2 token authentication (GitLab.com)
+   gq = gitlab.GraphQL(token='glpat-JVNSESs8EwWRx5yDxM5q')
+
+   # personal access token or OAuth2 token authentication (self-hosted GitLab instance)
+   gq = gitlab.GraphQL('https://gitlab.example.com', token='glpat-JVNSESs8EwWRx5yDxM5q')
+
+Sending queries
+===============
+
+Get the result of a query:
+
+.. code-block:: python
+
+    query = """{
+        query {
+          currentUser {
+            name
+          }
+        }
+    """
+
+    result = gq.execute(query)

{python_gitlab-4.10.0 → python_gitlab-4.11.0}/docs/api-usage.rst

@@ -1,8 +1,8 @@
-############################
-Getting started with the API
-############################
+##################
+Using the REST API
+##################
 
-python-gitlab only supports GitLab API v4.
+python-gitlab currently only supports v4 of the GitLab REST API.
 
 ``gitlab.Gitlab`` class
 =======================

{python_gitlab-4.10.0 → python_gitlab-4.11.0}/docs/cli-usage.rst

@@ -1,6 +1,6 @@
-############################
-Getting started with the CLI
-############################
+#############
+Using the CLI
+#############
 
 ``python-gitlab`` provides a :command:`gitlab` command-line tool to interact
 with GitLab servers.

{python_gitlab-4.10.0 → python_gitlab-4.11.0}/docs/gl_objects/pipelines_and_jobs.rst

@@ -51,7 +51,7 @@ Delete a pipeline::
 
 Get latest pipeline::
 
-    projet.pipelines.latest(ref="main")
+    project.pipelines.latest(ref="main")
 
 
 Triggers

{python_gitlab-4.10.0 → python_gitlab-4.11.0}/docs/index.rst

@@ -7,6 +7,7 @@
    cli-usage
    api-usage
    api-usage-advanced
+   api-usage-graphql
    cli-examples
    api-objects
    api/gitlab

{python_gitlab-4.10.0 → python_gitlab-4.11.0}/gitlab/__init__.py

@@ -27,7 +27,7 @@ from gitlab._version import (  # noqa: F401
     __title__,
     __version__,
 )
-from gitlab.client import Gitlab, GitlabList  # noqa: F401
+from gitlab.client import Gitlab, GitlabList, GraphQL  # noqa: F401
 from gitlab.exceptions import *  # noqa: F401,F403
 
 warnings.filterwarnings("default", category=DeprecationWarning, module="^gitlab")
@@ -42,5 +42,6 @@ __all__ = [
     "__version__",
     "Gitlab",
     "GitlabList",
+    "GraphQL",
 ]
 __all__.extend(gitlab.exceptions.__all__)

python_gitlab-4.11.0/gitlab/_backends/graphql.py

@@ -0,0 +1,24 @@
+from typing import Any
+
+import httpx
+from gql.transport.httpx import HTTPXTransport
+
+
+class GitlabTransport(HTTPXTransport):
+    """A gql httpx transport that reuses an existing httpx.Client.
+    By default, gql's transports do not have a keep-alive session
+    and do not enable providing your own session that's kept open.
+    This transport lets us provide and close our session on our own
+    and provide additional auth.
+    For details, see https://github.com/graphql-python/gql/issues/91.
+    """
+
+    def __init__(self, *args: Any, client: httpx.Client, **kwargs: Any):
+        super().__init__(*args, **kwargs)
+        self.client = client
+
+    def connect(self) -> None:
+        pass
+
+    def close(self) -> None:
+        pass

{python_gitlab-4.10.0 → python_gitlab-4.11.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.10.0"
+__version__ = "4.11.0"

{python_gitlab-4.10.0 → python_gitlab-4.11.0}/gitlab/client.py

@@ -2,7 +2,6 @@
 
 import os
 import re
-import time
 from typing import (
     Any,
     BinaryIO,
@@ -25,6 +24,19 @@ import gitlab.const
 import gitlab.exceptions
 from gitlab import _backends, utils
 
+try:
+    import gql
+    import gql.transport.exceptions
+    import graphql
+    import httpx
+
+    from ._backends.graphql import GitlabTransport
+
+    _GQL_INSTALLED = True
+except ImportError:  # pragma: no cover
+    _GQL_INSTALLED = False
+
+
 REDIRECT_MSG = (
     "python-gitlab detected a {status_code} ({reason!r}) redirection. You must update "
     "your GitLab URL to the correct URL to avoid issues. The redirection was from: "
@@ -89,7 +101,7 @@ class Gitlab:
         self._api_version = str(api_version)
         self._server_version: Optional[str] = None
         self._server_revision: Optional[str] = None
-        self._base_url = self._get_base_url(url)
+        self._base_url = utils.get_base_url(url)
         self._url = f"{self._base_url}/api/v{api_version}"
         #: Timeout to use for requests to gitlab server
         self.timeout = timeout
@@ -557,18 +569,6 @@ class Gitlab:
             "verify": self.ssl_verify,
         }
 
-    @staticmethod
-    def _get_base_url(url: Optional[str] = None) -> str:
-        """Return the base URL with the trailing slash stripped.
-        If the URL is a Falsy value, return the default URL.
-        Returns:
-            The base URL
-        """
-        if not url:
-            return gitlab.const.DEFAULT_URL
-
-        return url.rstrip("/")
-
     def _build_url(self, path: str) -> str:
         """Returns the full url from path.
 
@@ -718,7 +718,12 @@ class Gitlab:
         send_data = self._backend.prepare_send_data(files, post_data, raw)
         opts["headers"]["Content-type"] = send_data.content_type
 
-        cur_retries = 0
+        retry = utils.Retry(
+            max_retries=max_retries,
+            obey_rate_limit=obey_rate_limit,
+            retry_transient_errors=retry_transient_errors,
+        )
+
         while True:
             try:
                 result = self._backend.http_request(
@@ -733,14 +738,8 @@ class Gitlab:
                     **opts,
                 )
             except (requests.ConnectionError, requests.exceptions.ChunkedEncodingError):
-                if retry_transient_errors and (
-                    max_retries == -1 or cur_retries < max_retries
-                ):
-                    wait_time = 2**cur_retries * 0.1
-                    cur_retries += 1
-                    time.sleep(wait_time)
+                if retry.handle_retry():
                     continue
-
                 raise
 
             self._check_redirects(result.response)
@@ -748,31 +747,10 @@ class Gitlab:
             if 200 <= result.status_code < 300:
                 return result.response
 
-            def should_retry() -> bool:
-                if result.status_code == 429 and obey_rate_limit:
-                    return True
-
-                if not retry_transient_errors:
-                    return False
-                if result.status_code in gitlab.const.RETRYABLE_TRANSIENT_ERROR_CODES:
-                    return True
-                if result.status_code == 409 and "Resource lock" in result.reason:
-                    return True
-
-                return False
-
-            if should_retry():
-                # Response headers documentation:
-                # https://docs.gitlab.com/ee/user/admin_area/settings/user_and_ip_rate_limits.html#response-headers
-                if max_retries == -1 or cur_retries < max_retries:
-                    wait_time = 2**cur_retries * 0.1
-                    if "Retry-After" in result.headers:
-                        wait_time = int(result.headers["Retry-After"])
-                    elif "RateLimit-Reset" in result.headers:
-                        wait_time = int(result.headers["RateLimit-Reset"]) - time.time()
-                    cur_retries += 1
-                    time.sleep(wait_time)
-                    continue
+            if retry.handle_retry_on_status(
+                result.status_code, result.headers, result.reason
+            ):
+                continue
 
             error_message = result.content
             try:
@@ -1296,3 +1274,94 @@ class GitlabList:
             return self.next()
 
         raise StopIteration
+
+
+class GraphQL:
+    def __init__(
+        self,
+        url: Optional[str] = None,
+        *,
+        token: Optional[str] = None,
+        ssl_verify: Union[bool, str] = True,
+        client: Optional[httpx.Client] = None,
+        timeout: Optional[float] = None,
+        user_agent: str = gitlab.const.USER_AGENT,
+        fetch_schema_from_transport: bool = False,
+        max_retries: int = 10,
+        obey_rate_limit: bool = True,
+        retry_transient_errors: bool = False,
+    ) -> None:
+        if not _GQL_INSTALLED:
+            raise ImportError(
+                "The GraphQL client could not be initialized because "
+                "the gql dependencies are not installed. "
+                "Install them with 'pip install python-gitlab[graphql]'"
+            )
+        self._base_url = utils.get_base_url(url)
+        self._timeout = timeout
+        self._token = token
+        self._url = f"{self._base_url}/api/graphql"
+        self._user_agent = user_agent
+        self._ssl_verify = ssl_verify
+        self._max_retries = max_retries
+        self._obey_rate_limit = obey_rate_limit
+        self._retry_transient_errors = retry_transient_errors
+
+        opts = self._get_client_opts()
+        self._http_client = client or httpx.Client(**opts)
+        self._transport = GitlabTransport(self._url, client=self._http_client)
+        self._client = gql.Client(
+            transport=self._transport,
+            fetch_schema_from_transport=fetch_schema_from_transport,
+        )
+        self._gql = gql.gql
+
+    def __enter__(self) -> "GraphQL":
+        return self
+
+    def __exit__(self, *args: Any) -> None:
+        self._http_client.close()
+
+    def _get_client_opts(self) -> Dict[str, Any]:
+        headers = {"User-Agent": self._user_agent}
+
+        if self._token:
+            headers["Authorization"] = f"Bearer {self._token}"
+
+        return {
+            "headers": headers,
+            "timeout": self._timeout,
+            "verify": self._ssl_verify,
+        }
+
+    def execute(
+        self, request: Union[str, graphql.Source], *args: Any, **kwargs: Any
+    ) -> Any:
+        parsed_document = self._gql(request)
+        retry = utils.Retry(
+            max_retries=self._max_retries,
+            obey_rate_limit=self._obey_rate_limit,
+            retry_transient_errors=self._retry_transient_errors,
+        )
+
+        while True:
+            try:
+                result = self._client.execute(parsed_document, *args, **kwargs)
+            except gql.transport.exceptions.TransportServerError as e:
+                if retry.handle_retry_on_status(
+                    status_code=e.code, headers=self._transport.response_headers
+                ):
+                    continue
+
+                if e.code == 401:
+                    raise gitlab.exceptions.GitlabAuthenticationError(
+                        response_code=e.code,
+                        error_message=str(e),
+                    )
+
+                raise gitlab.exceptions.GitlabHttpError(
+                    response_code=e.code,
+                    error_message=str(e),
+                )
+
+            return result

{python_gitlab-4.10.0 → python_gitlab-4.11.0}/gitlab/utils.py

@@ -2,14 +2,26 @@ import dataclasses
 import email.message
 import logging
 import pathlib
+import time
 import traceback
 import urllib.parse
 import warnings
-from typing import Any, Callable, Dict, Iterator, Literal, Optional, Tuple, Type, Union
+from typing import (
+    Any,
+    Callable,
+    Dict,
+    Iterator,
+    Literal,
+    MutableMapping,
+    Optional,
+    Tuple,
+    Type,
+    Union,
+)
 
 import requests
 
-from gitlab import types
+from gitlab import const, types
 
 
 class _StdoutStream:
@@ -17,6 +29,18 @@ class _StdoutStream:
         print(chunk)
 
 
+def get_base_url(url: Optional[str] = None) -> str:
+    """Return the base URL with the trailing slash stripped.
+    If the URL is a Falsy value, return the default URL.
+    Returns:
+        The base URL
+    """
+    if not url:
+        return const.DEFAULT_URL
+
+    return url.rstrip("/")
+
+
 def get_content_type(content_type: Optional[str]) -> str:
     message = email.message.Message()
     if content_type is not None:
@@ -73,6 +97,71 @@ def response_content(
     return None
 
 
+class Retry:
+    def __init__(
+        self,
+        max_retries: int,
+        obey_rate_limit: Optional[bool] = True,
+        retry_transient_errors: Optional[bool] = False,
+    ) -> None:
+        self.cur_retries = 0
+        self.max_retries = max_retries
+        self.obey_rate_limit = obey_rate_limit
+        self.retry_transient_errors = retry_transient_errors
+
+    def _retryable_status_code(
+        self, status_code: Optional[int], reason: str = ""
+    ) -> bool:
+        if status_code == 429 and self.obey_rate_limit:
+            return True
+
+        if not self.retry_transient_errors:
+            return False
+        if status_code in const.RETRYABLE_TRANSIENT_ERROR_CODES:
+            return True
+        if status_code == 409 and "Resource lock" in reason:
+            return True
+
+        return False
+
+    def handle_retry_on_status(
+        self,
+        status_code: Optional[int],
+        headers: Optional[MutableMapping[str, str]] = None,
+        reason: str = "",
+    ) -> bool:
+        if not self._retryable_status_code(status_code, reason):
+            return False
+
+        if headers is None:
+            headers = {}
+
+        # Response headers documentation:
+        # https://docs.gitlab.com/ee/user/admin_area/settings/user_and_ip_rate_limits.html#response-headers
+        if self.max_retries == -1 or self.cur_retries < self.max_retries:
+            wait_time = 2**self.cur_retries * 0.1
+            if "Retry-After" in headers:
+                wait_time = int(headers["Retry-After"])
+            elif "RateLimit-Reset" in headers:
+                wait_time = int(headers["RateLimit-Reset"]) - time.time()
+            self.cur_retries += 1
+            time.sleep(wait_time)
+            return True
+
+        return False
+
+    def handle_retry(self) -> bool:
+        if self.retry_transient_errors and (
+            self.max_retries == -1 or self.cur_retries < self.max_retries
+        ):
+            wait_time = 2**self.cur_retries * 0.1
+            self.cur_retries += 1
+            time.sleep(wait_time)
+            return True
+
+        return False
+
+
 def _transform_types(
     data: Dict[str, Any],
     custom_types: Dict[str, Any],

{python_gitlab-4.10.0 → python_gitlab-4.11.0}/gitlab/v4/objects/members.py

@@ -37,8 +37,9 @@ class GroupMemberManager(CRUDMixin, RESTManager):
     _obj_cls = GroupMember
     _from_parent_attrs = {"group_id": "id"}
     _create_attrs = RequiredOptional(
-        required=("access_level", "user_id"),
+        required=("access_level",),
         optional=("expires_at", "tasks_to_be_done"),
+        exclusive=("username", "user_id"),
     )
     _update_attrs = RequiredOptional(
         required=("access_level",), optional=("expires_at",)
@@ -101,8 +102,9 @@ class ProjectMemberManager(CRUDMixin, RESTManager):
     _obj_cls = ProjectMember
     _from_parent_attrs = {"project_id": "id"}
     _create_attrs = RequiredOptional(
-        required=("access_level", "user_id"),
+        required=("access_level",),
         optional=("expires_at", "tasks_to_be_done"),
+        exclusive=("username", "user_id"),
     )
     _update_attrs = RequiredOptional(
         required=("access_level",), optional=("expires_at",)

{python_gitlab-4.10.0 → python_gitlab-4.11.0}/pyproject.toml

@@ -43,6 +43,7 @@ dynamic = ["version"]
 [project.optional-dependencies]
 autocompletion = ["argcomplete>=1.10.0,<3"]
 yaml = ["PyYaml>=6.0.1"]
+graphql = ["gql[httpx]>=3.5.0,<4"]
 
 [project.scripts]
 gitlab = "gitlab.cli:main"

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: python-gitlab
-Version: 4.10.0
+Version: 4.11.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>
@@ -34,6 +34,8 @@ Provides-Extra: autocompletion
 Requires-Dist: argcomplete<3,>=1.10.0; extra == "autocompletion"
 Provides-Extra: yaml
 Requires-Dist: PyYaml>=6.0.1; extra == "yaml"
+Provides-Extra: graphql
+Requires-Dist: gql[httpx]<4,>=3.5.0; extra == "graphql"
 
 python-gitlab
 =============

{python_gitlab-4.10.0 → python_gitlab-4.11.0}/python_gitlab.egg-info/SOURCES.txt

@@ -16,6 +16,7 @@ docs/__init__.py
 docs/api-levels.rst
 docs/api-objects.rst
 docs/api-usage-advanced.rst
+docs/api-usage-graphql.rst
 docs/api-usage.rst
 docs/changelog.md
 docs/cli-examples.rst
@@ -113,6 +114,7 @@ gitlab/py.typed
 gitlab/types.py
 gitlab/utils.py
 gitlab/_backends/__init__.py
+gitlab/_backends/graphql.py
 gitlab/_backends/protocol.py
 gitlab/_backends/requests_backend.py
 gitlab/v4/__init__.py
@@ -216,6 +218,7 @@ tests/functional/api/test_deploy_keys.py
 tests/functional/api/test_deploy_tokens.py
 tests/functional/api/test_epics.py
 tests/functional/api/test_gitlab.py
+tests/functional/api/test_graphql.py
 tests/functional/api/test_groups.py
 tests/functional/api/test_import_export.py
 tests/functional/api/test_issues.py
@@ -268,6 +271,8 @@ tests/unit/test_exceptions.py
 tests/unit/test_gitlab.py
 tests/unit/test_gitlab_auth.py
 tests/unit/test_gitlab_http_methods.py
+tests/unit/test_graphql.py
+tests/unit/test_retry.py
 tests/unit/test_types.py
 tests/unit/test_utils.py
 tests/unit/_backends/__init__.py

{python_gitlab-4.10.0 → python_gitlab-4.11.0}/python_gitlab.egg-info/requires.txt

@@ -4,5 +4,8 @@ requests-toolbelt>=1.0.0
 [autocompletion]
 argcomplete<3,>=1.10.0
 
+[graphql]
+gql[httpx]<4,>=3.5.0
+
 [yaml]
 PyYaml>=6.0.1

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

@@ -5,9 +5,10 @@ commitizen==3.29.0
 flake8==7.1.1
 isort==5.13.2
 mypy==1.11.2
-pylint==3.2.6
+pylint==3.2.7
 pytest==8.3.2
 responses==0.25.3
+respx==0.21.1
 types-PyYAML==6.0.12.20240808
-types-requests==2.32.0.20240712
-types-setuptools==73.0.0.20240822
+types-requests==2.32.0.20240907
+types-setuptools==74.1.0.20240907

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

@@ -1,5 +1,5 @@
 -r requirements.txt
-build==1.2.1
+build==1.2.2
 coverage==7.6.1
 pytest-console-scripts==1.4.1
 pytest-cov==5.0.0
@@ -7,4 +7,5 @@ pytest-github-actions-annotate-failures==0.2.0
 pytest==8.3.2
 PyYaml==6.0.2
 responses==0.25.3
+respx==0.21.1
 wheel==0.44.0

{python_gitlab-4.10.0 → python_gitlab-4.11.0}/requirements.txt

@@ -1,2 +1,4 @@
+gql==3.5.0
+httpx==0.27.2
 requests==2.32.3
 requests-toolbelt==1.0.0

python_gitlab-4.11.0/tests/functional/api/test_graphql.py

@@ -0,0 +1,20 @@
+import logging
+
+import pytest
+
+import gitlab
+
+
+@pytest.fixture
+def gl_gql(gitlab_url: str, gitlab_token: str) -> gitlab.GraphQL:
+    logging.info("Instantiating gitlab.GraphQL instance")
+    instance = gitlab.GraphQL(gitlab_url, token=gitlab_token)
+
+    return instance
+
+
+def test_query_returns_valid_response(gl_gql: gitlab.GraphQL):
+    query = "query {currentUser {active}}"
+
+    response = gl_gql.execute(query)
+    assert response["currentUser"]["active"] is True