-
Notifications
You must be signed in to change notification settings - Fork 650
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(objects): support Create and Revoke personal access token API
- Loading branch information
1 parent
a5d8b7f
commit e19314d
Showing
4 changed files
with
119 additions
and
28 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,17 +1,32 @@ | ||
from gitlab.base import RESTManager, RESTObject | ||
from gitlab.mixins import ListMixin | ||
from gitlab.base import RequiredOptional, RESTManager, RESTObject | ||
from gitlab.mixins import CreateMixin, DeleteMixin, ListMixin, ObjectDeleteMixin | ||
|
||
__all__ = [ | ||
"PersonalAccessToken", | ||
"PersonalAccessTokenManager", | ||
"UserPersonalAccessToken", | ||
"UserPersonalAccessTokenManager", | ||
] | ||
|
||
|
||
class PersonalAccessToken(RESTObject): | ||
class PersonalAccessToken(ObjectDeleteMixin, RESTObject): | ||
pass | ||
|
||
|
||
class PersonalAccessTokenManager(ListMixin, RESTManager): | ||
class PersonalAccessTokenManager(DeleteMixin, ListMixin, RESTManager): | ||
_path = "/personal_access_tokens" | ||
_obj_cls = PersonalAccessToken | ||
_list_filters = ("user_id",) | ||
|
||
|
||
class UserPersonalAccessToken(RESTObject): | ||
pass | ||
|
||
|
||
class UserPersonalAccessTokenManager(CreateMixin, RESTManager): | ||
_path = "/users/%(user_id)s/personal_access_tokens" | ||
_obj_cls = UserPersonalAccessToken | ||
_from_parent_attrs = {"user_id": "id"} | ||
_create_attrs = RequiredOptional( | ||
required=("name", "scopes"), optional=("expires_at",) | ||
) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,46 +1,94 @@ | ||
""" | ||
GitLab API: https://docs.gitlab.com/ee/api/personal_access_tokens.html | ||
GitLab API: | ||
https://docs.gitlab.com/ee/api/personal_access_tokens.html | ||
https://docs.gitlab.com/ee/api/users.html#create-a-personal-access-token | ||
""" | ||
|
||
import pytest | ||
import responses | ||
|
||
user_id = 1 | ||
token_id = 1 | ||
token_name = "Test Token" | ||
|
||
token_url = "http://localhost/api/v4/personal_access_tokens" | ||
single_token_url = f"{token_url}/{token_id}" | ||
user_token_url = f"http://localhost/api/v4/users/{user_id}/personal_access_tokens" | ||
|
||
content = { | ||
"id": token_id, | ||
"name": token_name, | ||
"revoked": False, | ||
"created_at": "2020-07-23T14:31:47.729Z", | ||
"scopes": ["api"], | ||
"active": True, | ||
"user_id": user_id, | ||
"expires_at": None, | ||
} | ||
|
||
|
||
@pytest.fixture | ||
def resp_list_personal_access_token(): | ||
content = [ | ||
{ | ||
"id": 4, | ||
"name": "Test Token", | ||
"revoked": False, | ||
"created_at": "2020-07-23T14:31:47.729Z", | ||
"scopes": ["api"], | ||
"active": True, | ||
"user_id": 24, | ||
"expires_at": None, | ||
} | ||
] | ||
def resp_create_user_personal_access_token(): | ||
with responses.RequestsMock() as rsps: | ||
rsps.add( | ||
method=responses.POST, | ||
url=user_token_url, | ||
json=content, | ||
content_type="application/json", | ||
status=200, | ||
) | ||
yield rsps | ||
|
||
|
||
@pytest.fixture | ||
def resp_personal_access_token(no_content): | ||
with responses.RequestsMock(assert_all_requests_are_fired=False) as rsps: | ||
rsps.add( | ||
method=responses.GET, | ||
url="http://localhost/api/v4/personal_access_tokens", | ||
json=content, | ||
url=token_url, | ||
json=[content], | ||
content_type="application/json", | ||
status=200, | ||
) | ||
rsps.add( | ||
method=responses.DELETE, | ||
url=single_token_url, | ||
json=no_content, | ||
content_type="application/json", | ||
status=204, | ||
) | ||
yield rsps | ||
|
||
|
||
def test_list_personal_access_tokens(gl, resp_list_personal_access_token): | ||
def test_create_personal_access_token(gl, resp_create_user_personal_access_token): | ||
user = gl.users.get(1, lazy=True) | ||
access_token = user.personal_access_tokens.create( | ||
{"name": token_name, "scopes": "api"} | ||
) | ||
assert access_token.revoked is False | ||
assert access_token.name == token_name | ||
|
||
|
||
def test_list_personal_access_tokens(gl, resp_personal_access_token): | ||
access_tokens = gl.personal_access_tokens.list() | ||
assert len(access_tokens) == 1 | ||
assert access_tokens[0].revoked is False | ||
assert access_tokens[0].name == "Test Token" | ||
assert access_tokens[0].name == token_name | ||
|
||
|
||
def test_list_personal_access_tokens_filter(gl, resp_list_personal_access_token): | ||
access_tokens = gl.personal_access_tokens.list(user_id=24) | ||
def test_list_personal_access_tokens_filter(gl, resp_personal_access_token): | ||
access_tokens = gl.personal_access_tokens.list(user_id=user_id) | ||
assert len(access_tokens) == 1 | ||
assert access_tokens[0].revoked is False | ||
assert access_tokens[0].user_id == 24 | ||
assert access_tokens[0].user_id == user_id | ||
|
||
|
||
def test_revoke_personal_access_token(gl, resp_personal_access_token): | ||
access_token = gl.personal_access_tokens.list(user_id=user_id)[0] | ||
access_token.delete() | ||
assert resp_personal_access_token.assert_call_count(single_token_url, 1) | ||
|
||
|
||
def test_revoke_personal_access_token_by_id(gl, resp_personal_access_token): | ||
gl.personal_access_tokens.delete(token_id) | ||
assert resp_personal_access_token.assert_call_count(single_token_url, 1) |