blob: e15e53ca53f40ce4127473a0f4002a3cdefc841c [file] [log] [blame]
adminbae64d82013-08-01 10:50:15 -07001#!/usr/bin/env python
kelvin-onlabedcff052015-01-16 12:53:55 -08002"""
adminbae64d82013-08-01 10:50:15 -07003Created on 26-Oct-2012
4
kelvin-onlabedcff052015-01-16 12:53:55 -08005author:: Anil Kumar ( anilkumar.s@paxterrasolutions.com )
adminbae64d82013-08-01 10:50:15 -07006
7
8 TestON is free software: you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation, either version 2 of the License, or
kelvin-onlabedcff052015-01-16 12:53:55 -080011 ( at your option ) any later version.
adminbae64d82013-08-01 10:50:15 -070012
13 TestON is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
17
18 You should have received a copy of the GNU General Public License
Jon Hallfbc828e2015-01-06 17:30:19 -080019 along with TestON. If not, see <http://www.gnu.org/licenses/>.
adminbae64d82013-08-01 10:50:15 -070020
21
22MininetCliDriver is the basic driver which will handle the Mininet functions
kelvin-onlabedcff052015-01-16 12:53:55 -080023"""
admin2a9548d2014-06-17 14:08:07 -070024import traceback
adminbae64d82013-08-01 10:50:15 -070025import pexpect
adminbae64d82013-08-01 10:50:15 -070026import re
27import sys
kelvin-onlabedcff052015-01-16 12:53:55 -080028sys.path.append( "../" )
adminbae64d82013-08-01 10:50:15 -070029from drivers.common.cli.emulatordriver import Emulator
adminbae64d82013-08-01 10:50:15 -070030
kelvin-onlabedcff052015-01-16 12:53:55 -080031
32class RemoteMininetDriver( Emulator ):
33
34 """
kelvin-onlabd3b64892015-01-20 13:26:24 -080035 RemoteMininetCliDriver is the basic driver which will handle the Mininet
36 functions. The main different between this and the MininetCliDriver is that
37 this one does not build the mininet. It assumes that there is already a
38 mininet running on the target.
kelvin-onlabedcff052015-01-16 12:53:55 -080039 """
40 def __init__( self ):
41 super( Emulator, self ).__init__()
adminbae64d82013-08-01 10:50:15 -070042 self.handle = self
kelvin-onlabedcff052015-01-16 12:53:55 -080043 self.wrapped = sys.modules[ __name__ ]
adminbae64d82013-08-01 10:50:15 -070044 self.flag = 0
45
kelvin-onlabedcff052015-01-16 12:53:55 -080046 def connect( self, **connectargs ):
kelvin-onlab08679eb2015-01-21 16:11:48 -080047 """,user_name, ip_address, pwd,options ):
kelvin-onlabd3b64892015-01-20 13:26:24 -080048 Here the main is the TestON instance after creating all the log
49 handles."""
adminbae64d82013-08-01 10:50:15 -070050 for key in connectargs:
kelvin-onlabedcff052015-01-16 12:53:55 -080051 vars( self )[ key ] = connectargs[ key ]
Jon Hallfbc828e2015-01-06 17:30:19 -080052
kelvin-onlabedcff052015-01-16 12:53:55 -080053 self.name = self.options[ 'name' ]
54 self.handle = super(
55 RemoteMininetDriver,
56 self ).connect(
kelvin-onlab08679eb2015-01-21 16:11:48 -080057 user_name=self.user_name,
58 ip_address=self.ip_address,
kelvin-onlabedcff052015-01-16 12:53:55 -080059 port=None,
60 pwd=self.pwd )
Jon Hallfbc828e2015-01-06 17:30:19 -080061
kelvin-onlabd3b64892015-01-20 13:26:24 -080062 self.sshHandle = self.handle
Jon Hallfbc828e2015-01-06 17:30:19 -080063
64 # Copying the readme file to process the
kelvin-onlabedcff052015-01-16 12:53:55 -080065 if self.handle:
adminbae64d82013-08-01 10:50:15 -070066 return main.TRUE
67
kelvin-onlabedcff052015-01-16 12:53:55 -080068 else:
69 main.log.error(
70 "Connection failed to the host " +
kelvin-onlab08679eb2015-01-21 16:11:48 -080071 self.user_name +
kelvin-onlabedcff052015-01-16 12:53:55 -080072 "@" +
kelvin-onlab08679eb2015-01-21 16:11:48 -080073 self.ip_address )
kelvin-onlabedcff052015-01-16 12:53:55 -080074 main.log.error( "Failed to connect to the Mininet" )
adminbae64d82013-08-01 10:50:15 -070075 return main.FALSE
admin98ad0092014-07-23 16:51:07 -070076
kelvin-onlabedcff052015-01-16 12:53:55 -080077 def checkForLoss( self, pingList ):
78 """
Jon Hall6c794f32014-08-14 13:33:13 -070079 Returns main.FALSE for 0% packet loss and
80 Returns main.ERROR if "found multiple mininet" is found and
81 Returns main.TRUE else
kelvin-onlabedcff052015-01-16 12:53:55 -080082 """
kelvin-onlabedcff052015-01-16 12:53:55 -080083 self.handle.sendline( "" )
84 self.handle.expect( "\$" )
kelvin-onlabedcff052015-01-16 12:53:55 -080085 self.handle.sendline( "" )
86 self.handle.expect( "\$" )
87 self.handle.sendline( "cat " + pingList )
88 self.handle.expect( pingList )
89 self.handle.expect( "\$" )
admin2580a0e2014-07-29 11:24:34 -070090 outputs = self.handle.before + self.handle.after
kelvin-onlabedcff052015-01-16 12:53:55 -080091 if re.search( " 0% packet loss", outputs ):
admin98ad0092014-07-23 16:51:07 -070092 return main.FALSE
kelvin-onlabedcff052015-01-16 12:53:55 -080093 elif re.search( "found multiple mininet", outputs ):
admin2580a0e2014-07-29 11:24:34 -070094 return main.ERROR
shahshreyaf4d4d0c2014-10-10 12:11:10 -070095 else:
kelvin-onlabedcff052015-01-16 12:53:55 -080096 main.log.error( "Error, unexpected output in the ping file" )
Jon Hall2ef1e9e2014-11-18 14:27:05 -050097 main.log.warn( outputs )
shahshreyaf4d4d0c2014-10-10 12:11:10 -070098 return main.TRUE
99
kelvin-onlabedcff052015-01-16 12:53:55 -0800100 def pingLong( self, **pingParams ):
101 """
kelvin-onlabd3b64892015-01-20 13:26:24 -0800102 Starts a continuous ping on the mininet host outputing
103 to a file in the /tmp dir.
kelvin-onlabedcff052015-01-16 12:53:55 -0800104 """
105 self.handle.sendline( "" )
106 self.handle.expect( "\$" )
kelvin-onlab7d0c9672015-01-20 15:56:22 -0800107 args = utilities.parse_args(
kelvin-onlabedcff052015-01-16 12:53:55 -0800108 [ "SRC", "TARGET", "PINGTIME" ], **pingParams )
109 precmd = "sudo rm /tmp/ping." + args[ "SRC" ]
110 self.execute( cmd=precmd, prompt="(.*)", timeout=10 )
kelvin-onlabd3b64892015-01-20 13:26:24 -0800111 command = "sudo mininet/util/m " + args[ "SRC" ] + " ping " +\
112 args[ "TARGET" ] + " -i .2 -w " + str( args[ 'PINGTIME' ] ) +\
113 " -D > /tmp/ping." + args[ "SRC" ] + " &"
Jon Hallfbc828e2015-01-06 17:30:19 -0800114 main.log.info( command )
kelvin-onlabedcff052015-01-16 12:53:55 -0800115 self.execute( cmd=command, prompt="(.*)", timeout=10 )
116 self.handle.sendline( "" )
117 self.handle.expect( "\$" )
adminbae64d82013-08-01 10:50:15 -0700118 return main.TRUE
119
kelvin-onlabedcff052015-01-16 12:53:55 -0800120 def pingstatus( self, **pingParams ):
121 """
kelvin-onlabd3b64892015-01-20 13:26:24 -0800122 Tails the respective ping output file and check that
123 there is a moving "64 bytes"
kelvin-onlabedcff052015-01-16 12:53:55 -0800124 """
125 self.handle.sendline( "" )
126 self.handle.expect( "\$" )
kelvin-onlab7d0c9672015-01-20 15:56:22 -0800127 args = utilities.parse_args( [ "SRC" ], **pingParams )
kelvin-onlabedcff052015-01-16 12:53:55 -0800128 self.handle.sendline( "tail /tmp/ping." + args[ "SRC" ] )
129 self.handle.expect( "tail" )
130 self.handle.expect( "\$" )
adminbae64d82013-08-01 10:50:15 -0700131 result = self.handle.before + self.handle.after
kelvin-onlabedcff052015-01-16 12:53:55 -0800132 self.handle.sendline( "" )
133 self.handle.expect( "\$" )
134 if re.search( 'Unreachable', result ):
135 main.log.info( "Unreachable found in ping logs..." )
adminbae64d82013-08-01 10:50:15 -0700136 return main.FALSE
kelvin-onlabedcff052015-01-16 12:53:55 -0800137 elif re.search( '64\sbytes', result ):
138 main.log.info( "Pings look good" )
adminbae64d82013-08-01 10:50:15 -0700139 return main.TRUE
Jon Hallfbc828e2015-01-06 17:30:19 -0800140 else:
kelvin-onlabedcff052015-01-16 12:53:55 -0800141 main.log.info( "No, or faulty ping data..." )
adminbae64d82013-08-01 10:50:15 -0700142 return main.FALSE
Jon Hallfbc828e2015-01-06 17:30:19 -0800143
kelvin-onlabedcff052015-01-16 12:53:55 -0800144 def pingKill( self, testONUser, testONIP ):
145 """
adminaeedddd2013-08-02 15:14:15 -0700146 Kills all continuous ping processes.
147 Then copies all the ping files to the TestStation.
kelvin-onlabedcff052015-01-16 12:53:55 -0800148 """
149 self.handle.sendline( "" )
150 self.handle.expect( "\$" )
Jon Hallfbc828e2015-01-06 17:30:19 -0800151 command = "sudo kill -SIGINT `pgrep ping`"
152 main.log.info( command )
kelvin-onlabedcff052015-01-16 12:53:55 -0800153 self.execute( cmd=command, prompt="(.*)", timeout=10 )
Jon Hallfbc828e2015-01-06 17:30:19 -0800154
adminbae64d82013-08-01 10:50:15 -0700155 main.log.info( "Transferring ping files to TestStation" )
kelvin-onlabedcff052015-01-16 12:53:55 -0800156 command = "scp /tmp/ping.* " + \
157 str( testONUser ) + "@" + str( testONIP ) + ":/tmp/"
158 self.execute( cmd=command, prompt="100%", timeout=20 )
159 # Make sure the output is cleared
160 self.handle.sendline( "" )
161 self.handle.expect( "\$" )
162 self.handle.sendline( "" )
163 self.handle.expect( "\$" )
164 self.handle.sendline( "" )
165 i = self.handle.expect( [ "password", "\$" ] )
Jon Hall368769f2014-11-19 15:43:35 -0800166 if i == 0:
kelvin-onlabedcff052015-01-16 12:53:55 -0800167 main.log.error( "Error, sudo asking for password" )
168 main.log.error( self.handle.before )
Jon Hall368769f2014-11-19 15:43:35 -0800169 return main.FALSE
170 else:
171 return main.TRUE
Jon Hallfbc828e2015-01-06 17:30:19 -0800172
kelvin-onlabedcff052015-01-16 12:53:55 -0800173 def pingLongKill( self ):
174 self.handle.sendline( "" )
175 self.handle.expect( "\$" )
admin2580a0e2014-07-29 11:24:34 -0700176 command = "sudo kill -SIGING `pgrep ping`"
kelvin-onlabedcff052015-01-16 12:53:55 -0800177 main.log.info( command )
178 self.execute( cmd=command, prompt="(.*)", timeout=10 )
179 self.handle.sendline( "" )
180 self.handle.expect( "\$" )
adminbae64d82013-08-01 10:50:15 -0700181 return main.TRUE
Jon Hallfbc828e2015-01-06 17:30:19 -0800182
kelvin-onlabedcff052015-01-16 12:53:55 -0800183 def pingHostOptical( self, **pingParams ):
184 """
shahshreya28bb18e2014-11-17 10:26:23 -0800185 This function is only for Packey Optical related ping
kelvin-onlabedcff052015-01-16 12:53:55 -0800186 Use the next pingHost() function for all normal scenarios )
shahshreya28bb18e2014-11-17 10:26:23 -0800187 Ping from one mininet host to another
188 Currently the only supported Params: SRC and TARGET
kelvin-onlabedcff052015-01-16 12:53:55 -0800189 """
kelvin-onlab7d0c9672015-01-20 15:56:22 -0800190 args = utilities.parse_args( [ "SRC", "TARGET" ], **pingParams )
kelvin-onlabedcff052015-01-16 12:53:55 -0800191 command = args[ "SRC" ] + " ping " + \
192 args[ "TARGET" ] + " -c 1 -i 1 -W 8"
shahshreya28bb18e2014-11-17 10:26:23 -0800193 try:
kelvin-onlabedcff052015-01-16 12:53:55 -0800194 main.log.warn( "Sending: " + command )
kelvin-onlabedcff052015-01-16 12:53:55 -0800195 self.handle.sendline( command )
196 i = self.handle.expect( [ command, pexpect.TIMEOUT ] )
shahshreya28bb18e2014-11-17 10:26:23 -0800197 if i == 1:
kelvin-onlabedcff052015-01-16 12:53:55 -0800198 main.log.error(
199 self.name +
200 ": timeout when waiting for response from mininet" )
201 main.log.error( "response: " + str( self.handle.before ) )
202 i = self.handle.expect( [ "mininet>", pexpect.TIMEOUT ] )
shahshreya28bb18e2014-11-17 10:26:23 -0800203 if i == 1:
kelvin-onlabedcff052015-01-16 12:53:55 -0800204 main.log.error(
205 self.name +
206 ": timeout when waiting for response from mininet" )
207 main.log.error( "response: " + str( self.handle.before ) )
shahshreya28bb18e2014-11-17 10:26:23 -0800208 response = self.handle.before
209 except pexpect.EOF:
kelvin-onlabedcff052015-01-16 12:53:55 -0800210 main.log.error( self.name + ": EOF exception found" )
211 main.log.error( self.name + ": " + self.handle.before )
shahshreya28bb18e2014-11-17 10:26:23 -0800212 main.cleanup()
213 main.exit()
kelvin-onlabedcff052015-01-16 12:53:55 -0800214 main.log.info( self.name + ": Ping Response: " + response )
kelvin-onlabedcff052015-01-16 12:53:55 -0800215 if re.search( ',\s0\%\spacket\sloss', response ):
216 main.log.info( self.name + ": no packets lost, host is reachable" )
kelvin-onlabd3b64892015-01-20 13:26:24 -0800217 main.lastResult = main.TRUE
shahshreya28bb18e2014-11-17 10:26:23 -0800218 return main.TRUE
kelvin-onlabedcff052015-01-16 12:53:55 -0800219 else:
220 main.log.error(
221 self.name +
222 ": PACKET LOST, HOST IS NOT REACHABLE" )
kelvin-onlabd3b64892015-01-20 13:26:24 -0800223 main.lastResult = main.FALSE
shahshreya28bb18e2014-11-17 10:26:23 -0800224 return main.FALSE
225
kelvin-onlabedcff052015-01-16 12:53:55 -0800226 def pingHost( self, **pingParams ):
227 """
Jon Hallfbc828e2015-01-06 17:30:19 -0800228 Pings between two hosts on remote mininet
kelvin-onlabedcff052015-01-16 12:53:55 -0800229 """
230 self.handle.sendline( "" )
231 self.handle.expect( "\$" )
kelvin-onlab7d0c9672015-01-20 15:56:22 -0800232 args = utilities.parse_args( [ "SRC", "TARGET" ], **pingParams )
kelvin-onlabedcff052015-01-16 12:53:55 -0800233 command = "mininet/util/m " + \
234 args[ "SRC" ] + " ping " + args[ "TARGET" ] + " -c 4 -W 1 -i .2"
235 main.log.info( command )
236 response = self.execute( cmd=command, prompt="rtt", timeout=10 )
kelvin-onlab7d0c9672015-01-20 15:56:22 -0800237 if utilities.assert_matches(
kelvin-onlabedcff052015-01-16 12:53:55 -0800238 expect=',\s0\%\spacket\sloss',
239 actual=response,
240 onpass="No Packet loss",
241 onfail="Host is not reachable" ):
242 main.log.info( "NO PACKET LOSS, HOST IS REACHABLE" )
kelvin-onlabd3b64892015-01-20 13:26:24 -0800243 main.lastResult = main.TRUE
adminbae64d82013-08-01 10:50:15 -0700244 return main.TRUE
kelvin-onlabedcff052015-01-16 12:53:55 -0800245 else:
246 main.log.error( "PACKET LOST, HOST IS NOT REACHABLE" )
kelvin-onlabd3b64892015-01-20 13:26:24 -0800247 main.lastResult = main.FALSE
adminbae64d82013-08-01 10:50:15 -0700248 return main.FALSE
Jon Hallfbc828e2015-01-06 17:30:19 -0800249
kelvin-onlabedcff052015-01-16 12:53:55 -0800250 def checknum( self, num ):
251 """
Jon Hallfbc828e2015-01-06 17:30:19 -0800252 Verifies the correct number of switches are running
kelvin-onlabedcff052015-01-16 12:53:55 -0800253 """
254 if self.handle:
255 self.handle.sendline( "" )
256 self.handle.expect( "\$" )
257 self.handle.sendline( 'ifconfig -a | grep "sw.. " | wc -l' )
258 self.handle.expect( "wc" )
259 self.handle.expect( "\$" )
adminbae64d82013-08-01 10:50:15 -0700260 response = self.handle.before
kelvin-onlabedcff052015-01-16 12:53:55 -0800261 self.handle.sendline(
262 'ps -ef | grep "bash -ms mininet:sw" | grep -v color | wc -l' )
263 self.handle.expect( "color" )
264 self.handle.expect( "\$" )
adminbae64d82013-08-01 10:50:15 -0700265 response2 = self.handle.before
266
kelvin-onlabedcff052015-01-16 12:53:55 -0800267 if re.search( num, response ):
268 if re.search( num, response2 ):
adminbae64d82013-08-01 10:50:15 -0700269 return main.TRUE
270 else:
271 return main.FALSE
272 else:
273 return main.FALSE
kelvin-onlabedcff052015-01-16 12:53:55 -0800274 else:
275 main.log.error( "Connection failed to the host" )
adminbae64d82013-08-01 10:50:15 -0700276
kelvin-onlabd3b64892015-01-20 13:26:24 -0800277 def startTcpdump(
kelvin-onlabedcff052015-01-16 12:53:55 -0800278 self,
279 filename,
280 intf="eth0",
281 port="port 6633",
282 user="admin" ):
283 """
admin2a9548d2014-06-17 14:08:07 -0700284 Runs tpdump on an intferface and saves the file
285 intf can be specified, or the default eth0 is used
kelvin-onlabedcff052015-01-16 12:53:55 -0800286 """
admin2a9548d2014-06-17 14:08:07 -0700287 try:
kelvin-onlabedcff052015-01-16 12:53:55 -0800288 self.handle.sendline( "" )
289 self.handle.sendline(
290 "sudo tcpdump -n -i " +
291 intf +
292 " " +
293 port +
294 " -w " +
295 filename.strip() +
296 " -Z " +
297 user +
298 " &" )
299 self.handle.sendline( "" )
300 self.handle.sendline( "" )
kelvin-onlabd3b64892015-01-20 13:26:24 -0800301 i = self.handle.expect( [ 'No\ssuch\device', 'listening\son',
302 pexpect.TIMEOUT, "\$" ], timeout=10 )
kelvin-onlabedcff052015-01-16 12:53:55 -0800303 main.log.warn( self.handle.before + self.handle.after )
admin2a9548d2014-06-17 14:08:07 -0700304 if i == 0:
kelvin-onlabd3b64892015-01-20 13:26:24 -0800305 main.log.error( self.name + ": tcpdump - No such device exists.\
306 tcpdump attempted on: " + intf )
admin2a9548d2014-06-17 14:08:07 -0700307 return main.FALSE
308 elif i == 1:
kelvin-onlabedcff052015-01-16 12:53:55 -0800309 main.log.info( self.name + ": tcpdump started on " + intf )
admin2a9548d2014-06-17 14:08:07 -0700310 return main.TRUE
311 elif i == 2:
kelvin-onlabd3b64892015-01-20 13:26:24 -0800312 main.log.error( self.name + ": tcpdump command timed out!\
313 Check interface name, given interface was: " + intf )
admin2a9548d2014-06-17 14:08:07 -0700314 return main.FALSE
kelvin-onlabedcff052015-01-16 12:53:55 -0800315 elif i == 3:
316 main.log.info( self.name + ": " + self.handle.before )
admin2a9548d2014-06-17 14:08:07 -0700317 return main.TRUE
318 else:
kelvin-onlabedcff052015-01-16 12:53:55 -0800319 main.log.error( self.name + ": tcpdump - unexpected response" )
admin2a9548d2014-06-17 14:08:07 -0700320 return main.FALSE
321 except pexpect.EOF:
kelvin-onlabedcff052015-01-16 12:53:55 -0800322 main.log.error( self.name + ": EOF exception found" )
323 main.log.error( self.name + ": " + self.handle.before )
admin2a9548d2014-06-17 14:08:07 -0700324 main.cleanup()
325 main.exit()
326 except:
kelvin-onlabedcff052015-01-16 12:53:55 -0800327 main.log.info(
kelvin-onlabd3b64892015-01-20 13:26:24 -0800328 self.name + ":" * 60 )
kelvin-onlab64b33712015-01-21 15:26:15 -0800329 main.log.error( traceback.print_exc() )
kelvin-onlabd3b64892015-01-20 13:26:24 -0800330 main.log.info( ":" * 80 )
admin2a9548d2014-06-17 14:08:07 -0700331 main.cleanup()
332 main.exit()
333
kelvin-onlabd3b64892015-01-20 13:26:24 -0800334 def stopTcpdump( self ):
admin2a9548d2014-06-17 14:08:07 -0700335 "pkills tcpdump"
336 try:
kelvin-onlabedcff052015-01-16 12:53:55 -0800337 self.handle.sendline( "sudo pkill tcpdump" )
338 self.handle.sendline( "" )
339 self.handle.sendline( "" )
340 self.handle.expect( "\$" )
admin2a9548d2014-06-17 14:08:07 -0700341 except pexpect.EOF:
kelvin-onlabedcff052015-01-16 12:53:55 -0800342 main.log.error( self.name + ": EOF exception found" )
343 main.log.error( self.name + ": " + self.handle.before )
admin2a9548d2014-06-17 14:08:07 -0700344 main.cleanup()
345 main.exit()
346 except:
kelvin-onlabedcff052015-01-16 12:53:55 -0800347 main.log.info(
kelvin-onlabd3b64892015-01-20 13:26:24 -0800348 self.name + ":" * 60 )
kelvin-onlab64b33712015-01-21 15:26:15 -0800349 main.log.error( traceback.print_exc() )
kelvin-onlabd3b64892015-01-20 13:26:24 -0800350 main.log.info( ":" * 80 )
admin2a9548d2014-06-17 14:08:07 -0700351 main.cleanup()
352 main.exit()
353
kelvin-onlabd3b64892015-01-20 13:26:24 -0800354 def runOpticalMnScript( self ):
kelvin-onlabedcff052015-01-16 12:53:55 -0800355 """
Jon Hallfbc828e2015-01-06 17:30:19 -0800356 This function is only meant for Packet Optical.
kelvin-onlabd3b64892015-01-20 13:26:24 -0800357 It runs the python script "optical.py" to create the
358 packet layer( mn ) topology
kelvin-onlabedcff052015-01-16 12:53:55 -0800359 """
shahshreya28bb18e2014-11-17 10:26:23 -0800360 try:
kelvin-onlabedcff052015-01-16 12:53:55 -0800361 self.handle.sendline( "" )
362 self.handle.expect( "\$" )
363 self.handle.sendline( "cd ~" )
364 self.handle.expect( "\$" )
365 self.handle.sendline( "sudo python optical.py" )
366 self.handle.expect( ">" )
shahshreya28bb18e2014-11-17 10:26:23 -0800367 return main.TRUE
368 except pexpect.EOF:
kelvin-onlabedcff052015-01-16 12:53:55 -0800369 main.log.error( self.name + ": EOF exception found" )
370 main.log.error( self.name + ": " + self.handle.before )
shahshreya28bb18e2014-11-17 10:26:23 -0800371 return main.FALSE
adminbae64d82013-08-01 10:50:15 -0700372
kelvin-onlabedcff052015-01-16 12:53:55 -0800373 def disconnect( self ):
374 """
Jon Hallfbc828e2015-01-06 17:30:19 -0800375 Called at the end of the test to disconnect the handle.
kelvin-onlabedcff052015-01-16 12:53:55 -0800376 """
adminbae64d82013-08-01 10:50:15 -0700377 response = ''
kelvin-onlabedcff052015-01-16 12:53:55 -0800378 # print "Disconnecting Mininet"
adminbae64d82013-08-01 10:50:15 -0700379 if self.handle:
kelvin-onlabedcff052015-01-16 12:53:55 -0800380 self.handle.sendline( "exit" )
381 self.handle.expect( "exit" )
382 self.handle.expect( "(.*)" )
adminbae64d82013-08-01 10:50:15 -0700383 response = self.handle.before
384
kelvin-onlabedcff052015-01-16 12:53:55 -0800385 else:
386 main.log.error( "Connection failed to the host" )
adminbae64d82013-08-01 10:50:15 -0700387 response = main.FALSE
Jon Hall2ef1e9e2014-11-18 14:27:05 -0500388 return response
adminbae64d82013-08-01 10:50:15 -0700389
kelvin-onlabd3b64892015-01-20 13:26:24 -0800390 def getFlowTable( self, protoVersion, sw ):
391 """
392 TODO document usage
393 TODO add option to look at cookies. ignoreing them for now
394
395 print "get_flowTable(" + str( protoVersion ) +" " + str( sw ) +")"
396 NOTE: Use format to force consistent flow table output across
397 versions"""
kelvin-onlabedcff052015-01-16 12:53:55 -0800398 self.handle.sendline( "cd" )
399 self.handle.expect( [ "\$", pexpect.EOF, pexpect.TIMEOUT ] )
kelvin-onlabedcff052015-01-16 12:53:55 -0800400 if protoVersion == 1.0:
401 command = "sudo ovs-ofctl dump-flows " + sw + \
kelvin-onlabd3b64892015-01-20 13:26:24 -0800402 " -F OpenFlow10-table_id | awk '{OFS=\",\" ; print $1 $3 $6 \
403 $7 $8}' | cut -d ',' -f 2- | sort -n -k1 -r"
kelvin-onlabedcff052015-01-16 12:53:55 -0800404 self.handle.sendline( command )
405 self.handle.expect( [ "k1 -r", pexpect.EOF, pexpect.TIMEOUT ] )
406 self.handle.expect(
407 [ "OFPST_FLOW", pexpect.EOF, pexpect.TIMEOUT ] )
shahshreyaf4d4d0c2014-10-10 12:11:10 -0700408 response = self.handle.before
kelvin-onlabedcff052015-01-16 12:53:55 -0800409 # print "response=", response
shahshreyaf4d4d0c2014-10-10 12:11:10 -0700410 return response
kelvin-onlabedcff052015-01-16 12:53:55 -0800411 elif protoVersion == 1.3:
412 command = "sudo ovs-ofctl dump-flows " + sw + \
kelvin-onlabd3b64892015-01-20 13:26:24 -0800413 " -O OpenFlow13 | awk '{OFS=\",\" ; print $1 $3 $6 $7}'\
414 | cut -d ',' -f 2- | sort -n -k1 -r"
kelvin-onlabedcff052015-01-16 12:53:55 -0800415 self.handle.sendline( command )
416 self.handle.expect( [ "k1 -r", pexpect.EOF, pexpect.TIMEOUT ] )
417 self.handle.expect(
418 [ "OFPST_FLOW", pexpect.EOF, pexpect.TIMEOUT ] )
shahshreyaf4d4d0c2014-10-10 12:11:10 -0700419 response = self.handle.before
kelvin-onlabedcff052015-01-16 12:53:55 -0800420 # print "response=", response
Jon Hall94fd0472014-12-08 11:52:42 -0800421 return response
422 else:
kelvin-onlabedcff052015-01-16 12:53:55 -0800423 main.log.error(
424 "Unknown protoVersion in get_flowTable(). given: (" +
425 str(
426 type( protoVersion ) ) +
427 ") '" +
kelvin-onlabd3b64892015-01-20 13:26:24 -0800428 str( protoVersion ) +
kelvin-onlabedcff052015-01-16 12:53:55 -0800429 "'" )
Jon Hall94fd0472014-12-08 11:52:42 -0800430
kelvin-onlabd3b64892015-01-20 13:26:24 -0800431 def flowComp( self, flow1, flow2 ):
kelvin-onlabedcff052015-01-16 12:53:55 -0800432 if flow1 == flow2:
santhosh19fd8032014-07-29 11:56:17 -0700433 return main.TRUE
434 else:
kelvin-onlabedcff052015-01-16 12:53:55 -0800435 main.log.info( "Flow tables do not match, printing tables:" )
436 main.log.info( "Flow Table 1:" )
437 main.log.info( flow1 )
438 main.log.info( "Flow Table 2:" )
439 main.log.info( flow2 )
santhosh19fd8032014-07-29 11:56:17 -0700440 return main.FALSE
441
kelvin-onlabd3b64892015-01-20 13:26:24 -0800442 def setIpTablesOUTPUT( self, dstIp, dstPort, action='add',
443 packetType='tcp', rule='DROP' ):
kelvin-onlabedcff052015-01-16 12:53:55 -0800444 """
shahshreyaf4d4d0c2014-10-10 12:11:10 -0700445 Description:
kelvin-onlabd3b64892015-01-20 13:26:24 -0800446 add or remove iptables rule to DROP ( default )
447 packets from specific IP and PORT
shahshreyaf4d4d0c2014-10-10 12:11:10 -0700448 Usage:
kelvin-onlabedcff052015-01-16 12:53:55 -0800449 * specify action ( 'add' or 'remove' )
shahshreyaf4d4d0c2014-10-10 12:11:10 -0700450 when removing, pass in the same argument as you would add. It will
Jon Hallfbc828e2015-01-06 17:30:19 -0800451 delete that specific rule.
kelvin-onlabd3b64892015-01-20 13:26:24 -0800452 * specify the destination ip to block with dstIp
453 * specify destination port to block to dstPort
kelvin-onlabedcff052015-01-16 12:53:55 -0800454 * optional packet type to block ( default tcp )
455 * optional iptables rule ( default DROP )
shahshreyaf4d4d0c2014-10-10 12:11:10 -0700456 WARNING:
kelvin-onlabd3b64892015-01-20 13:26:24 -0800457 * This function uses root privilege iptables command which may result
458 in unwanted network errors. USE WITH CAUTION
kelvin-onlabedcff052015-01-16 12:53:55 -0800459 """
shahshreyaf4d4d0c2014-10-10 12:11:10 -0700460 import re
461 import time
462
kelvin-onlabedcff052015-01-16 12:53:55 -0800463 # NOTE*********
shahshreyaf4d4d0c2014-10-10 12:11:10 -0700464 # The strict checking methods of this driver function is intentional
465 # to discourage any misuse or error of iptables, which can cause
466 # severe network errors
kelvin-onlabd3b64892015-01-20 13:26:24 -0800467 # *************
shahshreyaf4d4d0c2014-10-10 12:11:10 -0700468
kelvin-onlabd3b64892015-01-20 13:26:24 -0800469 # NOTE: Sleep needed to give some time
470 # for rule to be added and registered
shahshreyaf4d4d0c2014-10-10 12:11:10 -0700471 # to the instance
kelvin-onlabedcff052015-01-16 12:53:55 -0800472 time.sleep( 5 )
shahshreyaf4d4d0c2014-10-10 12:11:10 -0700473
kelvin-onlabd3b64892015-01-20 13:26:24 -0800474 actionType = action.lower()
475 if actionType != 'add' and actionType != 'remove':
kelvin-onlabedcff052015-01-16 12:53:55 -0800476 main.log.error(
477 "Invalid action type. 'add' or 'remove' table rule" )
shahshreyaf4d4d0c2014-10-10 12:11:10 -0700478 if rule != 'DROP' and rule != 'ACCEPT' and rule != 'LOG':
kelvin-onlabedcff052015-01-16 12:53:55 -0800479 # NOTE: Currently only supports rules DROP, ACCEPT, and LOG
480 main.log.error(
481 "Invalid rule. 'DROP' or 'ACCEPT' or 'LOG' only." )
shahshreyaf4d4d0c2014-10-10 12:11:10 -0700482 return
483 return
484 else:
485
kelvin-onlabedcff052015-01-16 12:53:55 -0800486 # If there is no existing rule in the iptables, we will see an
kelvin-onlabd3b64892015-01-20 13:26:24 -0800487 # 'iptables:'... message. We expect to see this message.
kelvin-onlabedcff052015-01-16 12:53:55 -0800488 # Otherwise, if there IS an existing rule, we will get the prompt
shahshreyaf4d4d0c2014-10-10 12:11:10 -0700489 # back, hence why we expect $ for remove type. We want to remove
490 # an already existing rule
491
kelvin-onlabd3b64892015-01-20 13:26:24 -0800492 if actionType == 'add':
493 # NOTE: "iptables:" expect is a result of
494 # return from the command
495 # iptables -C ...
496 # Any changes by the iptables command return string
497 # will result in failure of the function. ( deemed unlikely
498 # at the time of writing this function )
kelvin-onlabedcff052015-01-16 12:53:55 -0800499 # Check for existing rules on current input
500 self.handle.sendline( "" )
501 self.handle.expect( "\$" )
502 self.handle.sendline(
503 "sudo iptables -C OUTPUT -p " +
kelvin-onlabd3b64892015-01-20 13:26:24 -0800504 str( packetType ) +
kelvin-onlabedcff052015-01-16 12:53:55 -0800505 " -d " +
kelvin-onlabd3b64892015-01-20 13:26:24 -0800506 str( dstIp ) +
kelvin-onlabedcff052015-01-16 12:53:55 -0800507 " --dport " +
kelvin-onlabd3b64892015-01-20 13:26:24 -0800508 str( dstPort ) +
kelvin-onlabedcff052015-01-16 12:53:55 -0800509 " -j " +
510 str( rule ) )
511 i = self.handle.expect( [ "iptables:", "\$" ] )
shahshreyaf4d4d0c2014-10-10 12:11:10 -0700512 print i
513 print self.handle.before
514 print "after: "
515 print self.handle.after
516
kelvin-onlabd3b64892015-01-20 13:26:24 -0800517 elif actionType == 'remove':
kelvin-onlabedcff052015-01-16 12:53:55 -0800518 # Check for existing rules on current input
519 self.handle.sendline( "" )
520 self.handle.expect( "\$" )
521 self.handle.sendline(
522 "sudo iptables -C OUTPUT -p " +
kelvin-onlabd3b64892015-01-20 13:26:24 -0800523 str( packetType ) +
kelvin-onlabedcff052015-01-16 12:53:55 -0800524 " -d " +
kelvin-onlabd3b64892015-01-20 13:26:24 -0800525 str( dstIp ) +
kelvin-onlabedcff052015-01-16 12:53:55 -0800526 " --dport " +
kelvin-onlabd3b64892015-01-20 13:26:24 -0800527 str( dstPort ) +
kelvin-onlabedcff052015-01-16 12:53:55 -0800528 " -j " +
529 str( rule ) )
530 self.handle.expect( "\$" )
shahshreyaf4d4d0c2014-10-10 12:11:10 -0700531 print "before: "
532 print self.handle.before
kelvin-onlabd3b64892015-01-20 13:26:24 -0800533 actualString = self.handle.after
534 expectString = "iptables:"
shahshreyaf4d4d0c2014-10-10 12:11:10 -0700535 print "Actual String:"
kelvin-onlabd3b64892015-01-20 13:26:24 -0800536 print actualString
shahshreyaf4d4d0c2014-10-10 12:11:10 -0700537
kelvin-onlabd3b64892015-01-20 13:26:24 -0800538 if re.search( expectString, actualString ):
539 matchResult = main.TRUE
shahshreyaf4d4d0c2014-10-10 12:11:10 -0700540 else:
kelvin-onlabd3b64892015-01-20 13:26:24 -0800541 matchResult = main.FALSE
542 # If matchResult is main.TRUE, it means there is no matching rule.
shahshreyaf4d4d0c2014-10-10 12:11:10 -0700543
kelvin-onlabd3b64892015-01-20 13:26:24 -0800544 # If tables does not exist and expected prompt is returned,
545 # go ahead and add iptables rule
546 if matchResult == main.TRUE:
kelvin-onlabedcff052015-01-16 12:53:55 -0800547 # Ensure action type is add
kelvin-onlabd3b64892015-01-20 13:26:24 -0800548 if actionType == 'add':
549 # -A is the 'append' action of iptables
550 actionAdd = '-A'
shahshreyaf4d4d0c2014-10-10 12:11:10 -0700551 try:
kelvin-onlabedcff052015-01-16 12:53:55 -0800552 self.handle.sendline( "" )
553 self.handle.sendline(
554 "sudo iptables " +
kelvin-onlabd3b64892015-01-20 13:26:24 -0800555 actionAdd +
kelvin-onlabedcff052015-01-16 12:53:55 -0800556 " OUTPUT -p " +
kelvin-onlabd3b64892015-01-20 13:26:24 -0800557 str( packetType ) +
kelvin-onlabedcff052015-01-16 12:53:55 -0800558 " -d " +
kelvin-onlabd3b64892015-01-20 13:26:24 -0800559 str( dstIp ) +
kelvin-onlabedcff052015-01-16 12:53:55 -0800560 " --dport " +
kelvin-onlabd3b64892015-01-20 13:26:24 -0800561 str( dstPort ) +
kelvin-onlabedcff052015-01-16 12:53:55 -0800562 " -j " +
563 str( rule ) )
shahshreyaf4d4d0c2014-10-10 12:11:10 -0700564
kelvin-onlabd3b64892015-01-20 13:26:24 -0800565 infoString = "Rules added to " + str( self.name )
566 infoString += "iptable rule added to block IP: " + \
567 str( dstIp )
568 infoString += "Port: " + \
569 str( dstPort ) + " Rule: " + str( rule )
shahshreyaf4d4d0c2014-10-10 12:11:10 -0700570
kelvin-onlabd3b64892015-01-20 13:26:24 -0800571 main.log.info( infoString )
shahshreyaf4d4d0c2014-10-10 12:11:10 -0700572
kelvin-onlabedcff052015-01-16 12:53:55 -0800573 self.handle.expect(
574 [ "\$", pexpect.EOF, pexpect.TIMEOUT ] )
shahshreyaf4d4d0c2014-10-10 12:11:10 -0700575 except pexpect.TIMEOUT:
kelvin-onlabedcff052015-01-16 12:53:55 -0800576 main.log.error(
577 self.name +
578 ": Timeout exception in setIpTables function" )
shahshreyaf4d4d0c2014-10-10 12:11:10 -0700579 except:
kelvin-onlab64b33712015-01-21 15:26:15 -0800580 main.log.error( traceback.print_exc() )
shahshreyaf4d4d0c2014-10-10 12:11:10 -0700581 main.cleanup()
582 main.exit()
583 else:
kelvin-onlabedcff052015-01-16 12:53:55 -0800584 main.log.error(
585 "Given rule already exists, but attempted to add it" )
kelvin-onlabd3b64892015-01-20 13:26:24 -0800586 # If matchResult is 0, it means there IS a matching rule provided
587 elif matchResult == main.FALSE:
kelvin-onlabedcff052015-01-16 12:53:55 -0800588 # Ensure action type is remove
kelvin-onlabd3b64892015-01-20 13:26:24 -0800589 if actionType == 'remove':
590 # -D is the 'delete' rule of iptables
591 actionRemove = '-D'
shahshreyaf4d4d0c2014-10-10 12:11:10 -0700592 try:
kelvin-onlabedcff052015-01-16 12:53:55 -0800593 self.handle.sendline( "" )
594 # Delete a specific rule specified into the function
595 self.handle.sendline(
596 "sudo iptables " +
kelvin-onlabd3b64892015-01-20 13:26:24 -0800597 actionRemove +
kelvin-onlabedcff052015-01-16 12:53:55 -0800598 " OUTPUT -p " +
kelvin-onlabd3b64892015-01-20 13:26:24 -0800599 str( packetType ) +
kelvin-onlabedcff052015-01-16 12:53:55 -0800600 " -d " +
kelvin-onlabd3b64892015-01-20 13:26:24 -0800601 str( dstIp ) +
kelvin-onlabedcff052015-01-16 12:53:55 -0800602 " --dport " +
kelvin-onlabd3b64892015-01-20 13:26:24 -0800603 str( dstPort ) +
kelvin-onlabedcff052015-01-16 12:53:55 -0800604 " -j " +
605 str( rule ) )
shahshreyaf4d4d0c2014-10-10 12:11:10 -0700606
kelvin-onlabd3b64892015-01-20 13:26:24 -0800607 infoString = "Rules removed from " + str( self.name )
608 infoString += " iptables rule removed \
609 from blocking IP: " + \
610 str( dstIp )
611 infoString += " Port: " + \
612 str( dstPort ) + " Rule: " + str( rule )
shahshreyaf4d4d0c2014-10-10 12:11:10 -0700613
kelvin-onlabd3b64892015-01-20 13:26:24 -0800614 main.log.info( infoString )
shahshreyaf4d4d0c2014-10-10 12:11:10 -0700615
kelvin-onlabedcff052015-01-16 12:53:55 -0800616 self.handle.expect(
617 [ "\$", pexpect.EOF, pexpect.TIMEOUT ] )
shahshreyaf4d4d0c2014-10-10 12:11:10 -0700618 except pexpect.TIMEOUT:
kelvin-onlabedcff052015-01-16 12:53:55 -0800619 main.log.error(
620 self.name +
621 ": Timeout exception in setIpTables function" )
shahshreyaf4d4d0c2014-10-10 12:11:10 -0700622 except:
kelvin-onlab64b33712015-01-21 15:26:15 -0800623 main.log.error( traceback.print_exc() )
shahshreyaf4d4d0c2014-10-10 12:11:10 -0700624 main.cleanup()
625 main.exit()
626 else:
kelvin-onlabedcff052015-01-16 12:53:55 -0800627 main.log.error(
kelvin-onlabd3b64892015-01-20 13:26:24 -0800628 "Given rule does not exist,\
629 but attempted to remove it" )
shahshreyaf4d4d0c2014-10-10 12:11:10 -0700630 else:
kelvin-onlabedcff052015-01-16 12:53:55 -0800631 # NOTE: If a bad usage of this function occurs, exit the entire
632 # test
633 main.log.error( "Bad rule given for iptables. Exiting..." )
shahshreyaf4d4d0c2014-10-10 12:11:10 -0700634 main.cleanup()
635 main.exit()
636
637
adminbae64d82013-08-01 10:50:15 -0700638if __name__ != "__main__":
639 import sys
kelvin-onlabedcff052015-01-16 12:53:55 -0800640 sys.modules[ __name__ ] = RemoteMininetDriver()