mirror of
https://git.anonymousland.org/anonymousland/synapse.git
synced 2025-05-04 02:44:50 -04:00
Add missing type hints in tests (#14879)
* FIx-up type hints in tests.logging. * Add missing type hints to test_transactions.
This commit is contained in:
parent
345576bc34
commit
fc35e0673f
8 changed files with 75 additions and 42 deletions
|
@ -11,7 +11,10 @@
|
|||
# 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.
|
||||
from twisted.test.proto_helpers import AccumulatingProtocol
|
||||
from typing import Tuple
|
||||
|
||||
from twisted.internet.protocol import Protocol
|
||||
from twisted.test.proto_helpers import AccumulatingProtocol, MemoryReactorClock
|
||||
|
||||
from synapse.logging import RemoteHandler
|
||||
|
||||
|
@ -20,7 +23,9 @@ from tests.server import FakeTransport, get_clock
|
|||
from tests.unittest import TestCase
|
||||
|
||||
|
||||
def connect_logging_client(reactor, client_id):
|
||||
def connect_logging_client(
|
||||
reactor: MemoryReactorClock, client_id: int
|
||||
) -> Tuple[Protocol, AccumulatingProtocol]:
|
||||
# This is essentially tests.server.connect_client, but disabling autoflush on
|
||||
# the client transport. This is necessary to avoid an infinite loop due to
|
||||
# sending of data via the logging transport causing additional logs to be
|
||||
|
@ -35,10 +40,10 @@ def connect_logging_client(reactor, client_id):
|
|||
|
||||
|
||||
class RemoteHandlerTestCase(LoggerCleanupMixin, TestCase):
|
||||
def setUp(self):
|
||||
def setUp(self) -> None:
|
||||
self.reactor, _ = get_clock()
|
||||
|
||||
def test_log_output(self):
|
||||
def test_log_output(self) -> None:
|
||||
"""
|
||||
The remote handler delivers logs over TCP.
|
||||
"""
|
||||
|
@ -51,6 +56,7 @@ class RemoteHandlerTestCase(LoggerCleanupMixin, TestCase):
|
|||
client, server = connect_logging_client(self.reactor, 0)
|
||||
|
||||
# Trigger data being sent
|
||||
assert isinstance(client.transport, FakeTransport)
|
||||
client.transport.flush()
|
||||
|
||||
# One log message, with a single trailing newline
|
||||
|
@ -61,7 +67,7 @@ class RemoteHandlerTestCase(LoggerCleanupMixin, TestCase):
|
|||
# Ensure the data passed through properly.
|
||||
self.assertEqual(logs[0], "Hello there, wally!")
|
||||
|
||||
def test_log_backpressure_debug(self):
|
||||
def test_log_backpressure_debug(self) -> None:
|
||||
"""
|
||||
When backpressure is hit, DEBUG logs will be shed.
|
||||
"""
|
||||
|
@ -83,6 +89,7 @@ class RemoteHandlerTestCase(LoggerCleanupMixin, TestCase):
|
|||
|
||||
# Allow the reconnection
|
||||
client, server = connect_logging_client(self.reactor, 0)
|
||||
assert isinstance(client.transport, FakeTransport)
|
||||
client.transport.flush()
|
||||
|
||||
# Only the 7 infos made it through, the debugs were elided
|
||||
|
@ -90,7 +97,7 @@ class RemoteHandlerTestCase(LoggerCleanupMixin, TestCase):
|
|||
self.assertEqual(len(logs), 7)
|
||||
self.assertNotIn(b"debug", server.data)
|
||||
|
||||
def test_log_backpressure_info(self):
|
||||
def test_log_backpressure_info(self) -> None:
|
||||
"""
|
||||
When backpressure is hit, DEBUG and INFO logs will be shed.
|
||||
"""
|
||||
|
@ -116,6 +123,7 @@ class RemoteHandlerTestCase(LoggerCleanupMixin, TestCase):
|
|||
|
||||
# Allow the reconnection
|
||||
client, server = connect_logging_client(self.reactor, 0)
|
||||
assert isinstance(client.transport, FakeTransport)
|
||||
client.transport.flush()
|
||||
|
||||
# The 10 warnings made it through, the debugs and infos were elided
|
||||
|
@ -124,7 +132,7 @@ class RemoteHandlerTestCase(LoggerCleanupMixin, TestCase):
|
|||
self.assertNotIn(b"debug", server.data)
|
||||
self.assertNotIn(b"info", server.data)
|
||||
|
||||
def test_log_backpressure_cut_middle(self):
|
||||
def test_log_backpressure_cut_middle(self) -> None:
|
||||
"""
|
||||
When backpressure is hit, and no more DEBUG and INFOs cannot be culled,
|
||||
it will cut the middle messages out.
|
||||
|
@ -140,6 +148,7 @@ class RemoteHandlerTestCase(LoggerCleanupMixin, TestCase):
|
|||
|
||||
# Allow the reconnection
|
||||
client, server = connect_logging_client(self.reactor, 0)
|
||||
assert isinstance(client.transport, FakeTransport)
|
||||
client.transport.flush()
|
||||
|
||||
# The first five and last five warnings made it through, the debugs and
|
||||
|
@ -151,7 +160,7 @@ class RemoteHandlerTestCase(LoggerCleanupMixin, TestCase):
|
|||
logs,
|
||||
)
|
||||
|
||||
def test_cancel_connection(self):
|
||||
def test_cancel_connection(self) -> None:
|
||||
"""
|
||||
Gracefully handle the connection being cancelled.
|
||||
"""
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue