blob: a2c5aa73467c4dd56c9c5e12bbd2c1674ab73259 [file] [log] [blame]
adminbae64d82013-08-01 10:50:15 -07001#/usr/bin/env python
2'''
3Created on 07-Jan-2013
shahshreya7bf64442015-04-28 16:28:54 -07004
adminbae64d82013-08-01 10:50:15 -07005@author: Raghav Kashyap(raghavkashyap@paxterrasolutions.com)
6
7 TestON is free software: you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation, either version 2 of the License, or
10 (at your option) any later version.
11
12 TestON is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
16
17 You should have received a copy of the GNU General Public License
shahshreya7bf64442015-04-28 16:28:54 -070018 along with TestON. If not, see <http://www.gnu.org/licenses/>.
adminbae64d82013-08-01 10:50:15 -070019
20
21'''
22
23import logging
24import datetime
25import re
26import os
27class Logger:
28 '''
29 Add continuous logs and reports of the test.
shahshreya7bf64442015-04-28 16:28:54 -070030
adminbae64d82013-08-01 10:50:15 -070031 @author: Raghav Kashyap(raghavkashyap@paxterrasolutions.com)
32 '''
33 def _printHeader(self,main) :
34 '''
35 Log's header will be append to the Log file
36 '''
37 logmsg = "\n"+" " * 32+"+----------------+\n" +"-" * 30+" { Script And Files } "+"-" * 30+"\n" +" " * 32+"+----------------+\n";
38 logmsg = logmsg + "\n\tScript Log File : " + main.LogFileName + ""
39 logmsg = logmsg + "\n\tReport Log File : " + main.ReportFileName + ""
40 for component in main.componentDictionary.keys():
41 logmsg = logmsg + "\n\t"+component+" Session Log : " + main.logdir+"/"+component+".session" + ""
shahshreya7bf64442015-04-28 16:28:54 -070042
adminbae64d82013-08-01 10:50:15 -070043 logmsg = logmsg + "\n\tTest Script :" + path + "Tests/" + main.TEST + ".py"+ ""
44 logmsg = logmsg + "\n\tTest Params : " + path + "Tests/" + main.TEST + ".params" + ""
Jon Hall368769f2014-11-19 15:43:35 -080045 logmsg = logmsg + "\n\tTopology : " + path + "Tests/" +main.TEST + ".topo" + ""
adminbae64d82013-08-01 10:50:15 -070046 logmsg = logmsg + "\n"+" " * 30+"+" +"-" * 18+"+" +"\n" +"-" * 27+" { Script Exec Params } "+"-" * 27 +"\n" +" " * 30 +"+"+"-" * 18 +"+\n";
47 values = "\n\t" + str(main.params)
48 values = re.sub(",", "\n\t", values)
49 values = re.sub("{", "\n\t", values)
50 values = re.sub("}", "\n\t", values)
51 logmsg = logmsg + values
adminbae64d82013-08-01 10:50:15 -070052 logmsg = logmsg + "\n\n"+" " * 31+"+---------------+\n" +"-" * 29+" { Components Used } " +"-" * 29+"\n"+" " * 31+"+---------------+\n"
53 component_list = []
54 component_list.append(None)
shahshreya7bf64442015-04-28 16:28:54 -070055
adminbae64d82013-08-01 10:50:15 -070056 # Listing the components in the order of test_target component should be first.
57 if type(main.componentDictionary) == dict:
58 for key in main.componentDictionary.keys():
59 if main.test_target == key :
60 component_list[0] = key+"-Test Target"
61 else :
62 component_list.append(key)
shahshreya7bf64442015-04-28 16:28:54 -070063
adminbae64d82013-08-01 10:50:15 -070064 for index in range(len(component_list)) :
65 if index==0:
66 if component_list[index]:
67 logmsg+="\t"+component_list[index]+"\n"
68 elif index > 0 :
69 logmsg+="\t"+str(component_list[index])+"\n"
shahshreya7bf64442015-04-28 16:28:54 -070070
adminbae64d82013-08-01 10:50:15 -070071 logmsg = logmsg + "\n\n"+" " * 30+"+--------+\n" +"-" * 28+" { Topology } "+"-" * 28 +"\n" +" " * 30+"+--------+\n"
72 values = "\n\t" + str(main.topology['COMPONENT'])
73 values = re.sub(",", "\n\t", values)
74 values = re.sub("{", "\n\t", values)
75 values = re.sub("}", "\n\t", values)
76 logmsg = logmsg + values
adminbae64d82013-08-01 10:50:15 -070077 logmsg = logmsg + "\n"+"-" * 60+"\n"
shahshreya7bf64442015-04-28 16:28:54 -070078
adminbae64d82013-08-01 10:50:15 -070079 # enter into log file all headers
80 logfile = open(main.LogFileName,"w+")
81 logfile.write (logmsg)
82 print logmsg
83 main.logHeader = logmsg
adminbae64d82013-08-01 10:50:15 -070084 logfile.close()
shahshreya7bf64442015-04-28 16:28:54 -070085
adminbae64d82013-08-01 10:50:15 -070086 #enter into report file all headers
87 main.reportFile = open(main.ReportFileName,"w+")
88 main.reportFile.write(logmsg)
89 main.reportFile.close()
shahshreya7bf64442015-04-28 16:28:54 -070090
91 #wiki file header
92 currentTime = str( main.STARTTIME.strftime("%d %b %Y %H:%M:%S") )
93 main.wikiFile = open( main.WikiFileName, "w+" )
94 main.wikiFile.write( main.TEST + " at " + currentTime + "\n" )
95 main.wikiFile.close()
96
adminbae64d82013-08-01 10:50:15 -070097 def initlog(self,main):
98 '''
99 Initialise all the log handles.
100 '''
101 main._getTest()
shahshreya7bf64442015-04-28 16:28:54 -0700102 main.STARTTIME = datetime.datetime.now()
adminbae64d82013-08-01 10:50:15 -0700103
104 currentTime = re.sub("-|\s|:|\.", "_", str(main.STARTTIME.strftime("%d %b %Y %H:%M:%S")))
105 if main.logdir:
106 main.logdir = main.logdir+ "/"+main.TEST + "_" + currentTime
107 else:
108 main.logdir = main.logs_path + main.TEST + "_" + currentTime
shahshreya7bf64442015-04-28 16:28:54 -0700109
adminbae64d82013-08-01 10:50:15 -0700110 os.mkdir(main.logdir)
shahshreya7bf64442015-04-28 16:28:54 -0700111
adminbae64d82013-08-01 10:50:15 -0700112 main.LogFileName = main.logdir + "/" + main.TEST + "_" +str(currentTime) + ".log"
113 main.ReportFileName = main.logdir + "/" + main.TEST + "_" + str(currentTime) + ".rpt"
shahshreya7bf64442015-04-28 16:28:54 -0700114 main.WikiFileName = main.logdir + "/" + main.TEST + ".txt"
Jon Hall94fd0472014-12-08 11:52:42 -0800115 main.JenkinsCSV = main.logdir + "/" + main.TEST + ".csv"
shahshreya7bf64442015-04-28 16:28:54 -0700116
adminbae64d82013-08-01 10:50:15 -0700117 #### Add log-level - Report
118 logging.addLevelName(9, "REPORT")
119 logging.addLevelName(7, "EXACT")
Jon Hall0bde9ba2015-03-19 11:32:57 -0700120 logging.addLevelName(11, "CASE")
121 logging.addLevelName(12, "STEP")
adminbae64d82013-08-01 10:50:15 -0700122 main.log = logging.getLogger(main.TEST)
shahshreya7bf64442015-04-28 16:28:54 -0700123 def report(msg):
adminbae64d82013-08-01 10:50:15 -0700124 '''
125 Will append the report message to the logs.
126 '''
127 main.log._log(9,msg,"OpenFlowAutoMattion","OFAutoMation")
128 currentTime = datetime.datetime.now()
129 currentTime = currentTime.strftime("%d %b %Y %H:%M:%S")
130 newmsg = "\n[REPORT] " +"["+ str(currentTime)+"] "+msg
131 print newmsg
132 main.reportFile = open(main.ReportFileName,"a+")
133 main.reportFile.write(newmsg)
134 main.reportFile.close()
shahshreya7bf64442015-04-28 16:28:54 -0700135
136 main.log.report = report
137
138 def wiki( msg ):
139 '''
140 Will append the message to the txt file for the wiki.
141 '''
142 main.log._log(6,msg,"OpenFlowAutoMattion","OFAutoMation")
143 main.wikiFile = open(main.WikiFileName,"a+")
144 main.wikiFile.write(msg+"\n")
145 main.wikiFile.close()
146
147 main.log.wiki = wiki
148
149 def exact(exmsg):
adminbae64d82013-08-01 10:50:15 -0700150 '''
151 Will append the raw formatted message to the logs
152 '''
153 main.log._log(7,exmsg,"OpenFlowAutoMattion","OFAutoMation")
154 main.reportFile = open(main.ReportFileName,"a+")
155 main.reportFile.write(exmsg)
156 main.reportFile.close()
157 logfile = open(main.LogFileName,"a")
158 logfile.write("\n"+ str(exmsg) +"\n")
159 logfile.close()
160 print exmsg
shahshreya7bf64442015-04-28 16:28:54 -0700161
162 main.log.exact = exact
163
adminbae64d82013-08-01 10:50:15 -0700164 def case(msg):
165 '''
166 Format of the case type log defined here.
167 '''
168 main.log._log(9,msg,"OpenFlowAutoMattion","OFAutoMation")
169 currentTime = datetime.datetime.now()
170 newmsg = "["+str(currentTime)+"] " + "["+main.TEST+"] " + "[CASE] " +msg
171 logfile = open(main.LogFileName,"a")
172 logfile.write("\n"+ str(newmsg) +"\n")
173 logfile.close()
174 print newmsg
shahshreya7bf64442015-04-28 16:28:54 -0700175
adminbae64d82013-08-01 10:50:15 -0700176 main.log.case = case
shahshreya7bf64442015-04-28 16:28:54 -0700177
178 def step(msg):
adminbae64d82013-08-01 10:50:15 -0700179 '''
180 Format of the step type log defined here.
181 '''
182 main.log._log(9,msg,"OpenFlowAutoMattion","OFAutoMation")
183 currentTime = datetime.datetime.now()
184 newmsg = "["+str(currentTime)+"] " + "["+main.TEST+"] " + "[STEP] " +msg
185 logfile = open(main.LogFileName,"a")
186 logfile.write("\n"+ str(newmsg) +"\n")
187 logfile.close()
188 print newmsg
shahshreya7bf64442015-04-28 16:28:54 -0700189
190 main.log.step = step
191
adminbae64d82013-08-01 10:50:15 -0700192 main.LogFileHandler = logging.FileHandler(main.LogFileName)
193 self._printHeader(main)
194
195 ### initializing logging module and settig log level
196 main.log.setLevel(logging.INFO)
Jon Hall0bde9ba2015-03-19 11:32:57 -0700197 main.log.setLevel(logging.DEBUG) # Temporary
adminbae64d82013-08-01 10:50:15 -0700198 main.LogFileHandler.setLevel(logging.INFO)
shahshreya7bf64442015-04-28 16:28:54 -0700199
adminbae64d82013-08-01 10:50:15 -0700200 # create console handler with a higher log level
201 main.ConsoleHandler = logging.StreamHandler()
202 main.ConsoleHandler.setLevel(logging.INFO)
Jon Hall0bde9ba2015-03-19 11:32:57 -0700203 main.ConsoleHandler.setLevel(logging.DEBUG) #Temporary
adminbae64d82013-08-01 10:50:15 -0700204 # create formatter and add it to the handlers
Jon Hall0bde9ba2015-03-19 11:32:57 -0700205 #formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')
206 class MyFormatter( logging.Formatter ):
207 colors = { 'cyan': '\033[96m', 'purple': '\033[95m',
208 'blue': '\033[94m', 'green': '\033[92m',
209 'yellow': '\033[93m', 'red': '\033[91m',
210 'end': '\033[0m' }
211
212 FORMATS = {'DEFAULT': '%(asctime)s - %(name)s - %(levelname)s - %(message)s'}
213 if COLORS: # NOTE:colors will only be loaded if command is run from one line
214 # IE: './cli.py run testname'
215 # This is to prevent issues with Jenkins parsing
216 # TODO: Make colors configurable
217 levels = { logging.ERROR : colors['red'] +
218 FORMATS['DEFAULT'] +
219 colors['end'],
220 logging.WARN : colors['yellow'] +
221 FORMATS['DEFAULT'] +
222 colors['end'],
223 logging.DEBUG : colors['purple'] +
224 FORMATS['DEFAULT'] +
225 colors['end'] }
226 FORMATS.update( levels )
227
228 def format( self, record ):
229 self._fmt = self.FORMATS.get( record.levelno,
230 self.FORMATS[ 'DEFAULT' ] )
231 return logging.Formatter.format( self, record )
232 formatter = MyFormatter()
adminbae64d82013-08-01 10:50:15 -0700233 main.ConsoleHandler.setFormatter(formatter)
234 main.LogFileHandler.setFormatter(formatter)
235
236 # add the handlers to logger
237 main.log.addHandler(main.ConsoleHandler)
238 main.log.addHandler(main.LogFileHandler)
shahshreya7bf64442015-04-28 16:28:54 -0700239
adminbae64d82013-08-01 10:50:15 -0700240 def testSummary(self,main):
241 '''
242 testSummary will take care about the Summary of test.
243 '''
244
245 main.ENDTIME = datetime.datetime.now()
246 main.EXECTIME = main.ENDTIME - main.STARTTIME
247 if (main.TOTAL_TC_PASS == 0):
248 main.TOTAL_TC_SUCCESS = 0
249 else:
250 main.TOTAL_TC_SUCCESS = str((main.TOTAL_TC_PASS*100)/main.TOTAL_TC_RUN)
adminbae64d82013-08-01 10:50:15 -0700251 if (main.TOTAL_TC_RUN == 0) :
252 main.TOTAL_TC_EXECPERCENT = 0
253 else :
254 main.TOTAL_TC_EXECPERCENT = str((main.TOTAL_TC_RUN*100)/main.TOTAL_TC_PLANNED)
adminbae64d82013-08-01 10:50:15 -0700255 testResult = "\n\n"+"*" * 37+"\n" + "\tTest Execution Summary\n" + "\n"+"*" * 37+" \n"
256 testResult = testResult + "\n Test Start : " + str(main.STARTTIME.strftime("%d %b %Y %H:%M:%S"))
257 testResult = testResult + "\n Test End : " + str(main.ENDTIME.strftime("%d %b %Y %H:%M:%S"))
258 testResult = testResult + "\n Execution Time : " + str(main.EXECTIME)
259 testResult = testResult + "\n Total tests planned : " + str(main.TOTAL_TC_PLANNED)
260 testResult = testResult + "\n Total tests RUN : " + str(main.TOTAL_TC_RUN)
261 testResult = testResult + "\n Total Pass : " + str(main.TOTAL_TC_PASS)
262 testResult = testResult + "\n Total Fail : " + str(main.TOTAL_TC_FAIL)
263 testResult = testResult + "\n Total No Result : " + str(main.TOTAL_TC_NORESULT)
264 testResult = testResult + "\n Success Percentage : " + str(main.TOTAL_TC_SUCCESS) + "%"
265 testResult = testResult + "\n Execution Result : " + str(main.TOTAL_TC_EXECPERCENT) + "%"
shahshreya7bf64442015-04-28 16:28:54 -0700266
adminbae64d82013-08-01 10:50:15 -0700267 #main.log.report(testResult)
268 main.testResult = testResult
269 main.log.exact(testResult)
Jon Hall94fd0472014-12-08 11:52:42 -0800270
Jon Hall368769f2014-11-19 15:43:35 -0800271 ##CSV output needed for Jenkin's plot plugin
272 #NOTE: the elements were orded based on the colors assigned to the data
273 logfile = open(main.JenkinsCSV ,"w")
274 logfile.write(",".join( ['Tests Failed', 'Tests Passed', 'Tests Planned'] ) + "\n")
Jon Hall94fd0472014-12-08 11:52:42 -0800275 logfile.write(",".join( [str(int(main.TOTAL_TC_FAIL)), str(int(main.TOTAL_TC_PASS)), str(int(main.TOTAL_TC_PLANNED))] ))
276 logfile.close()
277
adminbae64d82013-08-01 10:50:15 -0700278 def updateCaseResults(self,main):
279 '''
280 Update the case result based on the steps execution and asserting each step in the test-case
281 '''
282 case = str(main.CurrentTestCaseNumber)
shahshreya7bf64442015-04-28 16:28:54 -0700283
adminbae64d82013-08-01 10:50:15 -0700284 if main.testCaseResult[case] == 2:
285 main.TOTAL_TC_RUN = main.TOTAL_TC_RUN + 1
286 main.TOTAL_TC_NORESULT = main.TOTAL_TC_NORESULT + 1
287 main.log.exact("\n "+"*" * 29+"\n" + "\n Result: No Assertion Called \n"+"*" * 29+"\n")
shahshreya7bf64442015-04-28 16:28:54 -0700288 main.log.wiki("Case "+case+": "+main.CurrentTestCase+" - No Result")
adminbae64d82013-08-01 10:50:15 -0700289 elif main.testCaseResult[case] == 1:
290 main.TOTAL_TC_RUN = main.TOTAL_TC_RUN + 1
291 main.TOTAL_TC_PASS = main.TOTAL_TC_PASS + 1
292 main.log.exact("\n"+"*" * 29+"\n Result: Pass \n"+"*" * 29+"\n")
shahshreya7bf64442015-04-28 16:28:54 -0700293 main.log.wiki("Case "+case+": "+main.CurrentTestCase+" - PASSED")
adminbae64d82013-08-01 10:50:15 -0700294 elif main.testCaseResult[case] == 0:
295 main.TOTAL_TC_RUN = main.TOTAL_TC_RUN + 1
296 main.TOTAL_TC_FAIL = main.TOTAL_TC_FAIL + 1
297 main.log.exact("\n"+"*" * 29+"\n Result: Failed \n"+"*" * 29+"\n")
shahshreya7bf64442015-04-28 16:28:54 -0700298 main.log.wiki("Case "+case+": "+main.CurrentTestCase+" - FAILED")
299