Skip to content

Commit

Permalink
Refactor logging for more granularity
Browse files Browse the repository at this point in the history 
This changes the use of the logger used for logging by the bots from the
root logger to a module specific logger, which provides more flexibility
in terms of configuration.

It also changes the command line options of the bots to configure
the verbosity of logging. This allows introducing an additional
verbosity level which uses debug logging for the bots themselves, but
doesn't do the same for third-party libraries used by them. This helps
reducing often undesired high-volume debug logs by libraries like
Slixmpp, while still generating debug logs for our custom code.
  • Loading branch information
@Dunedan
Dunedan committed Apr 18, 2024
1 parent 334d235 commit f4035ac
Show file tree
Hide file tree
Showing 5 changed files with 166 additions and 131 deletions.
45 changes: 23 additions & 22 deletions tests/test_echelon.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -123,41 +123,45 @@ class TestArgumentParsing(TestCase):

@parameterized.expand([
([],
Namespace(domain='lobby.wildfiregames.com', login='EcheLOn', log_level=30, xserver=None,
Namespace(domain='lobby.wildfiregames.com', login='EcheLOn', xserver=None,
no_verify=False, nickname='RatingsBot', password='XXXXXX', room='arena',
database_url='sqlite:///lobby_rankings.sqlite3')),
(['--debug'],
Namespace(domain='lobby.wildfiregames.com', login='EcheLOn', log_level=10, xserver=None,
verbosity=0, database_url='sqlite:///lobby_rankings.sqlite3')),
(['-v'],
Namespace(domain='lobby.wildfiregames.com', login='EcheLOn', xserver=None,
no_verify=False, nickname='RatingsBot', password='XXXXXX', room='arena',
database_url='sqlite:///lobby_rankings.sqlite3')),
(['--quiet'],
Namespace(domain='lobby.wildfiregames.com', login='EcheLOn', log_level=40, xserver=None,
verbosity=1, database_url='sqlite:///lobby_rankings.sqlite3')),
(['-vv'],
Namespace(domain='lobby.wildfiregames.com', login='EcheLOn', xserver=None,
no_verify=False, nickname='RatingsBot', password='XXXXXX', room='arena',
database_url='sqlite:///lobby_rankings.sqlite3')),
(['--verbose'],
Namespace(domain='lobby.wildfiregames.com', login='EcheLOn', log_level=20, xserver=None,
verbosity=2, database_url='sqlite:///lobby_rankings.sqlite3')),
(['-vvv'],
Namespace(domain='lobby.wildfiregames.com', login='EcheLOn', xserver=None,
no_verify=False, nickname='RatingsBot', password='XXXXXX', room='arena',
database_url='sqlite:///lobby_rankings.sqlite3')),
verbosity=3, database_url='sqlite:///lobby_rankings.sqlite3')),
(['--verbosity', '3'],
Namespace(domain='lobby.wildfiregames.com', login='EcheLOn', xserver=None,
no_verify=False, nickname='RatingsBot', password='XXXXXX', room='arena',
verbosity=3, database_url='sqlite:///lobby_rankings.sqlite3')),
(['-m', 'lobby.domain.tld'],
Namespace(domain='lobby.domain.tld', login='EcheLOn', log_level=30, nickname='RatingsBot',
Namespace(domain='lobby.domain.tld', login='EcheLOn', verbosity=0, nickname='RatingsBot',
xserver=None, no_verify=False, password='XXXXXX', room='arena',
database_url='sqlite:///lobby_rankings.sqlite3')),
(['--domain=lobby.domain.tld'],
Namespace(domain='lobby.domain.tld', login='EcheLOn', log_level=30, nickname='RatingsBot',
Namespace(domain='lobby.domain.tld', login='EcheLOn', verbosity=0, nickname='RatingsBot',
xserver=None, no_verify=False, password='XXXXXX', room='arena',
database_url='sqlite:///lobby_rankings.sqlite3')),
(['-m', 'lobby.domain.tld', '-l', 'bot', '-p', '123456', '-n', 'Bot', '-r', 'arena123',
'-v'],
Namespace(domain='lobby.domain.tld', login='bot', log_level=20, nickname='Bot',
Namespace(domain='lobby.domain.tld', login='bot', verbosity=1, nickname='Bot',
xserver=None, no_verify=False, password='123456', room='arena123',
database_url='sqlite:///lobby_rankings.sqlite3')),
(['--domain=lobby.domain.tld', '--login=bot', '--password=123456', '--nickname=Bot',
'--room=arena123', '--database-url=sqlite:////tmp/db.sqlite3', '--verbose'],
Namespace(domain='lobby.domain.tld', login='bot', log_level=20, nickname='Bot',
'--room=arena123', '--database-url=sqlite:////tmp/db.sqlite3'],
Namespace(domain='lobby.domain.tld', login='bot', verbosity=0, nickname='Bot',
xserver=None, no_verify=False, password='123456', room='arena123',
database_url='sqlite:////tmp/db.sqlite3')),
(['--no-verify'],
Namespace(domain='lobby.wildfiregames.com', login='EcheLOn', log_level=30, xserver=None,
Namespace(domain='lobby.wildfiregames.com', login='EcheLOn', verbosity=0, xserver=None,
no_verify=True, nickname='RatingsBot', password='XXXXXX', room='arena',
database_url='sqlite:///lobby_rankings.sqlite3')),
])
Expand All @@ -169,10 +173,7 @@ def test_valid(self, cmd_args, expected_args):
@parameterized.expand([
(['-f'],),
(['--foo'],),
(['--debug', '--quiet'],),
(['--quiet', '--verbose'],),
(['--debug', '--verbose'],),
(['--debug', '--quiet', '--verbose'],),
(['-v', '--verbosity', '1'],)
])
def test_invalid(self, cmd_args):
"""Test invalid parameter combinations."""
Expand All @@ -193,7 +194,7 @@ def test_success(self):
domain='lobby.wildfiregames.com', password='XXXXXX',
room='arena', nickname='RatingsBot',
database_url='sqlite:///lobby_rankings.sqlite3',
xserver=None, no_verify=False)
xserver=None, no_verify=False, verbosity=0)
main()
args_mock.assert_called_once_with()
leaderboard_mock.assert_called_once_with('sqlite:///lobby_rankings.sqlite3')
Expand Down
37 changes: 19 additions & 18 deletions tests/test_xpartamupp.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -92,37 +92,41 @@ class TestArgumentParsing(TestCase):
"""Test handling of parsing command line parameters."""

@parameterized.expand([
([], Namespace(domain='lobby.wildfiregames.com', login='xpartamupp', log_level=30,
([], Namespace(domain='lobby.wildfiregames.com', login='xpartamupp', verbosity=0,
xserver=None, no_verify=False,
nickname='WFGBot', password='XXXXXX', room='arena')),
(['--debug'],
Namespace(domain='lobby.wildfiregames.com', login='xpartamupp', log_level=10,
(['-v'],
Namespace(domain='lobby.wildfiregames.com', login='xpartamupp', verbosity=1,
xserver=None, no_verify=False,
nickname='WFGBot', password='XXXXXX', room='arena')),
(['--quiet'],
Namespace(domain='lobby.wildfiregames.com', login='xpartamupp', log_level=40,
(['-vv'],
Namespace(domain='lobby.wildfiregames.com', login='xpartamupp', verbosity=2,
xserver=None, no_verify=False,
nickname='WFGBot', password='XXXXXX', room='arena')),
(['--verbose'],
Namespace(domain='lobby.wildfiregames.com', login='xpartamupp', log_level=20,
(['-vvv'],
Namespace(domain='lobby.wildfiregames.com', login='xpartamupp', verbosity=3,
xserver=None, no_verify=False,
nickname='WFGBot', password='XXXXXX', room='arena')),
(['--verbosity', '3'],
Namespace(domain='lobby.wildfiregames.com', login='xpartamupp', verbosity=3,
xserver=None, no_verify=False,
nickname='WFGBot', password='XXXXXX', room='arena')),
(['-m', 'lobby.domain.tld'],
Namespace(domain='lobby.domain.tld', login='xpartamupp', log_level=30, nickname='WFGBot',
Namespace(domain='lobby.domain.tld', login='xpartamupp', verbosity=0, nickname='WFGBot',
xserver=None, no_verify=False, password='XXXXXX', room='arena')),
(['--domain=lobby.domain.tld'],
Namespace(domain='lobby.domain.tld', login='xpartamupp', log_level=30, nickname='WFGBot',
Namespace(domain='lobby.domain.tld', login='xpartamupp', verbosity=0, nickname='WFGBot',
xserver=None, no_verify=False, password='XXXXXX', room='arena')),
(['-m', 'lobby.domain.tld', '-l', 'bot', '-p', '123456', '-n', 'Bot', '-r', 'arena123',
'-v'],
Namespace(domain='lobby.domain.tld', login='bot', log_level=20, xserver=None,
Namespace(domain='lobby.domain.tld', login='bot', verbosity=1, xserver=None,
no_verify=False, nickname='Bot', password='123456', room='arena123')),
(['--domain=lobby.domain.tld', '--login=bot', '--password=123456', '--nickname=Bot',
'--room=arena123', '--verbose'],
Namespace(domain='lobby.domain.tld', login='bot', log_level=20, xserver=None,
'--room=arena123'],
Namespace(domain='lobby.domain.tld', login='bot', verbosity=0, xserver=None,
no_verify=False, nickname='Bot', password='123456', room='arena123')),
(['--no-verify'],
Namespace(domain='lobby.wildfiregames.com', login='xpartamupp', log_level=30,
Namespace(domain='lobby.wildfiregames.com', login='xpartamupp', verbosity=0,
xserver=None, no_verify=True,
nickname='WFGBot', password='XXXXXX', room='arena')),
])
Expand All @@ -134,10 +138,7 @@ def test_valid(self, cmd_args, expected_args):
@parameterized.expand([
(['-f'],),
(['--foo'],),
(['--debug', '--quiet'],),
(['--quiet', '--verbose'],),
(['--debug', '--verbose'],),
(['--debug', '--quiet', '--verbose'],),
(['-v', '--verbosity', '1'],)
])
def test_invalid(self, cmd_args):
"""Test invalid parameter combinations."""
Expand All @@ -156,7 +157,7 @@ def test_success(self):
args_mock.return_value = Mock(log_level=30, login='xpartamupp',
domain='lobby.wildfiregames.com', password='XXXXXX',
room='arena', nickname='WFGBot',
xserver=None, no_verify=False)
xserver=None, no_verify=False, verbosity=0)
main()
args_mock.assert_called_once_with()
xmpp_mock().register_plugin.assert_has_calls([call('xep_0004'), call('xep_0030'),
Expand Down
Loading

0 comments on commit f4035ac

Please sign in to comment.