VirtualBox

source: vbox/trunk/src/VBox/ValidationKit/testdriver/vbox.py@ 92238

Last change on this file since 92238 was 92238, checked in by vboxsync, 3 years ago

Validation Kit/testdriver: Moved setting LocalhostReachable right after we succeeded starting the VM (to make the testboxes start again, hopefully). ​bugref:9896
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 196.1 KB
Line 
1# -*- coding: utf-8 -*-
2# $Id: vbox.py 92238 2021-11-05 13:55:23Z vboxsync $
3# pylint: disable=too-many-lines
4
5"""
6VirtualBox Specific base testdriver.
7"""
8
9__copyright__ = \
10"""
11Copyright (C) 2010-2020 Oracle Corporation
12
13This file is part of VirtualBox Open Source Edition (OSE), as
14available from http://www.virtualbox.org. This file is free software;
15you can redistribute it and/or modify it under the terms of the GNU
16General Public License (GPL) as published by the Free Software
17Foundation, in version 2 as it comes in the "COPYING" file of the
18VirtualBox OSE distribution. VirtualBox OSE is distributed in the
19hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
20
21The contents of this file may alternatively be used under the terms
22of the Common Development and Distribution License Version 1.0
23(CDDL) only, as it comes in the "COPYING.CDDL" file of the
24VirtualBox OSE distribution, in which case the provisions of the
25CDDL are applicable instead of those of the GPL.
26
27You may elect to license modified versions of this file under the
28terms and conditions of either the GPL or the CDDL or both.
29"""
30__version__ = "$Revision: 92238 $"
31
32# pylint: disable=unnecessary-semicolon
33
34# Standard Python imports.
35import datetime
36import os
37import platform
38import re;
39import sys
40import threading
41import time
42import traceback
43
44# Figure out where the validation kit lives and make sure it's in the path.
45try: __file__
46except: __file__ = sys.argv[0];
47g_ksValidationKitDir = os.path.dirname(os.path.dirname(os.path.abspath(__file__)));
48if g_ksValidationKitDir not in sys.path:
49 sys.path.append(g_ksValidationKitDir);
50
51# Validation Kit imports.
52from common import utils;
53from testdriver import base;
54from testdriver import btresolver;
55from testdriver import reporter;
56from testdriver import vboxcon;
57from testdriver import vboxtestvms;
58
59# Python 3 hacks:
60if sys.version_info[0] >= 3:
61 xrange = range; # pylint: disable=redefined-builtin,invalid-name
62 long = int; # pylint: disable=redefined-builtin,invalid-name
63
64#
65# Exception and Error Unification Hacks.
66# Note! This is pretty gross stuff. Be warned!
67# TODO: Find better ways of doing these things, preferrably in vboxapi.
68#
69
70ComException = None; # pylint: disable=invalid-name
71__fnComExceptionGetAttr__ = None; # pylint: disable=invalid-name
72
73def __MyDefaultGetAttr(oSelf, sName):
74 """ __getattribute__/__getattr__ default fake."""
75 try:
76 oAttr = oSelf.__dict__[sName];
77 except:
78 oAttr = dir(oSelf)[sName];
79 return oAttr;
80
81def __MyComExceptionGetAttr(oSelf, sName):
82 """ ComException.__getattr__ wrapper - both XPCOM and COM. """
83 try:
84 oAttr = __fnComExceptionGetAttr__(oSelf, sName);
85 except AttributeError:
86 if platform.system() == 'Windows':
87 if sName == 'errno':
88 oAttr = __fnComExceptionGetAttr__(oSelf, 'hresult');
89 elif sName == 'msg':
90 oAttr = __fnComExceptionGetAttr__(oSelf, 'strerror');
91 else:
92 raise;
93 else:
94 if sName == 'hresult':
95 oAttr = __fnComExceptionGetAttr__(oSelf, 'errno');
96 elif sName == 'strerror':
97 oAttr = __fnComExceptionGetAttr__(oSelf, 'msg');
98 elif sName == 'excepinfo':
99 oAttr = None;
100 elif sName == 'argerror':
101 oAttr = None;
102 else:
103 raise;
104 #print '__MyComExceptionGetAttr(,%s) -> "%s"' % (sName, oAttr);
105 return oAttr;
106
107def __deployExceptionHacks__(oNativeComExceptionClass):
108 """
109 Deploys the exception and error hacks that helps unifying COM and XPCOM
110 exceptions and errors.
111 """
112 global ComException # pylint: disable=invalid-name
113 global __fnComExceptionGetAttr__ # pylint: disable=invalid-name
114
115 # Hook up our attribute getter for the exception class (ASSUMES new-style).
116 if __fnComExceptionGetAttr__ is None:
117 try:
118 __fnComExceptionGetAttr__ = getattr(oNativeComExceptionClass, '__getattr__');
119 except:
120 try:
121 __fnComExceptionGetAttr__ = getattr(oNativeComExceptionClass, '__getattribute__');
122 except:
123 __fnComExceptionGetAttr__ = __MyDefaultGetAttr;
124 setattr(oNativeComExceptionClass, '__getattr__', __MyComExceptionGetAttr)
125
126 # Make the modified classes accessible (are there better ways to do this?)
127 ComException = oNativeComExceptionClass
128 return None;
129
130
131
132#
133# Utility functions.
134#
135
136def isIpAddrValid(sIpAddr):
137 """
138 Checks if a IPv4 address looks valid. This will return false for
139 localhost and similar.
140 Returns True / False.
141 """
142 if sIpAddr is None: return False;
143 if len(sIpAddr.split('.')) != 4: return False;
144 if sIpAddr.endswith('.0'): return False;
145 if sIpAddr.endswith('.255'): return False;
146 if sIpAddr.startswith('127.'): return False;
147 if sIpAddr.startswith('169.254.'): return False;
148 if sIpAddr.startswith('192.0.2.'): return False;
149 if sIpAddr.startswith('224.0.0.'): return False;
150 return True;
151
152def stringifyErrorInfo(oErrInfo):
153 """
154 Stringifies the error information in a IVirtualBoxErrorInfo object.
155
156 Returns string with error info.
157 """
158 try:
159 rc = oErrInfo.resultCode;
160 sText = oErrInfo.text;
161 sIid = oErrInfo.interfaceID;
162 sComponent = oErrInfo.component;
163 except:
164 sRet = 'bad error object (%s)?' % (oErrInfo,);
165 traceback.print_exc();
166 else:
167 sRet = 'rc=%s text="%s" IID=%s component=%s' % (ComError.toString(rc), sText, sIid, sComponent);
168 return sRet;
169
170def reportError(oErr, sText):
171 """
172 Report a VirtualBox error on oErr. oErr can be IVirtualBoxErrorInfo
173 or IProgress. Anything else is ignored.
174
175 Returns the same a reporter.error().
176 """
177 try:
178 oErrObj = oErr.errorInfo; # IProgress.
179 except:
180 oErrObj = oErr;
181 reporter.error(sText);
182 return reporter.error(stringifyErrorInfo(oErrObj));
183
184def formatComOrXpComException(oType, oXcpt):
185 """
186 Callback installed with the reporter to better format COM exceptions.
187 Similar to format_exception_only, only it returns None if not interested.
188 """
189 _ = oType;
190 oVBoxMgr = vboxcon.goHackModuleClass.oVBoxMgr;
191 if oVBoxMgr is None:
192 return None;
193 if not oVBoxMgr.xcptIsOurXcptKind(oXcpt): # pylint: disable=not-callable
194 return None;
195
196 if platform.system() == 'Windows':
197 hrc = oXcpt.hresult;
198 if hrc == ComError.DISP_E_EXCEPTION and oXcpt.excepinfo is not None and len(oXcpt.excepinfo) > 5:
199 hrc = oXcpt.excepinfo[5];
200 sWhere = oXcpt.excepinfo[1];
201 sMsg = oXcpt.excepinfo[2];
202 else:
203 sWhere = None;
204 sMsg = oXcpt.strerror;
205 else:
206 hrc = oXcpt.errno;
207 sWhere = None;
208 sMsg = oXcpt.msg;
209
210 sHrc = oVBoxMgr.xcptToString(hrc); # pylint: disable=not-callable
211 if sHrc.find('(') < 0:
212 sHrc = '%s (%#x)' % (sHrc, hrc & 0xffffffff,);
213
214 asRet = ['COM-Xcpt: %s' % (sHrc,)];
215 if sMsg and sWhere:
216 asRet.append('--------- %s: %s' % (sWhere, sMsg,));
217 elif sMsg:
218 asRet.append('--------- %s' % (sMsg,));
219 return asRet;
220 #if sMsg and sWhere:
221 # return ['COM-Xcpt: %s - %s: %s' % (sHrc, sWhere, sMsg,)];
222 #if sMsg:
223 # return ['COM-Xcpt: %s - %s' % (sHrc, sMsg,)];
224 #return ['COM-Xcpt: %s' % (sHrc,)];
225
226#
227# Classes
228#
229
230class ComError(object):
231 """
232 Unified COM and XPCOM status code repository.
233 This works more like a module than a class since it's replacing a module.
234 """
235
236 # The VBOX_E_XXX bits:
237 __VBOX_E_BASE = -2135228416;
238 VBOX_E_OBJECT_NOT_FOUND = __VBOX_E_BASE + 1;
239 VBOX_E_INVALID_VM_STATE = __VBOX_E_BASE + 2;
240 VBOX_E_VM_ERROR = __VBOX_E_BASE + 3;
241 VBOX_E_FILE_ERROR = __VBOX_E_BASE + 4;
242 VBOX_E_IPRT_ERROR = __VBOX_E_BASE + 5;
243 VBOX_E_PDM_ERROR = __VBOX_E_BASE + 6;
244 VBOX_E_INVALID_OBJECT_STATE = __VBOX_E_BASE + 7;
245 VBOX_E_HOST_ERROR = __VBOX_E_BASE + 8;
246 VBOX_E_NOT_SUPPORTED = __VBOX_E_BASE + 9;
247 VBOX_E_XML_ERROR = __VBOX_E_BASE + 10;
248 VBOX_E_INVALID_SESSION_STATE = __VBOX_E_BASE + 11;
249 VBOX_E_OBJECT_IN_USE = __VBOX_E_BASE + 12;
250 VBOX_E_DONT_CALL_AGAIN = __VBOX_E_BASE + 13;
251
252 # Reverse lookup table.
253 dDecimalToConst = {}; # pylint: disable=invalid-name
254
255 def __init__(self):
256 raise base.GenError('No instances, please');
257
258 @staticmethod
259 def copyErrors(oNativeComErrorClass):
260 """
261 Copy all error codes from oNativeComErrorClass to this class and
262 install compatability mappings.
263 """
264
265 # First, add the VBOX_E_XXX constants to dDecimalToConst.
266 for sAttr in dir(ComError):
267 if sAttr.startswith('VBOX_E'):
268 oAttr = getattr(ComError, sAttr);
269 ComError.dDecimalToConst[oAttr] = sAttr;
270
271 # Copy all error codes from oNativeComErrorClass to this class.
272 for sAttr in dir(oNativeComErrorClass):
273 if sAttr[0].isupper():
274 oAttr = getattr(oNativeComErrorClass, sAttr);
275 setattr(ComError, sAttr, oAttr);
276 if isinstance(oAttr, int):
277 ComError.dDecimalToConst[oAttr] = sAttr;
278
279 # Install mappings to the other platform.
280 if platform.system() == 'Windows':
281 ComError.NS_OK = ComError.S_OK;
282 ComError.NS_ERROR_FAILURE = ComError.E_FAIL;
283 ComError.NS_ERROR_ABORT = ComError.E_ABORT;
284 ComError.NS_ERROR_NULL_POINTER = ComError.E_POINTER;
285 ComError.NS_ERROR_NO_INTERFACE = ComError.E_NOINTERFACE;
286 ComError.NS_ERROR_INVALID_ARG = ComError.E_INVALIDARG;
287 ComError.NS_ERROR_OUT_OF_MEMORY = ComError.E_OUTOFMEMORY;
288 ComError.NS_ERROR_NOT_IMPLEMENTED = ComError.E_NOTIMPL;
289 ComError.NS_ERROR_UNEXPECTED = ComError.E_UNEXPECTED;
290 else:
291 ComError.E_ACCESSDENIED = -2147024891; # see VBox/com/defs.h
292 ComError.S_OK = ComError.NS_OK;
293 ComError.E_FAIL = ComError.NS_ERROR_FAILURE;
294 ComError.E_ABORT = ComError.NS_ERROR_ABORT;
295 ComError.E_POINTER = ComError.NS_ERROR_NULL_POINTER;
296 ComError.E_NOINTERFACE = ComError.NS_ERROR_NO_INTERFACE;
297 ComError.E_INVALIDARG = ComError.NS_ERROR_INVALID_ARG;
298 ComError.E_OUTOFMEMORY = ComError.NS_ERROR_OUT_OF_MEMORY;
299 ComError.E_NOTIMPL = ComError.NS_ERROR_NOT_IMPLEMENTED;
300 ComError.E_UNEXPECTED = ComError.NS_ERROR_UNEXPECTED;
301 ComError.DISP_E_EXCEPTION = -2147352567; # For COM compatability only.
302 return True;
303
304 @staticmethod
305 def getXcptResult(oXcpt):
306 """
307 Gets the result code for an exception.
308 Returns COM status code (or E_UNEXPECTED).
309 """
310 if platform.system() == 'Windows':
311 # The DISP_E_EXCEPTION + excptinfo fun needs checking up, only
312 # empirical info on it so far.
313 try:
314 hrXcpt = oXcpt.hresult;
315 except AttributeError:
316 hrXcpt = ComError.E_UNEXPECTED;
317 if hrXcpt == ComError.DISP_E_EXCEPTION and oXcpt.excepinfo is not None:
318 hrXcpt = oXcpt.excepinfo[5];
319 else:
320 try:
321 hrXcpt = oXcpt.errno;
322 except AttributeError:
323 hrXcpt = ComError.E_UNEXPECTED;
324 return hrXcpt;
325
326 @staticmethod
327 def equal(oXcpt, hr):
328 """
329 Checks if the ComException e is not equal to the COM status code hr.
330 This takes DISP_E_EXCEPTION & excepinfo into account.
331
332 This method can be used with any Exception derivate, however it will
333 only return True for classes similar to the two ComException variants.
334 """
335 if platform.system() == 'Windows':
336 # The DISP_E_EXCEPTION + excptinfo fun needs checking up, only
337 # empirical info on it so far.
338 try:
339 hrXcpt = oXcpt.hresult;
340 except AttributeError:
341 return False;
342 if hrXcpt == ComError.DISP_E_EXCEPTION and oXcpt.excepinfo is not None:
343 hrXcpt = oXcpt.excepinfo[5];
344 else:
345 try:
346 hrXcpt = oXcpt.errno;
347 except AttributeError:
348 return False;
349 return hrXcpt == hr;
350
351 @staticmethod
352 def notEqual(oXcpt, hr):
353 """
354 Checks if the ComException e is not equal to the COM status code hr.
355 See equal() for more details.
356 """
357 return not ComError.equal(oXcpt, hr)
358
359 @staticmethod
360 def toString(hr):
361 """
362 Converts the specified COM status code to a string.
363 """
364 try:
365 sStr = ComError.dDecimalToConst[int(hr)];
366 except KeyError:
367 hrLong = long(hr);
368 sStr = '%#x (%d)' % (hrLong, hrLong);
369 return sStr;
370
371
372class Build(object): # pylint: disable=too-few-public-methods
373 """
374 A VirtualBox build.
375
376 Note! After dropping the installation of VBox from this code and instead
377 realizing that with the vboxinstall.py wrapper driver, this class is
378 of much less importance and contains unnecessary bits and pieces.
379 """
380
381 def __init__(self, oDriver, strInstallPath):
382 """
383 Construct a build object from a build file name and/or install path.
384 """
385 # Initialize all members first.
386 self.oDriver = oDriver;
387 self.sInstallPath = strInstallPath;
388 self.sSdkPath = None;
389 self.sSrcRoot = None;
390 self.sKind = None;
391 self.sDesignation = None;
392 self.sType = None;
393 self.sOs = None;
394 self.sArch = None;
395 self.sGuestAdditionsIso = None;
396
397 # Figure out the values as best we can.
398 if strInstallPath is None:
399 #
400 # Both parameters are None, which means we're falling back on a
401 # build in the development tree.
402 #
403 self.sKind = "development";
404
405 if self.sType is None:
406 self.sType = os.environ.get("KBUILD_TYPE", "release");
407 if self.sOs is None:
408 self.sOs = os.environ.get("KBUILD_TARGET", oDriver.sHost);
409 if self.sArch is None:
410 self.sArch = os.environ.get("KBUILD_TARGET_ARCH", oDriver.sHostArch);
411
412 sOut = os.path.join('out', self.sOs + '.' + self.sArch, self.sType);
413 sSearch = os.environ.get('VBOX_TD_DEV_TREE', os.path.dirname(__file__)); # Env.var. for older trees or testboxscript.
414 sCandidat = None;
415 for i in range(0, 10): # pylint: disable=unused-variable
416 sBldDir = os.path.join(sSearch, sOut);
417 if os.path.isdir(sBldDir):
418 sCandidat = os.path.join(sBldDir, 'bin', 'VBoxSVC' + base.exeSuff());
419 if os.path.isfile(sCandidat):
420 self.sSdkPath = os.path.join(sBldDir, 'bin/sdk');
421 break;
422 sCandidat = os.path.join(sBldDir, 'dist/VirtualBox.app/Contents/MacOS/VBoxSVC');
423 if os.path.isfile(sCandidat):
424 self.sSdkPath = os.path.join(sBldDir, 'dist/sdk');
425 break;
426 sSearch = os.path.abspath(os.path.join(sSearch, '..'));
427 if sCandidat is None or not os.path.isfile(sCandidat):
428 raise base.GenError();
429 self.sInstallPath = os.path.abspath(os.path.dirname(sCandidat));
430 self.sSrcRoot = os.path.abspath(sSearch);
431
432 self.sDesignation = os.environ.get('TEST_BUILD_DESIGNATION', None);
433 if self.sDesignation is None:
434 try:
435 oFile = utils.openNoInherit(os.path.join(self.sSrcRoot, sOut, 'revision.kmk'), 'r');
436 except:
437 pass;
438 else:
439 s = oFile.readline();
440 oFile.close();
441 oMatch = re.search("VBOX_SVN_REV=(\\d+)", s);
442 if oMatch is not None:
443 self.sDesignation = oMatch.group(1);
444
445 if self.sDesignation is None:
446 self.sDesignation = 'XXXXX'
447 else:
448 #
449 # We've been pointed to an existing installation, this could be
450 # in the out dir of a svn checkout, untarred VBoxAll or a real
451 # installation directory.
452 #
453 self.sKind = "preinstalled";
454 self.sType = "release";
455 self.sOs = oDriver.sHost;
456 self.sArch = oDriver.sHostArch;
457 self.sInstallPath = os.path.abspath(strInstallPath);
458 self.sSdkPath = os.path.join(self.sInstallPath, 'sdk');
459 self.sSrcRoot = None;
460 self.sDesignation = os.environ.get('TEST_BUILD_DESIGNATION', 'XXXXX');
461 ## @todo Much more work is required here.
462
463 # Try Determine the build type.
464 sVBoxManage = os.path.join(self.sInstallPath, 'VBoxManage' + base.exeSuff());
465 if os.path.isfile(sVBoxManage):
466 try:
467 (iExit, sStdOut, _) = utils.processOutputUnchecked([sVBoxManage, '--dump-build-type']);
468 sStdOut = sStdOut.strip();
469 if iExit == 0 and sStdOut in ('release', 'debug', 'strict', 'dbgopt', 'asan'):
470 self.sType = sStdOut;
471 reporter.log('Build: Detected build type: %s' % (self.sType));
472 else:
473 reporter.log('Build: --dump-build-type -> iExit=%u sStdOut=%s' % (iExit, sStdOut,));
474 except:
475 reporter.logXcpt('Build: Running "%s --dump-build-type" failed!' % (sVBoxManage,));
476 else:
477 reporter.log3('Build: sVBoxManage=%s not found' % (sVBoxManage,));
478
479 # Do some checks.
480 sVMMR0 = os.path.join(self.sInstallPath, 'VMMR0.r0');
481 if not os.path.isfile(sVMMR0) and utils.getHostOs() == 'solaris': # solaris is special.
482 sVMMR0 = os.path.join(self.sInstallPath, 'amd64' if utils.getHostArch() == 'amd64' else 'i386', 'VMMR0.r0');
483 if not os.path.isfile(sVMMR0):
484 raise base.GenError('%s is missing' % (sVMMR0,));
485
486 # Guest additions location is different on windows for some _stupid_ reason.
487 if self.sOs == 'win' and self.sKind != 'development':
488 self.sGuestAdditionsIso = '%s/VBoxGuestAdditions.iso' % (self.sInstallPath,);
489 elif self.sOs == 'darwin':
490 self.sGuestAdditionsIso = '%s/VBoxGuestAdditions.iso' % (self.sInstallPath,);
491 elif self.sOs == 'solaris':
492 self.sGuestAdditionsIso = '%s/VBoxGuestAdditions.iso' % (self.sInstallPath,);
493 else:
494 self.sGuestAdditionsIso = '%s/additions/VBoxGuestAdditions.iso' % (self.sInstallPath,);
495
496 # __init__ end;
497
498 def isDevBuild(self):
499 """ Returns True if it's development build (kind), otherwise False. """
500 return self.sKind == 'development';
501
502
503class EventHandlerBase(object):
504 """
505 Base class for both Console and VirtualBox event handlers.
506 """
507
508 def __init__(self, dArgs, fpApiVer, sName = None):
509 self.oVBoxMgr = dArgs['oVBoxMgr'];
510 self.oEventSrc = dArgs['oEventSrc']; # Console/VirtualBox for < 3.3
511 self.oListener = dArgs['oListener'];
512 self.fPassive = self.oListener is not None;
513 self.sName = sName
514 self.fShutdown = False;
515 self.oThread = None;
516 self.fpApiVer = fpApiVer;
517 self.dEventNo2Name = {};
518 for sKey, iValue in self.oVBoxMgr.constants.all_values('VBoxEventType').items():
519 self.dEventNo2Name[iValue] = sKey;
520
521 def threadForPassiveMode(self):
522 """
523 The thread procedure for the event processing thread.
524 """
525 assert self.fPassive is not None;
526 while not self.fShutdown:
527 try:
528 oEvt = self.oEventSrc.getEvent(self.oListener, 500);
529 except:
530 if not self.oVBoxMgr.xcptIsDeadInterface(): reporter.logXcpt();
531 else: reporter.log('threadForPassiveMode/%s: interface croaked (ignored)' % (self.sName,));
532 break;
533 if oEvt:
534 self.handleEvent(oEvt);
535 if not self.fShutdown:
536 try:
537 self.oEventSrc.eventProcessed(self.oListener, oEvt);
538 except:
539 reporter.logXcpt();
540 break;
541 self.unregister(fWaitForThread = False);
542 return None;
543
544 def startThreadForPassiveMode(self):
545 """
546 Called when working in passive mode.
547 """
548 self.oThread = threading.Thread(target = self.threadForPassiveMode, \
549 args=(), name=('PAS-%s' % (self.sName,)));
550 self.oThread.setDaemon(True)
551 self.oThread.start();
552 return None;
553
554 def unregister(self, fWaitForThread = True):
555 """
556 Unregister the event handler.
557 """
558 fRc = False;
559 if not self.fShutdown:
560 self.fShutdown = True;
561
562 if self.oEventSrc is not None:
563 if self.fpApiVer < 3.3:
564 try:
565 self.oEventSrc.unregisterCallback(self.oListener);
566 fRc = True;
567 except:
568 reporter.errorXcpt('unregisterCallback failed on %s' % (self.oListener,));
569 else:
570 try:
571 self.oEventSrc.unregisterListener(self.oListener);
572 fRc = True;
573 except:
574 if self.oVBoxMgr.xcptIsDeadInterface():
575 reporter.log('unregisterListener failed on %s because of dead interface (%s)'
576 % (self.oListener, self.oVBoxMgr.xcptToString(),));
577 else:
578 reporter.errorXcpt('unregisterListener failed on %s' % (self.oListener,));
579
580 if self.oThread is not None \
581 and self.oThread != threading.current_thread():
582 self.oThread.join();
583 self.oThread = None;
584
585 _ = fWaitForThread;
586 return fRc;
587
588 def handleEvent(self, oEvt):
589 """
590 Compatibility wrapper that child classes implement.
591 """
592 _ = oEvt;
593 return None;
594
595 @staticmethod
596 def registerDerivedEventHandler(oVBoxMgr, fpApiVer, oSubClass, dArgsCopy, # pylint: disable=too-many-arguments
597 oSrcParent, sSrcParentNm, sICallbackNm,
598 fMustSucceed = True, sLogSuffix = '', aenmEvents = None):
599 """
600 Registers the callback / event listener.
601 """
602 dArgsCopy['oVBoxMgr'] = oVBoxMgr;
603 dArgsCopy['oListener'] = None;
604 if fpApiVer < 3.3:
605 dArgsCopy['oEventSrc'] = oSrcParent;
606 try:
607 oRet = oVBoxMgr.createCallback(sICallbackNm, oSubClass, dArgsCopy);
608 except:
609 reporter.errorXcpt('%s::registerCallback(%s) failed%s' % (sSrcParentNm, oRet, sLogSuffix));
610 else:
611 try:
612 oSrcParent.registerCallback(oRet);
613 return oRet;
614 except Exception as oXcpt:
615 if fMustSucceed or ComError.notEqual(oXcpt, ComError.E_UNEXPECTED):
616 reporter.errorXcpt('%s::registerCallback(%s)%s' % (sSrcParentNm, oRet, sLogSuffix));
617 else:
618 #
619 # Scalable event handling introduced in VBox 4.0.
620 #
621 fPassive = sys.platform == 'win32'; # or webservices.
622
623 if not aenmEvents:
624 aenmEvents = (vboxcon.VBoxEventType_Any,);
625
626 try:
627 oEventSrc = oSrcParent.eventSource;
628 dArgsCopy['oEventSrc'] = oEventSrc;
629 if not fPassive:
630 oListener = oRet = oVBoxMgr.createListener(oSubClass, dArgsCopy);
631 else:
632 oListener = oEventSrc.createListener();
633 dArgsCopy['oListener'] = oListener;
634 oRet = oSubClass(dArgsCopy);
635 except:
636 reporter.errorXcpt('%s::eventSource.createListener(%s) failed%s' % (sSrcParentNm, oListener, sLogSuffix));
637 else:
638 try:
639 oEventSrc.registerListener(oListener, aenmEvents, not fPassive);
640 except Exception as oXcpt:
641 if fMustSucceed or ComError.notEqual(oXcpt, ComError.E_UNEXPECTED):
642 reporter.errorXcpt('%s::eventSource.registerListener(%s) failed%s'
643 % (sSrcParentNm, oListener, sLogSuffix));
644 else:
645 if not fPassive:
646 if sys.platform == 'win32':
647 from win32com.server.util import unwrap # pylint: disable=import-error
648 oRet = unwrap(oRet);
649 oRet.oListener = oListener;
650 else:
651 oRet.startThreadForPassiveMode();
652 return oRet;
653 return None;
654
655
656
657
658class ConsoleEventHandlerBase(EventHandlerBase):
659 """
660 Base class for handling IConsole events.
661
662 The class has IConsoleCallback (<=3.2) compatible callback methods which
663 the user can override as needed.
664
665 Note! This class must not inherit from object or we'll get type errors in VBoxPython.
666 """
667 def __init__(self, dArgs, sName = None):
668 self.oSession = dArgs['oSession'];
669 self.oConsole = dArgs['oConsole'];
670 if sName is None:
671 sName = self.oSession.sName;
672 EventHandlerBase.__init__(self, dArgs, self.oSession.fpApiVer, sName);
673
674
675 # pylint: disable=missing-docstring,too-many-arguments,unused-argument
676 def onMousePointerShapeChange(self, fVisible, fAlpha, xHot, yHot, cx, cy, abShape):
677 reporter.log2('onMousePointerShapeChange/%s' % (self.sName));
678 def onMouseCapabilityChange(self, fSupportsAbsolute, *aArgs): # Extra argument was added in 3.2.
679 reporter.log2('onMouseCapabilityChange/%s' % (self.sName));
680 def onKeyboardLedsChange(self, fNumLock, fCapsLock, fScrollLock):
681 reporter.log2('onKeyboardLedsChange/%s' % (self.sName));
682 def onStateChange(self, eState):
683 reporter.log2('onStateChange/%s' % (self.sName));
684 def onAdditionsStateChange(self):
685 reporter.log2('onAdditionsStateChange/%s' % (self.sName));
686 def onNetworkAdapterChange(self, oNic):
687 reporter.log2('onNetworkAdapterChange/%s' % (self.sName));
688 def onSerialPortChange(self, oPort):
689 reporter.log2('onSerialPortChange/%s' % (self.sName));
690 def onParallelPortChange(self, oPort):
691 reporter.log2('onParallelPortChange/%s' % (self.sName));
692 def onStorageControllerChange(self):
693 reporter.log2('onStorageControllerChange/%s' % (self.sName));
694 def onMediumChange(self, attachment):
695 reporter.log2('onMediumChange/%s' % (self.sName));
696 def onCPUChange(self, iCpu, fAdd):
697 reporter.log2('onCPUChange/%s' % (self.sName));
698 def onVRDPServerChange(self):
699 reporter.log2('onVRDPServerChange/%s' % (self.sName));
700 def onRemoteDisplayInfoChange(self):
701 reporter.log2('onRemoteDisplayInfoChange/%s' % (self.sName));
702 def onUSBControllerChange(self):
703 reporter.log2('onUSBControllerChange/%s' % (self.sName));
704 def onUSBDeviceStateChange(self, oDevice, fAttached, oError):
705 reporter.log2('onUSBDeviceStateChange/%s' % (self.sName));
706 def onSharedFolderChange(self, fGlobal):
707 reporter.log2('onSharedFolderChange/%s' % (self.sName));
708 def onRuntimeError(self, fFatal, sErrId, sMessage):
709 reporter.log2('onRuntimeError/%s' % (self.sName));
710 def onCanShowWindow(self):
711 reporter.log2('onCanShowWindow/%s' % (self.sName));
712 return True
713 def onShowWindow(self):
714 reporter.log2('onShowWindow/%s' % (self.sName));
715 return None;
716 # pylint: enable=missing-docstring,too-many-arguments,unused-argument
717
718 def handleEvent(self, oEvt):
719 """
720 Compatibility wrapper.
721 """
722 try:
723 oEvtBase = self.oVBoxMgr.queryInterface(oEvt, 'IEvent');
724 eType = oEvtBase.type;
725 except:
726 reporter.logXcpt();
727 return None;
728 if eType == vboxcon.VBoxEventType_OnRuntimeError:
729 try:
730 oEvtIt = self.oVBoxMgr.queryInterface(oEvtBase, 'IRuntimeErrorEvent');
731 return self.onRuntimeError(oEvtIt.fatal, oEvtIt.id, oEvtIt.message)
732 except:
733 reporter.logXcpt();
734 ## @todo implement the other events.
735 try:
736 if eType not in (vboxcon.VBoxEventType_OnMousePointerShapeChanged,
737 vboxcon.VBoxEventType_OnCursorPositionChanged):
738 if eType in self.dEventNo2Name:
739 reporter.log2('%s(%s)/%s' % (self.dEventNo2Name[eType], str(eType), self.sName));
740 else:
741 reporter.log2('%s/%s' % (str(eType), self.sName));
742 except AttributeError: # Handle older VBox versions which don't have a specific event.
743 pass;
744 return None;
745
746
747class VirtualBoxEventHandlerBase(EventHandlerBase):
748 """
749 Base class for handling IVirtualBox events.
750
751 The class has IConsoleCallback (<=3.2) compatible callback methods which
752 the user can override as needed.
753
754 Note! This class must not inherit from object or we'll get type errors in VBoxPython.
755 """
756 def __init__(self, dArgs, sName = "emanon"):
757 self.oVBoxMgr = dArgs['oVBoxMgr'];
758 self.oVBox = dArgs['oVBox'];
759 EventHandlerBase.__init__(self, dArgs, self.oVBox.fpApiVer, sName);
760
761 # pylint: disable=missing-docstring,unused-argument
762 def onMachineStateChange(self, sMachineId, eState):
763 pass;
764 def onMachineDataChange(self, sMachineId):
765 pass;
766 def onExtraDataCanChange(self, sMachineId, sKey, sValue):
767 # The COM bridge does tuples differently. Not very funny if you ask me... ;-)
768 if self.oVBoxMgr.type == 'MSCOM':
769 return '', 0, True;
770 return True, ''
771 def onExtraDataChange(self, sMachineId, sKey, sValue):
772 pass;
773 def onMediumRegistered(self, sMediumId, eMediumType, fRegistered):
774 pass;
775 def onMachineRegistered(self, sMachineId, fRegistered):
776 pass;
777 def onSessionStateChange(self, sMachineId, eState):
778 pass;
779 def onSnapshotTaken(self, sMachineId, sSnapshotId):
780 pass;
781 def onSnapshotDiscarded(self, sMachineId, sSnapshotId):
782 pass;
783 def onSnapshotChange(self, sMachineId, sSnapshotId):
784 pass;
785 def onGuestPropertyChange(self, sMachineId, sName, sValue, sFlags):
786 pass;
787 # pylint: enable=missing-docstring,unused-argument
788
789 def handleEvent(self, oEvt):
790 """
791 Compatibility wrapper.
792 """
793 try:
794 oEvtBase = self.oVBoxMgr.queryInterface(oEvt, 'IEvent');
795 eType = oEvtBase.type;
796 except:
797 reporter.logXcpt();
798 return None;
799 if eType == vboxcon.VBoxEventType_OnMachineStateChanged:
800 try:
801 oEvtIt = self.oVBoxMgr.queryInterface(oEvtBase, 'IMachineStateChangedEvent');
802 return self.onMachineStateChange(oEvtIt.machineId, oEvtIt.state)
803 except:
804 reporter.logXcpt();
805 elif eType == vboxcon.VBoxEventType_OnGuestPropertyChanged:
806 try:
807 oEvtIt = self.oVBoxMgr.queryInterface(oEvtBase, 'IGuestPropertyChangedEvent');
808 return self.onGuestPropertyChange(oEvtIt.machineId, oEvtIt.name, oEvtIt.value, oEvtIt.flags);
809 except:
810 reporter.logXcpt();
811 ## @todo implement the other events.
812 if eType in self.dEventNo2Name:
813 reporter.log2('%s(%s)/%s' % (self.dEventNo2Name[eType], str(eType), self.sName));
814 else:
815 reporter.log2('%s/%s' % (str(eType), self.sName));
816 return None;
817
818
819class SessionConsoleEventHandler(ConsoleEventHandlerBase):
820 """
821 For catching machine state changes and waking up the task machinery at that point.
822 """
823 def __init__(self, dArgs):
824 ConsoleEventHandlerBase.__init__(self, dArgs);
825
826 def onMachineStateChange(self, sMachineId, eState): # pylint: disable=unused-argument
827 """ Just interrupt the wait loop here so it can check again. """
828 _ = sMachineId; _ = eState;
829 self.oVBoxMgr.interruptWaitEvents();
830
831 def onRuntimeError(self, fFatal, sErrId, sMessage):
832 reporter.log('onRuntimeError/%s: fFatal=%d sErrId=%s sMessage=%s' % (self.sName, fFatal, sErrId, sMessage));
833 oSession = self.oSession;
834 if oSession is not None: # paranoia
835 if sErrId == 'HostMemoryLow':
836 oSession.signalHostMemoryLow();
837 if sys.platform == 'win32':
838 from testdriver import winbase;
839 winbase.logMemoryStats();
840 oSession.signalTask();
841 self.oVBoxMgr.interruptWaitEvents();
842
843
844
845class TestDriver(base.TestDriver): # pylint: disable=too-many-instance-attributes
846 """
847 This is the VirtualBox test driver.
848 """
849
850 def __init__(self):
851 base.TestDriver.__init__(self);
852 self.fImportedVBoxApi = False;
853 self.fpApiVer = 3.2;
854 self.uRevision = 0;
855 self.uApiRevision = 0;
856 self.oBuild = None;
857 self.oVBoxMgr = None;
858 self.oVBox = None;
859 self.aoRemoteSessions = [];
860 self.aoVMs = []; ## @todo not sure if this list will be of any use.
861 self.oTestVmManager = vboxtestvms.TestVmManager(self.sResourcePath);
862 self.oTestVmSet = vboxtestvms.TestVmSet();
863 self.sSessionTypeDef = 'headless';
864 self.sSessionType = self.sSessionTypeDef;
865 self.fEnableVrdp = True;
866 self.uVrdpBasePortDef = 6000;
867 self.uVrdpBasePort = self.uVrdpBasePortDef;
868 self.sDefBridgedNic = None;
869 self.fUseDefaultSvc = False;
870 self.sLogSelfGroups = '';
871 self.sLogSelfFlags = 'time';
872 self.sLogSelfDest = '';
873 self.sLogSessionGroups = '';
874 self.sLogSessionFlags = 'time';
875 self.sLogSessionDest = '';
876 self.sLogSvcGroups = '';
877 self.sLogSvcFlags = 'time';
878 self.sLogSvcDest = '';
879 self.sSelfLogFile = None;
880 self.sVBoxSvcLogFile = None;
881 self.oVBoxSvcProcess = None;
882 self.sVBoxSvcPidFile = None;
883 self.fVBoxSvcInDebugger = False;
884 self.fVBoxSvcWaitForDebugger = False;
885 self.sVBoxValidationKit = None;
886 self.sVBoxValidationKitIso = None;
887 self.sVBoxBootSectors = None;
888 self.fAlwaysUploadLogs = False;
889 self.fAlwaysUploadScreenshots = False;
890 self.fEnableDebugger = True;
891
892 # Drop LD_PRELOAD and enable memory leak detection in LSAN_OPTIONS from vboxinstall.py
893 # before doing build detection. This is a little crude and inflexible...
894 if 'LD_PRELOAD' in os.environ:
895 del os.environ['LD_PRELOAD'];
896 if 'LSAN_OPTIONS' in os.environ:
897 asLSanOptions = os.environ['LSAN_OPTIONS'].split(':');
898 try: asLSanOptions.remove('detect_leaks=0');
899 except: pass;
900 if asLSanOptions: os.environ['LSAN_OPTIONS'] = ':'.join(asLSanOptions);
901 else: del os.environ['LSAN_OPTIONS'];
902
903 # Quietly detect build and validation kit.
904 self._detectBuild(False);
905 self._detectValidationKit(False);
906
907 # Make sure all debug logs goes to the scratch area unless
908 # specified otherwise (more of this later on).
909 if 'VBOX_LOG_DEST' not in os.environ:
910 os.environ['VBOX_LOG_DEST'] = 'nodeny dir=%s' % (self.sScratchPath);
911
912
913 def _detectBuild(self, fQuiet = False):
914 """
915 This is used internally to try figure a locally installed build when
916 running tests manually.
917 """
918 if self.oBuild is not None:
919 return True;
920
921 # Try dev build first since that's where I'll be using it first...
922 if True is True: # pylint: disable=comparison-with-itself
923 try:
924 self.oBuild = Build(self, None);
925 reporter.log('VBox %s build at %s (%s).'
926 % (self.oBuild.sType, self.oBuild.sInstallPath, self.oBuild.sDesignation,));
927 return True;
928 except base.GenError:
929 pass;
930
931 # Try default installation locations.
932 if self.sHost == 'win':
933 sProgFiles = os.environ.get('ProgramFiles', 'C:\\Program Files');
934 asLocs = [
935 os.path.join(sProgFiles, 'Oracle', 'VirtualBox'),
936 os.path.join(sProgFiles, 'OracleVM', 'VirtualBox'),
937 os.path.join(sProgFiles, 'Sun', 'VirtualBox'),
938 ];
939 elif self.sHost == 'solaris':
940 asLocs = [ '/opt/VirtualBox-3.2', '/opt/VirtualBox-3.1', '/opt/VirtualBox-3.0', '/opt/VirtualBox' ];
941 elif self.sHost == 'darwin':
942 asLocs = [ '/Applications/VirtualBox.app/Contents/MacOS' ];
943 elif self.sHost == 'linux':
944 asLocs = [ '/opt/VirtualBox-3.2', '/opt/VirtualBox-3.1', '/opt/VirtualBox-3.0', '/opt/VirtualBox' ];
945 else:
946 asLocs = [ '/opt/VirtualBox' ];
947 if 'VBOX_INSTALL_PATH' in os.environ:
948 asLocs.insert(0, os.environ['VBOX_INSTALL_PATH']);
949
950 for sLoc in asLocs:
951 try:
952 self.oBuild = Build(self, sLoc);
953 reporter.log('VBox %s build at %s (%s).'
954 % (self.oBuild.sType, self.oBuild.sInstallPath, self.oBuild.sDesignation,));
955 return True;
956 except base.GenError:
957 pass;
958
959 if not fQuiet:
960 reporter.error('failed to find VirtualBox installation');
961 return False;
962
963 def _detectValidationKit(self, fQuiet = False):
964 """
965 This is used internally by the constructor to try locate an unzipped
966 VBox Validation Kit somewhere in the immediate proximity.
967 """
968 if self.sVBoxValidationKit is not None:
969 return True;
970
971 #
972 # Normally it's found where we're running from, which is the same as
973 # the script directly on the testboxes.
974 #
975 asCandidates = [self.sScriptPath, ];
976 if g_ksValidationKitDir not in asCandidates:
977 asCandidates.append(g_ksValidationKitDir);
978 if os.getcwd() not in asCandidates:
979 asCandidates.append(os.getcwd());
980 if self.oBuild is not None and self.oBuild.sInstallPath not in asCandidates:
981 asCandidates.append(self.oBuild.sInstallPath);
982
983 #
984 # When working out of the tree, we'll search the current directory
985 # as well as parent dirs.
986 #
987 for sDir in list(asCandidates):
988 for i in range(10):
989 sDir = os.path.dirname(sDir);
990 if sDir not in asCandidates:
991 asCandidates.append(sDir);
992
993 #
994 # Do the searching.
995 #
996 sCandidate = None;
997 for i, _ in enumerate(asCandidates):
998 sCandidate = asCandidates[i];
999 if os.path.isfile(os.path.join(sCandidate, 'VBoxValidationKit.iso')):
1000 break;
1001 sCandidate = os.path.join(sCandidate, 'validationkit');
1002 if os.path.isfile(os.path.join(sCandidate, 'VBoxValidationKit.iso')):
1003 break;
1004 sCandidate = None;
1005
1006 fRc = sCandidate is not None;
1007 if fRc is False:
1008 if not fQuiet:
1009 reporter.error('failed to find VBox Validation Kit installation (candidates: %s)' % (asCandidates,));
1010 sCandidate = os.path.join(self.sScriptPath, 'validationkit'); # Don't leave the values as None.
1011
1012 #
1013 # Set the member values.
1014 #
1015 self.sVBoxValidationKit = sCandidate;
1016 self.sVBoxValidationKitIso = os.path.join(sCandidate, 'VBoxValidationKit.iso');
1017 self.sVBoxBootSectors = os.path.join(sCandidate, 'bootsectors');
1018 return fRc;
1019
1020 def _makeEnvironmentChanges(self):
1021 """
1022 Make the necessary VBox related environment changes.
1023 Children not importing the VBox API should call this.
1024 """
1025 # Make sure we've got our own VirtualBox config and VBoxSVC (on XPCOM at least).
1026 if not self.fUseDefaultSvc:
1027 os.environ['VBOX_USER_HOME'] = os.path.join(self.sScratchPath, 'VBoxUserHome');
1028 sUser = os.environ.get('USERNAME', os.environ.get('USER', os.environ.get('LOGNAME', 'unknown')));
1029 os.environ['VBOX_IPC_SOCKETID'] = sUser + '-VBoxTest';
1030 return True;
1031
1032 @staticmethod
1033 def makeApiRevision(uMajor, uMinor, uBuild, uApiRevision):
1034 """ Calculates an API revision number. """
1035 return (long(uMajor) << 56) | (long(uMinor) << 48) | (long(uBuild) << 40) | uApiRevision;
1036
1037 def importVBoxApi(self):
1038 """
1039 Import the 'vboxapi' module from the VirtualBox build we're using and
1040 instantiate the two basic objects.
1041
1042 This will try detect an development or installed build if no build has
1043 been associated with the driver yet.
1044 """
1045 if self.fImportedVBoxApi:
1046 return True;
1047
1048 self._makeEnvironmentChanges();
1049
1050 # Do the detecting.
1051 self._detectBuild();
1052 if self.oBuild is None:
1053 return False;
1054
1055 # Avoid crashing when loading the 32-bit module (or whatever it is that goes bang).
1056 if self.oBuild.sArch == 'x86' \
1057 and self.sHost == 'darwin' \
1058 and platform.architecture()[0] == '64bit' \
1059 and self.oBuild.sKind == 'development' \
1060 and os.getenv('VERSIONER_PYTHON_PREFER_32_BIT') != 'yes':
1061 reporter.log("WARNING: 64-bit python on darwin, 32-bit VBox development build => crash");
1062 reporter.log("WARNING: bash-3.2$ /usr/bin/python2.5 ./testdriver");
1063 reporter.log("WARNING: or");
1064 reporter.log("WARNING: bash-3.2$ VERSIONER_PYTHON_PREFER_32_BIT=yes ./testdriver");
1065 return False;
1066
1067 # Start VBoxSVC and load the vboxapi bits.
1068 if self._startVBoxSVC() is True:
1069 assert(self.oVBoxSvcProcess is not None);
1070
1071 sSavedSysPath = sys.path;
1072 self._setupVBoxApi();
1073 sys.path = sSavedSysPath;
1074
1075 # Adjust the default machine folder.
1076 if self.fImportedVBoxApi and not self.fUseDefaultSvc and self.fpApiVer >= 4.0:
1077 sNewFolder = os.path.join(self.sScratchPath, 'VBoxUserHome', 'Machines');
1078 try:
1079 self.oVBox.systemProperties.defaultMachineFolder = sNewFolder;
1080 except:
1081 self.fImportedVBoxApi = False;
1082 self.oVBoxMgr = None;
1083 self.oVBox = None;
1084 reporter.logXcpt("defaultMachineFolder exception (sNewFolder=%s)" % (sNewFolder,));
1085
1086 # Kill VBoxSVC on failure.
1087 if self.oVBoxMgr is None:
1088 self._stopVBoxSVC();
1089 else:
1090 assert(self.oVBoxSvcProcess is None);
1091 return self.fImportedVBoxApi;
1092
1093 def _startVBoxSVC(self): # pylint: disable=too-many-statements
1094 """ Starts VBoxSVC. """
1095 assert(self.oVBoxSvcProcess is None);
1096
1097 # Setup vbox logging for VBoxSVC now and start it manually. This way
1098 # we can control both logging and shutdown.
1099 self.sVBoxSvcLogFile = '%s/VBoxSVC-debug.log' % (self.sScratchPath,);
1100 try: os.remove(self.sVBoxSvcLogFile);
1101 except: pass;
1102 os.environ['VBOX_LOG'] = self.sLogSvcGroups;
1103 os.environ['VBOX_LOG_FLAGS'] = '%s append' % (self.sLogSvcFlags,); # Append becuse of VBoxXPCOMIPCD.
1104 if self.sLogSvcDest:
1105 os.environ['VBOX_LOG_DEST'] = 'nodeny ' + self.sLogSvcDest;
1106 else:
1107 os.environ['VBOX_LOG_DEST'] = 'nodeny file=%s' % (self.sVBoxSvcLogFile,);
1108 os.environ['VBOXSVC_RELEASE_LOG_FLAGS'] = 'time append';
1109
1110 # Always leave a pid file behind so we can kill it during cleanup-before.
1111 self.sVBoxSvcPidFile = '%s/VBoxSVC.pid' % (self.sScratchPath,);
1112 fWritePidFile = True;
1113
1114 cMsFudge = 1;
1115 sVBoxSVC = '%s/VBoxSVC' % (self.oBuild.sInstallPath,); ## @todo .exe and stuff.
1116 if self.fVBoxSvcInDebugger:
1117 if self.sHost in ('darwin', 'freebsd', 'linux', 'solaris', ):
1118 # Start VBoxSVC in gdb in a new terminal.
1119 #sTerm = '/usr/bin/gnome-terminal'; - doesn't work, some fork+exec stuff confusing us.
1120 sTerm = '/usr/bin/xterm';
1121 if not os.path.isfile(sTerm): sTerm = '/usr/X11/bin/xterm';
1122 if not os.path.isfile(sTerm): sTerm = '/usr/X11R6/bin/xterm';
1123 if not os.path.isfile(sTerm): sTerm = '/usr/bin/xterm';
1124 if not os.path.isfile(sTerm): sTerm = 'xterm';
1125 sGdb = '/usr/bin/gdb';
1126 if not os.path.isfile(sGdb): sGdb = '/usr/local/bin/gdb';
1127 if not os.path.isfile(sGdb): sGdb = '/usr/sfw/bin/gdb';
1128 if not os.path.isfile(sGdb): sGdb = 'gdb';
1129 sGdbCmdLine = '%s --args %s --pidfile %s' % (sGdb, sVBoxSVC, self.sVBoxSvcPidFile);
1130 reporter.log('term="%s" gdb="%s"' % (sTerm, sGdbCmdLine));
1131 os.environ['SHELL'] = self.sOrgShell; # Non-working shell may cause gdb and/or the term problems.
1132 ## @todo -e is deprecated; use "-- <args>".
1133 self.oVBoxSvcProcess = base.Process.spawnp(sTerm, sTerm, '-e', sGdbCmdLine);
1134 os.environ['SHELL'] = self.sOurShell;
1135 if self.oVBoxSvcProcess is not None:
1136 reporter.log('Press enter or return after starting VBoxSVC in the debugger...');
1137 sys.stdin.read(1);
1138 fWritePidFile = False;
1139
1140 elif self.sHost == 'win':
1141 sWinDbg = 'c:\\Program Files\\Debugging Tools for Windows\\windbg.exe';
1142 if not os.path.isfile(sWinDbg): sWinDbg = 'c:\\Program Files\\Debugging Tools for Windows (x64)\\windbg.exe';
1143 if not os.path.isfile(sWinDbg): sWinDbg = 'c:\\Programme\\Debugging Tools for Windows\\windbg.exe'; # Localization rulez! pylint: disable=line-too-long
1144 if not os.path.isfile(sWinDbg): sWinDbg = 'c:\\Programme\\Debugging Tools for Windows (x64)\\windbg.exe';
1145 if not os.path.isfile(sWinDbg): sWinDbg = 'windbg'; # WinDbg must be in the path; better than nothing.
1146 # Assume that everything WinDbg needs is defined using the environment variables.
1147 # See WinDbg help for more information.
1148 reporter.log('windbg="%s"' % (sWinDbg));
1149 self.oVBoxSvcProcess = base.Process.spawn(sWinDbg, sWinDbg, sVBoxSVC + base.exeSuff());
1150 if self.oVBoxSvcProcess is not None:
1151 reporter.log('Press enter or return after starting VBoxSVC in the debugger...');
1152 sys.stdin.read(1);
1153 fWritePidFile = False;
1154 ## @todo add a pipe interface similar to xpcom if feasible, i.e. if
1155 # we can get actual handle values for pipes in python.
1156
1157 else:
1158 reporter.error('Port me!');
1159 else: # Run without a debugger attached.
1160 if self.sHost in ('darwin', 'freebsd', 'linux', 'solaris', ):
1161 #
1162 # XPCOM - We can use a pipe to let VBoxSVC notify us when it's ready.
1163 #
1164 iPipeR, iPipeW = os.pipe();
1165 if hasattr(os, 'set_inheritable'):
1166 os.set_inheritable(iPipeW, True); # pylint: disable=no-member
1167 os.environ['NSPR_INHERIT_FDS'] = 'vboxsvc:startup-pipe:5:0x%x' % (iPipeW,);
1168 reporter.log2("NSPR_INHERIT_FDS=%s" % (os.environ['NSPR_INHERIT_FDS']));
1169
1170 self.oVBoxSvcProcess = base.Process.spawn(sVBoxSVC, sVBoxSVC, '--auto-shutdown'); # SIGUSR1 requirement.
1171 try: # Try make sure we get the SIGINT and not VBoxSVC.
1172 os.setpgid(self.oVBoxSvcProcess.getPid(), 0); # pylint: disable=no-member
1173 os.setpgid(0, 0); # pylint: disable=no-member
1174 except:
1175 reporter.logXcpt();
1176
1177 os.close(iPipeW);
1178 try:
1179 sResponse = os.read(iPipeR, 32);
1180 except:
1181 reporter.logXcpt();
1182 sResponse = None;
1183 os.close(iPipeR);
1184
1185 if hasattr(sResponse, 'decode'):
1186 sResponse = sResponse.decode('utf-8', 'ignore');
1187
1188 if sResponse is None or sResponse.strip() != 'READY':
1189 reporter.error('VBoxSVC failed starting up... (sResponse=%s)' % (sResponse,));
1190 if not self.oVBoxSvcProcess.wait(5000):
1191 self.oVBoxSvcProcess.terminate();
1192 self.oVBoxSvcProcess.wait(5000);
1193 self.oVBoxSvcProcess = None;
1194
1195 elif self.sHost == 'win':
1196 #
1197 # Windows - Just fudge it for now.
1198 #
1199 cMsFudge = 2000;
1200 self.oVBoxSvcProcess = base.Process.spawn(sVBoxSVC, sVBoxSVC);
1201
1202 else:
1203 reporter.error('Port me!');
1204
1205 #
1206 # Enable automatic crash reporting if we succeeded.
1207 #
1208 if self.oVBoxSvcProcess is not None:
1209 self.oVBoxSvcProcess.enableCrashReporting('crash/report/svc', 'crash/dump/svc');
1210
1211 #
1212 # Wait for debugger to attach.
1213 #
1214 if self.oVBoxSvcProcess is not None and self.fVBoxSvcWaitForDebugger:
1215 reporter.log('Press any key after attaching to VBoxSVC (pid %s) with a debugger...'
1216 % (self.oVBoxSvcProcess.getPid(),));
1217 sys.stdin.read(1);
1218
1219 #
1220 # Fudge and pid file.
1221 #
1222 if self.oVBoxSvcProcess is not None and not self.oVBoxSvcProcess.wait(cMsFudge):
1223 if fWritePidFile:
1224 iPid = self.oVBoxSvcProcess.getPid();
1225 try:
1226 oFile = utils.openNoInherit(self.sVBoxSvcPidFile, "w+");
1227 oFile.write('%s' % (iPid,));
1228 oFile.close();
1229 except:
1230 reporter.logXcpt('sPidFile=%s' % (self.sVBoxSvcPidFile,));
1231 reporter.log('VBoxSVC PID=%u' % (iPid,));
1232
1233 #
1234 # Finally add the task so we'll notice when it dies in a relatively timely manner.
1235 #
1236 self.addTask(self.oVBoxSvcProcess);
1237 else:
1238 self.oVBoxSvcProcess = None;
1239 try: os.remove(self.sVBoxSvcPidFile);
1240 except: pass;
1241
1242 return self.oVBoxSvcProcess is not None;
1243
1244
1245 def _killVBoxSVCByPidFile(self, sPidFile):
1246 """ Kill a VBoxSVC given the pid from it's pid file. """
1247
1248 # Read the pid file.
1249 if not os.path.isfile(sPidFile):
1250 return False;
1251 try:
1252 oFile = utils.openNoInherit(sPidFile, "r");
1253 sPid = oFile.readline().strip();
1254 oFile.close();
1255 except:
1256 reporter.logXcpt('sPidfile=%s' % (sPidFile,));
1257 return False;
1258
1259 # Convert the pid to an integer and validate the range a little bit.
1260 try:
1261 iPid = long(sPid);
1262 except:
1263 reporter.logXcpt('sPidfile=%s sPid="%s"' % (sPidFile, sPid));
1264 return False;
1265 if iPid <= 0:
1266 reporter.log('negative pid - sPidfile=%s sPid="%s" iPid=%d' % (sPidFile, sPid, iPid));
1267 return False;
1268
1269 # Take care checking that it's VBoxSVC we're about to inhume.
1270 if base.processCheckPidAndName(iPid, "VBoxSVC") is not True:
1271 reporter.log('Ignoring stale VBoxSVC pid file (pid=%s)' % (iPid,));
1272 return False;
1273
1274 # Loop thru our different ways of getting VBoxSVC to terminate.
1275 for aHow in [ [ base.sendUserSignal1, 5000, 'Dropping VBoxSVC a SIGUSR1 hint...'], \
1276 [ base.processInterrupt, 5000, 'Dropping VBoxSVC a SIGINT hint...'], \
1277 [ base.processTerminate, 7500, 'VBoxSVC is still around, killing it...'] ]:
1278 reporter.log(aHow[2]);
1279 if aHow[0](iPid) is True:
1280 msStart = base.timestampMilli();
1281 while base.timestampMilli() - msStart < 5000 \
1282 and base.processExists(iPid):
1283 time.sleep(0.2);
1284
1285 fRc = not base.processExists(iPid);
1286 if fRc is True:
1287 break;
1288 if fRc:
1289 reporter.log('Successfully killed VBoxSVC (pid=%s)' % (iPid,));
1290 else:
1291 reporter.log('Failed to kill VBoxSVC (pid=%s)' % (iPid,));
1292 return fRc;
1293
1294 def _stopVBoxSVC(self):
1295 """
1296 Stops VBoxSVC. Try the polite way first.
1297 """
1298
1299 if self.oVBoxSvcProcess:
1300 self.removeTask(self.oVBoxSvcProcess);
1301 self.oVBoxSvcProcess.enableCrashReporting(None, None); # Disables it.
1302
1303 fRc = False;
1304 if self.oVBoxSvcProcess is not None \
1305 and not self.fVBoxSvcInDebugger:
1306 # by process object.
1307 if self.oVBoxSvcProcess.isRunning():
1308 reporter.log('Dropping VBoxSVC a SIGUSR1 hint...');
1309 if not self.oVBoxSvcProcess.sendUserSignal1() \
1310 or not self.oVBoxSvcProcess.wait(5000):
1311 reporter.log('Dropping VBoxSVC a SIGINT hint...');
1312 if not self.oVBoxSvcProcess.interrupt() \
1313 or not self.oVBoxSvcProcess.wait(5000):
1314 reporter.log('VBoxSVC is still around, killing it...');
1315 self.oVBoxSvcProcess.terminate();
1316 self.oVBoxSvcProcess.wait(7500);
1317 else:
1318 reporter.log('VBoxSVC is no longer running...');
1319
1320 if not self.oVBoxSvcProcess.isRunning():
1321 iExit = self.oVBoxSvcProcess.getExitCode();
1322 if iExit != 0 or not self.oVBoxSvcProcess.isNormalExit():
1323 reporter.error("VBoxSVC exited with status %d (%#x)" % (iExit, self.oVBoxSvcProcess.uExitCode));
1324 self.oVBoxSvcProcess = None;
1325 else:
1326 # by pid file.
1327 self._killVBoxSVCByPidFile('%s/VBoxSVC.pid' % (self.sScratchPath,));
1328 return fRc;
1329
1330 def _setupVBoxApi(self):
1331 """
1332 Import and set up the vboxapi.
1333 The caller saves and restores sys.path.
1334 """
1335
1336 # Setup vbox logging for self (the test driver).
1337 self.sSelfLogFile = '%s/VBoxTestDriver.log' % (self.sScratchPath,);
1338 try: os.remove(self.sSelfLogFile);
1339 except: pass;
1340 os.environ['VBOX_LOG'] = self.sLogSelfGroups;
1341 os.environ['VBOX_LOG_FLAGS'] = '%s append' % (self.sLogSelfFlags, );
1342 if self.sLogSelfDest:
1343 os.environ['VBOX_LOG_DEST'] = 'nodeny ' + self.sLogSelfDest;
1344 else:
1345 os.environ['VBOX_LOG_DEST'] = 'nodeny file=%s' % (self.sSelfLogFile,);
1346 os.environ['VBOX_RELEASE_LOG_FLAGS'] = 'time append';
1347
1348 # Hack the sys.path + environment so the vboxapi can be found.
1349 sys.path.insert(0, self.oBuild.sInstallPath);
1350 if self.oBuild.sSdkPath is not None:
1351 sys.path.insert(0, os.path.join(self.oBuild.sSdkPath, 'installer'))
1352 sys.path.insert(1, os.path.join(self.oBuild.sSdkPath, 'install')); # stupid stupid windows installer!
1353 sys.path.insert(2, os.path.join(self.oBuild.sSdkPath, 'bindings', 'xpcom', 'python'))
1354 os.environ['VBOX_PROGRAM_PATH'] = self.oBuild.sInstallPath;
1355 reporter.log("sys.path: %s" % (sys.path));
1356
1357 try:
1358 from vboxapi import VirtualBoxManager; # pylint: disable=import-error
1359 except:
1360 reporter.logXcpt('Error importing vboxapi');
1361 return False;
1362
1363 # Exception and error hacks.
1364 try:
1365 # pylint: disable=import-error
1366 if self.sHost == 'win':
1367 from pythoncom import com_error as NativeComExceptionClass # pylint: disable=no-name-in-module
1368 import winerror as NativeComErrorClass
1369 else:
1370 from xpcom import Exception as NativeComExceptionClass
1371 from xpcom import nsError as NativeComErrorClass
1372 # pylint: enable=import-error
1373 except:
1374 reporter.logXcpt('Error importing (XP)COM related stuff for exception hacks and errors');
1375 return False;
1376 __deployExceptionHacks__(NativeComExceptionClass)
1377 ComError.copyErrors(NativeComErrorClass);
1378
1379 # Create the manager.
1380 try:
1381 self.oVBoxMgr = VirtualBoxManager(None, None)
1382 except:
1383 self.oVBoxMgr = None;
1384 reporter.logXcpt('VirtualBoxManager exception');
1385 return False;
1386
1387 # Figure the API version.
1388 try:
1389 oVBox = self.oVBoxMgr.getVirtualBox();
1390
1391 try:
1392 sVer = oVBox.version;
1393 except:
1394 reporter.logXcpt('Failed to get VirtualBox version, assuming 4.0.0');
1395 sVer = "4.0.0";
1396 reporter.log("IVirtualBox.version=%s" % (sVer,));
1397
1398 # Convert the string to three integer values and check ranges.
1399 asVerComponents = sVer.split('.');
1400 try:
1401 sLast = asVerComponents[2].split('_')[0].split('r')[0];
1402 aiVerComponents = (int(asVerComponents[0]), int(asVerComponents[1]), int(sLast));
1403 except:
1404 raise base.GenError('Malformed version "%s"' % (sVer,));
1405 if aiVerComponents[0] < 3 or aiVerComponents[0] > 19:
1406 raise base.GenError('Malformed version "%s" - 1st component is out of bounds 3..19: %u'
1407 % (sVer, aiVerComponents[0]));
1408 if aiVerComponents[1] < 0 or aiVerComponents[1] > 9:
1409 raise base.GenError('Malformed version "%s" - 2nd component is out of bounds 0..9: %u'
1410 % (sVer, aiVerComponents[1]));
1411 if aiVerComponents[2] < 0 or aiVerComponents[2] > 99:
1412 raise base.GenError('Malformed version "%s" - 3rd component is out of bounds 0..99: %u'
1413 % (sVer, aiVerComponents[2]));
1414
1415 # Convert the three integers into a floating point value. The API is stable within a
1416 # x.y release, so the third component only indicates whether it's a stable or
1417 # development build of the next release.
1418 self.fpApiVer = aiVerComponents[0] + 0.1 * aiVerComponents[1];
1419 if aiVerComponents[2] >= 51:
1420 if self.fpApiVer not in [6.1, 5.2, 4.3, 3.2,]:
1421 self.fpApiVer += 0.1;
1422 else:
1423 self.fpApiVer = int(self.fpApiVer) + 1.0;
1424 # fudge value to be always bigger than the nominal value (0.1 gets rounded down)
1425 if round(self.fpApiVer, 1) > self.fpApiVer:
1426 self.fpApiVer += sys.float_info.epsilon * self.fpApiVer / 2.0;
1427
1428 try:
1429 self.uRevision = oVBox.revision;
1430 except:
1431 reporter.logXcpt('Failed to get VirtualBox revision, assuming 0');
1432 self.uRevision = 0;
1433 reporter.log("IVirtualBox.revision=%u" % (self.uRevision,));
1434
1435 try:
1436 self.uApiRevision = oVBox.APIRevision;
1437 except:
1438 reporter.logXcpt('Failed to get VirtualBox APIRevision, faking it.');
1439 self.uApiRevision = self.makeApiRevision(aiVerComponents[0], aiVerComponents[1], aiVerComponents[2], 0);
1440 reporter.log("IVirtualBox.APIRevision=%#x" % (self.uApiRevision,));
1441
1442 # Patch VBox manage to gloss over portability issues (error constants, etc).
1443 self._patchVBoxMgr();
1444
1445 # Wrap oVBox.
1446 from testdriver.vboxwrappers import VirtualBoxWrapper;
1447 self.oVBox = VirtualBoxWrapper(oVBox, self.oVBoxMgr, self.fpApiVer, self);
1448
1449 # Install the constant wrapping hack.
1450 vboxcon.goHackModuleClass.oVBoxMgr = self.oVBoxMgr; # VBoxConstantWrappingHack.
1451 vboxcon.fpApiVer = self.fpApiVer;
1452 reporter.setComXcptFormatter(formatComOrXpComException);
1453
1454 except:
1455 self.oVBoxMgr = None;
1456 self.oVBox = None;
1457 reporter.logXcpt("getVirtualBox / API version exception");
1458 return False;
1459
1460 # Done
1461 self.fImportedVBoxApi = True;
1462 reporter.log('Found version %s (%s)' % (self.fpApiVer, sVer));
1463 return True;
1464
1465 def _patchVBoxMgr(self):
1466 """
1467 Glosses over missing self.oVBoxMgr methods on older VBox versions.
1468 """
1469
1470 def _xcptGetResult(oSelf, oXcpt = None):
1471 """ See vboxapi. """
1472 _ = oSelf;
1473 if oXcpt is None: oXcpt = sys.exc_info()[1];
1474 if sys.platform == 'win32':
1475 import winerror; # pylint: disable=import-error
1476 hrXcpt = oXcpt.hresult;
1477 if hrXcpt == winerror.DISP_E_EXCEPTION:
1478 hrXcpt = oXcpt.excepinfo[5];
1479 else:
1480 hrXcpt = oXcpt.error;
1481 return hrXcpt;
1482
1483 def _xcptIsDeadInterface(oSelf, oXcpt = None):
1484 """ See vboxapi. """
1485 return oSelf.xcptGetStatus(oXcpt) in [
1486 0x80004004, -2147467260, # NS_ERROR_ABORT
1487 0x800706be, -2147023170, # NS_ERROR_CALL_FAILED (RPC_S_CALL_FAILED)
1488 0x800706ba, -2147023174, # RPC_S_SERVER_UNAVAILABLE.
1489 0x800706be, -2147023170, # RPC_S_CALL_FAILED.
1490 0x800706bf, -2147023169, # RPC_S_CALL_FAILED_DNE.
1491 0x80010108, -2147417848, # RPC_E_DISCONNECTED.
1492 0x800706b5, -2147023179, # RPC_S_UNKNOWN_IF
1493 ];
1494
1495 def _xcptIsOurXcptKind(oSelf, oXcpt = None):
1496 """ See vboxapi. """
1497 _ = oSelf;
1498 if oXcpt is None: oXcpt = sys.exc_info()[1];
1499 if sys.platform == 'win32':
1500 from pythoncom import com_error as NativeComExceptionClass # pylint: disable=import-error,no-name-in-module
1501 else:
1502 from xpcom import Exception as NativeComExceptionClass # pylint: disable=import-error
1503 return isinstance(oXcpt, NativeComExceptionClass);
1504
1505 def _xcptIsEqual(oSelf, oXcpt, hrStatus):
1506 """ See vboxapi. """
1507 hrXcpt = oSelf.xcptGetResult(oXcpt);
1508 return hrXcpt == hrStatus or hrXcpt == hrStatus - 0x100000000; # pylint: disable=consider-using-in
1509
1510 def _xcptToString(oSelf, oXcpt):
1511 """ See vboxapi. """
1512 _ = oSelf;
1513 if oXcpt is None: oXcpt = sys.exc_info()[1];
1514 return str(oXcpt);
1515
1516 def _getEnumValueName(oSelf, sEnumTypeNm, oEnumValue, fTypePrefix = False):
1517 """ See vboxapi. """
1518 _ = oSelf; _ = fTypePrefix;
1519 return '%s::%s' % (sEnumTypeNm, oEnumValue);
1520
1521 # Add utilities found in newer vboxapi revision.
1522 if not hasattr(self.oVBoxMgr, 'xcptIsDeadInterface'):
1523 import types;
1524 self.oVBoxMgr.xcptGetResult = types.MethodType(_xcptGetResult, self.oVBoxMgr);
1525 self.oVBoxMgr.xcptIsDeadInterface = types.MethodType(_xcptIsDeadInterface, self.oVBoxMgr);
1526 self.oVBoxMgr.xcptIsOurXcptKind = types.MethodType(_xcptIsOurXcptKind, self.oVBoxMgr);
1527 self.oVBoxMgr.xcptIsEqual = types.MethodType(_xcptIsEqual, self.oVBoxMgr);
1528 self.oVBoxMgr.xcptToString = types.MethodType(_xcptToString, self.oVBoxMgr);
1529 if not hasattr(self.oVBoxMgr, 'getEnumValueName'):
1530 import types;
1531 self.oVBoxMgr.getEnumValueName = types.MethodType(_getEnumValueName, self.oVBoxMgr);
1532
1533
1534 def _teardownVBoxApi(self): # pylint: disable=too-many-statements
1535 """
1536 Drop all VBox object references and shutdown com/xpcom.
1537 """
1538 if not self.fImportedVBoxApi:
1539 return True;
1540 import gc;
1541
1542 # Drop all references we've have to COM objects.
1543 self.aoRemoteSessions = [];
1544 self.aoVMs = [];
1545 self.oVBoxMgr = None;
1546 self.oVBox = None;
1547 vboxcon.goHackModuleClass.oVBoxMgr = None; # VBoxConstantWrappingHack.
1548 reporter.setComXcptFormatter(None);
1549
1550 # Do garbage collection to try get rid of those objects.
1551 try:
1552 gc.collect();
1553 except:
1554 reporter.logXcpt();
1555 self.fImportedVBoxApi = False;
1556
1557 # Check whether the python is still having any COM objects/interfaces around.
1558 cVBoxMgrs = 0;
1559 aoObjsLeftBehind = [];
1560 if self.sHost == 'win':
1561 import pythoncom; # pylint: disable=import-error
1562 try:
1563 cIfs = pythoncom._GetInterfaceCount(); # pylint: disable=no-member,protected-access
1564 cObjs = pythoncom._GetGatewayCount(); # pylint: disable=no-member,protected-access
1565 if cObjs == 0 and cIfs == 0:
1566 reporter.log('_teardownVBoxApi: no interfaces or objects left behind.');
1567 else:
1568 reporter.log('_teardownVBoxApi: Python COM still has %s objects and %s interfaces...' % ( cObjs, cIfs));
1569
1570 from win32com.client import DispatchBaseClass; # pylint: disable=import-error
1571 for oObj in gc.get_objects():
1572 if isinstance(oObj, DispatchBaseClass):
1573 reporter.log('_teardownVBoxApi: %s' % (oObj,));
1574 aoObjsLeftBehind.append(oObj);
1575 elif utils.getObjectTypeName(oObj) == 'VirtualBoxManager':
1576 reporter.log('_teardownVBoxApi: %s' % (oObj,));
1577 cVBoxMgrs += 1;
1578 aoObjsLeftBehind.append(oObj);
1579 oObj = None;
1580 except:
1581 reporter.logXcpt();
1582
1583 # If not being used, we can safely uninitialize COM.
1584 if cIfs == 0 and cObjs == 0 and cVBoxMgrs == 0 and not aoObjsLeftBehind:
1585 reporter.log('_teardownVBoxApi: Calling CoUninitialize...');
1586 try: pythoncom.CoUninitialize(); # pylint: disable=no-member
1587 except: reporter.logXcpt();
1588 else:
1589 reporter.log('_teardownVBoxApi: Returned from CoUninitialize.');
1590 else:
1591 try:
1592 # XPCOM doesn't crash and burn like COM if you shut it down with interfaces and objects around.
1593 # Also, it keeps a number of internal objects and interfaces around to do its job, so shutting
1594 # it down before we go looking for dangling interfaces is more or less required.
1595 from xpcom import _xpcom as _xpcom; # pylint: disable=import-error,useless-import-alias
1596 hrc = _xpcom.DeinitCOM();
1597 cIfs = _xpcom._GetInterfaceCount(); # pylint: disable=protected-access
1598 cObjs = _xpcom._GetGatewayCount(); # pylint: disable=protected-access
1599
1600 if cObjs == 0 and cIfs == 0:
1601 reporter.log('_teardownVBoxApi: No XPCOM interfaces or objects active. (hrc=%#x)' % (hrc,));
1602 else:
1603 reporter.log('_teardownVBoxApi: %s XPCOM objects and %s interfaces still around! (hrc=%#x)'
1604 % (cObjs, cIfs, hrc));
1605 if hasattr(_xpcom, '_DumpInterfaces'):
1606 try: _xpcom._DumpInterfaces(); # pylint: disable=protected-access
1607 except: reporter.logXcpt('_teardownVBoxApi: _DumpInterfaces failed');
1608
1609 from xpcom.client import Component; # pylint: disable=import-error
1610 for oObj in gc.get_objects():
1611 if isinstance(oObj, Component):
1612 reporter.log('_teardownVBoxApi: %s' % (oObj,));
1613 aoObjsLeftBehind.append(oObj);
1614 if utils.getObjectTypeName(oObj) == 'VirtualBoxManager':
1615 reporter.log('_teardownVBoxApi: %s' % (oObj,));
1616 cVBoxMgrs += 1;
1617 aoObjsLeftBehind.append(oObj);
1618 oObj = None;
1619 except:
1620 reporter.logXcpt();
1621
1622 # Try get the referrers to (XP)COM interfaces and objects that was left behind.
1623 for iObj in range(len(aoObjsLeftBehind)): # pylint: disable=consider-using-enumerate
1624 try:
1625 aoReferrers = gc.get_referrers(aoObjsLeftBehind[iObj]);
1626 reporter.log('_teardownVBoxApi: Found %u referrers to %s:' % (len(aoReferrers), aoObjsLeftBehind[iObj],));
1627 for oReferrer in aoReferrers:
1628 oMyFrame = sys._getframe(0); # pylint: disable=protected-access
1629 if oReferrer is oMyFrame:
1630 reporter.log('_teardownVBoxApi: - frame of this function');
1631 elif oReferrer is aoObjsLeftBehind:
1632 reporter.log('_teardownVBoxApi: - aoObjsLeftBehind');
1633 else:
1634 fPrinted = False;
1635 if isinstance(oReferrer, (dict, list, tuple)):
1636 try:
1637 aoSubReferreres = gc.get_referrers(oReferrer);
1638 for oSubRef in aoSubReferreres:
1639 if not isinstance(oSubRef, list) \
1640 and not isinstance(oSubRef, dict) \
1641 and oSubRef is not oMyFrame \
1642 and oSubRef is not aoSubReferreres:
1643 reporter.log('_teardownVBoxApi: - %s :: %s:'
1644 % (utils.getObjectTypeName(oSubRef), utils.getObjectTypeName(oReferrer)));
1645 fPrinted = True;
1646 break;
1647 del aoSubReferreres;
1648 except:
1649 reporter.logXcpt('subref');
1650 if not fPrinted:
1651 reporter.log('_teardownVBoxApi: - %s:' % (utils.getObjectTypeName(oReferrer),));
1652 try:
1653 import pprint;
1654 for sLine in pprint.pformat(oReferrer, width = 130).split('\n'):
1655 reporter.log('_teardownVBoxApi: %s' % (sLine,));
1656 except:
1657 reporter.log('_teardownVBoxApi: %s' % (oReferrer,));
1658 except:
1659 reporter.logXcpt();
1660 del aoObjsLeftBehind;
1661
1662 # Force garbage collection again, just for good measure.
1663 try:
1664 gc.collect();
1665 time.sleep(0.5); # fudge factor
1666 except:
1667 reporter.logXcpt();
1668 return True;
1669
1670 def _powerOffAllVms(self):
1671 """
1672 Tries to power off all running VMs.
1673 """
1674 for oSession in self.aoRemoteSessions:
1675 uPid = oSession.getPid();
1676 if uPid is not None:
1677 reporter.log('_powerOffAllVms: PID is %s for %s, trying to kill it.' % (uPid, oSession.sName,));
1678 base.processKill(uPid);
1679 else:
1680 reporter.log('_powerOffAllVms: No PID for %s' % (oSession.sName,));
1681 oSession.close();
1682 return None;
1683
1684
1685
1686 #
1687 # Build type, OS and arch getters.
1688 #
1689
1690 def getBuildType(self):
1691 """
1692 Get the build type.
1693 """
1694 if not self._detectBuild():
1695 return 'release';
1696 return self.oBuild.sType;
1697
1698 def getBuildOs(self):
1699 """
1700 Get the build OS.
1701 """
1702 if not self._detectBuild():
1703 return self.sHost;
1704 return self.oBuild.sOs;
1705
1706 def getBuildArch(self):
1707 """
1708 Get the build arch.
1709 """
1710 if not self._detectBuild():
1711 return self.sHostArch;
1712 return self.oBuild.sArch;
1713
1714 def getGuestAdditionsIso(self):
1715 """
1716 Get the path to the guest addition iso.
1717 """
1718 if not self._detectBuild():
1719 return None;
1720 return self.oBuild.sGuestAdditionsIso;
1721
1722 #
1723 # Override everything from the base class so the testdrivers don't have to
1724 # check whether we have overridden a method or not.
1725 #
1726
1727 def showUsage(self):
1728 rc = base.TestDriver.showUsage(self);
1729 reporter.log('');
1730 reporter.log('Generic VirtualBox Options:');
1731 reporter.log(' --vbox-session-type <type>');
1732 reporter.log(' Sets the session type. Typical values are: gui, headless, sdl');
1733 reporter.log(' Default: %s' % (self.sSessionTypeDef));
1734 reporter.log(' --vrdp, --no-vrdp');
1735 reporter.log(' Enables VRDP, ports starting at 6000');
1736 reporter.log(' Default: --vrdp');
1737 reporter.log(' --vrdp-base-port <port>');
1738 reporter.log(' Sets the base for VRDP port assignments.');
1739 reporter.log(' Default: %s' % (self.uVrdpBasePortDef));
1740 reporter.log(' --vbox-default-bridged-nic <interface>');
1741 reporter.log(' Sets the default interface for bridged networking.');
1742 reporter.log(' Default: autodetect');
1743 reporter.log(' --vbox-use-svc-defaults');
1744 reporter.log(' Use default locations and files for VBoxSVC. This is useful');
1745 reporter.log(' for automatically configuring the test VMs for debugging.');
1746 reporter.log(' --vbox-log');
1747 reporter.log(' The VBox logger group settings for everyone.');
1748 reporter.log(' --vbox-log-flags');
1749 reporter.log(' The VBox logger flags settings for everyone.');
1750 reporter.log(' --vbox-log-dest');
1751 reporter.log(' The VBox logger destination settings for everyone.');
1752 reporter.log(' --vbox-self-log');
1753 reporter.log(' The VBox logger group settings for the testdriver.');
1754 reporter.log(' --vbox-self-log-flags');
1755 reporter.log(' The VBox logger flags settings for the testdriver.');
1756 reporter.log(' --vbox-self-log-dest');
1757 reporter.log(' The VBox logger destination settings for the testdriver.');
1758 reporter.log(' --vbox-session-log');
1759 reporter.log(' The VM session logger group settings.');
1760 reporter.log(' --vbox-session-log-flags');
1761 reporter.log(' The VM session logger flags.');
1762 reporter.log(' --vbox-session-log-dest');
1763 reporter.log(' The VM session logger destination settings.');
1764 reporter.log(' --vbox-svc-log');
1765 reporter.log(' The VBoxSVC logger group settings.');
1766 reporter.log(' --vbox-svc-log-flags');
1767 reporter.log(' The VBoxSVC logger flag settings.');
1768 reporter.log(' --vbox-svc-log-dest');
1769 reporter.log(' The VBoxSVC logger destination settings.');
1770 reporter.log(' --vbox-svc-debug');
1771 reporter.log(' Start VBoxSVC in a debugger.');
1772 reporter.log(' --vbox-svc-wait-debug');
1773 reporter.log(' Start VBoxSVC and wait for debugger to attach to it.');
1774 reporter.log(' --vbox-always-upload-logs');
1775 reporter.log(' Whether to always upload log files, or only do so on failure.');
1776 reporter.log(' --vbox-always-upload-screenshots');
1777 reporter.log(' Whether to always upload final screen shots, or only do so on failure.');
1778 reporter.log(' --vbox-debugger, --no-vbox-debugger');
1779 reporter.log(' Enables the VBox debugger, port at 5000');
1780 reporter.log(' Default: --vbox-debugger');
1781 if self.oTestVmSet is not None:
1782 self.oTestVmSet.showUsage();
1783 return rc;
1784
1785 def parseOption(self, asArgs, iArg): # pylint: disable=too-many-statements
1786 if asArgs[iArg] == '--vbox-session-type':
1787 iArg += 1;
1788 if iArg >= len(asArgs):
1789 raise base.InvalidOption('The "--vbox-session-type" takes an argument');
1790 self.sSessionType = asArgs[iArg];
1791 elif asArgs[iArg] == '--vrdp':
1792 self.fEnableVrdp = True;
1793 elif asArgs[iArg] == '--no-vrdp':
1794 self.fEnableVrdp = False;
1795 elif asArgs[iArg] == '--vrdp-base-port':
1796 iArg += 1;
1797 if iArg >= len(asArgs):
1798 raise base.InvalidOption('The "--vrdp-base-port" takes an argument');
1799 try: self.uVrdpBasePort = int(asArgs[iArg]);
1800 except: raise base.InvalidOption('The "--vrdp-base-port" value "%s" is not a valid integer' % (asArgs[iArg],));
1801 if self.uVrdpBasePort <= 0 or self.uVrdpBasePort >= 65530:
1802 raise base.InvalidOption('The "--vrdp-base-port" value "%s" is not in the valid range (1..65530)'
1803 % (asArgs[iArg],));
1804 elif asArgs[iArg] == '--vbox-default-bridged-nic':
1805 iArg += 1;
1806 if iArg >= len(asArgs):
1807 raise base.InvalidOption('The "--vbox-default-bridged-nic" takes an argument');
1808 self.sDefBridgedNic = asArgs[iArg];
1809 elif asArgs[iArg] == '--vbox-use-svc-defaults':
1810 self.fUseDefaultSvc = True;
1811 elif asArgs[iArg] == '--vbox-self-log':
1812 iArg += 1;
1813 if iArg >= len(asArgs):
1814 raise base.InvalidOption('The "--vbox-self-log" takes an argument');
1815 self.sLogSelfGroups = asArgs[iArg];
1816 elif asArgs[iArg] == '--vbox-self-log-flags':
1817 iArg += 1;
1818 if iArg >= len(asArgs):
1819 raise base.InvalidOption('The "--vbox-self-log-flags" takes an argument');
1820 self.sLogSelfFlags = asArgs[iArg];
1821 elif asArgs[iArg] == '--vbox-self-log-dest':
1822 iArg += 1;
1823 if iArg >= len(asArgs):
1824 raise base.InvalidOption('The "--vbox-self-log-dest" takes an argument');
1825 self.sLogSelfDest = asArgs[iArg];
1826 elif asArgs[iArg] == '--vbox-session-log':
1827 iArg += 1;
1828 if iArg >= len(asArgs):
1829 raise base.InvalidOption('The "--vbox-session-log" takes an argument');
1830 self.sLogSessionGroups = asArgs[iArg];
1831 elif asArgs[iArg] == '--vbox-session-log-flags':
1832 iArg += 1;
1833 if iArg >= len(asArgs):
1834 raise base.InvalidOption('The "--vbox-session-log-flags" takes an argument');
1835 self.sLogSessionFlags = asArgs[iArg];
1836 elif asArgs[iArg] == '--vbox-session-log-dest':
1837 iArg += 1;
1838 if iArg >= len(asArgs):
1839 raise base.InvalidOption('The "--vbox-session-log-dest" takes an argument');
1840 self.sLogSessionDest = asArgs[iArg];
1841 elif asArgs[iArg] == '--vbox-svc-log':
1842 iArg += 1;
1843 if iArg >= len(asArgs):
1844 raise base.InvalidOption('The "--vbox-svc-log" takes an argument');
1845 self.sLogSvcGroups = asArgs[iArg];
1846 elif asArgs[iArg] == '--vbox-svc-log-flags':
1847 iArg += 1;
1848 if iArg >= len(asArgs):
1849 raise base.InvalidOption('The "--vbox-svc-log-flags" takes an argument');
1850 self.sLogSvcFlags = asArgs[iArg];
1851 elif asArgs[iArg] == '--vbox-svc-log-dest':
1852 iArg += 1;
1853 if iArg >= len(asArgs):
1854 raise base.InvalidOption('The "--vbox-svc-log-dest" takes an argument');
1855 self.sLogSvcDest = asArgs[iArg];
1856 elif asArgs[iArg] == '--vbox-log':
1857 iArg += 1;
1858 if iArg >= len(asArgs):
1859 raise base.InvalidOption('The "--vbox-log" takes an argument');
1860 self.sLogSelfGroups = asArgs[iArg];
1861 self.sLogSessionGroups = asArgs[iArg];
1862 self.sLogSvcGroups = asArgs[iArg];
1863 elif asArgs[iArg] == '--vbox-log-flags':
1864 iArg += 1;
1865 if iArg >= len(asArgs):
1866 raise base.InvalidOption('The "--vbox-svc-flags" takes an argument');
1867 self.sLogSelfFlags = asArgs[iArg];
1868 self.sLogSessionFlags = asArgs[iArg];
1869 self.sLogSvcFlags = asArgs[iArg];
1870 elif asArgs[iArg] == '--vbox-log-dest':
1871 iArg += 1;
1872 if iArg >= len(asArgs):
1873 raise base.InvalidOption('The "--vbox-log-dest" takes an argument');
1874 self.sLogSelfDest = asArgs[iArg];
1875 self.sLogSessionDest = asArgs[iArg];
1876 self.sLogSvcDest = asArgs[iArg];
1877 elif asArgs[iArg] == '--vbox-svc-debug':
1878 self.fVBoxSvcInDebugger = True;
1879 elif asArgs[iArg] == '--vbox-svc-wait-debug':
1880 self.fVBoxSvcWaitForDebugger = True;
1881 elif asArgs[iArg] == '--vbox-always-upload-logs':
1882 self.fAlwaysUploadLogs = True;
1883 elif asArgs[iArg] == '--vbox-always-upload-screenshots':
1884 self.fAlwaysUploadScreenshots = True;
1885 elif asArgs[iArg] == '--vbox-debugger':
1886 self.fEnableDebugger = True;
1887 elif asArgs[iArg] == '--no-vbox-debugger':
1888 self.fEnableDebugger = False;
1889 else:
1890 # Relevant for selecting VMs to test?
1891 if self.oTestVmSet is not None:
1892 iRc = self.oTestVmSet.parseOption(asArgs, iArg);
1893 if iRc != iArg:
1894 return iRc;
1895
1896 # Hand it to the base class.
1897 return base.TestDriver.parseOption(self, asArgs, iArg);
1898 return iArg + 1;
1899
1900 def completeOptions(self):
1901 return base.TestDriver.completeOptions(self);
1902
1903 def getNetworkAdapterNameFromType(self, oNic):
1904 """
1905 Returns the network adapter name from a given adapter type.
1906
1907 Returns an empty string if not found / invalid.
1908 """
1909 sAdpName = '';
1910 if oNic.adapterType == vboxcon.NetworkAdapterType_Am79C970A \
1911 or oNic.adapterType == vboxcon.NetworkAdapterType_Am79C973 \
1912 or oNic.adapterType == vboxcon.NetworkAdapterType_Am79C960:
1913 sAdpName = 'pcnet';
1914 elif oNic.adapterType == vboxcon.NetworkAdapterType_I82540EM \
1915 or oNic.adapterType == vboxcon.NetworkAdapterType_I82543GC \
1916 or oNic.adapterType == vboxcon.NetworkAdapterType_I82545EM:
1917 sAdpName = 'e1000';
1918 elif oNic.adapterType == vboxcon.NetworkAdapterType_Virtio:
1919 sAdpName = 'virtio-net';
1920 elif oNic.adapterType == vboxcon.NetworkAdapterType_Virtio_1_0:
1921 sAdpName = 'virtio-net-1-dot-0';
1922 return sAdpName;
1923
1924 def getResourceSet(self):
1925 asRsrcs = [];
1926 if self.oTestVmSet is not None:
1927 asRsrcs.extend(self.oTestVmSet.getResourceSet());
1928 asRsrcs.extend(base.TestDriver.getResourceSet(self));
1929 return asRsrcs;
1930
1931 def actionExtract(self):
1932 return base.TestDriver.actionExtract(self);
1933
1934 def actionVerify(self):
1935 return base.TestDriver.actionVerify(self);
1936
1937 def actionConfig(self):
1938 return base.TestDriver.actionConfig(self);
1939
1940 def actionExecute(self):
1941 return base.TestDriver.actionExecute(self);
1942
1943 def actionCleanupBefore(self):
1944 """
1945 Kill any VBoxSVC left behind by a previous test run.
1946 """
1947 self._killVBoxSVCByPidFile('%s/VBoxSVC.pid' % (self.sScratchPath,));
1948 return base.TestDriver.actionCleanupBefore(self);
1949
1950 def actionCleanupAfter(self):
1951 """
1952 Clean up the VBox bits and then call the base driver.
1953
1954 If your test driver overrides this, it should normally call us at the
1955 end of the job.
1956 """
1957 cErrorsEntry = reporter.getErrorCount();
1958
1959 # Kill any left over VM processes.
1960 self._powerOffAllVms();
1961
1962 # Drop all VBox object references and shutdown xpcom then
1963 # terminating VBoxSVC, with extreme prejudice if need be.
1964 self._teardownVBoxApi();
1965 self._stopVBoxSVC();
1966
1967 # Add the VBoxSVC and testdriver debug+release log files.
1968 if self.fAlwaysUploadLogs or reporter.getErrorCount() > 0:
1969 if self.sVBoxSvcLogFile is not None and os.path.isfile(self.sVBoxSvcLogFile):
1970 reporter.addLogFile(self.sVBoxSvcLogFile, 'log/debug/svc', 'Debug log file for VBoxSVC');
1971 self.sVBoxSvcLogFile = None;
1972
1973 if self.sSelfLogFile is not None and os.path.isfile(self.sSelfLogFile):
1974 reporter.addLogFile(self.sSelfLogFile, 'log/debug/client', 'Debug log file for the test driver');
1975 self.sSelfLogFile = None;
1976
1977 sVBoxSvcRelLog = os.path.join(self.sScratchPath, 'VBoxUserHome', 'VBoxSVC.log');
1978 if os.path.isfile(sVBoxSvcRelLog):
1979 reporter.addLogFile(sVBoxSvcRelLog, 'log/release/svc', 'Release log file for VBoxSVC');
1980 for sSuff in [ '.1', '.2', '.3', '.4', '.5', '.6', '.7', '.8' ]:
1981 if os.path.isfile(sVBoxSvcRelLog + sSuff):
1982 reporter.addLogFile(sVBoxSvcRelLog + sSuff, 'log/release/svc', 'Release log file for VBoxSVC');
1983
1984 # Finally, call the base driver to wipe the scratch space.
1985 fRc = base.TestDriver.actionCleanupAfter(self);
1986
1987 # Flag failure if the error count increased.
1988 if reporter.getErrorCount() > cErrorsEntry:
1989 fRc = False;
1990 return fRc;
1991
1992
1993 def actionAbort(self):
1994 """
1995 Terminate VBoxSVC if we've got a pid file.
1996 """
1997 #
1998 # Take default action first, then kill VBoxSVC. The other way around
1999 # is problematic since the testscript would continue running and possibly
2000 # trigger a new VBoxSVC to start.
2001 #
2002 fRc1 = base.TestDriver.actionAbort(self);
2003 fRc2 = self._killVBoxSVCByPidFile('%s/VBoxSVC.pid' % (self.sScratchPath,));
2004 return fRc1 is True and fRc2 is True;
2005
2006 def onExit(self, iRc):
2007 """
2008 Stop VBoxSVC if we've started it.
2009 """
2010 if self.oVBoxSvcProcess is not None:
2011 reporter.log('*** Shutting down the VBox API... (iRc=%s)' % (iRc,));
2012 self._powerOffAllVms();
2013 self._teardownVBoxApi();
2014 self._stopVBoxSVC();
2015 reporter.log('*** VBox API shutdown done.');
2016 return base.TestDriver.onExit(self, iRc);
2017
2018
2019 #
2020 # Task wait method override.
2021 #
2022
2023 def notifyAboutReadyTask(self, oTask):
2024 """
2025 Overriding base.TestDriver.notifyAboutReadyTask.
2026 """
2027 try:
2028 self.oVBoxMgr.interruptWaitEvents();
2029 reporter.log2('vbox.notifyAboutReadyTask: called interruptWaitEvents');
2030 except:
2031 reporter.logXcpt('vbox.notifyAboutReadyTask');
2032 return base.TestDriver.notifyAboutReadyTask(self, oTask);
2033
2034 def waitForTasksSleepWorker(self, cMsTimeout):
2035 """
2036 Overriding base.TestDriver.waitForTasksSleepWorker.
2037 """
2038 try:
2039 rc = self.oVBoxMgr.waitForEvents(int(cMsTimeout));
2040 _ = rc; #reporter.log2('vbox.waitForTasksSleepWorker(%u): true (waitForEvents -> %s)' % (cMsTimeout, rc));
2041 reporter.doPollWork('vbox.TestDriver.waitForTasksSleepWorker');
2042 return True;
2043 except KeyboardInterrupt:
2044 raise;
2045 except:
2046 reporter.logXcpt('vbox.waitForTasksSleepWorker');
2047 return False;
2048
2049 #
2050 # Utility methods.
2051 #
2052
2053 def processEvents(self, cMsTimeout = 0):
2054 """
2055 Processes events, returning after the first batch has been processed
2056 or the time limit has been reached.
2057
2058 Only Ctrl-C exception, no return.
2059 """
2060 try:
2061 self.oVBoxMgr.waitForEvents(cMsTimeout);
2062 except KeyboardInterrupt:
2063 raise;
2064 except:
2065 pass;
2066 return None;
2067
2068 def processPendingEvents(self):
2069 """ processEvents(0) - no waiting. """
2070 return self.processEvents(0);
2071
2072 def sleep(self, cSecs):
2073 """
2074 Sleep for a specified amount of time, processing XPCOM events all the while.
2075 """
2076 cMsTimeout = long(cSecs * 1000);
2077 msStart = base.timestampMilli();
2078 self.processEvents(0);
2079 while True:
2080 cMsElapsed = base.timestampMilli() - msStart;
2081 if cMsElapsed > cMsTimeout:
2082 break;
2083 #reporter.log2('cMsTimeout=%s - cMsElapsed=%d => %s' % (cMsTimeout, cMsElapsed, cMsTimeout - cMsElapsed));
2084 self.processEvents(cMsTimeout - cMsElapsed);
2085 return None;
2086
2087 def _logVmInfoUnsafe(self, oVM): # pylint: disable=too-many-statements,too-many-branches
2088 """
2089 Internal worker for logVmInfo that is wrapped in try/except.
2090 """
2091 reporter.log(" Name: %s" % (oVM.name,));
2092 reporter.log(" ID: %s" % (oVM.id,));
2093 oOsType = self.oVBox.getGuestOSType(oVM.OSTypeId);
2094 reporter.log(" OS Type: %s - %s" % (oVM.OSTypeId, oOsType.description,));
2095 reporter.log(" Machine state: %s" % (oVM.state,));
2096 reporter.log(" Session state: %s" % (oVM.sessionState,));
2097 if self.fpApiVer >= 4.2:
2098 reporter.log(" Session PID: %u (%#x)" % (oVM.sessionPID, oVM.sessionPID,));
2099 else:
2100 reporter.log(" Session PID: %u (%#x)" % (oVM.sessionPid, oVM.sessionPid,));
2101 if self.fpApiVer >= 5.0:
2102 reporter.log(" Session Name: %s" % (oVM.sessionName,));
2103 else:
2104 reporter.log(" Session Name: %s" % (oVM.sessionType,));
2105 reporter.log(" CPUs: %s" % (oVM.CPUCount,));
2106 reporter.log(" RAM: %sMB" % (oVM.memorySize,));
2107 if self.fpApiVer >= 6.1 and hasattr(oVM, 'graphicsAdapter'):
2108 reporter.log(" VRAM: %sMB" % (oVM.graphicsAdapter.VRAMSize,));
2109 reporter.log(" Monitors: %s" % (oVM.graphicsAdapter.monitorCount,));
2110 reporter.log(" GraphicsController: %s"
2111 % (self.oVBoxMgr.getEnumValueName('GraphicsControllerType', # pylint: disable=not-callable
2112 oVM.graphicsAdapter.graphicsControllerType),));
2113 else:
2114 reporter.log(" VRAM: %sMB" % (oVM.VRAMSize,));
2115 reporter.log(" Monitors: %s" % (oVM.monitorCount,));
2116 reporter.log(" GraphicsController: %s"
2117 % (self.oVBoxMgr.getEnumValueName('GraphicsControllerType', oVM.graphicsControllerType),)); # pylint: disable=not-callable
2118 reporter.log(" Chipset: %s" % (self.oVBoxMgr.getEnumValueName('ChipsetType', oVM.chipsetType),)); # pylint: disable=not-callable
2119 if self.fpApiVer >= 6.2 and hasattr(vboxcon, 'IommuType_None'):
2120 reporter.log(" IOMMU: %s" % (self.oVBoxMgr.getEnumValueName('IommuType', oVM.iommuType),)); # pylint: disable=not-callable
2121 reporter.log(" Firmware: %s" % (self.oVBoxMgr.getEnumValueName('FirmwareType', oVM.firmwareType),)); # pylint: disable=not-callable
2122 reporter.log(" HwVirtEx: %s" % (oVM.getHWVirtExProperty(vboxcon.HWVirtExPropertyType_Enabled),));
2123 reporter.log(" VPID support: %s" % (oVM.getHWVirtExProperty(vboxcon.HWVirtExPropertyType_VPID),));
2124 reporter.log(" Nested paging: %s" % (oVM.getHWVirtExProperty(vboxcon.HWVirtExPropertyType_NestedPaging),));
2125 atTypes = [
2126 ( 'CPUPropertyType_PAE', 'PAE: '),
2127 ( 'CPUPropertyType_LongMode', 'Long-mode: '),
2128 ( 'CPUPropertyType_HWVirt', 'Nested VT-x/AMD-V: '),
2129 ( 'CPUPropertyType_APIC', 'APIC: '),
2130 ( 'CPUPropertyType_X2APIC', 'X2APIC: '),
2131 ( 'CPUPropertyType_TripleFaultReset', 'TripleFaultReset: '),
2132 ( 'CPUPropertyType_IBPBOnVMExit', 'IBPBOnVMExit: '),
2133 ( 'CPUPropertyType_SpecCtrl', 'SpecCtrl: '),
2134 ( 'CPUPropertyType_SpecCtrlByHost', 'SpecCtrlByHost: '),
2135 ];
2136 for sEnumValue, sDesc in atTypes:
2137 if hasattr(vboxcon, sEnumValue):
2138 reporter.log(" %s%s" % (sDesc, oVM.getCPUProperty(getattr(vboxcon, sEnumValue)),));
2139 reporter.log(" ACPI: %s" % (oVM.BIOSSettings.ACPIEnabled,));
2140 reporter.log(" IO-APIC: %s" % (oVM.BIOSSettings.IOAPICEnabled,));
2141 if self.fpApiVer >= 3.2:
2142 if self.fpApiVer >= 4.2:
2143 reporter.log(" HPET: %s" % (oVM.HPETEnabled,));
2144 else:
2145 reporter.log(" HPET: %s" % (oVM.hpetEnabled,));
2146 if self.fpApiVer >= 6.1 and hasattr(oVM, 'graphicsAdapter'):
2147 reporter.log(" 3D acceleration: %s" % (oVM.graphicsAdapter.accelerate3DEnabled,));
2148 reporter.log(" 2D acceleration: %s" % (oVM.graphicsAdapter.accelerate2DVideoEnabled,));
2149 else:
2150 reporter.log(" 3D acceleration: %s" % (oVM.accelerate3DEnabled,));
2151 reporter.log(" 2D acceleration: %s" % (oVM.accelerate2DVideoEnabled,));
2152 reporter.log(" TeleporterEnabled: %s" % (oVM.teleporterEnabled,));
2153 reporter.log(" TeleporterPort: %s" % (oVM.teleporterPort,));
2154 reporter.log(" TeleporterAddress: %s" % (oVM.teleporterAddress,));
2155 reporter.log(" TeleporterPassword: %s" % (oVM.teleporterPassword,));
2156 reporter.log(" Clipboard mode: %s" % (oVM.clipboardMode,));
2157 if self.fpApiVer >= 5.0:
2158 reporter.log(" Drag and drop mode: %s" % (oVM.dnDMode,));
2159 elif self.fpApiVer >= 4.3:
2160 reporter.log(" Drag and drop mode: %s" % (oVM.dragAndDropMode,));
2161 if self.fpApiVer >= 4.0:
2162 reporter.log(" VRDP server: %s" % (oVM.VRDEServer.enabled,));
2163 try: sPorts = oVM.VRDEServer.getVRDEProperty("TCP/Ports");
2164 except: sPorts = "";
2165 reporter.log(" VRDP server ports: %s" % (sPorts,));
2166 reporter.log(" VRDP auth: %s (%s)" % (oVM.VRDEServer.authType, oVM.VRDEServer.authLibrary,));
2167 else:
2168 reporter.log(" VRDP server: %s" % (oVM.VRDPServer.enabled,));
2169 reporter.log(" VRDP server ports: %s" % (oVM.VRDPServer.ports,));
2170 reporter.log(" Last changed: %s" % (oVM.lastStateChange,));
2171
2172 aoControllers = self.oVBoxMgr.getArray(oVM, 'storageControllers')
2173 if aoControllers:
2174 reporter.log(" Controllers:");
2175 for oCtrl in aoControllers:
2176 reporter.log(" %s %s bus: %s type: %s" % (oCtrl.name, oCtrl.controllerType, oCtrl.bus, oCtrl.controllerType,));
2177 reporter.log(" AudioController: %s"
2178 % (self.oVBoxMgr.getEnumValueName('AudioControllerType', oVM.audioAdapter.audioController),)); # pylint: disable=not-callable
2179 reporter.log(" AudioEnabled: %s" % (oVM.audioAdapter.enabled,));
2180 reporter.log(" Host AudioDriver: %s"
2181 % (self.oVBoxMgr.getEnumValueName('AudioDriverType', oVM.audioAdapter.audioDriver),)); # pylint: disable=not-callable
2182
2183 self.processPendingEvents();
2184 aoAttachments = self.oVBoxMgr.getArray(oVM, 'mediumAttachments')
2185 if aoAttachments:
2186 reporter.log(" Attachments:");
2187 for oAtt in aoAttachments:
2188 sCtrl = "Controller: %s port: %s device: %s type: %s" % (oAtt.controller, oAtt.port, oAtt.device, oAtt.type);
2189 oMedium = oAtt.medium
2190 if oAtt.type == vboxcon.DeviceType_HardDisk:
2191 reporter.log(" %s: HDD" % sCtrl);
2192 reporter.log(" Id: %s" % (oMedium.id,));
2193 reporter.log(" Name: %s" % (oMedium.name,));
2194 reporter.log(" Format: %s" % (oMedium.format,));
2195 reporter.log(" Location: %s" % (oMedium.location,));
2196
2197 if oAtt.type == vboxcon.DeviceType_DVD:
2198 reporter.log(" %s: DVD" % sCtrl);
2199 if oMedium:
2200 reporter.log(" Id: %s" % (oMedium.id,));
2201 reporter.log(" Name: %s" % (oMedium.name,));
2202 if oMedium.hostDrive:
2203 reporter.log(" Host DVD %s" % (oMedium.location,));
2204 if oAtt.passthrough:
2205 reporter.log(" [passthrough mode]");
2206 else:
2207 reporter.log(" Virtual image: %s" % (oMedium.location,));
2208 reporter.log(" Size: %s" % (oMedium.size,));
2209 else:
2210 reporter.log(" empty");
2211
2212 if oAtt.type == vboxcon.DeviceType_Floppy:
2213 reporter.log(" %s: Floppy" % sCtrl);
2214 if oMedium:
2215 reporter.log(" Id: %s" % (oMedium.id,));
2216 reporter.log(" Name: %s" % (oMedium.name,));
2217 if oMedium.hostDrive:
2218 reporter.log(" Host floppy: %s" % (oMedium.location,));
2219 else:
2220 reporter.log(" Virtual image: %s" % (oMedium.location,));
2221 reporter.log(" Size: %s" % (oMedium.size,));
2222 else:
2223 reporter.log(" empty");
2224 self.processPendingEvents();
2225
2226 reporter.log(" Network Adapter:");
2227 for iSlot in range(0, 32):
2228 try: oNic = oVM.getNetworkAdapter(iSlot)
2229 except: break;
2230 if not oNic.enabled:
2231 reporter.log2(" slot #%d found but not enabled, skipping" % (iSlot,));
2232 continue;
2233 reporter.log(" slot #%d: type: %s (%s) MAC Address: %s lineSpeed: %s"
2234 % (iSlot, self.oVBoxMgr.getEnumValueName('NetworkAdapterType', oNic.adapterType), # pylint: disable=not-callable
2235 oNic.adapterType, oNic.MACAddress, oNic.lineSpeed) );
2236
2237 if oNic.attachmentType == vboxcon.NetworkAttachmentType_NAT:
2238 reporter.log(" attachmentType: NAT (%s)" % (oNic.attachmentType,));
2239 if self.fpApiVer >= 4.1:
2240 reporter.log(" nat-network: %s" % (oNic.NATNetwork,));
2241 elif oNic.attachmentType == vboxcon.NetworkAttachmentType_Bridged:
2242 reporter.log(" attachmentType: Bridged (%s)" % (oNic.attachmentType,));
2243 if self.fpApiVer >= 4.1:
2244 reporter.log(" hostInterface: %s" % (oNic.bridgedInterface,));
2245 else:
2246 reporter.log(" hostInterface: %s" % (oNic.hostInterface,));
2247 elif oNic.attachmentType == vboxcon.NetworkAttachmentType_Internal:
2248 reporter.log(" attachmentType: Internal (%s)" % (oNic.attachmentType,));
2249 reporter.log(" intnet-name: %s" % (oNic.internalNetwork,));
2250 elif oNic.attachmentType == vboxcon.NetworkAttachmentType_HostOnly:
2251 reporter.log(" attachmentType: HostOnly (%s)" % (oNic.attachmentType,));
2252 if self.fpApiVer >= 4.1:
2253 reporter.log(" hostInterface: %s" % (oNic.hostOnlyInterface,));
2254 else:
2255 reporter.log(" hostInterface: %s" % (oNic.hostInterface,));
2256 else:
2257 if self.fpApiVer >= 7.0:
2258 if oNic.attachmentType == vboxcon.NetworkAttachmentType_HostOnlyNetwork:
2259 reporter.log(" attachmentType: HostOnlyNetwork (%s)" % (oNic.attachmentType,));
2260 reporter.log(" hostonly-net: %s" % (oNic.hostOnlyNetwork,));
2261 elif self.fpApiVer >= 4.1:
2262 if oNic.attachmentType == vboxcon.NetworkAttachmentType_Generic:
2263 reporter.log(" attachmentType: Generic (%s)" % (oNic.attachmentType,));
2264 reporter.log(" generic-driver: %s" % (oNic.GenericDriver,));
2265 else:
2266 reporter.log(" attachmentType: unknown-%s" % (oNic.attachmentType,));
2267 else:
2268 reporter.log(" attachmentType: unknown-%s" % (oNic.attachmentType,));
2269 if oNic.traceEnabled:
2270 reporter.log(" traceFile: %s" % (oNic.traceFile,));
2271 self.processPendingEvents();
2272
2273 reporter.log(" Serial ports:");
2274 for iSlot in range(0, 8):
2275 try: oPort = oVM.getSerialPort(iSlot)
2276 except: break;
2277 if oPort is not None and oPort.enabled:
2278 enmHostMode = oPort.hostMode;
2279 reporter.log(" slot #%d: hostMode: %s (%s) I/O port: %s IRQ: %s server: %s path: %s" %
2280 (iSlot, self.oVBoxMgr.getEnumValueName('PortMode', enmHostMode), # pylint: disable=not-callable
2281 enmHostMode, oPort.IOBase, oPort.IRQ, oPort.server, oPort.path,) );
2282 self.processPendingEvents();
2283
2284 return True;
2285
2286 def logVmInfo(self, oVM): # pylint: disable=too-many-statements,too-many-branches
2287 """
2288 Logs VM configuration details.
2289
2290 This is copy, past, search, replace and edit of infoCmd from vboxshell.py.
2291 """
2292 try:
2293 fRc = self._logVmInfoUnsafe(oVM);
2294 except:
2295 reporter.logXcpt();
2296 fRc = False;
2297 return fRc;
2298
2299 def logVmInfoByName(self, sName):
2300 """
2301 logVmInfo + getVmByName.
2302 """
2303 return self.logVmInfo(self.getVmByName(sName));
2304
2305 def tryFindGuestOsId(self, sIdOrDesc):
2306 """
2307 Takes a guest OS ID or Description and returns the ID.
2308 If nothing matching it is found, the input is returned unmodified.
2309 """
2310
2311 if self.fpApiVer >= 4.0:
2312 if sIdOrDesc == 'Solaris (64 bit)':
2313 sIdOrDesc = 'Oracle Solaris 10 5/09 and earlier (64 bit)';
2314
2315 try:
2316 aoGuestTypes = self.oVBoxMgr.getArray(self.oVBox, 'GuestOSTypes');
2317 except:
2318 reporter.logXcpt();
2319 else:
2320 for oGuestOS in aoGuestTypes:
2321 try:
2322 sId = oGuestOS.id;
2323 sDesc = oGuestOS.description;
2324 except:
2325 reporter.logXcpt();
2326 else:
2327 if sIdOrDesc in (sId, sDesc,):
2328 sIdOrDesc = sId;
2329 break;
2330 self.processPendingEvents();
2331 return sIdOrDesc
2332
2333 def resourceFindVmHd(self, sVmName, sFlavor):
2334 """
2335 Search the test resources for the most recent VM HD.
2336
2337 Returns path relative to the test resource root.
2338 """
2339 ## @todo implement a proper search algo here.
2340 return '4.2/' + sFlavor + '/' + sVmName + '/t-' + sVmName + '.vdi';
2341
2342
2343 #
2344 # VM Api wrappers that logs errors, hides exceptions and other details.
2345 #
2346
2347 def createTestVMOnly(self, sName, sKind):
2348 """
2349 Creates and register a test VM without doing any kind of configuration.
2350
2351 Returns VM object (IMachine) on success, None on failure.
2352 """
2353 if not self.importVBoxApi():
2354 return None;
2355
2356 # create + register the VM
2357 try:
2358 if self.fpApiVer >= 4.2: # Introduces grouping (third parameter, empty for now).
2359 oVM = self.oVBox.createMachine("", sName, [], self.tryFindGuestOsId(sKind), "");
2360 elif self.fpApiVer >= 4.0:
2361 oVM = self.oVBox.createMachine("", sName, self.tryFindGuestOsId(sKind), "", False);
2362 elif self.fpApiVer >= 3.2:
2363 oVM = self.oVBox.createMachine(sName, self.tryFindGuestOsId(sKind), "", "", False);
2364 else:
2365 oVM = self.oVBox.createMachine(sName, self.tryFindGuestOsId(sKind), "", "");
2366 try:
2367 oVM.saveSettings();
2368 try:
2369 self.oVBox.registerMachine(oVM);
2370 return oVM;
2371 except:
2372 reporter.logXcpt();
2373 raise;
2374 except:
2375 reporter.logXcpt();
2376 if self.fpApiVer >= 4.0:
2377 try:
2378 if self.fpApiVer >= 4.3:
2379 oProgress = oVM.deleteConfig([]);
2380 else:
2381 oProgress = oVM.delete(None);
2382 self.waitOnProgress(oProgress);
2383 except:
2384 reporter.logXcpt();
2385 else:
2386 try: oVM.deleteSettings();
2387 except: reporter.logXcpt();
2388 raise;
2389 except:
2390 reporter.errorXcpt('failed to create vm "%s"' % (sName));
2391 return None;
2392
2393 # pylint: disable=too-many-arguments,too-many-locals,too-many-statements
2394 def createTestVM(self,
2395 sName,
2396 iGroup,
2397 sHd = None,
2398 cMbRam = None,
2399 cCpus = 1,
2400 fVirtEx = None,
2401 fNestedPaging = None,
2402 sDvdImage = None,
2403 sKind = "Other",
2404 fIoApic = None,
2405 fNstHwVirt = None,
2406 fPae = None,
2407 fFastBootLogo = True,
2408 eNic0Type = None,
2409 eNic0AttachType = None,
2410 sNic0NetName = 'default',
2411 sNic0MacAddr = 'grouped',
2412 sFloppy = None,
2413 fNatForwardingForTxs = None,
2414 sHddControllerType = 'IDE Controller',
2415 fVmmDevTestingPart = None,
2416 fVmmDevTestingMmio = False,
2417 sFirmwareType = 'bios',
2418 sChipsetType = 'piix3',
2419 sIommuType = 'none',
2420 sDvdControllerType = 'IDE Controller',
2421 sCom1RawFile = None):
2422 """
2423 Creates a test VM with a immutable HD from the test resources.
2424 """
2425 # create + register the VM
2426 oVM = self.createTestVMOnly(sName, sKind);
2427 if not oVM:
2428 return None;
2429
2430 # Configure the VM.
2431 fRc = True;
2432 oSession = self.openSession(oVM);
2433 if oSession is not None:
2434 fRc = oSession.setupPreferredConfig();
2435
2436 if fRc and cMbRam is not None :
2437 fRc = oSession.setRamSize(cMbRam);
2438 if fRc and cCpus is not None:
2439 fRc = oSession.setCpuCount(cCpus);
2440 if fRc and fVirtEx is not None:
2441 fRc = oSession.enableVirtEx(fVirtEx);
2442 if fRc and fNestedPaging is not None:
2443 fRc = oSession.enableNestedPaging(fNestedPaging);
2444 if fRc and fIoApic is not None:
2445 fRc = oSession.enableIoApic(fIoApic);
2446 if fRc and fNstHwVirt is not None:
2447 fRc = oSession.enableNestedHwVirt(fNstHwVirt);
2448 if fRc and fPae is not None:
2449 fRc = oSession.enablePae(fPae);
2450 if fRc and sDvdImage is not None:
2451 fRc = oSession.attachDvd(sDvdImage, sDvdControllerType);
2452 if fRc and sHd is not None:
2453 fRc = oSession.attachHd(sHd, sHddControllerType);
2454 if fRc and sFloppy is not None:
2455 fRc = oSession.attachFloppy(sFloppy);
2456 if fRc and eNic0Type is not None:
2457 fRc = oSession.setNicType(eNic0Type, 0);
2458 if fRc and (eNic0AttachType is not None or (sNic0NetName is not None and sNic0NetName != 'default')):
2459 fRc = oSession.setNicAttachment(eNic0AttachType, sNic0NetName, 0);
2460 if fRc and sNic0MacAddr is not None:
2461 if sNic0MacAddr == 'grouped':
2462 sNic0MacAddr = '%02X' % (iGroup);
2463 fRc = oSession.setNicMacAddress(sNic0MacAddr, 0);
2464 if fRc and fNatForwardingForTxs is True:
2465 fRc = oSession.setupNatForwardingForTxs();
2466 if fRc and fFastBootLogo is not None:
2467 fRc = oSession.setupBootLogo(fFastBootLogo);
2468 if fRc and self.fEnableVrdp:
2469 fRc = oSession.setupVrdp(True, self.uVrdpBasePort + iGroup);
2470 if fRc and fVmmDevTestingPart is not None:
2471 fRc = oSession.enableVmmDevTestingPart(fVmmDevTestingPart, fVmmDevTestingMmio);
2472 if fRc and sFirmwareType == 'bios':
2473 fRc = oSession.setFirmwareType(vboxcon.FirmwareType_BIOS);
2474 elif sFirmwareType == 'efi':
2475 fRc = oSession.setFirmwareType(vboxcon.FirmwareType_EFI);
2476 if fRc and self.fEnableDebugger:
2477 fRc = oSession.setExtraData('VBoxInternal/DBGC/Enabled', '1');
2478 if fRc and sChipsetType == 'piix3':
2479 fRc = oSession.setChipsetType(vboxcon.ChipsetType_PIIX3);
2480 elif sChipsetType == 'ich9':
2481 fRc = oSession.setChipsetType(vboxcon.ChipsetType_ICH9);
2482 if fRc and sCom1RawFile:
2483 fRc = oSession.setupSerialToRawFile(0, sCom1RawFile);
2484 if fRc and self.fpApiVer >= 6.2 and hasattr(vboxcon, 'IommuType_AMD') and sIommuType == 'amd':
2485 fRc = oSession.setIommuType(vboxcon.IommuType_AMD);
2486 elif fRc and self.fpApiVer >= 6.2 and hasattr(vboxcon, 'IommuType_Intel') and sIommuType == 'intel':
2487 fRc = oSession.setIommuType(vboxcon.IommuType_Intel);
2488
2489 if fRc: fRc = oSession.saveSettings();
2490 if not fRc: oSession.discardSettings(True);
2491 oSession.close();
2492 if not fRc:
2493 try: self.oVBox.unregisterMachine(oVM.id);
2494 except: pass;
2495 if self.fpApiVer >= 4.0:
2496 try:
2497 if self.fpApiVer >= 4.3:
2498 oProgress = oVM.deleteConfig([]);
2499 else:
2500 oProgress = oVM.delete(None);
2501 self.waitOnProgress(oProgress);
2502 except:
2503 reporter.logXcpt();
2504 else:
2505 try: oVM.deleteSettings();
2506 except: reporter.logXcpt();
2507 return None;
2508
2509 # success.
2510 reporter.log('created "%s" with name "%s"' % (oVM.id, sName));
2511 self.aoVMs.append(oVM);
2512 self.logVmInfo(oVM); # testing...
2513 return oVM;
2514 # pylint: enable=too-many-arguments,too-many-locals,too-many-statements
2515
2516 def createTestVmWithDefaults(self, # pylint: disable=too-many-arguments
2517 sName,
2518 iGroup,
2519 sKind,
2520 sDvdImage = None,
2521 fFastBootLogo = True,
2522 eNic0AttachType = None,
2523 sNic0NetName = 'default',
2524 sNic0MacAddr = 'grouped',
2525 fVmmDevTestingPart = None,
2526 fVmmDevTestingMmio = False,
2527 sCom1RawFile = None):
2528 """
2529 Creates a test VM with all defaults and no HDs.
2530 """
2531 # create + register the VM
2532 oVM = self.createTestVMOnly(sName, sKind);
2533 if oVM is not None:
2534 # Configure the VM with defaults according to sKind.
2535 fRc = True;
2536 oSession = self.openSession(oVM);
2537 if oSession is not None:
2538 if self.fpApiVer >= 6.0:
2539 try:
2540 oSession.o.machine.applyDefaults('');
2541 except:
2542 reporter.errorXcpt('failed to apply defaults to vm "%s"' % (sName,));
2543 fRc = False;
2544 else:
2545 reporter.error("Implement applyDefaults for vbox version %s" % (self.fpApiVer,));
2546 #fRc = oSession.setupPreferredConfig();
2547 fRc = False;
2548
2549 # Apply the specified configuration:
2550 if fRc and sDvdImage is not None:
2551 #fRc = oSession.insertDvd(sDvdImage); # attachDvd
2552 reporter.error('Implement: oSession.insertDvd(%s)' % (sDvdImage,));
2553 fRc = False;
2554
2555 if fRc and fFastBootLogo is not None:
2556 fRc = oSession.setupBootLogo(fFastBootLogo);
2557
2558 if fRc and (eNic0AttachType is not None or (sNic0NetName is not None and sNic0NetName != 'default')):
2559 fRc = oSession.setNicAttachment(eNic0AttachType, sNic0NetName, 0);
2560 if fRc and sNic0MacAddr is not None:
2561 if sNic0MacAddr == 'grouped':
2562 sNic0MacAddr = '%02X' % (iGroup,);
2563 fRc = oSession.setNicMacAddress(sNic0MacAddr, 0);
2564
2565 if fRc and fVmmDevTestingPart is not None:
2566 fRc = oSession.enableVmmDevTestingPart(fVmmDevTestingPart, fVmmDevTestingMmio);
2567
2568 if fRc and sCom1RawFile:
2569 fRc = oSession.setupSerialToRawFile(0, sCom1RawFile);
2570
2571 # Save the settings if we were successfull, otherwise discard them.
2572 if fRc:
2573 fRc = oSession.saveSettings();
2574 if not fRc:
2575 oSession.discardSettings(True);
2576 oSession.close();
2577
2578 if fRc is True:
2579 # If we've been successful, add the VM to the list and return it.
2580 # success.
2581 reporter.log('created "%s" with name "%s"' % (oVM.id, sName, ));
2582 self.aoVMs.append(oVM);
2583 self.logVmInfo(oVM); # testing...
2584 return oVM;
2585
2586 # Failed. Unregister the machine and delete it.
2587 try: self.oVBox.unregisterMachine(oVM.id);
2588 except: pass;
2589
2590 if self.fpApiVer >= 4.0:
2591 try:
2592 if self.fpApiVer >= 4.3:
2593 oProgress = oVM.deleteConfig([]);
2594 else:
2595 oProgress = oVM.delete(None);
2596 self.waitOnProgress(oProgress);
2597 except:
2598 reporter.logXcpt();
2599 else:
2600 try: oVM.deleteSettings();
2601 except: reporter.logXcpt();
2602 return None;
2603
2604 def addTestMachine(self, sNameOrId, fQuiet = False):
2605 """
2606 Adds an already existing (that is, configured) test VM to the
2607 test VM list.
2608 """
2609 # find + add the VM to the list.
2610 try:
2611 if self.fpApiVer >= 4.0:
2612 oVM = self.oVBox.findMachine(sNameOrId);
2613 else:
2614 reporter.error('fpApiVer=%s - did you remember to initialize the API' % (self.fpApiVer,));
2615 except:
2616 reporter.errorXcpt('could not find vm "%s"' % (sNameOrId,));
2617 return None;
2618
2619 self.aoVMs.append(oVM);
2620 if not fQuiet:
2621 reporter.log('Added "%s" with name "%s"' % (oVM.id, sNameOrId));
2622 self.logVmInfo(oVM);
2623 return oVM;
2624
2625 def openSession(self, oVM):
2626 """
2627 Opens a session for the VM. Returns the a Session wrapper object that
2628 will automatically close the session when the wrapper goes out of scope.
2629
2630 On failure None is returned and an error is logged.
2631 """
2632 try:
2633 sUuid = oVM.id;
2634 except:
2635 reporter.errorXcpt('failed to get the UUID for VM "%s"' % (oVM,));
2636 return None;
2637
2638 # This loop is a kludge to deal with us racing the closing of the
2639 # direct session of a previous VM run. See waitOnDirectSessionClose.
2640 for i in range(10):
2641 try:
2642 if self.fpApiVer <= 3.2:
2643 oSession = self.oVBoxMgr.openMachineSession(sUuid);
2644 else:
2645 oSession = self.oVBoxMgr.openMachineSession(oVM);
2646 break;
2647 except:
2648 if i == 9:
2649 reporter.errorXcpt('failed to open session for "%s" ("%s")' % (sUuid, oVM));
2650 return None;
2651 if i > 0:
2652 reporter.logXcpt('warning: failed to open session for "%s" ("%s") - retrying in %u secs' % (sUuid, oVM, i));
2653 self.waitOnDirectSessionClose(oVM, 5000 + i * 1000);
2654 from testdriver.vboxwrappers import SessionWrapper;
2655 return SessionWrapper(oSession, oVM, self.oVBox, self.oVBoxMgr, self, False);
2656
2657 #
2658 # Guest locations.
2659 #
2660
2661 @staticmethod
2662 def getGuestTempDir(oTestVm):
2663 """
2664 Helper for finding a temporary directory in the test VM.
2665
2666 Note! It may be necessary to create it!
2667 """
2668 if oTestVm.isWindows():
2669 return "C:\\Temp";
2670 if oTestVm.isOS2():
2671 return "C:\\Temp";
2672 return '/var/tmp';
2673
2674 @staticmethod
2675 def getGuestSystemDir(oTestVm, sPathPrefix = ''):
2676 """
2677 Helper for finding a system directory in the test VM that we can play around with.
2678 sPathPrefix can be used to specify other directories, such as /usr/local/bin/ or /usr/bin, for instance.
2679
2680 On Windows this is always the System32 directory, so this function can be used as
2681 basis for locating other files in or under that directory.
2682 """
2683 if oTestVm.isWindows():
2684 return oTestVm.pathJoin(TestDriver.getGuestWinDir(oTestVm), 'System32');
2685 if oTestVm.isOS2():
2686 return 'C:\\OS2\\DLL';
2687
2688 # OL / RHEL symlinks "/bin"/ to "/usr/bin". To avoid (unexpectedly) following symlinks, use "/usr/bin" then instead.
2689 if not sPathPrefix \
2690 and oTestVm.sKind in ('Oracle_64', 'Oracle'): ## @todo Does this apply for "RedHat" as well?
2691 return "/usr/bin";
2692
2693 return sPathPrefix + "/bin";
2694
2695 @staticmethod
2696 def getGuestSystemAdminDir(oTestVm, sPathPrefix = ''):
2697 """
2698 Helper for finding a system admin directory ("sbin") in the test VM that we can play around with.
2699 sPathPrefix can be used to specify other directories, such as /usr/local/sbin/ or /usr/sbin, for instance.
2700
2701 On Windows this is always the System32 directory, so this function can be used as
2702 basis for locating other files in or under that directory.
2703 On UNIX-y systems this always is the "sh" shell to guarantee a common shell syntax.
2704 """
2705 if oTestVm.isWindows():
2706 return oTestVm.pathJoin(TestDriver.getGuestWinDir(oTestVm), 'System32');
2707 if oTestVm.isOS2():
2708 return 'C:\\OS2\\DLL'; ## @todo r=andy Not sure here.
2709
2710 # OL / RHEL symlinks "/sbin"/ to "/usr/sbin". To avoid (unexpectedly) following symlinks, use "/usr/sbin" then instead.
2711 if not sPathPrefix \
2712 and oTestVm.sKind in ('Oracle_64', 'Oracle'): ## @todo Does this apply for "RedHat" as well?
2713 return "/usr/sbin";
2714
2715 return sPathPrefix + "/sbin";
2716
2717 @staticmethod
2718 def getGuestWinDir(oTestVm):
2719 """
2720 Helper for finding the Windows directory in the test VM that we can play around with.
2721 ASSUMES that we always install Windows on drive C.
2722
2723 Returns the Windows directory, or an empty string when executed on a non-Windows guest (asserts).
2724 """
2725 sWinDir = '';
2726 if oTestVm.isWindows():
2727 if oTestVm.sKind in ['WindowsNT4', 'WindowsNT3x',]:
2728 sWinDir = 'C:\\WinNT\\';
2729 else:
2730 sWinDir = 'C:\\Windows\\';
2731 assert sWinDir != '', 'Retrieving Windows directory for non-Windows OS';
2732 return sWinDir;
2733
2734 @staticmethod
2735 def getGuestSystemShell(oTestVm):
2736 """
2737 Helper for finding the default system shell in the test VM.
2738 """
2739 if oTestVm.isWindows():
2740 return TestDriver.getGuestSystemDir(oTestVm) + '\\cmd.exe';
2741 if oTestVm.isOS2():
2742 return TestDriver.getGuestSystemDir(oTestVm) + '\\..\\CMD.EXE';
2743 return "/bin/sh";
2744
2745 @staticmethod
2746 def getGuestSystemFileForReading(oTestVm):
2747 """
2748 Helper for finding a file in the test VM that we can read.
2749 """
2750 if oTestVm.isWindows():
2751 return TestDriver.getGuestSystemDir(oTestVm) + '\\ntdll.dll';
2752 if oTestVm.isOS2():
2753 return TestDriver.getGuestSystemDir(oTestVm) + '\\DOSCALL1.DLL';
2754 return "/bin/sh";
2755
2756 def getVmByName(self, sName):
2757 """
2758 Get a test VM by name. Returns None if not found, logged.
2759 """
2760 # Look it up in our 'cache'.
2761 for oVM in self.aoVMs:
2762 try:
2763 #reporter.log2('cur: %s / %s (oVM=%s)' % (oVM.name, oVM.id, oVM));
2764 if oVM.name == sName:
2765 return oVM;
2766 except:
2767 reporter.errorXcpt('failed to get the name from the VM "%s"' % (oVM));
2768
2769 # Look it up the standard way.
2770 return self.addTestMachine(sName, fQuiet = True);
2771
2772 def getVmByUuid(self, sUuid):
2773 """
2774 Get a test VM by uuid. Returns None if not found, logged.
2775 """
2776 # Look it up in our 'cache'.
2777 for oVM in self.aoVMs:
2778 try:
2779 if oVM.id == sUuid:
2780 return oVM;
2781 except:
2782 reporter.errorXcpt('failed to get the UUID from the VM "%s"' % (oVM));
2783
2784 # Look it up the standard way.
2785 return self.addTestMachine(sUuid, fQuiet = True);
2786
2787 def waitOnProgress(self, oProgress, cMsTimeout = 1000000, fErrorOnTimeout = True, cMsInterval = 1000):
2788 """
2789 Waits for a progress object to complete. Returns the status code.
2790 """
2791 # Wait for progress no longer than cMsTimeout time period.
2792 tsStart = datetime.datetime.now()
2793 while True:
2794 self.processPendingEvents();
2795 try:
2796 if oProgress.completed:
2797 break;
2798 except:
2799 return -1;
2800 self.processPendingEvents();
2801
2802 tsNow = datetime.datetime.now()
2803 tsDelta = tsNow - tsStart
2804 if ((tsDelta.microseconds + tsDelta.seconds * 1000000) // 1000) > cMsTimeout:
2805 if fErrorOnTimeout:
2806 reporter.errorTimeout('Timeout while waiting for progress.')
2807 return -1
2808
2809 reporter.doPollWork('vbox.TestDriver.waitOnProgress');
2810 try: oProgress.waitForCompletion(cMsInterval);
2811 except: return -2;
2812
2813 try: rc = oProgress.resultCode;
2814 except: rc = -2;
2815 self.processPendingEvents();
2816 return rc;
2817
2818 def waitOnDirectSessionClose(self, oVM, cMsTimeout):
2819 """
2820 Waits for the VM process to close it's current direct session.
2821
2822 Returns None.
2823 """
2824 # Get the original values so we're not subject to
2825 try:
2826 eCurState = oVM.sessionState;
2827 if self.fpApiVer >= 5.0:
2828 sCurName = sOrgName = oVM.sessionName;
2829 else:
2830 sCurName = sOrgName = oVM.sessionType;
2831 if self.fpApiVer >= 4.2:
2832 iCurPid = iOrgPid = oVM.sessionPID;
2833 else:
2834 iCurPid = iOrgPid = oVM.sessionPid;
2835 except Exception as oXcpt:
2836 if ComError.notEqual(oXcpt, ComError.E_ACCESSDENIED):
2837 reporter.logXcpt();
2838 self.processPendingEvents();
2839 return None;
2840 self.processPendingEvents();
2841
2842 msStart = base.timestampMilli();
2843 while iCurPid == iOrgPid \
2844 and sCurName == sOrgName \
2845 and sCurName != '' \
2846 and base.timestampMilli() - msStart < cMsTimeout \
2847 and eCurState in (vboxcon.SessionState_Unlocking, vboxcon.SessionState_Spawning, vboxcon.SessionState_Locked,):
2848 self.processEvents(1000);
2849 try:
2850 eCurState = oVM.sessionState;
2851 sCurName = oVM.sessionName if self.fpApiVer >= 5.0 else oVM.sessionType;
2852 iCurPid = oVM.sessionPID if self.fpApiVer >= 4.2 else oVM.sessionPid;
2853 except Exception as oXcpt:
2854 if ComError.notEqual(oXcpt, ComError.E_ACCESSDENIED):
2855 reporter.logXcpt();
2856 break;
2857 self.processPendingEvents();
2858 self.processPendingEvents();
2859 return None;
2860
2861 def uploadStartupLogFile(self, oVM, sVmName):
2862 """
2863 Uploads the VBoxStartup.log when present.
2864 """
2865 fRc = True;
2866 try:
2867 sLogFile = os.path.join(oVM.logFolder, 'VBoxHardening.log');
2868 except:
2869 reporter.logXcpt();
2870 fRc = False;
2871 else:
2872 if os.path.isfile(sLogFile):
2873 reporter.addLogFile(sLogFile, 'log/release/vm', '%s hardening log' % (sVmName, ),
2874 sAltName = '%s-%s' % (sVmName, os.path.basename(sLogFile),));
2875 return fRc;
2876
2877 def annotateAndUploadProcessReport(self, sProcessReport, sFilename, sKind, sDesc):
2878 """
2879 Annotates the given VM process report and uploads it if successfull.
2880 """
2881 fRc = False;
2882 if self.oBuild is not None and self.oBuild.sInstallPath is not None:
2883 oResolver = btresolver.BacktraceResolver(self.sScratchPath, self.oBuild.sInstallPath,
2884 self.getBuildOs(), self.getBuildArch(),
2885 fnLog = reporter.log);
2886 fRcTmp = oResolver.prepareEnv();
2887 if fRcTmp:
2888 reporter.log('Successfully prepared environment');
2889 sReportDbgSym = oResolver.annotateReport(sProcessReport);
2890 if sReportDbgSym is not None:
2891 reporter.addLogString(sReportDbgSym, sFilename, sKind, sDesc);
2892 fRc = True;
2893 else:
2894 reporter.log('Annotating report failed');
2895 oResolver.cleanupEnv();
2896 return fRc;
2897
2898 def startVmEx(self, oVM, fWait = True, sType = None, sName = None, asEnv = None): # pylint: disable=too-many-locals,too-many-statements
2899 """
2900 Start the VM, returning the VM session and progress object on success.
2901 The session is also added to the task list and to the aoRemoteSessions set.
2902
2903 asEnv is a list of string on the putenv() form.
2904
2905 On failure (None, None) is returned and an error is logged.
2906 """
2907 # Massage and check the input.
2908 if sType is None:
2909 sType = self.sSessionType;
2910 if sName is None:
2911 try: sName = oVM.name;
2912 except: sName = 'bad-vm-handle';
2913 reporter.log('startVmEx: sName=%s fWait=%s sType=%s' % (sName, fWait, sType));
2914 if oVM is None:
2915 return (None, None);
2916
2917 ## @todo Do this elsewhere.
2918 # Hack alert. Disables all annoying GUI popups.
2919 if sType == 'gui' and not self.aoRemoteSessions:
2920 try:
2921 self.oVBox.setExtraData('GUI/Input/AutoCapture', 'false');
2922 if self.fpApiVer >= 3.2:
2923 self.oVBox.setExtraData('GUI/LicenseAgreed', '8');
2924 else:
2925 self.oVBox.setExtraData('GUI/LicenseAgreed', '7');
2926 self.oVBox.setExtraData('GUI/RegistrationData', 'triesLeft=0');
2927 self.oVBox.setExtraData('GUI/SUNOnlineData', 'triesLeft=0');
2928 self.oVBox.setExtraData('GUI/SuppressMessages', 'confirmVMReset,remindAboutMouseIntegrationOn,'
2929 'remindAboutMouseIntegrationOff,remindAboutPausedVMInput,confirmInputCapture,'
2930 'confirmGoingFullscreen,remindAboutInaccessibleMedia,remindAboutWrongColorDepth,'
2931 'confirmRemoveMedium,allPopupPanes,allMessageBoxes,all');
2932 self.oVBox.setExtraData('GUI/UpdateDate', 'never');
2933 self.oVBox.setExtraData('GUI/PreventBetaWarning', self.oVBox.version);
2934 except:
2935 reporter.logXcpt();
2936
2937 # The UUID for the name.
2938 try:
2939 sUuid = oVM.id;
2940 except:
2941 reporter.errorXcpt('failed to get the UUID for VM "%s"' % (oVM));
2942 return (None, None);
2943 self.processPendingEvents();
2944
2945 # Construct the environment.
2946 sLogFile = '%s/VM-%s.log' % (self.sScratchPath, sUuid);
2947 try: os.remove(sLogFile);
2948 except: pass;
2949 if self.sLogSessionDest:
2950 sLogDest = self.sLogSessionDest;
2951 else:
2952 sLogDest = 'file=%s' % (sLogFile,);
2953 asEnvFinal = [
2954 'VBOX_LOG=%s' % (self.sLogSessionGroups,),
2955 'VBOX_LOG_FLAGS=%s' % (self.sLogSessionFlags,),
2956 'VBOX_LOG_DEST=nodeny %s' % (sLogDest,),
2957 'VBOX_RELEASE_LOG_FLAGS=append time',
2958 ];
2959 if sType == 'gui':
2960 asEnvFinal.append('VBOX_GUI_DBG_ENABLED=1');
2961 if asEnv is not None and asEnv:
2962 asEnvFinal += asEnv;
2963
2964 # Shortcuts for local testing.
2965 oProgress = oWrapped = None;
2966 oTestVM = self.oTestVmSet.findTestVmByName(sName) if self.oTestVmSet is not None else None;
2967 try:
2968 if oTestVM is not None \
2969 and oTestVM.fSnapshotRestoreCurrent is True:
2970 if oVM.state is vboxcon.MachineState_Running:
2971 reporter.log2('Machine "%s" already running.' % (sName,));
2972 oProgress = None;
2973 oWrapped = self.openSession(oVM);
2974 else:
2975 reporter.log2('Checking if snapshot for machine "%s" exists.' % (sName,));
2976 oSessionWrapperRestore = self.openSession(oVM);
2977 if oSessionWrapperRestore is not None:
2978 oSnapshotCur = oVM.currentSnapshot;
2979 if oSnapshotCur is not None:
2980 reporter.log2('Restoring snapshot for machine "%s".' % (sName,));
2981 oSessionWrapperRestore.restoreSnapshot(oSnapshotCur);
2982 reporter.log2('Current snapshot for machine "%s" restored.' % (sName,));
2983 else:
2984 reporter.log('warning: no current snapshot for machine "%s" found.' % (sName,));
2985 oSessionWrapperRestore.close();
2986 except:
2987 reporter.errorXcpt();
2988 return (None, None);
2989
2990 # Open a remote session, wait for this operation to complete.
2991 # (The loop is a kludge to deal with us racing the closing of the
2992 # direct session of a previous VM run. See waitOnDirectSessionClose.)
2993 if oWrapped is None:
2994 for i in range(10):
2995 try:
2996 if self.fpApiVer < 4.3 \
2997 or (self.fpApiVer == 4.3 and not hasattr(self.oVBoxMgr, 'getSessionObject')):
2998 oSession = self.oVBoxMgr.mgr.getSessionObject(self.oVBox); # pylint: disable=no-member
2999 elif self.fpApiVer < 5.2 \
3000 or (self.fpApiVer == 5.2 and hasattr(self.oVBoxMgr, 'vbox')):
3001 oSession = self.oVBoxMgr.getSessionObject(self.oVBox); # pylint: disable=no-member
3002 else:
3003 oSession = self.oVBoxMgr.getSessionObject(); # pylint: disable=no-member,no-value-for-parameter
3004 if self.fpApiVer < 3.3:
3005 oProgress = self.oVBox.openRemoteSession(oSession, sUuid, sType, '\n'.join(asEnvFinal));
3006 else:
3007 if self.uApiRevision >= self.makeApiRevision(6, 1, 0, 1):
3008 oProgress = oVM.launchVMProcess(oSession, sType, asEnvFinal);
3009 else:
3010 oProgress = oVM.launchVMProcess(oSession, sType, '\n'.join(asEnvFinal));
3011 break;
3012 except:
3013 if i == 9:
3014 reporter.errorXcpt('failed to start VM "%s" ("%s"), aborting.' % (sUuid, sName));
3015 return (None, None);
3016 oSession = None;
3017 if i >= 0:
3018 reporter.logXcpt('warning: failed to start VM "%s" ("%s") - retrying in %u secs.' % (sUuid, oVM, i)); # pylint: disable=line-too-long
3019 self.waitOnDirectSessionClose(oVM, 5000 + i * 1000);
3020 if fWait and oProgress is not None:
3021 rc = self.waitOnProgress(oProgress);
3022 if rc < 0:
3023 self.waitOnDirectSessionClose(oVM, 5000);
3024
3025 # VM failed to power up, still collect VBox.log, need to wrap the session object
3026 # in order to use the helper for adding the log files to the report.
3027 from testdriver.vboxwrappers import SessionWrapper;
3028 oTmp = SessionWrapper(oSession, oVM, self.oVBox, self.oVBoxMgr, self, True, sName, sLogFile);
3029 oTmp.addLogsToReport();
3030
3031 # Try to collect a stack trace of the process for further investigation of any startup hangs.
3032 uPid = oTmp.getPid();
3033 if uPid is not None:
3034 sHostProcessInfoHung = utils.processGetInfo(uPid, fSudo = True);
3035 if sHostProcessInfoHung is not None:
3036 reporter.log('Trying to annotate the hung VM startup process report, please stand by...');
3037 fRcTmp = self.annotateAndUploadProcessReport(sHostProcessInfoHung, 'vmprocess-startup-hung.log',
3038 'process/report/vm', 'Annotated hung VM process state during startup'); # pylint: disable=line-too-long
3039 # Upload the raw log for manual annotation in case resolving failed.
3040 if not fRcTmp:
3041 reporter.log('Failed to annotate hung VM process report, uploading raw report');
3042 reporter.addLogString(sHostProcessInfoHung, 'vmprocess-startup-hung.log', 'process/report/vm',
3043 'Hung VM process state during startup');
3044
3045 try:
3046 if oSession is not None:
3047 oSession.close();
3048 except: pass;
3049 reportError(oProgress, 'failed to open session for "%s"' % (sName));
3050 self.uploadStartupLogFile(oVM, sName);
3051 return (None, None);
3052 reporter.log2('waitOnProgress -> %s' % (rc,));
3053
3054 # Wrap up the session object and push on to the list before returning it.
3055 if oWrapped is None:
3056 from testdriver.vboxwrappers import SessionWrapper;
3057 oWrapped = SessionWrapper(oSession, oVM, self.oVBox, self.oVBoxMgr, self, True, sName, sLogFile);
3058
3059 oWrapped.registerEventHandlerForTask();
3060 self.aoRemoteSessions.append(oWrapped);
3061 if oWrapped is not self.aoRemoteSessions[len(self.aoRemoteSessions) - 1]:
3062 reporter.error('not by reference: oWrapped=%s aoRemoteSessions[%s]=%s'
3063 % (oWrapped, len(self.aoRemoteSessions) - 1,
3064 self.aoRemoteSessions[len(self.aoRemoteSessions) - 1]));
3065 self.addTask(oWrapped);
3066
3067 reporter.log2('startVmEx: oSession=%s, oSessionWrapper=%s, oProgress=%s' % (oSession, oWrapped, oProgress));
3068
3069 if self.fpApiVer >= 7.0:
3070 # Needed to reach the host (localhost) from the guest. See xTracker #9896.
3071 # Note: Do this right *after* the VM has been started.
3072 for iSlot in range(0, self.oVBox.systemProperties.getMaxNetworkAdapters(oVM.chipsetType)):
3073 try:
3074 oNic = oVM.getNetworkAdapter(iSlot);
3075 if not oNic.enabled:
3076 continue;
3077 sAdpName = self.getNetworkAdapterNameFromType(oNic);
3078 if oNic.attachmentType == vboxcon.NetworkAttachmentType_NAT:
3079 reporter.log2('Enabling "LocalhostReachable" (NAT) for network adapter "%s" in slot %d' % \
3080 (sAdpName, iSlot));
3081 oNatEngine = oNic.NATEngine;
3082 oNatEngine.LocalhostReachable = True;
3083 else:
3084 # Other attachments will fail if 'LocalhostReachable' extra data override is present
3085 ## @todo r=andy Is this still needed, as we now have the API (see above) in place?
3086 sKey = 'VBoxInternal/Devices/%s/%d/LUN#0/Config/LocalhostReachable' % (sAdpName, iSlot);
3087 reporter.log2('Disabling "LocalhostReachable" (NAT) for network adapter "%s" in slot %d (key: %s)' % \
3088 (sAdpName, iSlot, sKey));
3089 self.oVBox.setExtraData(sKey, '');
3090 except:
3091 reporter.logXcpt();
3092
3093 from testdriver.vboxwrappers import ProgressWrapper;
3094 return (oWrapped, ProgressWrapper(oProgress, self.oVBoxMgr, self,
3095 'starting %s' % (sName,)) if oProgress else None);
3096
3097 def startVm(self, oVM, sType=None, sName = None, asEnv = None):
3098 """ Simplified version of startVmEx. """
3099 oSession, _ = self.startVmEx(oVM, True, sType, sName, asEnv = asEnv);
3100 return oSession;
3101
3102 def startVmByNameEx(self, sName, fWait=True, sType=None, asEnv = None):
3103 """
3104 Start the VM, returning the VM session and progress object on success.
3105 The session is also added to the task list and to the aoRemoteSessions set.
3106
3107 On failure (None, None) is returned and an error is logged.
3108 """
3109 oVM = self.getVmByName(sName);
3110 if oVM is None:
3111 return (None, None);
3112 return self.startVmEx(oVM, fWait, sType, sName, asEnv = asEnv);
3113
3114 def startVmByName(self, sName, sType=None, asEnv = None):
3115 """
3116 Start the VM, returning the VM session on success. The session is
3117 also added to the task list and to the aoRemoteSessions set.
3118
3119 On failure None is returned and an error is logged.
3120 """
3121 oSession, _ = self.startVmByNameEx(sName, True, sType, asEnv = asEnv);
3122 return oSession;
3123
3124 def terminateVmBySession(self, oSession, oProgress = None, fTakeScreenshot = None): # pylint: disable=too-many-statements
3125 """
3126 Terminates the VM specified by oSession and adds the release logs to
3127 the test report.
3128
3129 This will try achieve this by using powerOff, but will resort to
3130 tougher methods if that fails.
3131
3132 The session will always be removed from the task list.
3133 The session will be closed unless we fail to kill the process.
3134 The session will be removed from the remote session list if closed.
3135
3136 The progress object (a wrapper!) is for teleportation and similar VM
3137 operations, it will be attempted canceled before powering off the VM.
3138 Failures are logged but ignored.
3139 The progress object will always be removed from the task list.
3140
3141 Returns True if powerOff and session close both succeed.
3142 Returns False if on failure (logged), including when we successfully
3143 kill the VM process.
3144 """
3145 reporter.log2('terminateVmBySession: oSession=%s (pid=%s) oProgress=%s' % (oSession.sName, oSession.getPid(), oProgress));
3146
3147 # Call getPid first to make sure the PID is cached in the wrapper.
3148 oSession.getPid();
3149
3150 #
3151 # If the host is out of memory, just skip all the info collection as it
3152 # requires memory too and seems to wedge.
3153 #
3154 sHostProcessInfo = None;
3155 sHostProcessInfoHung = None;
3156 sLastScreenshotPath = None;
3157 sOsKernelLog = None;
3158 sVgaText = None;
3159 asMiscInfos = [];
3160
3161 if not oSession.fHostMemoryLow:
3162 # Try to fetch the VM process info before meddling with its state.
3163 if self.fAlwaysUploadLogs or reporter.testErrorCount() > 0:
3164 sHostProcessInfo = utils.processGetInfo(oSession.getPid(), fSudo = True);
3165
3166 #
3167 # Pause the VM if we're going to take any screenshots or dig into the
3168 # guest. Failures are quitely ignored.
3169 #
3170 if self.fAlwaysUploadLogs or reporter.testErrorCount() > 0:
3171 try:
3172 if oSession.oVM.state in [ vboxcon.MachineState_Running,
3173 vboxcon.MachineState_LiveSnapshotting,
3174 vboxcon.MachineState_Teleporting ]:
3175 oSession.o.console.pause();
3176 except:
3177 reporter.logXcpt();
3178
3179 #
3180 # Take Screenshot and upload it (see below) to Test Manager if appropriate/requested.
3181 #
3182 if fTakeScreenshot is True or self.fAlwaysUploadScreenshots or reporter.testErrorCount() > 0:
3183 sLastScreenshotPath = os.path.join(self.sScratchPath, "LastScreenshot-%s.png" % oSession.sName);
3184 fRc = oSession.takeScreenshot(sLastScreenshotPath);
3185 if fRc is not True:
3186 sLastScreenshotPath = None;
3187
3188 # Query the OS kernel log from the debugger if appropriate/requested.
3189 if self.fAlwaysUploadLogs or reporter.testErrorCount() > 0:
3190 sOsKernelLog = oSession.queryOsKernelLog();
3191
3192 # Do "info vgatext all" separately.
3193 if self.fAlwaysUploadLogs or reporter.testErrorCount() > 0:
3194 sVgaText = oSession.queryDbgInfoVgaText();
3195
3196 # Various infos (do after kernel because of symbols).
3197 if self.fAlwaysUploadLogs or reporter.testErrorCount() > 0:
3198 # Dump the guest stack for all CPUs.
3199 cCpus = oSession.getCpuCount();
3200 if cCpus > 0:
3201 for iCpu in xrange(0, cCpus):
3202 sThis = oSession.queryDbgGuestStack(iCpu);
3203 if sThis:
3204 asMiscInfos += [
3205 '================ start guest stack VCPU %s ================\n' % (iCpu,),
3206 sThis,
3207 '================ end guest stack VCPU %s ==================\n' % (iCpu,),
3208 ];
3209
3210 for sInfo, sArg in [ ('mode', 'all'),
3211 ('fflags', ''),
3212 ('cpumguest', 'verbose all'),
3213 ('cpumguestinstr', 'symbol all'),
3214 ('exits', ''),
3215 ('pic', ''),
3216 ('apic', ''),
3217 ('apiclvt', ''),
3218 ('apictimer', ''),
3219 ('ioapic', ''),
3220 ('pit', ''),
3221 ('phys', ''),
3222 ('clocks', ''),
3223 ('timers', ''),
3224 ('gdt', ''),
3225 ('ldt', ''),
3226 ]:
3227 if sInfo in ['apic',] and self.fpApiVer < 5.1: # asserts and burns
3228 continue;
3229 sThis = oSession.queryDbgInfo(sInfo, sArg);
3230 if sThis:
3231 if sThis[-1] != '\n':
3232 sThis += '\n';
3233 asMiscInfos += [
3234 '================ start %s %s ================\n' % (sInfo, sArg),
3235 sThis,
3236 '================ end %s %s ==================\n' % (sInfo, sArg),
3237 ];
3238
3239 #
3240 # Terminate the VM
3241 #
3242
3243 # Cancel the progress object if specified.
3244 if oProgress is not None:
3245 if not oProgress.isCompleted() and oProgress.isCancelable():
3246 reporter.log2('terminateVmBySession: canceling "%s"...' % (oProgress.sName));
3247 try:
3248 oProgress.o.cancel();
3249 except:
3250 reporter.logXcpt();
3251 else:
3252 oProgress.wait();
3253 self.removeTask(oProgress);
3254
3255 # Check if the VM has terminated by itself before powering it off.
3256 fClose = True;
3257 fRc = True;
3258 if oSession.needsPoweringOff():
3259 reporter.log('terminateVmBySession: powering off "%s"...' % (oSession.sName,));
3260 fRc = oSession.powerOff(fFudgeOnFailure = False);
3261 if fRc is not True:
3262 # power off failed, try terminate it in a nice manner.
3263 fRc = False;
3264 uPid = oSession.getPid();
3265 if uPid is not None:
3266 #
3267 # Collect some information about the VM process first to have
3268 # some state information for further investigation why powering off failed.
3269 #
3270 sHostProcessInfoHung = utils.processGetInfo(uPid, fSudo = True);
3271
3272 # Exterminate...
3273 reporter.error('terminateVmBySession: Terminating PID %u (VM %s)' % (uPid, oSession.sName));
3274 fClose = base.processTerminate(uPid);
3275 if fClose is True:
3276 self.waitOnDirectSessionClose(oSession.oVM, 5000);
3277 fClose = oSession.waitForTask(1000);
3278
3279 if fClose is not True:
3280 # Being nice failed...
3281 reporter.error('terminateVmBySession: Termination failed, trying to kill PID %u (VM %s) instead' \
3282 % (uPid, oSession.sName));
3283 fClose = base.processKill(uPid);
3284 if fClose is True:
3285 self.waitOnDirectSessionClose(oSession.oVM, 5000);
3286 fClose = oSession.waitForTask(1000);
3287 if fClose is not True:
3288 reporter.error('terminateVmBySession: Failed to kill PID %u (VM %s)' % (uPid, oSession.sName));
3289
3290 # The final steps.
3291 if fClose is True:
3292 reporter.log('terminateVmBySession: closing session "%s"...' % (oSession.sName,));
3293 oSession.close();
3294 self.waitOnDirectSessionClose(oSession.oVM, 10000);
3295 try:
3296 eState = oSession.oVM.state;
3297 except:
3298 reporter.logXcpt();
3299 else:
3300 if eState == vboxcon.MachineState_Aborted:
3301 reporter.error('terminateVmBySession: The VM "%s" aborted!' % (oSession.sName,));
3302 self.removeTask(oSession);
3303
3304 #
3305 # Add the release log, debug log and a screenshot of the VM to the test report.
3306 #
3307 if self.fAlwaysUploadLogs or reporter.testErrorCount() > 0:
3308 oSession.addLogsToReport();
3309
3310 # Add a screenshot if it has been requested and taken successfully.
3311 if sLastScreenshotPath is not None:
3312 if reporter.testErrorCount() > 0:
3313 reporter.addLogFile(sLastScreenshotPath, 'screenshot/failure', 'Last VM screenshot');
3314 else:
3315 reporter.addLogFile(sLastScreenshotPath, 'screenshot/success', 'Last VM screenshot');
3316
3317 # Add the guest OS log if it has been requested and taken successfully.
3318 if sOsKernelLog is not None:
3319 reporter.addLogString(sOsKernelLog, 'kernel.log', 'log/guest/kernel', 'Guest OS kernel log');
3320
3321 # Add "info vgatext all" if we've got it.
3322 if sVgaText is not None:
3323 reporter.addLogString(sVgaText, 'vgatext.txt', 'info/vgatext', 'info vgatext all');
3324
3325 # Add the "info xxxx" items if we've got any.
3326 if asMiscInfos:
3327 reporter.addLogString(u''.join(asMiscInfos), 'info.txt', 'info/collection', 'A bunch of info items.');
3328
3329 # Add the host process info if we were able to retrieve it.
3330 if sHostProcessInfo is not None:
3331 reporter.log('Trying to annotate the VM process report, please stand by...');
3332 fRcTmp = self.annotateAndUploadProcessReport(sHostProcessInfo, 'vmprocess.log',
3333 'process/report/vm', 'Annotated VM process state');
3334 # Upload the raw log for manual annotation in case resolving failed.
3335 if not fRcTmp:
3336 reporter.log('Failed to annotate VM process report, uploading raw report');
3337 reporter.addLogString(sHostProcessInfo, 'vmprocess.log', 'process/report/vm', 'VM process state');
3338
3339 # Add the host process info for failed power off attempts if we were able to retrieve it.
3340 if sHostProcessInfoHung is not None:
3341 reporter.log('Trying to annotate the hung VM process report, please stand by...');
3342 fRcTmp = self.annotateAndUploadProcessReport(sHostProcessInfoHung, 'vmprocess-hung.log',
3343 'process/report/vm', 'Annotated hung VM process state');
3344 # Upload the raw log for manual annotation in case resolving failed.
3345 if not fRcTmp:
3346 reporter.log('Failed to annotate hung VM process report, uploading raw report');
3347 fRcTmp = reporter.addLogString(sHostProcessInfoHung, 'vmprocess-hung.log', 'process/report/vm',
3348 'Hung VM process state');
3349 if not fRcTmp:
3350 try: reporter.log('******* START vmprocess-hung.log *******\n%s\n******* END vmprocess-hung.log *******\n'
3351 % (sHostProcessInfoHung,));
3352 except: pass; # paranoia
3353
3354
3355 return fRc;
3356
3357
3358 #
3359 # Some information query functions (mix).
3360 #
3361 # Methods require the VBox API. If the information is provided by both
3362 # the testboxscript as well as VBox API, we'll check if it matches.
3363 #
3364
3365 def _hasHostCpuFeature(self, sEnvVar, sEnum, fpApiMinVer, fQuiet):
3366 """
3367 Common Worker for hasHostNestedPaging() and hasHostHwVirt().
3368
3369 Returns True / False.
3370 Raises exception on environment / host mismatch.
3371 """
3372 fEnv = os.environ.get(sEnvVar, None);
3373 if fEnv is not None:
3374 fEnv = fEnv.lower() not in [ 'false', 'f', 'not', 'no', 'n', '0', ];
3375
3376 fVBox = None;
3377 self.importVBoxApi();
3378 if self.fpApiVer >= fpApiMinVer and hasattr(vboxcon, sEnum):
3379 try:
3380 fVBox = self.oVBox.host.getProcessorFeature(getattr(vboxcon, sEnum));
3381 except:
3382 if not fQuiet:
3383 reporter.logXcpt();
3384
3385 if fVBox is not None:
3386 if fEnv is not None:
3387 if fEnv != fVBox and not fQuiet:
3388 reporter.log('TestBox configuration overwritten: fVBox=%s (%s) vs. fEnv=%s (%s)'
3389 % (fVBox, sEnum, fEnv, sEnvVar));
3390 return fEnv;
3391 return fVBox;
3392 if fEnv is not None:
3393 return fEnv;
3394 return False;
3395
3396 def hasHostHwVirt(self, fQuiet = False):
3397 """
3398 Checks if hardware assisted virtualization is supported by the host.
3399
3400 Returns True / False.
3401 Raises exception on environment / host mismatch.
3402 """
3403 return self._hasHostCpuFeature('TESTBOX_HAS_HW_VIRT', 'ProcessorFeature_HWVirtEx', 3.1, fQuiet);
3404
3405 def hasHostNestedPaging(self, fQuiet = False):
3406 """
3407 Checks if nested paging is supported by the host.
3408
3409 Returns True / False.
3410 Raises exception on environment / host mismatch.
3411 """
3412 return self._hasHostCpuFeature('TESTBOX_HAS_NESTED_PAGING', 'ProcessorFeature_NestedPaging', 4.2, fQuiet) \
3413 and self.hasHostHwVirt(fQuiet);
3414
3415 def hasHostNestedHwVirt(self, fQuiet = False):
3416 """
3417 Checks if nested hardware-assisted virtualization is supported by the host.
3418
3419 Returns True / False.
3420 Raises exception on environment / host mismatch.
3421 """
3422 return self._hasHostCpuFeature('TESTBOX_HAS_NESTED_HWVIRT', 'ProcessorFeature_NestedHWVirt', 6.0, fQuiet) \
3423 and self.hasHostHwVirt(fQuiet);
3424
3425 def hasHostLongMode(self, fQuiet = False):
3426 """
3427 Checks if the host supports 64-bit guests.
3428
3429 Returns True / False.
3430 Raises exception on environment / host mismatch.
3431 """
3432 # Note that the testboxscript doesn't export this variable atm.
3433 return self._hasHostCpuFeature('TESTBOX_HAS_LONG_MODE', 'ProcessorFeature_LongMode', 3.1, fQuiet);
3434
3435 def getHostCpuCount(self, fQuiet = False):
3436 """
3437 Returns the number of CPUs on the host.
3438
3439 Returns True / False.
3440 Raises exception on environment / host mismatch.
3441 """
3442 cEnv = os.environ.get('TESTBOX_CPU_COUNT', None);
3443 if cEnv is not None:
3444 cEnv = int(cEnv);
3445
3446 try:
3447 cVBox = self.oVBox.host.processorOnlineCount;
3448 except:
3449 if not fQuiet:
3450 reporter.logXcpt();
3451 cVBox = None;
3452
3453 if cVBox is not None:
3454 if cEnv is not None:
3455 assert cVBox == cEnv, 'Misconfigured TestBox: VBox: %u CPUs, testboxscript: %u CPUs' % (cVBox, cEnv);
3456 return cVBox;
3457 if cEnv is not None:
3458 return cEnv;
3459 return 1;
3460
3461 def _getHostCpuDesc(self, fQuiet = False):
3462 """
3463 Internal method used for getting the host CPU description from VBoxSVC.
3464 Returns description string, on failure an empty string is returned.
3465 """
3466 try:
3467 return self.oVBox.host.getProcessorDescription(0);
3468 except:
3469 if not fQuiet:
3470 reporter.logXcpt();
3471 return '';
3472
3473 def isHostCpuAmd(self, fQuiet = False):
3474 """
3475 Checks if the host CPU vendor is AMD.
3476
3477 Returns True / False.
3478 """
3479 sCpuDesc = self._getHostCpuDesc(fQuiet);
3480 return 'AMD' in sCpuDesc or sCpuDesc == 'AuthenticAMD';
3481
3482 def isHostCpuIntel(self, fQuiet = False):
3483 """
3484 Checks if the host CPU vendor is Intel.
3485
3486 Returns True / False.
3487 """
3488 sCpuDesc = self._getHostCpuDesc(fQuiet);
3489 return sCpuDesc.startswith("Intel") or sCpuDesc == 'GenuineIntel';
3490
3491 def isHostCpuVia(self, fQuiet = False):
3492 """
3493 Checks if the host CPU vendor is VIA (or Centaur).
3494
3495 Returns True / False.
3496 """
3497 sCpuDesc = self._getHostCpuDesc(fQuiet);
3498 return sCpuDesc.startswith("VIA") or sCpuDesc == 'CentaurHauls';
3499
3500 def isHostCpuShanghai(self, fQuiet = False):
3501 """
3502 Checks if the host CPU vendor is Shanghai (or Zhaoxin).
3503
3504 Returns True / False.
3505 """
3506 sCpuDesc = self._getHostCpuDesc(fQuiet);
3507 return sCpuDesc.startswith("ZHAOXIN") or sCpuDesc.strip(' ') == 'Shanghai';
3508
3509 def isHostCpuP4(self, fQuiet = False):
3510 """
3511 Checks if the host CPU is a Pentium 4 / Pentium D.
3512
3513 Returns True / False.
3514 """
3515 if not self.isHostCpuIntel(fQuiet):
3516 return False;
3517
3518 (uFamilyModel, _, _, _) = self.oVBox.host.getProcessorCPUIDLeaf(0, 0x1, 0);
3519 return ((uFamilyModel >> 8) & 0xf) == 0xf;
3520
3521 def hasRawModeSupport(self, fQuiet = False):
3522 """
3523 Checks if raw-mode is supported by VirtualBox that the testbox is
3524 configured for it.
3525
3526 Returns True / False.
3527 Raises no exceptions.
3528
3529 Note! Differs from the rest in that we don't require the
3530 TESTBOX_WITH_RAW_MODE value to match the API. It is
3531 sometimes helpful to disable raw-mode on individual
3532 test boxes. (This probably goes for
3533 """
3534 # The environment variable can be used to disable raw-mode.
3535 fEnv = os.environ.get('TESTBOX_WITH_RAW_MODE', None);
3536 if fEnv is not None:
3537 fEnv = fEnv.lower() not in [ 'false', 'f', 'not', 'no', 'n', '0', ];
3538 if fEnv is False:
3539 return False;
3540
3541 # Starting with 5.0 GA / RC2 the API can tell us whether VBox was built
3542 # with raw-mode support or not.
3543 self.importVBoxApi();
3544 if self.fpApiVer >= 5.0:
3545 try:
3546 fVBox = self.oVBox.systemProperties.rawModeSupported;
3547 except:
3548 if not fQuiet:
3549 reporter.logXcpt();
3550 fVBox = True;
3551 if fVBox is False:
3552 return False;
3553
3554 return True;
3555
3556 #
3557 # Testdriver execution methods.
3558 #
3559
3560 def handleTask(self, oTask, sMethod):
3561 """
3562 Callback method for handling unknown tasks in the various run loops.
3563
3564 The testdriver should override this if it already tasks running when
3565 calling startVmAndConnectToTxsViaTcp, txsRunTest or similar methods.
3566 Call super to handle unknown tasks.
3567
3568 Returns True if handled, False if not.
3569 """
3570 reporter.error('%s: unknown task %s' % (sMethod, oTask));
3571 return False;
3572
3573 def txsDoTask(self, oSession, oTxsSession, fnAsync, aArgs):
3574 """
3575 Generic TXS task wrapper which waits both on the TXS and the session tasks.
3576
3577 Returns False on error, logged.
3578 Returns task result on success.
3579 """
3580 # All async methods ends with the following two args.
3581 cMsTimeout = aArgs[-2];
3582 fIgnoreErrors = aArgs[-1];
3583
3584 fRemoveVm = self.addTask(oSession);
3585 fRemoveTxs = self.addTask(oTxsSession);
3586
3587 rc = fnAsync(*aArgs); # pylint: disable=star-args
3588 if rc is True:
3589 rc = False;
3590 oTask = self.waitForTasks(cMsTimeout + 1);
3591 if oTask is oTxsSession:
3592 if oTxsSession.isSuccess():
3593 rc = oTxsSession.getResult();
3594 elif fIgnoreErrors is True:
3595 reporter.log( 'txsDoTask: task failed (%s)' % (oTxsSession.getLastReply()[1],));
3596 else:
3597 reporter.error('txsDoTask: task failed (%s)' % (oTxsSession.getLastReply()[1],));
3598 else:
3599 oTxsSession.cancelTask();
3600 if oTask is None:
3601 if fIgnoreErrors is True:
3602 reporter.log( 'txsDoTask: The task timed out.');
3603 else:
3604 reporter.errorTimeout('txsDoTask: The task timed out.');
3605 elif oTask is oSession:
3606 reporter.error('txsDoTask: The VM terminated unexpectedly');
3607 else:
3608 if fIgnoreErrors is True:
3609 reporter.log( 'txsDoTask: An unknown task %s was returned' % (oTask,));
3610 else:
3611 reporter.error('txsDoTask: An unknown task %s was returned' % (oTask,));
3612 else:
3613 reporter.error('txsDoTask: fnAsync returned %s' % (rc,));
3614
3615 if fRemoveTxs:
3616 self.removeTask(oTxsSession);
3617 if fRemoveVm:
3618 self.removeTask(oSession);
3619 return rc;
3620
3621 # pylint: disable=missing-docstring
3622
3623 def txsDisconnect(self, oSession, oTxsSession, cMsTimeout = 30000, fIgnoreErrors = False):
3624 return self.txsDoTask(oSession, oTxsSession, oTxsSession.asyncDisconnect,
3625 (self.adjustTimeoutMs(cMsTimeout), fIgnoreErrors));
3626
3627 def txsVer(self, oSession, oTxsSession, cMsTimeout = 30000, fIgnoreErrors = False):
3628 return self.txsDoTask(oSession, oTxsSession, oTxsSession.asyncVer,
3629 (self.adjustTimeoutMs(cMsTimeout), fIgnoreErrors));
3630
3631 def txsUuid(self, oSession, oTxsSession, cMsTimeout = 30000, fIgnoreErrors = False):
3632 return self.txsDoTask(oSession, oTxsSession, oTxsSession.asyncUuid,
3633 (self.adjustTimeoutMs(cMsTimeout), fIgnoreErrors));
3634
3635 def txsMkDir(self, oSession, oTxsSession, sRemoteDir, fMode = 0o700, cMsTimeout = 30000, fIgnoreErrors = False):
3636 return self.txsDoTask(oSession, oTxsSession, oTxsSession.asyncMkDir,
3637 (sRemoteDir, fMode, self.adjustTimeoutMs(cMsTimeout), fIgnoreErrors));
3638
3639 def txsMkDirPath(self, oSession, oTxsSession, sRemoteDir, fMode = 0o700, cMsTimeout = 30000, fIgnoreErrors = False):
3640 return self.txsDoTask(oSession, oTxsSession, oTxsSession.asyncMkDirPath,
3641 (sRemoteDir, fMode, self.adjustTimeoutMs(cMsTimeout), fIgnoreErrors));
3642
3643 def txsMkSymlink(self, oSession, oTxsSession, sLinkTarget, sLink, cMsTimeout = 30000, fIgnoreErrors = False):
3644 return self.txsDoTask(oSession, oTxsSession, oTxsSession.asyncMkSymlink,
3645 (sLinkTarget, sLink, self.adjustTimeoutMs(cMsTimeout), fIgnoreErrors));
3646
3647 def txsRmDir(self, oSession, oTxsSession, sRemoteDir, cMsTimeout = 30000, fIgnoreErrors = False):
3648 return self.txsDoTask(oSession, oTxsSession, oTxsSession.asyncRmDir,
3649 (sRemoteDir, self.adjustTimeoutMs(cMsTimeout), fIgnoreErrors));
3650
3651 def txsRmFile(self, oSession, oTxsSession, sRemoteFile, cMsTimeout = 30000, fIgnoreErrors = False):
3652 return self.txsDoTask(oSession, oTxsSession, oTxsSession.asyncRmFile,
3653 (sRemoteFile, self.adjustTimeoutMs(cMsTimeout), fIgnoreErrors));
3654
3655 def txsRmSymlink(self, oSession, oTxsSession, sRemoteSymlink, cMsTimeout = 30000, fIgnoreErrors = False):
3656 return self.txsDoTask(oSession, oTxsSession, oTxsSession.asyncRmSymlink,
3657 (sRemoteSymlink, self.adjustTimeoutMs(cMsTimeout), fIgnoreErrors));
3658
3659 def txsRmTree(self, oSession, oTxsSession, sRemoteTree, cMsTimeout = 30000, fIgnoreErrors = False):
3660 return self.txsDoTask(oSession, oTxsSession, oTxsSession.asyncRmTree,
3661 (sRemoteTree, self.adjustTimeoutMs(cMsTimeout), fIgnoreErrors));
3662
3663 def txsIsDir(self, oSession, oTxsSession, sRemoteDir, cMsTimeout = 30000, fIgnoreErrors = False):
3664 return self.txsDoTask(oSession, oTxsSession, oTxsSession.asyncIsDir,
3665 (sRemoteDir, self.adjustTimeoutMs(cMsTimeout), fIgnoreErrors));
3666
3667 def txsIsFile(self, oSession, oTxsSession, sRemoteFile, cMsTimeout = 30000, fIgnoreErrors = False):
3668 return self.txsDoTask(oSession, oTxsSession, oTxsSession.asyncIsFile,
3669 (sRemoteFile, self.adjustTimeoutMs(cMsTimeout), fIgnoreErrors));
3670
3671 def txsIsSymlink(self, oSession, oTxsSession, sRemoteSymlink, cMsTimeout = 30000, fIgnoreErrors = False):
3672 return self.txsDoTask(oSession, oTxsSession, oTxsSession.asyncIsSymlink,
3673 (sRemoteSymlink, self.adjustTimeoutMs(cMsTimeout), fIgnoreErrors));
3674
3675 def txsUploadFile(self, oSession, oTxsSession, sLocalFile, sRemoteFile, cMsTimeout = 30000, fIgnoreErrors = False):
3676 return self.txsDoTask(oSession, oTxsSession, oTxsSession.asyncUploadFile, \
3677 (sLocalFile, sRemoteFile, self.adjustTimeoutMs(cMsTimeout), fIgnoreErrors));
3678
3679 def txsUploadString(self, oSession, oTxsSession, sContent, sRemoteFile, cMsTimeout = 30000, fIgnoreErrors = False):
3680 return self.txsDoTask(oSession, oTxsSession, oTxsSession.asyncUploadString, \
3681 (sContent, sRemoteFile, self.adjustTimeoutMs(cMsTimeout), fIgnoreErrors));
3682
3683 def txsDownloadFile(self, oSession, oTxsSession, sRemoteFile, sLocalFile, cMsTimeout = 30000, fIgnoreErrors = False):
3684 return self.txsDoTask(oSession, oTxsSession, oTxsSession.asyncDownloadFile, \
3685 (sRemoteFile, sLocalFile, self.adjustTimeoutMs(cMsTimeout), fIgnoreErrors));
3686
3687 def txsDownloadFiles(self, oSession, oTxsSession, aasFiles, fAddToLog = True, fIgnoreErrors = False):
3688 """
3689 Convenience function to get files from the guest, storing them in the
3690 scratch and adding them to the test result set (optional, but default).
3691
3692 The aasFiles parameter contains an array of with guest-path + host-path
3693 pairs, optionally a file 'kind', description and an alternative upload
3694 filename can also be specified.
3695
3696 Host paths are relative to the scratch directory or they must be given
3697 in absolute form. The guest path should be using guest path style.
3698
3699 Returns True on success.
3700 Returns False on failure (unless fIgnoreErrors is set), logged.
3701 """
3702 for asEntry in aasFiles:
3703 # Unpack:
3704 sGstFile = asEntry[0];
3705 sHstFile = asEntry[1];
3706 sKind = asEntry[2] if len(asEntry) > 2 and asEntry[2] else 'misc/other';
3707 sDescription = asEntry[3] if len(asEntry) > 3 and asEntry[3] else '';
3708 sAltName = asEntry[4] if len(asEntry) > 4 and asEntry[4] else None;
3709 assert len(asEntry) <= 5 and sGstFile and sHstFile;
3710 if not os.path.isabs(sHstFile):
3711 sHstFile = os.path.join(self.sScratchPath, sHstFile);
3712
3713 reporter.log2('Downloading file "%s" to "%s" ...' % (sGstFile, sHstFile,));
3714
3715 try: os.unlink(sHstFile); ## @todo txsDownloadFile doesn't truncate the output file.
3716 except: pass;
3717
3718 fRc = self.txsDownloadFile(oSession, oTxsSession, sGstFile, sHstFile, 30 * 1000, fIgnoreErrors);
3719 if fRc:
3720 if fAddToLog:
3721 reporter.addLogFile(sHstFile, sKind, sDescription, sAltName);
3722 else:
3723 if fIgnoreErrors is not True:
3724 return reporter.error('error downloading file "%s" to "%s"' % (sGstFile, sHstFile));
3725 reporter.log('warning: file "%s" was not downloaded, ignoring.' % (sGstFile,));
3726 return True;
3727
3728 def txsDownloadString(self, oSession, oTxsSession, sRemoteFile, sEncoding = 'utf-8', fIgnoreEncodingErrors = True,
3729 cMsTimeout = 30000, fIgnoreErrors = False):
3730 return self.txsDoTask(oSession, oTxsSession, oTxsSession.asyncDownloadString,
3731 (sRemoteFile, sEncoding, fIgnoreEncodingErrors, self.adjustTimeoutMs(cMsTimeout), fIgnoreErrors));
3732
3733 def txsPackFile(self, oSession, oTxsSession, sRemoteFile, sRemoteSource, cMsTimeout = 30000, fIgnoreErrors = False):
3734 return self.txsDoTask(oSession, oTxsSession, oTxsSession.asyncPackFile, \
3735 (sRemoteFile, sRemoteSource, self.adjustTimeoutMs(cMsTimeout), fIgnoreErrors));
3736
3737 def txsUnpackFile(self, oSession, oTxsSession, sRemoteFile, sRemoteDir, cMsTimeout = 30000, fIgnoreErrors = False):
3738 return self.txsDoTask(oSession, oTxsSession, oTxsSession.asyncUnpackFile, \
3739 (sRemoteFile, sRemoteDir, self.adjustTimeoutMs(cMsTimeout), fIgnoreErrors));
3740
3741 # pylint: enable=missing-docstring
3742
3743 def txsCdWait(self,
3744 oSession, # type: vboxwrappers.SessionWrapper
3745 oTxsSession, # type: txsclient.Session
3746 cMsTimeout = 30000, # type: int
3747 sFile = None # type: String
3748 ): # -> bool
3749 """
3750 Mostly an internal helper for txsRebootAndReconnectViaTcp and
3751 startVmAndConnectToTxsViaTcp that waits for the CDROM drive to become
3752 ready. It does this by polling for a file it knows to exist on the CD.
3753
3754 Returns True on success.
3755
3756 Returns False on failure, logged.
3757 """
3758
3759 if sFile is None:
3760 sFile = 'valkit.txt';
3761
3762 reporter.log('txsCdWait: Waiting for file "%s" to become available ...' % (sFile,));
3763
3764 fRemoveVm = self.addTask(oSession);
3765 fRemoveTxs = self.addTask(oTxsSession);
3766 cMsTimeout = self.adjustTimeoutMs(cMsTimeout);
3767 msStart = base.timestampMilli();
3768 cMsTimeout2 = cMsTimeout;
3769 fRc = oTxsSession.asyncIsFile('${CDROM}/%s' % (sFile,), cMsTimeout2);
3770 if fRc is True:
3771 while True:
3772 # wait for it to complete.
3773 oTask = self.waitForTasks(cMsTimeout2 + 1);
3774 if oTask is not oTxsSession:
3775 oTxsSession.cancelTask();
3776 if oTask is None:
3777 reporter.errorTimeout('txsCdWait: The task timed out (after %s ms).'
3778 % (base.timestampMilli() - msStart,));
3779 elif oTask is oSession:
3780 reporter.error('txsCdWait: The VM terminated unexpectedly');
3781 else:
3782 reporter.error('txsCdWait: An unknown task %s was returned' % (oTask,));
3783 fRc = False;
3784 break;
3785 if oTxsSession.isSuccess():
3786 break;
3787
3788 # Check for timeout.
3789 cMsElapsed = base.timestampMilli() - msStart;
3790 if cMsElapsed >= cMsTimeout:
3791 reporter.error('txsCdWait: timed out');
3792 fRc = False;
3793 break;
3794 # delay.
3795 self.sleep(1);
3796
3797 # resubmit the task.
3798 cMsTimeout2 = msStart + cMsTimeout - base.timestampMilli();
3799 if cMsTimeout2 < 500:
3800 cMsTimeout2 = 500;
3801 fRc = oTxsSession.asyncIsFile('${CDROM}/%s' % (sFile,), cMsTimeout2);
3802 if fRc is not True:
3803 reporter.error('txsCdWait: asyncIsFile failed');
3804 break;
3805 else:
3806 reporter.error('txsCdWait: asyncIsFile failed');
3807
3808 if not fRc:
3809 # Do some diagnosis to find out why this failed.
3810 ## @todo Identify guest OS type and only run one of the following commands.
3811 fIsNotWindows = True;
3812 reporter.log('txsCdWait: Listing root contents of ${CDROM}:');
3813 if fIsNotWindows:
3814 reporter.log('txsCdWait: Tiggering udevadm ...');
3815 oTxsSession.syncExec("/sbin/udevadm", ("/sbin/udevadm", "trigger", "--verbose"), fIgnoreErrors = True);
3816 time.sleep(15);
3817 oTxsSession.syncExec("/bin/ls", ("/bin/ls", "-al", "${CDROM}"), fIgnoreErrors = True);
3818 reporter.log('txsCdWait: Listing media directory:');
3819 oTxsSession.syncExec('/bin/ls', ('/bin/ls', '-l', '-a', '-R', '/media'), fIgnoreErrors = True);
3820 reporter.log('txsCdWait: Listing mount points / drives:');
3821 oTxsSession.syncExec('/bin/mount', ('/bin/mount',), fIgnoreErrors = True);
3822 oTxsSession.syncExec('/bin/cat', ('/bin/cat', '/etc/fstab'), fIgnoreErrors = True);
3823 oTxsSession.syncExec('/bin/dmesg', ('/bin/dmesg',), fIgnoreErrors = True);
3824 oTxsSession.syncExec('/usr/bin/lshw', ('/usr/bin/lshw', '-c', 'disk'), fIgnoreErrors = True);
3825 oTxsSession.syncExec('/bin/journalctl',
3826 ('/bin/journalctl', '-x', '-b'), fIgnoreErrors = True);
3827 oTxsSession.syncExec('/bin/journalctl',
3828 ('/bin/journalctl', '-x', '-b', '/usr/lib/udisks2/udisksd'), fIgnoreErrors = True);
3829 oTxsSession.syncExec('/usr/bin/udisksctl',
3830 ('/usr/bin/udisksctl', 'info', '-b', '/dev/sr0'), fIgnoreErrors = True);
3831 oTxsSession.syncExec('/bin/systemctl',
3832 ('/bin/systemctl', 'status', 'udisks2'), fIgnoreErrors = True);
3833 oTxsSession.syncExec('/bin/ps',
3834 ('/bin/ps', '-a', '-u', '-x'), fIgnoreErrors = True);
3835 reporter.log('txsCdWait: Mounting manually ...');
3836 for _ in range(3):
3837 oTxsSession.syncExec('/bin/mount', ('/bin/mount', '/dev/sr0', '${CDROM}'), fIgnoreErrors = True);
3838 time.sleep(5);
3839 reporter.log('txsCdWait: Re-Listing media directory:');
3840 oTxsSession.syncExec('/bin/ls', ('/bin/ls', '-l', '-a', '-R', '/media'), fIgnoreErrors = True);
3841 else:
3842 # ASSUMES that we always install Windows on drive C right now.
3843 sWinDir = "C:\\Windows\\System32\\";
3844 # Should work since WinXP Pro.
3845 oTxsSession.syncExec(sWinDir + "wbem\\WMIC.exe",
3846 ("WMIC.exe", "logicaldisk", "get",
3847 "deviceid, volumename, description"),
3848 fIgnoreErrors = True);
3849 oTxsSession.syncExec(sWinDir + " cmd.exe",
3850 ('cmd.exe', '/C', 'dir', '${CDROM}'),
3851 fIgnoreErrors = True);
3852
3853 if fRemoveTxs:
3854 self.removeTask(oTxsSession);
3855 if fRemoveVm:
3856 self.removeTask(oSession);
3857 return fRc;
3858
3859 def txsDoConnectViaTcp(self, oSession, cMsTimeout, fNatForwardingForTxs = False):
3860 """
3861 Mostly an internal worker for connecting to TXS via TCP used by the
3862 *ViaTcp methods.
3863
3864 Returns a tuplet with True/False and TxsSession/None depending on the
3865 result. Errors are logged.
3866 """
3867
3868 reporter.log2('txsDoConnectViaTcp: oSession=%s, cMsTimeout=%s, fNatForwardingForTxs=%s'
3869 % (oSession, cMsTimeout, fNatForwardingForTxs));
3870
3871 cMsTimeout = self.adjustTimeoutMs(cMsTimeout);
3872 oTxsConnect = oSession.txsConnectViaTcp(cMsTimeout, fNatForwardingForTxs = fNatForwardingForTxs);
3873 if oTxsConnect is not None:
3874 self.addTask(oTxsConnect);
3875 fRemoveVm = self.addTask(oSession);
3876 oTask = self.waitForTasks(cMsTimeout + 1);
3877 reporter.log2('txsDoConnectViaTcp: waitForTasks returned %s' % (oTask,));
3878 self.removeTask(oTxsConnect);
3879 if oTask is oTxsConnect:
3880 oTxsSession = oTxsConnect.getResult();
3881 if oTxsSession is not None:
3882 reporter.log('txsDoConnectViaTcp: Connected to TXS on %s.' % (oTxsSession.oTransport.sHostname,));
3883 return (True, oTxsSession);
3884
3885 reporter.error('txsDoConnectViaTcp: failed to connect to TXS.');
3886 else:
3887 oTxsConnect.cancelTask();
3888 if oTask is None:
3889 reporter.errorTimeout('txsDoConnectViaTcp: connect stage 1 timed out');
3890 elif oTask is oSession:
3891 oSession.reportPrematureTermination('txsDoConnectViaTcp: ');
3892 else:
3893 reporter.error('txsDoConnectViaTcp: unknown/wrong task %s' % (oTask,));
3894 if fRemoveVm:
3895 self.removeTask(oSession);
3896 else:
3897 reporter.error('txsDoConnectViaTcp: txsConnectViaTcp failed');
3898 return (False, None);
3899
3900 def startVmAndConnectToTxsViaTcp(self, sVmName, fCdWait = False, cMsTimeout = 15*60000, \
3901 cMsCdWait = 30000, sFileCdWait = None, \
3902 fNatForwardingForTxs = False):
3903 """
3904 Starts the specified VM and tries to connect to its TXS via TCP.
3905 The VM will be powered off if TXS doesn't respond before the specified
3906 time has elapsed.
3907
3908 Returns a the VM and TXS sessions (a two tuple) on success. The VM
3909 session is in the task list, the TXS session is not.
3910 Returns (None, None) on failure, fully logged.
3911 """
3912
3913 # Zap the guest IP to make sure we're not getting a stale entry
3914 # (unless we're restoring the VM of course).
3915 oTestVM = self.oTestVmSet.findTestVmByName(sVmName) if self.oTestVmSet is not None else None;
3916 if oTestVM is None \
3917 or oTestVM.fSnapshotRestoreCurrent is False:
3918 try:
3919 oSession1 = self.openSession(self.getVmByName(sVmName));
3920 oSession1.delGuestPropertyValue('/VirtualBox/GuestInfo/Net/0/V4/IP');
3921 oSession1.saveSettings(True);
3922 del oSession1;
3923 except:
3924 reporter.logXcpt();
3925
3926 # Start the VM.
3927 reporter.log('startVmAndConnectToTxsViaTcp: Starting(/preparing) "%s" (timeout %s s)...' % (sVmName, cMsTimeout / 1000));
3928 reporter.flushall();
3929 oSession = self.startVmByName(sVmName);
3930 if oSession is not None:
3931 # Connect to TXS.
3932 reporter.log2('startVmAndConnectToTxsViaTcp: Started(/prepared) "%s", connecting to TXS ...' % (sVmName,));
3933 (fRc, oTxsSession) = self.txsDoConnectViaTcp(oSession, cMsTimeout, fNatForwardingForTxs);
3934 if fRc is True:
3935 if fCdWait:
3936 # Wait for CD?
3937 reporter.log2('startVmAndConnectToTxsViaTcp: Waiting for file "%s" to become available ...' % (sFileCdWait,));
3938 fRc = self.txsCdWait(oSession, oTxsSession, cMsCdWait, sFileCdWait);
3939 if fRc is not True:
3940 reporter.error('startVmAndConnectToTxsViaTcp: txsCdWait failed');
3941
3942 sVer = self.txsVer(oSession, oTxsSession, cMsTimeout, fIgnoreErrors = True);
3943 if sVer is not False:
3944 reporter.log('startVmAndConnectToTxsViaTcp: TestExecService version %s' % (sVer,));
3945 else:
3946 reporter.log('startVmAndConnectToTxsViaTcp: Unable to retrieve TestExecService version');
3947
3948 if fRc is True:
3949 # Success!
3950 return (oSession, oTxsSession);
3951 else:
3952 reporter.error('startVmAndConnectToTxsViaTcp: txsDoConnectViaTcp failed');
3953 # If something went wrong while waiting for TXS to be started - take VM screenshot before terminate it
3954 self.terminateVmBySession(oSession);
3955 return (None, None);
3956
3957 def txsRebootAndReconnectViaTcp(self, oSession, oTxsSession, fCdWait = False, cMsTimeout = 15*60000, \
3958 cMsCdWait = 30000, sFileCdWait = None, fNatForwardingForTxs = False):
3959 """
3960 Executes the TXS reboot command
3961
3962 Returns A tuple of True and the new TXS session on success.
3963
3964 Returns A tuple of False and either the old TXS session or None on failure.
3965 """
3966 reporter.log2('txsRebootAndReconnect: cMsTimeout=%u' % (cMsTimeout,));
3967
3968 #
3969 # This stuff is a bit complicated because of rebooting being kind of
3970 # disruptive to the TXS and such... The protocol is that TXS will:
3971 # - ACK the reboot command.
3972 # - Shutdown the transport layer, implicitly disconnecting us.
3973 # - Execute the reboot operation.
3974 # - On failure, it will be re-init the transport layer and be
3975 # available pretty much immediately. UUID unchanged.
3976 # - On success, it will be respawed after the reboot (hopefully),
3977 # with a different UUID.
3978 #
3979 fRc = False;
3980 iStart = base.timestampMilli();
3981
3982 # Get UUID.
3983 cMsTimeout2 = min(60000, cMsTimeout);
3984 sUuidBefore = self.txsUuid(oSession, oTxsSession, self.adjustTimeoutMs(cMsTimeout2, 60000));
3985 if sUuidBefore is not False:
3986 # Reboot.
3987 cMsElapsed = base.timestampMilli() - iStart;
3988 cMsTimeout2 = cMsTimeout - cMsElapsed;
3989 fRc = self.txsDoTask(oSession, oTxsSession, oTxsSession.asyncReboot,
3990 (self.adjustTimeoutMs(cMsTimeout2, 60000), False));
3991 if fRc is True:
3992 # Reconnect.
3993 if fNatForwardingForTxs is True:
3994 self.sleep(22); # NAT fudge - Two fixes are wanted: 1. TXS connect retries. 2. Main API reboot/reset hint.
3995 cMsElapsed = base.timestampMilli() - iStart;
3996 (fRc, oTxsSession) = self.txsDoConnectViaTcp(oSession, cMsTimeout - cMsElapsed, fNatForwardingForTxs);
3997 if fRc is True:
3998 # Check the UUID.
3999 cMsElapsed = base.timestampMilli() - iStart;
4000 cMsTimeout2 = min(60000, cMsTimeout - cMsElapsed);
4001 sUuidAfter = self.txsDoTask(oSession, oTxsSession, oTxsSession.asyncUuid,
4002 (self.adjustTimeoutMs(cMsTimeout2, 60000), False));
4003 if sUuidBefore is not False:
4004 if sUuidAfter != sUuidBefore:
4005 reporter.log('The guest rebooted (UUID %s -> %s)' % (sUuidBefore, sUuidAfter))
4006
4007 # Do CD wait if specified.
4008 if fCdWait:
4009 fRc = self.txsCdWait(oSession, oTxsSession, cMsCdWait, sFileCdWait);
4010 if fRc is not True:
4011 reporter.error('txsRebootAndReconnectViaTcp: txsCdWait failed');
4012
4013 sVer = self.txsVer(oSession, oTxsSession, cMsTimeout, fIgnoreErrors = True);
4014 if sVer is not False:
4015 reporter.log('txsRebootAndReconnectViaTcp: TestExecService version %s' % (sVer,));
4016 else:
4017 reporter.log('txsRebootAndReconnectViaTcp: Unable to retrieve TestExecService version');
4018 else:
4019 reporter.error('txsRebootAndReconnectViaTcp: failed to get UUID (after)');
4020 else:
4021 reporter.error('txsRebootAndReconnectViaTcp: did not reboot (UUID %s)' % (sUuidBefore,));
4022 else:
4023 reporter.error('txsRebootAndReconnectViaTcp: txsDoConnectViaTcp failed');
4024 else:
4025 reporter.error('txsRebootAndReconnectViaTcp: reboot failed');
4026 else:
4027 reporter.error('txsRebootAndReconnectViaTcp: failed to get UUID (before)');
4028 return (fRc, oTxsSession);
4029
4030 # pylint: disable=too-many-locals,too-many-arguments
4031
4032 def txsRunTest(self, oTxsSession, sTestName, cMsTimeout, sExecName, asArgs = (), asAddEnv = (), sAsUser = "",
4033 fCheckSessionStatus = False):
4034 """
4035 Executes the specified test task, waiting till it completes or times out.
4036
4037 The VM session (if any) must be in the task list.
4038
4039 Returns True if we executed the task and nothing abnormal happend.
4040 Query the process status from the TXS session.
4041
4042 Returns False if some unexpected task was signalled or we failed to
4043 submit the job.
4044
4045 If fCheckSessionStatus is set to True, the overall session status will be
4046 taken into account and logged as an error on failure.
4047 """
4048 reporter.testStart(sTestName);
4049 reporter.log2('txsRunTest: cMsTimeout=%u sExecName=%s asArgs=%s' % (cMsTimeout, sExecName, asArgs));
4050
4051 # Submit the job.
4052 fRc = False;
4053 if oTxsSession.asyncExec(sExecName, asArgs, asAddEnv, sAsUser, cMsTimeout = self.adjustTimeoutMs(cMsTimeout)):
4054 self.addTask(oTxsSession);
4055
4056 # Wait for the job to complete.
4057 while True:
4058 oTask = self.waitForTasks(cMsTimeout + 1);
4059 if oTask is None:
4060 if fCheckSessionStatus:
4061 reporter.error('txsRunTest: waitForTasks for test "%s" timed out' % (sTestName,));
4062 else:
4063 reporter.log('txsRunTest: waitForTasks for test "%s" timed out' % (sTestName,));
4064 break;
4065 if oTask is oTxsSession:
4066 if fCheckSessionStatus \
4067 and not oTxsSession.isSuccess():
4068 reporter.error('txsRunTest: Test "%s" failed' % (sTestName,));
4069 else:
4070 fRc = True;
4071 reporter.log('txsRunTest: isSuccess=%s getResult=%s' \
4072 % (oTxsSession.isSuccess(), oTxsSession.getResult()));
4073 break;
4074 if not self.handleTask(oTask, 'txsRunTest'):
4075 break;
4076
4077 self.removeTask(oTxsSession);
4078 if not oTxsSession.pollTask():
4079 oTxsSession.cancelTask();
4080 else:
4081 reporter.error('txsRunTest: asyncExec failed');
4082
4083 reporter.testDone();
4084 return fRc;
4085
4086 def txsRunTestRedirectStd(self, oTxsSession, sTestName, cMsTimeout, sExecName, asArgs = (), asAddEnv = (), sAsUser = "",
4087 oStdIn = '/dev/null', oStdOut = '/dev/null', oStdErr = '/dev/null', oTestPipe = '/dev/null'):
4088 """
4089 Executes the specified test task, waiting till it completes or times out,
4090 redirecting stdin, stdout and stderr to the given objects.
4091
4092 The VM session (if any) must be in the task list.
4093
4094 Returns True if we executed the task and nothing abnormal happend.
4095 Query the process status from the TXS session.
4096
4097 Returns False if some unexpected task was signalled or we failed to
4098 submit the job.
4099 """
4100 reporter.testStart(sTestName);
4101 reporter.log2('txsRunTestRedirectStd: cMsTimeout=%u sExecName=%s asArgs=%s' % (cMsTimeout, sExecName, asArgs));
4102
4103 # Submit the job.
4104 fRc = False;
4105 if oTxsSession.asyncExecEx(sExecName, asArgs, asAddEnv, oStdIn, oStdOut, oStdErr,
4106 oTestPipe, sAsUser, cMsTimeout = self.adjustTimeoutMs(cMsTimeout)):
4107 self.addTask(oTxsSession);
4108
4109 # Wait for the job to complete.
4110 while True:
4111 oTask = self.waitForTasks(cMsTimeout + 1);
4112 if oTask is None:
4113 reporter.log('txsRunTestRedirectStd: waitForTasks timed out');
4114 break;
4115 if oTask is oTxsSession:
4116 fRc = True;
4117 reporter.log('txsRunTestRedirectStd: isSuccess=%s getResult=%s'
4118 % (oTxsSession.isSuccess(), oTxsSession.getResult()));
4119 break;
4120 if not self.handleTask(oTask, 'txsRunTestRedirectStd'):
4121 break;
4122
4123 self.removeTask(oTxsSession);
4124 if not oTxsSession.pollTask():
4125 oTxsSession.cancelTask();
4126 else:
4127 reporter.error('txsRunTestRedirectStd: asyncExec failed');
4128
4129 reporter.testDone();
4130 return fRc;
4131
4132 def txsRunTest2(self, oTxsSession1, oTxsSession2, sTestName, cMsTimeout,
4133 sExecName1, asArgs1,
4134 sExecName2, asArgs2,
4135 asAddEnv1 = (), sAsUser1 = '', fWithTestPipe1 = True,
4136 asAddEnv2 = (), sAsUser2 = '', fWithTestPipe2 = True):
4137 """
4138 Executes the specified test tasks, waiting till they complete or
4139 times out. The 1st task is started after the 2nd one.
4140
4141 The VM session (if any) must be in the task list.
4142
4143 Returns True if we executed the task and nothing abnormal happend.
4144 Query the process status from the TXS sessions.
4145
4146 Returns False if some unexpected task was signalled or we failed to
4147 submit the job.
4148 """
4149 reporter.testStart(sTestName);
4150
4151 # Submit the jobs.
4152 fRc = False;
4153 if oTxsSession1.asyncExec(sExecName1, asArgs1, asAddEnv1, sAsUser1, fWithTestPipe1, '1-',
4154 self.adjustTimeoutMs(cMsTimeout)):
4155 self.addTask(oTxsSession1);
4156
4157 self.sleep(2); # fudge! grr
4158
4159 if oTxsSession2.asyncExec(sExecName2, asArgs2, asAddEnv2, sAsUser2, fWithTestPipe2, '2-',
4160 self.adjustTimeoutMs(cMsTimeout)):
4161 self.addTask(oTxsSession2);
4162
4163 # Wait for the jobs to complete.
4164 cPendingJobs = 2;
4165 while True:
4166 oTask = self.waitForTasks(cMsTimeout + 1);
4167 if oTask is None:
4168 reporter.log('txsRunTest2: waitForTasks timed out');
4169 break;
4170
4171 if oTask is oTxsSession1 or oTask is oTxsSession2:
4172 if oTask is oTxsSession1: iTask = 1;
4173 else: iTask = 2;
4174 reporter.log('txsRunTest2: #%u - isSuccess=%s getResult=%s' \
4175 % (iTask, oTask.isSuccess(), oTask.getResult()));
4176 self.removeTask(oTask);
4177 cPendingJobs -= 1;
4178 if cPendingJobs <= 0:
4179 fRc = True;
4180 break;
4181
4182 elif not self.handleTask(oTask, 'txsRunTest'):
4183 break;
4184
4185 self.removeTask(oTxsSession2);
4186 if not oTxsSession2.pollTask():
4187 oTxsSession2.cancelTask();
4188 else:
4189 reporter.error('txsRunTest2: asyncExec #2 failed');
4190
4191 self.removeTask(oTxsSession1);
4192 if not oTxsSession1.pollTask():
4193 oTxsSession1.cancelTask();
4194 else:
4195 reporter.error('txsRunTest2: asyncExec #1 failed');
4196
4197 reporter.testDone();
4198 return fRc;
4199
4200 # pylint: enable=too-many-locals,too-many-arguments
4201
4202
4203 #
4204 # Working with test results via serial port.
4205 #
4206
4207 class TxsMonitorComFile(base.TdTaskBase):
4208 """
4209 Class that monitors a COM output file.
4210 """
4211
4212 def __init__(self, sComRawFile, asStopWords = None):
4213 base.TdTaskBase.__init__(self, utils.getCallerName());
4214 self.sComRawFile = sComRawFile;
4215 self.oStopRegExp = re.compile('\\b(' + '|'.join(asStopWords if asStopWords else ('PASSED', 'FAILED',)) + ')\\b');
4216 self.sResult = None; ##< The result.
4217 self.cchDisplayed = 0; ##< Offset into the file string of what we've already fed to the logger.
4218
4219 def toString(self):
4220 return '<%s sComRawFile=%s oStopRegExp=%s sResult=%s cchDisplayed=%s>' \
4221 % (base.TdTaskBase.toString(self), self.sComRawFile, self.oStopRegExp, self.sResult, self.cchDisplayed,);
4222
4223 def pollTask(self, fLocked = False):
4224 """
4225 Overrides TdTaskBase.pollTask() for the purpose of polling the file.
4226 """
4227 if not fLocked:
4228 self.lockTask();
4229
4230 sFile = utils.noxcptReadFile(self.sComRawFile, '', 'rU');
4231 if len(sFile) > self.cchDisplayed:
4232 sNew = sFile[self.cchDisplayed:];
4233 oMatch = self.oStopRegExp.search(sNew);
4234 if oMatch:
4235 # Done! Get result, flush all the output and signal the task.
4236 self.sResult = oMatch.group(1);
4237 for sLine in sNew.split('\n'):
4238 reporter.log('COM OUTPUT: %s' % (sLine,));
4239 self.cchDisplayed = len(sFile);
4240 self.signalTaskLocked();
4241 else:
4242 # Output whole lines only.
4243 offNewline = sFile.find('\n', self.cchDisplayed);
4244 while offNewline >= 0:
4245 reporter.log('COM OUTPUT: %s' % (sFile[self.cchDisplayed:offNewline]))
4246 self.cchDisplayed = offNewline + 1;
4247 offNewline = sFile.find('\n', self.cchDisplayed);
4248
4249 fRet = self.fSignalled;
4250 if not fLocked:
4251 self.unlockTask();
4252 return fRet;
4253
4254 # Our stuff.
4255 def getResult(self):
4256 """
4257 Returns the connected TXS session object on success.
4258 Returns None on failure or if the task has not yet completed.
4259 """
4260 self.oCv.acquire();
4261 sResult = self.sResult;
4262 self.oCv.release();
4263 return sResult;
4264
4265 def cancelTask(self):
4266 """ Cancels the task. """
4267 self.signalTask();
4268 return True;
4269
4270
4271 def monitorComRawFile(self, oSession, sComRawFile, cMsTimeout = 15*60000, asStopWords = None):
4272 """
4273 Monitors the COM output file for stop words (PASSED and FAILED by default).
4274
4275 Returns the stop word.
4276 Returns None on VM error and timeout.
4277 """
4278
4279 reporter.log2('monitorComRawFile: oSession=%s, cMsTimeout=%s, sComRawFile=%s' % (oSession, cMsTimeout, sComRawFile));
4280
4281 oMonitorTask = self.TxsMonitorComFile(sComRawFile, asStopWords);
4282 self.addTask(oMonitorTask);
4283
4284 cMsTimeout = self.adjustTimeoutMs(cMsTimeout);
4285 oTask = self.waitForTasks(cMsTimeout + 1);
4286 reporter.log2('monitorComRawFile: waitForTasks returned %s' % (oTask,));
4287
4288 if oTask is not oMonitorTask:
4289 oMonitorTask.cancelTask();
4290 self.removeTask(oMonitorTask);
4291
4292 oMonitorTask.pollTask();
4293 return oMonitorTask.getResult();
4294
4295
4296 def runVmAndMonitorComRawFile(self, sVmName, sComRawFile, cMsTimeout = 15*60000, asStopWords = None):
4297 """
4298 Runs the specified VM and monitors the given COM output file for stop
4299 words (PASSED and FAILED by default).
4300
4301 The caller is assumed to have configured the VM to use the given
4302 file. The method will take no action to verify this.
4303
4304 Returns the stop word.
4305 Returns None on VM error and timeout.
4306 """
4307
4308 # Start the VM.
4309 reporter.log('runVmAndMonitorComRawFile: Starting(/preparing) "%s" (timeout %s s)...' % (sVmName, cMsTimeout / 1000));
4310 reporter.flushall();
4311 oSession = self.startVmByName(sVmName);
4312 if oSession is not None:
4313 # Let it run and then terminate it.
4314 sRet = self.monitorComRawFile(oSession, sComRawFile, cMsTimeout, asStopWords);
4315 self.terminateVmBySession(oSession);
4316 else:
4317 sRet = None;
4318 return sRet;
4319
4320 #
4321 # Other stuff
4322 #
4323
4324 def waitForGAs(self,
4325 oSession, # type: vboxwrappers.SessionWrapper
4326 cMsTimeout = 120000, aenmWaitForRunLevels = None, aenmWaitForActive = None, aenmWaitForInactive = None):
4327 """
4328 Waits for the guest additions to enter a certain state.
4329
4330 aenmWaitForRunLevels - List of run level values to wait for (success if one matches).
4331 aenmWaitForActive - List facilities (type values) that must be active.
4332 aenmWaitForInactive - List facilities (type values) that must be inactive.
4333
4334 Defaults to wait for AdditionsRunLevelType_Userland if nothing else is given.
4335
4336 Returns True on success, False w/ error logging on timeout or failure.
4337 """
4338 reporter.log2('waitForGAs: oSession=%s, cMsTimeout=%s' % (oSession, cMsTimeout,));
4339
4340 #
4341 # Get IGuest:
4342 #
4343 try:
4344 oIGuest = oSession.o.console.guest;
4345 except:
4346 return reporter.errorXcpt();
4347
4348 #
4349 # Create a wait task:
4350 #
4351 from testdriver.vboxwrappers import AdditionsStatusTask;
4352 try:
4353 oGaStatusTask = AdditionsStatusTask(oSession = oSession,
4354 oIGuest = oIGuest,
4355 cMsTimeout = cMsTimeout,
4356 aenmWaitForRunLevels = aenmWaitForRunLevels,
4357 aenmWaitForActive = aenmWaitForActive,
4358 aenmWaitForInactive = aenmWaitForInactive);
4359 except:
4360 return reporter.errorXcpt();
4361
4362 #
4363 # Add the task and make sure the VM session is also present.
4364 #
4365 self.addTask(oGaStatusTask);
4366 fRemoveSession = self.addTask(oSession);
4367 oTask = self.waitForTasks(cMsTimeout + 1);
4368 reporter.log2('waitForGAs: returned %s (oGaStatusTask=%s, oSession=%s)' % (oTask, oGaStatusTask, oSession,));
4369 self.removeTask(oGaStatusTask);
4370 if fRemoveSession:
4371 self.removeTask(oSession);
4372
4373 #
4374 # Digest the result.
4375 #
4376 if oTask is oGaStatusTask:
4377 fSucceeded = oGaStatusTask.getResult();
4378 if fSucceeded is True:
4379 reporter.log('waitForGAs: Succeeded.');
4380 else:
4381 reporter.error('waitForGAs: Failed.');
4382 else:
4383 oGaStatusTask.cancelTask();
4384 if oTask is None:
4385 reporter.error('waitForGAs: Timed out.');
4386 elif oTask is oSession:
4387 oSession.reportPrematureTermination('waitForGAs: ');
4388 else:
4389 reporter.error('waitForGAs: unknown/wrong task %s' % (oTask,));
4390 fSucceeded = False;
4391 return fSucceeded;
4392
4393 @staticmethod
4394 def controllerTypeToName(eControllerType):
4395 """
4396 Translate a controller type to a standard controller name.
4397 """
4398 if eControllerType in (vboxcon.StorageControllerType_PIIX3, vboxcon.StorageControllerType_PIIX4,):
4399 sName = "IDE Controller";
4400 elif eControllerType == vboxcon.StorageControllerType_IntelAhci:
4401 sName = "SATA Controller";
4402 elif eControllerType == vboxcon.StorageControllerType_LsiLogicSas:
4403 sName = "SAS Controller";
4404 elif eControllerType in (vboxcon.StorageControllerType_LsiLogic, vboxcon.StorageControllerType_BusLogic,):
4405 sName = "SCSI Controller";
4406 elif eControllerType == vboxcon.StorageControllerType_NVMe:
4407 sName = "NVMe Controller";
4408 elif eControllerType == vboxcon.StorageControllerType_VirtioSCSI:
4409 sName = "VirtIO SCSI Controller";
4410 else:
4411 sName = "Storage Controller";
4412 return sName;
Note: See TracBrowser for help on using the repository browser.

© 2024 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette