[feat,refactor,fix]: remove env requirement, fix widgeet tests, add timeout tests

Author: null8626

tests/test_client.py

@@ -1,6 +1,6 @@
 from multidict import CIMultiDict
 from datetime import datetime
-from os import getenv, path
+from os import path
 import sys
 
 sys.path.insert(0, path.join(path.dirname(path.realpath(__file__)), '..'))
@@ -17,16 +17,14 @@
 from util import _test_attributes, RequestMock
 
 
+MOCK_TOKEN = '.eyJfdCI6IiIsImlkIjoiMzY0ODA2MDI5ODc2NTU1Nzc2In0=.'
+
+
 @pytest_asyncio.fixture
 async def client(
   monkeypatch: pytest.MonkeyPatch,
 ) -> AsyncGenerator[topgg.Client, None]:
-  token = getenv('TOPGG_TOKEN')
-
-  if TYPE_CHECKING:
-    assert token is not None, 'Missing Top.gg API token'
-
-  client = topgg.Client(token)
+  client = topgg.Client(MOCK_TOKEN)
 
   monkeypatch.setattr(topgg.Ratelimiter, '_calls', deque([time()]))
 
@@ -50,12 +48,7 @@ async def test_Client_basic_error_handling_works() -> None:
       pass
 
   with pytest.raises(topgg.Error, match='^Client session is already closed.$'):
-    token = getenv('TOPGG_TOKEN')
-
-    if TYPE_CHECKING:
-      assert token is not None, 'Missing Top.gg API token'
-
-    test_client = topgg.Client(token)
+    test_client = topgg.Client(MOCK_TOKEN)
 
     await test_client.close()
     await test_client.get_self()

tests/test_webhooks.py

@@ -4,7 +4,6 @@
 from functools import cache
 from hashlib import sha256
 from os.path import join
-from os import getenv
 from time import time
 import pytest_asyncio
 import pytest
@@ -15,23 +14,16 @@
 from util import _test_attributes, CURRENT_DIR
 
 
+MOCK_SECRET = 'testsecret1234'
 MOCK_TRACE = 'trace'
 WebhooksFixture = tuple[topgg.Webhooks, test_utils.TestClient]
 WebhooksSignatureFixture = Callable[[str], tuple[str, str]]
 
 
-@pytest.fixture
-def webhook_secret() -> str:
-  secret = getenv('TOPGG_WEBHOOK_SECRET')
-
-  assert secret is not None, 'Missing TOPGG_WEBHOOK_SECRET environment variable.'
-  return secret
-
-
 @pytest_asyncio.fixture
-async def webhooks(webhook_secret: str) -> AsyncGenerator[WebhooksFixture, None]:
+async def webhooks() -> AsyncGenerator[WebhooksFixture, None]:
   app = test_utils.TestClient(test_utils.TestServer(web.Application()))
-  webhooks = topgg.Webhooks('/webhook', webhook_secret, app=app)
+  webhooks = topgg.Webhooks('/webhook', MOCK_SECRET, app=app)
 
   for payload_type in topgg.PayloadType:
 
@@ -47,12 +39,12 @@ async def handler(payload: topgg.Payload, trace: str) -> web.Response:
 
 
 @pytest.fixture
-def webhook_signature(webhook_secret: str) -> WebhooksSignatureFixture:
+def webhook_signature() -> WebhooksSignatureFixture:
   t = str(int(time()))
 
   def generate_webhook_signature(body: str) -> tuple[str, str]:
     return t, hmac.new(
-      webhook_secret.encode('utf-8'),
+      MOCK_SECRET.encode('utf-8'),
       f'{t}.{body}'.encode('utf-8'),
       sha256,
     ).hexdigest()
@@ -63,7 +55,6 @@ def generate_webhook_signature(body: str) -> tuple[str, str]:
 @pytest.mark.asyncio
 async def test_Webhooks_error_handling_works(
   webhooks: WebhooksFixture,
-  webhook_secret: str,
   webhook_signature: WebhooksSignatureFixture,
 ) -> None:
   wh, client = webhooks
@@ -76,7 +67,10 @@ async def test_Webhooks_error_handling_works(
       topgg.Webhooks(None, None)
 
     with pytest.raises(TypeError, match='^The specified port must be an integer.$'):
-      topgg.Webhooks('foo', webhook_secret, port='')
+      topgg.Webhooks('foo', MOCK_SECRET, port='')
+
+    with pytest.raises(TypeError, match='^The specified timeout must be a float.$'):
+      topgg.Webhooks('foo', MOCK_SECRET, timeout=1)
 
   with pytest.raises(
     ValueError, match=r'^The specified secret, route, and/or host must not be empty.$'
@@ -140,6 +134,15 @@ def test():
     assert response.status == 403
     assert (await response.json()).get('error') == 'Invalid signature'
 
+    response = await client.post(
+      '/webhook',
+      data='',
+      headers={'Content-Length': '2', 'Content-Type': 'application/json'},
+    )
+
+    assert response.status == 400
+    assert (await response.json()).get('error') == 'Malformed request'
+
 
 @cache
 async def start_webhooks(webhooks: topgg.Webhooks):

tests/test_widget.py

@@ -6,16 +6,20 @@
 @pytest.mark.parametrize('function_name', ('large', 'votes', 'owner', 'social'))
 @pytest.mark.parametrize('platform', iter(Platform))
 @pytest.mark.parametrize('project_type', iter(ProjectType))
-def test_Widget_works(function_name: str, platform: Platform, project_type: ProjectType):
+def test_Widget_works(
+  function_name: str, platform: Platform, project_type: ProjectType
+):
   function = getattr(Widget, function_name)
 
-  url = function(project_type, 123456)
+  url = function(platform, project_type, 123456)
   path = 'large' if function_name == 'large' else f'small/{function_name}'
 
-  assert url == f'{BASE_URL}/widgets/{path}/{platform.value}/{project_type.value}/123456'
+  assert (
+    url == f'{BASE_URL}/widgets/{path}/{platform.value}/{project_type.value}/123456'
+  )
 
   with pytest.raises(
     TypeError,
     match=r'^The specified platform, project type, and/or project ID\'s type is invalid.$',
   ):
-    function(project_type, None)
+    function(platform, project_type, None)