"""Test client construction""" # pylint: disable=missing-docstring,protected-access from __future__ import annotations import asyncio from unittest.mock import patch import aiohttp import pytest from aiogithubapi import ( GitHubAPI, GitHubConnectionException, GitHubException, GitHubRatelimitException, ) from aiogithubapi.client import MESSAGE_EXCEPTIONS, STATUS_EXCEPTIONS from aiogithubapi.const import GitHubRequestKwarg, HttpStatusCode from tests.common import ( EXPECTED_ETAG, TEST_REQUEST_HEADERS, MockedRequests, MockResponse, ) @pytest.mark.asyncio async def test_passing_etag_to_request( github_api: GitHubAPI, mock_requests: MockedRequests, ): response = await github_api.generic("/generic") assert response.status == 200 assert "If-None-Match" not in mock_requests.last_request["headers"] mock_requests.clear() response = await github_api.generic("/generic", **{GitHubRequestKwarg.ETAG: "test"}) assert response.status == 200 assert mock_requests.last_request["headers"]["If-None-Match"] == "test" @pytest.mark.asyncio async def test_passing_headers_to_request( github_api: GitHubAPI, mock_requests: MockedRequests, ): response = await github_api.generic("/generic") assert response.status == 200 assert mock_requests.last_request["headers"] == TEST_REQUEST_HEADERS mock_requests.clear() response = await github_api.generic( "/generic", **{GitHubRequestKwarg.HEADERS: {"test": "test"}} ) assert response.status == 200 assert mock_requests.last_request["headers"] == { **TEST_REQUEST_HEADERS, "test": "test", } @pytest.mark.asyncio async def test_passing_params_to_request( github_api: GitHubAPI, mock_requests: MockedRequests, ): response = await github_api.generic("/generic") assert response.status == 200 assert mock_requests.last_request["params"] == {} mock_requests.clear() response = await github_api.generic("/generic", **{GitHubRequestKwarg.PARAMS: {"test": "test"}}) assert response.status == 200 assert mock_requests.last_request["params"] == {"test": "test"} mock_requests.clear() response = await github_api.generic("/generic", **{GitHubRequestKwarg.QUERY: {"test": "test"}}) assert response.status == 200 assert mock_requests.last_request["params"] == {"test": "test"} @pytest.mark.asyncio async def test_passing_method_to_request( github_api: GitHubAPI, mock_requests: MockedRequests, ): response = await github_api.generic("/generic") assert response.status == 200 assert mock_requests.last_request["method"] == "get" mock_requests.clear() response = await github_api.generic("/generic", **{GitHubRequestKwarg.METHOD: "POST"}) assert response.status == 200 assert mock_requests.last_request["method"] == "post" @pytest.mark.asyncio async def test_client_exceptions(github_api: GitHubAPI): with patch("aiohttp.ClientSession.request", side_effect=aiohttp.ClientError("client_error")): with pytest.raises( GitHubConnectionException, match="Request exception for 'https://api.github.com/generic' with - client_error", ): await github_api.generic("/generic") with patch( "aiohttp.ClientSession.request", side_effect=asyncio.CancelledError("cancelation_error"), ): with pytest.raises( GitHubConnectionException, match="Request exception for 'https://api.github.com/generic' with - cancelation_error", ): await github_api.generic("/generic") with patch("aiohttp.ClientSession.request", side_effect=asyncio.TimeoutError): with pytest.raises( GitHubConnectionException, match="Timeout of 20 reached while waiting for https://api.github.com/generic", ): await github_api.generic("/generic") with patch("aiohttp.ClientSession.request", side_effect=BaseException("Eeeeeh... okey?")): with pytest.raises( GitHubException, match="Unexpected exception for " "'https://api.github.com/generic' with - Eeeeeh... okey?", ): await github_api.generic("/generic") with patch("json.loads", side_effect=KeyError("err")): with pytest.raises( GitHubException, match="Could not handle response data from 'https://api.github.com/generic' with - 'err'", ): await github_api.generic("/generic") @pytest.mark.parametrize( "status,exception", (*((status, STATUS_EXCEPTIONS[status]) for status in STATUS_EXCEPTIONS),), ) @pytest.mark.asyncio async def test_status_code_handling( github_api: GitHubAPI, mock_response: MockResponse, status: HttpStatusCode, exception: GitHubException, ): mock_response.mock_status = status mock_response.mock_data = { "message": "Error", "documentation_url": "https://example.com", } with pytest.raises(exception): await github_api.generic("/generic") @pytest.mark.parametrize( "message,exception", ( *((message, MESSAGE_EXCEPTIONS[message]) for message in MESSAGE_EXCEPTIONS), ("API rate limit exceeded for xxx.xxx.xxx.xxx.", GitHubRatelimitException), ("Random error", GitHubException), ), ) @pytest.mark.asyncio async def test_error_message_handling( github_api: GitHubAPI, mock_response: MockResponse, message: str, exception: GitHubException, ): mock_response.mock_data = { "message": message, "documentation_url": "https://example.com", } with pytest.raises(exception): await github_api.generic("/generic") @pytest.mark.asyncio async def test_no_content_handling(github_api: GitHubAPI, mock_response: MockResponse): mock_response.mock_status = 204 response = await github_api.generic("/generic") assert response.data is None @pytest.mark.asyncio async def test_response_object(github_api: GitHubAPI, mock_response: MockResponse): response = await github_api.generic("/generic") assert response.etag == EXPECTED_ETAG assert response.page_number == 2 assert response.next_page_number == 3 assert response.last_page_number == 46 assert not response.is_last_page mock_response.mock_headers = {"Link": None} response = await github_api.generic("/generic") assert response.is_last_page assert response.page_number == 1 assert response.next_page_number is None assert response.last_page_number is None assert response.pages == {} mock_response.mock_headers = {"Link": ""} response = await github_api.generic("/generic") assert response.page_number == 1 @pytest.mark.asyncio async def test_created_with_message_handling(github_api: GitHubAPI, mock_response: MockResponse): """Ensure 201 Created with a message does not raise an exception.""" mock_response.mock_status = 201 mock_response.mock_data = { "message": "Some info message", "id": 123, "name": "created-object" } response = await github_api.generic("/generic") assert response.status == HttpStatusCode.CREATED assert response.data["message"] == "Some info message" assert response.data["id"] == 123 assert response.data["name"] == "created-object"