vbox.py@ 64226

Last change on this file since 64226 was 64190, checked in by vboxsync, 8 years ago
comment typo
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 148.8 KB

Line
1	# -- coding: utf-8 --
2	# $Id: vbox.py 64190 2016-10-10 17:32:38Z vboxsync $
3	# pylint: disable=C0302
4
5	"""
6	VirtualBox Specific base testdriver.
7	"""
8
9	__copyright__ = \
10	"""
11	Copyright (C) 2010-2016 Oracle Corporation
12
13	This file is part of VirtualBox Open Source Edition (OSE), as
14	available from http://www.virtualbox.org. This file is free software;
15	you can redistribute it and/or modify it under the terms of the GNU
16	General Public License (GPL) as published by the Free Software
17	Foundation, in version 2 as it comes in the "COPYING" file of the
18	VirtualBox OSE distribution. VirtualBox OSE is distributed in the
19	hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
20
21	The contents of this file may alternatively be used under the terms
22	of the Common Development and Distribution License Version 1.0
23	(CDDL) only, as it comes in the "COPYING.CDDL" file of the
24	VirtualBox OSE distribution, in which case the provisions of the
25	CDDL are applicable instead of those of the GPL.
26
27	You may elect to license modified versions of this file under the
28	terms and conditions of either the GPL or the CDDL or both.
29	"""
30	__version__ = "$Revision: 64190 $"
31
32
33	# Standard Python imports.
34	import os
35	import platform
36	import sys
37	import threading
38	import time
39	import traceback
40	import datetime
41
42	# Figure out where the validation kit lives and make sure it's in the path.
43	try: __file__
44	except: __file__ = sys.argv[0];
45	g_ksValidationKitDir = os.path.dirname(os.path.dirname(os.path.abspath(__file__)));
46	if g_ksValidationKitDir not in sys.path:
47	sys.path.append(g_ksValidationKitDir);
48
49	# Validation Kit imports.
50	from common import utils;
51	from testdriver import base;
52	from testdriver import reporter;
53	from testdriver import vboxcon;
54	from testdriver import vboxtestvms;
55
56
57	#
58	# Exception and Error Unification Hacks.
59	# Note! This is pretty gross stuff. Be warned!
60	# TODO: Find better ways of doing these things, preferrably in vboxapi.
61	#
62
63	ComException = None; # pylint: disable=C0103
64	__fnComExceptionGetAttr__ = None; # pylint: disable=C0103
65
66	def __MyDefaultGetAttr(oSelf, sName):
67	""" __getattribute__/__getattr__ default fake."""
68	try:
69	oAttr = oSelf.__dict__[sName];
70	except:
71	oAttr = dir(oSelf)[sName];
72	return oAttr;
73
74	def __MyComExceptionGetAttr(oSelf, sName):
75	""" ComException.__getattr__ wrapper - both XPCOM and COM. """
76	try:
77	oAttr = __fnComExceptionGetAttr__(oSelf, sName);
78	except AttributeError:
79	if platform.system() == 'Windows':
80	if sName == 'errno':
81	oAttr = __fnComExceptionGetAttr__(oSelf, 'hresult');
82	elif sName == 'msg':
83	oAttr = __fnComExceptionGetAttr__(oSelf, 'strerror');
84	else:
85	raise;
86	else:
87	if sName == 'hresult':
88	oAttr = __fnComExceptionGetAttr__(oSelf, 'errno');
89	elif sName == 'strerror':
90	oAttr = __fnComExceptionGetAttr__(oSelf, 'msg');
91	elif sName == 'excepinfo':
92	oAttr = None;
93	elif sName == 'argerror':
94	oAttr = None;
95	else:
96	raise;
97	#print '__MyComExceptionGetAttr(,%s) -> "%s"' % (sName, oAttr);
98	return oAttr;
99
100	def __deployExceptionHacks__(oNativeComExceptionClass):
101	"""
102	Deploys the exception and error hacks that helps unifying COM and XPCOM
103	exceptions and errors.
104	"""
105	global ComException # pylint: disable=C0103
106	global __fnComExceptionGetAttr__ # pylint: disable=C0103
107
108	# Hook up our attribute getter for the exception class (ASSUMES new-style).
109	if __fnComExceptionGetAttr__ is None:
110	try:
111	__fnComExceptionGetAttr__ = getattr(oNativeComExceptionClass, '__getattr__');
112	except:
113	try:
114	__fnComExceptionGetAttr__ = getattr(oNativeComExceptionClass, '__getattribute__');
115	except:
116	__fnComExceptionGetAttr__ = __MyDefaultGetAttr;
117	setattr(oNativeComExceptionClass, '__getattr__', __MyComExceptionGetAttr)
118
119	# Make the modified classes accessible (are there better ways to do this?)
120	ComException = oNativeComExceptionClass
121	return None;
122
123
124
125	#
126	# Utility functions.
127	#
128
129	def isIpAddrValid(sIpAddr):
130	"""
131	Checks if a IPv4 address looks valid. This will return false for
132	localhost and similar.
133	Returns True / False.
134	"""
135	if sIpAddr is None: return False;
136	if len(sIpAddr.split('.')) != 4: return False;
137	if sIpAddr.endswith('.0'): return False;
138	if sIpAddr.endswith('.255'): return False;
139	if sIpAddr.startswith('127.'): return False;
140	if sIpAddr.startswith('169.254.'): return False;
141	if sIpAddr.startswith('192.0.2.'): return False;
142	if sIpAddr.startswith('224.0.0.'): return False;
143	return True;
144
145	def stringifyErrorInfo(oErrInfo):
146	"""
147	Stringifies the error information in a IVirtualBoxErrorInfo object.
148
149	Returns string with error info.
150	"""
151	try:
152	rc = oErrInfo.resultCode;
153	sText = oErrInfo.text;
154	sIid = oErrInfo.interfaceID;
155	sComponent = oErrInfo.component;
156	except:
157	sRet = 'bad error object (%s)?' % (oErrInfo,);
158	traceback.print_exc();
159	else:
160	sRet = 'rc=%s text="%s" IID=%s component=%s' % (ComError.toString(rc), sText, sIid, sComponent);
161	return sRet;
162
163	def reportError(oErr, sText):
164	"""
165	Report a VirtualBox error on oErr. oErr can be IVirtualBoxErrorInfo
166	or IProgress. Anything else is ignored.
167
168	Returns the same a reporter.error().
169	"""
170	try:
171	oErrObj = oErr.errorInfo; # IProgress.
172	except:
173	oErrObj = oErr;
174	reporter.error(sText);
175	return reporter.error(stringifyErrorInfo(oErrObj));
176
177
178	#
179	# Classes
180	#
181
182	class ComError(object):
183	"""
184	Unified COM and XPCOM status code repository.
185	This works more like a module than a class since it's replacing a module.
186	"""
187
188	# The VBOX_E_XXX bits:
189	__VBOX_E_BASE = -2135228416;
190	VBOX_E_OBJECT_NOT_FOUND = __VBOX_E_BASE + 1;
191	VBOX_E_INVALID_VM_STATE = __VBOX_E_BASE + 2;
192	VBOX_E_VM_ERROR = __VBOX_E_BASE + 3;
193	VBOX_E_FILE_ERROR = __VBOX_E_BASE + 4;
194	VBOX_E_IPRT_ERROR = __VBOX_E_BASE + 5;
195	VBOX_E_PDM_ERROR = __VBOX_E_BASE + 6;
196	VBOX_E_INVALID_OBJECT_STATE = __VBOX_E_BASE + 7;
197	VBOX_E_HOST_ERROR = __VBOX_E_BASE + 8;
198	VBOX_E_NOT_SUPPORTED = __VBOX_E_BASE + 9;
199	VBOX_E_XML_ERROR = __VBOX_E_BASE + 10;
200	VBOX_E_INVALID_SESSION_STATE = __VBOX_E_BASE + 11;
201	VBOX_E_OBJECT_IN_USE = __VBOX_E_BASE + 12;
202	VBOX_E_DONT_CALL_AGAIN = __VBOX_E_BASE + 13;
203
204	# Reverse lookup table.
205	dDecimalToConst = {}; # pylint: disable=C0103
206
207	def __init__(self):
208	raise base.GenError('No instances, please');
209
210	@staticmethod
211	def copyErrors(oNativeComErrorClass):
212	"""
213	Copy all error codes from oNativeComErrorClass to this class and
214	install compatability mappings.
215	"""
216
217	# First, add the VBOX_E_XXX constants to dDecimalToConst.
218	for sAttr in dir(ComError):
219	if sAttr.startswith('VBOX_E'):
220	oAttr = getattr(ComError, sAttr);
221	ComError.dDecimalToConst[oAttr] = sAttr;
222
223	# Copy all error codes from oNativeComErrorClass to this class.
224	for sAttr in dir(oNativeComErrorClass):
225	if sAttr[0].isupper():
226	oAttr = getattr(oNativeComErrorClass, sAttr);
227	setattr(ComError, sAttr, oAttr);
228	if isinstance(oAttr, int):
229	ComError.dDecimalToConst[oAttr] = sAttr;
230
231	# Install mappings to the other platform.
232	if platform.system() == 'Windows':
233	ComError.NS_OK = ComError.S_OK;
234	ComError.NS_ERROR_FAILURE = ComError.E_FAIL;
235	ComError.NS_ERROR_ABORT = ComError.E_ABORT;
236	ComError.NS_ERROR_NULL_POINTER = ComError.E_POINTER;
237	ComError.NS_ERROR_NO_INTERFACE = ComError.E_NOINTERFACE;
238	ComError.NS_ERROR_INVALID_ARG = ComError.E_INVALIDARG;
239	ComError.NS_ERROR_OUT_OF_MEMORY = ComError.E_OUTOFMEMORY;
240	ComError.NS_ERROR_NOT_IMPLEMENTED = ComError.E_NOTIMPL;
241	ComError.NS_ERROR_UNEXPECTED = ComError.E_UNEXPECTED;
242	else:
243	ComError.E_ACCESSDENIED = -2147024891; # see VBox/com/defs.h
244	ComError.S_OK = ComError.NS_OK;
245	ComError.E_FAIL = ComError.NS_ERROR_FAILURE;
246	ComError.E_ABORT = ComError.NS_ERROR_ABORT;
247	ComError.E_POINTER = ComError.NS_ERROR_NULL_POINTER;
248	ComError.E_NOINTERFACE = ComError.NS_ERROR_NO_INTERFACE;
249	ComError.E_INVALIDARG = ComError.NS_ERROR_INVALID_ARG;
250	ComError.E_OUTOFMEMORY = ComError.NS_ERROR_OUT_OF_MEMORY;
251	ComError.E_NOTIMPL = ComError.NS_ERROR_NOT_IMPLEMENTED;
252	ComError.E_UNEXPECTED = ComError.NS_ERROR_UNEXPECTED;
253	ComError.DISP_E_EXCEPTION = -2147352567; # For COM compatability only.
254	return True;
255
256	@staticmethod
257	def getXcptResult(oXcpt):
258	"""
259	Gets the result code for an exception.
260	Returns COM status code (or E_UNEXPECTED).
261	"""
262	if platform.system() == 'Windows':
263	# The DISP_E_EXCEPTION + excptinfo fun needs checking up, only
264	# empirical info on it so far.
265	try:
266	hrXcpt = oXcpt.hresult;
267	except AttributeError:
268	hrXcpt = ComError.E_UNEXPECTED;
269	if hrXcpt == ComError.DISP_E_EXCEPTION and oXcpt.excepinfo is not None:
270	hrXcpt = oXcpt.excepinfo[5];
271	else:
272	try:
273	hrXcpt = oXcpt.errno;
274	except AttributeError:
275	hrXcpt = ComError.E_UNEXPECTED;
276	return hrXcpt;
277
278	@staticmethod
279	def equal(oXcpt, hr):
280	"""
281	Checks if the ComException e is not equal to the COM status code hr.
282	This takes DISP_E_EXCEPTION & excepinfo into account.
283
284	This method can be used with any Exception derivate, however it will
285	only return True for classes similar to the two ComException variants.
286	"""
287	if platform.system() == 'Windows':
288	# The DISP_E_EXCEPTION + excptinfo fun needs checking up, only
289	# empirical info on it so far.
290	try:
291	hrXcpt = oXcpt.hresult;
292	except AttributeError:
293	return False;
294	if hrXcpt == ComError.DISP_E_EXCEPTION and oXcpt.excepinfo is not None:
295	hrXcpt = oXcpt.excepinfo[5];
296	else:
297	try:
298	hrXcpt = oXcpt.errno;
299	except AttributeError:
300	return False;
301	return hrXcpt == hr;
302
303	@staticmethod
304	def notEqual(oXcpt, hr):
305	"""
306	Checks if the ComException e is not equal to the COM status code hr.
307	See equal() for more details.
308	"""
309	return not ComError.equal(oXcpt, hr)
310
311	@staticmethod
312	def toString(hr):
313	"""
314	Converts the specified COM status code to a string.
315	"""
316	try:
317	sStr = ComError.dDecimalToConst[int(hr)];
318	except KeyError:
319	hrLong = long(hr);
320	sStr = '%#x (%d)' % (hrLong, hrLong);
321	return sStr;
322
323
324	class Build(object): # pylint: disable=R0903
325	"""
326	A VirtualBox build.
327
328	Note! After dropping the installation of VBox from this code and instead
329	realizing that with the vboxinstall.py wrapper driver, this class is
330	of much less importance and contains unnecessary bits and pieces.
331	"""
332
333	def __init__(self, oDriver, strInstallPath):
334	"""
335	Construct a build object from a build file name and/or install path.
336	"""
337	# Initialize all members first.
338	self.oDriver = oDriver;
339	self.sInstallPath = strInstallPath;
340	self.sSdkPath = None;
341	self.sSrcRoot = None;
342	self.sKind = None;
343	self.sDesignation = None;
344	self.sType = None;
345	self.sOs = None;
346	self.sArch = None;
347	self.sGuestAdditionsIso = None;
348
349	# Figure out the values as best we can.
350	if strInstallPath is None:
351	#
352	# Both parameters are None, which means we're falling back on a
353	# build in the development tree.
354	#
355	self.sKind = "development";
356
357	if self.sType is None:
358	self.sType = os.environ.get("KBUILD_TYPE", os.environ.get("BUILD_TYPE", "release"));
359	if self.sOs is None:
360	self.sOs = os.environ.get("KBUILD_TARGET", os.environ.get("BUILD_TARGET", oDriver.sHost));
361	if self.sArch is None:
362	self.sArch = os.environ.get("KBUILD_TARGET_ARCH", os.environ.get("BUILD_TARGET_ARCH", oDriver.sHostArch));
363
364	sOut = os.path.join('out', self.sOs + '.' + self.sArch, self.sType);
365	sSearch = os.environ.get('VBOX_TD_DEV_TREE', os.path.dirname(__file__)); # Env.var. for older trees or testboxscript.
366	sCandidat = None;
367	for i in range(0, 10): # pylint: disable=W0612
368	sBldDir = os.path.join(sSearch, sOut);
369	if os.path.isdir(sBldDir):
370	sCandidat = os.path.join(sBldDir, 'bin', 'VBoxSVC' + base.exeSuff());
371	if os.path.isfile(sCandidat):
372	self.sSdkPath = os.path.join(sBldDir, 'bin/sdk');
373	break;
374	sCandidat = os.path.join(sBldDir, 'dist/VirtualBox.app/Contents/MacOS/VBoxSVC');
375	if os.path.isfile(sCandidat):
376	self.sSdkPath = os.path.join(sBldDir, 'dist/sdk');
377	break;
378	sSearch = os.path.abspath(os.path.join(sSearch, '..'));
379	if sCandidat is None or not os.path.isfile(sCandidat):
380	raise base.GenError();
381	self.sInstallPath = os.path.abspath(os.path.dirname(sCandidat));
382	self.sSrcRoot = os.path.abspath(sSearch);
383
384	self.sDesignation = os.environ.get('TEST_BUILD_DESIGNATION', None);
385	if self.sDesignation is None:
386	try:
387	oFile = utils.openNoInherit(os.path.join(self.sSrcRoot, sOut, 'revision.kmk'), 'r');
388	except:
389	pass;
390	else:
391	s = oFile.readline();
392	oFile.close();
393	import re;
394	oMatch = re.search("VBOX_SVN_REV=(\\d+)", s);
395	if oMatch is not None:
396	self.sDesignation = oMatch.group(1);
397
398	if self.sDesignation is None:
399	self.sDesignation = 'XXXXX'
400	else:
401	#
402	# We've been pointed to an existing installation, this could be
403	# in the out dir of a svn checkout, untarred VBoxAll or a real
404	# installation directory.
405	#
406	self.sKind = "preinstalled";
407	self.sType = "release";
408	self.sOs = oDriver.sHost;
409	self.sArch = oDriver.sHostArch;
410	self.sInstallPath = os.path.abspath(strInstallPath);
411	self.sSdkPath = os.path.join(self.sInstallPath, 'sdk');
412	self.sSrcRoot = None;
413	self.sDesignation = os.environ.get('TEST_BUILD_DESIGNATION', 'XXXXX');
414	## @todo Much more work is required here.
415
416	# Do some checks.
417	sVMMR0 = os.path.join(self.sInstallPath, 'VMMR0.r0');
418	if not os.path.isfile(sVMMR0) and utils.getHostOs() == 'solaris': # solaris is special.
419	sVMMR0 = os.path.join(self.sInstallPath, 'amd64' if utils.getHostArch() == 'amd64' else 'i386', 'VMMR0.r0');
420	if not os.path.isfile(sVMMR0):
421	raise base.GenError('%s is missing' % (sVMMR0,));
422
423	# Guest additions location is different on windows for some _stupid_ reason.
424	if self.sOs == 'win' and self.sKind != 'development':
425	self.sGuestAdditionsIso = '%s/VBoxGuestAdditions.iso' % (self.sInstallPath,);
426	elif self.sOs == 'darwin':
427	self.sGuestAdditionsIso = '%s/VBoxGuestAdditions.iso' % (self.sInstallPath,);
428	elif self.sOs == 'solaris':
429	self.sGuestAdditionsIso = '%s/VBoxGuestAdditions.iso' % (self.sInstallPath,);
430	else:
431	self.sGuestAdditionsIso = '%s/additions/VBoxGuestAdditions.iso' % (self.sInstallPath,);
432
433	# __init__ end;
434
435	def dump(self):
436	""" Status dumper for debugging. """
437	print >> sys.stderr, "testdriver.vbox.Build: sInstallPath= '%s'" % self.sInstallPath;
438	print >> sys.stderr, "testdriver.vbox.Build: sSdkPath = '%s'" % self.sSdkPath;
439	print >> sys.stderr, "testdriver.vbox.Build: sSrcRoot = '%s'" % self.sSrcRoot;
440	print >> sys.stderr, "testdriver.vbox.Build: sKind = '%s'" % self.sKind;
441	print >> sys.stderr, "testdriver.vbox.Build: sDesignation= '%s'" % self.sDesignation;
442	print >> sys.stderr, "testdriver.vbox.Build: sType = '%s'" % self.sType;
443	print >> sys.stderr, "testdriver.vbox.Build: sOs = '%s'" % self.sOs;
444	print >> sys.stderr, "testdriver.vbox.Build: sArch = '%s'" % self.sArch;
445
446	def isDevBuild(self):
447	""" Returns True if it's development build (kind), otherwise False. """
448	return self.sKind == 'development';
449
450
451	class EventHandlerBase(object):
452	"""
453	Base class for both Console and VirtualBox event handlers.
454	"""
455
456	def __init__(self, dArgs, fpApiVer, sName = None):
457	self.oVBoxMgr = dArgs['oVBoxMgr'];
458	self.oEventSrc = dArgs['oEventSrc']; # Console/VirtualBox for < 3.3
459	self.oListener = dArgs['oListener'];
460	self.fPassive = self.oListener != None;
461	self.sName = sName
462	self.fShutdown = False;
463	self.oThread = None;
464	self.fpApiVer = fpApiVer;
465
466	def threadForPassiveMode(self):
467	"""
468	The thread procedure for the event processing thread.
469	"""
470	assert self.fPassive is not None;
471	while not self.fShutdown:
472	try:
473	oEvt = self.oEventSrc.getEvent(self.oListener, 500);
474	except:
475	if not self.oVBoxMgr.xcptIsDeadInterface(): reporter.logXcpt();
476	else: reporter.log('threadForPassiveMode/%s: interface croaked (ignored)' % (self.sName,));
477	break;
478	if oEvt:
479	self.handleEvent(oEvt);
480	if not self.fShutdown:
481	try:
482	self.oEventSrc.eventProcessed(self.oListener, oEvt);
483	except:
484	reporter.logXcpt();
485	break;
486	self.unregister(fWaitForThread = False);
487	return None;
488
489	def startThreadForPassiveMode(self):
490	"""
491	Called when working in passive mode.
492	"""
493	self.oThread = threading.Thread(target = self.threadForPassiveMode, \
494	args=(), name=('PAS-%s' % (self.sName,)));
495	self.oThread.setDaemon(True)
496	self.oThread.start();
497	return None;
498
499	def unregister(self, fWaitForThread = True):
500	"""
501	Unregister the event handler.
502	"""
503	fRc = False;
504	if not self.fShutdown:
505	self.fShutdown = True;
506
507	if self.oEventSrc is not None:
508	if self.fpApiVer < 3.3:
509	try:
510	self.oEventSrc.unregisterCallback(self.oListener);
511	fRc = True;
512	except:
513	reporter.errorXcpt('unregisterCallback failed on %s' % (self.oListener,));
514	else:
515	try:
516	self.oEventSrc.unregisterListener(self.oListener);
517	fRc = True;
518	except:
519	if self.oVBoxMgr.xcptIsDeadInterface():
520	reporter.log('unregisterListener failed on %s because of dead interface (%s)'
521	% (self.oListener, self.oVBoxMgr.xcptToString(),));
522	else:
523	reporter.errorXcpt('unregisterListener failed on %s' % (self.oListener,));
524
525	if self.oThread is not None \
526	and self.oThread != threading.current_thread():
527	self.oThread.join();
528	self.oThread = None;
529
530	_ = fWaitForThread;
531	return fRc;
532
533	def handleEvent(self, oEvt):
534	"""
535	Compatibility wrapper that child classes implement.
536	"""
537	_ = oEvt;
538	return None;
539
540	@staticmethod
541	def registerDerivedEventHandler(oVBoxMgr, fpApiVer, oSubClass, dArgsCopy,
542	oSrcParent, sSrcParentNm, sICallbackNm,
543	fMustSucceed = True, sLogSuffix = ''):
544	"""
545	Registers the callback / event listener.
546	"""
547	dArgsCopy['oVBoxMgr'] = oVBoxMgr;
548	dArgsCopy['oListener'] = None;
549	if fpApiVer < 3.3:
550	dArgsCopy['oEventSrc'] = oSrcParent;
551	try:
552	oRet = oVBoxMgr.createCallback(sICallbackNm, oSubClass, dArgsCopy);
553	except:
554	reporter.errorXcpt('%s::registerCallback(%s) failed%s' % (sSrcParentNm, oRet, sLogSuffix));
555	else:
556	try:
557	oSrcParent.registerCallback(oRet);
558	return oRet;
559	except Exception, oXcpt:
560	if fMustSucceed or ComError.notEqual(oXcpt, ComError.E_UNEXPECTED):
561	reporter.errorXcpt('%s::registerCallback(%s)%s' % (sSrcParentNm, oRet, sLogSuffix));
562	else:
563	fPassive = sys.platform == 'win32'; # or webservices.
564	try:
565	oEventSrc = oSrcParent.eventSource;
566	dArgsCopy['oEventSrc'] = oEventSrc;
567	if not fPassive:
568	oListener = oRet = oVBoxMgr.createListener(oSubClass, dArgsCopy);
569	else:
570	oListener = oEventSrc.createListener();
571	dArgsCopy['oListener'] = oListener;
572	oRet = oSubClass(dArgsCopy);
573	except:
574	reporter.errorXcpt('%s::eventSource.createListener(%s) failed%s' % (sSrcParentNm, oListener, sLogSuffix));
575	else:
576	try:
577	oEventSrc.registerListener(oListener, [vboxcon.VBoxEventType_Any], not fPassive);
578	except Exception, oXcpt:
579	if fMustSucceed or ComError.notEqual(oXcpt, ComError.E_UNEXPECTED):
580	reporter.errorXcpt('%s::eventSource.registerListener(%s) failed%s' \
581	% (sSrcParentNm, oListener, sLogSuffix));
582	else:
583	if not fPassive:
584	if sys.platform == 'win32':
585	from win32com.server.util import unwrap # pylint: disable=F0401
586	oRet = unwrap(oRet);
587	oRet.oListener = oListener;
588	else:
589	oRet.startThreadForPassiveMode();
590	return oRet;
591	return None;
592
593
594
595
596	class ConsoleEventHandlerBase(EventHandlerBase):
597	"""
598	Base class for handling IConsole events.
599
600	The class has IConsoleCallback (<=3.2) compatible callback methods which
601	the user can override as needed.
602
603	Note! This class must not inherit from object or we'll get type errors in VBoxPython.
604	"""
605	def __init__(self, dArgs, sName = None):
606	self.oSession = dArgs['oSession'];
607	self.oConsole = dArgs['oConsole'];
608	if sName is None:
609	sName = self.oSession.sName;
610	EventHandlerBase.__init__(self, dArgs, self.oSession.fpApiVer, sName);
611
612
613	# pylint: disable=C0111,R0913,W0613
614	def onMousePointerShapeChange(self, fVisible, fAlpha, xHot, yHot, cx, cy, abShape):
615	reporter.log2('onMousePointerShapeChange/%s' % (self.sName));
616	def onMouseCapabilityChange(self, fSupportsAbsolute, *aArgs): # Extra argument was added in 3.2.
617	reporter.log2('onMouseCapabilityChange/%s' % (self.sName));
618	def onKeyboardLedsChange(self, fNumLock, fCapsLock, fScrollLock):
619	reporter.log2('onKeyboardLedsChange/%s' % (self.sName));
620	def onStateChange(self, eState):
621	reporter.log2('onStateChange/%s' % (self.sName));
622	def onAdditionsStateChange(self):
623	reporter.log2('onAdditionsStateChange/%s' % (self.sName));
624	def onNetworkAdapterChange(self, oNic):
625	reporter.log2('onNetworkAdapterChange/%s' % (self.sName));
626	def onSerialPortChange(self, oPort):
627	reporter.log2('onSerialPortChange/%s' % (self.sName));
628	def onParallelPortChange(self, oPort):
629	reporter.log2('onParallelPortChange/%s' % (self.sName));
630	def onStorageControllerChange(self):
631	reporter.log2('onStorageControllerChange/%s' % (self.sName));
632	def onMediumChange(self, attachment):
633	reporter.log2('onMediumChange/%s' % (self.sName));
634	def onCPUChange(self, iCpu, fAdd):
635	reporter.log2('onCPUChange/%s' % (self.sName));
636	def onVRDPServerChange(self):
637	reporter.log2('onVRDPServerChange/%s' % (self.sName));
638	def onRemoteDisplayInfoChange(self):
639	reporter.log2('onRemoteDisplayInfoChange/%s' % (self.sName));
640	def onUSBControllerChange(self):
641	reporter.log2('onUSBControllerChange/%s' % (self.sName));
642	def onUSBDeviceStateChange(self, oDevice, fAttached, oError):
643	reporter.log2('onUSBDeviceStateChange/%s' % (self.sName));
644	def onSharedFolderChange(self, fGlobal):
645	reporter.log2('onSharedFolderChange/%s' % (self.sName));
646	def onRuntimeError(self, fFatal, sErrId, sMessage):
647	reporter.log2('onRuntimeError/%s' % (self.sName));
648	def onCanShowWindow(self):
649	reporter.log2('onCanShowWindow/%s' % (self.sName));
650	return True
651	def onShowWindow(self):
652	reporter.log2('onShowWindow/%s' % (self.sName));
653	return None;
654	# pylint: enable=C0111,R0913,W0613
655
656	def handleEvent(self, oEvt):
657	"""
658	Compatibility wrapper.
659	"""
660	try:
661	oEvtBase = self.oVBoxMgr.queryInterface(oEvt, 'IEvent');
662	eType = oEvtBase.type;
663	except:
664	reporter.logXcpt();
665	return None;
666	if eType == vboxcon.VBoxEventType_OnRuntimeError:
667	try:
668	oEvtIt = self.oVBoxMgr.queryInterface(oEvtBase, 'IRuntimeErrorEvent');
669	return self.onRuntimeError(oEvtIt.fatal, oEvtIt.id, oEvtIt.message)
670	except:
671	reporter.logXcpt();
672	## @todo implement the other events.
673	if eType != vboxcon.VBoxEventType_OnMousePointerShapeChanged:
674	reporter.log2('%s/%s' % (str(eType), self.sName));
675	return None;
676
677
678	class VirtualBoxEventHandlerBase(EventHandlerBase):
679	"""
680	Base class for handling IVirtualBox events.
681
682	The class has IConsoleCallback (<=3.2) compatible callback methods which
683	the user can override as needed.
684
685	Note! This class must not inherit from object or we'll get type errors in VBoxPython.
686	"""
687	def __init__(self, dArgs, sName = "emanon"):
688	self.oVBoxMgr = dArgs['oVBoxMgr'];
689	self.oVBox = dArgs['oVBox'];
690	EventHandlerBase.__init__(self, dArgs, self.oVBox.fpApiVer, sName);
691
692	# pylint: disable=C0111,W0613
693	def onMachineStateChange(self, sMachineId, eState):
694	pass;
695	def onMachineDataChange(self, sMachineId):
696	pass;
697	def onExtraDataCanChange(self, sMachineId, sKey, sValue):
698	# The COM bridge does tuples differently. Not very funny if you ask me... ;-)
699	if self.oVBoxMgr.type == 'MSCOM':
700	return '', 0, True;
701	return True, ''
702	def onExtraDataChange(self, sMachineId, sKey, sValue):
703	pass;
704	def onMediumRegistered(self, sMediumId, eMediumType, fRegistered):
705	pass;
706	def onMachineRegistered(self, sMachineId, fRegistered):
707	pass;
708	def onSessionStateChange(self, sMachineId, eState):
709	pass;
710	def onSnapshotTaken(self, sMachineId, sSnapshotId):
711	pass;
712	def onSnapshotDiscarded(self, sMachineId, sSnapshotId):
713	pass;
714	def onSnapshotChange(self, sMachineId, sSnapshotId):
715	pass;
716	def onGuestPropertyChange(self, sMachineId, sName, sValue, sFlags):
717	pass;
718	# pylint: enable=C0111,W0613
719
720	def handleEvent(self, oEvt):
721	"""
722	Compatibility wrapper.
723	"""
724	try:
725	oEvtBase = self.oVBoxMgr.queryInterface(oEvt, 'IEvent');
726	eType = oEvtBase.type;
727	except:
728	reporter.logXcpt();
729	return None;
730	if eType == vboxcon.VBoxEventType_OnMachineStateChanged:
731	try:
732	oEvtIt = self.oVBoxMgr.queryInterface(oEvtBase, 'IMachineStateChangedEvent');
733	return self.onMachineStateChange(oEvtIt.machineId, oEvtIt.state)
734	except:
735	reporter.logXcpt();
736	elif eType == vboxcon.VBoxEventType_OnGuestPropertyChanged:
737	try:
738	oEvtIt = self.oVBoxMgr.queryInterface(oEvtBase, 'IGuestPropertyChangedEvent');
739	return self.onGuestPropertyChange(oEvtIt.machineId, oEvtIt.name, oEvtIt.value, oEvtIt.flags);
740	except:
741	reporter.logXcpt();
742	## @todo implement the other events.
743	reporter.log2('%s/%s' % (str(eType), self.sName));
744	return None;
745
746
747	class SessionConsoleEventHandler(ConsoleEventHandlerBase):
748	"""
749	For catching machine state changes and waking up the task machinery at that point.
750	"""
751	def __init__(self, dArgs):
752	ConsoleEventHandlerBase.__init__(self, dArgs);
753
754	def onMachineStateChange(self, sMachineId, eState): # pylint: disable=W0613
755	""" Just interrupt the wait loop here so it can check again. """
756	_ = sMachineId; _ = eState;
757	self.oVBoxMgr.interruptWaitEvents();
758
759	def onRuntimeError(self, fFatal, sErrId, sMessage):
760	reporter.log('onRuntimeError/%s: fFatal=%d sErrId=%s sMessage=%s' % (self.sName, fFatal, sErrId, sMessage));
761	oSession = self.oSession;
762	if oSession is not None: # paranoia
763	if sErrId == 'HostMemoryLow':
764	oSession.signalHostMemoryLow();
765	if sys.platform == 'win32':
766	from testdriver import winbase;
767	winbase.logMemoryStats();
768	oSession.signalTask();
769	self.oVBoxMgr.interruptWaitEvents();
770
771
772
773	class TestDriver(base.TestDriver): # pylint: disable=R0902
774	"""
775	This is the VirtualBox test driver.
776	"""
777
778	def __init__(self):
779	base.TestDriver.__init__(self);
780	self.fImportedVBoxApi = False;
781	self.fpApiVer = 3.2;
782	self.oBuild = None;
783	self.oVBoxMgr = None;
784	self.oVBox = None;
785	self.aoRemoteSessions = [];
786	self.aoVMs = []; ## @todo not sure if this list will be of any use.
787	self.oTestVmManager = vboxtestvms.TestVmManager(self.sResourcePath);
788	self.oTestVmSet = vboxtestvms.TestVmSet();
789	self.sSessionTypeDef = 'headless';
790	self.sSessionType = self.sSessionTypeDef;
791	self.fEnableVrdp = True;
792	self.uVrdpBasePortDef = 6000;
793	self.uVrdpBasePort = self.uVrdpBasePortDef;
794	self.sDefBridgedNic = None;
795	self.fUseDefaultSvc = False;
796	self.sLogSelfGroups = '';
797	self.sLogSelfFlags = 'time';
798	self.sLogSelfDest = '';
799	self.sLogSessionGroups = '';
800	self.sLogSessionFlags = 'time';
801	self.sLogSessionDest = '';
802	self.sLogSvcGroups = '';
803	self.sLogSvcFlags = 'time';
804	self.sLogSvcDest = '';
805	self.sSelfLogFile = None;
806	self.sVBoxSvcLogFile = None;
807	self.oVBoxSvcProcess = None;
808	self.sVBoxSvcPidFile = None;
809	self.fVBoxSvcInDebugger = False;
810	self.sVBoxValidationKit = None;
811	self.sVBoxValidationKitIso = None;
812	self.sVBoxBootSectors = None;
813	self.fAlwaysUploadLogs = False;
814	self.fAlwaysUploadScreenshots = False;
815	self.fEnableDebugger = True;
816
817	# Quietly detect build and validation kit.
818	self._detectBuild(False);
819	self._detectValidationKit(False);
820
821	# Make sure all debug logs goes to the scratch area unless
822	# specified otherwise (more of this later on).
823	if 'VBOX_LOG_DEST' not in os.environ:
824	os.environ['VBOX_LOG_DEST'] = 'dir=%s' % (self.sScratchPath);
825
826	def dump(self):
827	"""
828	Dump object state, for debugging.
829	"""
830	base.TestDriver.dump(self);
831	print >> sys.stderr, "testdriver.vbox: fImportedVBoxApi = '%s'" % self.fImportedVBoxApi;
832	print >> sys.stderr, "testdriver.vbox: fpApiVer = '%s'" % self.fpApiVer;
833	print >> sys.stderr, "testdriver.vbox: oBuild = '%s'" % self.oBuild;
834	print >> sys.stderr, "testdriver.vbox: oVBoxMgr = '%s'" % self.oVBoxMgr;
835	print >> sys.stderr, "testdriver.vbox: oVBox = '%s'" % self.oVBox;
836	print >> sys.stderr, "testdriver.vbox: aoRemoteSessions = '%s'" % self.aoRemoteSessions;
837	print >> sys.stderr, "testdriver.vbox: aoVMs = '%s'" % self.aoVMs;
838	print >> sys.stderr, "testdriver.vbox: sVBoxValidationKit = '%s'" % self.sVBoxValidationKit;
839	print >> sys.stderr, "testdriver.vbox: sVBoxValidationKitIso = '%s'" % self.sVBoxValidationKitIso;
840	print >> sys.stderr, "testdriver.vbox: sVBoxBootSectors = '%s'" % self.sVBoxBootSectors;
841	if self.oBuild is not None:
842	self.oBuild.dump();
843
844	def _detectBuild(self, fQuiet = False):
845	"""
846	This is used internally to try figure a locally installed build when
847	running tests manually.
848	"""
849	if self.oBuild is not None:
850	return True;
851
852	# Try dev build first since that's where I'll be using it first...
853	if True is True:
854	try:
855	self.oBuild = Build(self, None);
856	return True;
857	except base.GenError:
858	pass;
859
860	# Try default installation locations.
861	if self.sHost == 'win':
862	sProgFiles = os.environ.get('ProgramFiles', 'C:\\Program Files');
863	asLocs = [
864	os.path.join(sProgFiles, 'Oracle', 'VirtualBox'),
865	os.path.join(sProgFiles, 'OracleVM', 'VirtualBox'),
866	os.path.join(sProgFiles, 'Sun', 'VirtualBox'),
867	];
868	elif self.sHost == 'solaris':
869	asLocs = [ '/opt/VirtualBox-3.2', '/opt/VirtualBox-3.1', '/opt/VirtualBox-3.0', '/opt/VirtualBox' ];
870	elif self.sHost == 'darwin':
871	asLocs = [ '/Applications/VirtualBox.app/Contents/MacOS' ];
872	elif self.sHost == 'linux':
873	asLocs = [ '/opt/VirtualBox-3.2', '/opt/VirtualBox-3.1', '/opt/VirtualBox-3.0', '/opt/VirtualBox' ];
874	else:
875	asLocs = [ '/opt/VirtualBox' ];
876	if 'VBOX_INSTALL_PATH' in os.environ:
877	asLocs.insert(0, os.environ['VBOX_INSTALL_PATH']);
878
879	for sLoc in asLocs:
880	try:
881	self.oBuild = Build(self, sLoc);
882	return True;
883	except base.GenError:
884	pass;
885
886	if not fQuiet:
887	reporter.error('failed to find VirtualBox installation');
888	return False;
889
890	def _detectValidationKit(self, fQuiet = False):
891	"""
892	This is used internally by the constructor to try locate an unzipped
893	VBox Validation Kit somewhere in the immediate proximity.
894	"""
895	if self.sVBoxValidationKit is not None:
896	return True;
897
898	#
899	# Normally it's found where we're running from, which is the same as
900	# the script directly on the testboxes.
901	#
902	asCandidates = [self.sScriptPath, ];
903	if g_ksValidationKitDir not in asCandidates:
904	asCandidates.append(g_ksValidationKitDir);
905	if os.getcwd() not in asCandidates:
906	asCandidates.append(os.getcwd());
907	if self.oBuild is not None and self.oBuild.sInstallPath not in asCandidates:
908	asCandidates.append(self.oBuild.sInstallPath);
909
910	#
911	# When working out of the tree, we'll search the current directory
912	# as well as parent dirs.
913	#
914	for sDir in list(asCandidates):
915	for i in range(10):
916	sDir = os.path.dirname(sDir);
917	if sDir not in asCandidates:
918	asCandidates.append(sDir);
919
920	#
921	# Do the searching.
922	#
923	sCandidate = None;
924	for i, _ in enumerate(asCandidates):
925	sCandidate = asCandidates[i];
926	if os.path.isfile(os.path.join(sCandidate, 'VBoxValidationKit.iso')):
927	break;
928	sCandidate = os.path.join(sCandidate, 'validationkit');
929	if os.path.isfile(os.path.join(sCandidate, 'VBoxValidationKit.iso')):
930	break;
931	sCandidate = None;
932
933	fRc = sCandidate is not None;
934	if fRc is False:
935	if not fQuiet:
936	reporter.error('failed to find VBox Validation Kit installation (candidates: %s)' % (asCandidates,));
937	sCandidate = os.path.join(self.sScriptPath, 'validationkit'); # Don't leave the values as None.
938
939	#
940	# Set the member values.
941	#
942	self.sVBoxValidationKit = sCandidate;
943	self.sVBoxValidationKitIso = os.path.join(sCandidate, 'VBoxValidationKit.iso');
944	self.sVBoxBootSectors = os.path.join(sCandidate, 'bootsectors');
945	return fRc;
946
947	def _makeEnvironmentChanges(self):
948	"""
949	Make the necessary VBox related environment changes.
950	Children not importing the VBox API should call this.
951	"""
952	# Make sure we've got our own VirtualBox config and VBoxSVC (on XPCOM at least).
953	if not self.fUseDefaultSvc:
954	os.environ['VBOX_USER_HOME'] = os.path.join(self.sScratchPath, 'VBoxUserHome');
955	sUser = os.environ.get('USERNAME', os.environ.get('USER', os.environ.get('LOGNAME', 'unknown')));
956	os.environ['VBOX_IPC_SOCKETID'] = sUser + '-VBoxTest';
957	return True;
958
959	def importVBoxApi(self):
960	"""
961	Import the 'vboxapi' module from the VirtualBox build we're using and
962	instantiate the two basic objects.
963
964	This will try detect an development or installed build if no build has
965	been associated with the driver yet.
966	"""
967	if self.fImportedVBoxApi:
968	return True;
969
970	self._makeEnvironmentChanges();
971
972	# Do the detecting.
973	self._detectBuild();
974	if self.oBuild is None:
975	return False;
976
977	# Avoid crashing when loading the 32-bit module (or whatever it is that goes bang).
978	if self.oBuild.sArch == 'x86' \
979	and self.sHost == 'darwin' \
980	and platform.architecture()[0] == '64bit' \
981	and self.oBuild.sKind == 'development' \
982	and os.getenv('VERSIONER_PYTHON_PREFER_32_BIT') != 'yes':
983	print "WARNING: 64-bit python on darwin, 32-bit VBox development build => crash"
984	print "WARNING: bash-3.2$ /usr/bin/python2.5 ./testdriver"
985	print "WARNING: or"
986	print "WARNING: bash-3.2$ VERSIONER_PYTHON_PREFER_32_BIT=yes ./testdriver"
987	return False;
988
989	# Start VBoxSVC and load the vboxapi bits.
990	if self._startVBoxSVC() is True:
991	assert(self.oVBoxSvcProcess is not None);
992
993	sSavedSysPath = sys.path;
994	self._setupVBoxApi();
995	sys.path = sSavedSysPath;
996
997	# Adjust the default machine folder.
998	if self.fImportedVBoxApi and not self.fUseDefaultSvc and self.fpApiVer >= 4.0:
999	sNewFolder = os.path.join(self.sScratchPath, 'VBoxUserHome', 'Machines');
1000	try:
1001	self.oVBox.systemProperties.defaultMachineFolder = sNewFolder;
1002	except:
1003	self.fImportedVBoxApi = False;
1004	self.oVBoxMgr = None;
1005	self.oVBox = None;
1006	reporter.logXcpt("defaultMachineFolder exception (sNewFolder=%s)" % (sNewFolder,));
1007
1008	# Kill VBoxSVC on failure.
1009	if self.oVBoxMgr is None:
1010	self._stopVBoxSVC();
1011	else:
1012	assert(self.oVBoxSvcProcess is None);
1013	return self.fImportedVBoxApi;
1014
1015	def _startVBoxSVC(self): # pylint: disable=R0915
1016	""" Starts VBoxSVC. """
1017	assert(self.oVBoxSvcProcess is None);
1018
1019	# Setup vbox logging for VBoxSVC now and start it manually. This way
1020	# we can control both logging and shutdown.
1021	self.sVBoxSvcLogFile = '%s/VBoxSVC-debug.log' % (self.sScratchPath,);
1022	try: os.remove(self.sVBoxSvcLogFile);
1023	except: pass;
1024	os.environ['VBOX_LOG'] = self.sLogSvcGroups;
1025	os.environ['VBOX_LOG_FLAGS'] = '%s append' % (self.sLogSvcFlags,); # Append becuse of VBoxXPCOMIPCD.
1026	if self.sLogSvcDest:
1027	os.environ['VBOX_LOG_DEST'] = self.sLogSvcDest;
1028	else:
1029	os.environ['VBOX_LOG_DEST'] = 'file=%s' % (self.sVBoxSvcLogFile,);
1030	os.environ['VBOXSVC_RELEASE_LOG_FLAGS'] = 'time append';
1031
1032	# Always leave a pid file behind so we can kill it during cleanup-before.
1033	self.sVBoxSvcPidFile = '%s/VBoxSVC.pid' % (self.sScratchPath,);
1034	fWritePidFile = True;
1035
1036	cMsFudge = 1;
1037	sVBoxSVC = '%s/VBoxSVC' % (self.oBuild.sInstallPath,); ## @todo .exe and stuff.
1038	if self.fVBoxSvcInDebugger:
1039	if self.sHost in ('darwin', 'freebsd', 'linux', 'solaris', ):
1040	# Start VBoxSVC in gdb in a new terminal.
1041	#sTerm = '/usr/bin/gnome-terminal'; - doesn't work, some fork+exec stuff confusing us.
1042	sTerm = '/usr/bin/xterm';
1043	if not os.path.isfile(sTerm): sTerm = '/usr/X11/bin/xterm';
1044	if not os.path.isfile(sTerm): sTerm = '/usr/X11R6/bin/xterm';
1045	if not os.path.isfile(sTerm): sTerm = '/usr/bin/xterm';
1046	if not os.path.isfile(sTerm): sTerm = 'xterm';
1047	sGdb = '/usr/bin/gdb';
1048	if not os.path.isfile(sGdb): sGdb = '/usr/local/bin/gdb';
1049	if not os.path.isfile(sGdb): sGdb = '/usr/sfw/bin/gdb';
1050	if not os.path.isfile(sGdb): sGdb = 'gdb';
1051	sGdbCmdLine = '%s --args %s --pidfile %s' % (sGdb, sVBoxSVC, self.sVBoxSvcPidFile);
1052	reporter.log('term="%s" gdb="%s"' % (sTerm, sGdbCmdLine));
1053	os.environ['SHELL'] = self.sOrgShell; # Non-working shell may cause gdb and/or the term problems.
1054	self.oVBoxSvcProcess = base.Process.spawnp(sTerm, sTerm, '-e', sGdbCmdLine);
1055	os.environ['SHELL'] = self.sOurShell;
1056	if self.oVBoxSvcProcess is not None:
1057	reporter.log('Press enter or return after starting VBoxSVC in the debugger...');
1058	sys.stdin.read(1);
1059	fWritePidFile = False;
1060
1061	elif self.sHost == 'win':
1062	sWinDbg = 'c:\\Program Files\\Debugging Tools for Windows\\windbg.exe';
1063	if not os.path.isfile(sWinDbg): sWinDbg = 'c:\\Program Files\\Debugging Tools for Windows (x64)\\windbg.exe';
1064	if not os.path.isfile(sWinDbg): sWinDbg = 'c:\\Programme\\Debugging Tools for Windows\\windbg.exe'; # Localization rulez! pylint: disable=C0301
1065	if not os.path.isfile(sWinDbg): sWinDbg = 'c:\\Programme\\Debugging Tools for Windows (x64)\\windbg.exe';
1066	if not os.path.isfile(sWinDbg): sWinDbg = 'windbg'; # WinDbg must be in the path; better than nothing.
1067	# Assume that everything WinDbg needs is defined using the environment variables.
1068	# See WinDbg help for more information.
1069	reporter.log('windbg="%s"' % (sWinDbg));
1070	self.oVBoxSvcProcess = base.Process.spawn(sWinDbg, sWinDbg, sVBoxSVC + base.exeSuff());
1071	if self.oVBoxSvcProcess is not None:
1072	reporter.log('Press enter or return after starting VBoxSVC in the debugger...');
1073	sys.stdin.read(1);
1074	fWritePidFile = False;
1075	## @todo add a pipe interface similar to xpcom if feasible, i.e. if
1076	# we can get actual handle values for pipes in python.
1077
1078	else:
1079	reporter.error('Port me!');
1080	else: # Run without a debugger attached.
1081	if self.sHost in ('darwin', 'freebsd', 'linux', 'solaris', ):
1082	#
1083	# XPCOM - We can use a pipe to let VBoxSVC notify us when it's ready.
1084	#
1085	iPipeR, iPipeW = os.pipe();
1086	os.environ['NSPR_INHERIT_FDS'] = 'vboxsvc:startup-pipe:5:0x%x' % (iPipeW,);
1087	reporter.log2("NSPR_INHERIT_FDS=%s" % (os.environ['NSPR_INHERIT_FDS']));
1088
1089	self.oVBoxSvcProcess = base.Process.spawn(sVBoxSVC, sVBoxSVC, '--auto-shutdown'); # SIGUSR1 requirement.
1090	try: # Try make sure we get the SIGINT and not VBoxSVC.
1091	os.setpgid(self.oVBoxSvcProcess.getPid(), 0); # pylint: disable=E1101
1092	os.setpgid(0, 0); # pylint: disable=E1101
1093	except:
1094	reporter.logXcpt();
1095
1096	os.close(iPipeW);
1097	try:
1098	sResponse = os.read(iPipeR, 32);
1099	except:
1100	reporter.logXcpt();
1101	sResponse = None;
1102	os.close(iPipeR);
1103
1104	if sResponse is None or sResponse.strip() != 'READY':
1105	reporter.error('VBoxSVC failed starting up... (sResponse=%s)' % (sResponse,));
1106	if not self.oVBoxSvcProcess.wait(5000):
1107	self.oVBoxSvcProcess.terminate(2500);
1108	self.oVBoxSvcProcess.wait(5000);
1109	self.oVBoxSvcProcess = None;
1110
1111	elif self.sHost == 'win':
1112	#
1113	# Windows - Just fudge it for now.
1114	#
1115	cMsFudge = 2000;
1116	self.oVBoxSvcProcess = base.Process.spawn(sVBoxSVC, sVBoxSVC);
1117
1118	else:
1119	reporter.error('Port me!');
1120
1121	#
1122	# Enable automatic crash reporting if we succeeded.
1123	#
1124	if self.oVBoxSvcProcess is not None:
1125	self.oVBoxSvcProcess.enableCrashReporting('crash/report/svc', 'crash/dump/svc');
1126
1127	#
1128	# Fudge and pid file.
1129	#
1130	if self.oVBoxSvcProcess != None and not self.oVBoxSvcProcess.wait(cMsFudge):
1131	if fWritePidFile:
1132	iPid = self.oVBoxSvcProcess.getPid();
1133	try:
1134	oFile = utils.openNoInherit(self.sVBoxSvcPidFile, "w+");
1135	oFile.write('%s' % (iPid,));
1136	oFile.close();
1137	except:
1138	reporter.logXcpt('sPidFile=%s' % (self.sVBoxSvcPidFile,));
1139	reporter.log('VBoxSVC PID=%u' % (iPid,));
1140
1141	#
1142	# Finally add the task so we'll notice when it dies in a relatively timely manner.
1143	#
1144	self.addTask(self.oVBoxSvcProcess);
1145	else:
1146	self.oVBoxSvcProcess = None;
1147	try: os.remove(self.sVBoxSvcPidFile);
1148	except: pass;
1149
1150	return self.oVBoxSvcProcess != None;
1151
1152
1153	def _killVBoxSVCByPidFile(self, sPidFile):
1154	""" Kill a VBoxSVC given the pid from it's pid file. """
1155
1156	# Read the pid file.
1157	if not os.path.isfile(sPidFile):
1158	return False;
1159	try:
1160	oFile = utils.openNoInherit(sPidFile, "r");
1161	sPid = oFile.readline().strip();
1162	oFile.close();
1163	except:
1164	reporter.logXcpt('sPidfile=%s' % (sPidFile,));
1165	return False;
1166
1167	# Convert the pid to an integer and validate the range a little bit.
1168	try:
1169	iPid = long(sPid);
1170	except:
1171	reporter.logXcpt('sPidfile=%s sPid="%s"' % (sPidFile, sPid));
1172	return False;
1173	if iPid <= 0:
1174	reporter.log('negative pid - sPidfile=%s sPid="%s" iPid=%d' % (sPidFile, sPid, iPid));
1175	return False;
1176
1177	# Take care checking that it's VBoxSVC we're about to inhume.
1178	if base.processCheckPidAndName(iPid, "VBoxSVC") is not True:
1179	reporter.log('Ignoring stale VBoxSVC pid file (pid=%s)' % (iPid,));
1180	return False;
1181
1182	# Loop thru our different ways of getting VBoxSVC to terminate.
1183	for aHow in [ [ base.sendUserSignal1, 5000, 'Dropping VBoxSVC a SIGUSR1 hint...'], \
1184	[ base.processInterrupt, 5000, 'Dropping VBoxSVC a SIGINT hint...'], \
1185	[ base.processTerminate, 7500, 'VBoxSVC is still around, killing it...'] ]:
1186	reporter.log(aHow[2]);
1187	if aHow[0](iPid) is True:
1188	msStart = base.timestampMilli();
1189	while base.timestampMilli() - msStart < 5000 \
1190	and base.processExists(iPid):
1191	time.sleep(0.2);
1192
1193	fRc = not base.processExists(iPid);
1194	if fRc is True:
1195	break;
1196	if fRc:
1197	reporter.log('Successfully killed VBoxSVC (pid=%s)' % (iPid,));
1198	else:
1199	reporter.log('Failed to kill VBoxSVC (pid=%s)' % (iPid,));
1200	return fRc;
1201
1202	def _stopVBoxSVC(self):
1203	"""
1204	Stops VBoxSVC. Try the polite way first.
1205	"""
1206
1207	if self.oVBoxSvcProcess:
1208	self.removeTask(self.oVBoxSvcProcess);
1209	self.oVBoxSvcProcess.enableCrashReporting(None, None); # Disables it.
1210
1211	fRc = False;
1212	if self.oVBoxSvcProcess is not None \
1213	and not self.fVBoxSvcInDebugger:
1214	# by process object.
1215	if self.oVBoxSvcProcess.isRunning():
1216	reporter.log('Dropping VBoxSVC a SIGUSR1 hint...');
1217	if not self.oVBoxSvcProcess.sendUserSignal1() \
1218	or not self.oVBoxSvcProcess.wait(5000):
1219	reporter.log('Dropping VBoxSVC a SIGINT hint...');
1220	if not self.oVBoxSvcProcess.interrupt() \
1221	or not self.oVBoxSvcProcess.wait(5000):
1222	reporter.log('VBoxSVC is still around, killing it...');
1223	self.oVBoxSvcProcess.terminate();
1224	self.oVBoxSvcProcess.wait(7500);
1225	else:
1226	reporter.log('VBoxSVC is no longer running...');
1227	if not self.oVBoxSvcProcess.isRunning():
1228	self.oVBoxSvcProcess = None;
1229	else:
1230	# by pid file.
1231	self._killVBoxSVCByPidFile('%s/VBoxSVC.pid' % (self.sScratchPath,));
1232	return fRc;
1233
1234	def _setupVBoxApi(self):
1235	"""
1236	Import and set up the vboxapi.
1237	The caller saves and restores sys.path.
1238	"""
1239
1240	# Setup vbox logging for self (the test driver).
1241	self.sSelfLogFile = '%s/VBoxTestDriver.log' % (self.sScratchPath,);
1242	try: os.remove(self.sSelfLogFile);
1243	except: pass;
1244	os.environ['VBOX_LOG'] = self.sLogSelfGroups;
1245	os.environ['VBOX_LOG_FLAGS'] = '%s append' % (self.sLogSelfFlags, );
1246	if self.sLogSelfDest:
1247	os.environ['VBOX_LOG_DEST'] = self.sLogSelfDest;
1248	else:
1249	os.environ['VBOX_LOG_DEST'] = 'file=%s' % (self.sSelfLogFile,);
1250	os.environ['VBOX_RELEASE_LOG_FLAGS'] = 'time append';
1251
1252	# Hack the sys.path + environment so the vboxapi can be found.
1253	sys.path.insert(0, self.oBuild.sInstallPath);
1254	if self.oBuild.sSdkPath is not None:
1255	sys.path.insert(0, os.path.join(self.oBuild.sSdkPath, 'installer'))
1256	sys.path.insert(1, os.path.join(self.oBuild.sSdkPath, 'bindings', 'xpcom', 'python'))
1257	os.environ['VBOX_PROGRAM_PATH'] = self.oBuild.sInstallPath;
1258	reporter.log("sys.path: %s" % (sys.path));
1259
1260	try:
1261	# pylint: disable=F0401
1262	from vboxapi import VirtualBoxManager
1263	if self.sHost == 'win':
1264	from pythoncom import com_error as NativeComExceptionClass # pylint: disable=E0611
1265	import winerror as NativeComErrorClass
1266	else:
1267	from xpcom import Exception as NativeComExceptionClass
1268	from xpcom import nsError as NativeComErrorClass
1269	# pylint: enable=F0401
1270	except:
1271	traceback.print_exc();
1272	return False;
1273
1274	__deployExceptionHacks__(NativeComExceptionClass)
1275	ComError.copyErrors(NativeComErrorClass);
1276
1277	# Create the manager.
1278	try:
1279	self.oVBoxMgr = VirtualBoxManager(None, None)
1280	except:
1281	self.oVBoxMgr = None;
1282	reporter.logXcpt('VirtualBoxManager exception');
1283	return False;
1284	reporter.log("oVBoxMgr=%s" % (self.oVBoxMgr,)); # Temporary - debugging hang somewhere after 'sys.path' log line above.
1285
1286	# Figure the API version.
1287	try:
1288	oVBox = self.oVBoxMgr.getVirtualBox();
1289	reporter.log("oVBox=%s" % (oVBox,)); # Temporary - debugging hang somewhere after 'sys.path' log line above.
1290	try:
1291	sVer = oVBox.version;
1292	except:
1293	reporter.logXcpt('Failed to get VirtualBox version, assuming 4.0.0');
1294	sVer = "4.0.0";
1295	reporter.log("sVer=%s" % (sVer,)); # Temporary - debugging hang somewhere after 'sys.path' log line above.
1296	if sVer.startswith("5.1"):
1297	self.fpApiVer = 5.1;
1298	elif sVer.startswith("5.0") or (sVer.startswith("4.3.5") and len(sVer) == 6):
1299	self.fpApiVer = 5.0;
1300	elif sVer.startswith("4.3") or (sVer.startswith("4.2.5") and len(sVer) == 6):
1301	self.fpApiVer = 4.3;
1302	elif sVer.startswith("4.2."):
1303	self.fpApiVer = 4.2; ## @todo Fudge: Add (proper) 4.2 API support. Unmount medium etc?
1304	elif sVer.startswith("4.1.") or (sVer.startswith("4.0.5") and len(sVer) == 6):
1305	self.fpApiVer = 4.1;
1306	elif sVer.startswith("4.0."):
1307	self.fpApiVer = 4.0;
1308	elif sVer.startswith("3.2."):
1309	self.fpApiVer = 3.2;
1310	elif sVer.startswith("3.1."):
1311	self.fpApiVer = 3.1;
1312	elif sVer.startswith("3.0."):
1313	self.fpApiVer = 3.0;
1314	else:
1315	raise base.GenError('Unknown version "%s"' % (sVer,));
1316
1317	self._patchVBoxMgr();
1318
1319	from testdriver.vboxwrappers import VirtualBoxWrapper;
1320	self.oVBox = VirtualBoxWrapper(oVBox, self.oVBoxMgr, self.fpApiVer, self);
1321	vboxcon.goHackModuleClass.oVBoxMgr = self.oVBoxMgr; # VBoxConstantWrappingHack.
1322	vboxcon.fpApiVer = self.fpApiVer
1323	self.fImportedVBoxApi = True;
1324	reporter.log('Found version %s (%s)' % (self.fpApiVer, sVer));
1325	except:
1326	self.oVBoxMgr = None;
1327	self.oVBox = None;
1328	reporter.logXcpt("getVirtualBox exception");
1329	return False;
1330	return True;
1331
1332	def _patchVBoxMgr(self):
1333	"""
1334	Glosses over missing self.oVBoxMgr methods on older VBox versions.
1335	"""
1336
1337	def _xcptGetResult(oSelf, oXcpt = None):
1338	""" See vboxapi. """
1339	_ = oSelf;
1340	if oXcpt is None: oXcpt = sys.exc_info()[1];
1341	if sys.platform == 'win32':
1342	import winerror; # pylint: disable=F0401
1343	hrXcpt = oXcpt.hresult;
1344	if hrXcpt == winerror.DISP_E_EXCEPTION:
1345	hrXcpt = oXcpt.excepinfo[5];
1346	else:
1347	hrXcpt = oXcpt.error;
1348	return hrXcpt;
1349
1350	def _xcptIsDeadInterface(oSelf, oXcpt = None):
1351	""" See vboxapi. """
1352	return oSelf.xcptGetStatus(oXcpt) in [
1353	0x80004004, -2147467260, # NS_ERROR_ABORT
1354	0x800706be, -2147023170, # NS_ERROR_CALL_FAILED (RPC_S_CALL_FAILED)
1355	0x800706ba, -2147023174, # RPC_S_SERVER_UNAVAILABLE.
1356	0x800706be, -2147023170, # RPC_S_CALL_FAILED.
1357	0x800706bf, -2147023169, # RPC_S_CALL_FAILED_DNE.
1358	0x80010108, -2147417848, # RPC_E_DISCONNECTED.
1359	0x800706b5, -2147023179, # RPC_S_UNKNOWN_IF
1360	];
1361
1362	def _xcptIsOurXcptKind(oSelf, oXcpt = None):
1363	""" See vboxapi. """
1364	_ = oSelf;
1365	if oXcpt is None: oXcpt = sys.exc_info()[1];
1366	if sys.platform == 'win32':
1367	from pythoncom import com_error as NativeComExceptionClass # pylint: disable=F0401,E0611
1368	else:
1369	from xpcom import Exception as NativeComExceptionClass # pylint: disable=F0401
1370	return isinstance(oXcpt, NativeComExceptionClass);
1371
1372	def _xcptIsEqual(oSelf, oXcpt, hrStatus):
1373	""" See vboxapi. """
1374	hrXcpt = oSelf.xcptGetResult(oXcpt);
1375	return hrXcpt == hrStatus or hrXcpt == hrStatus - 0x100000000;
1376
1377	def _xcptToString(oSelf, oXcpt):
1378	""" See vboxapi. """
1379	_ = oSelf;
1380	if oXcpt is None: oXcpt = sys.exc_info()[1];
1381	return str(oXcpt);
1382
1383	# Add utilities found in newer vboxapi revision.
1384	if not hasattr(self.oVBoxMgr, 'xcptIsDeadInterface'):
1385	import types;
1386	self.oVBoxMgr.xcptGetResult = types.MethodType(_xcptGetResult, self.oVBoxMgr);
1387	self.oVBoxMgr.xcptIsDeadInterface = types.MethodType(_xcptIsDeadInterface, self.oVBoxMgr);
1388	self.oVBoxMgr.xcptIsOurXcptKind = types.MethodType(_xcptIsOurXcptKind, self.oVBoxMgr);
1389	self.oVBoxMgr.xcptIsEqual = types.MethodType(_xcptIsEqual, self.oVBoxMgr);
1390	self.oVBoxMgr.xcptToString = types.MethodType(_xcptToString, self.oVBoxMgr);
1391
1392
1393	def _teardownVBoxApi(self):
1394	"""
1395	Drop all VBox object references and shutdown com/xpcom.
1396	"""
1397	if not self.fImportedVBoxApi:
1398	return True;
1399
1400	self.aoRemoteSessions = [];
1401	self.aoVMs = [];
1402	self.oVBoxMgr = None;
1403	self.oVBox = None;
1404
1405	try:
1406	import gc
1407	gc.collect();
1408	except:
1409	reporter.logXcpt();
1410	self.fImportedVBoxApi = False;
1411
1412	if self.sHost == 'win':
1413	pass; ## TODO shutdown COM if possible/necessary?
1414	else:
1415	try:
1416	from xpcom import _xpcom as _xpcom; # pylint: disable=F0401
1417	hrc = _xpcom.NS_ShutdownXPCOM();
1418	cIfs = _xpcom._GetInterfaceCount(); # pylint: disable=W0212
1419	cObjs = _xpcom._GetGatewayCount(); # pylint: disable=W0212
1420	if cObjs == 0 and cIfs == 0:
1421	reporter.log('actionCleanupAfter: NS_ShutdownXPCOM -> %s, nothing left behind.' % (hrc, ));
1422	else:
1423	reporter.log('actionCleanupAfter: NS_ShutdownXPCOM -> %s, leaving %s objects and %s interfaces behind...' \
1424	% (hrc, cObjs, cIfs));
1425	if hasattr(_xpcom, '_DumpInterfaces'):
1426	try:
1427	_xpcom._DumpInterfaces(); # pylint: disable=W0212
1428	except:
1429	reporter.logXcpt('actionCleanupAfter: _DumpInterfaces failed');
1430	except:
1431	reporter.logXcpt();
1432
1433	try:
1434	gc.collect();
1435	time.sleep(0.5); # fudge factory
1436	except:
1437	reporter.logXcpt();
1438	return True;
1439
1440	def _powerOffAllVms(self):
1441	"""
1442	Tries to power off all running VMs.
1443	"""
1444	for oSession in self.aoRemoteSessions:
1445	uPid = oSession.getPid();
1446	if uPid is not None:
1447	reporter.log('_powerOffAllVms: PID is %s for %s, trying to kill it.' % (uPid, oSession.sName,));
1448	base.processKill(uPid);
1449	else:
1450	reporter.log('_powerOffAllVms: No PID for %s' % (oSession.sName,));
1451	oSession.close();
1452	return None;
1453
1454
1455
1456	#
1457	# Build type, OS and arch getters.
1458	#
1459
1460	def getBuildType(self):
1461	"""
1462	Get the build type.
1463	"""
1464	if not self._detectBuild():
1465	return 'release';
1466	return self.oBuild.sType;
1467
1468	def getBuildOs(self):
1469	"""
1470	Get the build OS.
1471	"""
1472	if not self._detectBuild():
1473	return self.sHost;
1474	return self.oBuild.sOs;
1475
1476	def getBuildArch(self):
1477	"""
1478	Get the build arch.
1479	"""
1480	if not self._detectBuild():
1481	return self.sHostArch;
1482	return self.oBuild.sArch;
1483
1484	def getGuestAdditionsIso(self):
1485	"""
1486	Get the path to the guest addition iso.
1487	"""
1488	if not self._detectBuild():
1489	return None;
1490	return self.oBuild.sGuestAdditionsIso;
1491
1492	#
1493	# Override everything from the base class so the testdrivers don't have to
1494	# check whether we have overridden a method or not.
1495	#
1496
1497	def showUsage(self):
1498	rc = base.TestDriver.showUsage(self);
1499	reporter.log('');
1500	reporter.log('Generic VirtualBox Options:');
1501	reporter.log(' --vbox-session-type <type>');
1502	reporter.log(' Sets the session type. Typical values are: gui, headless, sdl');
1503	reporter.log(' Default: %s' % (self.sSessionTypeDef));
1504	reporter.log(' --vrdp, --no-vrdp');
1505	reporter.log(' Enables VRDP, ports starting at 6000');
1506	reporter.log(' Default: --vrdp');
1507	reporter.log(' --vrdp-base-port <port>');
1508	reporter.log(' Sets the base for VRDP port assignments.');
1509	reporter.log(' Default: %s' % (self.uVrdpBasePortDef));
1510	reporter.log(' --vbox-default-bridged-nic <interface>');
1511	reporter.log(' Sets the default interface for bridged networking.');
1512	reporter.log(' Default: autodetect');
1513	reporter.log(' --vbox-use-svc-defaults');
1514	reporter.log(' Use default locations and files for VBoxSVC. This is useful');
1515	reporter.log(' for automatically configuring the test VMs for debugging.');
1516	reporter.log(' --vbox-self-log');
1517	reporter.log(' The VBox logger group settings for the testdriver.');
1518	reporter.log(' --vbox-self-log-flags');
1519	reporter.log(' The VBox logger flags settings for the testdriver.');
1520	reporter.log(' --vbox-self-log-dest');
1521	reporter.log(' The VBox logger destination settings for the testdriver.');
1522	reporter.log(' --vbox-session-log');
1523	reporter.log(' The VM session logger group settings.');
1524	reporter.log(' --vbox-session-log-flags');
1525	reporter.log(' The VM session logger flags.');
1526	reporter.log(' --vbox-session-log-dest');
1527	reporter.log(' The VM session logger destination settings.');
1528	reporter.log(' --vbox-svc-log');
1529	reporter.log(' The VBoxSVC logger group settings.');
1530	reporter.log(' --vbox-svc-log-flags');
1531	reporter.log(' The VBoxSVC logger flag settings.');
1532	reporter.log(' --vbox-svc-log-dest');
1533	reporter.log(' The VBoxSVC logger destination settings.');
1534	reporter.log(' --vbox-log');
1535	reporter.log(' The VBox logger group settings for everyone.');
1536	reporter.log(' --vbox-log-flags');
1537	reporter.log(' The VBox logger flags settings for everyone.');
1538	reporter.log(' --vbox-log-dest');
1539	reporter.log(' The VBox logger destination settings for everyone.');
1540	reporter.log(' --vbox-svc-debug');
1541	reporter.log(' Start VBoxSVC in a debugger');
1542	reporter.log(' --vbox-always-upload-logs');
1543	reporter.log(' Whether to always upload log files, or only do so on failure.');
1544	reporter.log(' --vbox-always-upload-screenshots');
1545	reporter.log(' Whether to always upload final screen shots, or only do so on failure.');
1546	reporter.log(' --vbox-debugger, --no-vbox-debugger');
1547	reporter.log(' Enables the VBox debugger, port at 5000');
1548	reporter.log(' Default: --vbox-debugger');
1549	if self.oTestVmSet is not None:
1550	self.oTestVmSet.showUsage();
1551	return rc;
1552
1553	def parseOption(self, asArgs, iArg): # pylint: disable=R0915
1554	if asArgs[iArg] == '--vbox-session-type':
1555	iArg += 1;
1556	if iArg >= len(asArgs):
1557	raise base.InvalidOption('The "--vbox-session-type" takes an argument');
1558	self.sSessionType = asArgs[iArg];
1559	elif asArgs[iArg] == '--vrdp':
1560	self.fEnableVrdp = True;
1561	elif asArgs[iArg] == '--no-vrdp':
1562	self.fEnableVrdp = False;
1563	elif asArgs[iArg] == '--vrdp-base-port':
1564	iArg += 1;
1565	if iArg >= len(asArgs):
1566	raise base.InvalidOption('The "--vrdp-base-port" takes an argument');
1567	try: self.uVrdpBasePort = int(asArgs[iArg]);
1568	except: raise base.InvalidOption('The "--vrdp-base-port" value "%s" is not a valid integer' % (asArgs[iArg],));
1569	if self.uVrdpBasePort <= 0 or self.uVrdpBasePort >= 65530:
1570	raise base.InvalidOption('The "--vrdp-base-port" value "%s" is not in the valid range (1..65530)'
1571	% (asArgs[iArg],));
1572	elif asArgs[iArg] == '--vbox-default-bridged-nic':
1573	iArg += 1;
1574	if iArg >= len(asArgs):
1575	raise base.InvalidOption('The "--vbox-default-bridged-nic" takes an argument');
1576	self.sDefBridgedNic = asArgs[iArg];
1577	elif asArgs[iArg] == '--vbox-use-svc-defaults':
1578	self.fUseDefaultSvc = True;
1579	elif asArgs[iArg] == '--vbox-self-log':
1580	iArg += 1;
1581	if iArg >= len(asArgs):
1582	raise base.InvalidOption('The "--vbox-self-log" takes an argument');
1583	self.sLogSelfGroups = asArgs[iArg];
1584	elif asArgs[iArg] == '--vbox-self-log-flags':
1585	iArg += 1;
1586	if iArg >= len(asArgs):
1587	raise base.InvalidOption('The "--vbox-self-log-flags" takes an argument');
1588	self.sLogSelfFlags = asArgs[iArg];
1589	elif asArgs[iArg] == '--vbox-self-log-dest':
1590	iArg += 1;
1591	if iArg >= len(asArgs):
1592	raise base.InvalidOption('The "--vbox-self-log-dest" takes an argument');
1593	self.sLogSelfDest = asArgs[iArg];
1594	elif asArgs[iArg] == '--vbox-session-log':
1595	iArg += 1;
1596	if iArg >= len(asArgs):
1597	raise base.InvalidOption('The "--vbox-session-log" takes an argument');
1598	self.sLogSessionGroups = asArgs[iArg];
1599	elif asArgs[iArg] == '--vbox-session-log-flags':
1600	iArg += 1;
1601	if iArg >= len(asArgs):
1602	raise base.InvalidOption('The "--vbox-session-log-flags" takes an argument');
1603	self.sLogSessionFlags = asArgs[iArg];
1604	elif asArgs[iArg] == '--vbox-session-log-dest':
1605	iArg += 1;
1606	if iArg >= len(asArgs):
1607	raise base.InvalidOption('The "--vbox-session-log-dest" takes an argument');
1608	self.sLogSessionDest = asArgs[iArg];
1609	elif asArgs[iArg] == '--vbox-svc-log':
1610	iArg += 1;
1611	if iArg >= len(asArgs):
1612	raise base.InvalidOption('The "--vbox-svc-log" takes an argument');
1613	self.sLogSvcGroups = asArgs[iArg];
1614	elif asArgs[iArg] == '--vbox-svc-log-flags':
1615	iArg += 1;
1616	if iArg >= len(asArgs):
1617	raise base.InvalidOption('The "--vbox-svc-log-flags" takes an argument');
1618	self.sLogSvcFlags = asArgs[iArg];
1619	elif asArgs[iArg] == '--vbox-svc-log-dest':
1620	iArg += 1;
1621	if iArg >= len(asArgs):
1622	raise base.InvalidOption('The "--vbox-svc-log-dest" takes an argument');
1623	self.sLogSvcDest = asArgs[iArg];
1624	elif asArgs[iArg] == '--vbox-log':
1625	iArg += 1;
1626	if iArg >= len(asArgs):
1627	raise base.InvalidOption('The "--vbox-log" takes an argument');
1628	self.sLogSelfGroups = asArgs[iArg];
1629	self.sLogSessionGroups = asArgs[iArg];
1630	self.sLogSvcGroups = asArgs[iArg];
1631	elif asArgs[iArg] == '--vbox-log-flags':
1632	iArg += 1;
1633	if iArg >= len(asArgs):
1634	raise base.InvalidOption('The "--vbox-svc-flags" takes an argument');
1635	self.sLogSelfFlags = asArgs[iArg];
1636	self.sLogSessionFlags = asArgs[iArg];
1637	self.sLogSvcFlags = asArgs[iArg];
1638	elif asArgs[iArg] == '--vbox-log-dest':
1639	iArg += 1;
1640	if iArg >= len(asArgs):
1641	raise base.InvalidOption('The "--vbox-log-dest" takes an argument');
1642	self.sLogSelfDest = asArgs[iArg];
1643	self.sLogSessionDest = asArgs[iArg];
1644	self.sLogSvcDest = asArgs[iArg];
1645	elif asArgs[iArg] == '--vbox-svc-debug':
1646	self.fVBoxSvcInDebugger = True;
1647	elif asArgs[iArg] == '--vbox-always-upload-logs':
1648	self.fAlwaysUploadLogs = True;
1649	elif asArgs[iArg] == '--vbox-always-upload-screenshots':
1650	self.fAlwaysUploadScreenshots = True;
1651	elif asArgs[iArg] == '--vbox-debugger':
1652	self.fEnableDebugger = True;
1653	elif asArgs[iArg] == '--no-vbox-debugger':
1654	self.fEnableDebugger = False;
1655	else:
1656	# Relevant for selecting VMs to test?
1657	if self.oTestVmSet is not None:
1658	iRc = self.oTestVmSet.parseOption(asArgs, iArg);
1659	if iRc != iArg:
1660	return iRc;
1661
1662	# Hand it to the base class.
1663	return base.TestDriver.parseOption(self, asArgs, iArg);
1664	return iArg + 1;
1665
1666	def completeOptions(self):
1667	return base.TestDriver.completeOptions(self);
1668
1669	def getResourceSet(self):
1670	if self.oTestVmSet is not None:
1671	return self.oTestVmSet.getResourceSet();
1672	return base.TestDriver.getResourceSet(self);
1673
1674	def actionExtract(self):
1675	return base.TestDriver.actionExtract(self);
1676
1677	def actionVerify(self):
1678	return base.TestDriver.actionVerify(self);
1679
1680	def actionConfig(self):
1681	return base.TestDriver.actionConfig(self);
1682
1683	def actionExecute(self):
1684	return base.TestDriver.actionExecute(self);
1685
1686	def actionCleanupBefore(self):
1687	"""
1688	Kill any VBoxSVC left behind by a previous test run.
1689	"""
1690	self._killVBoxSVCByPidFile('%s/VBoxSVC.pid' % (self.sScratchPath,));
1691	return base.TestDriver.actionCleanupBefore(self);
1692
1693	def actionCleanupAfter(self):
1694	"""
1695	Clean up the VBox bits and then call the base driver.
1696
1697	If your test driver overrides this, it should normally call us at the
1698	end of the job.
1699	"""
1700
1701	# Kill any left over VM processes.
1702	self._powerOffAllVms();
1703
1704	# Drop all VBox object references and shutdown xpcom then
1705	# terminating VBoxSVC, with extreme prejudice if need be.
1706	self._teardownVBoxApi();
1707	self._stopVBoxSVC();
1708
1709	# Add the VBoxSVC and testdriver debug+release log files.
1710	if self.fAlwaysUploadLogs or reporter.getErrorCount() > 0:
1711	if self.sVBoxSvcLogFile is not None and os.path.isfile(self.sVBoxSvcLogFile):
1712	reporter.addLogFile(self.sVBoxSvcLogFile, 'log/debug/svc', 'Debug log file for VBoxSVC');
1713	self.sVBoxSvcLogFile = None;
1714
1715	if self.sSelfLogFile is not None and os.path.isfile(self.sSelfLogFile):
1716	reporter.addLogFile(self.sSelfLogFile, 'log/debug/client', 'Debug log file for the test driver');
1717	self.sSelfLogFile = None;
1718
1719	sVBoxSvcRelLog = os.path.join(self.sScratchPath, 'VBoxUserHome', 'VBoxSVC.log');
1720	if os.path.isfile(sVBoxSvcRelLog):
1721	reporter.addLogFile(sVBoxSvcRelLog, 'log/release/svc', 'Release log file for VBoxSVC');
1722	for sSuff in [ '.1', '.2', '.3', '.4', '.5', '.6', '.7', '.8' ]:
1723	if os.path.isfile(sVBoxSvcRelLog + sSuff):
1724	reporter.addLogFile(sVBoxSvcRelLog + sSuff, 'log/release/svc', 'Release log file for VBoxSVC');
1725	# Testbox debugging - START - TEMPORARY, REMOVE ASAP.
1726	if self.sHost in ('darwin', 'freebsd', 'linux', 'solaris', ):
1727	try:
1728	print '> ls -la %s' % (os.path.join(self.sScratchPath, 'VBoxUserHome'),);
1729	utils.processCall(['ls', '-la', os.path.join(self.sScratchPath, 'VBoxUserHome')]);
1730	print '> ls -la %s' % (self.sScratchPath,);
1731	utils.processCall(['ls', '-la', self.sScratchPath]);
1732	except: pass;
1733	# Testbox debugging - END - TEMPORARY, REMOVE ASAP.
1734
1735	# Finally, call the base driver to wipe the scratch space.
1736	return base.TestDriver.actionCleanupAfter(self);
1737
1738	def actionAbort(self):
1739	"""
1740	Terminate VBoxSVC if we've got a pid file.
1741	"""
1742	self._killVBoxSVCByPidFile('%s/VBoxSVC.pid' % (self.sScratchPath,));
1743	return base.TestDriver.actionAbort(self);
1744
1745	def onExit(self, iRc):
1746	"""
1747	Stop VBoxSVC if we've started it.
1748	"""
1749	if self.oVBoxSvcProcess is not None:
1750	reporter.log('*** Shutting down the VBox API... (iRc=%s)' % (iRc,));
1751	self._powerOffAllVms();
1752	self._teardownVBoxApi();
1753	self._stopVBoxSVC();
1754	reporter.log('*** VBox API shutdown done.');
1755	return base.TestDriver.onExit(self, iRc);
1756
1757
1758	#
1759	# Task wait method override.
1760	#
1761
1762	def notifyAboutReadyTask(self, oTask):
1763	"""
1764	Overriding base.TestDriver.notifyAboutReadyTask.
1765	"""
1766	try:
1767	self.oVBoxMgr.interruptWaitEvents();
1768	reporter.log2('vbox.notifyAboutReadyTask: called interruptWaitEvents');
1769	except:
1770	reporter.logXcpt('vbox.notifyAboutReadyTask');
1771	return base.TestDriver.notifyAboutReadyTask(self, oTask);
1772
1773	def waitForTasksSleepWorker(self, cMsTimeout):
1774	"""
1775	Overriding base.TestDriver.waitForTasksSleepWorker.
1776	"""
1777	try:
1778	rc = self.oVBoxMgr.waitForEvents(int(cMsTimeout));
1779	_ = rc; #reporter.log2('vbox.waitForTasksSleepWorker(%u): true (waitForEvents -> %s)' % (cMsTimeout, rc));
1780	reporter.doPollWork('vbox.TestDriver.waitForTasksSleepWorker');
1781	return True;
1782	except KeyboardInterrupt:
1783	raise;
1784	except:
1785	reporter.logXcpt('vbox.waitForTasksSleepWorker');
1786	return False;
1787
1788	#
1789	# Utility methods.
1790	#
1791
1792	def processEvents(self, cMsTimeout = 0):
1793	"""
1794	Processes events, returning after the first batch has been processed
1795	or the time limit has been reached.
1796
1797	Only Ctrl-C exception, no return.
1798	"""
1799	try:
1800	self.oVBoxMgr.waitForEvents(cMsTimeout);
1801	except KeyboardInterrupt:
1802	raise;
1803	except:
1804	pass;
1805	return None;
1806
1807	def processPendingEvents(self):
1808	""" processEvents(0) - no waiting. """
1809	return self.processEvents(0);
1810
1811	def sleep(self, cSecs):
1812	"""
1813	Sleep for a specified amount of time, processing XPCOM events all the while.
1814	"""
1815	cMsTimeout = long(cSecs * 1000);
1816	msStart = base.timestampMilli();
1817	self.processEvents(0);
1818	while True:
1819	cMsElapsed = base.timestampMilli() - msStart;
1820	if cMsElapsed > cMsTimeout:
1821	break;
1822	#reporter.log2('cMsTimeout=%s - cMsElapsed=%d => %s' % (cMsTimeout, cMsElapsed, cMsTimeout - cMsElapsed));
1823	self.processEvents(cMsTimeout - cMsElapsed);
1824	return None;
1825
1826	def _logVmInfoUnsafe(self, oVM): # pylint: disable=R0915,R0912
1827	"""
1828	Internal worker for logVmInfo that is wrapped in try/except.
1829
1830	This is copy, paste, search, replace and edit of infoCmd from vboxshell.py.
1831	"""
1832	oOsType = self.oVBox.getGuestOSType(oVM.OSTypeId)
1833	reporter.log(" Name: %s" % (oVM.name));
1834	reporter.log(" ID: %s" % (oVM.id));
1835	reporter.log(" OS Type: %s - %s" % (oVM.OSTypeId, oOsType.description));
1836	reporter.log(" Machine state: %s" % (oVM.state));
1837	reporter.log(" Session state: %s" % (oVM.sessionState));
1838	if self.fpApiVer >= 4.2:
1839	reporter.log(" Session PID: %u (%#x)" % (oVM.sessionPID, oVM.sessionPID));
1840	else:
1841	reporter.log(" Session PID: %u (%#x)" % (oVM.sessionPid, oVM.sessionPid));
1842	if self.fpApiVer >= 5.0:
1843	reporter.log(" Session Name: %s" % (oVM.sessionName));
1844	else:
1845	reporter.log(" Session Name: %s" % (oVM.sessionType));
1846	reporter.log(" CPUs: %s" % (oVM.CPUCount));
1847	reporter.log(" RAM: %sMB" % (oVM.memorySize));
1848	reporter.log(" VRAM: %sMB" % (oVM.VRAMSize));
1849	reporter.log(" Monitors: %s" % (oVM.monitorCount));
1850	if oVM.firmwareType == vboxcon.FirmwareType_BIOS: sType = "BIOS";
1851	elif oVM.firmwareType == vboxcon.FirmwareType_EFI: sType = "EFI";
1852	elif oVM.firmwareType == vboxcon.FirmwareType_EFI32: sType = "EFI32";
1853	elif oVM.firmwareType == vboxcon.FirmwareType_EFI64: sType = "EFI64";
1854	elif oVM.firmwareType == vboxcon.FirmwareType_EFIDUAL: sType = "EFIDUAL";
1855	else: sType = "unknown %s" % (oVM.firmwareType);
1856	reporter.log(" Firmware: %s" % (sType));
1857	reporter.log(" HwVirtEx: %s" % (oVM.getHWVirtExProperty(vboxcon.HWVirtExPropertyType_Enabled)));
1858	reporter.log(" VPID support: %s" % (oVM.getHWVirtExProperty(vboxcon.HWVirtExPropertyType_VPID)));
1859	reporter.log(" Nested paging: %s" % (oVM.getHWVirtExProperty(vboxcon.HWVirtExPropertyType_NestedPaging)));
1860	if self.fpApiVer >= 4.2 and hasattr(vboxcon, 'CPUPropertyType_LongMode'):
1861	reporter.log(" Long-mode: %s" % (oVM.getCPUProperty(vboxcon.CPUPropertyType_LongMode)));
1862	if self.fpApiVer >= 3.2:
1863	reporter.log(" PAE: %s" % (oVM.getCPUProperty(vboxcon.CPUPropertyType_PAE)));
1864	if self.fpApiVer < 5.0:
1865	reporter.log(" Synthetic CPU: %s" % (oVM.getCPUProperty(vboxcon.CPUPropertyType_Synthetic)));
1866	else:
1867	reporter.log(" PAE: %s" % (oVM.getCpuProperty(vboxcon.CpuPropertyType_PAE)));
1868	reporter.log(" Synthetic CPU: %s" % (oVM.getCpuProperty(vboxcon.CpuPropertyType_Synthetic)));
1869	reporter.log(" ACPI: %s" % (oVM.BIOSSettings.ACPIEnabled));
1870	reporter.log(" IO-APIC: %s" % (oVM.BIOSSettings.IOAPICEnabled));
1871	if self.fpApiVer >= 3.2:
1872	if self.fpApiVer >= 4.2:
1873	reporter.log(" HPET: %s" % (oVM.HPETEnabled));
1874	else:
1875	reporter.log(" HPET: %s" % (oVM.hpetEnabled));
1876	reporter.log(" 3D acceleration: %s" % (oVM.accelerate3DEnabled));
1877	reporter.log(" 2D acceleration: %s" % (oVM.accelerate2DVideoEnabled));
1878	reporter.log(" TeleporterEnabled: %s" % (oVM.teleporterEnabled));
1879	reporter.log(" TeleporterPort: %s" % (oVM.teleporterPort));
1880	reporter.log(" TeleporterAddress: %s" % (oVM.teleporterAddress));
1881	reporter.log(" TeleporterPassword: %s" % (oVM.teleporterPassword));
1882	reporter.log(" Clipboard mode: %s" % (oVM.clipboardMode));
1883	if self.fpApiVer >= 5.0:
1884	reporter.log(" Drag and drop mode: %s" % (oVM.dnDMode));
1885	elif self.fpApiVer >= 4.3:
1886	reporter.log(" Drag and drop mode: %s" % (oVM.dragAndDropMode));
1887	if self.fpApiVer >= 4.0:
1888	reporter.log(" VRDP server: %s" % (oVM.VRDEServer.enabled));
1889	try: sPorts = oVM.VRDEServer.getVRDEProperty("TCP/Ports");
1890	except: sPorts = "";
1891	reporter.log(" VRDP server ports: %s" % (sPorts));
1892	reporter.log(" VRDP auth: %s (%s)" % (oVM.VRDEServer.authType, oVM.VRDEServer.authLibrary));
1893	else:
1894	reporter.log(" VRDP server: %s" % (oVM.VRDPServer.enabled));
1895	reporter.log(" VRDP server ports: %s" % (oVM.VRDPServer.ports));
1896	reporter.log(" Last changed: %s" % (oVM.lastStateChange));
1897
1898	aoControllers = self.oVBoxMgr.getArray(oVM, 'storageControllers')
1899	if aoControllers:
1900	reporter.log(" Controllers:");
1901	for oCtrl in aoControllers:
1902	reporter.log(" %s %s bus: %s type: %s" % (oCtrl.name, oCtrl.controllerType, oCtrl.bus, oCtrl.controllerType));
1903	oAudioAdapter = oVM.audioAdapter;
1904	if oAudioAdapter.audioController == vboxcon.AudioControllerType_AC97: sType = "AC97";
1905	elif oAudioAdapter.audioController == vboxcon.AudioControllerType_SB16: sType = "SB16";
1906	elif oAudioAdapter.audioController == vboxcon.AudioControllerType_HDA: sType = "HDA";
1907	else: sType = "unknown %s" % (oAudioAdapter.audioController);
1908	reporter.log(" AudioController: %s" % (sType));
1909	reporter.log(" AudioEnabled: %s" % (oAudioAdapter.enabled));
1910
1911	self.processPendingEvents();
1912	aoAttachments = self.oVBoxMgr.getArray(oVM, 'mediumAttachments')
1913	if aoAttachments:
1914	reporter.log(" Attachments:");
1915	for oAtt in aoAttachments:
1916	sCtrl = "Controller: %s port: %s device: %s type: %s" % (oAtt.controller, oAtt.port, oAtt.device, oAtt.type);
1917	oMedium = oAtt.medium
1918	if oAtt.type == vboxcon.DeviceType_HardDisk:
1919	reporter.log(" %s: HDD" % sCtrl);
1920	reporter.log(" Id: %s" % (oMedium.id));
1921	reporter.log(" Name: %s" % (oMedium.name));
1922	reporter.log(" Format: %s" % (oMedium.format));
1923	reporter.log(" Location: %s" % (oMedium.location));
1924
1925	if oAtt.type == vboxcon.DeviceType_DVD:
1926	reporter.log(" %s: DVD" % sCtrl);
1927	if oMedium:
1928	reporter.log(" Id: %s" % (oMedium.id));
1929	reporter.log(" Name: %s" % (oMedium.name));
1930	if oMedium.hostDrive:
1931	reporter.log(" Host DVD %s" % (oMedium.location));
1932	if oAtt.passthrough:
1933	reporter.log(" [passthrough mode]");
1934	else:
1935	reporter.log(" Virtual image: %s" % (oMedium.location));
1936	reporter.log(" Size: %s" % (oMedium.size));
1937	else:
1938	reporter.log(" empty");
1939
1940	if oAtt.type == vboxcon.DeviceType_Floppy:
1941	reporter.log(" %s: Floppy" % sCtrl);
1942	if oMedium:
1943	reporter.log(" Id: %s" % (oMedium.id));
1944	reporter.log(" Name: %s" % (oMedium.name));
1945	if oMedium.hostDrive:
1946	reporter.log(" Host floppy: %s" % (oMedium.location));
1947	else:
1948	reporter.log(" Virtual image: %s" % (oMedium.location));
1949	reporter.log(" Size: %s" % (oMedium.size));
1950	else:
1951	reporter.log(" empty");
1952	self.processPendingEvents();
1953
1954	reporter.log(" Network Adapter:");
1955	for iSlot in range(0, 32):
1956	try: oNic = oVM.getNetworkAdapter(iSlot)
1957	except: break;
1958	if not oNic.enabled:
1959	reporter.log2(" slot #%d found but not enabled, skipping" % (iSlot,));
1960	continue;
1961	if oNic.adapterType == vboxcon.NetworkAdapterType_Am79C973: sType = "PCNet";
1962	elif oNic.adapterType == vboxcon.NetworkAdapterType_Am79C970A: sType = "PCNetOld";
1963	elif oNic.adapterType == vboxcon.NetworkAdapterType_I82545EM: sType = "E1000";
1964	elif oNic.adapterType == vboxcon.NetworkAdapterType_I82540EM: sType = "E1000Desk";
1965	elif oNic.adapterType == vboxcon.NetworkAdapterType_I82543GC: sType = "E1000Srv2";
1966	elif oNic.adapterType == vboxcon.NetworkAdapterType_Virtio: sType = "Virtio";
1967	else: sType = "unknown %s" % (oNic.adapterType);
1968	reporter.log(" slot #%d: type: %s (%s) MAC Address: %s lineSpeed: %s" % \
1969	(iSlot, sType, oNic.adapterType, oNic.MACAddress, oNic.lineSpeed) );
1970
1971	if oNic.attachmentType == vboxcon.NetworkAttachmentType_NAT:
1972	reporter.log(" attachmentType: NAT (%s)" % (oNic.attachmentType));
1973	if self.fpApiVer >= 4.1:
1974	reporter.log(" nat-network: %s" % (oNic.NATNetwork,));
1975	elif oNic.attachmentType == vboxcon.NetworkAttachmentType_Bridged:
1976	reporter.log(" attachmentType: Bridged (%s)" % (oNic.attachmentType));
1977	if self.fpApiVer >= 4.1:
1978	reporter.log(" hostInterface: %s" % (oNic.bridgedInterface));
1979	else:
1980	reporter.log(" hostInterface: %s" % (oNic.hostInterface));
1981	elif oNic.attachmentType == vboxcon.NetworkAttachmentType_Internal:
1982	reporter.log(" attachmentType: Internal (%s)" % (oNic.attachmentType));
1983	reporter.log(" intnet-name: %s" % (oNic.internalNetwork,));
1984	elif oNic.attachmentType == vboxcon.NetworkAttachmentType_HostOnly:
1985	reporter.log(" attachmentType: HostOnly (%s)" % (oNic.attachmentType));
1986	if self.fpApiVer >= 4.1:
1987	reporter.log(" hostInterface: %s" % (oNic.hostOnlyInterface));
1988	else:
1989	reporter.log(" hostInterface: %s" % (oNic.hostInterface));
1990	else:
1991	if self.fpApiVer >= 4.1:
1992	if oNic.attachmentType == vboxcon.NetworkAttachmentType_Generic:
1993	reporter.log(" attachmentType: Generic (%s)" % (oNic.attachmentType));
1994	reporter.log(" generic-driver: %s" % (oNic.GenericDriver));
1995	else:
1996	reporter.log(" attachmentType: unknown-%s" % (oNic.attachmentType));
1997	else:
1998	reporter.log(" attachmentType: unknown-%s" % (oNic.attachmentType));
1999	if oNic.traceEnabled:
2000	reporter.log(" traceFile: %s" % (oNic.traceFile));
2001	self.processPendingEvents();
2002	return True;
2003
2004	def logVmInfo(self, oVM): # pylint: disable=R0915,R0912
2005	"""
2006	Logs VM configuration details.
2007
2008	This is copy, past, search, replace and edit of infoCmd from vboxshell.py.
2009	"""
2010	try:
2011	fRc = self._logVmInfoUnsafe(oVM);
2012	except:
2013	reporter.logXcpt();
2014	fRc = False;
2015	return fRc;
2016
2017	def logVmInfoByName(self, sName):
2018	"""
2019	logVmInfo + getVmByName.
2020	"""
2021	return self.logVmInfo(self.getVmByName(sName));
2022
2023	def tryFindGuestOsId(self, sIdOrDesc):
2024	"""
2025	Takes a guest OS ID or Description and returns the ID.
2026	If nothing matching it is found, the input is returned unmodified.
2027	"""
2028
2029	if self.fpApiVer >= 4.0:
2030	if sIdOrDesc == 'Solaris (64 bit)':
2031	sIdOrDesc = 'Oracle Solaris 10 5/09 and earlier (64 bit)';
2032
2033	try:
2034	aoGuestTypes = self.oVBoxMgr.getArray(self.oVBox, 'GuestOSTypes');
2035	except:
2036	reporter.logXcpt();
2037	else:
2038	for oGuestOS in aoGuestTypes:
2039	try:
2040	sId = oGuestOS.id;
2041	sDesc = oGuestOS.description;
2042	except:
2043	reporter.logXcpt();
2044	else:
2045	if sIdOrDesc == sId or sIdOrDesc == sDesc:
2046	sIdOrDesc = sId;
2047	break;
2048	self.processPendingEvents();
2049	return sIdOrDesc
2050
2051	def resourceFindVmHd(self, sVmName, sFlavor):
2052	"""
2053	Search the test resources for the most recent VM HD.
2054
2055	Returns path relative to the test resource root.
2056	"""
2057	## @todo implement a proper search algo here.
2058	return '4.2/' + sFlavor + '/' + sVmName + '/t-' + sVmName + '.vdi';
2059
2060
2061	#
2062	# VM Api wrappers that logs errors, hides exceptions and other details.
2063	#
2064
2065	# pylint: disable=R0913,R0914,R0915
2066	def createTestVM(self, sName, iGroup, sHd = None, cMbRam = None, cCpus = 1, fVirtEx = None, fNestedPaging = None, \
2067	sDvdImage = None, sKind = "Other", fIoApic = None, fPae = None, fFastBootLogo = True, \
2068	eNic0Type = None, eNic0AttachType = None, sNic0NetName = 'default', sNic0MacAddr = 'grouped', \
2069	sFloppy = None, fNatForwardingForTxs = None, sHddControllerType = 'IDE Controller', \
2070	fVmmDevTestingPart = None, fVmmDevTestingMmio = False, sFirmwareType = 'bios'):
2071	"""
2072	Creates a test VM with a immutable HD from the test resources.
2073	"""
2074	if not self.importVBoxApi():
2075	return None;
2076
2077	# create + register the VM
2078	try:
2079	if self.fpApiVer >= 4.2: # Introduces grouping (third parameter, empty for now).
2080	oVM = self.oVBox.createMachine("", sName, [], self.tryFindGuestOsId(sKind), "");
2081	elif self.fpApiVer >= 4.0:
2082	oVM = self.oVBox.createMachine("", sName, self.tryFindGuestOsId(sKind), "", False);
2083	elif self.fpApiVer >= 3.2:
2084	oVM = self.oVBox.createMachine(sName, self.tryFindGuestOsId(sKind), "", "", False);
2085	else:
2086	oVM = self.oVBox.createMachine(sName, self.tryFindGuestOsId(sKind), "", "");
2087	try:
2088	oVM.saveSettings();
2089	try:
2090	self.oVBox.registerMachine(oVM);
2091	except:
2092	raise;
2093	except:
2094	reporter.logXcpt();
2095	if self.fpApiVer >= 4.0:
2096	try:
2097	if self.fpApiVer >= 4.3:
2098	oProgress = oVM.deleteConfig([]);
2099	else:
2100	oProgress = oVM.delete(None);
2101	self.waitOnProgress(oProgress);
2102	except:
2103	reporter.logXcpt();
2104	else:
2105	try: oVM.deleteSettings();
2106	except: reporter.logXcpt();
2107	raise;
2108	except:
2109	reporter.errorXcpt('failed to create vm "%s"' % (sName));
2110	return None;
2111
2112	# Configure the VM.
2113	fRc = True;
2114	oSession = self.openSession(oVM);
2115	if oSession is not None:
2116	fRc = oSession.setupPreferredConfig();
2117
2118	if fRc and cMbRam is not None :
2119	fRc = oSession.setRamSize(cMbRam);
2120	if fRc and cCpus is not None:
2121	fRc = oSession.setCpuCount(cCpus);
2122	if fRc and fVirtEx is not None:
2123	fRc = oSession.enableVirtEx(fVirtEx);
2124	if fRc and fNestedPaging is not None:
2125	fRc = oSession.enableNestedPaging(fNestedPaging);
2126	if fRc and fIoApic is not None:
2127	fRc = oSession.enableIoApic(fIoApic);
2128	if fRc and fPae is not None:
2129	fRc = oSession.enablePae(fPae);
2130	if fRc and sDvdImage is not None:
2131	fRc = oSession.attachDvd(sDvdImage);
2132	if fRc and sHd is not None:
2133	fRc = oSession.attachHd(sHd, sHddControllerType);
2134	if fRc and sFloppy is not None:
2135	fRc = oSession.attachFloppy(sFloppy);
2136	if fRc and eNic0Type is not None:
2137	fRc = oSession.setNicType(eNic0Type, 0);
2138	if fRc and (eNic0AttachType is not None or (sNic0NetName is not None and sNic0NetName != 'default')):
2139	fRc = oSession.setNicAttachment(eNic0AttachType, sNic0NetName, 0);
2140	if fRc and sNic0MacAddr is not None:
2141	if sNic0MacAddr == 'grouped':
2142	sNic0MacAddr = '%02u' % (iGroup);
2143	fRc = oSession.setNicMacAddress(sNic0MacAddr, 0);
2144	if fRc and fNatForwardingForTxs is True:
2145	fRc = oSession.setupNatForwardingForTxs();
2146	if fRc and fFastBootLogo is not None:
2147	fRc = oSession.setupBootLogo(fFastBootLogo);
2148	if fRc and self.fEnableVrdp:
2149	fRc = oSession.setupVrdp(True, self.uVrdpBasePort + iGroup);
2150	if fRc and fVmmDevTestingPart is not None:
2151	fRc = oSession.enableVmmDevTestingPart(fVmmDevTestingPart, fVmmDevTestingMmio);
2152	if fRc and sFirmwareType == 'bios':
2153	fRc = oSession.setFirmwareType(vboxcon.FirmwareType_BIOS);
2154	elif sFirmwareType == 'efi':
2155	fRc = oSession.setFirmwareType(vboxcon.FirmwareType_EFI);
2156	if fRc and self.fEnableDebugger:
2157	fRc = oSession.setExtraData('VBoxInternal/DBGC/Enabled', '1');
2158
2159	if fRc: fRc = oSession.saveSettings();
2160	if not fRc: oSession.discardSettings(True);
2161	oSession.close();
2162	if not fRc:
2163	try: self.oVBox.unregisterMachine(oVM.id);
2164	except: pass;
2165	if self.fpApiVer >= 4.0:
2166	try:
2167	if self.fpApiVer >= 4.3:
2168	oProgress = oVM.deleteConfig([]);
2169	else:
2170	oProgress = oVM.delete(None);
2171	self.waitOnProgress(oProgress);
2172	except:
2173	reporter.logXcpt();
2174	else:
2175	try: oVM.deleteSettings();
2176	except: reporter.logXcpt();
2177	return None;
2178
2179	# success.
2180	reporter.log('created "%s" with name "%s"' % (oVM.id, sName));
2181	self.aoVMs.append(oVM);
2182	self.logVmInfo(oVM); # testing...
2183	return oVM;
2184	# pylint: enable=R0913,R0914,R0915
2185
2186	def addTestMachine(self, sNameOrId, fQuiet = False):
2187	"""
2188	Adds an already existing (that is, configured) test VM to the
2189	test VM list.
2190	"""
2191	# find + add the VM to the list.
2192	try:
2193	if self.fpApiVer >= 4.0:
2194	oVM = self.oVBox.findMachine(sNameOrId);
2195	else:
2196	reporter.error('Port me!'); ## @todo Add support for older version < 4.0.
2197	except:
2198	reporter.errorXcpt('could not find vm "%s"' % (sNameOrId,));
2199	return None;
2200
2201	self.aoVMs.append(oVM);
2202	if not fQuiet:
2203	reporter.log('Added "%s" with name "%s"' % (oVM.id, sNameOrId));
2204	self.logVmInfo(oVM);
2205	return oVM;
2206
2207	def openSession(self, oVM):
2208	"""
2209	Opens a session for the VM. Returns the a Session wrapper object that
2210	will automatically close the session when the wrapper goes out of scope.
2211
2212	On failure None is returned and an error is logged.
2213	"""
2214	try:
2215	sUuid = oVM.id;
2216	except:
2217	reporter.errorXcpt('failed to get the UUID for VM "%s"' % (oVM,));
2218	return None;
2219
2220	# This loop is a kludge to deal with us racing the closing of the
2221	# direct session of a previous VM run. See waitOnDirectSessionClose.
2222	for i in range(10):
2223	try:
2224	if self.fpApiVer <= 3.2:
2225	oSession = self.oVBoxMgr.openMachineSession(sUuid);
2226	else:
2227	oSession = self.oVBoxMgr.openMachineSession(oVM);
2228	break;
2229	except:
2230	if i == 9:
2231	reporter.errorXcpt('failed to open session for "%s" ("%s")' % (sUuid, oVM));
2232	return None;
2233	if i > 0:
2234	reporter.logXcpt('warning: failed to open session for "%s" ("%s") - retrying in %u secs' % (sUuid, oVM, i));
2235	self.waitOnDirectSessionClose(oVM, 5000 + i * 1000);
2236	from testdriver.vboxwrappers import SessionWrapper;
2237	return SessionWrapper(oSession, oVM, self.oVBox, self.oVBoxMgr, self, False);
2238
2239	def getVmByName(self, sName):
2240	"""
2241	Get a test VM by name. Returns None if not found, logged.
2242	"""
2243	# Look it up in our 'cache'.
2244	for oVM in self.aoVMs:
2245	try:
2246	#reporter.log2('cur: %s / %s (oVM=%s)' % (oVM.name, oVM.id, oVM));
2247	if oVM.name == sName:
2248	return oVM;
2249	except:
2250	reporter.errorXcpt('failed to get the name from the VM "%s"' % (oVM));
2251
2252	# Look it up the standard way.
2253	return self.addTestMachine(sName, fQuiet = True);
2254
2255	def getVmByUuid(self, sUuid):
2256	"""
2257	Get a test VM by uuid. Returns None if not found, logged.
2258	"""
2259	# Look it up in our 'cache'.
2260	for oVM in self.aoVMs:
2261	try:
2262	if oVM.id == sUuid:
2263	return oVM;
2264	except:
2265	reporter.errorXcpt('failed to get the UUID from the VM "%s"' % (oVM));
2266
2267	# Look it up the standard way.
2268	return self.addTestMachine(sUuid, fQuiet = True);
2269
2270	def waitOnProgress(self, oProgress, cMsTimeout = 1000000, fErrorOnTimeout = True, cMsInterval = 1000):
2271	"""
2272	Waits for a progress object to complete. Returns the status code.
2273	"""
2274	# Wait for progress no longer than cMsTimeout time period.
2275	tsStart = datetime.datetime.now()
2276	while True:
2277	self.processPendingEvents();
2278	try:
2279	if oProgress.completed:
2280	break;
2281	except:
2282	return -1;
2283	self.processPendingEvents();
2284
2285	tsNow = datetime.datetime.now()
2286	tsDelta = tsNow - tsStart
2287	if ((tsDelta.microseconds + tsDelta.seconds * 1000000) / 1000) > cMsTimeout:
2288	if fErrorOnTimeout:
2289	reporter.errorTimeout('Timeout while waiting for progress.')
2290	return -1
2291
2292	reporter.doPollWork('vbox.TestDriver.waitOnProgress');
2293	try: oProgress.waitForCompletion(cMsInterval);
2294	except: return -2;
2295
2296	try: rc = oProgress.resultCode;
2297	except: rc = -2;
2298	self.processPendingEvents();
2299	return rc;
2300
2301	def waitOnDirectSessionClose(self, oVM, cMsTimeout):
2302	"""
2303	Waits for the VM process to close it's current direct session.
2304
2305	Returns None.
2306	"""
2307	# Get the original values so we're not subject to
2308	try:
2309	eCurState = oVM.sessionState;
2310	if self.fpApiVer >= 5.0:
2311	sCurName = sOrgName = oVM.sessionName;
2312	else:
2313	sCurName = sOrgName = oVM.sessionType;
2314	if self.fpApiVer >= 4.2:
2315	iCurPid = iOrgPid = oVM.sessionPID;
2316	else:
2317	iCurPid = iOrgPid = oVM.sessionPid;
2318	except Exception, oXcpt:
2319	if ComError.notEqual(oXcpt, ComError.E_ACCESSDENIED):
2320	reporter.logXcpt();
2321	self.processPendingEvents();
2322	return None;
2323	self.processPendingEvents();
2324
2325	msStart = base.timestampMilli();
2326	while iCurPid == iOrgPid \
2327	and sCurName == sOrgName \
2328	and sCurName != '' \
2329	and base.timestampMilli() - msStart < cMsTimeout \
2330	and ( eCurState == vboxcon.SessionState_Unlocking \
2331	or eCurState == vboxcon.SessionState_Spawning \
2332	or eCurState == vboxcon.SessionState_Locked):
2333	self.processEvents(1000);
2334	try:
2335	eCurState = oVM.sessionState;
2336	sCurName = oVM.sessionName if self.fpApiVer >= 5.0 else oVM.sessionType;
2337	iCurPid = oVM.sessionPID if self.fpApiVer >= 4.2 else oVM.sessionPid;
2338	except Exception, oXcpt:
2339	if ComError.notEqual(oXcpt, ComError.E_ACCESSDENIED):
2340	reporter.logXcpt();
2341	break;
2342	self.processPendingEvents();
2343	self.processPendingEvents();
2344	return None;
2345
2346	def uploadStartupLogFile(self, oVM, sVmName):
2347	"""
2348	Uploads the VBoxStartup.log when present.
2349	"""
2350	fRc = True;
2351	try:
2352	sLogFile = os.path.join(oVM.logFolder, 'VBoxHardening.log');
2353	except:
2354	reporter.logXcpt();
2355	fRc = False;
2356	else:
2357	if os.path.isfile(sLogFile):
2358	reporter.addLogFile(sLogFile, 'log/release/vm', '%s hardening log' % (sVmName, ),
2359	sAltName = '%s-%s' % (sVmName, os.path.basename(sLogFile),));
2360	return fRc;
2361
2362	def startVmEx(self, oVM, fWait = True, sType = None, sName = None, asEnv = None): # pylint: disable=R0914,R0915
2363	"""
2364	Start the VM, returning the VM session and progress object on success.
2365	The session is also added to the task list and to the aoRemoteSessions set.
2366
2367	asEnv is a list of string on the putenv() form.
2368
2369	On failure (None, None) is returned and an error is logged.
2370	"""
2371	# Massage and check the input.
2372	if sType is None:
2373	sType = self.sSessionType;
2374	if sName is None:
2375	try: sName = oVM.name;
2376	except: sName = 'bad-vm-handle';
2377	reporter.log('startVmEx: sName=%s fWait=%s sType=%s' % (sName, fWait, sType));
2378	if oVM is None:
2379	return (None, None);
2380
2381	## @todo Do this elsewhere.
2382	# Hack alert. Disables all annoying GUI popups.
2383	if sType == 'gui' and len(self.aoRemoteSessions) == 0:
2384	try:
2385	self.oVBox.setExtraData('GUI/Input/AutoCapture', 'false');
2386	if self.fpApiVer >= 3.2:
2387	self.oVBox.setExtraData('GUI/LicenseAgreed', '8');
2388	else:
2389	self.oVBox.setExtraData('GUI/LicenseAgreed', '7');
2390	self.oVBox.setExtraData('GUI/RegistrationData', 'triesLeft=0');
2391	self.oVBox.setExtraData('GUI/SUNOnlineData', 'triesLeft=0');
2392	self.oVBox.setExtraData('GUI/SuppressMessages', 'confirmVMReset,remindAboutMouseIntegrationOn,'
2393	'remindAboutMouseIntegrationOff,remindAboutPausedVMInput,confirmInputCapture,'
2394	'confirmGoingFullscreen,remindAboutInaccessibleMedia,remindAboutWrongColorDepth,'
2395	'confirmRemoveMedium,allPopupPanes,allMessageBoxes,all');
2396	self.oVBox.setExtraData('GUI/UpdateDate', 'never');
2397	self.oVBox.setExtraData('GUI/PreventBetaWarning', self.oVBox.version);
2398	except:
2399	reporter.logXcpt();
2400
2401	# The UUID for the name.
2402	try:
2403	sUuid = oVM.id;
2404	except:
2405	reporter.errorXcpt('failed to get the UUID for VM "%s"' % (oVM));
2406	return (None, None);
2407	self.processPendingEvents();
2408
2409	# Construct the environment.
2410	sLogFile = '%s/VM-%s.log' % (self.sScratchPath, sUuid);
2411	try: os.remove(sLogFile);
2412	except: pass;
2413	if self.sLogSessionDest:
2414	sLogDest = self.sLogSessionDest;
2415	else:
2416	sLogDest = 'file=%s' % sLogFile;
2417	sEnv = 'VBOX_LOG=%s\nVBOX_LOG_FLAGS=%s\nVBOX_LOG_DEST=%s\nVBOX_RELEASE_LOG_FLAGS=append time' \
2418	% (self.sLogSessionGroups, self.sLogSessionFlags, sLogDest,);
2419	if sType == 'gui':
2420	sEnv += '\nVBOX_GUI_DBG_ENABLED=1'
2421	if asEnv is not None and len(asEnv) > 0:
2422	sEnv += '\n' + ('\n'.join(asEnv));
2423
2424	# Shortcuts for local testing.
2425	oProgress = oWrapped = None;
2426	oTestVM = self.oTestVmSet.findTestVmByName(sName) if self.oTestVmSet is not None else None;
2427	try:
2428	if oTestVM is not None \
2429	and oTestVM.fSnapshotRestoreCurrent is True:
2430	if oVM.state is vboxcon.MachineState_Running:
2431	reporter.log2('Machine "%s" already running.' % (sName,));
2432	oProgress = None;
2433	oWrapped = self.openSession(oVM);
2434	else:
2435	reporter.log2('Checking if snapshot for machine "%s" exists.' % (sName,));
2436	oSessionWrapperRestore = self.openSession(oVM);
2437	if oSessionWrapperRestore is not None:
2438	oSnapshotCur = oVM.currentSnapshot;
2439	if oSnapshotCur is not None:
2440	reporter.log2('Restoring snapshot for machine "%s".' % (sName,));
2441	oSessionWrapperRestore.restoreSnapshot(oSnapshotCur);
2442	reporter.log2('Current snapshot for machine "%s" restored.' % (sName,));
2443	else:
2444	reporter.log('warning: no current snapshot for machine "%s" found.' % (sName,));
2445	oSessionWrapperRestore.close();
2446	except:
2447	reporter.errorXcpt();
2448	return (None, None);
2449
2450	# Open a remote session, wait for this operation to complete.
2451	# (The loop is a kludge to deal with us racing the closing of the
2452	# direct session of a previous VM run. See waitOnDirectSessionClose.)
2453	if oWrapped is None:
2454	for i in range(10):
2455	try:
2456	if self.fpApiVer < 4.3 \
2457	or (self.fpApiVer == 4.3 and not hasattr(self.oVBoxMgr, 'getSessionObject')):
2458	oSession = self.oVBoxMgr.mgr.getSessionObject(self.oVBox); # pylint: disable=E1101
2459	else:
2460	oSession = self.oVBoxMgr.getSessionObject(self.oVBox); # pylint: disable=E1101
2461	if self.fpApiVer < 3.3:
2462	oProgress = self.oVBox.openRemoteSession(oSession, sUuid, sType, sEnv);
2463	else:
2464	oProgress = oVM.launchVMProcess(oSession, sType, sEnv);
2465	break;
2466	except:
2467	if i == 9:
2468	reporter.errorXcpt('failed to start VM "%s" ("%s"), aborting.' % (sUuid, sName));
2469	return (None, None);
2470	oSession = None;
2471	if i >= 0:
2472	reporter.logXcpt('warning: failed to start VM "%s" ("%s") - retrying in %u secs.' % (sUuid, oVM, i)); # pylint: disable=C0301
2473	self.waitOnDirectSessionClose(oVM, 5000 + i * 1000);
2474	if fWait and oProgress is not None:
2475	rc = self.waitOnProgress(oProgress);
2476	if rc < 0:
2477	self.waitOnDirectSessionClose(oVM, 5000);
2478	try:
2479	if oSession is not None:
2480	oSession.close();
2481	except: pass;
2482	reportError(oProgress, 'failed to open session for "%s"' % (sName));
2483	self.uploadStartupLogFile(oVM, sName);
2484	return (None, None);
2485	reporter.log2('waitOnProgress -> %s' % (rc,));
2486
2487	# Wrap up the session object and push on to the list before returning it.
2488	if oWrapped is None:
2489	from testdriver.vboxwrappers import SessionWrapper;
2490	oWrapped = SessionWrapper(oSession, oVM, self.oVBox, self.oVBoxMgr, self, True, sName, sLogFile);
2491
2492	oWrapped.registerEventHandlerForTask();
2493	self.aoRemoteSessions.append(oWrapped);
2494	if oWrapped is not self.aoRemoteSessions[len(self.aoRemoteSessions) - 1]:
2495	reporter.error('not by reference: oWrapped=%s aoRemoteSessions[%s]=%s'
2496	% (oWrapped, len(self.aoRemoteSessions) - 1,
2497	self.aoRemoteSessions[len(self.aoRemoteSessions) - 1]));
2498	self.addTask(oWrapped);
2499
2500	reporter.log2('startVmEx: oSession=%s, oSessionWrapper=%s, oProgress=%s' % (oSession, oWrapped, oProgress));
2501
2502	from testdriver.vboxwrappers import ProgressWrapper;
2503	return (oWrapped, ProgressWrapper(oProgress, self.oVBoxMgr, self,
2504	'starting %s' % (sName,)) if oProgress else None);
2505
2506	def startVm(self, oVM, sType=None, sName = None, asEnv = None):
2507	""" Simplified version of startVmEx. """
2508	oSession, _ = self.startVmEx(oVM, True, sType, sName, asEnv = asEnv);
2509	return oSession;
2510
2511	def startVmByNameEx(self, sName, fWait=True, sType=None, asEnv = None):
2512	"""
2513	Start the VM, returning the VM session and progress object on success.
2514	The session is also added to the task list and to the aoRemoteSessions set.
2515
2516	On failure (None, None) is returned and an error is logged.
2517	"""
2518	oVM = self.getVmByName(sName);
2519	if oVM is None:
2520	return (None, None);
2521	return self.startVmEx(oVM, fWait, sType, sName, asEnv = asEnv);
2522
2523	def startVmByName(self, sName, sType=None, asEnv = None):
2524	"""
2525	Start the VM, returning the VM session on success. The session is
2526	also added to the task list and to the aoRemoteSessions set.
2527
2528	On failure None is returned and an error is logged.
2529	"""
2530	oSession, _ = self.startVmByNameEx(sName, True, sType, asEnv = asEnv);
2531	return oSession;
2532
2533	def terminateVmBySession(self, oSession, oProgress = None, fTakeScreenshot = None):
2534	"""
2535	Terminates the VM specified by oSession and adds the release logs to
2536	the test report.
2537
2538	This will try achieve this by using powerOff, but will resort to
2539	tougher methods if that fails.
2540
2541	The session will always be removed from the task list.
2542	The session will be closed unless we fail to kill the process.
2543	The session will be removed from the remote session list if closed.
2544
2545	The progress object (a wrapper!) is for teleportation and similar VM
2546	operations, it will be attempted canceled before powering off the VM.
2547	Failures are logged but ignored.
2548	The progress object will always be removed from the task list.
2549
2550	Returns True if powerOff and session close both succeed.
2551	Returns False if on failure (logged), including when we successfully
2552	kill the VM process.
2553	"""
2554	reporter.log2('terminateVmBySession: oSession=%s (pid=%s) oProgress=%s' % (oSession.sName, oSession.getPid(), oProgress));
2555
2556	# Call getPid first to make sure the PID is cached in the wrapper.
2557	oSession.getPid();
2558
2559	#
2560	# If the host is out of memory, just skip all the info collection as it
2561	# requires memory too and seems to wedge.
2562	#
2563	sLastScreenshotPath = None;
2564	sOsKernelLog = None;
2565	sVgaText = None;
2566	asMiscInfos = [];
2567	if not oSession.fHostMemoryLow:
2568	#
2569	# Pause the VM if we're going to take any screenshots or dig into the
2570	# guest. Failures are quitely ignored.
2571	#
2572	if self.fAlwaysUploadLogs or reporter.testErrorCount() > 0:
2573	try:
2574	if oSession.oVM.state in [ vboxcon.MachineState_Running,
2575	vboxcon.MachineState_LiveSnapshotting,
2576	vboxcon.MachineState_Teleporting ]:
2577	oSession.o.console.pause();
2578	except:
2579	reporter.logXcpt();
2580
2581	#
2582	# Take Screenshot and upload it (see below) to Test Manager if appropriate/requested.
2583	#
2584	if fTakeScreenshot is True or self.fAlwaysUploadScreenshots or reporter.testErrorCount() > 0:
2585	sLastScreenshotPath = os.path.join(self.sScratchPath, "LastScreenshot-%s.png" % oSession.sName);
2586	fRc = oSession.takeScreenshot(sLastScreenshotPath);
2587	if fRc is not True:
2588	sLastScreenshotPath = None;
2589
2590	# Query the OS kernel log from the debugger if appropriate/requested.
2591	if self.fAlwaysUploadLogs or reporter.testErrorCount() > 0:
2592	sOsKernelLog = oSession.queryOsKernelLog();
2593
2594	# Do "info vgatext all" separately.
2595	if self.fAlwaysUploadLogs or reporter.testErrorCount() > 0:
2596	sVgaText = oSession.queryDbgInfoVgaText();
2597
2598	# Various infos (do after kernel because of symbols).
2599	if self.fAlwaysUploadLogs or reporter.testErrorCount() > 0:
2600	# Dump the guest stack for all CPUs.
2601	cCpus = oSession.getCpuCount();
2602	if cCpus > 0:
2603	for iCpu in xrange(0, cCpus):
2604	sThis = oSession.queryDbgGuestStack(iCpu);
2605	if sThis is not None and len(sThis) > 0:
2606	asMiscInfos += [
2607	'================ start guest stack VCPU %s ================\n' % (iCpu,),
2608	sThis,
2609	'================ end guest stack VCPU %s ==================\n' % (iCpu,),
2610	];
2611
2612	for sInfo, sArg in [ ('mode', 'all'),
2613	('fflags', ''),
2614	('cpumguest', 'verbose all'),
2615	('cpumguestinstr', 'symbol all'),
2616	('pic', ''),
2617	('apic', ''),
2618	('ioapic', ''),
2619	('pit', ''),
2620	('phys', ''),
2621	('clocks', ''),
2622	('timers', ''),
2623	('gdtguest', ''),
2624	('ldtguest', ''),
2625	]:
2626	if sInfo in ['apic',] and self.fpApiVer < 5.1: # asserts and burns
2627	continue;
2628	sThis = oSession.queryDbgInfo(sInfo, sArg);
2629	if sThis is not None and len(sThis) > 0:
2630	if sThis[-1] != '\n':
2631	sThis += '\n';
2632	asMiscInfos += [
2633	'================ start %s %s ================\n' % (sInfo, sArg),
2634	sThis,
2635	'================ end %s %s ==================\n' % (sInfo, sArg),
2636	];
2637
2638	#
2639	# Terminate the VM
2640	#
2641
2642	# Cancel the progress object if specified.
2643	if oProgress is not None:
2644	if not oProgress.isCompleted() and oProgress.isCancelable():
2645	reporter.log2('terminateVmBySession: canceling "%s"...' % (oProgress.sName));
2646	try:
2647	oProgress.o.cancel();
2648	except:
2649	reporter.logXcpt();
2650	else:
2651	oProgress.wait();
2652	self.removeTask(oProgress);
2653
2654	# Check if the VM has terminated by it self before powering it off.
2655	fClose = True;
2656	fRc = True;
2657	if oSession.needsPoweringOff():
2658	reporter.log('terminateVmBySession: powering off "%s"...' % (oSession.sName,));
2659	fRc = oSession.powerOff(fFudgeOnFailure = False);
2660	if fRc is not True:
2661	# power off failed, try terminate it in a nice manner.
2662	fRc = False;
2663	uPid = oSession.getPid();
2664	if uPid is not None:
2665	reporter.error('terminateVmBySession: Terminating PID %u (VM %s)' % (uPid, oSession.sName));
2666	fClose = base.processTerminate(uPid);
2667	if fClose is True:
2668	self.waitOnDirectSessionClose(oSession.oVM, 5000);
2669	fClose = oSession.waitForTask(1000);
2670
2671	if fClose is not True:
2672	# Being nice failed...
2673	reporter.error('terminateVmBySession: Termination failed, trying to kill PID %u (VM %s) instead' \
2674	% (uPid, oSession.sName));
2675	fClose = base.processKill(uPid);
2676	if fClose is True:
2677	self.waitOnDirectSessionClose(oSession.oVM, 5000);
2678	fClose = oSession.waitForTask(1000);
2679	if fClose is not True:
2680	reporter.error('terminateVmBySession: Failed to kill PID %u (VM %s)' % (uPid, oSession.sName));
2681
2682	# The final steps.
2683	if fClose is True:
2684	reporter.log('terminateVmBySession: closing session "%s"...' % (oSession.sName,));
2685	oSession.close();
2686	self.waitOnDirectSessionClose(oSession.oVM, 10000);
2687	try:
2688	eState = oSession.oVM.state;
2689	except:
2690	reporter.logXcpt();
2691	else:
2692	if eState == vboxcon.MachineState_Aborted:
2693	reporter.error('terminateVmBySession: The VM "%s" aborted!' % (oSession.sName,));
2694	self.removeTask(oSession);
2695
2696	#
2697	# Add the release log, debug log and a screenshot of the VM to the test report.
2698	#
2699	if self.fAlwaysUploadLogs or reporter.testErrorCount() > 0:
2700	oSession.addLogsToReport();
2701
2702	# Add a screenshot if it has been requested and taken successfully.
2703	if sLastScreenshotPath is not None:
2704	if reporter.testErrorCount() > 0:
2705	reporter.addLogFile(sLastScreenshotPath, 'screenshot/failure', 'Last VM screenshot');
2706	else:
2707	reporter.addLogFile(sLastScreenshotPath, 'screenshot/success', 'Last VM screenshot');
2708
2709	# Add the guest OS log if it has been requested and taken successfully.
2710	if sOsKernelLog is not None:
2711	reporter.addLogString(sOsKernelLog, 'kernel.log', 'log/guest/kernel', 'Guest OS kernel log');
2712
2713	# Add "info vgatext all" if we've got it.
2714	if sVgaText is not None:
2715	reporter.addLogString(sVgaText, 'vgatext.txt', 'info/vgatext', 'info vgatext all');
2716
2717	# Add the "info xxxx" items if we've got any.
2718	if len(asMiscInfos) > 0:
2719	reporter.addLogString(u''.join(asMiscInfos), 'info.txt', 'info/collection', 'A bunch of info items.');
2720
2721
2722	return fRc;
2723
2724
2725	#
2726	# Some information query functions (mix).
2727	#
2728	# Methods require the VBox API. If the information is provided by both
2729	# the testboxscript as well as VBox API, we'll check if it matches.
2730	#
2731
2732	def _hasHostCpuFeature(self, sEnvVar, sEnum, fpApiMinVer, fQuiet):
2733	"""
2734	Common Worker for hasHostNestedPaging() and hasHostHwVirt().
2735
2736	Returns True / False.
2737	Raises exception on environment / host mismatch.
2738	"""
2739	fEnv = os.environ.get(sEnvVar, None);
2740	if fEnv is not None:
2741	fEnv = fEnv.lower() not in [ 'false', 'f', 'not', 'no', 'n', '0', ];
2742
2743	fVBox = None;
2744	self.importVBoxApi();
2745	if self.fpApiVer >= fpApiMinVer and hasattr(vboxcon, sEnum):
2746	try:
2747	fVBox = self.oVBox.host.getProcessorFeature(getattr(vboxcon, sEnum));
2748	except:
2749	if not fQuiet:
2750	reporter.logXcpt();
2751
2752	if fVBox is not None:
2753	if fEnv is not None:
2754	if fEnv != fVBox and not fQuiet:
2755	reporter.log('TestBox configuration overwritten: fVBox=%s (%s) vs. fEnv=%s (%s)'
2756	% (fVBox, sEnum, fEnv, sEnvVar));
2757	return fEnv;
2758	return fVBox;
2759	if fEnv is not None:
2760	return fEnv;
2761	return False;
2762
2763	def hasHostHwVirt(self, fQuiet = False):
2764	"""
2765	Checks if hardware assisted virtualization is supported by the host.
2766
2767	Returns True / False.
2768	Raises exception on environment / host mismatch.
2769	"""
2770	return self._hasHostCpuFeature('TESTBOX_HAS_HW_VIRT', 'ProcessorFeature_HWVirtEx', 3.1, fQuiet);
2771
2772	def hasHostNestedPaging(self, fQuiet = False):
2773	"""
2774	Checks if nested paging is supported by the host.
2775
2776	Returns True / False.
2777	Raises exception on environment / host mismatch.
2778	"""
2779	return self._hasHostCpuFeature('TESTBOX_HAS_NESTED_PAGING', 'ProcessorFeature_NestedPaging', 4.2, fQuiet) \
2780	and self.hasHostHwVirt(fQuiet);
2781
2782	def hasHostLongMode(self, fQuiet = False):
2783	"""
2784	Checks if the host supports 64-bit guests.
2785
2786	Returns True / False.
2787	Raises exception on environment / host mismatch.
2788	"""
2789	# Note that the testboxscript doesn't export this variable atm.
2790	return self._hasHostCpuFeature('TESTBOX_HAS_LONG_MODE', 'ProcessorFeature_LongMode', 3.1, fQuiet);
2791
2792	def getHostCpuCount(self, fQuiet = False):
2793	"""
2794	Returns the number of CPUs on the host.
2795
2796	Returns True / False.
2797	Raises exception on environment / host mismatch.
2798	"""
2799	cEnv = os.environ.get('TESTBOX_CPU_COUNT', None);
2800	if cEnv is not None:
2801	cEnv = int(cEnv);
2802
2803	try:
2804	cVBox = self.oVBox.host.processorOnlineCount;
2805	except:
2806	if not fQuiet:
2807	reporter.logXcpt();
2808	cVBox = None;
2809
2810	if cVBox is not None:
2811	if cEnv is not None:
2812	assert cVBox == cEnv, 'Misconfigured TestBox: VBox: %u CPUs, testboxscript: %u CPUs' % (cVBox, cEnv);
2813	return cVBox;
2814	if cEnv is not None:
2815	return cEnv;
2816	return 1;
2817
2818	def _getHostCpuDesc(self, fQuiet = False):
2819	"""
2820	Internal method used for getting the host CPU description from VBoxSVC.
2821	Returns description string, on failure an empty string is returned.
2822	"""
2823	try:
2824	return self.oVBox.host.getProcessorDescription(0);
2825	except:
2826	if not fQuiet:
2827	reporter.logXcpt();
2828	return '';
2829
2830	def isHostCpuAmd(self, fQuiet = False):
2831	"""
2832	Checks if the host CPU vendor is AMD.
2833
2834	Returns True / False.
2835	"""
2836	sCpuDesc = self._getHostCpuDesc(fQuiet);
2837	return sCpuDesc.startswith("AMD") or sCpuDesc == 'AuthenticAMD';
2838
2839	def isHostCpuIntel(self, fQuiet = False):
2840	"""
2841	Checks if the host CPU vendor is Intel.
2842
2843	Returns True / False.
2844	"""
2845	sCpuDesc = self._getHostCpuDesc(fQuiet);
2846	return sCpuDesc.startswith("Intel") or sCpuDesc == 'GenuineIntel';
2847
2848	def isHostCpuVia(self, fQuiet = False):
2849	"""
2850	Checks if the host CPU vendor is VIA (or Centaur).
2851
2852	Returns True / False.
2853	"""
2854	sCpuDesc = self._getHostCpuDesc(fQuiet);
2855	return sCpuDesc.startswith("VIA") or sCpuDesc == 'CentaurHauls';
2856
2857	def hasRawModeSupport(self, fQuiet = False):
2858	"""
2859	Checks if raw-mode is supported by VirtualBox that the testbox is
2860	configured for it.
2861
2862	Returns True / False.
2863	Raises no exceptions.
2864
2865	Note! Differs from the rest in that we don't require the
2866	TESTBOX_WITH_RAW_MODE value to match the API. It is
2867	sometimes helpful to disable raw-mode on individual
2868	test boxes. (This probably goes for
2869	"""
2870	# The environment variable can be used to disable raw-mode.
2871	fEnv = os.environ.get('TESTBOX_WITH_RAW_MODE', None);
2872	if fEnv is not None:
2873	fEnv = fEnv.lower() not in [ 'false', 'f', 'not', 'no', 'n', '0', ];
2874	if fEnv is False:
2875	return False;
2876
2877	# Starting with 5.0 GA / RC2 the API can tell us whether VBox was built
2878	# with raw-mode support or not.
2879	self.importVBoxApi();
2880	if self.fpApiVer >= 5.0:
2881	try:
2882	fVBox = self.oVBox.systemProperties.rawModeSupported;
2883	except:
2884	if not fQuiet:
2885	reporter.logXcpt();
2886	fVBox = True;
2887	if fVBox is False:
2888	return False;
2889
2890	return True;
2891
2892	#
2893	# Testdriver execution methods.
2894	#
2895
2896	def handleTask(self, oTask, sMethod):
2897	"""
2898	Callback method for handling unknown tasks in the various run loops.
2899
2900	The testdriver should override this if it already tasks running when
2901	calling startVmAndConnectToTxsViaTcp, txsRunTest or similar methods.
2902	Call super to handle unknown tasks.
2903
2904	Returns True if handled, False if not.
2905	"""
2906	reporter.error('%s: unknown task %s' % (sMethod, oTask));
2907	return False;
2908
2909	def txsDoTask(self, oSession, oTxsSession, fnAsync, aArgs):
2910	"""
2911	Generic TXS task wrapper which waits both on the TXS and the session tasks.
2912
2913	Returns False on error, logged.
2914
2915	Returns task result on success.
2916	"""
2917	# All async methods ends with the following to args.
2918	cMsTimeout = aArgs[-2];
2919	fIgnoreErrors = aArgs[-1];
2920
2921	fRemoveVm = self.addTask(oSession);
2922	fRemoveTxs = self.addTask(oTxsSession);
2923
2924	rc = fnAsync(*aArgs); # pylint: disable=W0142
2925	if rc is True:
2926	rc = False;
2927	oTask = self.waitForTasks(cMsTimeout + 1);
2928	if oTask is oTxsSession:
2929	if oTxsSession.isSuccess():
2930	rc = oTxsSession.getResult();
2931	elif fIgnoreErrors is True:
2932	reporter.log( 'txsDoTask: task failed (%s)' % (oTxsSession.getLastReply()[1],));
2933	else:
2934	reporter.error('txsDoTask: task failed (%s)' % (oTxsSession.getLastReply()[1],));
2935	else:
2936	oTxsSession.cancelTask();
2937	if oTask is None:
2938	if fIgnoreErrors is True:
2939	reporter.log( 'txsDoTask: The task timed out.');
2940	else:
2941	reporter.errorTimeout('txsDoTask: The task timed out.');
2942	elif oTask is oSession:
2943	reporter.error('txsDoTask: The VM terminated unexpectedly');
2944	else:
2945	if fIgnoreErrors is True:
2946	reporter.log( 'txsDoTask: An unknown task %s was returned' % (oTask,));
2947	else:
2948	reporter.error('txsDoTask: An unknown task %s was returned' % (oTask,));
2949	else:
2950	reporter.error('txsDoTask: fnAsync returned %s' % (rc,));
2951
2952	if fRemoveTxs:
2953	self.removeTask(oTxsSession);
2954	if fRemoveVm:
2955	self.removeTask(oSession);
2956	return rc;
2957
2958	# pylint: disable=C0111
2959
2960	def txsDisconnect(self, oSession, oTxsSession, cMsTimeout = 30000, fIgnoreErrors = False):
2961	return self.txsDoTask(oSession, oTxsSession, oTxsSession.asyncDisconnect,
2962	(self.adjustTimeoutMs(cMsTimeout), fIgnoreErrors));
2963
2964	def txsUuid(self, oSession, oTxsSession, cMsTimeout = 30000, fIgnoreErrors = False):
2965	return self.txsDoTask(oSession, oTxsSession, oTxsSession.asyncUuid,
2966	(self.adjustTimeoutMs(cMsTimeout), fIgnoreErrors));
2967
2968	def txsMkDir(self, oSession, oTxsSession, sRemoteDir, fMode = 0700, cMsTimeout = 30000, fIgnoreErrors = False):
2969	return self.txsDoTask(oSession, oTxsSession, oTxsSession.asyncMkDir,
2970	(sRemoteDir, fMode, self.adjustTimeoutMs(cMsTimeout), fIgnoreErrors));
2971
2972	def txsMkDirPath(self, oSession, oTxsSession, sRemoteDir, fMode = 0700, cMsTimeout = 30000, fIgnoreErrors = False):
2973	return self.txsDoTask(oSession, oTxsSession, oTxsSession.asyncMkDirPath,
2974	(sRemoteDir, fMode, self.adjustTimeoutMs(cMsTimeout), fIgnoreErrors));
2975
2976	def txsMkSymlink(self, oSession, oTxsSession, sLinkTarget, sLink, cMsTimeout = 30000, fIgnoreErrors = False):
2977	return self.txsDoTask(oSession, oTxsSession, oTxsSession.asyncMkSymlink,
2978	(sLinkTarget, sLink, self.adjustTimeoutMs(cMsTimeout), fIgnoreErrors));
2979
2980	def txsRmDir(self, oSession, oTxsSession, sRemoteDir, cMsTimeout = 30000, fIgnoreErrors = False):
2981	return self.txsDoTask(oSession, oTxsSession, oTxsSession.asyncRmDir,
2982	(sRemoteDir, self.adjustTimeoutMs(cMsTimeout), fIgnoreErrors));
2983
2984	def txsRmFile(self, oSession, oTxsSession, sRemoteFile, cMsTimeout = 30000, fIgnoreErrors = False):
2985	return self.txsDoTask(oSession, oTxsSession, oTxsSession.asyncRmFile,
2986	(sRemoteFile, self.adjustTimeoutMs(cMsTimeout), fIgnoreErrors));
2987
2988	def txsRmSymlink(self, oSession, oTxsSession, sRemoteSymlink, cMsTimeout = 30000, fIgnoreErrors = False):
2989	return self.txsDoTask(oSession, oTxsSession, oTxsSession.asyncRmSymlink,
2990	(sRemoteSymlink, self.adjustTimeoutMs(cMsTimeout), fIgnoreErrors));
2991
2992	def txsRmTree(self, oSession, oTxsSession, sRemoteTree, cMsTimeout = 30000, fIgnoreErrors = False):
2993	return self.txsDoTask(oSession, oTxsSession, oTxsSession.asyncRmTree,
2994	(sRemoteTree, self.adjustTimeoutMs(cMsTimeout), fIgnoreErrors));
2995
2996	def txsIsDir(self, oSession, oTxsSession, sRemoteDir, cMsTimeout = 30000, fIgnoreErrors = False):
2997	return self.txsDoTask(oSession, oTxsSession, oTxsSession.asyncIsDir,
2998	(sRemoteDir, self.adjustTimeoutMs(cMsTimeout), fIgnoreErrors));
2999
3000	def txsIsFile(self, oSession, oTxsSession, sRemoteFile, cMsTimeout = 30000, fIgnoreErrors = False):
3001	return self.txsDoTask(oSession, oTxsSession, oTxsSession.asyncIsFile,
3002	(sRemoteFile, self.adjustTimeoutMs(cMsTimeout), fIgnoreErrors));
3003
3004	def txsIsSymlink(self, oSession, oTxsSession, sRemoteSymlink, cMsTimeout = 30000, fIgnoreErrors = False):
3005	return self.txsDoTask(oSession, oTxsSession, oTxsSession.asyncIsSymlink,
3006	(sRemoteSymlink, self.adjustTimeoutMs(cMsTimeout), fIgnoreErrors));
3007
3008	def txsUploadFile(self, oSession, oTxsSession, sLocalFile, sRemoteFile, cMsTimeout = 30000, fIgnoreErrors = False):
3009	return self.txsDoTask(oSession, oTxsSession, oTxsSession.asyncUploadFile, \
3010	(sLocalFile, sRemoteFile, self.adjustTimeoutMs(cMsTimeout), fIgnoreErrors));
3011
3012	def txsUploadString(self, oSession, oTxsSession, sContent, sRemoteFile, cMsTimeout = 30000, fIgnoreErrors = False):
3013	return self.txsDoTask(oSession, oTxsSession, oTxsSession.asyncUploadString, \
3014	(sContent, sRemoteFile, self.adjustTimeoutMs(cMsTimeout), fIgnoreErrors));
3015
3016	def txsDownloadFile(self, oSession, oTxsSession, sRemoteFile, sLocalFile, cMsTimeout = 30000, fIgnoreErrors = False):
3017	return self.txsDoTask(oSession, oTxsSession, oTxsSession.asyncDownloadFile, \
3018	(sRemoteFile, sLocalFile, self.adjustTimeoutMs(cMsTimeout), fIgnoreErrors));
3019
3020	def txsDownloadFiles(self, oSession, oTxsSession, asFiles, fIgnoreErrors = False):
3021	"""
3022	Convenience function to get files from the guest and stores it
3023	into the scratch directory for later (manual) review.
3024
3025	Returns True on success.
3026
3027	Returns False on failure, logged.
3028	"""
3029	fRc = True;
3030	for sGstFile in asFiles:
3031	## @todo Check for already existing files on the host and create a new
3032	# name for the current file to download.
3033	sTmpFile = os.path.join(self.sScratchPath, 'tmp-' + os.path.basename(sGstFile));
3034	reporter.log2('Downloading file "%s" to "%s" ...' % (sGstFile, sTmpFile));
3035	fRc = self.txsDownloadFile(oSession, oTxsSession, sGstFile, sTmpFile, 30 * 1000, fIgnoreErrors);
3036	try: os.unlink(sTmpFile);
3037	except: pass;
3038	if fRc:
3039	reporter.addLogFile(sTmpFile, 'misc/other', 'guest - ' + sGstFile);
3040	else:
3041	if fIgnoreErrors is not True:
3042	reporter.error('error downloading file "%s" to "%s"' % (sGstFile, sTmpFile));
3043	return fRc;
3044	reporter.log('warning: file "%s" was not downloaded, ignoring.' % (sGstFile,));
3045	return True;
3046
3047	def txsDownloadString(self, oSession, oTxsSession, sRemoteFile, cMsTimeout = 30000, fIgnoreErrors = False):
3048	return self.txsDoTask(oSession, oTxsSession, oTxsSession.asyncDownloadString,
3049	(sRemoteFile, self.adjustTimeoutMs(cMsTimeout), fIgnoreErrors));
3050
3051	def txsUnpackFile(self, oSession, oTxsSession, sRemoteFile, sRemoteDir, cMsTimeout = 30000, fIgnoreErrors = False):
3052	return self.txsDoTask(oSession, oTxsSession, oTxsSession.asyncUnpackFile, \
3053	(sRemoteFile, sRemoteDir, self.adjustTimeoutMs(cMsTimeout), fIgnoreErrors));
3054
3055	# pylint: enable=C0111
3056
3057	def txsCdWait(self, oSession, oTxsSession, cMsTimeout = 30000, sFileCdWait = 'vboxtxs-readme.txt'):
3058	"""
3059	Mostly an internal helper for txsRebootAndReconnectViaTcp and
3060	startVmAndConnectToTxsViaTcp that waits for the CDROM drive to become
3061	ready. It does this by polling for a file it knows to exist on the CD.
3062
3063	Returns True on success.
3064
3065	Returns False on failure, logged.
3066	"""
3067
3068	fRemoveVm = self.addTask(oSession);
3069	fRemoveTxs = self.addTask(oTxsSession);
3070	cMsTimeout = self.adjustTimeoutMs(cMsTimeout);
3071	msStart = base.timestampMilli();
3072	cMsTimeout2 = cMsTimeout;
3073	fRc = oTxsSession.asyncIsFile('${CDROM}/%s' % (sFileCdWait), cMsTimeout2);
3074	if fRc is True:
3075	while True:
3076	# wait for it to complete.
3077	oTask = self.waitForTasks(cMsTimeout2 + 1);
3078	if oTask is not oTxsSession:
3079	oTxsSession.cancelTask();
3080	if oTask is None:
3081	reporter.errorTimeout('txsToCdWait: The task timed out (after %s ms).'
3082	% (base.timestampMilli() - msStart,));
3083	elif oTask is oSession:
3084	reporter.error('txsToCdWait: The VM terminated unexpectedly');
3085	else:
3086	reporter.error('txsToCdWait: An unknown task %s was returned' % (oTask,));
3087	fRc = False;
3088	break;
3089	if oTxsSession.isSuccess():
3090	break;
3091
3092	# Check for timeout.
3093	cMsElapsed = base.timestampMilli() - msStart;
3094	if cMsElapsed >= cMsTimeout:
3095	reporter.error('txsToCdWait: timed out');
3096	fRc = False;
3097	break;
3098
3099	# delay.
3100	self.sleep(1);
3101
3102	# resubmitt the task.
3103	cMsTimeout2 = msStart + cMsTimeout - base.timestampMilli();
3104	if cMsTimeout2 < 500:
3105	cMsTimeout2 = 500;
3106	fRc = oTxsSession.asyncIsFile('${CDROM}/%s' % (sFileCdWait), cMsTimeout2);
3107	if fRc is not True:
3108	reporter.error('txsToCdWait: asyncIsFile failed');
3109	break;
3110	else:
3111	reporter.error('txsToCdWait: asyncIsFile failed');
3112
3113	if fRemoveTxs:
3114	self.removeTask(oTxsSession);
3115	if fRemoveVm:
3116	self.removeTask(oSession);
3117	return fRc;
3118
3119	def txsDoConnectViaTcp(self, oSession, cMsTimeout, fNatForwardingForTxs = False):
3120	"""
3121	Mostly an internal worker for connecting to TXS via TCP used by the
3122	*ViaTcp methods.
3123
3124	Returns a tuplet with True/False and TxsSession/None depending on the
3125	result. Errors are logged.
3126	"""
3127
3128	reporter.log2('txsDoConnectViaTcp: oSession=%s, cMsTimeout=%s, fNatForwardingForTxs=%s'
3129	% (oSession, cMsTimeout, fNatForwardingForTxs));
3130
3131	cMsTimeout = self.adjustTimeoutMs(cMsTimeout);
3132	oTxsConnect = oSession.txsConnectViaTcp(cMsTimeout, fNatForwardingForTxs = fNatForwardingForTxs);
3133	if oTxsConnect is not None:
3134	self.addTask(oTxsConnect);
3135	fRemoveVm = self.addTask(oSession);
3136	oTask = self.waitForTasks(cMsTimeout + 1);
3137	reporter.log2('txsDoConnectViaTcp: waitForTasks returned %s' % (oTask,));
3138	self.removeTask(oTxsConnect);
3139	if oTask is oTxsConnect:
3140	oTxsSession = oTxsConnect.getResult();
3141	if oTxsSession is not None:
3142	reporter.log('txsDoConnectViaTcp: Connected to TXS on %s.' % (oTxsSession.oTransport.sHostname,));
3143	return (True, oTxsSession);
3144
3145	reporter.error('txsDoConnectViaTcp: failed to connect to TXS.');
3146	else:
3147	oTxsConnect.cancelTask();
3148	if oTask is None:
3149	reporter.errorTimeout('txsDoConnectViaTcp: connect stage 1 timed out');
3150	elif oTask is oSession:
3151	oSession.reportPrematureTermination('txsDoConnectViaTcp: ');
3152	else:
3153	reporter.error('txsDoConnectViaTcp: unknown/wrong task %s' % (oTask,));
3154	if fRemoveVm:
3155	self.removeTask(oSession);
3156	else:
3157	reporter.error('txsDoConnectViaTcp: txsConnectViaTcp failed');
3158	return (False, None);
3159
3160	def startVmAndConnectToTxsViaTcp(self, sVmName, fCdWait = False, cMsTimeout = 15*60000, \
3161	cMsCdWait = 30000, sFileCdWait = 'vboxtxs-readme.txt', \
3162	fNatForwardingForTxs = False):
3163	"""
3164	Starts the specified VM and tries to connect to its TXS via TCP.
3165	The VM will be powered off if TXS doesn't respond before the specified
3166	time has elapsed.
3167
3168	Returns a the VM and TXS sessions (a two tuple) on success. The VM
3169	session is in the task list, the TXS session is not.
3170	Returns (None, None) on failure, fully logged.
3171	"""
3172
3173	# Zap the guest IP to make sure we're not getting a stale entry
3174	# (unless we're restoring the VM of course).
3175	oTestVM = self.oTestVmSet.findTestVmByName(sVmName) if self.oTestVmSet is not None else None;
3176	if oTestVM is None \
3177	or oTestVM.fSnapshotRestoreCurrent is False:
3178	try:
3179	oSession1 = self.openSession(self.getVmByName(sVmName));
3180	oSession1.delGuestPropertyValue('/VirtualBox/GuestInfo/Net/0/V4/IP');
3181	oSession1.saveSettings(True);
3182	del oSession1;
3183	except:
3184	reporter.logXcpt();
3185
3186	# Start the VM.
3187	reporter.log('startVmAndConnectToTxsViaTcp: Starting(/preparing) "%s" (timeout %s s)...' % (sVmName, cMsTimeout / 1000));
3188	reporter.flushall();
3189	oSession = self.startVmByName(sVmName);
3190	if oSession is not None:
3191	# Connect to TXS.
3192	reporter.log2('startVmAndConnectToTxsViaTcp: Started(/prepared) "%s", connecting to TXS ...' % (sVmName,));
3193	(fRc, oTxsSession) = self.txsDoConnectViaTcp(oSession, cMsTimeout, fNatForwardingForTxs);
3194	if fRc is True:
3195	if fCdWait:
3196	# Wait for CD?
3197	fRc = self.txsCdWait(oSession, oTxsSession, cMsCdWait, sFileCdWait);
3198	if fRc is not True:
3199	reporter.error('startVmAndConnectToTxsViaTcp: txsCdWait failed');
3200	if fRc is True:
3201	# Success!
3202	return (oSession, oTxsSession);
3203	else:
3204	reporter.error('startVmAndConnectToTxsViaTcp: txsDoConnectViaTcp failed');
3205	# If something went wrong while waiting for TXS to be started - take VM screenshot before terminate it
3206	self.terminateVmBySession(oSession);
3207	return (None, None);
3208
3209	def txsRebootAndReconnectViaTcp(self, oSession, oTxsSession, fCdWait = False, cMsTimeout = 15*60000, \
3210	cMsCdWait = 30000, sFileCdWait = 'vboxtxs-readme.txt', fNatForwardingForTxs = False):
3211	"""
3212	Executes the TXS reboot command
3213
3214	Returns A tuple of True and the new TXS session on success.
3215
3216	Returns A tuple of False and either the old TXS session or None on failure.
3217	"""
3218	reporter.log2('txsRebootAndReconnect: cMsTimeout=%u' % (cMsTimeout,));
3219
3220	#
3221	# This stuff is a bit complicated because of rebooting being kind of
3222	# disruptive to the TXS and such... The protocol is that TXS will:
3223	# - ACK the reboot command.
3224	# - Shutdown the transport layer, implicitly disconnecting us.
3225	# - Execute the reboot operation.
3226	# - On failure, it will be re-init the transport layer and be
3227	# available pretty much immediately. UUID unchanged.
3228	# - On success, it will be respawed after the reboot (hopefully),
3229	# with a different UUID.
3230	#
3231	fRc = False;
3232	iStart = base.timestampMilli();
3233
3234	# Get UUID.
3235	cMsTimeout2 = min(60000, cMsTimeout);
3236	sUuidBefore = self.txsUuid(oSession, oTxsSession, self.adjustTimeoutMs(cMsTimeout2, 60000));
3237	if sUuidBefore is not False:
3238	# Reboot.
3239	cMsElapsed = base.timestampMilli() - iStart;
3240	cMsTimeout2 = cMsTimeout - cMsElapsed;
3241	fRc = self.txsDoTask(oSession, oTxsSession, oTxsSession.asyncReboot,
3242	(self.adjustTimeoutMs(cMsTimeout2, 60000), False));
3243	if fRc is True:
3244	# Reconnect.
3245	if fNatForwardingForTxs is True:
3246	self.sleep(22); # NAT fudge - Two fixes are wanted: 1. TXS connect retries. 2. Main API reboot/reset hint.
3247	cMsElapsed = base.timestampMilli() - iStart;
3248	(fRc, oTxsSession) = self.txsDoConnectViaTcp(oSession, cMsTimeout - cMsElapsed, fNatForwardingForTxs);
3249	if fRc is True:
3250	# Check the UUID.
3251	cMsElapsed = base.timestampMilli() - iStart;
3252	cMsTimeout2 = min(60000, cMsTimeout - cMsElapsed);
3253	sUuidAfter = self.txsDoTask(oSession, oTxsSession, oTxsSession.asyncUuid,
3254	(self.adjustTimeoutMs(cMsTimeout2, 60000), False));
3255	if sUuidBefore is not False:
3256	if sUuidAfter != sUuidBefore:
3257	reporter.log('The guest rebooted (UUID %s -> %s)' % (sUuidBefore, sUuidAfter))
3258
3259	# Do CD wait if specified.
3260	if fCdWait:
3261	fRc = self.txsCdWait(oSession, oTxsSession, cMsCdWait, sFileCdWait);
3262	if fRc is not True:
3263	reporter.error('txsRebootAndReconnectViaTcp: txsCdWait failed');
3264	else:
3265	reporter.error('txsRebootAndReconnectViaTcp: failed to get UUID (after)');
3266	else:
3267	reporter.error('txsRebootAndReconnectViaTcp: did not reboot (UUID %s)' % (sUuidBefore,));
3268	else:
3269	reporter.error('txsRebootAndReconnectViaTcp: txsDoConnectViaTcp failed');
3270	else:
3271	reporter.error('txsRebootAndReconnectViaTcp: reboot failed');
3272	else:
3273	reporter.error('txsRebootAndReconnectViaTcp: failed to get UUID (before)');
3274	return (fRc, oTxsSession);
3275
3276	# pylint: disable=R0914,R0913
3277
3278	def txsRunTest(self, oTxsSession, sTestName, cMsTimeout, sExecName, asArgs = (), asAddEnv = (), sAsUser = ""):
3279	"""
3280	Executes the specified test task, waiting till it completes or times out.
3281
3282	The VM session (if any) must be in the task list.
3283
3284	Returns True if we executed the task and nothing abnormal happend.
3285	Query the process status from the TXS session.
3286
3287	Returns False if some unexpected task was signalled or we failed to
3288	submit the job.
3289	"""
3290	reporter.testStart(sTestName);
3291	reporter.log2('txsRunTest: cMsTimeout=%u sExecName=%s asArgs=%s' % (cMsTimeout, sExecName, asArgs));
3292
3293	# Submit the job.
3294	fRc = False;
3295	if oTxsSession.asyncExec(sExecName, asArgs, asAddEnv, sAsUser, cMsTimeout = self.adjustTimeoutMs(cMsTimeout)):
3296	self.addTask(oTxsSession);
3297
3298	# Wait for the job to complete.
3299	while True:
3300	oTask = self.waitForTasks(cMsTimeout + 1);
3301	if oTask is None:
3302	reporter.log('txsRunTest: waitForTasks timed out');
3303	break;
3304	if oTask is oTxsSession:
3305	fRc = True;
3306	reporter.log('txsRunTest: isSuccess=%s getResult=%s' % (oTxsSession.isSuccess(), oTxsSession.getResult()));
3307	break;
3308	if not self.handleTask(oTask, 'txsRunTest'):
3309	break;
3310
3311	self.removeTask(oTxsSession);
3312	if not oTxsSession.pollTask():
3313	oTxsSession.cancelTask();
3314	else:
3315	reporter.error('txsRunTest: asyncExec failed');
3316
3317	reporter.testDone();
3318	return fRc;
3319
3320	def txsRunTestRedirectStd(self, oTxsSession, sTestName, cMsTimeout, sExecName, asArgs = (), asAddEnv = (), sAsUser = "",
3321	oStdIn = '/dev/null', oStdOut = '/dev/null', oStdErr = '/dev/null', oTestPipe = '/dev/null'):
3322	"""
3323	Executes the specified test task, waiting till it completes or times out,
3324	redirecting stdin, stdout and stderr to the given objects.
3325
3326	The VM session (if any) must be in the task list.
3327
3328	Returns True if we executed the task and nothing abnormal happend.
3329	Query the process status from the TXS session.
3330
3331	Returns False if some unexpected task was signalled or we failed to
3332	submit the job.
3333	"""
3334	reporter.testStart(sTestName);
3335	reporter.log2('txsRunTestRedirectStd: cMsTimeout=%u sExecName=%s asArgs=%s' % (cMsTimeout, sExecName, asArgs));
3336
3337	# Submit the job.
3338	fRc = False;
3339	if oTxsSession.asyncExecEx(sExecName, asArgs, asAddEnv, oStdIn, oStdOut, oStdErr,
3340	oTestPipe, sAsUser, cMsTimeout = self.adjustTimeoutMs(cMsTimeout)):
3341	self.addTask(oTxsSession);
3342
3343	# Wait for the job to complete.
3344	while True:
3345	oTask = self.waitForTasks(cMsTimeout + 1);
3346	if oTask is None:
3347	reporter.log('txsRunTestRedirectStd: waitForTasks timed out');
3348	break;
3349	if oTask is oTxsSession:
3350	fRc = True;
3351	reporter.log('txsRunTestRedirectStd: isSuccess=%s getResult=%s'
3352	% (oTxsSession.isSuccess(), oTxsSession.getResult()));
3353	break;
3354	if not self.handleTask(oTask, 'txsRunTestRedirectStd'):
3355	break;
3356
3357	self.removeTask(oTxsSession);
3358	if not oTxsSession.pollTask():
3359	oTxsSession.cancelTask();
3360	else:
3361	reporter.error('txsRunTestRedirectStd: asyncExec failed');
3362
3363	reporter.testDone();
3364	return fRc;
3365
3366	def txsRunTest2(self, oTxsSession1, oTxsSession2, sTestName, cMsTimeout,
3367	sExecName1, asArgs1,
3368	sExecName2, asArgs2,
3369	asAddEnv1 = (), sAsUser1 = '', fWithTestPipe1 = True,
3370	asAddEnv2 = (), sAsUser2 = '', fWithTestPipe2 = True):
3371	"""
3372	Executes the specified test tasks, waiting till they complete or
3373	times out. The 1st task is started after the 2nd one.
3374
3375	The VM session (if any) must be in the task list.
3376
3377	Returns True if we executed the task and nothing abnormal happend.
3378	Query the process status from the TXS sessions.
3379
3380	Returns False if some unexpected task was signalled or we failed to
3381	submit the job.
3382	"""
3383	reporter.testStart(sTestName);
3384
3385	# Submit the jobs.
3386	fRc = False;
3387	if oTxsSession1.asyncExec(sExecName1, asArgs1, asAddEnv1, sAsUser1, fWithTestPipe1, '1-',
3388	self.adjustTimeoutMs(cMsTimeout)):
3389	self.addTask(oTxsSession1);
3390
3391	self.sleep(2); # fudge! grr
3392
3393	if oTxsSession2.asyncExec(sExecName2, asArgs2, asAddEnv2, sAsUser2, fWithTestPipe2, '2-',
3394	self.adjustTimeoutMs(cMsTimeout)):
3395	self.addTask(oTxsSession2);
3396
3397	# Wait for the jobs to complete.
3398	cPendingJobs = 2;
3399	while True:
3400	oTask = self.waitForTasks(cMsTimeout + 1);
3401	if oTask is None:
3402	reporter.log('txsRunTest2: waitForTasks timed out');
3403	break;
3404
3405	if oTask is oTxsSession1 or oTask is oTxsSession2:
3406	if oTask is oTxsSession1: iTask = 1;
3407	else: iTask = 2;
3408	reporter.log('txsRunTest2: #%u - isSuccess=%s getResult=%s' \
3409	% (iTask, oTask.isSuccess(), oTask.getResult()));
3410	self.removeTask(oTask);
3411	cPendingJobs -= 1;
3412	if cPendingJobs <= 0:
3413	fRc = True;
3414	break;
3415
3416	elif not self.handleTask(oTask, 'txsRunTest'):
3417	break;
3418
3419	self.removeTask(oTxsSession2);
3420	if not oTxsSession2.pollTask():
3421	oTxsSession2.cancelTask();
3422	else:
3423	reporter.error('txsRunTest2: asyncExec #2 failed');
3424
3425	self.removeTask(oTxsSession1);
3426	if not oTxsSession1.pollTask():
3427	oTxsSession1.cancelTask();
3428	else:
3429	reporter.error('txsRunTest2: asyncExec #1 failed');
3430
3431	reporter.testDone();
3432	return fRc;
3433
3434	# pylint: enable=R0914,R0913
3435

Note: See TracBrowser for help on using the repository browser.

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

Download in other formats: