input-remapper/tests/testcases/test_logger.py

#!/usr/bin/python3
# -*- coding: utf-8 -*-
# key-mapper - GUI for device specific keyboard mappings
# Copyright (C) 2021 sezanzeb <proxima@hip70890b.de>
#
# This file is part of key-mapper.
#
# key-mapper is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# key-mapper is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with key-mapper.  If not, see <https://www.gnu.org/licenses/>.


import os
import shutil
import unittest
import logging

from keymapper.logger import logger, add_filehandler, update_verbosity, \
    log_info

from tests.test import tmp


class TestLogger(unittest.TestCase):
    def tearDown(self):
        # remove the file handler
        logger.handlers = [
            handler for handler in logger.handlers
            if not isinstance(logger.handlers, logging.FileHandler)
        ]
        path = os.path.join(tmp, 'logger-test')
        if os.path.exists(path):
            shutil.rmtree(path)

        update_verbosity(debug=True)

    def test_key_spam(self):
        path = add_filehandler(os.path.join(tmp, 'logger-test'))
        logger.key_spam(((1, 2, 1),), 'foo %s bar', 1234)
        logger.key_spam(((1, 200, -1), (1, 5, 1)), 'foo %s', (1, 2))
        with open(path, 'r') as f:
            content = f.read().lower()
            self.assertIn('((1, 2, 1)) ------------------- foo 1234 bar', content)
            self.assertIn('((1, 200, -1), (1, 5, 1)) ----- foo (1, 2)', content)

    def test_log_info(self):
        update_verbosity(debug=False)
        path = add_filehandler(os.path.join(tmp, 'logger-test'))
        log_info()
        with open(path, 'r') as f:
            content = f.read().lower()
            self.assertIn('key-mapper', content)

    def test_makes_path(self):
        path = os.path.join(tmp, 'logger-test')
        if os.path.exists(path):
            shutil.rmtree(path)

        new_path = os.path.join(tmp, 'logger-test', 'a', 'b', 'c')
        add_filehandler(new_path)
        self.assertTrue(os.path.exists(new_path))

    def test_clears_log(self):
        path = os.path.join(tmp, 'logger-test', 'log')
        os.makedirs(os.path.dirname(path), exist_ok=True)
        os.mknod(path)
        with open(path, 'w') as f:
            f.write('foo')
        add_filehandler(os.path.join(tmp, 'logger-test'))
        with open(path, 'r') as f:
            self.assertEqual(f.read(), '')

    def test_debug(self):
        path = add_filehandler(os.path.join(tmp, 'logger-test'))
        logger.error('abc')
        logger.warning('foo')
        logger.info('123')
        logger.debug('456')
        logger.spam('789')
        with open(path, 'r') as f:
            content = f.read().lower()
            self.assertIn('logger.py', content)
            self.assertIn('line', content)

            self.assertIn('error', content)
            self.assertIn('abc', content)

            self.assertIn('warn', content)
            self.assertIn('foo', content)

            self.assertIn('info', content)
            self.assertIn('123', content)

            self.assertIn('debug', content)
            self.assertIn('456', content)

            self.assertIn('spam', content)
            self.assertIn('789', content)

    def test_default(self):
        path = add_filehandler(os.path.join(tmp, 'logger-test'))
        update_verbosity(debug=False)
        logger.error('abc')
        logger.warning('foo')
        logger.info('123')
        logger.debug('456')
        logger.spam('789')
        with open(path, 'r') as f:
            content = f.read().lower()
            self.assertNotIn('logger.py', content)
            self.assertNotIn('line', content)

            self.assertIn('error', content)
            self.assertIn('abc', content)

            self.assertIn('warn', content)
            self.assertIn('foo', content)

            self.assertNotIn('info', content)
            self.assertIn('123', content)

            self.assertNotIn('debug', content)
            self.assertNotIn('456', content)

            self.assertNotIn('spam', content)
            self.assertNotIn('789', content)


if __name__ == "__main__":
    unittest.main()