blob: 2f7e5bb986046d51edc4747b2dc4fcff3ebab7a2 [file] [log] [blame]
adminbae64d82013-08-01 10:50:15 -07001#!/usr/bin/env python
2'''
3Created on 23-Oct-2012
Jeremy Ronquillob27ce4c2017-07-17 12:41:28 -07004Copyright 2012 Open Networking Foundation (ONF)
Jon Hall4ba53f02015-07-29 13:07:41 -07005
Jeremy Songsterae01bba2016-07-11 15:39:17 -07006Please refer questions to either the onos test mailing list at <onos-test@onosproject.org>,
7the System Testing Plans and Results wiki page at <https://wiki.onosproject.org/x/voMg>,
8or the System Testing Guide page at <https://wiki.onosproject.org/x/WYQg>
adminbae64d82013-08-01 10:50:15 -07009
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
13 (at your option) any later version.
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 Hall4ba53f02015-07-29 13:07:41 -070021 along with TestON. If not, see <http://www.gnu.org/licenses/>.
adminbae64d82013-08-01 10:50:15 -070022
Jon Hall4ba53f02015-07-29 13:07:41 -070023
adminbae64d82013-08-01 10:50:15 -070024Utilities will take care about the basic functions like :
25 * Extended assertion,
26 * parse_args for key-value pair handling
27 * Parsing the params or topology file.
28
29'''
30import re
31from configobj import ConfigObj
adminbae64d82013-08-01 10:50:15 -070032from core import ast as ast
33import smtplib
34
adminbae64d82013-08-01 10:50:15 -070035import email
36import os
37import email.mime.application
Jon Hall095730a2015-12-17 14:57:45 -080038import time
39import random
adminbae64d82013-08-01 10:50:15 -070040
41class Utilities:
42 '''
43 Utilities will take care about the basic functions like :
44 * Extended assertion,
45 * parse_args for key-value pair handling
46 * Parsing the params or topology file.
47 '''
Jon Hall4ba53f02015-07-29 13:07:41 -070048
adminbae64d82013-08-01 10:50:15 -070049 def __init__(self):
50 self.wrapped = sys.modules[__name__]
51
52 def __getattr__(self, name):
53 '''
54 This will invoke, if the attribute wasn't found the usual ways.
55 Here it will look for assert_attribute and will execute when AttributeError occurs.
56 It will return the result of the assert_attribute.
57 '''
58 try:
59 return getattr(self.wrapped, name)
60 except AttributeError:
61 def assertHandling(**kwargs):
Jon Hall4ba53f02015-07-29 13:07:41 -070062 nameVar = re.match("^assert",name,flags=0)
adminbae64d82013-08-01 10:50:15 -070063 matchVar = re.match("assert(_not_|_)(equals|matches|greater|lesser)",name,flags=0)
64 notVar = 0
65 operators = ""
66
67 try :
68 if matchVar.group(1) == "_not_" and matchVar.group(2) :
69 notVar = 1
70 operators = matchVar.group(2)
71 elif matchVar.group(1) == "_" and matchVar.group(2):
72 operators = matchVar.group(2)
adminbae64d82013-08-01 10:50:15 -070073 except AttributeError:
74 if matchVar==None and nameVar:
75 operators ='equals'
Jon Hall79bec222015-04-30 16:23:30 -070076 result = self._assert(NOT=notVar,operator=operators,**kwargs)
adminbae64d82013-08-01 10:50:15 -070077 if result == main.TRUE:
78 main.log.info("Assertion Passed")
Jon Hall79bec222015-04-30 16:23:30 -070079 main.STEPRESULT = main.TRUE
adminbae64d82013-08-01 10:50:15 -070080 elif result == main.FALSE:
81 main.log.warn("Assertion Failed")
Jon Hall79bec222015-04-30 16:23:30 -070082 main.STEPRESULT = main.FALSE
83 else:
adminbae64d82013-08-01 10:50:15 -070084 main.log.error("There is an Error in Assertion")
Jon Hall79bec222015-04-30 16:23:30 -070085 main.STEPRESULT = main.ERROR
adminbae64d82013-08-01 10:50:15 -070086 return result
adminbae64d82013-08-01 10:50:15 -070087 return assertHandling
Jon Hall79bec222015-04-30 16:23:30 -070088
Jon Hall8ce34e82015-06-05 10:41:45 -070089 def _assert (self,**assertParam):
adminbae64d82013-08-01 10:50:15 -070090 '''
91 It will take the arguments :
Jon Hall8ce34e82015-06-05 10:41:45 -070092 expect:'Expected output'
93 actual:'Actual output'
adminbae64d82013-08-01 10:50:15 -070094 onpass:'Action or string to be triggered or displayed respectively when the assert passed'
95 onfail:'Action or string to be triggered or displayed respectively when the assert failed'
96 not:'optional argument to specify the negation of the each assertion type'
97 operator:'assertion type will be defined by using operator. Like equal , greater, lesser, matches.'
Jon Hall8ce34e82015-06-05 10:41:45 -070098
adminbae64d82013-08-01 10:50:15 -070099 It will return the assertion result.
Jon Hall8ce34e82015-06-05 10:41:45 -0700100
adminbae64d82013-08-01 10:50:15 -0700101 '''
Jon Hall8ce34e82015-06-05 10:41:45 -0700102
adminbae64d82013-08-01 10:50:15 -0700103 arguments = self.parse_args(["EXPECT","ACTUAL","ONPASS","ONFAIL","NOT","OPERATOR"],**assertParam)
Jon Hall8ce34e82015-06-05 10:41:45 -0700104
adminbae64d82013-08-01 10:50:15 -0700105 result = 0
106 valuetype = ''
107 operation = "not "+ str(arguments["OPERATOR"]) if arguments['NOT'] and arguments['NOT'] == 1 else arguments["OPERATOR"]
108 operators = {'equals':{'STR':'==','NUM':'=='}, 'matches' : '=~', 'greater':'>' ,'lesser':'<'}
Jon Hall8ce34e82015-06-05 10:41:45 -0700109
adminbae64d82013-08-01 10:50:15 -0700110 expectMatch = re.match('^\s*[+-]?0(e0)?\s*$', str(arguments["EXPECT"]), re.I+re.M)
111 if not ((not expectMatch) and (arguments["EXPECT"]==0)):
112 valuetype = 'NUM'
113 else :
114 if arguments["OPERATOR"] == 'greater' or arguments["OPERATOR"] == 'lesser':
115 main.log.error("Numeric comparison on strings is not possibele")
116 return main.ERROR
Jon Hall8ce34e82015-06-05 10:41:45 -0700117
adminbae64d82013-08-01 10:50:15 -0700118 valuetype = 'STR'
119 arguments["ACTUAL"] = str(arguments["ACTUAL"])
120 if arguments["OPERATOR"] != 'matches':
121 arguments["EXPECT"] = str(arguments["EXPECT"])
Jon Hall8ce34e82015-06-05 10:41:45 -0700122
adminbae64d82013-08-01 10:50:15 -0700123 try :
124 opcode = operators[str(arguments["OPERATOR"])][valuetype] if arguments["OPERATOR"] == 'equals' else operators[str(arguments["OPERATOR"])]
Jon Hall8ce34e82015-06-05 10:41:45 -0700125
Jon Hall1306a562015-09-04 11:21:24 -0700126 except KeyError as e:
adminbae64d82013-08-01 10:50:15 -0700127 print "Key Error in assertion"
Jon Hall1306a562015-09-04 11:21:24 -0700128 print e
adminbae64d82013-08-01 10:50:15 -0700129 return main.FALSE
Jon Hall8ce34e82015-06-05 10:41:45 -0700130
adminbae64d82013-08-01 10:50:15 -0700131 if opcode == '=~':
132 try:
133 assert re.search(str(arguments["EXPECT"]),str(arguments["ACTUAL"]))
134 result = main.TRUE
135 except AssertionError:
136 try :
Jon Hall8ce34e82015-06-05 10:41:45 -0700137 assert re.match(str(arguments["EXPECT"]),str(arguments["ACTUAL"]))
adminbae64d82013-08-01 10:50:15 -0700138 result = main.TRUE
139 except AssertionError:
140 main.log.error("Assertion Failed")
141 result = main.FALSE
adminbae64d82013-08-01 10:50:15 -0700142 else :
143 try:
144 if str(opcode)=="==":
145 main.log.info("Verifying the Expected is equal to the actual or not using assert_equal")
146 if (arguments["EXPECT"] == arguments["ACTUAL"]):
147 result = main.TRUE
148 else :
149 result = main.FALSE
adminbae64d82013-08-01 10:50:15 -0700150 elif str(opcode) == ">":
151 main.log.info("Verifying the Expected is Greater than the actual or not using assert_greater")
152 if (ast.literal_eval(arguments["EXPECT"]) > ast.literal_eval(arguments["ACTUAL"])) :
153 result = main.TRUE
154 else :
155 result = main.FALSE
adminbae64d82013-08-01 10:50:15 -0700156 elif str(opcode) == "<":
157 main.log.info("Verifying the Expected is Lesser than the actual or not using assert_lesser")
158 if (ast.literal_eval(arguments["EXPECT"]) < ast.literal_eval(arguments["ACTUAL"])):
159 result = main.TRUE
160 else :
161 result = main.FALSE
adminbae64d82013-08-01 10:50:15 -0700162 except AssertionError:
163 main.log.error("Assertion Failed")
164 result = main.FALSE
adminbae64d82013-08-01 10:50:15 -0700165 result = result if result else 0
166 result = not result if arguments["NOT"] and arguments["NOT"] == 1 else result
167 resultString = ""
168 if result :
169 resultString = str(resultString) + "PASS"
170 main.log.info(arguments["ONPASS"])
171 else :
172 resultString = str(resultString) + "FAIL"
173 if not isinstance(arguments["ONFAIL"],str):
174 eval(str(arguments["ONFAIL"]))
175 else :
176 main.log.error(arguments["ONFAIL"])
177 main.log.report(arguments["ONFAIL"])
Jon Hall90627612015-06-09 14:57:02 -0700178 main.onFailMsg = arguments[ 'ONFAIL' ]
Jon Hall8ce34e82015-06-05 10:41:45 -0700179
adminbae64d82013-08-01 10:50:15 -0700180 msg = arguments["ON" + str(resultString)]
181
182 if not isinstance(msg,str):
183 try:
184 eval(str(msg))
Jon Hall1306a562015-09-04 11:21:24 -0700185 except SyntaxError as e:
186 print "function definition is not right"
187 print e
adminbae64d82013-08-01 10:50:15 -0700188
189 main.last_result = result
Jon Hall80577e72015-09-29 14:07:25 -0700190 if main.stepResults[2]:
191 main.stepResults[2][-1] = result
192 try:
193 main.stepResults[3][-1] = arguments[ 'ONFAIL' ]
194 except AttributeError:
195 pass
196 else:
197 main.log.warn( "Assertion called before a test step" )
adminbae64d82013-08-01 10:50:15 -0700198 return result
Jon Hall8ce34e82015-06-05 10:41:45 -0700199
adminbae64d82013-08-01 10:50:15 -0700200 def parse_args(self,args, **kwargs):
201 '''
202 It will accept the (key,value) pair and will return the (key,value) pairs with keys in uppercase.
203 '''
204 newArgs = {}
205 for key,value in kwargs.iteritems():
adminbae64d82013-08-01 10:50:15 -0700206 if isinstance(args,list) and str.upper(key) in args:
Jon Hall4ba53f02015-07-29 13:07:41 -0700207 for each in args:
adminbae64d82013-08-01 10:50:15 -0700208 if each==str.upper(key):
209 newArgs [str(each)] = value
210 elif each != str.upper(key) and (newArgs.has_key(str(each)) == False ):
211 newArgs[str(each)] = None
Jon Hall4ba53f02015-07-29 13:07:41 -0700212
adminbae64d82013-08-01 10:50:15 -0700213 return newArgs
Jon Hall4ba53f02015-07-29 13:07:41 -0700214
adminbae64d82013-08-01 10:50:15 -0700215 def send_mail(self):
216 # Create a text/plain message
217 msg = email.mime.Multipart.MIMEMultipart()
218 try :
219 if main.test_target:
Jon Hall25079782015-10-13 13:54:39 -0700220 sub = "Result summary of \"" + main.TEST + "\" run on component \"" +\
221 main.test_target + "\" Version \"" +\
222 vars( main )[main.test_target].get_version() + "\": " +\
223 str( main.TOTAL_TC_SUCCESS ) + "% Passed"
adminbae64d82013-08-01 10:50:15 -0700224 else :
Jon Hall25079782015-10-13 13:54:39 -0700225 sub = "Result summary of \"" + main.TEST + "\": " +\
226 str( main.TOTAL_TC_SUCCESS ) + "% Passed"
Jon Hall1306a562015-09-04 11:21:24 -0700227 except ( KeyError, AttributeError ):
Jon Hall25079782015-10-13 13:54:39 -0700228 sub = "Result summary of \"" + main.TEST + "\": " +\
229 str( main.TOTAL_TC_SUCCESS ) + "% Passed"
Jon Hall4ba53f02015-07-29 13:07:41 -0700230
adminbae64d82013-08-01 10:50:15 -0700231 msg['Subject'] = sub
Jon Hall25079782015-10-13 13:54:39 -0700232 msg['From'] = main.sender
adminbae64d82013-08-01 10:50:15 -0700233 msg['To'] = main.mail
Jon Hall4ba53f02015-07-29 13:07:41 -0700234
adminbae64d82013-08-01 10:50:15 -0700235 # The main body is just another attachment
Jon Hall25079782015-10-13 13:54:39 -0700236 body = email.mime.Text.MIMEText( main.logHeader + "\n" +
237 main.testResult)
238 msg.attach( body )
Jon Hall4ba53f02015-07-29 13:07:41 -0700239
Jon Hall25079782015-10-13 13:54:39 -0700240 # Attachments
241 for filename in os.listdir( main.logdir ):
242 filepath = main.logdir + "/" + filename
243 fp = open( filepath, 'rb' )
244 att = email.mime.application.MIMEApplication( fp.read(),
245 _subtype="" )
adminbae64d82013-08-01 10:50:15 -0700246 fp.close()
Jon Hall25079782015-10-13 13:54:39 -0700247 att.add_header( 'Content-Disposition',
248 'attachment',
249 filename=filename )
250 msg.attach( att )
251 try:
252 smtp = smtplib.SMTP( main.smtp )
253 smtp.starttls()
254 smtp.login( main.sender, main.senderPwd )
255 smtp.sendmail( msg['From'], [msg['To']], msg.as_string() )
256 smtp.quit()
257 except Exception:
258 main.log.exception( "Error sending email" )
Jon Hall4ba53f02015-07-29 13:07:41 -0700259 return main.TRUE
260
Jon Hall25079782015-10-13 13:54:39 -0700261 def send_warning_email( self, subject=None ):
262 try:
263 if not subject:
264 subject = main.TEST + " PAUSED!"
265 # Create a text/plain message
266 msg = email.mime.Multipart.MIMEMultipart()
267
268 msg['Subject'] = subject
269 msg['From'] = main.sender
270 msg['To'] = main.mail
271
272 smtp = smtplib.SMTP( main.smtp )
273 smtp.starttls()
274 smtp.login( main.sender, main.senderPwd )
275 smtp.sendmail( msg['From'], [msg['To']], msg.as_string() )
276 smtp.quit()
277 except Exception:
278 main.log.exception( "" )
279 return main.FALSE
280 return main.TRUE
Jon Hall4ba53f02015-07-29 13:07:41 -0700281
adminbae64d82013-08-01 10:50:15 -0700282 def parse(self,fileName):
283 '''
284 This will parse the params or topo or cfg file and return content in the file as Dictionary
285 '''
286 self.fileName = fileName
Jon Hall4ba53f02015-07-29 13:07:41 -0700287 matchFileName = re.match(r'(.*)\.(cfg|params|topo)',self.fileName,re.M|re.I)
adminbae64d82013-08-01 10:50:15 -0700288 if matchFileName:
289 try :
290 parsedInfo = ConfigObj(self.fileName)
291 return parsedInfo
Jon Hall1306a562015-09-04 11:21:24 -0700292 except StandardError:
Jon Hall4ba53f02015-07-29 13:07:41 -0700293 print "There is no such file to parse "+fileName
adminbae64d82013-08-01 10:50:15 -0700294 else:
Jon Hall4ba53f02015-07-29 13:07:41 -0700295 return 0
adminbae64d82013-08-01 10:50:15 -0700296
Jon Hall095730a2015-12-17 14:57:45 -0800297 def retry( self, f, retValue, args=(), kwargs={},
Devin Lima4f95bc2017-08-11 11:13:03 -0700298 sleep=1, attempts=2, randomTime=False,
299 getRetryingTime=False ):
Jon Hall095730a2015-12-17 14:57:45 -0800300 """
301 Given a function and bad return values, retry will retry a function
302 until successful or give up after a certain number of attempts.
303
304 Arguments:
305 f - a callable object
306 retValue - Return value(s) of f to retry on. This can be a list or an
307 object.
308 args - A tuple containing the arguments of f.
309 kwargs - A dictionary containing the keyword arguments of f.
310 sleep - Time in seconds to sleep between retries. If random is True,
311 this is the max time to wait. Defaults to 1 second.
312 attempts - Max number of attempts before returning. If set to 1,
313 f will only be called once. Defaults to 2 trys.
314 random - Boolean indicating if the wait time is random between 0
315 and sleep or exactly sleep seconds. Defaults to False.
316 """
317 # TODO: be able to pass in a conditional statement(s). For example:
318 # retCondition = "< 7"
319 # Then we do something like 'if eval( "ret " + retCondition ):break'
320 try:
321 assert attempts > 0, "attempts must be more than 1"
322 assert sleep >= 0, "sleep must be >= 0"
323 if not isinstance( retValue, list ):
324 retValue = [ retValue ]
Devin Lima4f95bc2017-08-11 11:13:03 -0700325 if getRetryingTime:
326 startTime = time.time()
Jon Hall095730a2015-12-17 14:57:45 -0800327 for i in range( 0, attempts ):
328 ret = f( *args, **kwargs )
329 if ret not in retValue:
330 # NOTE that False in [ 0 ] == True
331 break
332 if randomTime:
333 sleeptime = random.randint( 0, sleep )
334 else:
335 sleeptime = sleep
336 time.sleep( sleeptime )
Jon Hall2ad817e2017-05-18 11:13:10 -0700337 if i > 0:
338 main.log.debug( str( f ) + " was retried " + str( i ) + " times." )
Devin Lima4f95bc2017-08-11 11:13:03 -0700339 if getRetryingTime:
340 main.log.debug( "Took " + str( time.time() - startTime ) + " seconds for retrying." )
Jon Hall095730a2015-12-17 14:57:45 -0800341 return ret
342 except AssertionError:
343 main.log.exception( "Invalid arguements for retry: " )
Devin Lim44075962017-08-11 10:56:37 -0700344 main.cleanAndExit()
Jon Hall095730a2015-12-17 14:57:45 -0800345 except Exception:
346 main.log.exception( "Uncaught exception in retry: " )
Devin Lim44075962017-08-11 10:56:37 -0700347 main.cleanAndExit()
Jon Hall095730a2015-12-17 14:57:45 -0800348
adminbae64d82013-08-01 10:50:15 -0700349
350if __name__ != "__main__":
351 import sys
Jon Hall4ba53f02015-07-29 13:07:41 -0700352
353 sys.modules[__name__] = Utilities()