-
Notifications
You must be signed in to change notification settings - Fork 85
/
OpTestLogger.py
174 lines (151 loc) · 7.13 KB
/
OpTestLogger.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
#!/usr/bin/env python3
# OpenPOWER Automated Test Project
#
# Contributors Listed Below - COPYRIGHT 2018
# [+] International Business Machines Corp.
#
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
# implied. See the License for the specific language governing
# permissions and limitations under the License.
#
# This implements all the python logger setup for op-test
import os
import sys
from datetime import datetime
import logging
from logging.handlers import RotatingFileHandler
class FileLikeLogger():
def __init__(self, l):
self.log = l
def write(self, data):
lines = data.splitlines()
for line in lines:
self.log.debug(line.rstrip("\n"))
def flush(self):
pass
class OpTestLogger():
'''
This class is used as the main global logger and handler initialization module.
See testcases/HelloWorld.py as an example for the usage within an op-test module.
'''
def __init__(self):
'''
Provide defaults and setup the minimal StreamHandlers
'''
self.parent_logger = 'op-test'
self.maxBytes_logger_file = 2000000
self.maxBytes_logger_debug_file = 2000000
self.backupCount_logger_files = 10
self.backupCount_debug_files = 10
self.logdir = os.getcwd()
self.logger_file = 'main.log'
self.logger_debug_file = 'debug.log'
self.optest_logger = logging.getLogger(self.parent_logger)
# clear the logger of any handlers in this shell
self.optest_logger.handlers = []
# need to set the logger to deepest level, handlers will filter
self.optest_logger.setLevel(logging.DEBUG)
# we need to init stream handler as special case to keep all happy
self.sh = logging.StreamHandler()
# save the sh level for later refreshes
self.sh_level = logging.ERROR
self.sh.setLevel(self.sh_level)
self.sh.setFormatter(logging.Formatter(
'%(asctime)s:%(name)s:%(funcName)s:%(levelname)s:%(message)s'))
self.optest_logger.addHandler(self.sh)
self.fh = None
self.dh = None
def get_logger(self, myname):
'''
Provide a method that allows individual module helper capabilities
'''
return logging.getLogger(self.parent_logger+'.{}'.format(myname))
def get_custom_logger(self, myname):
'''
Provide a method that allows individual module helper capabilities
'''
return logging.getLogger("op-test-thread"+'.{}'.format(myname))
def setUpLoggerFile(self, logger_file):
'''
Provide a method that allows setting up of a file handler with customized file rotation and formatting.
:param logger_file: File name to use for logging the main log records.
'''
# need to log that location of logging may be changed
self.optest_logger.info('Preparing to set location of Log File to {}'.format(
os.path.join(self.logdir, logger_file)))
self.logger_file = logger_file
if (not os.path.exists(self.logdir)):
os.makedirs(self.logdir)
self.fh = RotatingFileHandler(os.path.join(self.logdir, self.logger_file),
maxBytes=self.maxBytes_logger_file, backupCount=self.backupCount_logger_files,
encoding="utf8")
self.fh.setLevel(logging.INFO)
self.fh.setFormatter(logging.Formatter(
'%(asctime)s:%(name)s:%(levelname)s:%(message)s'))
self.optest_logger.addHandler(self.fh)
self.optest_logger.debug('FileHandler settings updated')
self.optest_logger.info('Log file: {}'.format(
os.path.join(self.logdir, self.logger_file)))
def setUpLoggerDebugFile(self, logger_debug_file):
'''
Provide a method that allows setting up of a debug file handler with customized file rotation and formatting.
:param logger_debug_file: File name to use for logging the debug log records.
'''
self.optest_logger.info('Preparing to set location of Debug Log File to {}'.format(
os.path.join(self.logdir, logger_debug_file)))
self.logger_debug_file = logger_debug_file
if (not os.path.exists(self.logdir)):
os.makedirs(self.logdir)
self.dh = RotatingFileHandler(os.path.join(self.logdir, self.logger_debug_file),
maxBytes=self.maxBytes_logger_debug_file, backupCount=self.backupCount_debug_files,
encoding="utf8")
self.dh.setLevel(logging.DEBUG)
self.dh.setFormatter(logging.Formatter(
'%(asctime)s:%(name)s:%(funcName)s:%(levelname)s:%(message)s'))
self.optest_logger.addHandler(self.dh)
self.optest_logger.debug('DebugHandler settings updated')
self.optest_logger.info('Debug Log file: {}'.format(
os.path.join(self.logdir, self.logger_debug_file)))
def setUpChildLogger(self, logger_name=None, logger_debug_file=None):
# setup library to send to optest_logger
if logger_debug_file is None:
logger_debug_file = os.path.join(
self.logdir, self.logger_debug_file)
if logger_name is not None:
temp_logger = logging.getLogger(logger_name)
temp_logger.setLevel(logging.DEBUG)
# send to the already existing debug file handler
temp_logger.addHandler(self.dh)
def setUpCustomLoggerDebugFile(self, logger_name, logger_debug_file):
'''
Provide a method that allows setting up of a debug file handler with customized file rotation and formatting.
:param logger_name: custom logger name
:param logger_debug_file: File name to use for logging the debug log records.
'''
self.optest_custom_logger = logging.getLogger(logger_name)
self.optest_custom_logger.addHandler(self.sh)
self.logger_debug_file = logger_debug_file
if (not os.path.exists(self.logdir)):
os.makedirs(self.logdir)
self.dh = RotatingFileHandler(os.path.join(self.logdir, self.logger_debug_file),
maxBytes=self.maxBytes_logger_debug_file, backupCount=self.backupCount_debug_files,
encoding="utf8")
self.dh.setLevel(logging.DEBUG)
self.dh.setFormatter(logging.Formatter(
'%(asctime)s:%(name)s:%(funcName)s:%(levelname)s:%(message)s'))
self.optest_custom_logger.addHandler(self.dh)
self.optest_custom_logger.debug(
'DebugHandler settings updated for custom logger')
self.optest_custom_logger.info('Debug Log file: {}'.format(
os.path.join(self.logdir, self.logger_debug_file)))
global optest_logger_glob
optest_logger_glob = OpTestLogger()