mdclogpy/tst/test_Logger.py

   1 # Copyright (c) 2019 AT&T Intellectual Property.
   2 # Copyright (c) 2018-2019 Nokia.
   3 #
   4 # Licensed under the Apache License, Version 2.0 (the "License");
   5 # you may not use this file except in compliance with the License.
   6 # You may obtain a copy of the License at
   7 #
   8 #     http://www.apache.org/licenses/LICENSE-2.0
   9 #
  10 # Unless required by applicable law or agreed to in writing, software
  11 # distributed under the License is distributed on an "AS IS" BASIS,
  12 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13 # See the License for the specific language governing permissions and
  14 # limitations under the License.
  15 #
  16 # This source code is part of the near-RT RIC (RAN Intelligent Controller)
  17 # platform project (RICP).
  18 #
  19 """Unit tests for Logger.py"""
  20 import unittest
  21 from unittest.mock import patch
  22 import sys
  23 import os
  24 import time
  25
  26 from mdclogpy import Logger
  27 from mdclogpy import Level
  28 import mdclogpy
  29 from .mdclogtestutils import TestMdcLogUtils
  30
  31
  32 class TestMdcLog(unittest.TestCase):
  33     """Unit tests for mdclog.py"""
  34
  35     def setUp(self):
  36         self.logger = Logger()
  37
  38     def tearDown(self):
  39         pass
  40
  41
  42     def test_that_get_level_returns_the_current_log_level(self):
  43
  44         # default level is ERROR
  45         self.assertEqual(self.logger.get_level(), Level.ERROR)
  46         self.logger.set_level(Level.INFO)
  47         self.assertEqual(self.logger.get_level(), Level.INFO)
  48         self.logger.set_level(Level.WARNING)
  49         self.assertEqual(self.logger.get_level(), Level.WARNING)
  50         self.logger.set_level(Level.ERROR)
  51         self.assertEqual(self.logger.get_level(), Level.ERROR)
  52         self.logger.set_level(Level.DEBUG)
  53         self.assertEqual(self.logger.get_level(), Level.DEBUG)
  54
  55     def test_that_set_level_does_not_accept_incorrect_level(self):
  56
  57         self.logger.set_level(Level.INFO)
  58         self.logger.set_level(55)
  59         self.assertEqual(self.logger.get_level(), Level.INFO)
  60
  61     @patch('mdclogpy.Logger._output_log')
  62     def test_that_logs_with_lower_than_current_level_(self, output_mock):
  63
  64         self.logger.set_level(Level.WARNING)
  65         self.logger.log(Level.DEBUG, "DEBUG")
  66         self.logger.log(Level.INFO, "INFO")
  67         self.logger.log(Level.WARNING, "WARNING")
  68         self.logger.log(Level.ERROR, "ERROR")
  69
  70         self.assertEqual(2, output_mock.call_count)
  71         logs = TestMdcLogUtils.get_logs_as_json(output_mock.call_args_list)
  72         self.assertEqual(logs[0]["msg"], "WARNING")
  73         self.assertEqual(logs[1]["msg"], "ERROR")
  74
  75     @patch('mdclogpy.Logger._output_log')
  76     def test_that_logs_with_lower_than_current_level_are_not_logged(self, output_mock):
  77
  78         self.logger.set_level(Level.WARNING)
  79         self.logger.log(Level.DEBUG, "DEBUG")
  80         self.logger.log(Level.INFO, "INFO")
  81         self.logger.log(Level.WARNING, "WARNING")
  82         self.logger.log(Level.ERROR, "ERROR")
  83
  84         self.assertEqual(2, output_mock.call_count)
  85         logs = TestMdcLogUtils.get_logs_as_json(output_mock.call_args_list)
  86         self.assertEqual(logs[0]["msg"], "WARNING")
  87         self.assertEqual(logs[1]["msg"], "ERROR")
  88
  89     @patch('mdclogpy.Logger._output_log')
  90     def test_that_log_contains_correct_criticality(self, output_mock):
  91
  92         self.logger.set_level(Level.DEBUG)
  93
  94         self.logger.log(Level.DEBUG, "debug test log")
  95         self.logger.log(Level.INFO, "info test log")
  96         self.logger.log(Level.WARNING, "warning test log")
  97         self.logger.log(Level.ERROR, "error test log")
  98
  99         self.logger.debug("another debug test log")
 100         self.logger.info("another info test log")
 101         self.logger.warning("another warning test log")
 102         self.logger.error("another error test log")
 103
 104         self.assertEqual(8, output_mock.call_count)
 105         logs = TestMdcLogUtils.get_logs_as_json(output_mock.call_args_list)
 106         self.assertEqual(logs[0]["crit"], "DEBUG")
 107         self.assertEqual(logs[1]["crit"], "INFO")
 108         self.assertEqual(logs[2]["crit"], "WARNING")
 109         self.assertEqual(logs[3]["crit"], "ERROR")
 110         self.assertEqual(logs[4]["crit"], "DEBUG")
 111         self.assertEqual(logs[5]["crit"], "INFO")
 112         self.assertEqual(logs[6]["crit"], "WARNING")
 113         self.assertEqual(logs[7]["crit"], "ERROR")
 114
 115     @patch('time.time')
 116     @patch('mdclogpy.Logger._output_log')
 117     def test_that_log_contains_correct_timestamp(self, output_mock, mock_time):
 118
 119         mock_time.return_value = 1554806251.4388545
 120         self.logger.error("timestamp test")
 121
 122         logs = TestMdcLogUtils.get_logs_as_json(output_mock.call_args_list)
 123         self.assertEqual(logs[0]["ts"], 1554806251439)
 124
 125     @patch('mdclogpy.Logger._output_log')
 126     def test_that_log_contains_correct_message(self, output_mock):
 127
 128         self.logger.error("message test")
 129         logs = TestMdcLogUtils.get_logs_as_json(output_mock.call_args_list)
 130         print(logs)
 131         self.assertEqual(logs[0]["msg"], "message test")
 132
 133     @patch('mdclogpy.Logger._output_log')
 134     def test_that_log_message_is_escaped_to_valid_json_string(self, output_mock):
 135
 136         self.logger.set_level(Level.DEBUG)
 137
 138         self.logger.info('\ and "')
 139
 140         logs = TestMdcLogUtils.get_logs(output_mock.call_args_list)
 141         self.assertTrue(r'\\ and \"' in logs[0])
 142         logs = TestMdcLogUtils.get_logs_as_json(output_mock.call_args_list)
 143         self.assertEqual(logs[0]["msg"], '\ and "')
 144
 145
 146     @patch('mdclogpy.Logger._output_log')
 147     def test_that_empty_mdc_is_logged_correctly(self, output_mock):
 148         self.logger.mdclog_format_init(configmap_monitor=True)
 149         self.logger.error("empty mdc test")
 150         logs = TestMdcLogUtils.get_logs_as_json(output_mock.call_args_list)
 151         self.assertEqual(logs[0]["msg"],'empty mdc test')
 152
 153
 154
 155     @patch('mdclogpy.Logger._output_log')
 156     def test_that_mdc_values_are_logged_correctly(self, output_mock):
 157
 158         self.logger.add_mdc("key1", "value1")
 159         self.logger.add_mdc("key2", "value2")
 160         self.logger.error("mdc test")
 161
 162         logs = TestMdcLogUtils.get_logs_as_json(output_mock.call_args_list)
 163         self.assertEqual(logs[0]["mdc"]["key1"], "value1")
 164         self.assertEqual(logs[0]["mdc"]["key2"], "value2")
 165
 166     @patch('mdclogpy.Logger._output_log')
 167     def test_that_mdc_pid_logged_correctly(self, output_mock):
 168         self.logger.mdclog_format_init(configmap_monitor=True)
 169         self.logger.error("mdc test")
 170         logs = TestMdcLogUtils.get_logs_as_json(output_mock.call_args_list)
 171         self.assertTrue(logs[0]["mdc"]["PID"])
 172
 173
 174     def test_that_mdc_values_can_be_added_and_removed(self):
 175
 176         self.logger.add_mdc("key1", "value1")
 177         self.logger.add_mdc("key2", "value2")
 178         self.assertEqual(self.logger.get_mdc("key2"), "value2")
 179         self.assertEqual(self.logger.get_mdc("key1"), "value1")
 180         self.assertEqual(self.logger.get_mdc("non_existent"), None)
 181         self.logger.remove_mdc("key1")
 182         self.assertEqual(self.logger.get_mdc("key1"), None)
 183         self.logger.remove_mdc("non_existent")
 184         self.logger.clean_mdc()
 185         self.assertEqual(self.logger.get_mdc("key2"), None)
 186
 187     @patch('mdclogpy.Logger._output_log')
 188     def test_multiple_logger_instances(self, output_mock):
 189
 190         logger1 = Logger("logger1")
 191         logger2 = Logger("logger2")
 192         logger1.add_mdc("logger1_key1", "logger1_value1")
 193         logger1.add_mdc("logger1_key2", "logger1_value2")
 194         logger2.add_mdc("logger2_key1", "logger2_value1")
 195         logger2.add_mdc("logger2_key2", "logger2_value2")
 196         mdclogpy.add_mdc("key", "value")
 197
 198         logger1.error("error msg")
 199         logger2.error("warning msg")
 200         mdclogpy.error("info msg")
 201
 202         logs = TestMdcLogUtils.get_logs_as_json(output_mock.call_args_list)
 203         self.assertEqual(3, output_mock.call_count)
 204
 205         self.assertEqual(logs[0]["id"], "logger1")
 206         self.assertEqual(logs[0]["crit"], "ERROR")
 207         self.assertEqual(logs[0]["msg"], "error msg")
 208         self.assertEqual(logs[0]["mdc"]["logger1_key1"], "logger1_value1")
 209         self.assertEqual(logs[0]["mdc"]["logger1_key2"], "logger1_value2")
 210         self.assertEqual(len(logs[0]["mdc"]), 2)
 211
 212         self.assertEqual(logs[1]["id"], "logger2")
 213         self.assertEqual(logs[1]["crit"], "ERROR")
 214         self.assertEqual(logs[1]["msg"], "warning msg")
 215         self.assertEqual(logs[1]["mdc"]["logger2_key1"], "logger2_value1")
 216         self.assertEqual(logs[1]["mdc"]["logger2_key2"], "logger2_value2")
 217         self.assertEqual(len(logs[1]["mdc"]), 2)
 218
 219         self.assertEqual(logs[2]["id"], sys.argv[0])
 220         self.assertEqual(logs[2]["crit"], "ERROR")
 221         self.assertEqual(logs[2]["msg"], "info msg")
 222         self.assertEqual(logs[2]["mdc"]["key"], "value")
 223         self.assertEqual(len(logs[2]["mdc"]), 1)
 224
 225 if __name__ == '__main__':
 226     unittest.main()