Tests should not depend on Matrix-nio, that uses lxml that needs a lot of dependencies and a lot of time to build

corres2math/matrix.py

@@ -1,12 +1,7 @@
+from enum import Enum
 import os
-from typing import Any, Dict, Optional, Tuple, Union
 
 from asgiref.sync import async_to_sync
-from nio import AsyncClient, DataProvider, ProfileSetAvatarError, ProfileSetAvatarResponse, \
-    ProfileSetDisplayNameError, ProfileSetDisplayNameResponse, RoomCreateError, RoomCreateResponse, \
-    RoomInviteError, RoomInviteResponse, RoomKickError, RoomKickResponse, RoomPreset, \
-    RoomPutStateError, RoomPutStateResponse, RoomResolveAliasResponse, RoomVisibility, TransferMonitor, \
-    UploadError, UploadResponse
 
 
 class Matrix:
@@ -18,11 +13,11 @@ class Matrix:
     Tasks are normally asynchronous, but for compatibility we make
     them synchronous.
     """
-    _token: str = None
-    _device_id: str = None
+    _token = None
+    _device_id = None
 
     @classmethod
-    async def _get_client(cls) -> Union[AsyncClient, "FakeMatrixClient"]:  # pragma: no cover
+    async def _get_client(cls):  # pragma: no cover
         """
         Retrieve the bot account.
         If not logged, log in and store access token.
@@ -30,6 +25,7 @@ class Matrix:
         if not os.getenv("SYNAPSE_PASSWORD"):
             return FakeMatrixClient()
 
+        from nio import AsyncClient
         client = AsyncClient("https://correspondances-maths.fr", "@corres2mathbot:correspondances-maths.fr")
         client.user_id = "@corres2mathbot:correspondances-maths.fr"
 
@@ -53,7 +49,7 @@ class Matrix:
 
     @classmethod
     @async_to_sync
-    async def set_display_name(cls, name: str) -> Union[ProfileSetDisplayNameResponse, ProfileSetDisplayNameError]:
+    async def set_display_name(cls, name: str):
         """
         Set the display name of the bot account.
         """
@@ -62,7 +58,7 @@ class Matrix:
 
     @classmethod
     @async_to_sync
-    async def set_avatar(cls, avatar_url: str) -> Union[ProfileSetAvatarResponse, ProfileSetAvatarError]:
+    async def set_avatar(cls, avatar_url: str):  # pragma: no cover
         """
         Set the display avatar of the bot account.
         """
@@ -73,13 +69,13 @@ class Matrix:
     @async_to_sync
     async def upload(
             cls,
-            data_provider: DataProvider,
+            data_provider,
             content_type: str = "application/octet-stream",
-            filename: Optional[str] = None,
+            filename: str = None,
             encrypt: bool = False,
-            monitor: Optional[TransferMonitor] = None,
-            filesize: Optional[int] = None,
-    ) -> Tuple[Union[UploadResponse, UploadError], Optional[Dict[str, Any]]]:
+            monitor=None,
+            filesize: int = None,
+    ):  # pragma: no cover
         """
         Upload a file to the content repository.
 
@@ -134,24 +130,24 @@ class Matrix:
         """
         client = await cls._get_client()
         return await client.upload(data_provider, content_type, filename, encrypt, monitor, filesize) \
-            if isinstance(client, AsyncClient) else UploadResponse("debug mode"), None
+            if not isinstance(client, FakeMatrixClient) else None, None
 
     @classmethod
     @async_to_sync
     async def create_room(
             cls,
-            visibility: RoomVisibility = RoomVisibility.private,
-            alias: Optional[str] = None,
-            name: Optional[str] = None,
-            topic: Optional[str] = None,
-            room_version: Optional[str] = None,
-            federate: bool = True,
-            is_direct: bool = False,
-            preset: Optional[RoomPreset] = None,
+            visibility=None,
+            alias=None,
+            name=None,
+            topic=None,
+            room_version=None,
+            federate=True,
+            is_direct=False,
+            preset=None,
             invite=(),
             initial_state=(),
-            power_level_override: Optional[Dict[str, Any]] = None,
-    ) -> Union[RoomCreateResponse, RoomCreateError]:
+            power_level_override=None,
+    ):
         """
         Create a new room.
 
@@ -213,18 +209,18 @@ class Matrix:
             power_level_override)
 
     @classmethod
-    async def resolve_room_alias(cls, room_alias: str) -> Optional[str]:
+    async def resolve_room_alias(cls, room_alias: str):
         """
         Resolve a room alias to a room ID.
         Return None if the alias does not exist.
         """
         client = await cls._get_client()
-        resp: RoomResolveAliasResponse = await client.room_resolve_alias(room_alias)
-        return resp.room_id if isinstance(resp, RoomResolveAliasResponse) else None
+        resp = await client.room_resolve_alias(room_alias)
+        return resp.room_id if resp else None
 
     @classmethod
     @async_to_sync
-    async def invite(cls, room_id: str, user_id: str) -> Union[RoomInviteResponse, RoomInviteError]:
+    async def invite(cls, room_id: str, user_id: str):
         """
         Invite a user to a room.
 
@@ -266,13 +262,13 @@ class Matrix:
 
     @classmethod
     @async_to_sync
-    async def kick(cls, room_id: str, user_id: str, reason: str = None) -> Union[RoomKickResponse, RoomKickError]:
+    async def kick(cls, room_id: str, user_id: str, reason: str = None):
         """
         Kick a user from a room, or withdraw their invitation.
 
         Kicking a user adjusts their membership to "leave" with an optional
         reason.
-
+²
         Returns either a `RoomKickResponse` if the request was successful or
         a `RoomKickError` if there was an error with the request.
 
@@ -289,8 +285,7 @@ class Matrix:
 
     @classmethod
     @async_to_sync
-    async def set_room_power_level(cls, room_id: str, user_id: str, power_level: int)\
-            -> Union[RoomPutStateResponse, RoomPutStateError]:  # pragma: no cover
+    async def set_room_power_level(cls, room_id: str, user_id: str, power_level: int):  # pragma: no cover
         """
         Put a given power level to a user in a certain room.
 
@@ -306,7 +301,7 @@ class Matrix:
         """
         client = await cls._get_client()
         if isinstance(client, FakeMatrixClient):
-            return RoomPutStateError("debug mode")
+            return None
 
         if room_id.startswith("#"):
             room_id = await cls.resolve_room_alias(room_id)
@@ -317,8 +312,7 @@ class Matrix:
 
     @classmethod
     @async_to_sync
-    async def set_room_power_level_event(cls, room_id: str, event: str, power_level: int)\
-            -> Union[RoomPutStateResponse, RoomPutStateError]:  # pragma: no cover
+    async def set_room_power_level_event(cls, room_id: str, event: str, power_level: int):  # pragma: no cover
         """
         Define the minimal power level to have to send a certain event type
          in a given room.
@@ -335,7 +329,7 @@ class Matrix:
         """
         client = await cls._get_client()
         if isinstance(client, FakeMatrixClient):
-            return RoomPutStateError("debug mode")
+            return None
 
         if room_id.startswith("#"):
             room_id = await cls.resolve_room_alias(room_id)
@@ -349,8 +343,7 @@ class Matrix:
 
     @classmethod
     @async_to_sync
-    async def set_room_avatar(cls, room_id: str, avatar_uri: str)\
-            -> Union[RoomPutStateResponse, RoomPutStateError]:
+    async def set_room_avatar(cls, room_id: str, avatar_uri: str):
         """
         Define the avatar of a room.
 
@@ -370,6 +363,22 @@ class Matrix:
         }, state_key="")
 
 
+if os.getenv("SYNAPSE_PASSWORD"):  # pragma: no cover
+    from nio import RoomVisibility, RoomPreset
+    RoomVisibility = RoomVisibility
+    RoomPreset = RoomPreset
+else:
+    # When running tests, faking matrix-nio classes to don't include the module
+    class RoomVisibility(Enum):
+        private = 'private'
+        public = 'public'
+
+    class RoomPreset(Enum):
+        private_chat = "private_chat"
+        trusted_private_chat = "trusted_private_chat"
+        public_chat = "public_chat"
+
+
 class FakeMatrixClient:
     """
     Simulate a Matrix client to run tests, if no Matrix homeserver is connected.

corres2math/middlewares.py

@@ -2,7 +2,6 @@ from threading import local
 
 from django.conf import settings
 from django.contrib.auth.models import AnonymousUser, User
-from django.contrib.sessions.backends.db import SessionStore
 
 USER_ATTR_NAME = getattr(settings, 'LOCAL_USER_ATTR_NAME', '_current_user')
 SESSION_ATTR_NAME = getattr(settings, 'LOCAL_SESSION_ATTR_NAME', '_current_session')

corres2math/settings.py

@@ -51,16 +51,14 @@ INSTALLED_APPS = [
     'django.forms',
 
     'bootstrap_datepicker_plus',
+    'cas_server',
     'crispy_forms',
-    'django_extensions',
     'django_tables2',
     'haystack',
     'logs',
-    'mailer',
     'polymorphic',
     'rest_framework',
     'rest_framework.authtoken',
-    'cas_server',
 
     'api',
     'eastereggs',
@@ -68,6 +66,12 @@ INSTALLED_APPS = [
     'participation',
 ]
 
+if "test" not in sys.argv:  # pragma: no cover
+    INSTALLED_APPS += [
+        'django_extensions',
+        'mailer',
+    ]
+
 MIDDLEWARE = [
     'django.middleware.security.SecurityMiddleware',
     'django.contrib.sessions.middleware.SessionMiddleware',