Skip to content

Commit e9b1583

Browse files
author
Gauvain Pocentek
committed
Rework authentication args handling
* Raise exceptions when conflicting arguments are used * Build the auth headers when instanciating Gitlab, not on each request * Enable anonymous Gitlab objects (#364) Add docs and unit tests
1 parent ba6e09e commit e9b1583

File tree

3 files changed

+89
-27
lines changed

3 files changed

+89
-27
lines changed

‎docs/api-usage.rst‎

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,11 +20,17 @@ To connect to a GitLab server, create a ``gitlab.Gitlab`` object:
2020
import gitlab
2121
2222
# private token authentication
23-
gl = gitlab.Gitlab('http://10.0.0.1', 'JVNSESs8EwWRx5yDxM5q')
23+
gl = gitlab.Gitlab('http://10.0.0.1', private_token='JVNSESs8EwWRx5yDxM5q')
2424
25-
# or username/password authentication
25+
# oauth token authentication
26+
gl = gitlab.Gitlab('http://10.0.0.1', oauth_token='my_long_token_here')
27+
28+
# username/password authentication
2629
gl = gitlab.Gitlab('http://10.0.0.1', email='jdoe', password='s3cr3t')
2730
31+
# anonymous gitlab instance, read-only for public resources
32+
gl = gitlab.Gitlab('http://10.0.0.1')
33+
2834
# make an API request to create the gl.user object. This is mandatory if you
2935
# use the username/password authentication.
3036
gl.auth()

‎gitlab/__init__.py‎

Lines changed: 32 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,7 @@ class Gitlab(object):
5959
Args:
6060
url (str): The URL of the GitLab server.
6161
private_token (str): The user private token
62+
oauth_token (str): An oauth token
6263
email (str): The user email or login.
6364
password (str): The user password (associated with email).
6465
ssl_verify (bool|str): Whether SSL certificates should be validated. If
@@ -82,16 +83,19 @@ def __init__(self, url, private_token=None, oauth_token=None, email=None,
8283
self.timeout = timeout
8384
#: Headers that will be used in request to GitLab
8485
self.headers = {}
85-
self._set_token(private_token, oauth_token)
8686

8787
#: The user email
8888
self.email = email
8989
#: The user password (associated with email)
9090
self.password = password
9191
#: Whether SSL certificates should be validated
9292
self.ssl_verify = ssl_verify
93+
94+
self.private_token = private_token
9395
self.http_username = http_username
9496
self.http_password = http_password
97+
self.oauth_token = oauth_token
98+
self._set_auth_info()
9599

96100
#: Create a session object for requests
97101
self.session = session or requests.Session()
@@ -192,15 +196,12 @@ def auth(self):
192196
The `user` attribute will hold a `gitlab.objects.CurrentUser` object on
193197
success.
194198
"""
195-
if self.private_token:
199+
if self.private_token or self.oauth_token:
196200
self._token_auth()
197201
else:
198202
self._credentials_auth()
199203

200204
def _credentials_auth(self):
201-
if not self.email or not self.password:
202-
raise GitlabAuthenticationError("Missing email/password")
203-
204205
data = {'email': self.email, 'password': self.password}
205206
if self.api_version == '3':
206207
r = self._raw_post('/session', json.dumps(data),
@@ -211,8 +212,8 @@ def _credentials_auth(self):
211212
r = self.http_post('/session', data)
212213
manager = self._objects.CurrentUserManager(self)
213214
self.user = self._objects.CurrentUser(manager, r)
214-
215-
self._set_token(self.user.private_token)
215+
self.private_token = self.user.private_token
216+
self._set_auth_info()
216217

217218
def _token_auth(self):
218219
if self.api_version == '3':
@@ -267,18 +268,30 @@ def _construct_url(self, id_, obj, parameters, action=None):
267268
else:
268269
return url
269270

270-
def _set_token(self, private_token, oauth_token=None):
271-
self.private_token = private_token if private_token else None
272-
self.oauth_token = oauth_token if oauth_token else None
271+
def _set_auth_info(self):
272+
if self.private_token and self.oauth_token:
273+
raise ValueError("Only one of private_token or oauth_token should "
274+
"be defined")
275+
if ((self.http_username and not self.http_password)
276+
or (not self.http_username and self.http_password)):
277+
raise ValueError("Both http_username and http_password should "
278+
"be defined")
279+
if self.oauth_token and self.http_username:
280+
raise ValueError("Only one of oauth authentication or http "
281+
"authentication should be defined")
282+
283+
self._http_auth = None
284+
if self.private_token:
285+
self.headers['PRIVATE-TOKEN'] = self.private_token
286+
self.headers.pop('Authorization', None)
287+
288+
if self.oauth_token:
289+
self.headers['Authorization'] = "Bearer %s" % self.oauth_token
290+
self.headers.pop('PRIVATE-TOKEN', None)
273291

274-
if private_token:
275-
self.headers["PRIVATE-TOKEN"] = private_token
276-
if 'Authorization' in self.headers:
277-
del self.headers["Authorization"]
278-
elif oauth_token:
279-
self.headers['Authorization'] = "Bearer %s" % oauth_token
280-
if "PRIVATE-TOKEN" in self.headers:
281-
del self.headers["PRIVATE-TOKEN"]
292+
if self.http_username:
293+
self._http_auth = requests.auth.HTTPBasicAuth(self.http_username,
294+
self.http_password)
282295

283296
def enable_debug(self):
284297
import logging
@@ -300,16 +313,10 @@ def _create_headers(self, content_type=None):
300313
request_headers['Content-type'] = content_type
301314
return request_headers
302315

303-
def _create_auth(self):
304-
if self.http_username and self.http_password:
305-
return requests.auth.HTTPBasicAuth(self.http_username,
306-
self.http_password)
307-
return None
308-
309316
def _get_session_opts(self, content_type):
310317
return {
311318
'headers': self._create_headers(content_type),
312-
'auth': self._create_auth(),
319+
'auth': self._http_auth,
313320
'timeout': self.timeout,
314321
'verify': self.ssl_verify
315322
}

‎gitlab/tests/test_gitlab.py‎

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@
2727
from httmock import HTTMock # noqa
2828
from httmock import response # noqa
2929
from httmock import urlmatch # noqa
30+
import requests
3031
import six
3132

3233
import gitlab
@@ -884,6 +885,54 @@ def resp_cont(url, request):
884885
self.assertRaises(GitlabUpdateError, self.gl.update, obj)
885886

886887

888+
class TestGitlabAuth(unittest.TestCase):
889+
def test_invalid_auth_args(self):
890+
self.assertRaises(ValueError,
891+
Gitlab,
892+
"http://localhost", api_version='4',
893+
private_token='private_token', oauth_token='bearer')
894+
self.assertRaises(ValueError,
895+
Gitlab,
896+
"http://localhost", api_version='4',
897+
oauth_token='bearer', http_username='foo',
898+
http_password='bar')
899+
self.assertRaises(ValueError,
900+
Gitlab,
901+
"http://localhost", api_version='4',
902+
private_token='private_token', http_password='bar')
903+
self.assertRaises(ValueError,
904+
Gitlab,
905+
"http://localhost", api_version='4',
906+
private_token='private_token', http_username='foo')
907+
908+
def test_private_token_auth(self):
909+
gl = Gitlab('http://localhost', private_token='private_token',
910+
api_version='4')
911+
self.assertEqual(gl.private_token, 'private_token')
912+
self.assertEqual(gl.oauth_token, None)
913+
self.assertEqual(gl._http_auth, None)
914+
self.assertEqual(gl.headers['PRIVATE-TOKEN'], 'private_token')
915+
self.assertNotIn('Authorization', gl.headers)
916+
917+
def test_oauth_token_auth(self):
918+
gl = Gitlab('http://localhost', oauth_token='oauth_token',
919+
api_version='4')
920+
self.assertEqual(gl.private_token, None)
921+
self.assertEqual(gl.oauth_token, 'oauth_token')
922+
self.assertEqual(gl._http_auth, None)
923+
self.assertEqual(gl.headers['Authorization'], 'Bearer oauth_token')
924+
self.assertNotIn('PRIVATE-TOKEN', gl.headers)
925+
926+
def test_http_auth(self):
927+
gl = Gitlab('http://localhost', private_token='private_token',
928+
http_username='foo', http_password='bar', api_version='4')
929+
self.assertEqual(gl.private_token, 'private_token')
930+
self.assertEqual(gl.oauth_token, None)
931+
self.assertIsInstance(gl._http_auth, requests.auth.HTTPBasicAuth)
932+
self.assertEqual(gl.headers['PRIVATE-TOKEN'], 'private_token')
933+
self.assertNotIn('Authorization', gl.headers)
934+
935+
887936
class TestGitlab(unittest.TestCase):
888937

889938
def setUp(self):

0 commit comments

Comments
 (0)