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