vbox.py@ 61952

Last change on this file since 61952 was 61952, checked in by vboxsync, 9 years ago
testdriver/onRuntimeError: Log windows memory stats on HostMemoryLow.
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 148.7 KB

Line
1	# -- coding: utf-8 --
2	# $Id: vbox.py 61952 2016-06-30 09:53:56Z 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: 61952 $"
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	return True;
1781	except KeyboardInterrupt:
1782	raise;
1783	except:
1784	reporter.logXcpt('vbox.waitForTasksSleepWorker');
1785	return False;
1786
1787	#
1788	# Utility methods.
1789	#
1790
1791	def processEvents(self, cMsTimeout = 0):
1792	"""
1793	Processes events, returning after the first batch has been processed
1794	or the time limit has been reached.
1795
1796	Only Ctrl-C exception, no return.
1797	"""
1798	try:
1799	self.oVBoxMgr.waitForEvents(cMsTimeout);
1800	except KeyboardInterrupt:
1801	raise;
1802	except:
1803	pass;
1804	return None;
1805
1806	def processPendingEvents(self):
1807	""" processEvents(0) - no waiting. """
1808	return self.processEvents(0);
1809
1810	def sleep(self, cSecs):
1811	"""
1812	Sleep for a specified amount of time, processing XPCOM events all the while.
1813	"""
1814	cMsTimeout = long(cSecs * 1000);
1815	msStart = base.timestampMilli();
1816	self.processEvents(0);
1817	while True:
1818	cMsElapsed = base.timestampMilli() - msStart;
1819	if cMsElapsed > cMsTimeout:
1820	break;
1821	#reporter.log2('cMsTimeout=%s - cMsElapsed=%d => %s' % (cMsTimeout, cMsElapsed, cMsTimeout - cMsElapsed));
1822	self.processEvents(cMsTimeout - cMsElapsed);
1823	return None;
1824
1825	def _logVmInfoUnsafe(self, oVM): # pylint: disable=R0915,R0912
1826	"""
1827	Internal worker for logVmInfo that is wrapped in try/except.
1828
1829	This is copy, paste, search, replace and edit of infoCmd from vboxshell.py.
1830	"""
1831	oOsType = self.oVBox.getGuestOSType(oVM.OSTypeId)
1832	reporter.log(" Name: %s" % (oVM.name));
1833	reporter.log(" ID: %s" % (oVM.id));
1834	reporter.log(" OS Type: %s - %s" % (oVM.OSTypeId, oOsType.description));
1835	reporter.log(" Machine state: %s" % (oVM.state));
1836	reporter.log(" Session state: %s" % (oVM.sessionState));
1837	if self.fpApiVer >= 4.2:
1838	reporter.log(" Session PID: %u (%#x)" % (oVM.sessionPID, oVM.sessionPID));
1839	else:
1840	reporter.log(" Session PID: %u (%#x)" % (oVM.sessionPid, oVM.sessionPid));
1841	if self.fpApiVer >= 5.0:
1842	reporter.log(" Session Name: %s" % (oVM.sessionName));
1843	else:
1844	reporter.log(" Session Name: %s" % (oVM.sessionType));
1845	reporter.log(" CPUs: %s" % (oVM.CPUCount));
1846	reporter.log(" RAM: %sMB" % (oVM.memorySize));
1847	reporter.log(" VRAM: %sMB" % (oVM.VRAMSize));
1848	reporter.log(" Monitors: %s" % (oVM.monitorCount));
1849	if oVM.firmwareType == vboxcon.FirmwareType_BIOS: sType = "BIOS";
1850	elif oVM.firmwareType == vboxcon.FirmwareType_EFI: sType = "EFI";
1851	elif oVM.firmwareType == vboxcon.FirmwareType_EFI32: sType = "EFI32";
1852	elif oVM.firmwareType == vboxcon.FirmwareType_EFI64: sType = "EFI64";
1853	elif oVM.firmwareType == vboxcon.FirmwareType_EFIDUAL: sType = "EFIDUAL";
1854	else: sType = "unknown %s" % (oVM.firmwareType);
1855	reporter.log(" Firmware: %s" % (sType));
1856	reporter.log(" HwVirtEx: %s" % (oVM.getHWVirtExProperty(vboxcon.HWVirtExPropertyType_Enabled)));
1857	reporter.log(" VPID support: %s" % (oVM.getHWVirtExProperty(vboxcon.HWVirtExPropertyType_VPID)));
1858	reporter.log(" Nested paging: %s" % (oVM.getHWVirtExProperty(vboxcon.HWVirtExPropertyType_NestedPaging)));
1859	if self.fpApiVer >= 4.2 and hasattr(vboxcon, 'CPUPropertyType_LongMode'):
1860	reporter.log(" Long-mode: %s" % (oVM.getCPUProperty(vboxcon.CPUPropertyType_LongMode)));
1861	if self.fpApiVer >= 3.2:
1862	reporter.log(" PAE: %s" % (oVM.getCPUProperty(vboxcon.CPUPropertyType_PAE)));
1863	if self.fpApiVer < 5.0:
1864	reporter.log(" Synthetic CPU: %s" % (oVM.getCPUProperty(vboxcon.CPUPropertyType_Synthetic)));
1865	else:
1866	reporter.log(" PAE: %s" % (oVM.getCpuProperty(vboxcon.CpuPropertyType_PAE)));
1867	reporter.log(" Synthetic CPU: %s" % (oVM.getCpuProperty(vboxcon.CpuPropertyType_Synthetic)));
1868	reporter.log(" ACPI: %s" % (oVM.BIOSSettings.ACPIEnabled));
1869	reporter.log(" IO-APIC: %s" % (oVM.BIOSSettings.IOAPICEnabled));
1870	if self.fpApiVer >= 3.2:
1871	if self.fpApiVer >= 4.2:
1872	reporter.log(" HPET: %s" % (oVM.HPETEnabled));
1873	else:
1874	reporter.log(" HPET: %s" % (oVM.hpetEnabled));
1875	reporter.log(" 3D acceleration: %s" % (oVM.accelerate3DEnabled));
1876	reporter.log(" 2D acceleration: %s" % (oVM.accelerate2DVideoEnabled));
1877	reporter.log(" TeleporterEnabled: %s" % (oVM.teleporterEnabled));
1878	reporter.log(" TeleporterPort: %s" % (oVM.teleporterPort));
1879	reporter.log(" TeleporterAddress: %s" % (oVM.teleporterAddress));
1880	reporter.log(" TeleporterPassword: %s" % (oVM.teleporterPassword));
1881	reporter.log(" Clipboard mode: %s" % (oVM.clipboardMode));
1882	if self.fpApiVer >= 5.0:
1883	reporter.log(" Drag and drop mode: %s" % (oVM.dnDMode));
1884	elif self.fpApiVer >= 4.3:
1885	reporter.log(" Drag and drop mode: %s" % (oVM.dragAndDropMode));
1886	if self.fpApiVer >= 4.0:
1887	reporter.log(" VRDP server: %s" % (oVM.VRDEServer.enabled));
1888	try: sPorts = oVM.VRDEServer.getVRDEProperty("TCP/Ports");
1889	except: sPorts = "";
1890	reporter.log(" VRDP server ports: %s" % (sPorts));
1891	reporter.log(" VRDP auth: %s (%s)" % (oVM.VRDEServer.authType, oVM.VRDEServer.authLibrary));
1892	else:
1893	reporter.log(" VRDP server: %s" % (oVM.VRDPServer.enabled));
1894	reporter.log(" VRDP server ports: %s" % (oVM.VRDPServer.ports));
1895	reporter.log(" Last changed: %s" % (oVM.lastStateChange));
1896
1897	aoControllers = self.oVBoxMgr.getArray(oVM, 'storageControllers')
1898	if aoControllers:
1899	reporter.log(" Controllers:");
1900	for oCtrl in aoControllers:
1901	reporter.log(" %s %s bus: %s type: %s" % (oCtrl.name, oCtrl.controllerType, oCtrl.bus, oCtrl.controllerType));
1902	oAudioAdapter = oVM.audioAdapter;
1903	if oAudioAdapter.audioController == vboxcon.AudioControllerType_AC97: sType = "AC97";
1904	elif oAudioAdapter.audioController == vboxcon.AudioControllerType_SB16: sType = "SB16";
1905	elif oAudioAdapter.audioController == vboxcon.AudioControllerType_HDA: sType = "HDA";
1906	else: sType = "unknown %s" % (oAudioAdapter.audioController);
1907	reporter.log(" AudioController: %s" % (sType));
1908	reporter.log(" AudioEnabled: %s" % (oAudioAdapter.enabled));
1909
1910	self.processPendingEvents();
1911	aoAttachments = self.oVBoxMgr.getArray(oVM, 'mediumAttachments')
1912	if aoAttachments:
1913	reporter.log(" Attachments:");
1914	for oAtt in aoAttachments:
1915	sCtrl = "Controller: %s port: %s device: %s type: %s" % (oAtt.controller, oAtt.port, oAtt.device, oAtt.type);
1916	oMedium = oAtt.medium
1917	if oAtt.type == vboxcon.DeviceType_HardDisk:
1918	reporter.log(" %s: HDD" % sCtrl);
1919	reporter.log(" Id: %s" % (oMedium.id));
1920	reporter.log(" Name: %s" % (oMedium.name));
1921	reporter.log(" Format: %s" % (oMedium.format));
1922	reporter.log(" Location: %s" % (oMedium.location));
1923
1924	if oAtt.type == vboxcon.DeviceType_DVD:
1925	reporter.log(" %s: DVD" % sCtrl);
1926	if oMedium:
1927	reporter.log(" Id: %s" % (oMedium.id));
1928	reporter.log(" Name: %s" % (oMedium.name));
1929	if oMedium.hostDrive:
1930	reporter.log(" Host DVD %s" % (oMedium.location));
1931	if oAtt.passthrough:
1932	reporter.log(" [passthrough mode]");
1933	else:
1934	reporter.log(" Virtual image: %s" % (oMedium.location));
1935	reporter.log(" Size: %s" % (oMedium.size));
1936	else:
1937	reporter.log(" empty");
1938
1939	if oAtt.type == vboxcon.DeviceType_Floppy:
1940	reporter.log(" %s: Floppy" % sCtrl);
1941	if oMedium:
1942	reporter.log(" Id: %s" % (oMedium.id));
1943	reporter.log(" Name: %s" % (oMedium.name));
1944	if oMedium.hostDrive:
1945	reporter.log(" Host floppy: %s" % (oMedium.location));
1946	else:
1947	reporter.log(" Virtual image: %s" % (oMedium.location));
1948	reporter.log(" Size: %s" % (oMedium.size));
1949	else:
1950	reporter.log(" empty");
1951	self.processPendingEvents();
1952
1953	reporter.log(" Network Adapter:");
1954	for iSlot in range(0, 32):
1955	try: oNic = oVM.getNetworkAdapter(iSlot)
1956	except: break;
1957	if not oNic.enabled:
1958	reporter.log2(" slot #%d found but not enabled, skipping" % (iSlot,));
1959	continue;
1960	if oNic.adapterType == vboxcon.NetworkAdapterType_Am79C973: sType = "PCNet";
1961	elif oNic.adapterType == vboxcon.NetworkAdapterType_Am79C970A: sType = "PCNetOld";
1962	elif oNic.adapterType == vboxcon.NetworkAdapterType_I82545EM: sType = "E1000";
1963	elif oNic.adapterType == vboxcon.NetworkAdapterType_I82540EM: sType = "E1000Desk";
1964	elif oNic.adapterType == vboxcon.NetworkAdapterType_I82543GC: sType = "E1000Srv2";
1965	elif oNic.adapterType == vboxcon.NetworkAdapterType_Virtio: sType = "Virtio";
1966	else: sType = "unknown %s" % (oNic.adapterType);
1967	reporter.log(" slot #%d: type: %s (%s) MAC Address: %s lineSpeed: %s" % \
1968	(iSlot, sType, oNic.adapterType, oNic.MACAddress, oNic.lineSpeed) );
1969
1970	if oNic.attachmentType == vboxcon.NetworkAttachmentType_NAT:
1971	reporter.log(" attachmentType: NAT (%s)" % (oNic.attachmentType));
1972	if self.fpApiVer >= 4.1:
1973	reporter.log(" nat-network: %s" % (oNic.NATNetwork,));
1974	elif oNic.attachmentType == vboxcon.NetworkAttachmentType_Bridged:
1975	reporter.log(" attachmentType: Bridged (%s)" % (oNic.attachmentType));
1976	if self.fpApiVer >= 4.1:
1977	reporter.log(" hostInterface: %s" % (oNic.bridgedInterface));
1978	else:
1979	reporter.log(" hostInterface: %s" % (oNic.hostInterface));
1980	elif oNic.attachmentType == vboxcon.NetworkAttachmentType_Internal:
1981	reporter.log(" attachmentType: Internal (%s)" % (oNic.attachmentType));
1982	reporter.log(" intnet-name: %s" % (oNic.internalNetwork,));
1983	elif oNic.attachmentType == vboxcon.NetworkAttachmentType_HostOnly:
1984	reporter.log(" attachmentType: HostOnly (%s)" % (oNic.attachmentType));
1985	if self.fpApiVer >= 4.1:
1986	reporter.log(" hostInterface: %s" % (oNic.hostOnlyInterface));
1987	else:
1988	reporter.log(" hostInterface: %s" % (oNic.hostInterface));
1989	else:
1990	if self.fpApiVer >= 4.1:
1991	if oNic.attachmentType == vboxcon.NetworkAttachmentType_Generic:
1992	reporter.log(" attachmentType: Generic (%s)" % (oNic.attachmentType));
1993	reporter.log(" generic-driver: %s" % (oNic.GenericDriver));
1994	else:
1995	reporter.log(" attachmentType: unknown-%s" % (oNic.attachmentType));
1996	else:
1997	reporter.log(" attachmentType: unknown-%s" % (oNic.attachmentType));
1998	if oNic.traceEnabled:
1999	reporter.log(" traceFile: %s" % (oNic.traceFile));
2000	self.processPendingEvents();
2001	return True;
2002
2003	def logVmInfo(self, oVM): # pylint: disable=R0915,R0912
2004	"""
2005	Logs VM configuration details.
2006
2007	This is copy, past, search, replace and edit of infoCmd from vboxshell.py.
2008	"""
2009	try:
2010	fRc = self._logVmInfoUnsafe(oVM);
2011	except:
2012	reporter.logXcpt();
2013	fRc = False;
2014	return fRc;
2015
2016	def logVmInfoByName(self, sName):
2017	"""
2018	logVmInfo + getVmByName.
2019	"""
2020	return self.logVmInfo(self.getVmByName(sName));
2021
2022	def tryFindGuestOsId(self, sIdOrDesc):
2023	"""
2024	Takes a guest OS ID or Description and returns the ID.
2025	If nothing matching it is found, the input is returned unmodified.
2026	"""
2027
2028	if self.fpApiVer >= 4.0:
2029	if sIdOrDesc == 'Solaris (64 bit)':
2030	sIdOrDesc = 'Oracle Solaris 10 5/09 and earlier (64 bit)';
2031
2032	try:
2033	aoGuestTypes = self.oVBoxMgr.getArray(self.oVBox, 'GuestOSTypes');
2034	except:
2035	reporter.logXcpt();
2036	else:
2037	for oGuestOS in aoGuestTypes:
2038	try:
2039	sId = oGuestOS.id;
2040	sDesc = oGuestOS.description;
2041	except:
2042	reporter.logXcpt();
2043	else:
2044	if sIdOrDesc == sId or sIdOrDesc == sDesc:
2045	sIdOrDesc = sId;
2046	break;
2047	self.processPendingEvents();
2048	return sIdOrDesc
2049
2050	def resourceFindVmHd(self, sVmName, sFlavor):
2051	"""
2052	Search the test resources for the most recent VM HD.
2053
2054	Returns path relative to the test resource root.
2055	"""
2056	## @todo implement a proper search algo here.
2057	return '4.2/' + sFlavor + '/' + sVmName + '/t-' + sVmName + '.vdi';
2058
2059
2060	#
2061	# VM Api wrappers that logs errors, hides exceptions and other details.
2062	#
2063
2064	# pylint: disable=R0913,R0914,R0915
2065	def createTestVM(self, sName, iGroup, sHd = None, cMbRam = None, cCpus = 1, fVirtEx = None, fNestedPaging = None, \
2066	sDvdImage = None, sKind = "Other", fIoApic = None, fPae = None, fFastBootLogo = True, \
2067	eNic0Type = None, eNic0AttachType = None, sNic0NetName = 'default', sNic0MacAddr = 'grouped', \
2068	sFloppy = None, fNatForwardingForTxs = None, sHddControllerType = 'IDE Controller', \
2069	fVmmDevTestingPart = None, fVmmDevTestingMmio = False, sFirmwareType = 'bios'):
2070	"""
2071	Creates a test VM with a immutable HD from the test resources.
2072	"""
2073	if not self.importVBoxApi():
2074	return None;
2075
2076	# create + register the VM
2077	try:
2078	if self.fpApiVer >= 4.2: # Introduces grouping (third parameter, empty for now).
2079	oVM = self.oVBox.createMachine("", sName, [], self.tryFindGuestOsId(sKind), "");
2080	elif self.fpApiVer >= 4.0:
2081	oVM = self.oVBox.createMachine("", sName, self.tryFindGuestOsId(sKind), "", False);
2082	elif self.fpApiVer >= 3.2:
2083	oVM = self.oVBox.createMachine(sName, self.tryFindGuestOsId(sKind), "", "", False);
2084	else:
2085	oVM = self.oVBox.createMachine(sName, self.tryFindGuestOsId(sKind), "", "");
2086	try:
2087	oVM.saveSettings();
2088	try:
2089	self.oVBox.registerMachine(oVM);
2090	except:
2091	raise;
2092	except:
2093	reporter.logXcpt();
2094	if self.fpApiVer >= 4.0:
2095	try:
2096	if self.fpApiVer >= 4.3:
2097	oProgress = oVM.deleteConfig([]);
2098	else:
2099	oProgress = oVM.delete(None);
2100	self.waitOnProgress(oProgress);
2101	except:
2102	reporter.logXcpt();
2103	else:
2104	try: oVM.deleteSettings();
2105	except: reporter.logXcpt();
2106	raise;
2107	except:
2108	reporter.errorXcpt('failed to create vm "%s"' % (sName));
2109	return None;
2110
2111	# Configure the VM.
2112	fRc = True;
2113	oSession = self.openSession(oVM);
2114	if oSession is not None:
2115	fRc = oSession.setupPreferredConfig();
2116
2117	if fRc and cMbRam is not None :
2118	fRc = oSession.setRamSize(cMbRam);
2119	if fRc and cCpus is not None:
2120	fRc = oSession.setCpuCount(cCpus);
2121	if fRc and fVirtEx is not None:
2122	fRc = oSession.enableVirtEx(fVirtEx);
2123	if fRc and fNestedPaging is not None:
2124	fRc = oSession.enableNestedPaging(fNestedPaging);
2125	if fRc and fIoApic is not None:
2126	fRc = oSession.enableIoApic(fIoApic);
2127	if fRc and fPae is not None:
2128	fRc = oSession.enablePae(fPae);
2129	if fRc and sDvdImage is not None:
2130	fRc = oSession.attachDvd(sDvdImage);
2131	if fRc and sHd is not None:
2132	fRc = oSession.attachHd(sHd, sHddControllerType);
2133	if fRc and sFloppy is not None:
2134	fRc = oSession.attachFloppy(sFloppy);
2135	if fRc and eNic0Type is not None:
2136	fRc = oSession.setNicType(eNic0Type, 0);
2137	if fRc and (eNic0AttachType is not None or (sNic0NetName is not None and sNic0NetName != 'default')):
2138	fRc = oSession.setNicAttachment(eNic0AttachType, sNic0NetName, 0);
2139	if fRc and sNic0MacAddr is not None:
2140	if sNic0MacAddr == 'grouped':
2141	sNic0MacAddr = '%02u' % (iGroup);
2142	fRc = oSession.setNicMacAddress(sNic0MacAddr, 0);
2143	if fRc and fNatForwardingForTxs is True:
2144	fRc = oSession.setupNatForwardingForTxs();
2145	if fRc and fFastBootLogo is not None:
2146	fRc = oSession.setupBootLogo(fFastBootLogo);
2147	if fRc and self.fEnableVrdp:
2148	fRc = oSession.setupVrdp(True, self.uVrdpBasePort + iGroup);
2149	if fRc and fVmmDevTestingPart is not None:
2150	fRc = oSession.enableVmmDevTestingPart(fVmmDevTestingPart, fVmmDevTestingMmio);
2151	if fRc and sFirmwareType == 'bios':
2152	fRc = oSession.setFirmwareType(vboxcon.FirmwareType_BIOS);
2153	elif sFirmwareType == 'efi':
2154	fRc = oSession.setFirmwareType(vboxcon.FirmwareType_EFI);
2155	if fRc and self.fEnableDebugger:
2156	fRc = oSession.setExtraData('VBoxInternal/DBGC/Enabled', '1');
2157
2158	if fRc: fRc = oSession.saveSettings();
2159	if not fRc: oSession.discardSettings(True);
2160	oSession.close();
2161	if not fRc:
2162	try: self.oVBox.unregisterMachine(oVM.id);
2163	except: pass;
2164	if self.fpApiVer >= 4.0:
2165	try:
2166	if self.fpApiVer >= 4.3:
2167	oProgress = oVM.deleteConfig([]);
2168	else:
2169	oProgress = oVM.delete(None);
2170	self.waitOnProgress(oProgress);
2171	except:
2172	reporter.logXcpt();
2173	else:
2174	try: oVM.deleteSettings();
2175	except: reporter.logXcpt();
2176	return None;
2177
2178	# success.
2179	reporter.log('created "%s" with name "%s"' % (oVM.id, sName));
2180	self.aoVMs.append(oVM);
2181	self.logVmInfo(oVM); # testing...
2182	return oVM;
2183	# pylint: enable=R0913,R0914,R0915
2184
2185	def addTestMachine(self, sNameOrId, fQuiet = False):
2186	"""
2187	Adds an already existing (that is, configured) test VM to the
2188	test VM list.
2189	"""
2190	# find + add the VM to the list.
2191	try:
2192	if self.fpApiVer >= 4.0:
2193	oVM = self.oVBox.findMachine(sNameOrId);
2194	else:
2195	reporter.error('Port me!'); ## @todo Add support for older version < 4.0.
2196	except:
2197	reporter.errorXcpt('could not find vm "%s"' % (sNameOrId,));
2198	return None;
2199
2200	self.aoVMs.append(oVM);
2201	if not fQuiet:
2202	reporter.log('Added "%s" with name "%s"' % (oVM.id, sNameOrId));
2203	self.logVmInfo(oVM);
2204	return oVM;
2205
2206	def openSession(self, oVM):
2207	"""
2208	Opens a session for the VM. Returns the a Session wrapper object that
2209	will automatically close the session when the wrapper goes out of scope.
2210
2211	On failure None is returned and an error is logged.
2212	"""
2213	try:
2214	sUuid = oVM.id;
2215	except:
2216	reporter.errorXcpt('failed to get the UUID for VM "%s"' % (oVM,));
2217	return None;
2218
2219	# This loop is a kludge to deal with us racing the closing of the
2220	# direct session of a previous VM run. See waitOnDirectSessionClose.
2221	for i in range(10):
2222	try:
2223	if self.fpApiVer <= 3.2:
2224	oSession = self.oVBoxMgr.openMachineSession(sUuid);
2225	else:
2226	oSession = self.oVBoxMgr.openMachineSession(oVM);
2227	break;
2228	except:
2229	if i == 9:
2230	reporter.errorXcpt('failed to open session for "%s" ("%s")' % (sUuid, oVM));
2231	return None;
2232	if i > 0:
2233	reporter.logXcpt('warning: failed to open session for "%s" ("%s") - retrying in %u secs' % (sUuid, oVM, i));
2234	self.waitOnDirectSessionClose(oVM, 5000 + i * 1000);
2235	from testdriver.vboxwrappers import SessionWrapper;
2236	return SessionWrapper(oSession, oVM, self.oVBox, self.oVBoxMgr, self, False);
2237
2238	def getVmByName(self, sName):
2239	"""
2240	Get a test VM by name. Returns None if not found, logged.
2241	"""
2242	# Look it up in our 'cache'.
2243	for oVM in self.aoVMs:
2244	try:
2245	#reporter.log2('cur: %s / %s (oVM=%s)' % (oVM.name, oVM.id, oVM));
2246	if oVM.name == sName:
2247	return oVM;
2248	except:
2249	reporter.errorXcpt('failed to get the name from the VM "%s"' % (oVM));
2250
2251	# Look it up the standard way.
2252	return self.addTestMachine(sName, fQuiet = True);
2253
2254	def getVmByUuid(self, sUuid):
2255	"""
2256	Get a test VM by uuid. Returns None if not found, logged.
2257	"""
2258	# Look it up in our 'cache'.
2259	for oVM in self.aoVMs:
2260	try:
2261	if oVM.id == sUuid:
2262	return oVM;
2263	except:
2264	reporter.errorXcpt('failed to get the UUID from the VM "%s"' % (oVM));
2265
2266	# Look it up the standard way.
2267	return self.addTestMachine(sUuid, fQuiet = True);
2268
2269	def waitOnProgress(self, oProgress, cMsTimeout = 1000000, fErrorOnTimeout = True, cMsInterval = 1000):
2270	"""
2271	Waits for a progress object to complete. Returns the status code.
2272	"""
2273	# Wait for progress no longer than cMsTimeout time period.
2274	tsStart = datetime.datetime.now()
2275	while True:
2276	self.processPendingEvents();
2277	try:
2278	if oProgress.completed:
2279	break;
2280	except:
2281	return -1;
2282	self.processPendingEvents();
2283
2284	tsNow = datetime.datetime.now()
2285	tsDelta = tsNow - tsStart
2286	if ((tsDelta.microseconds + tsDelta.seconds * 1000000) / 1000) > cMsTimeout:
2287	if fErrorOnTimeout:
2288	reporter.errorTimeout('Timeout while waiting for progress.')
2289	return -1
2290
2291	try: oProgress.waitForCompletion(cMsInterval);
2292	except: return -2;
2293
2294	try: rc = oProgress.resultCode;
2295	except: rc = -2;
2296	self.processPendingEvents();
2297	return rc;
2298
2299	def waitOnDirectSessionClose(self, oVM, cMsTimeout):
2300	"""
2301	Waits for the VM process to close it's current direct session.
2302
2303	Returns None.
2304	"""
2305	# Get the original values so we're not subject to
2306	try:
2307	eCurState = oVM.sessionState;
2308	if self.fpApiVer >= 5.0:
2309	sCurName = sOrgName = oVM.sessionName;
2310	else:
2311	sCurName = sOrgName = oVM.sessionType;
2312	if self.fpApiVer >= 4.2:
2313	iCurPid = iOrgPid = oVM.sessionPID;
2314	else:
2315	iCurPid = iOrgPid = oVM.sessionPid;
2316	except Exception, oXcpt:
2317	if ComError.notEqual(oXcpt, ComError.E_ACCESSDENIED):
2318	reporter.logXcpt();
2319	self.processPendingEvents();
2320	return None;
2321	self.processPendingEvents();
2322
2323	msStart = base.timestampMilli();
2324	while iCurPid == iOrgPid \
2325	and sCurName == sOrgName \
2326	and sCurName != '' \
2327	and base.timestampMilli() - msStart < cMsTimeout \
2328	and ( eCurState == vboxcon.SessionState_Unlocking \
2329	or eCurState == vboxcon.SessionState_Spawning \
2330	or eCurState == vboxcon.SessionState_Locked):
2331	self.processEvents(1000);
2332	try:
2333	eCurState = oVM.sessionState;
2334	sCurName = oVM.sessionName if self.fpApiVer >= 5.0 else oVM.sessionType;
2335	iCurPid = oVM.sessionPID if self.fpApiVer >= 4.2 else oVM.sessionPid;
2336	except Exception, oXcpt:
2337	if ComError.notEqual(oXcpt, ComError.E_ACCESSDENIED):
2338	reporter.logXcpt();
2339	break;
2340	self.processPendingEvents();
2341	self.processPendingEvents();
2342	return None;
2343
2344	def uploadStartupLogFile(self, oVM, sVmName):
2345	"""
2346	Uploads the VBoxStartup.log when present.
2347	"""
2348	fRc = True;
2349	try:
2350	sLogFile = os.path.join(oVM.logFolder, 'VBoxStartup.log');
2351	except:
2352	reporter.logXcpt();
2353	fRc = False;
2354	else:
2355	if os.path.isfile(sLogFile):
2356	reporter.addLogFile(sLogFile, 'log/release/vm', '%s startup log' % (sVmName, ),
2357	sAltName = '%s-%s' % (sVmName, os.path.basename(sLogFile),));
2358	return fRc;
2359
2360	def startVmEx(self, oVM, fWait = True, sType = None, sName = None, asEnv = None): # pylint: disable=R0914,R0915
2361	"""
2362	Start the VM, returning the VM session and progress object on success.
2363	The session is also added to the task list and to the aoRemoteSessions set.
2364
2365	asEnv is a list of string on the putenv() form.
2366
2367	On failure (None, None) is returned and an error is logged.
2368	"""
2369	# Massage and check the input.
2370	if sType is None:
2371	sType = self.sSessionType;
2372	if sName is None:
2373	try: sName = oVM.name;
2374	except: sName = 'bad-vm-handle';
2375	reporter.log('startVmEx: sName=%s fWait=%s sType=%s' % (sName, fWait, sType));
2376	if oVM is None:
2377	return (None, None);
2378
2379	## @todo Do this elsewhere.
2380	# Hack alert. Disables all annoying GUI popups.
2381	if sType == 'gui' and len(self.aoRemoteSessions) == 0:
2382	try:
2383	self.oVBox.setExtraData('GUI/Input/AutoCapture', 'false');
2384	if self.fpApiVer >= 3.2:
2385	self.oVBox.setExtraData('GUI/LicenseAgreed', '8');
2386	else:
2387	self.oVBox.setExtraData('GUI/LicenseAgreed', '7');
2388	self.oVBox.setExtraData('GUI/RegistrationData', 'triesLeft=0');
2389	self.oVBox.setExtraData('GUI/SUNOnlineData', 'triesLeft=0');
2390	self.oVBox.setExtraData('GUI/SuppressMessages', 'confirmVMReset,remindAboutMouseIntegrationOn,'
2391	'remindAboutMouseIntegrationOff,remindAboutPausedVMInput,confirmInputCapture,'
2392	'confirmGoingFullscreen,remindAboutInaccessibleMedia,remindAboutWrongColorDepth,'
2393	'confirmRemoveMedium,allPopupPanes,allMessageBoxes,all');
2394	self.oVBox.setExtraData('GUI/UpdateDate', 'never');
2395	self.oVBox.setExtraData('GUI/PreventBetaWarning', self.oVBox.version);
2396	except:
2397	reporter.logXcpt();
2398
2399	# The UUID for the name.
2400	try:
2401	sUuid = oVM.id;
2402	except:
2403	reporter.errorXcpt('failed to get the UUID for VM "%s"' % (oVM));
2404	return (None, None);
2405	self.processPendingEvents();
2406
2407	# Construct the environment.
2408	sLogFile = '%s/VM-%s.log' % (self.sScratchPath, sUuid);
2409	try: os.remove(sLogFile);
2410	except: pass;
2411	if self.sLogSessionDest:
2412	sLogDest = self.sLogSessionDest;
2413	else:
2414	sLogDest = 'file=%s' % sLogFile;
2415	sEnv = 'VBOX_LOG=%s\nVBOX_LOG_FLAGS=%s\nVBOX_LOG_DEST=%s\nVBOX_RELEASE_LOG_FLAGS=append time' \
2416	% (self.sLogSessionGroups, self.sLogSessionFlags, sLogDest,);
2417	if sType == 'gui':
2418	sEnv += '\nVBOX_GUI_DBG_ENABLED=1'
2419	if asEnv is not None and len(asEnv) > 0:
2420	sEnv += '\n' + ('\n'.join(asEnv));
2421
2422	# Shortcuts for local testing.
2423	oProgress = oWrapped = None;
2424	oTestVM = self.oTestVmSet.findTestVmByName(sName) if self.oTestVmSet is not None else None;
2425	try:
2426	if oTestVM is not None \
2427	and oTestVM.fSnapshotRestoreCurrent is True:
2428	if oVM.state is vboxcon.MachineState_Running:
2429	reporter.log2('Machine "%s" already running.' % (sName,));
2430	oProgress = None;
2431	oWrapped = self.openSession(oVM);
2432	else:
2433	reporter.log2('Checking if snapshot for machine "%s" exists.' % (sName,));
2434	oSessionWrapperRestore = self.openSession(oVM);
2435	if oSessionWrapperRestore is not None:
2436	oSnapshotCur = oVM.currentSnapshot;
2437	if oSnapshotCur is not None:
2438	reporter.log2('Restoring snapshot for machine "%s".' % (sName,));
2439	oSessionWrapperRestore.restoreSnapshot(oSnapshotCur);
2440	reporter.log2('Current snapshot for machine "%s" restored.' % (sName,));
2441	else:
2442	reporter.log('warning: no current snapshot for machine "%s" found.' % (sName,));
2443	oSessionWrapperRestore.close();
2444	except:
2445	reporter.errorXcpt();
2446	return (None, None);
2447
2448	# Open a remote session, wait for this operation to complete.
2449	# (The loop is a kludge to deal with us racing the closing of the
2450	# direct session of a previous VM run. See waitOnDirectSessionClose.)
2451	if oWrapped is None:
2452	for i in range(10):
2453	try:
2454	if self.fpApiVer < 4.3 \
2455	or (self.fpApiVer == 4.3 and not hasattr(self.oVBoxMgr, 'getSessionObject')):
2456	oSession = self.oVBoxMgr.mgr.getSessionObject(self.oVBox); # pylint: disable=E1101
2457	else:
2458	oSession = self.oVBoxMgr.getSessionObject(self.oVBox); # pylint: disable=E1101
2459	if self.fpApiVer < 3.3:
2460	oProgress = self.oVBox.openRemoteSession(oSession, sUuid, sType, sEnv);
2461	else:
2462	oProgress = oVM.launchVMProcess(oSession, sType, sEnv);
2463	break;
2464	except:
2465	if i == 9:
2466	reporter.errorXcpt('failed to start VM "%s" ("%s"), aborting.' % (sUuid, sName));
2467	return (None, None);
2468	oSession = None;
2469	if i >= 0:
2470	reporter.logXcpt('warning: failed to start VM "%s" ("%s") - retrying in %u secs.' % (sUuid, oVM, i)); # pylint: disable=C0301
2471	self.waitOnDirectSessionClose(oVM, 5000 + i * 1000);
2472	if fWait and oProgress is not None:
2473	rc = self.waitOnProgress(oProgress);
2474	if rc < 0:
2475	self.waitOnDirectSessionClose(oVM, 5000);
2476	try:
2477	if oSession is not None:
2478	oSession.close();
2479	except: pass;
2480	reportError(oProgress, 'failed to open session for "%s"' % (sName));
2481	self.uploadStartupLogFile(oVM, sName);
2482	return (None, None);
2483	reporter.log2('waitOnProgress -> %s' % (rc,));
2484
2485	# Wrap up the session object and push on to the list before returning it.
2486	if oWrapped is None:
2487	from testdriver.vboxwrappers import SessionWrapper;
2488	oWrapped = SessionWrapper(oSession, oVM, self.oVBox, self.oVBoxMgr, self, True, sName, sLogFile);
2489
2490	oWrapped.registerEventHandlerForTask();
2491	self.aoRemoteSessions.append(oWrapped);
2492	if oWrapped is not self.aoRemoteSessions[len(self.aoRemoteSessions) - 1]:
2493	reporter.error('not by reference: oWrapped=%s aoRemoteSessions[%s]=%s'
2494	% (oWrapped, len(self.aoRemoteSessions) - 1,
2495	self.aoRemoteSessions[len(self.aoRemoteSessions) - 1]));
2496	self.addTask(oWrapped);
2497
2498	reporter.log2('startVmEx: oSession=%s, oSessionWrapper=%s, oProgress=%s' % (oSession, oWrapped, oProgress));
2499
2500	from testdriver.vboxwrappers import ProgressWrapper;
2501	return (oWrapped, ProgressWrapper(oProgress, self.oVBoxMgr, self,
2502	'starting %s' % (sName,)) if oProgress else None);
2503
2504	def startVm(self, oVM, sType=None, sName = None, asEnv = None):
2505	""" Simplified version of startVmEx. """
2506	oSession, _ = self.startVmEx(oVM, True, sType, sName, asEnv = asEnv);
2507	return oSession;
2508
2509	def startVmByNameEx(self, sName, fWait=True, sType=None, asEnv = None):
2510	"""
2511	Start the VM, returning the VM session and progress object on success.
2512	The session is also added to the task list and to the aoRemoteSessions set.
2513
2514	On failure (None, None) is returned and an error is logged.
2515	"""
2516	oVM = self.getVmByName(sName);
2517	if oVM is None:
2518	return (None, None);
2519	return self.startVmEx(oVM, fWait, sType, sName, asEnv = asEnv);
2520
2521	def startVmByName(self, sName, sType=None, asEnv = None):
2522	"""
2523	Start the VM, returning the VM session on success. The session is
2524	also added to the task list and to the aoRemoteSessions set.
2525
2526	On failure None is returned and an error is logged.
2527	"""
2528	oSession, _ = self.startVmByNameEx(sName, True, sType, asEnv = asEnv);
2529	return oSession;
2530
2531	def terminateVmBySession(self, oSession, oProgress = None, fTakeScreenshot = None):
2532	"""
2533	Terminates the VM specified by oSession and adds the release logs to
2534	the test report.
2535
2536	This will try archive this by using powerOff, but will resort to
2537	tougher methods if that fails.
2538
2539	The session will always be removed from the task list.
2540	The session will be closed unless we fail to kill the process.
2541	The session will be removed from the remote session list if closed.
2542
2543	The progress object (a wrapper!) is for teleportation and similar VM
2544	operations, it will be attempted canceled before powering off the VM.
2545	Failures are logged but ignored.
2546	The progress object will always be removed from the task list.
2547
2548	Returns True if powerOff and session close both succeed.
2549	Returns False if on failure (logged), including when we successfully
2550	kill the VM process.
2551	"""
2552	reporter.log2('terminateVmBySession: oSession=%s (pid=%s) oProgress=%s' % (oSession.sName, oSession.getPid(), oProgress));
2553
2554	# Call getPid first to make sure the PID is cached in the wrapper.
2555	oSession.getPid();
2556
2557	#
2558	# If the host is out of memory, just skip all the info collection as it
2559	# requires memory too and seems to wedge.
2560	#
2561	sLastScreenshotPath = None;
2562	sOsKernelLog = None;
2563	sVgaText = None;
2564	asMiscInfos = [];
2565	if not oSession.fHostMemoryLow:
2566	#
2567	# Pause the VM if we're going to take any screenshots or dig into the
2568	# guest. Failures are quitely ignored.
2569	#
2570	if self.fAlwaysUploadLogs or reporter.testErrorCount() > 0:
2571	try:
2572	if oSession.oVM.state in [ vboxcon.MachineState_Running,
2573	vboxcon.MachineState_LiveSnapshotting,
2574	vboxcon.MachineState_Teleporting ]:
2575	oSession.o.console.pause();
2576	except:
2577	reporter.logXcpt();
2578
2579	#
2580	# Take Screenshot and upload it (see below) to Test Manager if appropriate/requested.
2581	#
2582	if fTakeScreenshot is True or self.fAlwaysUploadScreenshots or reporter.testErrorCount() > 0:
2583	sLastScreenshotPath = os.path.join(self.sScratchPath, "LastScreenshot-%s.png" % oSession.sName);
2584	fRc = oSession.takeScreenshot(sLastScreenshotPath);
2585	if fRc is not True:
2586	sLastScreenshotPath = None;
2587
2588	# Query the OS kernel log from the debugger if appropriate/requested.
2589	if self.fAlwaysUploadLogs or reporter.testErrorCount() > 0:
2590	sOsKernelLog = oSession.queryOsKernelLog();
2591
2592	# Do "info vgatext all" separately.
2593	if self.fAlwaysUploadLogs or reporter.testErrorCount() > 0:
2594	sVgaText = oSession.queryDbgInfoVgaText();
2595
2596	# Various infos (do after kernel because of symbols).
2597	if self.fAlwaysUploadLogs or reporter.testErrorCount() > 0:
2598	# Dump the guest stack for all CPUs.
2599	cCpus = oSession.getCpuCount();
2600	if cCpus > 0:
2601	for iCpu in xrange(0, cCpus):
2602	sThis = oSession.queryDbgGuestStack(iCpu);
2603	if sThis is not None and len(sThis) > 0:
2604	asMiscInfos += [
2605	'================ start guest stack VCPU %s ================\n' % (iCpu,),
2606	sThis,
2607	'================ end guest stack VCPU %s ==================\n' % (iCpu,),
2608	];
2609
2610	for sInfo, sArg in [ ('mode', 'all'),
2611	('fflags', ''),
2612	('cpumguest', 'verbose all'),
2613	('cpumguestinstr', 'symbol all'),
2614	('pic', ''),
2615	('apic', ''),
2616	('ioapic', ''),
2617	('pit', ''),
2618	('phys', ''),
2619	('clocks', ''),
2620	('timers', ''),
2621	('gdtguest', ''),
2622	('ldtguest', ''),
2623	]:
2624	if sInfo in ['apic',] and self.fpApiVer < 5.1: # asserts and burns
2625	continue;
2626	sThis = oSession.queryDbgInfo(sInfo, sArg);
2627	if sThis is not None and len(sThis) > 0:
2628	if sThis[-1] != '\n':
2629	sThis += '\n';
2630	asMiscInfos += [
2631	'================ start %s %s ================\n' % (sInfo, sArg),
2632	sThis,
2633	'================ end %s %s ==================\n' % (sInfo, sArg),
2634	];
2635
2636	#
2637	# Terminate the VM
2638	#
2639
2640	# Cancel the progress object if specified.
2641	if oProgress is not None:
2642	if not oProgress.isCompleted() and oProgress.isCancelable():
2643	reporter.log2('terminateVmBySession: canceling "%s"...' % (oProgress.sName));
2644	try:
2645	oProgress.o.cancel();
2646	except:
2647	reporter.logXcpt();
2648	else:
2649	oProgress.wait();
2650	self.removeTask(oProgress);
2651
2652	# Check if the VM has terminated by it self before powering it off.
2653	fClose = True;
2654	fRc = True;
2655	if oSession.needsPoweringOff():
2656	reporter.log('terminateVmBySession: powering off "%s"...' % (oSession.sName,));
2657	fRc = oSession.powerOff(fFudgeOnFailure = False);
2658	if fRc is not True:
2659	# power off failed, try terminate it in a nice manner.
2660	fRc = False;
2661	uPid = oSession.getPid();
2662	if uPid is not None:
2663	reporter.error('terminateVmBySession: Terminating PID %u (VM %s)' % (uPid, oSession.sName));
2664	fClose = base.processTerminate(uPid);
2665	if fClose is True:
2666	self.waitOnDirectSessionClose(oSession.oVM, 5000);
2667	fClose = oSession.waitForTask(1000);
2668
2669	if fClose is not True:
2670	# Being nice failed...
2671	reporter.error('terminateVmBySession: Termination failed, trying to kill PID %u (VM %s) instead' \
2672	% (uPid, oSession.sName));
2673	fClose = base.processKill(uPid);
2674	if fClose is True:
2675	self.waitOnDirectSessionClose(oSession.oVM, 5000);
2676	fClose = oSession.waitForTask(1000);
2677	if fClose is not True:
2678	reporter.error('terminateVmBySession: Failed to kill PID %u (VM %s)' % (uPid, oSession.sName));
2679
2680	# The final steps.
2681	if fClose is True:
2682	reporter.log('terminateVmBySession: closing session "%s"...' % (oSession.sName,));
2683	oSession.close();
2684	self.waitOnDirectSessionClose(oSession.oVM, 10000);
2685	try:
2686	eState = oSession.oVM.state;
2687	except:
2688	reporter.logXcpt();
2689	else:
2690	if eState == vboxcon.MachineState_Aborted:
2691	reporter.error('terminateVmBySession: The VM "%s" aborted!' % (oSession.sName,));
2692	self.removeTask(oSession);
2693
2694	#
2695	# Add the release log, debug log and a screenshot of the VM to the test report.
2696	#
2697	if self.fAlwaysUploadLogs or reporter.testErrorCount() > 0:
2698	oSession.addLogsToReport();
2699
2700	# Add a screenshot if it has been requested and taken successfully.
2701	if sLastScreenshotPath is not None:
2702	if reporter.testErrorCount() > 0:
2703	reporter.addLogFile(sLastScreenshotPath, 'screenshot/failure', 'Last VM screenshot');
2704	else:
2705	reporter.addLogFile(sLastScreenshotPath, 'screenshot/success', 'Last VM screenshot');
2706
2707	# Add the guest OS log if it has been requested and taken successfully.
2708	if sOsKernelLog is not None:
2709	reporter.addLogString(sOsKernelLog, 'kernel.log', 'log/guest/kernel', 'Guest OS kernel log');
2710
2711	# Add "info vgatext all" if we've got it.
2712	if sVgaText is not None:
2713	reporter.addLogString(sVgaText, 'vgatext.txt', 'info/vgatext', 'info vgatext all');
2714
2715	# Add the "info xxxx" items if we've got any.
2716	if len(asMiscInfos) > 0:
2717	reporter.addLogString(u''.join(asMiscInfos), 'info.txt', 'info/collection', 'A bunch of info items.');
2718
2719
2720	return fRc;
2721
2722
2723	#
2724	# Some information query functions (mix).
2725	#
2726	# Methods require the VBox API. If the information is provided by both
2727	# the testboxscript as well as VBox API, we'll check if it matches.
2728	#
2729
2730	def _hasHostCpuFeature(self, sEnvVar, sEnum, fpApiMinVer, fQuiet):
2731	"""
2732	Common Worker for hasHostNestedPaging() and hasHostHwVirt().
2733
2734	Returns True / False.
2735	Raises exception on environment / host mismatch.
2736	"""
2737	fEnv = os.environ.get(sEnvVar, None);
2738	if fEnv is not None:
2739	fEnv = fEnv.lower() not in [ 'false', 'f', 'not', 'no', 'n', '0', ];
2740
2741	fVBox = None;
2742	self.importVBoxApi();
2743	if self.fpApiVer >= fpApiMinVer and hasattr(vboxcon, sEnum):
2744	try:
2745	fVBox = self.oVBox.host.getProcessorFeature(getattr(vboxcon, sEnum));
2746	except:
2747	if not fQuiet:
2748	reporter.logXcpt();
2749
2750	if fVBox is not None:
2751	if fEnv is not None:
2752	if fEnv != fVBox and not fQuiet:
2753	reporter.log('TestBox configuration overwritten: fVBox=%s (%s) vs. fEnv=%s (%s)'
2754	% (fVBox, sEnum, fEnv, sEnvVar));
2755	return fEnv;
2756	return fVBox;
2757	if fEnv is not None:
2758	return fEnv;
2759	return False;
2760
2761	def hasHostHwVirt(self, fQuiet = False):
2762	"""
2763	Checks if hardware assisted virtualization is supported by the host.
2764
2765	Returns True / False.
2766	Raises exception on environment / host mismatch.
2767	"""
2768	return self._hasHostCpuFeature('TESTBOX_HAS_HW_VIRT', 'ProcessorFeature_HWVirtEx', 3.1, fQuiet);
2769
2770	def hasHostNestedPaging(self, fQuiet = False):
2771	"""
2772	Checks if nested paging is supported by the host.
2773
2774	Returns True / False.
2775	Raises exception on environment / host mismatch.
2776	"""
2777	return self._hasHostCpuFeature('TESTBOX_HAS_NESTED_PAGING', 'ProcessorFeature_NestedPaging', 4.2, fQuiet) \
2778	and self.hasHostHwVirt(fQuiet);
2779
2780	def hasHostLongMode(self, fQuiet = False):
2781	"""
2782	Checks if the host supports 64-bit guests.
2783
2784	Returns True / False.
2785	Raises exception on environment / host mismatch.
2786	"""
2787	# Note that the testboxscript doesn't export this variable atm.
2788	return self._hasHostCpuFeature('TESTBOX_HAS_LONG_MODE', 'ProcessorFeature_LongMode', 3.1, fQuiet);
2789
2790	def getHostCpuCount(self, fQuiet = False):
2791	"""
2792	Returns the number of CPUs on the host.
2793
2794	Returns True / False.
2795	Raises exception on environment / host mismatch.
2796	"""
2797	cEnv = os.environ.get('TESTBOX_CPU_COUNT', None);
2798	if cEnv is not None:
2799	cEnv = int(cEnv);
2800
2801	try:
2802	cVBox = self.oVBox.host.processorOnlineCount;
2803	except:
2804	if not fQuiet:
2805	reporter.logXcpt();
2806	cVBox = None;
2807
2808	if cVBox is not None:
2809	if cEnv is not None:
2810	assert cVBox == cEnv, 'Misconfigured TestBox: VBox: %u CPUs, testboxscript: %u CPUs' % (cVBox, cEnv);
2811	return cVBox;
2812	if cEnv is not None:
2813	return cEnv;
2814	return 1;
2815
2816	def _getHostCpuDesc(self, fQuiet = False):
2817	"""
2818	Internal method used for getting the host CPU description from VBoxSVC.
2819	Returns description string, on failure an empty string is returned.
2820	"""
2821	try:
2822	return self.oVBox.host.getProcessorDescription(0);
2823	except:
2824	if not fQuiet:
2825	reporter.logXcpt();
2826	return '';
2827
2828	def isHostCpuAmd(self, fQuiet = False):
2829	"""
2830	Checks if the host CPU vendor is AMD.
2831
2832	Returns True / False.
2833	"""
2834	sCpuDesc = self._getHostCpuDesc(fQuiet);
2835	return sCpuDesc.startswith("AMD") or sCpuDesc == 'AuthenticAMD';
2836
2837	def isHostCpuIntel(self, fQuiet = False):
2838	"""
2839	Checks if the host CPU vendor is Intel.
2840
2841	Returns True / False.
2842	"""
2843	sCpuDesc = self._getHostCpuDesc(fQuiet);
2844	return sCpuDesc.startswith("Intel") or sCpuDesc == 'GenuineIntel';
2845
2846	def isHostCpuVia(self, fQuiet = False):
2847	"""
2848	Checks if the host CPU vendor is VIA (or Centaur).
2849
2850	Returns True / False.
2851	"""
2852	sCpuDesc = self._getHostCpuDesc(fQuiet);
2853	return sCpuDesc.startswith("VIA") or sCpuDesc == 'CentaurHauls';
2854
2855	def hasRawModeSupport(self, fQuiet = False):
2856	"""
2857	Checks if raw-mode is supported by VirtualBox that the testbox is
2858	configured for it.
2859
2860	Returns True / False.
2861	Raises no exceptions.
2862
2863	Note! Differs from the rest in that we don't require the
2864	TESTBOX_WITH_RAW_MODE value to match the API. It is
2865	sometimes helpful to disable raw-mode on individual
2866	test boxes. (This probably goes for
2867	"""
2868	# The environment variable can be used to disable raw-mode.
2869	fEnv = os.environ.get('TESTBOX_WITH_RAW_MODE', None);
2870	if fEnv is not None:
2871	fEnv = fEnv.lower() not in [ 'false', 'f', 'not', 'no', 'n', '0', ];
2872	if fEnv is False:
2873	return False;
2874
2875	# Starting with 5.0 GA / RC2 the API can tell us whether VBox was built
2876	# with raw-mode support or not.
2877	self.importVBoxApi();
2878	if self.fpApiVer >= 5.0:
2879	try:
2880	fVBox = self.oVBox.systemProperties.rawModeSupported;
2881	except:
2882	if not fQuiet:
2883	reporter.logXcpt();
2884	fVBox = True;
2885	if fVBox is False:
2886	return False;
2887
2888	return True;
2889
2890	#
2891	# Testdriver execution methods.
2892	#
2893
2894	def handleTask(self, oTask, sMethod):
2895	"""
2896	Callback method for handling unknown tasks in the various run loops.
2897
2898	The testdriver should override this if it already tasks running when
2899	calling startVmAndConnectToTxsViaTcp, txsRunTest or similar methods.
2900	Call super to handle unknown tasks.
2901
2902	Returns True if handled, False if not.
2903	"""
2904	reporter.error('%s: unknown task %s' % (sMethod, oTask));
2905	return False;
2906
2907	def txsDoTask(self, oSession, oTxsSession, fnAsync, aArgs):
2908	"""
2909	Generic TXS task wrapper which waits both on the TXS and the session tasks.
2910
2911	Returns False on error, logged.
2912
2913	Returns task result on success.
2914	"""
2915	# All async methods ends with the following to args.
2916	cMsTimeout = aArgs[-2];
2917	fIgnoreErrors = aArgs[-1];
2918
2919	fRemoveVm = self.addTask(oSession);
2920	fRemoveTxs = self.addTask(oTxsSession);
2921
2922	rc = fnAsync(*aArgs); # pylint: disable=W0142
2923	if rc is True:
2924	rc = False;
2925	oTask = self.waitForTasks(cMsTimeout + 1);
2926	if oTask is oTxsSession:
2927	if oTxsSession.isSuccess():
2928	rc = oTxsSession.getResult();
2929	elif fIgnoreErrors is True:
2930	reporter.log( 'txsDoTask: task failed (%s)' % (oTxsSession.getLastReply()[1],));
2931	else:
2932	reporter.error('txsDoTask: task failed (%s)' % (oTxsSession.getLastReply()[1],));
2933	else:
2934	oTxsSession.cancelTask();
2935	if oTask is None:
2936	if fIgnoreErrors is True:
2937	reporter.log( 'txsDoTask: The task timed out.');
2938	else:
2939	reporter.errorTimeout('txsDoTask: The task timed out.');
2940	elif oTask is oSession:
2941	reporter.error('txsDoTask: The VM terminated unexpectedly');
2942	else:
2943	if fIgnoreErrors is True:
2944	reporter.log( 'txsDoTask: An unknown task %s was returned' % (oTask,));
2945	else:
2946	reporter.error('txsDoTask: An unknown task %s was returned' % (oTask,));
2947	else:
2948	reporter.error('txsDoTask: fnAsync returned %s' % (rc,));
2949
2950	if fRemoveTxs:
2951	self.removeTask(oTxsSession);
2952	if fRemoveVm:
2953	self.removeTask(oSession);
2954	return rc;
2955
2956	# pylint: disable=C0111
2957
2958	def txsDisconnect(self, oSession, oTxsSession, cMsTimeout = 30000, fIgnoreErrors = False):
2959	return self.txsDoTask(oSession, oTxsSession, oTxsSession.asyncDisconnect,
2960	(self.adjustTimeoutMs(cMsTimeout), fIgnoreErrors));
2961
2962	def txsUuid(self, oSession, oTxsSession, cMsTimeout = 30000, fIgnoreErrors = False):
2963	return self.txsDoTask(oSession, oTxsSession, oTxsSession.asyncUuid,
2964	(self.adjustTimeoutMs(cMsTimeout), fIgnoreErrors));
2965
2966	def txsMkDir(self, oSession, oTxsSession, sRemoteDir, fMode = 0700, cMsTimeout = 30000, fIgnoreErrors = False):
2967	return self.txsDoTask(oSession, oTxsSession, oTxsSession.asyncMkDir,
2968	(sRemoteDir, fMode, self.adjustTimeoutMs(cMsTimeout), fIgnoreErrors));
2969
2970	def txsMkDirPath(self, oSession, oTxsSession, sRemoteDir, fMode = 0700, cMsTimeout = 30000, fIgnoreErrors = False):
2971	return self.txsDoTask(oSession, oTxsSession, oTxsSession.asyncMkDirPath,
2972	(sRemoteDir, fMode, self.adjustTimeoutMs(cMsTimeout), fIgnoreErrors));
2973
2974	def txsMkSymlink(self, oSession, oTxsSession, sLinkTarget, sLink, cMsTimeout = 30000, fIgnoreErrors = False):
2975	return self.txsDoTask(oSession, oTxsSession, oTxsSession.asyncMkSymlink,
2976	(sLinkTarget, sLink, self.adjustTimeoutMs(cMsTimeout), fIgnoreErrors));
2977
2978	def txsRmDir(self, oSession, oTxsSession, sRemoteDir, cMsTimeout = 30000, fIgnoreErrors = False):
2979	return self.txsDoTask(oSession, oTxsSession, oTxsSession.asyncRmDir,
2980	(sRemoteDir, self.adjustTimeoutMs(cMsTimeout), fIgnoreErrors));
2981
2982	def txsRmFile(self, oSession, oTxsSession, sRemoteFile, cMsTimeout = 30000, fIgnoreErrors = False):
2983	return self.txsDoTask(oSession, oTxsSession, oTxsSession.asyncRmFile,
2984	(sRemoteFile, self.adjustTimeoutMs(cMsTimeout), fIgnoreErrors));
2985
2986	def txsRmSymlink(self, oSession, oTxsSession, sRemoteSymlink, cMsTimeout = 30000, fIgnoreErrors = False):
2987	return self.txsDoTask(oSession, oTxsSession, oTxsSession.asyncRmSymlink,
2988	(sRemoteSymlink, self.adjustTimeoutMs(cMsTimeout), fIgnoreErrors));
2989
2990	def txsRmTree(self, oSession, oTxsSession, sRemoteTree, cMsTimeout = 30000, fIgnoreErrors = False):
2991	return self.txsDoTask(oSession, oTxsSession, oTxsSession.asyncRmTree,
2992	(sRemoteTree, self.adjustTimeoutMs(cMsTimeout), fIgnoreErrors));
2993
2994	def txsIsDir(self, oSession, oTxsSession, sRemoteDir, cMsTimeout = 30000, fIgnoreErrors = False):
2995	return self.txsDoTask(oSession, oTxsSession, oTxsSession.asyncIsDir,
2996	(sRemoteDir, self.adjustTimeoutMs(cMsTimeout), fIgnoreErrors));
2997
2998	def txsIsFile(self, oSession, oTxsSession, sRemoteFile, cMsTimeout = 30000, fIgnoreErrors = False):
2999	return self.txsDoTask(oSession, oTxsSession, oTxsSession.asyncIsFile,
3000	(sRemoteFile, self.adjustTimeoutMs(cMsTimeout), fIgnoreErrors));
3001
3002	def txsIsSymlink(self, oSession, oTxsSession, sRemoteSymlink, cMsTimeout = 30000, fIgnoreErrors = False):
3003	return self.txsDoTask(oSession, oTxsSession, oTxsSession.asyncIsSymlink,
3004	(sRemoteSymlink, self.adjustTimeoutMs(cMsTimeout), fIgnoreErrors));
3005
3006	def txsUploadFile(self, oSession, oTxsSession, sLocalFile, sRemoteFile, cMsTimeout = 30000, fIgnoreErrors = False):
3007	return self.txsDoTask(oSession, oTxsSession, oTxsSession.asyncUploadFile, \
3008	(sLocalFile, sRemoteFile, self.adjustTimeoutMs(cMsTimeout), fIgnoreErrors));
3009
3010	def txsUploadString(self, oSession, oTxsSession, sContent, sRemoteFile, cMsTimeout = 30000, fIgnoreErrors = False):
3011	return self.txsDoTask(oSession, oTxsSession, oTxsSession.asyncUploadString, \
3012	(sContent, sRemoteFile, self.adjustTimeoutMs(cMsTimeout), fIgnoreErrors));
3013
3014	def txsDownloadFile(self, oSession, oTxsSession, sRemoteFile, sLocalFile, cMsTimeout = 30000, fIgnoreErrors = False):
3015	return self.txsDoTask(oSession, oTxsSession, oTxsSession.asyncDownloadFile, \
3016	(sRemoteFile, sLocalFile, self.adjustTimeoutMs(cMsTimeout), fIgnoreErrors));
3017
3018	def txsDownloadFiles(self, oSession, oTxsSession, asFiles, fIgnoreErrors = False):
3019	"""
3020	Convenience function to get files from the guest and stores it
3021	into the scratch directory for later (manual) review.
3022
3023	Returns True on success.
3024
3025	Returns False on failure, logged.
3026	"""
3027	fRc = True;
3028	for sGstFile in asFiles:
3029	## @todo Check for already existing files on the host and create a new
3030	# name for the current file to download.
3031	sTmpFile = os.path.join(self.sScratchPath, 'tmp-' + os.path.basename(sGstFile));
3032	reporter.log2('Downloading file "%s" to "%s" ...' % (sGstFile, sTmpFile));
3033	fRc = self.txsDownloadFile(oSession, oTxsSession, sGstFile, sTmpFile, 30 * 1000, fIgnoreErrors);
3034	try: os.unlink(sTmpFile);
3035	except: pass;
3036	if fRc:
3037	reporter.addLogFile(sTmpFile, 'misc/other', 'guest - ' + sGstFile);
3038	else:
3039	if fIgnoreErrors is not True:
3040	reporter.error('error downloading file "%s" to "%s"' % (sGstFile, sTmpFile));
3041	return fRc;
3042	reporter.log('warning: file "%s" was not downloaded, ignoring.' % (sGstFile,));
3043	return True;
3044
3045	def txsDownloadString(self, oSession, oTxsSession, sRemoteFile, cMsTimeout = 30000, fIgnoreErrors = False):
3046	return self.txsDoTask(oSession, oTxsSession, oTxsSession.asyncDownloadString,
3047	(sRemoteFile, self.adjustTimeoutMs(cMsTimeout), fIgnoreErrors));
3048
3049	def txsUnpackFile(self, oSession, oTxsSession, sRemoteFile, sRemoteDir, cMsTimeout = 30000, fIgnoreErrors = False):
3050	return self.txsDoTask(oSession, oTxsSession, oTxsSession.asyncUnpackFile, \
3051	(sRemoteFile, sRemoteDir, self.adjustTimeoutMs(cMsTimeout), fIgnoreErrors));
3052
3053	# pylint: enable=C0111
3054
3055	def txsCdWait(self, oSession, oTxsSession, cMsTimeout = 30000, sFileCdWait = 'vboxtxs-readme.txt'):
3056	"""
3057	Mostly an internal helper for txsRebootAndReconnectViaTcp and
3058	startVmAndConnectToTxsViaTcp that waits for the CDROM drive to become
3059	ready. It does this by polling for a file it knows to exist on the CD.
3060
3061	Returns True on success.
3062
3063	Returns False on failure, logged.
3064	"""
3065
3066	fRemoveVm = self.addTask(oSession);
3067	fRemoveTxs = self.addTask(oTxsSession);
3068	cMsTimeout = self.adjustTimeoutMs(cMsTimeout);
3069	msStart = base.timestampMilli();
3070	cMsTimeout2 = cMsTimeout;
3071	fRc = oTxsSession.asyncIsFile('${CDROM}/%s' % (sFileCdWait), cMsTimeout2);
3072	if fRc is True:
3073	while True:
3074	# wait for it to complete.
3075	oTask = self.waitForTasks(cMsTimeout2 + 1);
3076	if oTask is not oTxsSession:
3077	oTxsSession.cancelTask();
3078	if oTask is None:
3079	reporter.errorTimeout('txsToCdWait: The task timed out (after %s ms).'
3080	% (base.timestampMilli() - msStart,));
3081	elif oTask is oSession:
3082	reporter.error('txsToCdWait: The VM terminated unexpectedly');
3083	else:
3084	reporter.error('txsToCdWait: An unknown task %s was returned' % (oTask,));
3085	fRc = False;
3086	break;
3087	if oTxsSession.isSuccess():
3088	break;
3089
3090	# Check for timeout.
3091	cMsElapsed = base.timestampMilli() - msStart;
3092	if cMsElapsed >= cMsTimeout:
3093	reporter.error('txsToCdWait: timed out');
3094	fRc = False;
3095	break;
3096
3097	# delay.
3098	self.sleep(1);
3099
3100	# resubmitt the task.
3101	cMsTimeout2 = msStart + cMsTimeout - base.timestampMilli();
3102	if cMsTimeout2 < 500:
3103	cMsTimeout2 = 500;
3104	fRc = oTxsSession.asyncIsFile('${CDROM}/%s' % (sFileCdWait), cMsTimeout2);
3105	if fRc is not True:
3106	reporter.error('txsToCdWait: asyncIsFile failed');
3107	break;
3108	else:
3109	reporter.error('txsToCdWait: asyncIsFile failed');
3110
3111	if fRemoveTxs:
3112	self.removeTask(oTxsSession);
3113	if fRemoveVm:
3114	self.removeTask(oSession);
3115	return fRc;
3116
3117	def txsDoConnectViaTcp(self, oSession, cMsTimeout, fNatForwardingForTxs = False):
3118	"""
3119	Mostly an internal worker for connecting to TXS via TCP used by the
3120	*ViaTcp methods.
3121
3122	Returns a tuplet with True/False and TxsSession/None depending on the
3123	result. Errors are logged.
3124	"""
3125
3126	reporter.log2('txsDoConnectViaTcp: oSession=%s, cMsTimeout=%s, fNatForwardingForTxs=%s'
3127	% (oSession, cMsTimeout, fNatForwardingForTxs));
3128
3129	cMsTimeout = self.adjustTimeoutMs(cMsTimeout);
3130	oTxsConnect = oSession.txsConnectViaTcp(cMsTimeout, fNatForwardingForTxs = fNatForwardingForTxs);
3131	if oTxsConnect is not None:
3132	self.addTask(oTxsConnect);
3133	fRemoveVm = self.addTask(oSession);
3134	oTask = self.waitForTasks(cMsTimeout + 1);
3135	reporter.log2('txsDoConnectViaTcp: waitForTasks returned %s' % (oTask,));
3136	self.removeTask(oTxsConnect);
3137	if oTask is oTxsConnect:
3138	oTxsSession = oTxsConnect.getResult();
3139	if oTxsSession is not None:
3140	reporter.log('txsDoConnectViaTcp: Connected to TXS on %s.' % (oTxsSession.oTransport.sHostname,));
3141	return (True, oTxsSession);
3142
3143	reporter.error('txsDoConnectViaTcp: failed to connect to TXS.');
3144	else:
3145	oTxsConnect.cancelTask();
3146	if oTask is None:
3147	reporter.errorTimeout('txsDoConnectViaTcp: connect stage 1 timed out');
3148	elif oTask is oSession:
3149	oSession.reportPrematureTermination('txsDoConnectViaTcp: ');
3150	else:
3151	reporter.error('txsDoConnectViaTcp: unknown/wrong task %s' % (oTask,));
3152	if fRemoveVm:
3153	self.removeTask(oSession);
3154	else:
3155	reporter.error('txsDoConnectViaTcp: txsConnectViaTcp failed');
3156	return (False, None);
3157
3158	def startVmAndConnectToTxsViaTcp(self, sVmName, fCdWait = False, cMsTimeout = 15*60000, \
3159	cMsCdWait = 30000, sFileCdWait = 'vboxtxs-readme.txt', \
3160	fNatForwardingForTxs = False):
3161	"""
3162	Starts the specified VM and tries to connect to its TXS via TCP.
3163	The VM will be powered off if TXS doesn't respond before the specified
3164	time has elapsed.
3165
3166	Returns a the VM and TXS sessions (a two tuple) on success. The VM
3167	session is in the task list, the TXS session is not.
3168	Returns (None, None) on failure, fully logged.
3169	"""
3170
3171	# Zap the guest IP to make sure we're not getting a stale entry
3172	# (unless we're restoring the VM of course).
3173	oTestVM = self.oTestVmSet.findTestVmByName(sVmName) if self.oTestVmSet is not None else None;
3174	if oTestVM is None \
3175	or oTestVM.fSnapshotRestoreCurrent is False:
3176	try:
3177	oSession1 = self.openSession(self.getVmByName(sVmName));
3178	oSession1.delGuestPropertyValue('/VirtualBox/GuestInfo/Net/0/V4/IP');
3179	oSession1.saveSettings(True);
3180	del oSession1;
3181	except:
3182	reporter.logXcpt();
3183
3184	# Start the VM.
3185	reporter.log('startVmAndConnectToTxsViaTcp: Starting(/preparing) "%s" (timeout %s s)...' % (sVmName, cMsTimeout / 1000));
3186	oSession = self.startVmByName(sVmName);
3187	if oSession is not None:
3188	# Connect to TXS.
3189	reporter.log2('startVmAndConnectToTxsViaTcp: Started(/prepared) "%s", connecting to TXS ...' % (sVmName,));
3190	(fRc, oTxsSession) = self.txsDoConnectViaTcp(oSession, cMsTimeout, fNatForwardingForTxs);
3191	if fRc is True:
3192	if fCdWait:
3193	# Wait for CD?
3194	fRc = self.txsCdWait(oSession, oTxsSession, cMsCdWait, sFileCdWait);
3195	if fRc is not True:
3196	reporter.error('startVmAndConnectToTxsViaTcp: txsCdWait failed');
3197	if fRc is True:
3198	# Success!
3199	return (oSession, oTxsSession);
3200	else:
3201	reporter.error('startVmAndConnectToTxsViaTcp: txsDoConnectViaTcp failed');
3202	# If something went wrong while waiting for TXS to be started - take VM screenshot before terminate it
3203	self.terminateVmBySession(oSession);
3204	return (None, None);
3205
3206	def txsRebootAndReconnectViaTcp(self, oSession, oTxsSession, fCdWait = False, cMsTimeout = 15*60000, \
3207	cMsCdWait = 30000, sFileCdWait = 'vboxtxs-readme.txt', fNatForwardingForTxs = False):
3208	"""
3209	Executes the TXS reboot command
3210
3211	Returns A tuple of True and the new TXS session on success.
3212
3213	Returns A tuple of False and either the old TXS session or None on failure.
3214	"""
3215	reporter.log2('txsRebootAndReconnect: cMsTimeout=%u' % (cMsTimeout,));
3216
3217	#
3218	# This stuff is a bit complicated because of rebooting being kind of
3219	# disruptive to the TXS and such... The protocol is that TXS will:
3220	# - ACK the reboot command.
3221	# - Shutdown the transport layer, implicitly disconnecting us.
3222	# - Execute the reboot operation.
3223	# - On failure, it will be re-init the transport layer and be
3224	# available pretty much immediately. UUID unchanged.
3225	# - On success, it will be respawed after the reboot (hopefully),
3226	# with a different UUID.
3227	#
3228	fRc = False;
3229	iStart = base.timestampMilli();
3230
3231	# Get UUID.
3232	cMsTimeout2 = min(60000, cMsTimeout);
3233	sUuidBefore = self.txsUuid(oSession, oTxsSession, self.adjustTimeoutMs(cMsTimeout2, 60000));
3234	if sUuidBefore is not False:
3235	# Reboot.
3236	cMsElapsed = base.timestampMilli() - iStart;
3237	cMsTimeout2 = cMsTimeout - cMsElapsed;
3238	fRc = self.txsDoTask(oSession, oTxsSession, oTxsSession.asyncReboot,
3239	(self.adjustTimeoutMs(cMsTimeout2, 60000), False));
3240	if fRc is True:
3241	# Reconnect.
3242	if fNatForwardingForTxs is True:
3243	self.sleep(22); # NAT fudge - Two fixes are wanted: 1. TXS connect retries. 2. Main API reboot/reset hint.
3244	cMsElapsed = base.timestampMilli() - iStart;
3245	(fRc, oTxsSession) = self.txsDoConnectViaTcp(oSession, cMsTimeout - cMsElapsed, fNatForwardingForTxs);
3246	if fRc is True:
3247	# Check the UUID.
3248	cMsElapsed = base.timestampMilli() - iStart;
3249	cMsTimeout2 = min(60000, cMsTimeout - cMsElapsed);
3250	sUuidAfter = self.txsDoTask(oSession, oTxsSession, oTxsSession.asyncUuid,
3251	(self.adjustTimeoutMs(cMsTimeout2, 60000), False));
3252	if sUuidBefore is not False:
3253	if sUuidAfter != sUuidBefore:
3254	reporter.log('The guest rebooted (UUID %s -> %s)' % (sUuidBefore, sUuidAfter))
3255
3256	# Do CD wait if specified.
3257	if fCdWait:
3258	fRc = self.txsCdWait(oSession, oTxsSession, cMsCdWait, sFileCdWait);
3259	if fRc is not True:
3260	reporter.error('txsRebootAndReconnectViaTcp: txsCdWait failed');
3261	else:
3262	reporter.error('txsRebootAndReconnectViaTcp: failed to get UUID (after)');
3263	else:
3264	reporter.error('txsRebootAndReconnectViaTcp: did not reboot (UUID %s)' % (sUuidBefore,));
3265	else:
3266	reporter.error('txsRebootAndReconnectViaTcp: txsDoConnectViaTcp failed');
3267	else:
3268	reporter.error('txsRebootAndReconnectViaTcp: reboot failed');
3269	else:
3270	reporter.error('txsRebootAndReconnectViaTcp: failed to get UUID (before)');
3271	return (fRc, oTxsSession);
3272
3273	# pylint: disable=R0914,R0913
3274
3275	def txsRunTest(self, oTxsSession, sTestName, cMsTimeout, sExecName, asArgs = (), asAddEnv = (), sAsUser = ""):
3276	"""
3277	Executes the specified test task, waiting till it completes or times out.
3278
3279	The VM session (if any) must be in the task list.
3280
3281	Returns True if we executed the task and nothing abnormal happend.
3282	Query the process status from the TXS session.
3283
3284	Returns False if some unexpected task was signalled or we failed to
3285	submit the job.
3286	"""
3287	reporter.testStart(sTestName);
3288	reporter.log2('txsRunTest: cMsTimeout=%u sExecName=%s asArgs=%s' % (cMsTimeout, sExecName, asArgs));
3289
3290	# Submit the job.
3291	fRc = False;
3292	if oTxsSession.asyncExec(sExecName, asArgs, asAddEnv, sAsUser, cMsTimeout = self.adjustTimeoutMs(cMsTimeout)):
3293	self.addTask(oTxsSession);
3294
3295	# Wait for the job to complete.
3296	while True:
3297	oTask = self.waitForTasks(cMsTimeout + 1);
3298	if oTask is None:
3299	reporter.log('txsRunTest: waitForTasks timed out');
3300	break;
3301	if oTask is oTxsSession:
3302	fRc = True;
3303	reporter.log('txsRunTest: isSuccess=%s getResult=%s' % (oTxsSession.isSuccess(), oTxsSession.getResult()));
3304	break;
3305	if not self.handleTask(oTask, 'txsRunTest'):
3306	break;
3307
3308	self.removeTask(oTxsSession);
3309	if not oTxsSession.pollTask():
3310	oTxsSession.cancelTask();
3311	else:
3312	reporter.error('txsRunTest: asyncExec failed');
3313
3314	reporter.testDone();
3315	return fRc;
3316
3317	def txsRunTestRedirectStd(self, oTxsSession, sTestName, cMsTimeout, sExecName, asArgs = (), asAddEnv = (), sAsUser = "",
3318	oStdIn = '/dev/null', oStdOut = '/dev/null', oStdErr = '/dev/null', oTestPipe = '/dev/null'):
3319	"""
3320	Executes the specified test task, waiting till it completes or times out,
3321	redirecting stdin, stdout and stderr to the given objects.
3322
3323	The VM session (if any) must be in the task list.
3324
3325	Returns True if we executed the task and nothing abnormal happend.
3326	Query the process status from the TXS session.
3327
3328	Returns False if some unexpected task was signalled or we failed to
3329	submit the job.
3330	"""
3331	reporter.testStart(sTestName);
3332	reporter.log2('txsRunTestRedirectStd: cMsTimeout=%u sExecName=%s asArgs=%s' % (cMsTimeout, sExecName, asArgs));
3333
3334	# Submit the job.
3335	fRc = False;
3336	if oTxsSession.asyncExecEx(sExecName, asArgs, asAddEnv, oStdIn, oStdOut, oStdErr,
3337	oTestPipe, sAsUser, cMsTimeout = self.adjustTimeoutMs(cMsTimeout)):
3338	self.addTask(oTxsSession);
3339
3340	# Wait for the job to complete.
3341	while True:
3342	oTask = self.waitForTasks(cMsTimeout + 1);
3343	if oTask is None:
3344	reporter.log('txsRunTestRedirectStd: waitForTasks timed out');
3345	break;
3346	if oTask is oTxsSession:
3347	fRc = True;
3348	reporter.log('txsRunTestRedirectStd: isSuccess=%s getResult=%s'
3349	% (oTxsSession.isSuccess(), oTxsSession.getResult()));
3350	break;
3351	if not self.handleTask(oTask, 'txsRunTestRedirectStd'):
3352	break;
3353
3354	self.removeTask(oTxsSession);
3355	if not oTxsSession.pollTask():
3356	oTxsSession.cancelTask();
3357	else:
3358	reporter.error('txsRunTestRedirectStd: asyncExec failed');
3359
3360	reporter.testDone();
3361	return fRc;
3362
3363	def txsRunTest2(self, oTxsSession1, oTxsSession2, sTestName, cMsTimeout,
3364	sExecName1, asArgs1,
3365	sExecName2, asArgs2,
3366	asAddEnv1 = (), sAsUser1 = '', fWithTestPipe1 = True,
3367	asAddEnv2 = (), sAsUser2 = '', fWithTestPipe2 = True):
3368	"""
3369	Executes the specified test tasks, waiting till they complete or
3370	times out. The 1st task is started after the 2nd one.
3371
3372	The VM session (if any) must be in the task list.
3373
3374	Returns True if we executed the task and nothing abnormal happend.
3375	Query the process status from the TXS sessions.
3376
3377	Returns False if some unexpected task was signalled or we failed to
3378	submit the job.
3379	"""
3380	reporter.testStart(sTestName);
3381
3382	# Submit the jobs.
3383	fRc = False;
3384	if oTxsSession1.asyncExec(sExecName1, asArgs1, asAddEnv1, sAsUser1, fWithTestPipe1, '1-',
3385	self.adjustTimeoutMs(cMsTimeout)):
3386	self.addTask(oTxsSession1);
3387
3388	self.sleep(2); # fudge! grr
3389
3390	if oTxsSession2.asyncExec(sExecName2, asArgs2, asAddEnv2, sAsUser2, fWithTestPipe2, '2-',
3391	self.adjustTimeoutMs(cMsTimeout)):
3392	self.addTask(oTxsSession2);
3393
3394	# Wait for the jobs to complete.
3395	cPendingJobs = 2;
3396	while True:
3397	oTask = self.waitForTasks(cMsTimeout + 1);
3398	if oTask is None:
3399	reporter.log('txsRunTest2: waitForTasks timed out');
3400	break;
3401
3402	if oTask is oTxsSession1 or oTask is oTxsSession2:
3403	if oTask is oTxsSession1: iTask = 1;
3404	else: iTask = 2;
3405	reporter.log('txsRunTest2: #%u - isSuccess=%s getResult=%s' \
3406	% (iTask, oTask.isSuccess(), oTask.getResult()));
3407	self.removeTask(oTask);
3408	cPendingJobs -= 1;
3409	if cPendingJobs <= 0:
3410	fRc = True;
3411	break;
3412
3413	elif not self.handleTask(oTask, 'txsRunTest'):
3414	break;
3415
3416	self.removeTask(oTxsSession2);
3417	if not oTxsSession2.pollTask():
3418	oTxsSession2.cancelTask();
3419	else:
3420	reporter.error('txsRunTest2: asyncExec #2 failed');
3421
3422	self.removeTask(oTxsSession1);
3423	if not oTxsSession1.pollTask():
3424	oTxsSession1.cancelTask();
3425	else:
3426	reporter.error('txsRunTest2: asyncExec #1 failed');
3427
3428	reporter.testDone();
3429	return fRc;
3430
3431	# pylint: enable=R0914,R0913
3432

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

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

Download in other formats: