Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 1 | # /usr/bin/env python |
| 2 | """ |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 3 | Created on 07-Jan-2013 |
Jeremy Songster | ae01bba | 2016-07-11 15:39:17 -0700 | [diff] [blame] | 4 | Modified 2015 by ON.Lab |
Jon Hall | 81d3d39 | 2015-04-24 14:40:35 -0700 | [diff] [blame] | 5 | |
Jeremy Songster | ae01bba | 2016-07-11 15:39:17 -0700 | [diff] [blame] | 6 | Please refer questions to either the onos test mailing list at <onos-test@onosproject.org>, |
| 7 | the System Testing Plans and Results wiki page at <https://wiki.onosproject.org/x/voMg>, |
| 8 | or the System Testing Guide page at <https://wiki.onosproject.org/x/WYQg> |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 9 | |
| 10 | TestON is free software: you can redistribute it and/or modify |
| 11 | it under the terms of the GNU General Public License as published by |
| 12 | the Free Software Foundation, either version 2 of the License, or |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 13 | ( at your option ) any later version. |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 14 | |
| 15 | TestON is distributed in the hope that it will be useful, |
| 16 | but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 17 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 18 | GNU General Public License for more details. |
| 19 | |
| 20 | You should have received a copy of the GNU General Public License |
Jon Hall | 81d3d39 | 2015-04-24 14:40:35 -0700 | [diff] [blame] | 21 | along with TestON. If not, see <http://www.gnu.org/licenses/>. |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 22 | |
| 23 | |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 24 | """ |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 25 | import logging |
| 26 | import datetime |
| 27 | import re |
| 28 | import os |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 29 | |
| 30 | |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 31 | class Logger: |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 32 | |
| 33 | """ |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 34 | Add continuous logs and reports of the test. |
Jon Hall | 81d3d39 | 2015-04-24 14:40:35 -0700 | [diff] [blame] | 35 | |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 36 | author:: Raghav Kashyap( raghavkashyap@paxterrasolutions.com ) |
| 37 | """ |
| 38 | def _printHeader( self, main ): |
| 39 | """ |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 40 | Log's header will be append to the Log file |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 41 | """ |
| 42 | logmsg = "\n" + " " * 32 + "+----------------+\n" + "-" * 30 + " { Script And Files } " + "-" * 30 + "\n" + " " * 32 + "+----------------+\n" |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 43 | logmsg = logmsg + "\n\tScript Log File : " + main.LogFileName + "" |
| 44 | logmsg = logmsg + "\n\tReport Log File : " + main.ReportFileName + "" |
| 45 | for component in main.componentDictionary.keys(): |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 46 | logmsg = logmsg + "\n\t" + component + " Session Log : " + main.logdir + "/" + component + ".session" + "" |
Jon Hall | 81d3d39 | 2015-04-24 14:40:35 -0700 | [diff] [blame] | 47 | |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 48 | logmsg = logmsg + "\n\tTest Script :" + path + "Tests/" + main.TEST + ".py" + "" |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 49 | logmsg = logmsg + "\n\tTest Params : " + path + "Tests/" + main.TEST + ".params" + "" |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 50 | logmsg = logmsg + "\n\tTopology : " + path + "Tests/" + main.TEST + ".topo" + "" |
| 51 | logmsg = logmsg + "\n" + " " * 30 + "+" + "-" * 18 + "+" + "\n" + "-" * 27 + " { Script Exec Params } " + "-" * 27 + "\n" + " " * 30 + "+" + "-" * 18 + "+\n" |
| 52 | values = "\n\t" + str( main.params ) |
| 53 | values = re.sub( ",", "\n\t", values ) |
| 54 | values = re.sub( "{", "\n\t", values ) |
| 55 | values = re.sub( "}", "\n\t", values ) |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 56 | logmsg = logmsg + values |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 57 | logmsg = logmsg + "\n\n" + " " * 31 + "+---------------+\n" + "-" * 29 + " { Components Used } " + "-" * 29 + "\n" + " " * 31 + "+---------------+\n" |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 58 | component_list = [] |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 59 | component_list.append( None ) |
Jon Hall | 81d3d39 | 2015-04-24 14:40:35 -0700 | [diff] [blame] | 60 | |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 61 | # Listing the components in the order of test_target component should be first. |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 62 | if isinstance( main.componentDictionary, dict ): |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 63 | for key in main.componentDictionary.keys(): |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 64 | if main.test_target == key: |
| 65 | component_list[ 0 ] = key + "-Test Target" |
| 66 | else: |
| 67 | component_list.append( key ) |
Jon Hall | 81d3d39 | 2015-04-24 14:40:35 -0700 | [diff] [blame] | 68 | |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 69 | for index in range( len( component_list ) ): |
| 70 | if index == 0: |
| 71 | if component_list[ index ]: |
| 72 | logmsg += "\t" + component_list[ index ] + "\n" |
| 73 | elif index > 0: |
| 74 | logmsg += "\t" + str( component_list[ index ] ) + "\n" |
Jon Hall | 81d3d39 | 2015-04-24 14:40:35 -0700 | [diff] [blame] | 75 | |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 76 | logmsg = logmsg + "\n\n" + " " * 30 + "+--------+\n" + "-" * 28 + " { Topology } " + "-" * 28 + "\n" + " " * 30 + "+--------+\n" |
| 77 | values = "\n\t" + str( main.topology[ 'COMPONENT' ] ) |
| 78 | values = re.sub( ",", "\n\t", values ) |
| 79 | values = re.sub( "{", "\n\t", values ) |
| 80 | values = re.sub( "}", "\n\t", values ) |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 81 | logmsg = logmsg + values |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 82 | logmsg = logmsg + "\n" + "-" * 60 + "\n" |
Jon Hall | 81d3d39 | 2015-04-24 14:40:35 -0700 | [diff] [blame] | 83 | |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 84 | # enter into log file all headers |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 85 | logfile = open( main.LogFileName, "w+" ) |
| 86 | logfile.write( logmsg ) |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 87 | print logmsg |
| 88 | main.logHeader = logmsg |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 89 | logfile.close() |
Jon Hall | 81d3d39 | 2015-04-24 14:40:35 -0700 | [diff] [blame] | 90 | |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 91 | # enter into report file all headers |
| 92 | main.reportFile = open( main.ReportFileName, "w+" ) |
| 93 | main.reportFile.write( logmsg ) |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 94 | main.reportFile.close() |
Jon Hall | 81d3d39 | 2015-04-24 14:40:35 -0700 | [diff] [blame] | 95 | |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 96 | # Sumamry file header |
| 97 | currentTime = str( main.STARTTIME.strftime( "%d %b %Y %H:%M:%S" ) ) |
Jon Hall | 79bec22 | 2015-04-30 16:23:30 -0700 | [diff] [blame] | 98 | main.summaryFile = open( main.SummaryFileName, "w+" ) |
| 99 | main.summaryFile.write( main.TEST + " at " + currentTime + "\n" ) |
| 100 | main.summaryFile.close() |
| 101 | |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 102 | # wiki file header |
| 103 | currentTime = str( main.STARTTIME.strftime( "%d %b %Y %H:%M:%S" ) ) |
Jon Hall | 81d3d39 | 2015-04-24 14:40:35 -0700 | [diff] [blame] | 104 | main.wikiFile = open( main.WikiFileName, "w+" ) |
Jon Hall | 79bec22 | 2015-04-30 16:23:30 -0700 | [diff] [blame] | 105 | main.wikiFile.write( main.TEST + " at " + currentTime + "<p></p>\n" ) |
Jon Hall | 81d3d39 | 2015-04-24 14:40:35 -0700 | [diff] [blame] | 106 | main.wikiFile.close() |
| 107 | |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 108 | def initlog( self, main ): |
| 109 | """ |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 110 | Initialise all the log handles. |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 111 | """ |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 112 | main._getTest() |
Jon Hall | 81d3d39 | 2015-04-24 14:40:35 -0700 | [diff] [blame] | 113 | main.STARTTIME = datetime.datetime.now() |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 114 | |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 115 | currentTime = re.sub( "-|\s|:|\.", "_", str( main.STARTTIME.strftime( "%d %b %Y %H:%M:%S" ) ) ) |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 116 | if main.logdir: |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 117 | main.logdir = main.logdir + "/" + main.TEST + "_" + currentTime |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 118 | else: |
| 119 | main.logdir = main.logs_path + main.TEST + "_" + currentTime |
Jon Hall | 81d3d39 | 2015-04-24 14:40:35 -0700 | [diff] [blame] | 120 | |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 121 | os.mkdir( main.logdir ) |
Jon Hall | 81d3d39 | 2015-04-24 14:40:35 -0700 | [diff] [blame] | 122 | |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 123 | main.LogFileName = main.logdir + "/" + main.TEST + "_" + str( currentTime ) + ".log" |
| 124 | main.ReportFileName = main.logdir + "/" + main.TEST + "_" + str( currentTime ) + ".rpt" |
Jon Hall | 79bec22 | 2015-04-30 16:23:30 -0700 | [diff] [blame] | 125 | main.WikiFileName = main.logdir + "/" + main.TEST + "Wiki.txt" |
| 126 | main.SummaryFileName = main.logdir + "/" + main.TEST + "Summary.txt" |
Jon Hall | 94fd047 | 2014-12-08 11:52:42 -0800 | [diff] [blame] | 127 | main.JenkinsCSV = main.logdir + "/" + main.TEST + ".csv" |
Devin Lim | 90803a8 | 2017-08-29 13:41:44 -0700 | [diff] [blame] | 128 | main.resultFile = main.logdir + "/" + main.TEST + "Result.txt" |
| 129 | |
Jon Hall | 2507978 | 2015-10-13 13:54:39 -0700 | [diff] [blame] | 130 | main.TOTAL_TC_SUCCESS = 0 |
Jon Hall | 81d3d39 | 2015-04-24 14:40:35 -0700 | [diff] [blame] | 131 | |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 132 | # Add log-level - Report |
| 133 | logging.addLevelName( 9, "REPORT" ) |
| 134 | logging.addLevelName( 7, "EXACT" ) |
| 135 | logging.addLevelName( 11, "CASE" ) |
| 136 | logging.addLevelName( 12, "STEP" ) |
| 137 | main.log = logging.getLogger( main.TEST ) |
| 138 | |
| 139 | def report( msg ): |
| 140 | """ |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 141 | Will append the report message to the logs. |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 142 | """ |
| 143 | main.log._log( 9, msg, "OpenFlowAutoMattion", "OFAutoMation" ) |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 144 | currentTime = datetime.datetime.now() |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 145 | currentTime = currentTime.strftime( "%d %b %Y %H:%M:%S" ) |
| 146 | newmsg = "\n[REPORT] " + "[" + str( currentTime ) + "] " + msg |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 147 | print newmsg |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 148 | main.reportFile = open( main.ReportFileName, "a+" ) |
| 149 | main.reportFile.write( newmsg ) |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 150 | main.reportFile.close() |
Jon Hall | 81d3d39 | 2015-04-24 14:40:35 -0700 | [diff] [blame] | 151 | |
| 152 | main.log.report = report |
| 153 | |
Jon Hall | 79bec22 | 2015-04-30 16:23:30 -0700 | [diff] [blame] | 154 | def summary( msg ): |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 155 | """ |
Jon Hall | 79bec22 | 2015-04-30 16:23:30 -0700 | [diff] [blame] | 156 | Will append the message to the txt file for the summary. |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 157 | """ |
| 158 | main.log._log( 6, msg, "OpenFlowAutoMattion", "OFAutoMation" ) |
| 159 | main.summaryFile = open( main.SummaryFileName, "a+" ) |
| 160 | main.summaryFile.write( msg + "\n" ) |
Jon Hall | 79bec22 | 2015-04-30 16:23:30 -0700 | [diff] [blame] | 161 | main.summaryFile.close() |
| 162 | |
| 163 | main.log.summary = summary |
| 164 | |
Jon Hall | 81d3d39 | 2015-04-24 14:40:35 -0700 | [diff] [blame] | 165 | def wiki( msg ): |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 166 | """ |
Jon Hall | 81d3d39 | 2015-04-24 14:40:35 -0700 | [diff] [blame] | 167 | Will append the message to the txt file for the wiki. |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 168 | """ |
| 169 | main.log._log( 6, msg, "OpenFlowAutoMattion", "OFAutoMation" ) |
| 170 | main.wikiFile = open( main.WikiFileName, "a+" ) |
| 171 | main.wikiFile.write( msg + "\n" ) |
Jon Hall | 81d3d39 | 2015-04-24 14:40:35 -0700 | [diff] [blame] | 172 | main.wikiFile.close() |
| 173 | |
| 174 | main.log.wiki = wiki |
| 175 | |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 176 | def exact( exmsg ): |
| 177 | """ |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 178 | Will append the raw formatted message to the logs |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 179 | """ |
| 180 | main.log._log( 7, exmsg, "OpenFlowAutoMattion", "OFAutoMation" ) |
| 181 | main.reportFile = open( main.ReportFileName, "a+" ) |
| 182 | main.reportFile.write( exmsg ) |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 183 | main.reportFile.close() |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 184 | logfile = open( main.LogFileName, "a" ) |
| 185 | logfile.write( "\n" + str( exmsg ) + "\n" ) |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 186 | logfile.close() |
| 187 | print exmsg |
Jon Hall | 81d3d39 | 2015-04-24 14:40:35 -0700 | [diff] [blame] | 188 | |
| 189 | main.log.exact = exact |
| 190 | |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 191 | def case( msg ): |
| 192 | """ |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 193 | Format of the case type log defined here. |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 194 | """ |
| 195 | main.log._log( 9, msg, "OpenFlowAutoMattion", "OFAutoMation" ) |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 196 | currentTime = datetime.datetime.now() |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 197 | newmsg = "[" + str( currentTime ) + "] " + "[" + main.TEST + "] " + "[CASE] " + msg |
| 198 | logfile = open( main.LogFileName, "a" ) |
| 199 | logfile.write( "\n" + str( newmsg ) + "\n" ) |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 200 | logfile.close() |
| 201 | print newmsg |
Jon Hall | 81d3d39 | 2015-04-24 14:40:35 -0700 | [diff] [blame] | 202 | |
Jon Hall | 4ba53f0 | 2015-07-29 13:07:41 -0700 | [diff] [blame] | 203 | main.log.case = case |
Jon Hall | 81d3d39 | 2015-04-24 14:40:35 -0700 | [diff] [blame] | 204 | |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 205 | def step( msg ): |
| 206 | """ |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 207 | Format of the step type log defined here. |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 208 | """ |
| 209 | main.log._log( 9, msg, "OpenFlowAutoMattion", "OFAutoMation" ) |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 210 | currentTime = datetime.datetime.now() |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 211 | newmsg = "[" + str( currentTime ) + "] " + "[" + main.TEST + "] " + "[STEP] " + msg |
| 212 | logfile = open( main.LogFileName, "a" ) |
| 213 | logfile.write( "\n" + str( newmsg ) + "\n" ) |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 214 | logfile.close() |
| 215 | print newmsg |
Jon Hall | 81d3d39 | 2015-04-24 14:40:35 -0700 | [diff] [blame] | 216 | |
| 217 | main.log.step = step |
| 218 | |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 219 | main.LogFileHandler = logging.FileHandler( main.LogFileName ) |
| 220 | self._printHeader( main ) |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 221 | |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 222 | # initializing logging module and setting log level |
| 223 | main.log.setLevel( logging.INFO ) |
| 224 | main.log.setLevel( logging.DEBUG ) # Temporary |
| 225 | main.LogFileHandler.setLevel( logging.INFO ) |
Jon Hall | 81d3d39 | 2015-04-24 14:40:35 -0700 | [diff] [blame] | 226 | |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 227 | # create console handler with a higher log level |
| 228 | main.ConsoleHandler = logging.StreamHandler() |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 229 | main.ConsoleHandler.setLevel( logging.INFO ) |
| 230 | main.ConsoleHandler.setLevel( logging.DEBUG ) # Temporary |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 231 | # create formatter and add it to the handlers |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 232 | # formatter = logging.Formatter( '%(asctime)s - %(name)s - %(levelname)s - %(message)s' ) |
| 233 | |
Jon Hall | 0bde9ba | 2015-03-19 11:32:57 -0700 | [diff] [blame] | 234 | class MyFormatter( logging.Formatter ): |
| 235 | colors = { 'cyan': '\033[96m', 'purple': '\033[95m', |
| 236 | 'blue': '\033[94m', 'green': '\033[92m', |
| 237 | 'yellow': '\033[93m', 'red': '\033[91m', |
| 238 | 'end': '\033[0m' } |
| 239 | |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 240 | FORMATS = { 'DEFAULT': '%(asctime)s - %(name)s - %(levelname)s - %(message)s' } |
Jon Hall | 0bde9ba | 2015-03-19 11:32:57 -0700 | [diff] [blame] | 241 | if COLORS: # NOTE:colors will only be loaded if command is run from one line |
| 242 | # IE: './cli.py run testname' |
| 243 | # This is to prevent issues with Jenkins parsing |
| 244 | # TODO: Make colors configurable |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 245 | levels = { logging.ERROR: colors[ 'red' ] + |
| 246 | FORMATS[ 'DEFAULT' ] + |
| 247 | colors[ 'end' ], |
| 248 | logging.WARN: colors[ 'yellow' ] + |
| 249 | FORMATS[ 'DEFAULT' ] + |
| 250 | colors[ 'end' ], |
| 251 | logging.DEBUG: colors[ 'purple' ] + |
| 252 | FORMATS[ 'DEFAULT' ] + |
| 253 | colors[ 'end' ] } |
Jon Hall | 0bde9ba | 2015-03-19 11:32:57 -0700 | [diff] [blame] | 254 | FORMATS.update( levels ) |
| 255 | |
| 256 | def format( self, record ): |
| 257 | self._fmt = self.FORMATS.get( record.levelno, |
| 258 | self.FORMATS[ 'DEFAULT' ] ) |
| 259 | return logging.Formatter.format( self, record ) |
| 260 | formatter = MyFormatter() |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 261 | main.ConsoleHandler.setFormatter( formatter ) |
| 262 | main.LogFileHandler.setFormatter( formatter ) |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 263 | |
| 264 | # add the handlers to logger |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 265 | main.log.addHandler( main.ConsoleHandler ) |
| 266 | main.log.addHandler( main.LogFileHandler ) |
Jon Hall | 81d3d39 | 2015-04-24 14:40:35 -0700 | [diff] [blame] | 267 | |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 268 | def testSummary( self, main ): |
| 269 | """ |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 270 | testSummary will take care about the Summary of test. |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 271 | """ |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 272 | main.ENDTIME = datetime.datetime.now() |
| 273 | main.EXECTIME = main.ENDTIME - main.STARTTIME |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 274 | if ( main.TOTAL_TC_PASS == 0 ): |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 275 | main.TOTAL_TC_SUCCESS = 0 |
| 276 | else: |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 277 | main.TOTAL_TC_SUCCESS = str( ( main.TOTAL_TC_PASS * 100 ) / main.TOTAL_TC_RUN ) |
| 278 | if ( main.TOTAL_TC_RUN == 0 ): |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 279 | main.TOTAL_TC_EXECPERCENT = 0 |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 280 | else: |
| 281 | main.TOTAL_TC_EXECPERCENT = str( ( main.TOTAL_TC_RUN * 100 ) / main.TOTAL_TC_PLANNED ) |
| 282 | testResult = "\n\n" + "*" * 37 + "\n" + "\tTest Execution Summary\n" + "\n" + "*" * 37 + " \n" |
| 283 | testResult = testResult + "\n Test Start : " + str( main.STARTTIME.strftime( "%d %b %Y %H:%M:%S" ) ) |
| 284 | testResult = testResult + "\n Test End : " + str( main.ENDTIME.strftime( "%d %b %Y %H:%M:%S" ) ) |
| 285 | testResult = testResult + "\n Execution Time : " + str( main.EXECTIME ) |
| 286 | testResult = testResult + "\n Total tests planned : " + str( main.TOTAL_TC_PLANNED ) |
| 287 | testResult = testResult + "\n Total tests RUN : " + str( main.TOTAL_TC_RUN ) |
| 288 | testResult = testResult + "\n Total Pass : " + str( main.TOTAL_TC_PASS ) |
| 289 | testResult = testResult + "\n Total Fail : " + str( main.TOTAL_TC_FAIL ) |
| 290 | testResult = testResult + "\n Total No Result : " + str( main.TOTAL_TC_NORESULT ) |
| 291 | testResult = testResult + "\n Success Percentage : " + str( main.TOTAL_TC_SUCCESS ) + "%" |
| 292 | testResult = testResult + "\n Execution Result : " + str( main.TOTAL_TC_EXECPERCENT ) + "%\n" |
Devin Lim | ec98979 | 2017-08-15 15:57:55 -0700 | [diff] [blame] | 293 | if main.failedCase: |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 294 | testResult = testResult + "\n Case Failed : " + str( main.failedCase ) |
Devin Lim | ec98979 | 2017-08-15 15:57:55 -0700 | [diff] [blame] | 295 | if main.noResultCase: |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 296 | testResult = testResult + "\n Case NoResult : " + str( main.noResultCase ) |
| 297 | testResult = testResult + "\n Case Executed : " + str( main.executedCase ) |
| 298 | testResult = testResult + "\n Case Not Executed : " + str( main.leftCase ) |
| 299 | # main.log.report( testResult ) |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 300 | main.testResult = testResult |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 301 | main.log.exact( testResult ) |
Jon Hall | 94fd047 | 2014-12-08 11:52:42 -0800 | [diff] [blame] | 302 | |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 303 | # CSV output needed for Jenkins plot plugin |
| 304 | # NOTE: the elements were ordered based on the colors assigned to the data |
| 305 | logfile = open( main.JenkinsCSV, "w" ) |
| 306 | logfile.write( ",".join( [ 'Tests Failed', 'Tests Passed', 'Tests Planned' ] ) + "\n" ) |
| 307 | logfile.write( ",".join( [ str( int( main.TOTAL_TC_FAIL ) ), str( int( main.TOTAL_TC_PASS ) ), str( int( main.TOTAL_TC_PLANNED ) ) ] ) + "\n" ) |
Jon Hall | 94fd047 | 2014-12-08 11:52:42 -0800 | [diff] [blame] | 308 | logfile.close() |
| 309 | |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 310 | executedStatus = open( main.resultFile, "w" ) |
Devin Lim | 90803a8 | 2017-08-29 13:41:44 -0700 | [diff] [blame] | 311 | if main.TOTAL_TC_FAIL == 0 and main.TOTAL_TC_NORESULT + main.TOTAL_TC_PASS == main.TOTAL_TC_PLANNED: |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 312 | executedStatus.write( "1\n" ) |
Devin Lim | 90803a8 | 2017-08-29 13:41:44 -0700 | [diff] [blame] | 313 | else: |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 314 | executedStatus.write( "0\n" ) |
Devin Lim | 90803a8 | 2017-08-29 13:41:44 -0700 | [diff] [blame] | 315 | executedStatus.close() |
| 316 | |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 317 | def updateCaseResults( self, main ): |
| 318 | """ |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 319 | Update the case result based on the steps execution and asserting each step in the test-case |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 320 | """ |
| 321 | case = str( main.CurrentTestCaseNumber ) |
| 322 | currentResult = main.testCaseResult.get( case, 2 ) |
Jon Hall | 81d3d39 | 2015-04-24 14:40:35 -0700 | [diff] [blame] | 323 | |
Jon Hall | 79bec22 | 2015-04-30 16:23:30 -0700 | [diff] [blame] | 324 | if currentResult == 2: |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 325 | main.TOTAL_TC_RUN = main.TOTAL_TC_RUN + 1 |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 326 | main.TOTAL_TC_NORESULT = main.TOTAL_TC_NORESULT + 1 |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 327 | main.log.exact( "\n " + "*" * 29 + "\n" + "\n Result: No Assertion Called \n" + "*" * 29 + "\n" ) |
| 328 | line = "Case " + case + ": " + main.CurrentTestCase + " - No Result" |
Jon Hall | 79bec22 | 2015-04-30 16:23:30 -0700 | [diff] [blame] | 329 | elif currentResult == 1: |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 330 | main.TOTAL_TC_RUN = main.TOTAL_TC_RUN + 1 |
| 331 | main.TOTAL_TC_PASS = main.TOTAL_TC_PASS + 1 |
| 332 | main.log.exact( "\n" + "*" * 29 + "\n Result: Pass \n" + "*" * 29 + "\n" ) |
| 333 | line = "Case " + case + ": " + main.CurrentTestCase + " - PASS" |
Jon Hall | 79bec22 | 2015-04-30 16:23:30 -0700 | [diff] [blame] | 334 | elif currentResult == 0: |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 335 | main.TOTAL_TC_RUN = main.TOTAL_TC_RUN + 1 |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 336 | main.TOTAL_TC_FAIL = main.TOTAL_TC_FAIL + 1 |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 337 | main.log.exact( "\n" + "*" * 29 + "\n Result: Failed \n" + "*" * 29 + "\n" ) |
| 338 | line = "Case " + case + ": " + main.CurrentTestCase + " - FAIL" |
Jon Hall | 79bec22 | 2015-04-30 16:23:30 -0700 | [diff] [blame] | 339 | else: |
| 340 | main.log.error( " Unknown result of case " + case + |
| 341 | ". Result was: " + currentResult ) |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 342 | line = "Case " + case + ": " + main.CurrentTestCase + " - ERROR" |
Jon Hall | 79bec22 | 2015-04-30 16:23:30 -0700 | [diff] [blame] | 343 | main.log.wiki( "<h3>" + line + "</h3>" ) |
| 344 | main.log.summary( line ) |