admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 1 | #!/usr/bin/env python |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 2 | """ |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 3 | Created on 22-Oct-2012 |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 4 | Copyright 2012 Open Networking Foundation ( ONF ) |
Jon Hall | 65844a3 | 2015-03-09 19:09:37 -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 | 65844a3 | 2015-03-09 19:09:37 -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 | |
| 24 | |
| 25 | teston is the main module. |
| 26 | |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 27 | """ |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 28 | import sys |
| 29 | import getpass |
| 30 | import os |
| 31 | import re |
| 32 | import __builtin__ |
| 33 | import new |
| 34 | import xmldict |
Jon Hall | 30b82fa | 2015-03-04 17:15:43 -0800 | [diff] [blame] | 35 | import importlib |
Jon Hall | 5b58673 | 2015-06-11 11:39:39 -0700 | [diff] [blame] | 36 | import threading |
Jeremy Ronquillo | 15ff107 | 2017-07-17 10:55:46 -0700 | [diff] [blame] | 37 | import pdb |
Jon Hall | 714eeba | 2015-09-29 17:53:10 -0700 | [diff] [blame] | 38 | module = new.module( "test" ) |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 39 | import openspeak |
Hari Krishna | be4b97b | 2015-07-15 12:19:43 -0700 | [diff] [blame] | 40 | import subprocess |
Jon Hall | 714eeba | 2015-09-29 17:53:10 -0700 | [diff] [blame] | 41 | global path, drivers_path, core_path, tests_path, logs_path |
Jon Hall | 4450624 | 2015-07-29 17:40:26 -0700 | [diff] [blame] | 42 | location = os.path.abspath( os.path.dirname( __file__ ) ) |
| 43 | path = re.sub( "(core|bin)$", "", location ) |
Jon Hall | 714eeba | 2015-09-29 17:53:10 -0700 | [diff] [blame] | 44 | drivers_path = path + "drivers" |
| 45 | core_path = path + "core" |
| 46 | tests_path = path + "tests" |
| 47 | logs_path = path + "logs/" |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 48 | config_path = path + "config/" |
Jon Hall | 4450624 | 2015-07-29 17:40:26 -0700 | [diff] [blame] | 49 | sys.path.append( path ) |
| 50 | sys.path.append( drivers_path ) |
| 51 | sys.path.append( core_path ) |
| 52 | sys.path.append( tests_path ) |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 53 | |
| 54 | from core.utilities import Utilities |
kelvin-onlab | fb52166 | 2015-02-27 09:52:40 -0800 | [diff] [blame] | 55 | from core.Thread import Thread |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 56 | |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 57 | |
Jon Hall | ca31989 | 2017-06-15 15:25:22 -0700 | [diff] [blame] | 58 | class SkipCase( Exception ): |
| 59 | pass |
| 60 | |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 61 | |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 62 | class TestON: |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 63 | |
| 64 | """ |
kelvin-onlab | f70fd54 | 2015-05-07 18:41:40 -0700 | [diff] [blame] | 65 | TestON will initiate the specified test. |
Jon Hall | 714eeba | 2015-09-29 17:53:10 -0700 | [diff] [blame] | 66 | The main tasks are: |
kelvin-onlab | f70fd54 | 2015-05-07 18:41:40 -0700 | [diff] [blame] | 67 | * Initiate the required Component handles for the test. |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 68 | * Create Log file Handles. |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 69 | """ |
Jon Hall | 714eeba | 2015-09-29 17:53:10 -0700 | [diff] [blame] | 70 | def __init__( self, options ): |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 71 | """ |
Jon Hall | 714eeba | 2015-09-29 17:53:10 -0700 | [diff] [blame] | 72 | Initialise the component handles specified in the topology file of |
| 73 | the specified test. |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 74 | """ |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 75 | # Initialization of the variables. |
| 76 | __builtin__.main = self |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 77 | __builtin__.path = path |
| 78 | __builtin__.utilities = Utilities() |
| 79 | self.TRUE = 1 |
| 80 | self.FALSE = 0 |
| 81 | self.ERROR = -1 |
kelvin-onlab | f70fd54 | 2015-05-07 18:41:40 -0700 | [diff] [blame] | 82 | self.NORESULT = 2 |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 83 | self.FAIL = False |
| 84 | self.PASS = True |
kelvin-onlab | f70fd54 | 2015-05-07 18:41:40 -0700 | [diff] [blame] | 85 | self.CASERESULT = self.ERROR |
| 86 | self.STEPRESULT = self.NORESULT |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 87 | self.init_result = self.TRUE |
| 88 | self.testResult = "Summary" |
kelvin-onlab | f70fd54 | 2015-05-07 18:41:40 -0700 | [diff] [blame] | 89 | self.stepName = "" |
| 90 | self.stepCache = "" |
Jon Hall | d61331b | 2015-02-17 16:35:47 -0800 | [diff] [blame] | 91 | self.EXPERIMENTAL_MODE = False |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 92 | self.test_target = None |
| 93 | self.lastcommand = None |
Jon Hall | d61331b | 2015-02-17 16:35:47 -0800 | [diff] [blame] | 94 | self.testDir = tests_path |
| 95 | self.configFile = config_path + "teston.cfg" |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 96 | self.parsingClass = "xmlparser" |
| 97 | self.parserPath = core_path + "/xmlparser" |
| 98 | self.loggerPath = core_path + "/logger" |
| 99 | self.loggerClass = "Logger" |
| 100 | self.logs_path = logs_path |
| 101 | self.driver = '' |
kelvin-onlab | fb52166 | 2015-02-27 09:52:40 -0800 | [diff] [blame] | 102 | self.Thread = Thread |
Jon Hall | 5b58673 | 2015-06-11 11:39:39 -0700 | [diff] [blame] | 103 | self.cleanupFlag = False |
| 104 | self.cleanupLock = threading.Lock() |
Jon Hall | 0fc0d45 | 2015-07-14 09:49:58 -0700 | [diff] [blame] | 105 | self.initiated = False |
Devin Lim | ec98979 | 2017-08-15 15:57:55 -0700 | [diff] [blame] | 106 | self.executedCase = [] |
| 107 | self.leftCase = [] |
| 108 | self.failedCase = [] |
| 109 | self.noResultCase = [] |
Jon Hall | 65844a3 | 2015-03-09 19:09:37 -0700 | [diff] [blame] | 110 | |
Jon Hall | 2507978 | 2015-10-13 13:54:39 -0700 | [diff] [blame] | 111 | self.config = self.configparser() |
Jon Hall | 714eeba | 2015-09-29 17:53:10 -0700 | [diff] [blame] | 112 | verifyOptions( options ) |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 113 | load_logger() |
| 114 | self.componentDictionary = {} |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 115 | self.componentDictionary = self.topology[ 'COMPONENT' ] |
Jon Hall | 714eeba | 2015-09-29 17:53:10 -0700 | [diff] [blame] | 116 | self.driversList = [] |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 117 | if isinstance( self.componentDictionary, str ): |
Jon Hall | 714eeba | 2015-09-29 17:53:10 -0700 | [diff] [blame] | 118 | self.componentDictionary = dict( self.componentDictionary ) |
Jon Hall | 65844a3 | 2015-03-09 19:09:37 -0700 | [diff] [blame] | 119 | |
Jon Hall | 714eeba | 2015-09-29 17:53:10 -0700 | [diff] [blame] | 120 | for component in self.componentDictionary: |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 121 | self.driversList.append( self.componentDictionary[ component ][ 'type' ] ) |
Jon Hall | 65844a3 | 2015-03-09 19:09:37 -0700 | [diff] [blame] | 122 | |
Jon Hall | 714eeba | 2015-09-29 17:53:10 -0700 | [diff] [blame] | 123 | self.driversList = list( set( self.driversList ) ) # Removing duplicates. |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 124 | # Checking the test_target option set for the component or not |
Jon Hall | 714eeba | 2015-09-29 17:53:10 -0700 | [diff] [blame] | 125 | if isinstance( self.componentDictionary, dict ): |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 126 | for component in self.componentDictionary.keys(): |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 127 | if 'test_target' in self.componentDictionary[ component ].keys(): |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 128 | self.test_target = component |
Jon Hall | 65844a3 | 2015-03-09 19:09:37 -0700 | [diff] [blame] | 129 | |
Jon Hall | d61331b | 2015-02-17 16:35:47 -0800 | [diff] [blame] | 130 | # Checking for the openspeak file and test script |
Jon Hall | 714eeba | 2015-09-29 17:53:10 -0700 | [diff] [blame] | 131 | self.logger.initlog( self ) |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 132 | |
| 133 | # Creating Drivers Handles |
Jon Hall | 714eeba | 2015-09-29 17:53:10 -0700 | [diff] [blame] | 134 | initString = "\n" + "*" * 30 + "\n CASE INIT \n" + "*" * 30 + "\n" |
| 135 | self.log.exact( initString ) |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 136 | self.driverObject = {} |
Jon Hall | 714eeba | 2015-09-29 17:53:10 -0700 | [diff] [blame] | 137 | self.random_order = 111 # Random order id to connect the components |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 138 | components_connect_order = {} |
Jon Hall | 714eeba | 2015-09-29 17:53:10 -0700 | [diff] [blame] | 139 | if isinstance( self.componentDictionary, dict ): |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 140 | for component in self.componentDictionary.keys(): |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 141 | if 'connect_order' not in self.componentDictionary[ component ].keys(): |
| 142 | self.componentDictionary[ component ][ 'connect_order' ] = str( self.get_random() ) |
| 143 | components_connect_order[ component ] = eval( self.componentDictionary[ component ][ 'connect_order' ] ) |
Jon Hall | 714eeba | 2015-09-29 17:53:10 -0700 | [diff] [blame] | 144 | # Ordering components based on the connect order. |
| 145 | ordered_component_list = sorted( components_connect_order, |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 146 | key=lambda key: components_connect_order[ key ] ) |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 147 | print ordered_component_list |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 148 | for component in ordered_component_list: |
Jon Hall | 714eeba | 2015-09-29 17:53:10 -0700 | [diff] [blame] | 149 | self.componentInit( component ) |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 150 | |
Jon Hall | 714eeba | 2015-09-29 17:53:10 -0700 | [diff] [blame] | 151 | def configparser( self ): |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 152 | """ |
| 153 | It will parse the config file ( teston.cfg ) and return as dictionary |
| 154 | """ |
Jon Hall | 714eeba | 2015-09-29 17:53:10 -0700 | [diff] [blame] | 155 | matchFileName = re.match( r'(.*)\.cfg', self.configFile, re.M | re.I ) |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 156 | if matchFileName: |
Jon Hall | 714eeba | 2015-09-29 17:53:10 -0700 | [diff] [blame] | 157 | xml = open( self.configFile ).read() |
| 158 | try: |
| 159 | self.configDict = xmldict.xml_to_dict( xml ) |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 160 | return self.configDict |
Jon Hall | 1306a56 | 2015-09-04 11:21:24 -0700 | [diff] [blame] | 161 | except IOError: |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 162 | print "There is no such file to parse " + self.configFile |
Jon Hall | 1306a56 | 2015-09-04 11:21:24 -0700 | [diff] [blame] | 163 | else: |
| 164 | print "There is no such file to parse " + self.configFile |
kelvin-onlab | f70fd54 | 2015-05-07 18:41:40 -0700 | [diff] [blame] | 165 | |
Jon Hall | 714eeba | 2015-09-29 17:53:10 -0700 | [diff] [blame] | 166 | def componentInit( self, component ): |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 167 | """ |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 168 | This method will initialize specified component |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 169 | """ |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 170 | global driver_options |
Jon Hall | 0fc0d45 | 2015-07-14 09:49:58 -0700 | [diff] [blame] | 171 | self.initiated = False |
Jon Hall | 714eeba | 2015-09-29 17:53:10 -0700 | [diff] [blame] | 172 | self.log.info( "Creating component Handle: " + component ) |
Jon Hall | d61331b | 2015-02-17 16:35:47 -0800 | [diff] [blame] | 173 | driver_options = {} |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 174 | if 'COMPONENTS' in self.componentDictionary[ component ].keys(): |
| 175 | driver_options = dict( self.componentDictionary[ component ][ 'COMPONENTS' ] ) |
| 176 | driver_options[ 'name' ] = component |
| 177 | driverName = self.componentDictionary[ component ][ 'type' ] |
| 178 | driver_options[ 'type' ] = driverName |
kelvin-onlab | f70fd54 | 2015-05-07 18:41:40 -0700 | [diff] [blame] | 179 | |
Jon Hall | 714eeba | 2015-09-29 17:53:10 -0700 | [diff] [blame] | 180 | classPath = self.getDriverPath( driverName.lower() ) |
| 181 | driverModule = importlib.import_module( classPath ) |
| 182 | driverClass = getattr( driverModule, driverName ) |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 183 | driverObject = driverClass() |
kelvin-onlab | f70fd54 | 2015-05-07 18:41:40 -0700 | [diff] [blame] | 184 | |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 185 | if "OCN" in self.componentDictionary[ component ][ 'host' ] and\ |
Jon Hall | 714eeba | 2015-09-29 17:53:10 -0700 | [diff] [blame] | 186 | main.onoscell: |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 187 | self.componentDictionary[ component ][ 'host' ] = main.mnIP |
Hari Krishna | be4b97b | 2015-07-15 12:19:43 -0700 | [diff] [blame] | 188 | |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 189 | user_name = self.componentDictionary[ component ].get( 'user', |
| 190 | getpass.getuser() ) |
| 191 | ip_address = self.componentDictionary[ component ].get( 'host', |
| 192 | 'localhost' ) |
| 193 | pwd = self.componentDictionary[ component ].get( 'password', |
| 194 | 'changeme' ) |
| 195 | port = self.componentDictionary[ component ].get( 'port' ) |
Jon Hall | 714eeba | 2015-09-29 17:53:10 -0700 | [diff] [blame] | 196 | connect_result = driverObject.connect( user_name=user_name, |
| 197 | ip_address=ip_address, |
| 198 | pwd=pwd, |
| 199 | port=port, |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 200 | options=driver_options ) |
cameron@onlab.us | 5cc6a37 | 2015-05-11 17:18:07 -0700 | [diff] [blame] | 201 | |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 202 | if not connect_result: |
Jon Hall | 714eeba | 2015-09-29 17:53:10 -0700 | [diff] [blame] | 203 | self.log.error( "Exiting from the test execution because connecting to the " + |
| 204 | component + " component failed." ) |
Jon Hall | d61331b | 2015-02-17 16:35:47 -0800 | [diff] [blame] | 205 | self.exit() |
kelvin-onlab | f70fd54 | 2015-05-07 18:41:40 -0700 | [diff] [blame] | 206 | |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 207 | vars( self )[ component ] = driverObject |
Jon Hall | 0fc0d45 | 2015-07-14 09:49:58 -0700 | [diff] [blame] | 208 | self.initiated = True |
Jon Hall | ca31989 | 2017-06-15 15:25:22 -0700 | [diff] [blame] | 209 | return driverObject |
kelvin-onlab | f70fd54 | 2015-05-07 18:41:40 -0700 | [diff] [blame] | 210 | |
Jon Hall | 714eeba | 2015-09-29 17:53:10 -0700 | [diff] [blame] | 211 | def run( self ): |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 212 | """ |
Jon Hall | 714eeba | 2015-09-29 17:53:10 -0700 | [diff] [blame] | 213 | The Execution of the test script's cases listed in the Test params |
| 214 | file will be done here then update each test case result. |
| 215 | This method will return main.TRUE if it executed all the test cases |
| 216 | successfully, else will retun main.FALSE |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 217 | """ |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 218 | self.testCaseResult = {} |
Jon Hall | a118598 | 2014-09-15 14:55:10 -0700 | [diff] [blame] | 219 | self.TOTAL_TC = 0 |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 220 | self.TOTAL_TC_RUN = 0 |
Jon Hall | d61331b | 2015-02-17 16:35:47 -0800 | [diff] [blame] | 221 | self.TOTAL_TC_PLANNED = 0 |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 222 | self.TOTAL_TC_NORESULT = 0 |
| 223 | self.TOTAL_TC_FAIL = 0 |
| 224 | self.TOTAL_TC_PASS = 0 |
Jon Hall | a118598 | 2014-09-15 14:55:10 -0700 | [diff] [blame] | 225 | self.TEST_ITERATION = 0 |
Jon Hall | 714eeba | 2015-09-29 17:53:10 -0700 | [diff] [blame] | 226 | |
| 227 | # NOTE: number of main.step statements in the |
| 228 | # outer most level of the test case. used to |
| 229 | # execute code in smaller steps |
| 230 | self.stepCount = 0 |
kelvin-onlab | f70fd54 | 2015-05-07 18:41:40 -0700 | [diff] [blame] | 231 | self.CASERESULT = self.NORESULT |
| 232 | |
Jon Hall | d61331b | 2015-02-17 16:35:47 -0800 | [diff] [blame] | 233 | import testparser |
Jon Hall | 53c5e66 | 2016-04-13 16:06:56 -0700 | [diff] [blame] | 234 | test = testparser.TestParser( main.testFile ) |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 235 | self.testscript = test.testscript |
| 236 | self.code = test.getStepCode() |
Jon Hall | 714eeba | 2015-09-29 17:53:10 -0700 | [diff] [blame] | 237 | repeat = int( self.params.get( 'repeat', 1 ) ) |
| 238 | self.TOTAL_TC_PLANNED = len( self.testcases_list ) * repeat |
kelvin-onlab | f70fd54 | 2015-05-07 18:41:40 -0700 | [diff] [blame] | 239 | |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 240 | result = self.TRUE |
Jon Hall | 714eeba | 2015-09-29 17:53:10 -0700 | [diff] [blame] | 241 | while repeat: |
Devin Lim | ec98979 | 2017-08-15 15:57:55 -0700 | [diff] [blame] | 242 | self.leftCase.extend( self.testcases_list ) |
Jon Hall | a118598 | 2014-09-15 14:55:10 -0700 | [diff] [blame] | 243 | for self.CurrentTestCaseNumber in self.testcases_list: |
Devin Lim | ec98979 | 2017-08-15 15:57:55 -0700 | [diff] [blame] | 244 | self.executedCase.append( self.leftCase.pop( 0 ) ) |
Jon Hall | 714eeba | 2015-09-29 17:53:10 -0700 | [diff] [blame] | 245 | result = self.runCase( self.CurrentTestCaseNumber ) |
| 246 | repeat -= 1 |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 247 | return result |
kelvin-onlab | f70fd54 | 2015-05-07 18:41:40 -0700 | [diff] [blame] | 248 | |
Jon Hall | e234cc4 | 2015-08-31 15:26:47 -0700 | [diff] [blame] | 249 | def runCase( self, testCaseNumber ): |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 250 | self.CurrentTestCaseNumber = testCaseNumber |
kelvin-onlab | f70fd54 | 2015-05-07 18:41:40 -0700 | [diff] [blame] | 251 | self.CurrentTestCase = "" |
Jon Hall | 714eeba | 2015-09-29 17:53:10 -0700 | [diff] [blame] | 252 | |
| 253 | # List of step results in a case. ANDed together to get the result |
| 254 | self.stepResultsList = [] |
kelvin-onlab | f70fd54 | 2015-05-07 18:41:40 -0700 | [diff] [blame] | 255 | self.stepName = "" |
Jon Hall | 783bbf9 | 2015-07-23 14:33:19 -0700 | [diff] [blame] | 256 | self.caseExplanation = "" |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 257 | result = self.TRUE |
Jon Hall | 714eeba | 2015-09-29 17:53:10 -0700 | [diff] [blame] | 258 | |
| 259 | # NOTE: number of main.step statements in the |
| 260 | # outer most level of the test case. used to |
| 261 | # execute code in smaller steps |
| 262 | self.stepCount = 0 |
| 263 | |
| 264 | # NOTE: This is the current number of main.step()'s executed |
| 265 | # in a case. Used for logging. |
| 266 | self.stepNumber = 0 |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 267 | self.EXPERIMENTAL_MODE = self.FALSE |
| 268 | self.addCaseHeader() |
Devin Lim | ec98979 | 2017-08-15 15:57:55 -0700 | [diff] [blame] | 269 | self.log.debug( "Case Executed : " + str( self.executedCase ) ) |
| 270 | self.log.debug( "Case to be executed : " + str( self.leftCase ) ) |
Jon Hall | e234cc4 | 2015-08-31 15:26:47 -0700 | [diff] [blame] | 271 | self.testCaseNumber = str( testCaseNumber ) |
| 272 | self.CASERESULT = self.NORESULT |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 273 | stopped = False |
Jon Hall | 5a72b71 | 2015-09-28 12:20:59 -0700 | [diff] [blame] | 274 | try: |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 275 | self.code[ self.testCaseNumber ] |
Jon Hall | d61331b | 2015-02-17 16:35:47 -0800 | [diff] [blame] | 276 | except KeyError: |
Jon Hall | e234cc4 | 2015-08-31 15:26:47 -0700 | [diff] [blame] | 277 | self.log.error( "There is no Test-Case " + self.testCaseNumber ) |
Jon Hall | febb1c7 | 2015-03-05 13:30:09 -0800 | [diff] [blame] | 278 | return self.FALSE |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 279 | self.stepCount = 0 |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 280 | while self.stepCount < len( self.code[ self.testCaseNumber ].keys() ): |
Jon Hall | 714eeba | 2015-09-29 17:53:10 -0700 | [diff] [blame] | 281 | result = self.runStep( self.code, self.testCaseNumber ) |
Jon Hall | febb1c7 | 2015-03-05 13:30:09 -0800 | [diff] [blame] | 282 | if result == self.FALSE: |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 283 | break |
Jon Hall | febb1c7 | 2015-03-05 13:30:09 -0800 | [diff] [blame] | 284 | elif result == self.TRUE: |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 285 | continue |
Jon Hall | 5a72b71 | 2015-09-28 12:20:59 -0700 | [diff] [blame] | 286 | # stepResults format: ( stepNo[], stepName[], stepResult[], onFail[] ) |
| 287 | stepResults = self.stepResultsList |
Jon Hall | e234cc4 | 2015-08-31 15:26:47 -0700 | [diff] [blame] | 288 | if not stopped: |
| 289 | if self.CASERESULT == self.TRUE or self.CASERESULT == self.FALSE: |
Jon Hall | 714eeba | 2015-09-29 17:53:10 -0700 | [diff] [blame] | 290 | # Result was already explitily set somewhere else like |
| 291 | # in skipCase() |
Jon Hall | e234cc4 | 2015-08-31 15:26:47 -0700 | [diff] [blame] | 292 | pass |
Jon Hall | 5a72b71 | 2015-09-28 12:20:59 -0700 | [diff] [blame] | 293 | elif all( self.TRUE == i for i in stepResults ): |
kelvin-onlab | f70fd54 | 2015-05-07 18:41:40 -0700 | [diff] [blame] | 294 | # ALL PASSED |
| 295 | self.CASERESULT = self.TRUE |
Jon Hall | 5a72b71 | 2015-09-28 12:20:59 -0700 | [diff] [blame] | 296 | elif self.FALSE in stepResults: |
kelvin-onlab | f70fd54 | 2015-05-07 18:41:40 -0700 | [diff] [blame] | 297 | # AT LEAST ONE FAILED |
| 298 | self.CASERESULT = self.FALSE |
Jon Hall | 5a72b71 | 2015-09-28 12:20:59 -0700 | [diff] [blame] | 299 | elif self.TRUE in stepResults: |
kelvin-onlab | f70fd54 | 2015-05-07 18:41:40 -0700 | [diff] [blame] | 300 | # AT LEAST ONE PASSED |
| 301 | self.CASERESULT = self.TRUE |
| 302 | else: |
| 303 | self.CASERESULT = self.NORESULT |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 304 | self.testCaseResult[ str( self.CurrentTestCaseNumber ) ] = self.CASERESULT |
Devin Lim | ec98979 | 2017-08-15 15:57:55 -0700 | [diff] [blame] | 305 | self.organizeResult( self.CurrentTestCaseNumber, self.CASERESULT ) |
Jon Hall | 714eeba | 2015-09-29 17:53:10 -0700 | [diff] [blame] | 306 | self.logger.updateCaseResults( self ) |
Jon Hall | 783bbf9 | 2015-07-23 14:33:19 -0700 | [diff] [blame] | 307 | self.log.wiki( "<p>" + self.caseExplanation + "</p>" ) |
| 308 | self.log.summary( self.caseExplanation ) |
kelvin-onlab | f70fd54 | 2015-05-07 18:41:40 -0700 | [diff] [blame] | 309 | self.log.wiki( "<ul>" ) |
acsmars | e2d1ed1 | 2015-10-05 13:51:17 -0700 | [diff] [blame] | 310 | subcaseMessage = False |
kelvin-onlab | f70fd54 | 2015-05-07 18:41:40 -0700 | [diff] [blame] | 311 | for line in self.stepCache.splitlines(): |
acsmars | e2d1ed1 | 2015-10-05 13:51:17 -0700 | [diff] [blame] | 312 | if re.search( "[0-9]\.[0-9]", line ): # Step |
| 313 | if subcaseMessage: # End of Failure Message Printout |
| 314 | self.log.wiki( "</ul>\n" ) |
| 315 | subcaseMessage = False |
| 316 | if re.search( " - PASS$", line ): |
| 317 | self.log.wiki( "<li>" + line + " <ac:emoticon ac:name=\"tick\" /></li>\n" ) |
| 318 | elif re.search( " - FAIL$", line ): |
| 319 | self.log.wiki( "<li>" + line + " <ac:emoticon ac:name=\"cross\" /></li>\n" ) |
| 320 | elif re.search( " - No Result$", line ): |
| 321 | self.log.wiki( "<li>" + line + " <ac:emoticon ac:name=\"warning\" /></li>\n" ) |
| 322 | else: # Substep |
| 323 | if not subcaseMessage: # Open Failure Message Printout |
| 324 | self.log.wiki( "<ul><li>" + line + "</li>\n" ) |
| 325 | subcaseMessage = True |
| 326 | else: # Add to Failure Message Printout |
| 327 | self.log.wiki( "<li>" + line + "</li>\n" ) |
acsmars | 27e62dd | 2015-10-06 11:35:47 -0700 | [diff] [blame] | 328 | if subcaseMessage: # End of Failure Message Printout for last item |
| 329 | self.log.wiki( "</ul>\n" ) |
kelvin-onlab | f70fd54 | 2015-05-07 18:41:40 -0700 | [diff] [blame] | 330 | self.log.wiki( "</ul>" ) |
| 331 | self.log.summary( self.stepCache ) |
| 332 | self.stepCache = "" |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 333 | return result |
kelvin-onlab | f70fd54 | 2015-05-07 18:41:40 -0700 | [diff] [blame] | 334 | |
Devin Lim | ec98979 | 2017-08-15 15:57:55 -0700 | [diff] [blame] | 335 | def organizeResult( self, caseNum, result ): |
| 336 | """ |
| 337 | Organize the result and put the current number into either |
| 338 | failed/noResult lists. |
| 339 | * caseNum - number of the case |
| 340 | * result - result of the case |
| 341 | """ |
| 342 | if result == main.FALSE: |
| 343 | self.failedCase.append( caseNum ) |
| 344 | elif result == self.NORESULT: |
| 345 | self.noResultCase.append( caseNum ) |
| 346 | |
Jon Hall | 714eeba | 2015-09-29 17:53:10 -0700 | [diff] [blame] | 347 | def runStep( self, code, testCaseNumber ): |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 348 | if not cli.pause: |
Jon Hall | 5a72b71 | 2015-09-28 12:20:59 -0700 | [diff] [blame] | 349 | try: |
| 350 | step = self.stepCount |
| 351 | # stepResults format: ( stepNo, stepName, stepResult, onFail ) |
| 352 | # NOTE: This is needed to catch results of main.step()'s |
| 353 | # called inside functions or loops |
| 354 | self.stepResults = ( [], [], [], [] ) |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 355 | exec code[ testCaseNumber ][ step ] in module.__dict__ |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 356 | self.stepCount = self.stepCount + 1 |
Jon Hall | 96b816f | 2015-11-03 12:00:56 -0800 | [diff] [blame] | 357 | self.parseStepResults( testCaseNumber ) |
Jon Hall | ca31989 | 2017-06-15 15:25:22 -0700 | [diff] [blame] | 358 | except SkipCase: # Raised in self.skipCase() |
Jon Hall | e234cc4 | 2015-08-31 15:26:47 -0700 | [diff] [blame] | 359 | self.log.warn( "Skipping the rest of CASE" + |
| 360 | str( testCaseNumber ) ) |
Jon Hall | 96b816f | 2015-11-03 12:00:56 -0800 | [diff] [blame] | 361 | self.parseStepResults( testCaseNumber ) |
Jon Hall | 714eeba | 2015-09-29 17:53:10 -0700 | [diff] [blame] | 362 | self.stepResultsList.append( self.STEPRESULT ) |
Jon Hall | e234cc4 | 2015-08-31 15:26:47 -0700 | [diff] [blame] | 363 | self.stepCache += "\t\t" + self.onFailMsg + "\n" |
| 364 | self.stepCount = self.stepCount + 1 |
| 365 | return self.FALSE |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 366 | except Exception as e: |
Jon Hall | c160635 | 2015-10-06 14:51:36 -0700 | [diff] [blame] | 367 | try: |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 368 | stepNo = self.stepResults[ 0 ][ self.stepNumber - 1 ] |
Jon Hall | c160635 | 2015-10-06 14:51:36 -0700 | [diff] [blame] | 369 | except IndexError: |
| 370 | stepNo = "<IndexError>" |
| 371 | main.log.warn( "Error trying to get step number. " + |
| 372 | "It is likely between step " + |
Jon Hall | 6e70975 | 2016-02-01 13:38:46 -0800 | [diff] [blame] | 373 | str( self.stepNumber ) + " and step " + |
Jon Hall | c160635 | 2015-10-06 14:51:36 -0700 | [diff] [blame] | 374 | str( self.stepNumber + 1 ) ) |
| 375 | try: |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 376 | stepName = self.stepResults[ 1 ][ self.stepNumber - 1 ] |
Jon Hall | c160635 | 2015-10-06 14:51:36 -0700 | [diff] [blame] | 377 | except IndexError: |
| 378 | stepName = "<IndexError>" |
| 379 | self.log.error( "\nException in the following section of" + |
| 380 | " code: " + str( testCaseNumber ) + "." + |
| 381 | str( stepNo ) + ": " + stepName ) |
Jeremy | d9e4eb1 | 2016-04-13 12:09:06 -0700 | [diff] [blame] | 382 | self.log.error( str( e.__class__ ) + str( e.message ) ) |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 383 | self.stepCount = self.stepCount + 1 |
Jon Hall | 714eeba | 2015-09-29 17:53:10 -0700 | [diff] [blame] | 384 | self.logger.updateCaseResults( self ) |
| 385 | # WIKI results |
kelvin-onlab | f70fd54 | 2015-05-07 18:41:40 -0700 | [diff] [blame] | 386 | self.log.wiki( "<ul>" ) |
| 387 | for line in self.stepCache.splitlines(): |
| 388 | if re.search( " - PASS$", line ): |
| 389 | self.log.wiki( "<li>" + line + " <ac:emoticon ac:name=\"tick\" /></li>\n" ) |
| 390 | elif re.search( " - FAIL$", line ): |
| 391 | self.log.wiki( "<li>" + line + " <ac:emoticon ac:name=\"cross\" /></li>\n" ) |
| 392 | elif re.search( " - No Result$", line ): |
| 393 | self.log.wiki( "<li>" + line + " <ac:emoticon ac:name=\"warning\" /></li>\n" ) |
Jon Hall | 9062761 | 2015-06-09 14:57:02 -0700 | [diff] [blame] | 394 | else: # Should only be on fail message |
| 395 | self.log.wiki( "<ul><li>" + line + "</li></ul>\n" ) |
kelvin-onlab | f70fd54 | 2015-05-07 18:41:40 -0700 | [diff] [blame] | 396 | self.log.wiki( "</ul>" ) |
Jon Hall | 714eeba | 2015-09-29 17:53:10 -0700 | [diff] [blame] | 397 | # summary results |
kelvin-onlab | f70fd54 | 2015-05-07 18:41:40 -0700 | [diff] [blame] | 398 | self.log.summary( self.stepCache ) |
| 399 | self.stepCache = "" |
shahshreya | 957feaa | 2015-03-23 16:08:29 -0700 | [diff] [blame] | 400 | self.cleanup() |
Jon Hall | 00539b1 | 2015-04-03 13:55:46 -0700 | [diff] [blame] | 401 | self.exit() |
Jon Hall | e234cc4 | 2015-08-31 15:26:47 -0700 | [diff] [blame] | 402 | return self.TRUE |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 403 | if cli.stop: |
| 404 | cli.stop = False |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 405 | self.TOTAL_TC_NORESULT = self.TOTAL_TC_NORESULT + 1 |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 406 | self.testCaseResult[ str( self.CurrentTestCaseNumber ) ] = "Stopped" |
Jon Hall | 714eeba | 2015-09-29 17:53:10 -0700 | [diff] [blame] | 407 | self.logger.updateCaseResults( self ) |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 408 | result = self.cleanup() |
Jon Hall | e234cc4 | 2015-08-31 15:26:47 -0700 | [diff] [blame] | 409 | return self.FALSE |
| 410 | |
Jon Hall | 96b816f | 2015-11-03 12:00:56 -0800 | [diff] [blame] | 411 | def parseStepResults( self, testCaseNumber ): |
| 412 | """ |
| 413 | Parse throught the step results for the wiki |
| 414 | """ |
| 415 | try: |
| 416 | # Iterate through each of the steps and print them |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 417 | for index in range( len( self.stepResults[ 0 ] ) ): |
Jon Hall | 96b816f | 2015-11-03 12:00:56 -0800 | [diff] [blame] | 418 | # stepResults = ( stepNo, stepName, stepResult, onFail ) |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 419 | stepNo = self.stepResults[ 0 ][ index ] |
| 420 | stepName = self.stepResults[ 1 ][ index ] |
| 421 | stepResult = self.stepResults[ 2 ][ index ] |
| 422 | onFail = self.stepResults[ 3 ][ index ] |
Jon Hall | 96b816f | 2015-11-03 12:00:56 -0800 | [diff] [blame] | 423 | self.stepCache += "\t" + str( testCaseNumber ) + "." |
| 424 | self.stepCache += str( stepNo ) + " " |
| 425 | self.stepCache += stepName + " - " |
| 426 | if stepResult == self.TRUE: |
| 427 | self.stepCache += "PASS\n" |
| 428 | elif stepResult == self.FALSE: |
| 429 | self.stepCache += "FAIL\n" |
| 430 | self.stepCache += "\t\t" + onFail + "\n" |
| 431 | else: |
| 432 | self.stepCache += "No Result\n" |
| 433 | self.stepResultsList.append( stepResult ) |
| 434 | except Exception: |
| 435 | self.log.exception( "Error parsing step results" ) |
| 436 | |
Jon Hall | e234cc4 | 2015-08-31 15:26:47 -0700 | [diff] [blame] | 437 | def skipCase( self, result="DEFAULT", msg=None ): |
| 438 | """ |
| 439 | Will skip the rest of the code in a test case. The case results will be |
| 440 | determined as normal based on completed assertions unless the result |
| 441 | argument is given. |
| 442 | |
| 443 | Optional Arguments: |
Jon Hall | 7c4f430 | 2016-07-15 14:39:02 -0700 | [diff] [blame] | 444 | result: Case insensitive string. Can be 'PASS' or 'FAIL' and will set |
Jon Hall | e234cc4 | 2015-08-31 15:26:47 -0700 | [diff] [blame] | 445 | the case result accordingly. |
| 446 | msg: Message to be printed when the case is skipped in the reports. |
| 447 | """ |
| 448 | result = result.upper().strip() |
| 449 | if result == "PASS": |
| 450 | self.CASERESULT = self.TRUE |
| 451 | elif result == "FAIL": |
| 452 | self.CASERESULT = self.FALSE |
| 453 | self.onFailMsg = "Skipping the rest of this case. " |
| 454 | if msg: |
| 455 | self.onFailMsg += str( msg ) |
Jon Hall | ca31989 | 2017-06-15 15:25:22 -0700 | [diff] [blame] | 456 | raise SkipCase |
kelvin-onlab | f70fd54 | 2015-05-07 18:41:40 -0700 | [diff] [blame] | 457 | |
Jon Hall | 714eeba | 2015-09-29 17:53:10 -0700 | [diff] [blame] | 458 | def addCaseHeader( self ): |
| 459 | caseHeader = "\n" + "*" * 30 + "\n Result summary for Testcase" +\ |
| 460 | str( self.CurrentTestCaseNumber ) + "\n" + "*" * 30 + "\n" |
| 461 | self.log.exact( caseHeader ) |
| 462 | caseHeader = "\n" + "*" * 40 + "\nStart of Test Case" +\ |
| 463 | str( self.CurrentTestCaseNumber ) + " : " |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 464 | for driver in self.componentDictionary.keys(): |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 465 | vars( self )[ driver + 'log' ].info( caseHeader ) |
kelvin-onlab | f70fd54 | 2015-05-07 18:41:40 -0700 | [diff] [blame] | 466 | |
Jon Hall | 714eeba | 2015-09-29 17:53:10 -0700 | [diff] [blame] | 467 | def addCaseFooter( self ): |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 468 | stepNo = self.stepResults[ 0 ][ -2 ] |
Jon Hall | 714eeba | 2015-09-29 17:53:10 -0700 | [diff] [blame] | 469 | if stepNo > 0: |
| 470 | previousStep = " " + str( self.CurrentTestCaseNumber ) + "." +\ |
| 471 | str( stepNo ) + ": " + str( self.stepName ) |
| 472 | stepHeader = "\n" + "*" * 40 + "\nEnd of Step " + previousStep +\ |
| 473 | "\n" + "*" * 40 + "\n" |
kelvin-onlab | f70fd54 | 2015-05-07 18:41:40 -0700 | [diff] [blame] | 474 | |
Jon Hall | 714eeba | 2015-09-29 17:53:10 -0700 | [diff] [blame] | 475 | caseFooter = "\n" + "*" * 40 + "\nEnd of Test case " +\ |
| 476 | str( self.CurrentTestCaseNumber ) + "\n" + "*" * 40 + "\n" |
kelvin-onlab | f70fd54 | 2015-05-07 18:41:40 -0700 | [diff] [blame] | 477 | |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 478 | for driver in self.driversList: |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 479 | vars( self )[ driver ].write( stepHeader + "\n" + caseFooter ) |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 480 | |
Jon Hall | 714eeba | 2015-09-29 17:53:10 -0700 | [diff] [blame] | 481 | def cleanup( self ): |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 482 | """ |
Jon Hall | 5b58673 | 2015-06-11 11:39:39 -0700 | [diff] [blame] | 483 | Print a summary of the current test's results then attempt to release |
| 484 | all the component handles and the close opened file handles. |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 485 | |
Jon Hall | 5b58673 | 2015-06-11 11:39:39 -0700 | [diff] [blame] | 486 | This function shouldbe threadsafe such that cleanup will only be |
| 487 | executed once per test. |
| 488 | |
| 489 | This will return TRUE if all the component handles and log handles |
| 490 | closed properly, else return FALSE. |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 491 | """ |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 492 | result = self.TRUE |
Jon Hall | 5b58673 | 2015-06-11 11:39:39 -0700 | [diff] [blame] | 493 | lock = self.cleanupLock |
| 494 | if lock.acquire( False ): |
| 495 | try: |
| 496 | if self.cleanupFlag is False: # First thread to run this |
| 497 | self.cleanupFlag = True |
Jon Hall | 0fc0d45 | 2015-07-14 09:49:58 -0700 | [diff] [blame] | 498 | if self.initiated: |
Jon Hall | 714eeba | 2015-09-29 17:53:10 -0700 | [diff] [blame] | 499 | self.logger.testSummary( self ) |
Jon Hall | 892818c | 2015-10-20 17:58:34 -0700 | [diff] [blame] | 500 | components = self.componentDictionary |
| 501 | for component in sorted( components, |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 502 | key=lambda item: components[ item ][ 'connect_order' ], |
Jon Hall | 892818c | 2015-10-20 17:58:34 -0700 | [diff] [blame] | 503 | reverse=True ): |
Jon Hall | 714eeba | 2015-09-29 17:53:10 -0700 | [diff] [blame] | 504 | try: |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 505 | tempObject = vars( self )[ component ] |
Jon Hall | 714eeba | 2015-09-29 17:53:10 -0700 | [diff] [blame] | 506 | print "Disconnecting from " + str( tempObject.name ) +\ |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 507 | ": " + str( tempObject.__class__ ) |
Jon Hall | 5b58673 | 2015-06-11 11:39:39 -0700 | [diff] [blame] | 508 | tempObject.disconnect() |
Jon Hall | 1306a56 | 2015-09-04 11:21:24 -0700 | [diff] [blame] | 509 | except KeyboardInterrupt: |
| 510 | pass |
| 511 | except KeyError: |
| 512 | # Component not created yet |
| 513 | self.log.warn( "Could not find the component " + |
| 514 | str( component ) ) |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 515 | except Exception: |
Jon Hall | 5b58673 | 2015-06-11 11:39:39 -0700 | [diff] [blame] | 516 | self.log.exception( "Exception while disconnecting from " + |
| 517 | str( component ) ) |
| 518 | result = self.FALSE |
| 519 | # Closing all the driver's session files |
| 520 | for driver in self.componentDictionary.keys(): |
| 521 | try: |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 522 | vars( self )[ driver ].close_log_handles() |
Jon Hall | 1306a56 | 2015-09-04 11:21:24 -0700 | [diff] [blame] | 523 | except KeyboardInterrupt: |
| 524 | pass |
| 525 | except KeyError: |
| 526 | # Component not created yet |
| 527 | self.log.warn( "Could not find the component " + |
| 528 | str( driver ) + " while trying to" + |
| 529 | " close log file" ) |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 530 | except Exception: |
Jon Hall | 5b58673 | 2015-06-11 11:39:39 -0700 | [diff] [blame] | 531 | self.log.exception( "Exception while closing log files for " + |
| 532 | str( driver ) ) |
| 533 | result = self.FALSE |
| 534 | else: |
| 535 | pass # Someone else already ran through this function |
| 536 | finally: |
| 537 | lock.release() |
| 538 | else: # Someone already has a lock |
| 539 | # NOTE: This could cause problems if we don't release the lock |
| 540 | # correctly |
| 541 | lock.acquire() # Wait for the other thread to finish |
| 542 | # NOTE: If we don't wait, exit could be called while the thread |
| 543 | # with the lock is still cleaning up |
| 544 | lock.release() |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 545 | return result |
Jon Hall | d61331b | 2015-02-17 16:35:47 -0800 | [diff] [blame] | 546 | |
Jon Hall | 714eeba | 2015-09-29 17:53:10 -0700 | [diff] [blame] | 547 | def pause( self ): |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 548 | """ |
Jon Hall | 714eeba | 2015-09-29 17:53:10 -0700 | [diff] [blame] | 549 | This function will pause the test's execution, and will continue after |
| 550 | user provide 'resume' command. |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 551 | """ |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 552 | __builtin__.testthread.pause() |
kelvin-onlab | f70fd54 | 2015-05-07 18:41:40 -0700 | [diff] [blame] | 553 | |
Jon Hall | 714eeba | 2015-09-29 17:53:10 -0700 | [diff] [blame] | 554 | def onfail( self, *components ): |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 555 | """ |
kelvin-onlab | f70fd54 | 2015-05-07 18:41:40 -0700 | [diff] [blame] | 556 | When test step failed, calling all the components onfail. |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 557 | """ |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 558 | if not components: |
Jon Hall | 714eeba | 2015-09-29 17:53:10 -0700 | [diff] [blame] | 559 | try: |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 560 | for component in self.componentDictionary.keys(): |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 561 | tempObject = vars( self )[ component ] |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 562 | result = tempObject.onfail() |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 563 | except Exception as e: |
Jon Hall | 714eeba | 2015-09-29 17:53:10 -0700 | [diff] [blame] | 564 | print str( e ) |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 565 | result = self.FALSE |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 566 | else: |
Jon Hall | 714eeba | 2015-09-29 17:53:10 -0700 | [diff] [blame] | 567 | try: |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 568 | for component in components: |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 569 | tempObject = vars( self )[ component ] |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 570 | result = tempObject.onfail() |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 571 | except Exception as e: |
Jon Hall | 714eeba | 2015-09-29 17:53:10 -0700 | [diff] [blame] | 572 | print str( e ) |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 573 | result = self.FALSE |
kelvin-onlab | f70fd54 | 2015-05-07 18:41:40 -0700 | [diff] [blame] | 574 | |
Jon Hall | 714eeba | 2015-09-29 17:53:10 -0700 | [diff] [blame] | 575 | def getDriverPath( self, driverName ): |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 576 | """ |
Jon Hall | 714eeba | 2015-09-29 17:53:10 -0700 | [diff] [blame] | 577 | Based on the component 'type' specified in the params , this method |
| 578 | will find the absolute path, by recursively searching the name of |
| 579 | the component. |
| 580 | |
| 581 | NOTE: This function requires the linux 'find' command. |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 582 | """ |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 583 | import commands |
| 584 | |
Jon Hall | 714eeba | 2015-09-29 17:53:10 -0700 | [diff] [blame] | 585 | cmd = "find " + drivers_path + " -name " + driverName + ".py" |
| 586 | result = commands.getoutput( cmd ) |
kelvin-onlab | f70fd54 | 2015-05-07 18:41:40 -0700 | [diff] [blame] | 587 | |
Jon Hall | 714eeba | 2015-09-29 17:53:10 -0700 | [diff] [blame] | 588 | result_array = str( result ).split( '\n' ) |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 589 | result_count = 0 |
kelvin-onlab | f70fd54 | 2015-05-07 18:41:40 -0700 | [diff] [blame] | 590 | |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 591 | for drivers_list in result_array: |
Jon Hall | 714eeba | 2015-09-29 17:53:10 -0700 | [diff] [blame] | 592 | result_count = result_count + 1 |
| 593 | if result_count > 1: |
| 594 | print "Found " + driverName + " " + str( result_count ) + " times:" |
| 595 | print str( result_array ) |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 596 | self.exit() |
kelvin-onlab | f70fd54 | 2015-05-07 18:41:40 -0700 | [diff] [blame] | 597 | |
Jon Hall | 714eeba | 2015-09-29 17:53:10 -0700 | [diff] [blame] | 598 | result = re.sub( "(.*)drivers", "", result ) |
| 599 | result = re.sub( "\/\/", "/", result ) |
| 600 | result = re.sub( "\.py", "", result ) |
| 601 | result = re.sub( "\.pyc", "", result ) |
| 602 | result = re.sub( "\/", ".", result ) |
| 603 | result = "drivers" + result |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 604 | return result |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 605 | |
Jon Hall | 714eeba | 2015-09-29 17:53:10 -0700 | [diff] [blame] | 606 | def step( self, stepDesc ): |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 607 | """ |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 608 | The step information of the test-case will append to the logs. |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 609 | """ |
Jon Hall | 714eeba | 2015-09-29 17:53:10 -0700 | [diff] [blame] | 610 | previousStep = " " + str( self.CurrentTestCaseNumber ) + "." +\ |
| 611 | str( self.stepNumber ) + ": " + str( self.stepName ) |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 612 | self.stepName = stepDesc |
Jon Hall | 5a72b71 | 2015-09-28 12:20:59 -0700 | [diff] [blame] | 613 | self.stepNumber += 1 |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 614 | self.stepResults[ 0 ].append( self.stepNumber ) |
| 615 | self.stepResults[ 1 ].append( stepDesc ) |
| 616 | self.stepResults[ 2 ].append( self.NORESULT ) |
| 617 | self.stepResults[ 3 ].append( "No on fail message given" ) |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 618 | |
Jon Hall | 714eeba | 2015-09-29 17:53:10 -0700 | [diff] [blame] | 619 | stepName = " " + str( self.CurrentTestCaseNumber ) + "." +\ |
| 620 | str( self.stepNumber ) + ": " + str( stepDesc ) |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 621 | self.log.step( stepName ) |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 622 | stepHeader = "" |
Jon Hall | 714eeba | 2015-09-29 17:53:10 -0700 | [diff] [blame] | 623 | line = "\n" + "-" * 45 + "\n" |
| 624 | if self.stepNumber > 1: |
| 625 | stepHeader = line + "End of Step " + previousStep + line |
| 626 | stepHeader += line + "Start of Step" + stepName + line |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 627 | for driver in self.componentDictionary.keys(): |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 628 | vars( self )[ driver + 'log' ].info( stepHeader ) |
kelvin-onlab | f70fd54 | 2015-05-07 18:41:40 -0700 | [diff] [blame] | 629 | |
Jon Hall | 714eeba | 2015-09-29 17:53:10 -0700 | [diff] [blame] | 630 | def case( self, testCaseName ): |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 631 | """ |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 632 | Test's each test-case information will append to the logs. |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 633 | """ |
Jon Hall | d61331b | 2015-02-17 16:35:47 -0800 | [diff] [blame] | 634 | self.CurrentTestCase = testCaseName |
Jon Hall | 714eeba | 2015-09-29 17:53:10 -0700 | [diff] [blame] | 635 | testCaseName = " " + str( testCaseName ) |
| 636 | self.log.case( testCaseName ) |
| 637 | caseHeader = testCaseName + "\n" + "*" * 40 + "\n" |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 638 | for driver in self.componentDictionary.keys(): |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 639 | vars( self )[ driver + 'log' ].info( caseHeader ) |
kelvin-onlab | f70fd54 | 2015-05-07 18:41:40 -0700 | [diff] [blame] | 640 | |
Jon Hall | 714eeba | 2015-09-29 17:53:10 -0700 | [diff] [blame] | 641 | def testDesc( self, description ): |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 642 | """ |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 643 | Test description will append to the logs. |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 644 | """ |
Jon Hall | 714eeba | 2015-09-29 17:53:10 -0700 | [diff] [blame] | 645 | description = "Test Description : " + str( description ) |
| 646 | self.log.info( description ) |
kelvin-onlab | f70fd54 | 2015-05-07 18:41:40 -0700 | [diff] [blame] | 647 | |
Jon Hall | 714eeba | 2015-09-29 17:53:10 -0700 | [diff] [blame] | 648 | def _getTest( self ): |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 649 | """ |
Jon Hall | 714eeba | 2015-09-29 17:53:10 -0700 | [diff] [blame] | 650 | This method will parse the test script to find required test |
| 651 | information. |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 652 | """ |
Jon Hall | 53c5e66 | 2016-04-13 16:06:56 -0700 | [diff] [blame] | 653 | testFileHandler = open( main.testFile, 'r' ) |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 654 | testFileList = testFileHandler.readlines() |
| 655 | testFileHandler.close() |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 656 | counter = 0 |
Jon Hall | 714eeba | 2015-09-29 17:53:10 -0700 | [diff] [blame] | 657 | for index in range( len( testFileList ) ): |
| 658 | lineMatch = re.match( '\s+def CASE(\d+)(.*):', |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 659 | testFileList[ index ], |
Jon Hall | 714eeba | 2015-09-29 17:53:10 -0700 | [diff] [blame] | 660 | 0 ) |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 661 | if lineMatch: |
Jon Hall | 714eeba | 2015-09-29 17:53:10 -0700 | [diff] [blame] | 662 | counter = counter + 1 |
| 663 | self.TC_PLANNED = len( self.testcases_list ) |
kelvin-onlab | f70fd54 | 2015-05-07 18:41:40 -0700 | [diff] [blame] | 664 | |
Jon Hall | 714eeba | 2015-09-29 17:53:10 -0700 | [diff] [blame] | 665 | def response_parser( self, response, return_format ): |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 666 | " It will load the default response parser " |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 667 | response_dict = {} |
Jon Hall | 714eeba | 2015-09-29 17:53:10 -0700 | [diff] [blame] | 668 | response_dict = self.response_to_dict( response, return_format ) |
| 669 | return_format_string = self.dict_to_return_format( response, |
| 670 | return_format, |
| 671 | response_dict ) |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 672 | return return_format_string |
kelvin-onlab | f70fd54 | 2015-05-07 18:41:40 -0700 | [diff] [blame] | 673 | |
Jon Hall | 714eeba | 2015-09-29 17:53:10 -0700 | [diff] [blame] | 674 | def response_to_dict( self, response, return_format ): |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 675 | response_dict = {} |
Jon Hall | 714eeba | 2015-09-29 17:53:10 -0700 | [diff] [blame] | 676 | json_match = re.search( '^\s*{', response ) |
| 677 | xml_match = re.search( '^\s*\<', response ) |
| 678 | ini_match = re.search( '^\s*\[', response ) |
| 679 | if json_match: |
| 680 | self.log.info( "Response is in 'JSON' format, converting to '" + |
| 681 | return_format + "' format" ) |
Jon Hall | d61331b | 2015-02-17 16:35:47 -0800 | [diff] [blame] | 682 | # Formatting the json string |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 683 | response = re.sub( r"{\s*'?(\w)", r'{ "\1', response ) |
Jon Hall | 714eeba | 2015-09-29 17:53:10 -0700 | [diff] [blame] | 684 | response = re.sub( r",\s*'?(\w)", r',"\1', response ) |
| 685 | response = re.sub( r"(\w)'?\s*:", r'\1":', response ) |
| 686 | response = re.sub( r":\s*'(\w)'\s*([,}])", r':"\1"\2', response ) |
| 687 | try: |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 688 | import json |
Jon Hall | 714eeba | 2015-09-29 17:53:10 -0700 | [diff] [blame] | 689 | response_dict = json.loads( response ) |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 690 | except Exception: |
Jon Hall | 2a5002c | 2015-08-21 16:49:11 -0700 | [diff] [blame] | 691 | self.log.exception( "Json Parser is unable to parse the string" ) |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 692 | return response_dict |
Jon Hall | 714eeba | 2015-09-29 17:53:10 -0700 | [diff] [blame] | 693 | elif ini_match: |
| 694 | self.log.info( "Response is in 'INI' format, converting to '" + |
| 695 | return_format + "' format" ) |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 696 | from configobj import ConfigObj |
Jon Hall | 714eeba | 2015-09-29 17:53:10 -0700 | [diff] [blame] | 697 | response_file = open( "respnse_file.temp", 'w' ) |
| 698 | response_file.write( response ) |
Jon Hall | d61331b | 2015-02-17 16:35:47 -0800 | [diff] [blame] | 699 | response_file.close() |
Jon Hall | 714eeba | 2015-09-29 17:53:10 -0700 | [diff] [blame] | 700 | response_dict = ConfigObj( "respnse_file.temp" ) |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 701 | return response_dict |
Jon Hall | 714eeba | 2015-09-29 17:53:10 -0700 | [diff] [blame] | 702 | elif xml_match: |
| 703 | self.log.info( "Response is in 'XML' format, converting to '" + |
| 704 | return_format + "' format" ) |
| 705 | try: |
| 706 | response_dict = xmldict.xml_to_dict( "<response> " + |
| 707 | str( response ) + |
| 708 | " </response>" ) |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 709 | except Exception: |
Jon Hall | 1306a56 | 2015-09-04 11:21:24 -0700 | [diff] [blame] | 710 | self.log.exception() |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 711 | return response_dict |
kelvin-onlab | f70fd54 | 2015-05-07 18:41:40 -0700 | [diff] [blame] | 712 | |
Jon Hall | 714eeba | 2015-09-29 17:53:10 -0700 | [diff] [blame] | 713 | def dict_to_return_format( self, response, return_format, response_dict ): |
| 714 | if return_format == 'table': |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 715 | " Will return in table format" |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 716 | to_do = "Call the table output formatter" |
| 717 | global response_table |
| 718 | response_table = '\n' |
Jon Hall | 714eeba | 2015-09-29 17:53:10 -0700 | [diff] [blame] | 719 | response_table = response_table + '\t'.join( response_dict ) + "\n" |
kelvin-onlab | f70fd54 | 2015-05-07 18:41:40 -0700 | [diff] [blame] | 720 | |
Jon Hall | 714eeba | 2015-09-29 17:53:10 -0700 | [diff] [blame] | 721 | def get_table( value_to_convert ): |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 722 | """ This will parse the dictionary recusrsively and print as |
| 723 | table format""" |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 724 | table_data = "" |
Jon Hall | 714eeba | 2015-09-29 17:53:10 -0700 | [diff] [blame] | 725 | if isinstance( value_to_convert, dict ): |
| 726 | table_data = table_data + '\t'.join( value_to_convert ) +\ |
| 727 | "\n" |
| 728 | for temp_val in value_to_convert.values(): |
| 729 | table_data = table_data + get_table( temp_val ) |
| 730 | else: |
| 731 | table_data = table_data + str( value_to_convert ) + "\t" |
Jon Hall | d61331b | 2015-02-17 16:35:47 -0800 | [diff] [blame] | 732 | return table_data |
kelvin-onlab | f70fd54 | 2015-05-07 18:41:40 -0700 | [diff] [blame] | 733 | |
Jon Hall | 714eeba | 2015-09-29 17:53:10 -0700 | [diff] [blame] | 734 | for value in response_dict.values(): |
| 735 | response_table = response_table + get_table( value ) |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 736 | return response_table |
kelvin-onlab | f70fd54 | 2015-05-07 18:41:40 -0700 | [diff] [blame] | 737 | |
Jon Hall | 714eeba | 2015-09-29 17:53:10 -0700 | [diff] [blame] | 738 | elif return_format == 'config': |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 739 | " Will return in config format" |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 740 | to_do = 'Call dict to config coverter' |
Jon Hall | 714eeba | 2015-09-29 17:53:10 -0700 | [diff] [blame] | 741 | response_string = str( response_dict ) |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 742 | print response_string |
Jon Hall | 714eeba | 2015-09-29 17:53:10 -0700 | [diff] [blame] | 743 | response_config = re.sub( ",", "\n\t", response_string ) |
| 744 | response_config = re.sub( "u\'", "\'", response_config ) |
| 745 | response_config = re.sub( "{", "", response_config ) |
| 746 | response_config = re.sub( "}", "\n", response_config ) |
| 747 | response_config = re.sub( ":", " =", response_config ) |
| 748 | return "[response]\n\t " + response_config |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 749 | elif return_format == 'xml': |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 750 | " Will return in xml format" |
Jon Hall | 714eeba | 2015-09-29 17:53:10 -0700 | [diff] [blame] | 751 | response_xml = xmldict.dict_to_xml( response_dict ) |
| 752 | response_xml = re.sub( ">\s*<", ">\n<", response_xml ) |
| 753 | return "\n" + response_xml |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 754 | elif return_format == 'json': |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 755 | " Will return in json format" |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 756 | to_do = 'Call dict to xml coverter' |
| 757 | import json |
Jon Hall | 714eeba | 2015-09-29 17:53:10 -0700 | [diff] [blame] | 758 | response_json = json.dumps( response_dict ) |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 759 | return response_json |
kelvin-onlab | f70fd54 | 2015-05-07 18:41:40 -0700 | [diff] [blame] | 760 | |
Jon Hall | 714eeba | 2015-09-29 17:53:10 -0700 | [diff] [blame] | 761 | def get_random( self ): |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 762 | self.random_order = self.random_order + 1 |
| 763 | return self.random_order |
kelvin-onlab | f70fd54 | 2015-05-07 18:41:40 -0700 | [diff] [blame] | 764 | |
Jon Hall | 714eeba | 2015-09-29 17:53:10 -0700 | [diff] [blame] | 765 | def exit( self ): |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 766 | __builtin__.testthread = None |
Jon Hall | 5b58673 | 2015-06-11 11:39:39 -0700 | [diff] [blame] | 767 | for thread in threading.enumerate(): |
| 768 | if thread.isAlive(): |
| 769 | try: |
| 770 | thread._Thread__stop() |
| 771 | except: |
Jon Hall | 1306a56 | 2015-09-04 11:21:24 -0700 | [diff] [blame] | 772 | # NOTE: We should catch any exceptions while trying to |
| 773 | # close the thread so that we can try to close the other |
| 774 | # threads as well |
Jon Hall | 714eeba | 2015-09-29 17:53:10 -0700 | [diff] [blame] | 775 | print str( thread.getName() ) +\ |
| 776 | ' could not be terminated' |
Jeremy Ronquillo | 15ff107 | 2017-07-17 10:55:46 -0700 | [diff] [blame] | 777 | os.system( "stty sane" ) # fix format if necessary |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 778 | sys.exit() |
| 779 | |
Devin Lim | 4407596 | 2017-08-11 10:56:37 -0700 | [diff] [blame] | 780 | def cleanAndExit( self ): |
| 781 | """ |
| 782 | It will set the testcase result to be FAILED and update it |
| 783 | before cleaning up and exitting the test. |
| 784 | :return: |
| 785 | """ |
| 786 | if self.CurrentTestCaseNumber: |
| 787 | self.testCaseResult[ str( self.CurrentTestCaseNumber ) ] = self.FALSE |
Devin Lim | ec98979 | 2017-08-15 15:57:55 -0700 | [diff] [blame] | 788 | self.organizeResult( self.CurrentTestCaseNumber, self.FALSE ) |
Devin Lim | 4407596 | 2017-08-11 10:56:37 -0700 | [diff] [blame] | 789 | self.logger.updateCaseResults( self ) |
| 790 | self.cleanup() |
| 791 | self.exit() |
Jeremy Ronquillo | 15ff107 | 2017-07-17 10:55:46 -0700 | [diff] [blame] | 792 | |
Jon Hall | cd3d2a3 | 2015-10-01 11:07:28 -0700 | [diff] [blame] | 793 | def stop( self, email=False ): |
| 794 | """ |
| 795 | Stop the test until Ctrl-D is entered. |
| 796 | Ctrl-C will kill the test |
Jon Hall | 2507978 | 2015-10-13 13:54:39 -0700 | [diff] [blame] | 797 | |
| 798 | Optional arguments: |
| 799 | email can either be a bool, or you can specify the email address |
| 800 | to send the email to |
Jon Hall | cd3d2a3 | 2015-10-01 11:07:28 -0700 | [diff] [blame] | 801 | """ |
| 802 | try: |
| 803 | if email: |
Jon Hall | 2507978 | 2015-10-13 13:54:39 -0700 | [diff] [blame] | 804 | if '@' in email: |
| 805 | main.mail = email |
| 806 | utilities.send_warning_email() |
Jeremy Ronquillo | 15ff107 | 2017-07-17 10:55:46 -0700 | [diff] [blame] | 807 | self.log.debug( "Test execution suspended. \n" |
| 808 | "- Type 'c' to resume the test.\n" |
| 809 | "- Type Ctrl-C to exit the test.\n" |
| 810 | "- Enter interactive python interpreter commands.\n" |
| 811 | "\t- ie: main.Mininet1.pingall()\n" |
| 812 | "- Type 'help' for help with pdb." ) |
| 813 | pdb.set_trace() |
Jon Hall | cd3d2a3 | 2015-10-01 11:07:28 -0700 | [diff] [blame] | 814 | except EOFError: |
| 815 | return |
| 816 | # Pass all other exceptions up to caller |
| 817 | |
| 818 | |
Jon Hall | 714eeba | 2015-09-29 17:53:10 -0700 | [diff] [blame] | 819 | def verifyOptions( options ): |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 820 | """ |
Jon Hall | 714eeba | 2015-09-29 17:53:10 -0700 | [diff] [blame] | 821 | This will verify the command line options and set to default values, |
| 822 | if any option not given in command line. |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 823 | """ |
Jon Hall | 714eeba | 2015-09-29 17:53:10 -0700 | [diff] [blame] | 824 | verifyTest( options ) |
| 825 | verifyExample( options ) |
| 826 | verifyTestScript( options ) |
YPZhang | 1c89e76 | 2016-06-29 10:43:58 -0700 | [diff] [blame] | 827 | verifyParams( options ) |
Jon Hall | 714eeba | 2015-09-29 17:53:10 -0700 | [diff] [blame] | 828 | verifyLogdir( options ) |
| 829 | verifyMail( options ) |
| 830 | verifyTestCases( options ) |
| 831 | verifyOnosCell( options ) |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 832 | |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 833 | |
Jon Hall | 714eeba | 2015-09-29 17:53:10 -0700 | [diff] [blame] | 834 | def verifyTest( options ): |
Jon Hall | 4450624 | 2015-07-29 17:40:26 -0700 | [diff] [blame] | 835 | try: |
| 836 | if options.testname: |
| 837 | main.TEST = options.testname |
Jon Hall | 714eeba | 2015-09-29 17:53:10 -0700 | [diff] [blame] | 838 | main.classPath = "tests." + main.TEST + "." + main.TEST |
Jon Hall | 4450624 | 2015-07-29 17:40:26 -0700 | [diff] [blame] | 839 | main.tests_path = tests_path |
| 840 | elif options.example: |
| 841 | main.TEST = options.example |
Jon Hall | 714eeba | 2015-09-29 17:53:10 -0700 | [diff] [blame] | 842 | main.tests_path = path + "/examples/" |
| 843 | main.classPath = "examples." + main.TEST + "." + main.TEST |
Jon Hall | 4450624 | 2015-07-29 17:40:26 -0700 | [diff] [blame] | 844 | except AttributeError: |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 845 | print "Test or Example not specified please specify the --test <test name > or --example <example name>" |
Jon Hall | 5b58673 | 2015-06-11 11:39:39 -0700 | [diff] [blame] | 846 | main.exit() |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 847 | |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 848 | |
Jon Hall | 714eeba | 2015-09-29 17:53:10 -0700 | [diff] [blame] | 849 | def verifyExample( options ): |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 850 | if options.example: |
Jon Hall | 714eeba | 2015-09-29 17:53:10 -0700 | [diff] [blame] | 851 | main.testDir = path + '/examples/' |
| 852 | main.tests_path = path + "/examples/" |
| 853 | main.classPath = "examples." + main.TEST + "." + main.TEST |
kelvin-onlab | f70fd54 | 2015-05-07 18:41:40 -0700 | [diff] [blame] | 854 | |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 855 | |
Jon Hall | 714eeba | 2015-09-29 17:53:10 -0700 | [diff] [blame] | 856 | def verifyLogdir( options ): |
Jon Hall | 88e498c | 2015-03-06 09:54:35 -0800 | [diff] [blame] | 857 | # Verifying Log directory option |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 858 | if options.logdir: |
| 859 | main.logdir = options.logdir |
Jon Hall | 714eeba | 2015-09-29 17:53:10 -0700 | [diff] [blame] | 860 | else: |
Jon Hall | d61331b | 2015-02-17 16:35:47 -0800 | [diff] [blame] | 861 | main.logdir = main.FALSE |
kelvin-onlab | f70fd54 | 2015-05-07 18:41:40 -0700 | [diff] [blame] | 862 | |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 863 | |
Jon Hall | 714eeba | 2015-09-29 17:53:10 -0700 | [diff] [blame] | 864 | def verifyMail( options ): |
Jon Hall | 2507978 | 2015-10-13 13:54:39 -0700 | [diff] [blame] | 865 | # Mail-To: field |
| 866 | if options.mail: # Test run specific |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 867 | main.mail = options.mail |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 868 | elif main.params.get( 'mail' ): # Test suite specific |
Jon Hall | 2507978 | 2015-10-13 13:54:39 -0700 | [diff] [blame] | 869 | main.mail = main.params.get( 'mail' ) |
| 870 | else: # TestON specific |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 871 | main.mail = main.config[ 'config' ].get( 'mail_to' ) |
Jon Hall | 2507978 | 2015-10-13 13:54:39 -0700 | [diff] [blame] | 872 | # Mail-From: field |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 873 | main.sender = main.config[ 'config' ].get( 'mail_from' ) |
Jon Hall | 2507978 | 2015-10-13 13:54:39 -0700 | [diff] [blame] | 874 | # Mail smtp server |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 875 | main.smtp = main.config[ 'config' ].get( 'mail_server' ) |
Jon Hall | 2507978 | 2015-10-13 13:54:39 -0700 | [diff] [blame] | 876 | # Mail-From account password |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 877 | main.senderPwd = main.config[ 'config' ].get( 'mail_pass' ) |
| 878 | |
Jon Hall | 2507978 | 2015-10-13 13:54:39 -0700 | [diff] [blame] | 879 | |
Devin Lim | 2df68a1 | 2017-06-30 15:39:05 -0700 | [diff] [blame] | 880 | def evalTestCase( tempList ): |
| 881 | tList = [] |
| 882 | for tcase in tempList: |
| 883 | if isinstance( tcase, list ): |
| 884 | tList.extend( evalTestCase( tcase ) ) |
| 885 | else: |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 886 | tList.extend( [ tcase ] ) |
Devin Lim | 2df68a1 | 2017-06-30 15:39:05 -0700 | [diff] [blame] | 887 | return tList |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 888 | |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 889 | |
Jon Hall | 714eeba | 2015-09-29 17:53:10 -0700 | [diff] [blame] | 890 | def verifyTestCases( options ): |
Jon Hall | 88e498c | 2015-03-06 09:54:35 -0800 | [diff] [blame] | 891 | # Getting Test cases list |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 892 | if options.testcases: |
Jon Hall | febb1c7 | 2015-03-05 13:30:09 -0800 | [diff] [blame] | 893 | testcases_list = options.testcases |
Jon Hall | 88e498c | 2015-03-06 09:54:35 -0800 | [diff] [blame] | 894 | # sys.exit() |
Jon Hall | 714eeba | 2015-09-29 17:53:10 -0700 | [diff] [blame] | 895 | testcases_list = re.sub( "(\[|\])", "", options.testcases ) |
| 896 | main.testcases_list = eval( testcases_list + "," ) |
| 897 | else: |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 898 | if 'testcases' in main.params.keys(): |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 899 | temp = eval( main.params[ 'testcases' ] + "," ) |
Devin Lim | 2df68a1 | 2017-06-30 15:39:05 -0700 | [diff] [blame] | 900 | main.testcases_list = evalTestCase( list( temp ) ) |
Jon Hall | 714eeba | 2015-09-29 17:53:10 -0700 | [diff] [blame] | 901 | else: |
| 902 | print "Testcases not specifed in params, please provide in " +\ |
| 903 | "params file or 'testcases' commandline argument" |
Jon Hall | d61331b | 2015-02-17 16:35:47 -0800 | [diff] [blame] | 904 | sys.exit() |
kelvin-onlab | f70fd54 | 2015-05-07 18:41:40 -0700 | [diff] [blame] | 905 | |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 906 | |
Jon Hall | 714eeba | 2015-09-29 17:53:10 -0700 | [diff] [blame] | 907 | def verifyOnosCell( options ): |
Hari Krishna | be4b97b | 2015-07-15 12:19:43 -0700 | [diff] [blame] | 908 | # Verifying onoscell option |
Hari Krishna | 03f530e | 2015-07-10 17:28:27 -0700 | [diff] [blame] | 909 | if options.onoscell: |
| 910 | main.onoscell = options.onoscell |
Devin Lim | 58046fa | 2017-07-05 16:55:00 -0700 | [diff] [blame] | 911 | main.ONOSip = [] |
Hari Krishna | be4b97b | 2015-07-15 12:19:43 -0700 | [diff] [blame] | 912 | main.mnIP = "" |
Devin Lim | 58046fa | 2017-07-05 16:55:00 -0700 | [diff] [blame] | 913 | cellCMD = ". ~/onos/tools/dev/bash_profile; cell " + main.onoscell |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 914 | output = subprocess.check_output( [ "bash", '-c', cellCMD ] ) |
Hari Krishna | be4b97b | 2015-07-15 12:19:43 -0700 | [diff] [blame] | 915 | splitOutput = output.splitlines() |
Devin Lim | 58046fa | 2017-07-05 16:55:00 -0700 | [diff] [blame] | 916 | main.apps = "" |
Jon Hall | 714eeba | 2015-09-29 17:53:10 -0700 | [diff] [blame] | 917 | for i in range( len( splitOutput ) ): |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 918 | if re.match( "OCN", splitOutput[ i ] ): |
| 919 | mnNode = splitOutput[ i ].split( "=" ) |
| 920 | main.mnIP = mnNode[ 1 ] |
Jon Hall | 714eeba | 2015-09-29 17:53:10 -0700 | [diff] [blame] | 921 | # cell already sorts OC variables in bash, so no need to |
| 922 | # sort in TestON |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 923 | elif re.match( "OC[1-9]", splitOutput[ i ] ): |
| 924 | onosNodes = splitOutput[ i ].split( "=" ) |
| 925 | main.ONOSip.append( onosNodes[ 1 ] ) |
| 926 | elif re.match( "ONOS_APPS", splitOutput[ i ] ): |
| 927 | main.apps = ( splitOutput[ i ].split( "=" ) )[ 1 ] |
Jon Hall | 714eeba | 2015-09-29 17:53:10 -0700 | [diff] [blame] | 928 | else: |
Hari Krishna | 03f530e | 2015-07-10 17:28:27 -0700 | [diff] [blame] | 929 | main.onoscell = main.FALSE |
| 930 | |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 931 | |
Jon Hall | 714eeba | 2015-09-29 17:53:10 -0700 | [diff] [blame] | 932 | def verifyTestScript( options ): |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 933 | """ |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 934 | Verifyies test script. |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 935 | """ |
Jon Hall | d61331b | 2015-02-17 16:35:47 -0800 | [diff] [blame] | 936 | main.openspeak = openspeak.OpenSpeak() |
Jon Hall | 53c5e66 | 2016-04-13 16:06:56 -0700 | [diff] [blame] | 937 | directory = main.testDir + "/" + main.TEST |
| 938 | if os.path.exists( directory ): |
| 939 | pass |
| 940 | else: |
| 941 | directory = "" |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 942 | for root, dirs, files in os.walk( main.testDir, topdown=True ): |
Jon Hall | 53c5e66 | 2016-04-13 16:06:56 -0700 | [diff] [blame] | 943 | if not directory: |
| 944 | for name in dirs: |
| 945 | if name == main.TEST: |
| 946 | directory = ( os.path.join( root, name ) ) |
| 947 | index = directory.find( "/tests/" ) + 1 |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 948 | main.classPath = directory[ index: ].replace( '/', '.' ) + "." + main.TEST |
Jon Hall | 53c5e66 | 2016-04-13 16:06:56 -0700 | [diff] [blame] | 949 | break |
| 950 | openspeakfile = directory + "/" + main.TEST + ".ospk" |
| 951 | main.testFile = directory + "/" + main.TEST + ".py" |
Jon Hall | 714eeba | 2015-09-29 17:53:10 -0700 | [diff] [blame] | 952 | if os.path.exists( openspeakfile ): |
Jon Hall | 4450624 | 2015-07-29 17:40:26 -0700 | [diff] [blame] | 953 | # Openspeak file found, compiling to python |
Jon Hall | 714eeba | 2015-09-29 17:53:10 -0700 | [diff] [blame] | 954 | main.openspeak.compiler( openspeakfile=openspeakfile, writetofile=1 ) |
Jon Hall | 53c5e66 | 2016-04-13 16:06:56 -0700 | [diff] [blame] | 955 | elif os.path.exists( main.testFile ): |
Jon Hall | 4450624 | 2015-07-29 17:40:26 -0700 | [diff] [blame] | 956 | # No openspeak found, using python file instead |
| 957 | pass |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 958 | else: |
Jon Hall | 714eeba | 2015-09-29 17:53:10 -0700 | [diff] [blame] | 959 | print "\nThere is no \"" + main.TEST + "\" test script.\nPlease provide a " +\ |
Jon Hall | 4450624 | 2015-07-29 17:40:26 -0700 | [diff] [blame] | 960 | "Python or OpenSpeak test script in the tests folder: " +\ |
Jon Hall | 714eeba | 2015-09-29 17:53:10 -0700 | [diff] [blame] | 961 | main.testDir + "/" + main.TEST + "/" |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 962 | __builtin__.testthread = None |
| 963 | main.exit() |
Jon Hall | 714eeba | 2015-09-29 17:53:10 -0700 | [diff] [blame] | 964 | try: |
| 965 | testModule = __import__( main.classPath, |
| 966 | globals(), |
| 967 | locals(), |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 968 | [ main.TEST ], |
Jon Hall | 714eeba | 2015-09-29 17:53:10 -0700 | [diff] [blame] | 969 | -1 ) |
Jon Hall | 1306a56 | 2015-09-04 11:21:24 -0700 | [diff] [blame] | 970 | except ImportError: |
Jon Hall | 714eeba | 2015-09-29 17:53:10 -0700 | [diff] [blame] | 971 | print "There was an import error, it might mean that there is " +\ |
| 972 | "no test named " + main.TEST |
Jon Hall | d61331b | 2015-02-17 16:35:47 -0800 | [diff] [blame] | 973 | main.exit() |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 974 | |
Jon Hall | 714eeba | 2015-09-29 17:53:10 -0700 | [diff] [blame] | 975 | testClass = getattr( testModule, main.TEST ) |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 976 | main.testObject = testClass() |
| 977 | load_parser() |
Jon Hall | 714eeba | 2015-09-29 17:53:10 -0700 | [diff] [blame] | 978 | main.params = main.parser.parseParams( main.classPath ) |
| 979 | main.topology = main.parser.parseTopology( main.classPath ) |
kelvin-onlab | f70fd54 | 2015-05-07 18:41:40 -0700 | [diff] [blame] | 980 | |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 981 | |
YPZhang | 1c89e76 | 2016-06-29 10:43:58 -0700 | [diff] [blame] | 982 | def verifyParams( options ): |
Jon Hall | 714eeba | 2015-09-29 17:53:10 -0700 | [diff] [blame] | 983 | try: |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 984 | main.params = main.params[ 'PARAMS' ] |
Jon Hall | 1306a56 | 2015-09-04 11:21:24 -0700 | [diff] [blame] | 985 | except KeyError: |
Jon Hall | 714eeba | 2015-09-29 17:53:10 -0700 | [diff] [blame] | 986 | print "Error with the params file: Either the file not specified " +\ |
| 987 | "or the format is not correct" |
Jon Hall | d61331b | 2015-02-17 16:35:47 -0800 | [diff] [blame] | 988 | main.exit() |
Jon Hall | 714eeba | 2015-09-29 17:53:10 -0700 | [diff] [blame] | 989 | try: |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 990 | main.topology = main.topology[ 'TOPOLOGY' ] |
Jon Hall | 1306a56 | 2015-09-04 11:21:24 -0700 | [diff] [blame] | 991 | except KeyError: |
Jon Hall | 714eeba | 2015-09-29 17:53:10 -0700 | [diff] [blame] | 992 | print "Error with the Topology file: Either the file not specified " +\ |
| 993 | "or the format is not correct" |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 994 | main.exit() |
YPZhang | 1c89e76 | 2016-06-29 10:43:58 -0700 | [diff] [blame] | 995 | # Overwrite existing params variables if they are specified from command line |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 996 | if len( options.params ) > 0: |
YPZhang | 1c89e76 | 2016-06-29 10:43:58 -0700 | [diff] [blame] | 997 | # Some params variables are specified from command line |
| 998 | for param in options.params: |
| 999 | if not re.search( ".=.", param ): |
| 1000 | print( "Error when parsing params: params should follow key=value format" ) |
| 1001 | continue |
Jon Hall | 7c4f430 | 2016-07-15 14:39:02 -0700 | [diff] [blame] | 1002 | # Split the param string to catch nested keys and the value |
YPZhang | 1c89e76 | 2016-06-29 10:43:58 -0700 | [diff] [blame] | 1003 | [ keys, value ] = param.split( "=" ) |
| 1004 | # Split the nested keys according to its hierarchy |
| 1005 | keyList = keys.split( "/" ) |
| 1006 | # Get the outermost dictionary |
| 1007 | paramDict = main.params |
| 1008 | # Get the innermost dictionary |
| 1009 | try: |
| 1010 | while len( keyList ) > 1: |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 1011 | key = keyList.pop( 0 ) |
YPZhang | 1c89e76 | 2016-06-29 10:43:58 -0700 | [diff] [blame] | 1012 | assert isinstance( paramDict[ key ], dict ) |
| 1013 | paramDict = paramDict[ key ] |
| 1014 | except KeyError: |
| 1015 | print( "Error when parsing params: key \"" + key + "\" not found in main.params" ) |
| 1016 | main.exit() |
| 1017 | except AssertionError: |
| 1018 | print( "Error when parsing params: \"" + key + "\" is already the innermost level in main.params" ) |
| 1019 | main.exit() |
| 1020 | # Change the value |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 1021 | if keyList[ 0 ] not in paramDict: |
YPZhang | 1c89e76 | 2016-06-29 10:43:58 -0700 | [diff] [blame] | 1022 | print( "Error when parsing params: key \"" + keyList[0] + "\" not found in main.params" ) |
| 1023 | main.exit() |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 1024 | elif isinstance( paramDict[ keyList[ 0 ] ], dict ): |
YPZhang | 1c89e76 | 2016-06-29 10:43:58 -0700 | [diff] [blame] | 1025 | print( "Error when parsing params: more levels under key \"" + keyList[0] + "\" in main.params" ) |
| 1026 | main.exit() |
| 1027 | else: |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 1028 | paramDict[ keyList[ 0 ] ] = value |
| 1029 | |
kelvin-onlab | f70fd54 | 2015-05-07 18:41:40 -0700 | [diff] [blame] | 1030 | |
Jon Hall | 714eeba | 2015-09-29 17:53:10 -0700 | [diff] [blame] | 1031 | def load_parser(): |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 1032 | """ |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 1033 | It facilitates the loading customised parser for topology and params file. |
| 1034 | It loads parser mentioned in tab named parser of teston.cfg file. |
Jon Hall | 714eeba | 2015-09-29 17:53:10 -0700 | [diff] [blame] | 1035 | It also loads default xmlparser if no parser have specified in teston.cfg |
| 1036 | file. |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 1037 | |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 1038 | """ |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 1039 | confighash = main.configDict |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 1040 | if 'file' in confighash[ 'config' ][ 'parser' ] and\ |
| 1041 | 'class' in confighash[ 'config' ][ 'parser' ]: |
| 1042 | path = confighash[ 'config' ][ 'parser' ][ 'file' ] |
Jon Hall | 714eeba | 2015-09-29 17:53:10 -0700 | [diff] [blame] | 1043 | if path is not None or\ |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 1044 | confighash[ 'config' ][ 'parser' ][ 'class' ] is not None: |
Jon Hall | 4450624 | 2015-07-29 17:40:26 -0700 | [diff] [blame] | 1045 | try: |
| 1046 | module = re.sub( r".py\s*$", "", path ) |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 1047 | moduleList = module.split( "/" ) |
| 1048 | newModule = ".".join( moduleList[ -2: ] ) |
| 1049 | parsingClass = confighash[ 'config' ][ 'parser' ][ 'class' ] |
Jon Hall | 714eeba | 2015-09-29 17:53:10 -0700 | [diff] [blame] | 1050 | parsingModule = __import__( newModule, |
| 1051 | globals(), |
| 1052 | locals(), |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 1053 | [ parsingClass ], |
Jon Hall | 714eeba | 2015-09-29 17:53:10 -0700 | [diff] [blame] | 1054 | -1 ) |
| 1055 | parsingClass = getattr( parsingModule, parsingClass ) |
Jon Hall | 4450624 | 2015-07-29 17:40:26 -0700 | [diff] [blame] | 1056 | main.parser = parsingClass() |
Jon Hall | 714eeba | 2015-09-29 17:53:10 -0700 | [diff] [blame] | 1057 | if hasattr( main.parser, "parseParams" ) and\ |
| 1058 | hasattr( main.parser, "parseTopology" ) and\ |
| 1059 | hasattr( main.parser, "parse" ): |
Jon Hall | 4450624 | 2015-07-29 17:40:26 -0700 | [diff] [blame] | 1060 | pass |
| 1061 | else: |
| 1062 | print "Invalid parser format" |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 1063 | main.exit() |
Jon Hall | 4450624 | 2015-07-29 17:40:26 -0700 | [diff] [blame] | 1064 | except ImportError: |
Jon Hall | 714eeba | 2015-09-29 17:53:10 -0700 | [diff] [blame] | 1065 | print "Could not find the file " + path +\ |
| 1066 | " using default parser." |
Jon Hall | d61331b | 2015-02-17 16:35:47 -0800 | [diff] [blame] | 1067 | load_defaultParser() |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 1068 | elif confighash[ 'config' ][ 'parser' ][ 'file' ] is None or\ |
| 1069 | confighash[ 'config' ][ 'parser' ][ 'class' ] is None: |
Jon Hall | d61331b | 2015-02-17 16:35:47 -0800 | [diff] [blame] | 1070 | load_defaultParser() |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 1071 | else: |
| 1072 | load_defaultParser() |
| 1073 | |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 1074 | |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 1075 | def load_defaultParser(): |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 1076 | """ |
Jon Hall | 714eeba | 2015-09-29 17:53:10 -0700 | [diff] [blame] | 1077 | It will load the default parser which is xml parser to parse the params and |
| 1078 | topology file. |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 1079 | """ |
| 1080 | moduleList = main.parserPath.split( "/" ) |
| 1081 | newModule = ".".join( moduleList[ -2: ] ) |
Jon Hall | 714eeba | 2015-09-29 17:53:10 -0700 | [diff] [blame] | 1082 | try: |
Jon Hall | d61331b | 2015-02-17 16:35:47 -0800 | [diff] [blame] | 1083 | parsingClass = main.parsingClass |
Jon Hall | 714eeba | 2015-09-29 17:53:10 -0700 | [diff] [blame] | 1084 | parsingModule = __import__( newModule, |
| 1085 | globals(), |
| 1086 | locals(), |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 1087 | [ parsingClass ], |
Jon Hall | 714eeba | 2015-09-29 17:53:10 -0700 | [diff] [blame] | 1088 | -1 ) |
| 1089 | parsingClass = getattr( parsingModule, parsingClass ) |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 1090 | main.parser = parsingClass() |
Jon Hall | 714eeba | 2015-09-29 17:53:10 -0700 | [diff] [blame] | 1091 | if hasattr( main.parser, "parseParams" ) and\ |
| 1092 | hasattr( main.parser, "parseTopology" ) and\ |
| 1093 | hasattr( main.parser, "parse" ): |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 1094 | pass |
| 1095 | else: |
| 1096 | main.exit() |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 1097 | except ImportError: |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 1098 | print sys.exc_info()[ 1 ] |
| 1099 | |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 1100 | |
Jon Hall | 714eeba | 2015-09-29 17:53:10 -0700 | [diff] [blame] | 1101 | def load_logger(): |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 1102 | """ |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 1103 | It facilitates the loading customised parser for topology and params file. |
| 1104 | It loads parser mentioned in tab named parser of teston.cfg file. |
Jon Hall | 714eeba | 2015-09-29 17:53:10 -0700 | [diff] [blame] | 1105 | It also loads default xmlparser if no parser have specified in teston.cfg |
| 1106 | file. |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 1107 | """ |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 1108 | confighash = main.configDict |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 1109 | if 'file' in confighash[ 'config' ][ 'logger' ] and\ |
| 1110 | 'class' in confighash[ 'config' ][ 'logger' ]: |
| 1111 | path = confighash[ 'config' ][ 'logger' ][ 'file' ] |
Jon Hall | 714eeba | 2015-09-29 17:53:10 -0700 | [diff] [blame] | 1112 | if path is not None or\ |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 1113 | confighash[ 'config' ][ 'logger' ][ 'class' ] is not None: |
Jon Hall | 4450624 | 2015-07-29 17:40:26 -0700 | [diff] [blame] | 1114 | try: |
| 1115 | module = re.sub( r".py\s*$", "", path ) |
Jon Hall | 714eeba | 2015-09-29 17:53:10 -0700 | [diff] [blame] | 1116 | moduleList = module.split( "/" ) |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 1117 | newModule = ".".join( moduleList[ -2: ] ) |
| 1118 | loggerClass = confighash[ 'config' ][ 'logger' ][ 'class' ] |
Jon Hall | 714eeba | 2015-09-29 17:53:10 -0700 | [diff] [blame] | 1119 | loggerModule = __import__( newModule, |
| 1120 | globals(), |
| 1121 | locals(), |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 1122 | [ loggerClass ], |
Jon Hall | 714eeba | 2015-09-29 17:53:10 -0700 | [diff] [blame] | 1123 | -1 ) |
| 1124 | loggerClass = getattr( loggerModule, loggerClass ) |
Jon Hall | 4450624 | 2015-07-29 17:40:26 -0700 | [diff] [blame] | 1125 | main.logger = loggerClass() |
Jon Hall | 4450624 | 2015-07-29 17:40:26 -0700 | [diff] [blame] | 1126 | except ImportError: |
Jon Hall | 714eeba | 2015-09-29 17:53:10 -0700 | [diff] [blame] | 1127 | print "Could not find the file " + path +\ |
| 1128 | " using default logger." |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 1129 | load_defaultlogger() |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 1130 | elif confighash[ 'config' ][ 'parser' ][ 'file' ] is None or\ |
| 1131 | confighash[ 'config' ][ 'parser' ][ 'class' ] is None: |
Jon Hall | d61331b | 2015-02-17 16:35:47 -0800 | [diff] [blame] | 1132 | load_defaultlogger() |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 1133 | else: |
| 1134 | load_defaultlogger() |
| 1135 | |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 1136 | |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 1137 | def load_defaultlogger(): |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 1138 | """ |
Jon Hall | 714eeba | 2015-09-29 17:53:10 -0700 | [diff] [blame] | 1139 | It will load the default parser which is xml parser to parse the params and |
| 1140 | topology file. |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 1141 | """ |
| 1142 | moduleList = main.loggerPath.split( "/" ) |
| 1143 | newModule = ".".join( moduleList[ -2: ] ) |
Jon Hall | 714eeba | 2015-09-29 17:53:10 -0700 | [diff] [blame] | 1144 | try: |
Jon Hall | d61331b | 2015-02-17 16:35:47 -0800 | [diff] [blame] | 1145 | loggerClass = main.loggerClass |
Jon Hall | 714eeba | 2015-09-29 17:53:10 -0700 | [diff] [blame] | 1146 | loggerModule = __import__( newModule, |
| 1147 | globals(), |
| 1148 | locals(), |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 1149 | [ loggerClass ], |
Jon Hall | 714eeba | 2015-09-29 17:53:10 -0700 | [diff] [blame] | 1150 | -1 ) |
| 1151 | loggerClass = getattr( loggerModule, loggerClass ) |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 1152 | main.logger = loggerClass() |
| 1153 | |
| 1154 | except ImportError: |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 1155 | print sys.exc_info()[ 1 ] |
Jon Hall | d61331b | 2015-02-17 16:35:47 -0800 | [diff] [blame] | 1156 | main.exit() |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 1157 | |
Jeremy Ronquillo | 23fb216 | 2017-09-15 14:59:57 -0700 | [diff] [blame^] | 1158 | |
Jon Hall | 714eeba | 2015-09-29 17:53:10 -0700 | [diff] [blame] | 1159 | def _echo( self ): |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 1160 | print "THIS IS ECHO" |