Commitd71c1db

committed

feat(client): warn user on misconfigured URL inauth()

1 parent31c9c2f commitd71c1dbCopy full SHA for d71c1db

File tree

+27

-2

lines changed

+27

-2

lines changed

Lines changed: 3 additions & 1 deletion

Original file line number	Diff line number	Diff line change
`@@ -363,12 +363,14 @@ def _merge_auth(`
`363`	`363`	`return (None,None,None)`
`364`	`364`
`365`	`365`	`defauth(self)->None:`
`366`		`-"""Performs an authentication using private token.`
	`366`	`+"""Performs an authentication using private token. Warns the user if a`
	`367`	`+ potentially misconfigured URL is detected on the client or server side.`
`367`	`368`
`368`	`369`	The `user` attribute will hold a `gitlab.objects.CurrentUser` object on
`369`	`370`	`success.`
`370`	`371`	`"""`
`371`	`372`	`self.user=self._objects.CurrentUserManager(self).get()`
	`373`	`+self._check_url(self.user.web_url,path=self.user.username)`
`372`	`374`
`373`	`375`	`defversion(self)->Tuple[str,str]:`
`374`	`376`	`"""Returns the version and revision of the gitlab server.`

Lines changed: 1 addition & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -100,6 +100,7 @@ def test_private_token_overrides_job_token(`
`100`	`100`	`# CLI first calls .auth() when private token is present`
`101`	`101`	`resp_auth_with_token=copy.deepcopy(resp_get_project_with_token)`
`102`	`102`	`resp_auth_with_token.update(url=f"{DEFAULT_URL}/api/v4/user")`
	`103`	`+resp_auth_with_token["json"].update(username="user",web_url=f"{DEFAULT_URL}/user")`
`103`	`104`
`104`	`105`	`responses.add(**resp_get_project_with_token)`
`105`	`106`	`responses.add(**resp_auth_with_token)`

Lines changed: 23 additions & 1 deletion

Original file line number	Diff line number	Diff line change
`@@ -37,7 +37,11 @@ def resp_get_user():`
`37`	`37`	`return {`
`38`	`38`	`"method":responses.GET,`
`39`	`39`	`"url":"http://localhost/api/v4/user",`
`40`		`-"json": {"id":1,"username":"username"},`
	`40`	`+"json": {`
	`41`	`+"id":1,`
	`42`	`+"username":"username",`
	`43`	`+"web_url":"http://localhost/username",`
	`44`	`+ },`
`41`	`45`	`"content_type":"application/json",`
`42`	`46`	`"status":200,`
`43`	`47`	`}`
`@@ -254,6 +258,24 @@ def test_gitlab_token_auth(gl, resp_get_user):`
`254`	`258`	`assertisinstance(gl.user,gitlab.v4.objects.CurrentUser)`
`255`	`259`
`256`	`260`
	`261`	`+@responses.activate`
	`262`	`+deftest_gitlab_auth_with_mismatching_url_warns():`
	`263`	`+responses.add(`
	`264`	`+method=responses.GET,`
	`265`	`+url="http://first.example.com/api/v4/user",`
	`266`	`+json={`
	`267`	`+"username":"test-user",`
	`268`	`+"web_url":"http://second.example.com/test-user",`
	`269`	`+ },`
	`270`	`+content_type="application/json",`
	`271`	`+status=200,`
	`272`	`+ )`
	`273`	`+gl=gitlab.Gitlab("http://first.example.com")`
	`274`	`+`
	`275`	`+withpytest.warns(UserWarning):`
	`276`	`+gl.auth()`
	`277`	`+`
	`278`	`+`
`257`	`279`	`deftest_gitlab_default_url():`
`258`	`280`	`gl=gitlab.Gitlab()`
`259`	`281`	`assertgl.url==gitlab.const.DEFAULT_URL`

Comments

(0)