2020-10-29 14:27:37 +03:00
|
|
|
#
|
2023-11-21 23:29:58 +03:00
|
|
|
# This file is licensed under the Affero General Public License (AGPL) version 3.
|
|
|
|
#
|
2024-01-23 14:26:48 +03:00
|
|
|
# Copyright 2019 The Matrix.org Foundation C.I.C.
|
2023-11-21 23:29:58 +03:00
|
|
|
# Copyright (C) 2023 New Vector, Ltd
|
|
|
|
#
|
|
|
|
# This program is free software: you can redistribute it and/or modify
|
|
|
|
# it under the terms of the GNU Affero General Public License as
|
|
|
|
# published by the Free Software Foundation, either version 3 of the
|
|
|
|
# License, or (at your option) any later version.
|
|
|
|
#
|
|
|
|
# See the GNU Affero General Public License for more details:
|
|
|
|
# <https://www.gnu.org/licenses/agpl-3.0.html>.
|
|
|
|
#
|
|
|
|
# Originally licensed under the Apache License, Version 2.0:
|
|
|
|
# <http://www.apache.org/licenses/LICENSE-2.0>.
|
|
|
|
#
|
|
|
|
# [This file includes modifications made by New Vector Limited]
|
2020-10-29 14:27:37 +03:00
|
|
|
#
|
|
|
|
#
|
|
|
|
import logging
|
|
|
|
|
2023-01-26 22:45:24 +03:00
|
|
|
from tests.unittest import TestCase
|
2020-10-29 14:27:37 +03:00
|
|
|
|
2023-01-26 22:45:24 +03:00
|
|
|
|
|
|
|
class LoggerCleanupMixin(TestCase):
|
|
|
|
def get_logger(self, handler: logging.Handler) -> logging.Logger:
|
2020-10-29 14:27:37 +03:00
|
|
|
"""
|
|
|
|
Attach a handler to a logger and add clean-ups to remove revert this.
|
|
|
|
"""
|
|
|
|
# Create a logger and add the handler to it.
|
|
|
|
logger = logging.getLogger(__name__)
|
|
|
|
logger.addHandler(handler)
|
|
|
|
|
|
|
|
# Ensure the logger actually logs something.
|
|
|
|
logger.setLevel(logging.INFO)
|
|
|
|
|
|
|
|
# Ensure the logger gets cleaned-up appropriately.
|
|
|
|
self.addCleanup(logger.removeHandler, handler)
|
|
|
|
self.addCleanup(logger.setLevel, logging.NOTSET)
|
|
|
|
|
|
|
|
return logger
|