📝 add unit test using mock transport

Author: yanyongyu

docs/usage/unit-test.md

@@ -1,6 +1,10 @@
 # Unit Test
 
-If you are using githubkit in your business logic, you may want to mock the github API in your unit tests. You can custom the response by mocking the `request`/`arequest` method of the `GitHub` class. Here is an example of how to mock githubkit's API calls:
+If you are using githubkit in your business logic, you may want to mock the github API in your unit tests. There are two ways to reach this.
+
+## Mocking the API Calls
+
+If you can't provide a githubkit test client to your business logic, you can mock the `request`/`arequest` method of the `GitHub` class to custom the response. Here is an example of how to mock githubkit's API calls:
 
 === "Sync"
 
@@ -106,3 +110,66 @@ If you are using githubkit in your business logic, you may want to mock the gith
     1. Example function you want to test, which calls the GitHub API.
     2. other request parameters including headers, json, etc.
     3. When the request is made, return a fake response
+
+## Using a Test Transport
+
+You can also create a test client with mock transport and provide it to your business logic. Here is an example:
+
+=== "Sync"
+
+    ```python
+    import json
+    from pathlib import Path
+
+    import httpx
+    import pytest
+
+    from githubkit import GitHub
+    from githubkit.versions.latest.models import FullRepository
+
+    FAKE_RESPONSE = json.loads(Path("fake_response.json").read_text())
+
+    def target_sync_func(github: GitHub):
+        resp = github.rest.repos.get("owner", "repo")
+        return resp.parsed_data
+
+    def mock_transport_handler(request: httpx.Request) -> httpx.Response:
+        if request.method == "GET" and request.url.path == "/repos/owner/repo":
+            return httpx.Response(status_code=200, json=FAKE_RESPONSE)
+        raise RuntimeError(f"Unexpected request: {request.method} {request.url.path}")
+
+    def test_sync_mock():
+        g = GitHub("xxxxx", transport=httpx.MockTransport(mock_transport_handler))
+        repo = target_sync_func(g)
+        assert isinstance(repo, FullRepository)
+    ```
+
+=== "Async"
+
+    ```python
+    import json
+    from pathlib import Path
+
+    import httpx
+    import pytest
+
+    from githubkit import GitHub
+    from githubkit.versions.latest.models import FullRepository
+
+    FAKE_RESPONSE = json.loads(Path("fake_response.json").read_text())
+
+    async def target_async_func(github: GitHub):
+        resp = await github.rest.repos.async_get("owner", "repo")
+        return resp.parsed_data
+
+    def mock_transport_handler(request: httpx.Request) -> httpx.Response:
+        if request.method == "GET" and request.url.path == "/repos/owner/repo":
+            return httpx.Response(status_code=200, json=FAKE_RESPONSE)
+        raise RuntimeError(f"Unexpected request: {request.method} {request.url.path}")
+
+    @pytest.mark.anyio
+    async def test_async_mock():
+        g = GitHub("xxxxx", async_transport=httpx.MockTransport(mock_transport_handler))
+        repo = await target_async_func(g)
+        assert isinstance(repo, FullRepository)
+    ```

tests/test_unit_test/test_mock_transport.py

@@ -1,16 +1,12 @@
 import json
 from pathlib import Path
-from typing import TypeVar
 
 import httpx
 import pytest
 
 from githubkit import GitHub
 from githubkit.versions.latest.models import FullRepository
 
-T = TypeVar("T")
-
-
 FAKE_RESPONSE = json.loads((Path(__file__).parent / "fake_response.json").read_text())