Skip to content

Commit cef3aa5

Browse files
sathieusathieu
committed
feat: add support for job token
See https://docs.gitlab.com/ee/api/jobs.html#get-job-artifacts for usage
1 parent b7f3342 commit cef3aa5

File tree

7 files changed

+58
-11
lines changed

7 files changed

+58
-11
lines changed

‎docker-entrypoint.sh‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ per_page = ${GITLAB_PER_PAGE:-10}
1414
url = ${GITLAB_URL:-https://gitlab.com}
1515
private_token = ${GITLAB_PRIVATE_TOKEN}
1616
oauth_token = ${GITLAB_OAUTH_TOKEN}
17+
job_token = ${GITLAB_JOB_TOKEN}
1718
http_username = ${GITLAB_HTTP_USERNAME}
1819
http_password = ${GITLAB_HTTP_PASSWORD}
1920
EOF

‎docs/api-usage.rst‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,10 @@ To connect to a GitLab server, create a ``gitlab.Gitlab`` object:
1919
# oauth token authentication
2020
gl = gitlab.Gitlab('http://10.0.0.1', oauth_token='my_long_token_here')
2121
22+
# job token authentication (to be used in CI)
23+
import os
24+
gl = gitlab.Gitlab('http://10.0.0.1', job_token=os.environ['CI_JOB_TOKEN'])
25+
2226
# username/password authentication (for GitLab << 10.2)
2327
gl = gitlab.Gitlab('http://10.0.0.1', email='jdoe', password='s3cr3t')
2428

‎docs/cli.rst‎

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -83,9 +83,9 @@ You must define the ``url`` in each GitLab server section.
8383
If the GitLab server you are using redirects requests from http to https,
8484
make sure to use the ``https://`` protocol in the ``url`` definition.
8585

86-
Only one of ``private_token`` or ``oauth_token`` should be defined. If neither
87-
are defined an anonymous request will be sent to the Gitlab server, with very
88-
limited permissions.
86+
Only one of ``private_token``, ``oauth_token`` or ``job_token`` should be
87+
defined. If neither are defined an anonymous request will be sent to the Gitlab
88+
server, with very limited permissions.
8989

9090
.. list-table:: GitLab server options
9191
:header-rows: 1
@@ -96,10 +96,12 @@ limited permissions.
9696
- URL for the GitLab server
9797
* - ``private_token``
9898
- Your user token. Login/password is not supported. Refer to `the official
99-
documentation`__ to learn how to obtain a token.
99+
documentation`_pat to learn how to obtain a token.
100100
* - ``oauth_token``
101101
- An Oauth token for authentication. The Gitlab server must be configured
102102
to support this authentication method.
103+
* - ``job_token``
104+
- Your job token. See `the official documentation`_job-token to learn how to obtain a token.
103105
* - ``api_version``
104106
- GitLab API version to use (``3`` or ``4``). Defaults to ``4`` since
105107
version 1.3.0.
@@ -108,7 +110,8 @@ limited permissions.
108110
* - ``http_password``
109111
- Password for optional HTTP authentication
110112

111-
__ https://docs.gitlab.com/ce/user/profile/personal_access_tokens.html
113+
.. _pat: https://docs.gitlab.com/ce/user/profile/personal_access_tokens.html
114+
.. _job-token: https://docs.gitlab.com/ce/api/jobs.html#get-job-artifacts
112115

113116
CLI
114117
===

‎gitlab/__init__.py‎

Lines changed: 22 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,7 @@ class Gitlab(object):
6060
url (str): The URL of the GitLab server.
6161
private_token (str): The user private token
6262
oauth_token (str): An oauth token
63+
job_token (str): A CI job token
6364
email (str): The user email or login.
6465
password (str): The user password (associated with email).
6566
ssl_verify (bool|str): Whether SSL certificates should be validated. If
@@ -76,6 +77,7 @@ def __init__(
7677
url,
7778
private_token=None,
7879
oauth_token=None,
80+
job_token=None,
7981
email=None,
8082
password=None,
8183
ssl_verify=True,
@@ -107,6 +109,7 @@ def __init__(
107109
self.http_username = http_username
108110
self.http_password = http_password
109111
self.oauth_token = oauth_token
112+
self.job_token = job_token
110113
self._set_auth_info()
111114

112115
#: Create a session object for requests
@@ -195,6 +198,7 @@ def from_config(cls, gitlab_id=None, config_files=None):
195198
config.url,
196199
private_token=config.private_token,
197200
oauth_token=config.oauth_token,
201+
job_token=config.job_token,
198202
ssl_verify=config.ssl_verify,
199203
timeout=config.timeout,
200204
http_username=config.http_username,
@@ -211,7 +215,7 @@ def auth(self):
211215
The `user` attribute will hold a `gitlab.objects.CurrentUser` object on
212216
success.
213217
"""
214-
if self.private_token or self.oauth_token:
218+
if self.private_token or self.oauth_token or self.job_token:
215219
self._token_auth()
216220
else:
217221
self._credentials_auth()
@@ -346,9 +350,16 @@ def _construct_url(self, id_, obj, parameters, action=None):
346350
return url
347351

348352
def _set_auth_info(self):
349-
if self.private_token and self.oauth_token:
353+
if (
354+
sum(
355+
bool(arg)
356+
for arg in [self.private_token, self.oauth_token, self.job_token]
357+
)
358+
!= 1
359+
):
350360
raise ValueError(
351-
"Only one of private_token or oauth_token should " "be defined"
361+
"Only one of private_token, oauth_token or job_token should "
362+
"be defined"
352363
)
353364
if (self.http_username and not self.http_password) or (
354365
not self.http_username and self.http_password
@@ -364,12 +375,19 @@ def _set_auth_info(self):
364375

365376
self._http_auth = None
366377
if self.private_token:
367-
self.headers["PRIVATE-TOKEN"] = self.private_token
368378
self.headers.pop("Authorization", None)
379+
self.headers["PRIVATE-TOKEN"] = self.private_token
380+
self.headers.pop("JOB-TOKEN", None)
369381

370382
if self.oauth_token:
371383
self.headers["Authorization"] = "Bearer %s" % self.oauth_token
372384
self.headers.pop("PRIVATE-TOKEN", None)
385+
self.headers.pop("JOB-TOKEN", None)
386+
387+
if self.job_token:
388+
self.headers.pop("Authorization", None)
389+
self.headers.pop("PRIVATE-TOKEN", None)
390+
self.headers["JOB-TOKEN"] = self.job_token
373391

374392
if self.http_username:
375393
self._http_auth = requests.auth.HTTPBasicAuth(

‎gitlab/cli.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -202,7 +202,7 @@ def main():
202202

203203
try:
204204
gl = gitlab.Gitlab.from_config(gitlab_id, config_files)
205-
if gl.private_token or gl.oauth_token:
205+
if gl.private_token or gl.oauth_token or gl.job_token:
206206
gl.auth()
207207
except Exception as e:
208208
die(str(e))

‎gitlab/config.py‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -122,6 +122,12 @@ def __init__(self, gitlab_id=None, config_files=None):
122122
except Exception:
123123
pass
124124

125+
self.job_token = None
126+
try:
127+
self.job_token = self._config.get(self.gitlab_id, "job_token")
128+
except Exception:
129+
pass
130+
125131
self.http_username = None
126132
self.http_password = None
127133
try:

‎gitlab/tests/test_gitlab.py‎

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -403,17 +403,31 @@ def test_private_token_auth(self):
403403
gl = Gitlab("http://localhost", private_token="private_token", api_version="4")
404404
self.assertEqual(gl.private_token, "private_token")
405405
self.assertEqual(gl.oauth_token, None)
406+
self.assertEqual(gl.job_token, None)
406407
self.assertEqual(gl._http_auth, None)
407-
self.assertEqual(gl.headers["PRIVATE-TOKEN"], "private_token")
408408
self.assertNotIn("Authorization", gl.headers)
409+
self.assertEqual(gl.headers["PRIVATE-TOKEN"], "private_token")
410+
self.assertNotIn("JOB-TOKEN", gl.headers)
409411

410412
def test_oauth_token_auth(self):
411413
gl = Gitlab("http://localhost", oauth_token="oauth_token", api_version="4")
412414
self.assertEqual(gl.private_token, None)
413415
self.assertEqual(gl.oauth_token, "oauth_token")
416+
self.assertEqual(gl.job_token, None)
414417
self.assertEqual(gl._http_auth, None)
415418
self.assertEqual(gl.headers["Authorization"], "Bearer oauth_token")
416419
self.assertNotIn("PRIVATE-TOKEN", gl.headers)
420+
self.assertNotIn("JOB-TOKEN", gl.headers)
421+
422+
def test_job_token_auth(self):
423+
gl = Gitlab("http://localhost", job_token="CI_JOB_TOKEN", api_version="4")
424+
self.assertEqual(gl.private_token, None)
425+
self.assertEqual(gl.oauth_token, None)
426+
self.assertEqual(gl.job_token, "CI_JOB_TOKEN")
427+
self.assertEqual(gl._http_auth, None)
428+
self.assertNotIn("Authorization", gl.headers)
429+
self.assertNotIn("PRIVATE-TOKEN", gl.headers)
430+
self.assertEqual(gl.headers["JOB-TOKEN"], "CI_JOB_TOKEN")
417431

418432
def test_http_auth(self):
419433
gl = Gitlab(
@@ -425,6 +439,7 @@ def test_http_auth(self):
425439
)
426440
self.assertEqual(gl.private_token, "private_token")
427441
self.assertEqual(gl.oauth_token, None)
442+
self.assertEqual(gl.job_token, None)
428443
self.assertIsInstance(gl._http_auth, requests.auth.HTTPBasicAuth)
429444
self.assertEqual(gl.headers["PRIVATE-TOKEN"], "private_token")
430445
self.assertNotIn("Authorization", gl.headers)

0 commit comments

Comments
 (0)