mirror of
https://mau.dev/maunium/synapse.git
synced 2024-12-15 11:03:51 +01:00
6463244375
Over time we've begun to use newer versions of mypy, typeshed, stub packages---and of course we've improved our own annotations. This makes some type ignore comments no longer necessary. I have removed them. There was one exception: a module that imports `select.epoll`. The ignore is redundant on Linux, but I've kept it ignored for those of us who work on the source tree using not-Linux. (#11771) I'm more interested in the config line which enforces this. I want unused ignores to be reported, because I think it's useful feedback when annotating to know when you've fixed a problem you had to previously ignore. * Installing extras before typechecking Lacking an easy way to install all extras generically, let's bite the bullet and make install the hand-maintained `all` extra before typechecking. Now that https://github.com/matrix-org/backend-meta/pull/6 is merged to the release/v1 branch.
129 lines
3.7 KiB
Python
129 lines
3.7 KiB
Python
# Copyright 2019-2021 The Matrix.org Foundation C.I.C.
|
||
#
|
||
# Licensed under the Apache License, Version 2.0 (the "License");
|
||
# you may not use this file except in compliance with the License.
|
||
# You may obtain a copy of the License at
|
||
#
|
||
# http://www.apache.org/licenses/LICENSE-2.0
|
||
#
|
||
# Unless required by applicable law or agreed to in writing, software
|
||
# distributed under the License is distributed on an "AS IS" BASIS,
|
||
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||
# See the License for the specific language governing permissions and
|
||
# limitations under the License.
|
||
|
||
"""
|
||
Utilities for running the unit tests
|
||
"""
|
||
import sys
|
||
import warnings
|
||
from asyncio import Future
|
||
from binascii import unhexlify
|
||
from typing import Awaitable, Callable, TypeVar
|
||
from unittest.mock import Mock
|
||
|
||
import attr
|
||
|
||
from twisted.python.failure import Failure
|
||
from twisted.web.client import ResponseDone
|
||
|
||
TV = TypeVar("TV")
|
||
|
||
|
||
def get_awaitable_result(awaitable: Awaitable[TV]) -> TV:
|
||
"""Get the result from an Awaitable which should have completed
|
||
|
||
Asserts that the given awaitable has a result ready, and returns its value
|
||
"""
|
||
i = awaitable.__await__()
|
||
try:
|
||
next(i)
|
||
except StopIteration as e:
|
||
# awaitable returned a result
|
||
return e.value
|
||
|
||
# if next didn't raise, the awaitable hasn't completed.
|
||
raise Exception("awaitable has not yet completed")
|
||
|
||
|
||
def make_awaitable(result: TV) -> Awaitable[TV]:
|
||
"""
|
||
Makes an awaitable, suitable for mocking an `async` function.
|
||
This uses Futures as they can be awaited multiple times so can be returned
|
||
to multiple callers.
|
||
"""
|
||
future: Future[TV] = Future()
|
||
future.set_result(result)
|
||
return future
|
||
|
||
|
||
def setup_awaitable_errors() -> Callable[[], None]:
|
||
"""
|
||
Convert warnings from a non-awaited coroutines into errors.
|
||
"""
|
||
warnings.simplefilter("error", RuntimeWarning)
|
||
|
||
# unraisablehook was added in Python 3.8.
|
||
if not hasattr(sys, "unraisablehook"):
|
||
return lambda: None
|
||
|
||
# State shared between unraisablehook and check_for_unraisable_exceptions.
|
||
unraisable_exceptions = []
|
||
orig_unraisablehook = sys.unraisablehook
|
||
|
||
def unraisablehook(unraisable):
|
||
unraisable_exceptions.append(unraisable.exc_value)
|
||
|
||
def cleanup():
|
||
"""
|
||
A method to be used as a clean-up that fails a test-case if there are any new unraisable exceptions.
|
||
"""
|
||
sys.unraisablehook = orig_unraisablehook
|
||
if unraisable_exceptions:
|
||
raise unraisable_exceptions.pop()
|
||
|
||
sys.unraisablehook = unraisablehook
|
||
|
||
return cleanup
|
||
|
||
|
||
def simple_async_mock(return_value=None, raises=None) -> Mock:
|
||
# AsyncMock is not available in python3.5, this mimics part of its behaviour
|
||
async def cb(*args, **kwargs):
|
||
if raises:
|
||
raise raises
|
||
return return_value
|
||
|
||
return Mock(side_effect=cb)
|
||
|
||
|
||
@attr.s
|
||
class FakeResponse:
|
||
"""A fake twisted.web.IResponse object
|
||
|
||
there is a similar class at treq.test.test_response, but it lacks a `phrase`
|
||
attribute, and didn't support deliverBody until recently.
|
||
"""
|
||
|
||
# HTTP response code
|
||
code = attr.ib(type=int)
|
||
|
||
# HTTP response phrase (eg b'OK' for a 200)
|
||
phrase = attr.ib(type=bytes)
|
||
|
||
# body of the response
|
||
body = attr.ib(type=bytes)
|
||
|
||
def deliverBody(self, protocol):
|
||
protocol.dataReceived(self.body)
|
||
protocol.connectionLost(Failure(ResponseDone()))
|
||
|
||
|
||
# A small image used in some tests.
|
||
#
|
||
# Resolution: 1×1, MIME type: image/png, Extension: png, Size: 67 B
|
||
SMALL_PNG = unhexlify(
|
||
b"89504e470d0a1a0a0000000d4948445200000001000000010806"
|
||
b"0000001f15c4890000000a49444154789c63000100000500010d"
|
||
b"0a2db40000000049454e44ae426082"
|
||
)
|