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     @patch('mdclogpy.Logger._output_log')
 155     def test_that_config_map_is_monitored_correctly(self, output_mock):
 156         src = open("//tmp//log","w")
 157         src.write("log-level: debug\n")
 158         src.close()
 159         self.logger.filename = "/tmp/log"
 160         self.logger.dirname = "/tmp/"
 161         self.logger.mdc = {"PID":"","SYSTEM_NAME":"","HOST_NAME":"","SERVICE_NAME":"","CONTAINER_NAME":"","POD_NAME":""}
 162         self.logger.get_env_params_values()
 163         self.logger.parse_file()
 164         self.logger.error("Hello")
 165         self.assertEqual(self.logger.get_level(),Level.DEBUG)
 166
 167     @patch('mdclogpy.Logger._output_log')
 168     def test_that_mdc_values_are_logged_correctly(self, output_mock):
 169
 170         self.logger.add_mdc("key1", "value1")
 171         self.logger.add_mdc("key2", "value2")
 172         self.logger.error("mdc test")
 173
 174         logs = TestMdcLogUtils.get_logs_as_json(output_mock.call_args_list)
 175         self.assertEqual(logs[0]["mdc"]["key1"], "value1")
 176         self.assertEqual(logs[0]["mdc"]["key2"], "value2")
 177
 178     @patch('mdclogpy.Logger._output_log')
 179     def test_that_mdc_pid_logged_correctly(self, output_mock):
 180         self.logger.mdclog_format_init(configmap_monitor=True)
 181         self.logger.error("mdc test")
 182         logs = TestMdcLogUtils.get_logs_as_json(output_mock.call_args_list)
 183         self.assertTrue(logs[0]["mdc"]["PID"])
 184
 185
 186     def test_that_mdc_values_can_be_added_and_removed(self):
 187
 188         self.logger.add_mdc("key1", "value1")
 189         self.logger.add_mdc("key2", "value2")
 190         self.assertEqual(self.logger.get_mdc("key2"), "value2")
 191         self.assertEqual(self.logger.get_mdc("key1"), "value1")
 192         self.assertEqual(self.logger.get_mdc("non_existent"), None)
 193         self.logger.remove_mdc("key1")
 194         self.assertEqual(self.logger.get_mdc("key1"), None)
 195         self.logger.remove_mdc("non_existent")
 196         self.logger.clean_mdc()
 197         self.assertEqual(self.logger.get_mdc("key2"), None)
 198
 199     @patch('mdclogpy.Logger._output_log')
 200     def test_multiple_logger_instances(self, output_mock):
 201
 202         logger1 = Logger("logger1")
 203         logger2 = Logger("logger2")
 204         logger1.add_mdc("logger1_key1", "logger1_value1")
 205         logger1.add_mdc("logger1_key2", "logger1_value2")
 206         logger2.add_mdc("logger2_key1", "logger2_value1")
 207         logger2.add_mdc("logger2_key2", "logger2_value2")
 208         mdclogpy.add_mdc("key", "value")
 209
 210         logger1.error("error msg")
 211         logger2.error("warning msg")
 212         mdclogpy.error("info msg")
 213
 214         logs = TestMdcLogUtils.get_logs_as_json(output_mock.call_args_list)
 215         self.assertEqual(3, output_mock.call_count)
 216
 217         self.assertEqual(logs[0]["id"], "logger1")
 218         self.assertEqual(logs[0]["crit"], "ERROR")
 219         self.assertEqual(logs[0]["msg"], "error msg")
 220         self.assertEqual(logs[0]["mdc"]["logger1_key1"], "logger1_value1")
 221         self.assertEqual(logs[0]["mdc"]["logger1_key2"], "logger1_value2")
 222         self.assertEqual(len(logs[0]["mdc"]), 2)
 223
 224         self.assertEqual(logs[1]["id"], "logger2")
 225         self.assertEqual(logs[1]["crit"], "ERROR")
 226         self.assertEqual(logs[1]["msg"], "warning msg")
 227         self.assertEqual(logs[1]["mdc"]["logger2_key1"], "logger2_value1")
 228         self.assertEqual(logs[1]["mdc"]["logger2_key2"], "logger2_value2")
 229         self.assertEqual(len(logs[1]["mdc"]), 2)
 230
 231         self.assertEqual(logs[2]["id"], sys.argv[0])
 232         self.assertEqual(logs[2]["crit"], "ERROR")
 233         self.assertEqual(logs[2]["msg"], "info msg")
 234         self.assertEqual(logs[2]["mdc"]["key"], "value")
 235         self.assertEqual(len(logs[2]["mdc"]), 1)
 236
 237 if __name__ == '__main__':
 238     unittest.main()