summaryrefslogtreecommitdiff
path: root/slog/slog_tests.py
diff options
context:
space:
mode:
Diffstat (limited to 'slog/slog_tests.py')
-rw-r--r--slog/slog_tests.py258
1 files changed, 258 insertions, 0 deletions
diff --git a/slog/slog_tests.py b/slog/slog_tests.py
new file mode 100644
index 0000000..cc18f15
--- /dev/null
+++ b/slog/slog_tests.py
@@ -0,0 +1,258 @@
+# slog_tests.py - unit tests for structured logging
+#
+# Copyright 2016 QvarnLabs Ab
+#
+# 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.
+#
+# This program 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 Affero General Public License for more details.
+#
+# You should have received a copy of the GNU Affero General Public License
+# along with this program. If not, see <http://www.gnu.org/licenses/>.
+
+
+import glob
+import json
+import os
+import shutil
+import tempfile
+import time
+import unittest
+
+import slog
+
+
+class StructuredLogTests(unittest.TestCase):
+
+ def setUp(self):
+ self.tempdir = tempfile.mkdtemp()
+
+ def tearDown(self):
+ shutil.rmtree(self.tempdir)
+
+ def create_structured_log(self):
+ filename = os.path.join(self.tempdir, 'slog.log')
+ writer = slog.FileSlogWriter()
+ writer.set_filename(filename)
+
+ log = slog.StructuredLog()
+ log.add_log_writer(writer, slog.FilterAllow())
+ return log, writer, filename
+
+ def read_log_entries(self, writer):
+ filename = writer.get_filename()
+ with open(filename) as f:
+ return [json.loads(line) for line in f]
+
+ def test_logs_in_json(self):
+ log, writer, _ = self.create_structured_log()
+ log.log('testmsg', foo='foo', bar='bar', number=12765)
+ log.close()
+
+ objs = self.read_log_entries(writer)
+ self.assertEqual(len(objs), 1)
+ obj = objs[0]
+ self.assertEqual(obj['msg_type'], 'testmsg')
+ self.assertEqual(obj['foo'], 'foo')
+ self.assertEqual(obj['bar'], 'bar')
+ self.assertEqual(obj['number'], 12765)
+
+ def test_logs_two_lines_in_json(self):
+ log, writer, _ = self.create_structured_log()
+ log.log('testmsg1', foo='foo')
+ log.log('testmsg2', bar='bar')
+ log.close()
+
+ objs = self.read_log_entries(writer)
+ self.assertEqual(len(objs), 2)
+ obj1, obj2 = objs
+
+ self.assertEqual(obj1['msg_type'], 'testmsg1')
+ self.assertEqual(obj1['foo'], 'foo')
+
+ self.assertEqual(obj2['msg_type'], 'testmsg2')
+ self.assertEqual(obj2['bar'], 'bar')
+
+ def test_adds_some_extra_fields(self):
+ log, writer, _ = self.create_structured_log()
+ log.log('testmsg')
+ log.close()
+
+ objs = self.read_log_entries(writer)
+ self.assertEqual(len(objs), 1)
+ obj = objs[0]
+ self.assertEqual(obj['msg_type'], 'testmsg')
+ self.assertIn('_timestamp', obj)
+ self.assertIn('_process_id', obj)
+ self.assertIn('_thread_id', obj)
+ self.assertEqual(obj['_context'], None)
+
+ def test_adds_context_when_given(self):
+ log, writer, _ = self.create_structured_log()
+ log.set_context('request 123')
+ log.log('testmsg')
+ log.close()
+
+ objs = self.read_log_entries(writer)
+ self.assertEqual(len(objs), 1)
+ obj = objs[0]
+ self.assertEqual(obj['_context'], 'request 123')
+
+ def test_resets_context_when_requested(self):
+ log, writer, _ = self.create_structured_log()
+ log.set_context('request 123')
+ log.reset_context()
+ log.log('testmsg')
+ log.close()
+
+ objs = self.read_log_entries(writer)
+ self.assertEqual(len(objs), 1)
+ obj = objs[0]
+ self.assertEqual(obj['_context'], None)
+
+ def test_counts_messages(self):
+ log, writer, _ = self.create_structured_log()
+ log.log('testmsg')
+ log.log('testmsg')
+ log.close()
+
+ objs = self.read_log_entries(writer)
+ self.assertEqual(len(objs), 2)
+ self.assertEqual(objs[0]['_msg_number'], 1)
+ self.assertEqual(objs[1]['_msg_number'], 2)
+
+ def test_logs_traceback(self):
+ log, writer, _ = self.create_structured_log()
+ log.log('testmsg', exc_info=True)
+ log.close()
+
+ objs = self.read_log_entries(writer)
+ self.assertEqual(len(objs), 1)
+ self.assertIn('_traceback', objs[0])
+
+ def test_logs_unicode(self):
+ log, writer, _ = self.create_structured_log()
+ log.log('testmsg', text='foo')
+ log.close()
+
+ objs = self.read_log_entries(writer)
+ self.assertEqual(len(objs), 1)
+ self.assertEqual(objs[0]['text'], 'foo')
+
+ def test_logs_nonutf8(self):
+ log, writer, _ = self.create_structured_log()
+ notutf8 = '\x86'
+ log.log('blobmsg', notutf8=notutf8)
+ log.close()
+
+ objs = self.read_log_entries(writer)
+ self.assertEqual(len(objs), 1)
+ self.assertEqual(objs[0]['notutf8'], notutf8)
+
+ def test_logs_list(self):
+ log, writer, _ = self.create_structured_log()
+ log.log('testmsg', items=[1, 2, 3])
+ log.close()
+
+ objs = self.read_log_entries(writer)
+ self.assertEqual(len(objs), 1)
+ self.assertEqual(objs[0]['items'], [1, 2, 3])
+
+ def test_logs_tuple(self):
+ log, writer, _ = self.create_structured_log()
+ log.log('testmsg', t=(1, 2, 3))
+ log.close()
+
+ objs = self.read_log_entries(writer)
+ self.assertEqual(len(objs), 1)
+ # Tuples get returned as s list.
+ self.assertEqual(objs[0]['t'], [1, 2, 3])
+
+ def test_logs_dict(self):
+ log, writer, _ = self.create_structured_log()
+ dikt = {
+ 'foo': 'bar',
+ 'yo': [1, 2, 3],
+ }
+ log.log('testmsg', dikt=dikt)
+ log.close()
+
+ objs = self.read_log_entries(writer)
+ self.assertEqual(len(objs), 1)
+ self.assertEqual(objs[0]['dikt'], dikt)
+
+ def test_logs_to_two_files(self):
+ filename1 = os.path.join(self.tempdir, 'slog1XS')
+ writer1 = slog.FileSlogWriter()
+ writer1.set_filename(filename1)
+
+ filename2 = os.path.join(self.tempdir, 'slog2')
+ writer2 = slog.FileSlogWriter()
+ writer2.set_filename(filename2)
+
+ log = slog.StructuredLog()
+ log.add_log_writer(writer1, slog.FilterAllow())
+ log.add_log_writer(writer2, slog.FilterAllow())
+
+ log.log('test', msg_text='hello')
+ objs1 = self.read_log_entries(writer1)
+ objs2 = self.read_log_entries(writer2)
+
+ self.assertEqual(objs1, objs2)
+
+
+class FileSlogWriterTests(unittest.TestCase):
+
+ def setUp(self):
+ self.tempdir = tempfile.mkdtemp()
+ self.filename = os.path.join(self.tempdir, 'foo.log')
+
+ def tearDown(self):
+ shutil.rmtree(self.tempdir)
+
+ def test_gets_initial_filename_right(self):
+ fw = slog.FileSlogWriter()
+ fw.set_filename(self.filename)
+ self.assertEqual(fw.get_filename(), self.filename)
+
+ def test_gets_rotated_filename_right(self):
+ fw = slog.FileSlogWriter()
+ fw.set_filename(self.filename)
+
+ now = time.struct_time((1969, 9, 1, 14, 30, 42, 0, 243, 0))
+ self.assertEqual(
+ fw.get_rotated_filename(now=now),
+ os.path.join(self.tempdir, 'foo-19690901T143042.log')
+ )
+
+ def test_creates_file(self):
+ fw = slog.FileSlogWriter()
+ filename = os.path.join(self.tempdir, 'slog.log')
+ fw.set_filename(filename)
+ self.assertTrue(os.path.exists(filename))
+
+ def test_rotates_after_size_limit(self):
+ fw = slog.FileSlogWriter()
+ filename = os.path.join(self.tempdir, 'slog.log')
+ fw.set_filename(filename)
+ fw.set_max_file_size(1)
+ fw.write({'foo': 'bar'})
+ filenames = glob.glob(self.tempdir + '/*.log')
+ self.assertEqual(len(filenames), 2)
+ self.assertTrue(filename in filenames)
+
+ rotated_filename = [x for x in filenames if x != filename][0]
+ objs1 = self.load_log_objs(filename)
+ objs2 = self.load_log_objs(rotated_filename)
+
+ self.assertEqual(len(objs1), 0)
+ self.assertEqual(len(objs2), 1)
+
+ def load_log_objs(self, filename):
+ with open(filename) as f:
+ return [json.loads(line) for line in f]
generated by cgit v1.2.1 (git 2.18.0) at 2024-04-29 06:02:48 +0000