| 1 |
"""Test client construction""" |
| 2 |
# pylint: disable=missing-docstring,protected-access |
| 3 |
from aiohttp import ClientSession |
| 4 |
import pytest |
| 5 |
|
| 6 |
from aiogithubapi.client import GitHubClient |
| 7 |
from aiogithubapi.const import BASE_API_HEADERS, DEFAULT_USER_AGENT, HEADER_GITHUB_API_VERSION, GitHubClientKwarg |
| 8 |
|
| 9 |
from tests.common import TOKEN |
| 10 |
|
| 11 |
|
| 12 |
@pytest.mark.asyncio |
| 13 |
async def test_client_construction_defaults( |
| 14 |
client_session: ClientSession, caplog: pytest.CaptureFixture |
| 15 |
): |
| 16 |
client = GitHubClient(session=client_session) |
| 17 |
base_request_data = client._base_request_data |
| 18 |
|
| 19 |
assert client._session == client_session |
| 20 |
assert base_request_data.base_url == "https://api.github.com" |
| 21 |
assert base_request_data.timeout == 20 |
| 22 |
assert base_request_data.token is None |
| 23 |
assert base_request_data.kwargs == {} |
| 24 |
assert base_request_data.headers == BASE_API_HEADERS |
| 25 |
assert "Authorization" not in base_request_data.headers |
| 26 |
assert base_request_data.headers["User-Agent"] == DEFAULT_USER_AGENT |
| 27 |
assert ( |
| 28 |
"User-Agent not set. Set this with passing a user-agent header or the client_name argument." |
| 29 |
in caplog.text |
| 30 |
) |
| 31 |
|
| 32 |
|
| 33 |
@pytest.mark.asyncio |
| 34 |
async def test_client_construction_with_token(client_session: ClientSession): |
| 35 |
client = GitHubClient(session=client_session, token=TOKEN) |
| 36 |
base_request_data = client._base_request_data |
| 37 |
assert base_request_data.token == TOKEN |
| 38 |
assert base_request_data.headers == { |
| 39 |
**BASE_API_HEADERS, |
| 40 |
"Authorization": "token xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx", |
| 41 |
} |
| 42 |
|
| 43 |
|
| 44 |
@pytest.mark.asyncio |
| 45 |
async def test_client_construction_with_api_version(client_session: ClientSession): |
| 46 |
client = GitHubClient(session=client_session, token=TOKEN, api_version="3000-01-01") |
| 47 |
base_request_data = client._base_request_data |
| 48 |
assert base_request_data.token == TOKEN |
| 49 |
assert base_request_data.headers == { |
| 50 |
**BASE_API_HEADERS, |
| 51 |
HEADER_GITHUB_API_VERSION: "3000-01-01", |
| 52 |
"Authorization": "token xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx", |
| 53 |
} |
| 54 |
|
| 55 |
|
| 56 |
@pytest.mark.asyncio |
| 57 |
async def test_client_construction_with_kwargs_timeout(client_session: ClientSession): |
| 58 |
client = GitHubClient(session=client_session, **{GitHubClientKwarg.TIMEOUT: 10}) |
| 59 |
base_request_data = client._base_request_data |
| 60 |
assert base_request_data.timeout == 10 |
| 61 |
|
| 62 |
|
| 63 |
@pytest.mark.asyncio |
| 64 |
async def test_client_construction_with_kwargs_base_url(client_session: ClientSession): |
| 65 |
client = GitHubClient( |
| 66 |
session=client_session, **{GitHubClientKwarg.BASE_URL: "https://example.com"} |
| 67 |
) |
| 68 |
base_request_data = client._base_request_data |
| 69 |
assert base_request_data.base_url == "https://example.com" |
| 70 |
|
| 71 |
|
| 72 |
@pytest.mark.asyncio |
| 73 |
async def test_client_construction_with_kwargs_headers(client_session: ClientSession): |
| 74 |
client = GitHubClient( |
| 75 |
session=client_session, **{GitHubClientKwarg.HEADERS: {"User-Agent": "test/client"}} |
| 76 |
) |
| 77 |
base_request_data = client._base_request_data |
| 78 |
assert base_request_data.headers["User-Agent"] == "test/client" |
| 79 |
|
| 80 |
|
| 81 |
@pytest.mark.asyncio |
| 82 |
async def test_client_construction_with_kwargs_client_name(client_session: ClientSession): |
| 83 |
client = GitHubClient( |
| 84 |
session=client_session, **{GitHubClientKwarg.CLIENT_NAME: "test_client/1.2.3"} |
| 85 |
) |
| 86 |
base_request_data = client._base_request_data |
| 87 |
assert base_request_data.headers["User-Agent"] == "test_client/1.2.3" |