feat(client): warn user on misconfigured URL in auth()

nejch · nejch · commit d71c1dbe349d · 2022-08-04T18:21:05.000+02:00
diff --git a/gitlab/client.py b/gitlab/client.py
@@ -363,12 +363,14 @@ def _merge_auth(
         return (None, None, None)
 
     def auth(self) -> None:
-        """Performs an authentication using private token.
+        """Performs an authentication using private token. Warns the user if a
+        potentially misconfigured URL is detected on the client or server side.
 
         The `user` attribute will hold a `gitlab.objects.CurrentUser` object on
         success.
         """
         self.user = self._objects.CurrentUserManager(self).get()
+        self._check_url(self.user.web_url, path=self.user.username)
 
     def version(self) -> Tuple[str, str]:
         """Returns the version and revision of the gitlab server.
diff --git a/tests/functional/cli/test_cli.py b/tests/functional/cli/test_cli.py
@@ -100,6 +100,7 @@ def test_private_token_overrides_job_token(
     # CLI first calls .auth() when private token is present
     resp_auth_with_token = copy.deepcopy(resp_get_project_with_token)
     resp_auth_with_token.update(url=f"{DEFAULT_URL}/api/v4/user")
+    resp_auth_with_token["json"].update(username="user", web_url=f"{DEFAULT_URL}/user")
 
     responses.add(**resp_get_project_with_token)
     responses.add(**resp_auth_with_token)
diff --git a/tests/unit/test_gitlab.py b/tests/unit/test_gitlab.py
@@ -37,7 +37,11 @@ def resp_get_user():
     return {
         "method": responses.GET,
         "url": "http://localhost/api/v4/user",
-        "json": {"id": 1, "username": "username"},
+        "json": {
+            "id": 1,
+            "username": "username",
+            "web_url": "http://localhost/username",
+        },
         "content_type": "application/json",
         "status": 200,
     }
@@ -254,6 +258,24 @@ def test_gitlab_token_auth(gl, resp_get_user):
     assert isinstance(gl.user, gitlab.v4.objects.CurrentUser)
 
 
+@responses.activate
+def test_gitlab_auth_with_mismatching_url_warns():
+    responses.add(
+        method=responses.GET,
+        url="http://first.example.com/api/v4/user",
+        json={
+            "username": "test-user",
+            "web_url": "http://second.example.com/test-user",
+        },
+        content_type="application/json",
+        status=200,
+    )
+    gl = gitlab.Gitlab("http://first.example.com")
+
+    with pytest.warns(UserWarning):
+        gl.auth()
+
+
 def test_gitlab_default_url():
     gl = gitlab.Gitlab()
     assert gl.url == gitlab.const.DEFAULT_URL
