admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 1 | #!/usr/bin/env python |
kelvin | 8ec7144 | 2015-01-15 16:57:00 -0800 | [diff] [blame] | 2 | """ |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 3 | Created on 24-Oct-2012 |
kelvin | 8ec7144 | 2015-01-15 16:57:00 -0800 | [diff] [blame] | 4 | |
| 5 | author:s: Anil Kumar ( anilkumar.s@paxterrasolutions.com ), |
| 6 | Raghav Kashyap( raghavkashyap@paxterrasolutions.com ) |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 7 | |
| 8 | |
| 9 | TestON is free software: you can redistribute it and/or modify |
| 10 | it under the terms of the GNU General Public License as published by |
| 11 | the Free Software Foundation, either version 2 of the License, or |
kelvin | 8ec7144 | 2015-01-15 16:57:00 -0800 | [diff] [blame] | 12 | ( at your option ) any later version. |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 13 | |
| 14 | TestON is distributed in the hope that it will be useful, |
| 15 | but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 16 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 17 | GNU General Public License for more details. |
| 18 | |
| 19 | You should have received a copy of the GNU General Public License |
kelvin | 8ec7144 | 2015-01-15 16:57:00 -0800 | [diff] [blame] | 20 | along with TestON. If not, see <http://www.gnu.org/licenses/>. |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 21 | |
| 22 | |
kelvin | 8ec7144 | 2015-01-15 16:57:00 -0800 | [diff] [blame] | 23 | |
| 24 | """ |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 25 | import pexpect |
kelvin | 8ec7144 | 2015-01-15 16:57:00 -0800 | [diff] [blame] | 26 | import struct |
| 27 | import fcntl |
| 28 | import os |
| 29 | import sys |
| 30 | import signal |
| 31 | import sys |
| 32 | import re |
| 33 | sys.path.append( "../" ) |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 34 | |
| 35 | from drivers.component import Component |
kelvin | 8ec7144 | 2015-01-15 16:57:00 -0800 | [diff] [blame] | 36 | |
| 37 | |
| 38 | class CLI( Component ): |
| 39 | |
| 40 | """ |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 41 | This will define common functions for CLI included. |
kelvin | 8ec7144 | 2015-01-15 16:57:00 -0800 | [diff] [blame] | 42 | """ |
| 43 | def __init__( self ): |
| 44 | super( Component, self ).__init__() |
| 45 | |
| 46 | def connect( self, **connectargs ): |
| 47 | """ |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 48 | Connection will establish to the remote host using ssh. |
| 49 | It will take user_name ,ip_address and password as arguments<br> |
kelvin | 8ec7144 | 2015-01-15 16:57:00 -0800 | [diff] [blame] | 50 | and will return the handle. |
| 51 | """ |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 52 | for key in connectargs: |
kelvin | 8ec7144 | 2015-01-15 16:57:00 -0800 | [diff] [blame] | 53 | vars( self )[ key ] = connectargs[ key ] |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 54 | |
kelvin | 8ec7144 | 2015-01-15 16:57:00 -0800 | [diff] [blame] | 55 | connect_result = super( CLI, self ).connect() |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 56 | ssh_newkey = 'Are you sure you want to continue connecting' |
kelvin | 8ec7144 | 2015-01-15 16:57:00 -0800 | [diff] [blame] | 57 | refused = "ssh: connect to host " + \ |
| 58 | self.ip_address + " port 22: Connection refused" |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 59 | if self.port: |
kelvin | 8ec7144 | 2015-01-15 16:57:00 -0800 | [diff] [blame] | 60 | self.handle = pexpect.spawn( |
| 61 | 'ssh -p ' + |
| 62 | self.port + |
| 63 | ' ' + |
| 64 | self.user_name + |
| 65 | '@' + |
| 66 | self.ip_address, |
Jon Hall | 9aaba88 | 2015-01-19 15:05:15 -0800 | [diff] [blame] | 67 | env={ "TERM": "xterm-mono" }, |
kelvin | 8ec7144 | 2015-01-15 16:57:00 -0800 | [diff] [blame] | 68 | maxread=50000 ) |
| 69 | else: |
| 70 | self.handle = pexpect.spawn( |
| 71 | 'ssh -X ' + |
| 72 | self.user_name + |
| 73 | '@' + |
| 74 | self.ip_address, |
Jon Hall | 9aaba88 | 2015-01-19 15:05:15 -0800 | [diff] [blame] | 75 | env={ "TERM": "xterm-mono" }, |
kelvin | 8ec7144 | 2015-01-15 16:57:00 -0800 | [diff] [blame] | 76 | maxread=1000000, |
| 77 | timeout=60 ) |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 78 | |
| 79 | self.handle.logfile = self.logfile_handler |
kelvin | 8ec7144 | 2015-01-15 16:57:00 -0800 | [diff] [blame] | 80 | i = 5 |
| 81 | while i == 5: |
| 82 | i = self.handle.expect( [ |
acsmars | 248c04d | 2015-06-29 15:00:17 -0700 | [diff] [blame^] | 83 | ssh_newkey, |
Jon Hall | 05f8868 | 2015-06-09 14:57:53 -0700 | [diff] [blame] | 84 | 'password:|Password:', |
kelvin | 8ec7144 | 2015-01-15 16:57:00 -0800 | [diff] [blame] | 85 | pexpect.EOF, |
| 86 | pexpect.TIMEOUT, |
| 87 | refused, |
| 88 | 'teston>', |
| 89 | '>|#|\$' ], |
| 90 | 120 ) |
| 91 | if i == 0: |
| 92 | main.log.info( "ssh key confirmation received, send yes" ) |
| 93 | self.handle.sendline( 'yes' ) |
acsmars | 248c04d | 2015-06-29 15:00:17 -0700 | [diff] [blame^] | 94 | continue #Expect either a password prompt or access |
kelvin | 8ec7144 | 2015-01-15 16:57:00 -0800 | [diff] [blame] | 95 | if i == 1: |
Jon Hall | 6360493 | 2015-02-26 17:09:50 -0800 | [diff] [blame] | 96 | if self.pwd: |
| 97 | main.log.info( |
| 98 | "ssh connection asked for password, gave password" ) |
| 99 | self.handle.sendline( self.pwd ) |
| 100 | self.handle.expect( '>|#|\$' ) |
| 101 | else: |
| 102 | # FIXME: TestON does not support a username having no |
| 103 | # password |
| 104 | main.log.error( "Server asked for password, but none was " |
| 105 | "given in the .topo file" ) |
| 106 | main.exit() |
kelvin | 8ec7144 | 2015-01-15 16:57:00 -0800 | [diff] [blame] | 107 | elif i == 2: |
| 108 | main.log.error( "Connection timeout" ) |
| 109 | return main.FALSE |
| 110 | elif i == 3: # timeout |
| 111 | main.log.error( |
| 112 | "No route to the Host " + |
| 113 | self.user_name + |
| 114 | "@" + |
| 115 | self.ip_address ) |
| 116 | return main.FALSE |
| 117 | elif i == 4: |
| 118 | main.log.error( |
| 119 | "ssh: connect to host " + |
| 120 | self.ip_address + |
| 121 | " port 22: Connection refused" ) |
| 122 | return main.FALSE |
| 123 | elif i == 6: |
| 124 | main.log.info( "Password not required logged in" ) |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 125 | |
kelvin | 8ec7144 | 2015-01-15 16:57:00 -0800 | [diff] [blame] | 126 | self.handle.sendline( "" ) |
| 127 | self.handle.expect( '>|#|\$' ) |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 128 | return self.handle |
| 129 | |
kelvin | 8ec7144 | 2015-01-15 16:57:00 -0800 | [diff] [blame] | 130 | def disconnect( self ): |
| 131 | result = super( CLI, self ).disconnect( self ) |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 132 | result = main.TRUE |
kelvin | 8ec7144 | 2015-01-15 16:57:00 -0800 | [diff] [blame] | 133 | # self.execute( cmd="exit",timeout=120,prompt="(.*)" ) |
| 134 | |
| 135 | def execute( self, **execparams ): |
| 136 | """ |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 137 | It facilitates the command line execution of a given command. It has arguments as : |
| 138 | cmd => represents command to be executed, |
| 139 | prompt => represents expect command prompt or output, |
| 140 | timeout => timeout for command execution, |
| 141 | more => to provide a key press if it is on. |
| 142 | |
| 143 | It will return output of command exection. |
kelvin | 8ec7144 | 2015-01-15 16:57:00 -0800 | [diff] [blame] | 144 | """ |
| 145 | result = super( CLI, self ).execute( self ) |
admin | aef0055 | 2014-05-08 09:18:36 -0700 | [diff] [blame] | 146 | defaultPrompt = '.*[$>\#]' |
kelvin | 8ec7144 | 2015-01-15 16:57:00 -0800 | [diff] [blame] | 147 | args = utilities.parse_args( [ |
| 148 | "CMD", |
| 149 | "TIMEOUT", |
| 150 | "PROMPT", |
| 151 | "MORE" ], |
| 152 | **execparams ) |
| 153 | |
| 154 | expectPrompt = args[ "PROMPT" ] if args[ "PROMPT" ] else defaultPrompt |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 155 | self.LASTRSP = "" |
kelvin | 8ec7144 | 2015-01-15 16:57:00 -0800 | [diff] [blame] | 156 | timeoutVar = args[ "TIMEOUT" ] if args[ "TIMEOUT" ] else 10 |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 157 | cmd = '' |
kelvin | 8ec7144 | 2015-01-15 16:57:00 -0800 | [diff] [blame] | 158 | if args[ "CMD" ]: |
| 159 | cmd = args[ "CMD" ] |
| 160 | else: |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 161 | return 0 |
kelvin | 8ec7144 | 2015-01-15 16:57:00 -0800 | [diff] [blame] | 162 | if args[ "MORE" ] is None: |
| 163 | args[ "MORE" ] = " " |
| 164 | self.handle.sendline( cmd ) |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 165 | self.lastCommand = cmd |
kelvin | 8ec7144 | 2015-01-15 16:57:00 -0800 | [diff] [blame] | 166 | index = self.handle.expect( [ |
| 167 | expectPrompt, |
| 168 | "--More--", |
| 169 | 'Command not found.', |
| 170 | pexpect.TIMEOUT, |
| 171 | "^:$" ], |
| 172 | timeout=timeoutVar ) |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 173 | if index == 0: |
kelvin | 8ec7144 | 2015-01-15 16:57:00 -0800 | [diff] [blame] | 174 | self.LASTRSP = self.LASTRSP + \ |
| 175 | self.handle.before + self.handle.after |
| 176 | main.log.info( |
| 177 | "Executed :" + str( |
| 178 | cmd ) + " \t\t Expected Prompt '" + str( |
| 179 | expectPrompt) + "' Found" ) |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 180 | elif index == 1: |
| 181 | self.LASTRSP = self.LASTRSP + self.handle.before |
kelvin | 8ec7144 | 2015-01-15 16:57:00 -0800 | [diff] [blame] | 182 | self.handle.send( args[ "MORE" ] ) |
| 183 | main.log.info( |
| 184 | "Found More screen to go , Sending a key to proceed" ) |
| 185 | indexMore = self.handle.expect( |
| 186 | [ "--More--", expectPrompt ], timeout=timeoutVar ) |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 187 | while indexMore == 0: |
kelvin | 8ec7144 | 2015-01-15 16:57:00 -0800 | [diff] [blame] | 188 | main.log.info( |
| 189 | "Found anoother More screen to go , Sending a key to proceed" ) |
| 190 | self.handle.send( args[ "MORE" ] ) |
| 191 | indexMore = self.handle.expect( |
| 192 | [ "--More--", expectPrompt ], timeout=timeoutVar ) |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 193 | self.LASTRSP = self.LASTRSP + self.handle.before |
kelvin | 8ec7144 | 2015-01-15 16:57:00 -0800 | [diff] [blame] | 194 | elif index == 2: |
| 195 | main.log.error( "Command not found" ) |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 196 | self.LASTRSP = self.LASTRSP + self.handle.before |
kelvin | 8ec7144 | 2015-01-15 16:57:00 -0800 | [diff] [blame] | 197 | elif index == 3: |
| 198 | main.log.error( "Expected Prompt not found , Time Out!!" ) |
| 199 | main.log.error( expectPrompt ) |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 200 | return "Expected Prompt not found , Time Out!!" |
kelvin | 8ec7144 | 2015-01-15 16:57:00 -0800 | [diff] [blame] | 201 | |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 202 | elif index == 4: |
| 203 | self.LASTRSP = self.LASTRSP + self.handle.before |
kelvin | 8ec7144 | 2015-01-15 16:57:00 -0800 | [diff] [blame] | 204 | # self.handle.send( args[ "MORE" ] ) |
| 205 | self.handle.sendcontrol( "D" ) |
| 206 | main.log.info( |
| 207 | "Found More screen to go , Sending a key to proceed" ) |
| 208 | indexMore = self.handle.expect( |
| 209 | [ "^:$", expectPrompt ], timeout=timeoutVar ) |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 210 | while indexMore == 0: |
kelvin | 8ec7144 | 2015-01-15 16:57:00 -0800 | [diff] [blame] | 211 | main.log.info( |
| 212 | "Found another More screen to go , Sending a key to proceed" ) |
| 213 | self.handle.sendcontrol( "D" ) |
| 214 | indexMore = self.handle.expect( |
| 215 | [ "^:$", expectPrompt ], timeout=timeoutVar ) |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 216 | self.LASTRSP = self.LASTRSP + self.handle.before |
kelvin | 8ec7144 | 2015-01-15 16:57:00 -0800 | [diff] [blame] | 217 | |
| 218 | main.last_response = self.remove_contol_chars( self.LASTRSP ) |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 219 | return self.LASTRSP |
kelvin | 8ec7144 | 2015-01-15 16:57:00 -0800 | [diff] [blame] | 220 | |
| 221 | def remove_contol_chars( self, response ): |
| 222 | # RE_XML_ILLEGAL = '([\u0000-\u0008\u000b-\u000c\u000e-\u001f\ufffe-\uffff])|([%s-%s][^%s-%s])|([^%s-%s][%s-%s])|([%s-%s]$)|(^[%s-%s])'%( unichr( 0xd800 ),unichr( 0xdbff ),unichr( 0xdc00 ),unichr( 0xdfff ),unichr( 0xd800 ),unichr( 0xdbff ),unichr( 0xdc00 ),unichr( 0xdfff ),unichr( 0xd800 ),unichr( 0xdbff ),unichr( 0xdc00 ),unichr( 0xdfff ) ) |
| 223 | # response = re.sub( RE_XML_ILLEGAL, "\n", response ) |
| 224 | response = re.sub( r"[\x01-\x1F\x7F]", "", response ) |
| 225 | # response = re.sub( r"\[\d+\;1H", "\n", response ) |
| 226 | response = re.sub( r"\[\d+\;\d+H", "", response ) |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 227 | return response |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 228 | |
kelvin | 8ec7144 | 2015-01-15 16:57:00 -0800 | [diff] [blame] | 229 | def runAsSudoUser( self, handle, pwd, default ): |
| 230 | |
| 231 | i = handle.expect( [ ".ssword:*", default, pexpect.EOF ] ) |
| 232 | if i == 0: |
| 233 | handle.sendline( pwd ) |
| 234 | handle.sendline( "\r" ) |
| 235 | |
| 236 | if i == 1: |
| 237 | handle.expect( default ) |
| 238 | |
| 239 | if i == 2: |
| 240 | main.log.error( "Unable to run as Sudo user" ) |
| 241 | |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 242 | return handle |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 243 | |
kelvin | 8ec7144 | 2015-01-15 16:57:00 -0800 | [diff] [blame] | 244 | def onfail( self ): |
| 245 | if 'onfail' in main.componentDictionary[ self.name ]: |
| 246 | commandList = main.componentDictionary[ |
| 247 | self.name ][ 'onfail' ].split( "," ) |
| 248 | for command in commandList: |
| 249 | response = self.execute( |
| 250 | cmd=command, |
| 251 | prompt="(.*)", |
| 252 | timeout=120 ) |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 253 | |
kelvin | 8ec7144 | 2015-01-15 16:57:00 -0800 | [diff] [blame] | 254 | def secureCopy( self, user_name, ip_address, filepath, pwd, dst_path ): |
| 255 | |
| 256 | # scp openflow@192.168.56.101:/home/openflow/sample |
| 257 | # /home/paxterra/Desktop/ |
| 258 | """ |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 259 | Connection will establish to the remote host using ssh. |
| 260 | It will take user_name ,ip_address and password as arguments<br> |
kelvin | 8ec7144 | 2015-01-15 16:57:00 -0800 | [diff] [blame] | 261 | and will return the handle. |
| 262 | """ |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 263 | ssh_newkey = 'Are you sure you want to continue connecting' |
kelvin | 8ec7144 | 2015-01-15 16:57:00 -0800 | [diff] [blame] | 264 | refused = "ssh: connect to host " + \ |
| 265 | ip_address + " port 22: Connection refused" |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 266 | |
kelvin | 8ec7144 | 2015-01-15 16:57:00 -0800 | [diff] [blame] | 267 | cmd = 'scp ' + str( user_name ) + '@' + str( ip_address ) + ':' + \ |
| 268 | str( filepath ) + ' ' + str(dst_path ) |
| 269 | |
| 270 | main.log.info( "Sending: " + cmd ) |
| 271 | self.handle = pexpect.spawn( cmd ) |
| 272 | i = self.handle.expect( [ |
| 273 | ssh_newkey, |
| 274 | 'password:', |
| 275 | pexpect.EOF, |
| 276 | pexpect.TIMEOUT, |
| 277 | refused ], |
| 278 | 120 ) |
| 279 | |
| 280 | if i == 0: |
| 281 | main.log.info( "ssh key confirmation received, send yes" ) |
| 282 | self.handle.sendline( 'yes' ) |
| 283 | i = self.handle.expect( [ ssh_newkey, 'password:', pexpect.EOF ] ) |
| 284 | if i == 1: |
| 285 | main.log.info( "ssh connection asked for password, gave password" ) |
| 286 | self.handle.sendline( pwd ) |
| 287 | # self.handle.expect( user_name ) |
| 288 | |
| 289 | elif i == 2: |
| 290 | main.log.error( "Connection timeout" ) |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 291 | pass |
kelvin | 8ec7144 | 2015-01-15 16:57:00 -0800 | [diff] [blame] | 292 | elif i == 3: # timeout |
| 293 | main.log.error( |
| 294 | "No route to the Host " + |
| 295 | user_name + |
| 296 | "@" + |
| 297 | ip_address ) |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 298 | return main.FALSE |
kelvin | 8ec7144 | 2015-01-15 16:57:00 -0800 | [diff] [blame] | 299 | elif i == 4: |
| 300 | main.log.error( |
| 301 | "ssh: connect to host " + |
| 302 | ip_address + |
| 303 | " port 22: Connection refused" ) |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 304 | return main.FALSE |
| 305 | |
kelvin | 8ec7144 | 2015-01-15 16:57:00 -0800 | [diff] [blame] | 306 | self.handle.sendline( "" ) |
| 307 | self.handle.expect( "$" ) |
Jon Hall | 94fd047 | 2014-12-08 11:52:42 -0800 | [diff] [blame] | 308 | print self.handle.before |
kelvin | 8ec7144 | 2015-01-15 16:57:00 -0800 | [diff] [blame] | 309 | |
admin | bae64d8 | 2013-08-01 10:50:15 -0700 | [diff] [blame] | 310 | return self.handle |
kelvin | 8ec7144 | 2015-01-15 16:57:00 -0800 | [diff] [blame] | 311 | |