vbox.py@ 61956

Last change on this file since 61956 was 61956, checked in by vboxsync, 9 years ago
vbox.py: VBoxStartup.log -> VBoxHardening.log
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 61956 2016-06-30 12:07:36Z 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.215389.xyz. 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: 61956 $"
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	reporter.doPollWork();
2292	try: oProgress.waitForCompletion(cMsInterval);
2293	except: return -2;
2294
2295	try: rc = oProgress.resultCode;
2296	except: rc = -2;
2297	self.processPendingEvents();
2298	return rc;
2299
2300	def waitOnDirectSessionClose(self, oVM, cMsTimeout):
2301	"""
2302	Waits for the VM process to close it's current direct session.
2303
2304	Returns None.
2305	"""
2306	# Get the original values so we're not subject to
2307	try:
2308	eCurState = oVM.sessionState;
2309	if self.fpApiVer >= 5.0:
2310	sCurName = sOrgName = oVM.sessionName;
2311	else:
2312	sCurName = sOrgName = oVM.sessionType;
2313	if self.fpApiVer >= 4.2:
2314	iCurPid = iOrgPid = oVM.sessionPID;
2315	else:
2316	iCurPid = iOrgPid = oVM.sessionPid;
2317	except Exception, oXcpt:
2318	if ComError.notEqual(oXcpt, ComError.E_ACCESSDENIED):
2319	reporter.logXcpt();
2320	self.processPendingEvents();
2321	return None;
2322	self.processPendingEvents();
2323
2324	msStart = base.timestampMilli();
2325	while iCurPid == iOrgPid \
2326	and sCurName == sOrgName \
2327	and sCurName != '' \
2328	and base.timestampMilli() - msStart < cMsTimeout \
2329	and ( eCurState == vboxcon.SessionState_Unlocking \
2330	or eCurState == vboxcon.SessionState_Spawning \
2331	or eCurState == vboxcon.SessionState_Locked):
2332	self.processEvents(1000);
2333	try:
2334	eCurState = oVM.sessionState;
2335	sCurName = oVM.sessionName if self.fpApiVer >= 5.0 else oVM.sessionType;
2336	iCurPid = oVM.sessionPID if self.fpApiVer >= 4.2 else oVM.sessionPid;
2337	except Exception, oXcpt:
2338	if ComError.notEqual(oXcpt, ComError.E_ACCESSDENIED):
2339	reporter.logXcpt();
2340	break;
2341	self.processPendingEvents();
2342	self.processPendingEvents();
2343	return None;
2344
2345	def uploadStartupLogFile(self, oVM, sVmName):
2346	"""
2347	Uploads the VBoxStartup.log when present.
2348	"""
2349	fRc = True;
2350	try:
2351	sLogFile = os.path.join(oVM.logFolder, 'VBoxHardening.log');
2352	except:
2353	reporter.logXcpt();
2354	fRc = False;
2355	else:
2356	if os.path.isfile(sLogFile):
2357	reporter.addLogFile(sLogFile, 'log/release/vm', '%s hardening log' % (sVmName, ),
2358	sAltName = '%s-%s' % (sVmName, os.path.basename(sLogFile),));
2359	return fRc;
2360
2361	def startVmEx(self, oVM, fWait = True, sType = None, sName = None, asEnv = None): # pylint: disable=R0914,R0915
2362	"""
2363	Start the VM, returning the VM session and progress object on success.
2364	The session is also added to the task list and to the aoRemoteSessions set.
2365
2366	asEnv is a list of string on the putenv() form.
2367
2368	On failure (None, None) is returned and an error is logged.
2369	"""
2370	# Massage and check the input.
2371	if sType is None:
2372	sType = self.sSessionType;
2373	if sName is None:
2374	try: sName = oVM.name;
2375	except: sName = 'bad-vm-handle';
2376	reporter.log('startVmEx: sName=%s fWait=%s sType=%s' % (sName, fWait, sType));
2377	if oVM is None:
2378	return (None, None);
2379
2380	## @todo Do this elsewhere.
2381	# Hack alert. Disables all annoying GUI popups.
2382	if sType == 'gui' and len(self.aoRemoteSessions) == 0:
2383	try:
2384	self.oVBox.setExtraData('GUI/Input/AutoCapture', 'false');
2385	if self.fpApiVer >= 3.2:
2386	self.oVBox.setExtraData('GUI/LicenseAgreed', '8');
2387	else:
2388	self.oVBox.setExtraData('GUI/LicenseAgreed', '7');
2389	self.oVBox.setExtraData('GUI/RegistrationData', 'triesLeft=0');
2390	self.oVBox.setExtraData('GUI/SUNOnlineData', 'triesLeft=0');
2391	self.oVBox.setExtraData('GUI/SuppressMessages', 'confirmVMReset,remindAboutMouseIntegrationOn,'
2392	'remindAboutMouseIntegrationOff,remindAboutPausedVMInput,confirmInputCapture,'
2393	'confirmGoingFullscreen,remindAboutInaccessibleMedia,remindAboutWrongColorDepth,'
2394	'confirmRemoveMedium,allPopupPanes,allMessageBoxes,all');
2395	self.oVBox.setExtraData('GUI/UpdateDate', 'never');
2396	self.oVBox.setExtraData('GUI/PreventBetaWarning', self.oVBox.version);
2397	except:
2398	reporter.logXcpt();
2399
2400	# The UUID for the name.
2401	try:
2402	sUuid = oVM.id;
2403	except:
2404	reporter.errorXcpt('failed to get the UUID for VM "%s"' % (oVM));
2405	return (None, None);
2406	self.processPendingEvents();
2407
2408	# Construct the environment.
2409	sLogFile = '%s/VM-%s.log' % (self.sScratchPath, sUuid);
2410	try: os.remove(sLogFile);
2411	except: pass;
2412	if self.sLogSessionDest:
2413	sLogDest = self.sLogSessionDest;
2414	else:
2415	sLogDest = 'file=%s' % sLogFile;
2416	sEnv = 'VBOX_LOG=%s\nVBOX_LOG_FLAGS=%s\nVBOX_LOG_DEST=%s\nVBOX_RELEASE_LOG_FLAGS=append time' \
2417	% (self.sLogSessionGroups, self.sLogSessionFlags, sLogDest,);
2418	if sType == 'gui':
2419	sEnv += '\nVBOX_GUI_DBG_ENABLED=1'
2420	if asEnv is not None and len(asEnv) > 0:
2421	sEnv += '\n' + ('\n'.join(asEnv));
2422
2423	# Shortcuts for local testing.
2424	oProgress = oWrapped = None;
2425	oTestVM = self.oTestVmSet.findTestVmByName(sName) if self.oTestVmSet is not None else None;
2426	try:
2427	if oTestVM is not None \
2428	and oTestVM.fSnapshotRestoreCurrent is True:
2429	if oVM.state is vboxcon.MachineState_Running:
2430	reporter.log2('Machine "%s" already running.' % (sName,));
2431	oProgress = None;
2432	oWrapped = self.openSession(oVM);
2433	else:
2434	reporter.log2('Checking if snapshot for machine "%s" exists.' % (sName,));
2435	oSessionWrapperRestore = self.openSession(oVM);
2436	if oSessionWrapperRestore is not None:
2437	oSnapshotCur = oVM.currentSnapshot;
2438	if oSnapshotCur is not None:
2439	reporter.log2('Restoring snapshot for machine "%s".' % (sName,));
2440	oSessionWrapperRestore.restoreSnapshot(oSnapshotCur);
2441	reporter.log2('Current snapshot for machine "%s" restored.' % (sName,));
2442	else:
2443	reporter.log('warning: no current snapshot for machine "%s" found.' % (sName,));
2444	oSessionWrapperRestore.close();
2445	except:
2446	reporter.errorXcpt();
2447	return (None, None);
2448
2449	# Open a remote session, wait for this operation to complete.
2450	# (The loop is a kludge to deal with us racing the closing of the
2451	# direct session of a previous VM run. See waitOnDirectSessionClose.)
2452	if oWrapped is None:
2453	for i in range(10):
2454	try:
2455	if self.fpApiVer < 4.3 \
2456	or (self.fpApiVer == 4.3 and not hasattr(self.oVBoxMgr, 'getSessionObject')):
2457	oSession = self.oVBoxMgr.mgr.getSessionObject(self.oVBox); # pylint: disable=E1101
2458	else:
2459	oSession = self.oVBoxMgr.getSessionObject(self.oVBox); # pylint: disable=E1101
2460	if self.fpApiVer < 3.3:
2461	oProgress = self.oVBox.openRemoteSession(oSession, sUuid, sType, sEnv);
2462	else:
2463	oProgress = oVM.launchVMProcess(oSession, sType, sEnv);
2464	break;
2465	except:
2466	if i == 9:
2467	reporter.errorXcpt('failed to start VM "%s" ("%s"), aborting.' % (sUuid, sName));
2468	return (None, None);
2469	oSession = None;
2470	if i >= 0:
2471	reporter.logXcpt('warning: failed to start VM "%s" ("%s") - retrying in %u secs.' % (sUuid, oVM, i)); # pylint: disable=C0301
2472	self.waitOnDirectSessionClose(oVM, 5000 + i * 1000);
2473	if fWait and oProgress is not None:
2474	rc = self.waitOnProgress(oProgress);
2475	if rc < 0:
2476	self.waitOnDirectSessionClose(oVM, 5000);
2477	try:
2478	if oSession is not None:
2479	oSession.close();
2480	except: pass;
2481	reportError(oProgress, 'failed to open session for "%s"' % (sName));
2482	self.uploadStartupLogFile(oVM, sName);
2483	return (None, None);
2484	reporter.log2('waitOnProgress -> %s' % (rc,));
2485
2486	# Wrap up the session object and push on to the list before returning it.
2487	if oWrapped is None:
2488	from testdriver.vboxwrappers import SessionWrapper;
2489	oWrapped = SessionWrapper(oSession, oVM, self.oVBox, self.oVBoxMgr, self, True, sName, sLogFile);
2490
2491	oWrapped.registerEventHandlerForTask();
2492	self.aoRemoteSessions.append(oWrapped);
2493	if oWrapped is not self.aoRemoteSessions[len(self.aoRemoteSessions) - 1]:
2494	reporter.error('not by reference: oWrapped=%s aoRemoteSessions[%s]=%s'
2495	% (oWrapped, len(self.aoRemoteSessions) - 1,
2496	self.aoRemoteSessions[len(self.aoRemoteSessions) - 1]));
2497	self.addTask(oWrapped);
2498
2499	reporter.log2('startVmEx: oSession=%s, oSessionWrapper=%s, oProgress=%s' % (oSession, oWrapped, oProgress));
2500
2501	from testdriver.vboxwrappers import ProgressWrapper;
2502	return (oWrapped, ProgressWrapper(oProgress, self.oVBoxMgr, self,
2503	'starting %s' % (sName,)) if oProgress else None);
2504
2505	def startVm(self, oVM, sType=None, sName = None, asEnv = None):
2506	""" Simplified version of startVmEx. """
2507	oSession, _ = self.startVmEx(oVM, True, sType, sName, asEnv = asEnv);
2508	return oSession;
2509
2510	def startVmByNameEx(self, sName, fWait=True, sType=None, asEnv = None):
2511	"""
2512	Start the VM, returning the VM session and progress object on success.
2513	The session is also added to the task list and to the aoRemoteSessions set.
2514
2515	On failure (None, None) is returned and an error is logged.
2516	"""
2517	oVM = self.getVmByName(sName);
2518	if oVM is None:
2519	return (None, None);
2520	return self.startVmEx(oVM, fWait, sType, sName, asEnv = asEnv);
2521
2522	def startVmByName(self, sName, sType=None, asEnv = None):
2523	"""
2524	Start the VM, returning the VM session on success. The session is
2525	also added to the task list and to the aoRemoteSessions set.
2526
2527	On failure None is returned and an error is logged.
2528	"""
2529	oSession, _ = self.startVmByNameEx(sName, True, sType, asEnv = asEnv);
2530	return oSession;
2531
2532	def terminateVmBySession(self, oSession, oProgress = None, fTakeScreenshot = None):
2533	"""
2534	Terminates the VM specified by oSession and adds the release logs to
2535	the test report.
2536
2537	This will try archive this by using powerOff, but will resort to
2538	tougher methods if that fails.
2539
2540	The session will always be removed from the task list.
2541	The session will be closed unless we fail to kill the process.
2542	The session will be removed from the remote session list if closed.
2543
2544	The progress object (a wrapper!) is for teleportation and similar VM
2545	operations, it will be attempted canceled before powering off the VM.
2546	Failures are logged but ignored.
2547	The progress object will always be removed from the task list.
2548
2549	Returns True if powerOff and session close both succeed.
2550	Returns False if on failure (logged), including when we successfully
2551	kill the VM process.
2552	"""
2553	reporter.log2('terminateVmBySession: oSession=%s (pid=%s) oProgress=%s' % (oSession.sName, oSession.getPid(), oProgress));
2554
2555	# Call getPid first to make sure the PID is cached in the wrapper.
2556	oSession.getPid();
2557
2558	#
2559	# If the host is out of memory, just skip all the info collection as it
2560	# requires memory too and seems to wedge.
2561	#
2562	sLastScreenshotPath = None;
2563	sOsKernelLog = None;
2564	sVgaText = None;
2565	asMiscInfos = [];
2566	if not oSession.fHostMemoryLow:
2567	#
2568	# Pause the VM if we're going to take any screenshots or dig into the
2569	# guest. Failures are quitely ignored.
2570	#
2571	if self.fAlwaysUploadLogs or reporter.testErrorCount() > 0:
2572	try:
2573	if oSession.oVM.state in [ vboxcon.MachineState_Running,
2574	vboxcon.MachineState_LiveSnapshotting,
2575	vboxcon.MachineState_Teleporting ]:
2576	oSession.o.console.pause();
2577	except:
2578	reporter.logXcpt();
2579
2580	#
2581	# Take Screenshot and upload it (see below) to Test Manager if appropriate/requested.
2582	#
2583	if fTakeScreenshot is True or self.fAlwaysUploadScreenshots or reporter.testErrorCount() > 0:
2584	sLastScreenshotPath = os.path.join(self.sScratchPath, "LastScreenshot-%s.png" % oSession.sName);
2585	fRc = oSession.takeScreenshot(sLastScreenshotPath);
2586	if fRc is not True:
2587	sLastScreenshotPath = None;
2588
2589	# Query the OS kernel log from the debugger if appropriate/requested.
2590	if self.fAlwaysUploadLogs or reporter.testErrorCount() > 0:
2591	sOsKernelLog = oSession.queryOsKernelLog();
2592
2593	# Do "info vgatext all" separately.
2594	if self.fAlwaysUploadLogs or reporter.testErrorCount() > 0:
2595	sVgaText = oSession.queryDbgInfoVgaText();
2596
2597	# Various infos (do after kernel because of symbols).
2598	if self.fAlwaysUploadLogs or reporter.testErrorCount() > 0:
2599	# Dump the guest stack for all CPUs.
2600	cCpus = oSession.getCpuCount();
2601	if cCpus > 0:
2602	for iCpu in xrange(0, cCpus):
2603	sThis = oSession.queryDbgGuestStack(iCpu);
2604	if sThis is not None and len(sThis) > 0:
2605	asMiscInfos += [
2606	'================ start guest stack VCPU %s ================\n' % (iCpu,),
2607	sThis,
2608	'================ end guest stack VCPU %s ==================\n' % (iCpu,),
2609	];
2610
2611	for sInfo, sArg in [ ('mode', 'all'),
2612	('fflags', ''),
2613	('cpumguest', 'verbose all'),
2614	('cpumguestinstr', 'symbol all'),
2615	('pic', ''),
2616	('apic', ''),
2617	('ioapic', ''),
2618	('pit', ''),
2619	('phys', ''),
2620	('clocks', ''),
2621	('timers', ''),
2622	('gdtguest', ''),
2623	('ldtguest', ''),
2624	]:
2625	if sInfo in ['apic',] and self.fpApiVer < 5.1: # asserts and burns
2626	continue;
2627	sThis = oSession.queryDbgInfo(sInfo, sArg);
2628	if sThis is not None and len(sThis) > 0:
2629	if sThis[-1] != '\n':
2630	sThis += '\n';
2631	asMiscInfos += [
2632	'================ start %s %s ================\n' % (sInfo, sArg),
2633	sThis,
2634	'================ end %s %s ==================\n' % (sInfo, sArg),
2635	];
2636
2637	#
2638	# Terminate the VM
2639	#
2640
2641	# Cancel the progress object if specified.
2642	if oProgress is not None:
2643	if not oProgress.isCompleted() and oProgress.isCancelable():
2644	reporter.log2('terminateVmBySession: canceling "%s"...' % (oProgress.sName));
2645	try:
2646	oProgress.o.cancel();
2647	except:
2648	reporter.logXcpt();
2649	else:
2650	oProgress.wait();
2651	self.removeTask(oProgress);
2652
2653	# Check if the VM has terminated by it self before powering it off.
2654	fClose = True;
2655	fRc = True;
2656	if oSession.needsPoweringOff():
2657	reporter.log('terminateVmBySession: powering off "%s"...' % (oSession.sName,));
2658	fRc = oSession.powerOff(fFudgeOnFailure = False);
2659	if fRc is not True:
2660	# power off failed, try terminate it in a nice manner.
2661	fRc = False;
2662	uPid = oSession.getPid();
2663	if uPid is not None:
2664	reporter.error('terminateVmBySession: Terminating PID %u (VM %s)' % (uPid, oSession.sName));
2665	fClose = base.processTerminate(uPid);
2666	if fClose is True:
2667	self.waitOnDirectSessionClose(oSession.oVM, 5000);
2668	fClose = oSession.waitForTask(1000);
2669
2670	if fClose is not True:
2671	# Being nice failed...
2672	reporter.error('terminateVmBySession: Termination failed, trying to kill PID %u (VM %s) instead' \
2673	% (uPid, oSession.sName));
2674	fClose = base.processKill(uPid);
2675	if fClose is True:
2676	self.waitOnDirectSessionClose(oSession.oVM, 5000);
2677	fClose = oSession.waitForTask(1000);
2678	if fClose is not True:
2679	reporter.error('terminateVmBySession: Failed to kill PID %u (VM %s)' % (uPid, oSession.sName));
2680
2681	# The final steps.
2682	if fClose is True:
2683	reporter.log('terminateVmBySession: closing session "%s"...' % (oSession.sName,));
2684	oSession.close();
2685	self.waitOnDirectSessionClose(oSession.oVM, 10000);
2686	try:
2687	eState = oSession.oVM.state;
2688	except:
2689	reporter.logXcpt();
2690	else:
2691	if eState == vboxcon.MachineState_Aborted:
2692	reporter.error('terminateVmBySession: The VM "%s" aborted!' % (oSession.sName,));
2693	self.removeTask(oSession);
2694
2695	#
2696	# Add the release log, debug log and a screenshot of the VM to the test report.
2697	#
2698	if self.fAlwaysUploadLogs or reporter.testErrorCount() > 0:
2699	oSession.addLogsToReport();
2700
2701	# Add a screenshot if it has been requested and taken successfully.
2702	if sLastScreenshotPath is not None:
2703	if reporter.testErrorCount() > 0:
2704	reporter.addLogFile(sLastScreenshotPath, 'screenshot/failure', 'Last VM screenshot');
2705	else:
2706	reporter.addLogFile(sLastScreenshotPath, 'screenshot/success', 'Last VM screenshot');
2707
2708	# Add the guest OS log if it has been requested and taken successfully.
2709	if sOsKernelLog is not None:
2710	reporter.addLogString(sOsKernelLog, 'kernel.log', 'log/guest/kernel', 'Guest OS kernel log');
2711
2712	# Add "info vgatext all" if we've got it.
2713	if sVgaText is not None:
2714	reporter.addLogString(sVgaText, 'vgatext.txt', 'info/vgatext', 'info vgatext all');
2715
2716	# Add the "info xxxx" items if we've got any.
2717	if len(asMiscInfos) > 0:
2718	reporter.addLogString(u''.join(asMiscInfos), 'info.txt', 'info/collection', 'A bunch of info items.');
2719
2720
2721	return fRc;
2722
2723
2724	#
2725	# Some information query functions (mix).
2726	#
2727	# Methods require the VBox API. If the information is provided by both
2728	# the testboxscript as well as VBox API, we'll check if it matches.
2729	#
2730
2731	def _hasHostCpuFeature(self, sEnvVar, sEnum, fpApiMinVer, fQuiet):
2732	"""
2733	Common Worker for hasHostNestedPaging() and hasHostHwVirt().
2734
2735	Returns True / False.
2736	Raises exception on environment / host mismatch.
2737	"""
2738	fEnv = os.environ.get(sEnvVar, None);
2739	if fEnv is not None:
2740	fEnv = fEnv.lower() not in [ 'false', 'f', 'not', 'no', 'n', '0', ];
2741
2742	fVBox = None;
2743	self.importVBoxApi();
2744	if self.fpApiVer >= fpApiMinVer and hasattr(vboxcon, sEnum):
2745	try:
2746	fVBox = self.oVBox.host.getProcessorFeature(getattr(vboxcon, sEnum));
2747	except:
2748	if not fQuiet:
2749	reporter.logXcpt();
2750
2751	if fVBox is not None:
2752	if fEnv is not None:
2753	if fEnv != fVBox and not fQuiet:
2754	reporter.log('TestBox configuration overwritten: fVBox=%s (%s) vs. fEnv=%s (%s)'
2755	% (fVBox, sEnum, fEnv, sEnvVar));
2756	return fEnv;
2757	return fVBox;
2758	if fEnv is not None:
2759	return fEnv;
2760	return False;
2761
2762	def hasHostHwVirt(self, fQuiet = False):
2763	"""
2764	Checks if hardware assisted virtualization is supported by the host.
2765
2766	Returns True / False.
2767	Raises exception on environment / host mismatch.
2768	"""
2769	return self._hasHostCpuFeature('TESTBOX_HAS_HW_VIRT', 'ProcessorFeature_HWVirtEx', 3.1, fQuiet);
2770
2771	def hasHostNestedPaging(self, fQuiet = False):
2772	"""
2773	Checks if nested paging is supported by the host.
2774
2775	Returns True / False.
2776	Raises exception on environment / host mismatch.
2777	"""
2778	return self._hasHostCpuFeature('TESTBOX_HAS_NESTED_PAGING', 'ProcessorFeature_NestedPaging', 4.2, fQuiet) \
2779	and self.hasHostHwVirt(fQuiet);
2780
2781	def hasHostLongMode(self, fQuiet = False):
2782	"""
2783	Checks if the host supports 64-bit guests.
2784
2785	Returns True / False.
2786	Raises exception on environment / host mismatch.
2787	"""
2788	# Note that the testboxscript doesn't export this variable atm.
2789	return self._hasHostCpuFeature('TESTBOX_HAS_LONG_MODE', 'ProcessorFeature_LongMode', 3.1, fQuiet);
2790
2791	def getHostCpuCount(self, fQuiet = False):
2792	"""
2793	Returns the number of CPUs on the host.
2794
2795	Returns True / False.
2796	Raises exception on environment / host mismatch.
2797	"""
2798	cEnv = os.environ.get('TESTBOX_CPU_COUNT', None);
2799	if cEnv is not None:
2800	cEnv = int(cEnv);
2801
2802	try:
2803	cVBox = self.oVBox.host.processorOnlineCount;
2804	except:
2805	if not fQuiet:
2806	reporter.logXcpt();
2807	cVBox = None;
2808
2809	if cVBox is not None:
2810	if cEnv is not None:
2811	assert cVBox == cEnv, 'Misconfigured TestBox: VBox: %u CPUs, testboxscript: %u CPUs' % (cVBox, cEnv);
2812	return cVBox;
2813	if cEnv is not None:
2814	return cEnv;
2815	return 1;
2816
2817	def _getHostCpuDesc(self, fQuiet = False):
2818	"""
2819	Internal method used for getting the host CPU description from VBoxSVC.
2820	Returns description string, on failure an empty string is returned.
2821	"""
2822	try:
2823	return self.oVBox.host.getProcessorDescription(0);
2824	except:
2825	if not fQuiet:
2826	reporter.logXcpt();
2827	return '';
2828
2829	def isHostCpuAmd(self, fQuiet = False):
2830	"""
2831	Checks if the host CPU vendor is AMD.
2832
2833	Returns True / False.
2834	"""
2835	sCpuDesc = self._getHostCpuDesc(fQuiet);
2836	return sCpuDesc.startswith("AMD") or sCpuDesc == 'AuthenticAMD';
2837
2838	def isHostCpuIntel(self, fQuiet = False):
2839	"""
2840	Checks if the host CPU vendor is Intel.
2841
2842	Returns True / False.
2843	"""
2844	sCpuDesc = self._getHostCpuDesc(fQuiet);
2845	return sCpuDesc.startswith("Intel") or sCpuDesc == 'GenuineIntel';
2846
2847	def isHostCpuVia(self, fQuiet = False):
2848	"""
2849	Checks if the host CPU vendor is VIA (or Centaur).
2850
2851	Returns True / False.
2852	"""
2853	sCpuDesc = self._getHostCpuDesc(fQuiet);
2854	return sCpuDesc.startswith("VIA") or sCpuDesc == 'CentaurHauls';
2855
2856	def hasRawModeSupport(self, fQuiet = False):
2857	"""
2858	Checks if raw-mode is supported by VirtualBox that the testbox is
2859	configured for it.
2860
2861	Returns True / False.
2862	Raises no exceptions.
2863
2864	Note! Differs from the rest in that we don't require the
2865	TESTBOX_WITH_RAW_MODE value to match the API. It is
2866	sometimes helpful to disable raw-mode on individual
2867	test boxes. (This probably goes for
2868	"""
2869	# The environment variable can be used to disable raw-mode.
2870	fEnv = os.environ.get('TESTBOX_WITH_RAW_MODE', None);
2871	if fEnv is not None:
2872	fEnv = fEnv.lower() not in [ 'false', 'f', 'not', 'no', 'n', '0', ];
2873	if fEnv is False:
2874	return False;
2875
2876	# Starting with 5.0 GA / RC2 the API can tell us whether VBox was built
2877	# with raw-mode support or not.
2878	self.importVBoxApi();
2879	if self.fpApiVer >= 5.0:
2880	try:
2881	fVBox = self.oVBox.systemProperties.rawModeSupported;
2882	except:
2883	if not fQuiet:
2884	reporter.logXcpt();
2885	fVBox = True;
2886	if fVBox is False:
2887	return False;
2888
2889	return True;
2890
2891	#
2892	# Testdriver execution methods.
2893	#
2894
2895	def handleTask(self, oTask, sMethod):
2896	"""
2897	Callback method for handling unknown tasks in the various run loops.
2898
2899	The testdriver should override this if it already tasks running when
2900	calling startVmAndConnectToTxsViaTcp, txsRunTest or similar methods.
2901	Call super to handle unknown tasks.
2902
2903	Returns True if handled, False if not.
2904	"""
2905	reporter.error('%s: unknown task %s' % (sMethod, oTask));
2906	return False;
2907
2908	def txsDoTask(self, oSession, oTxsSession, fnAsync, aArgs):
2909	"""
2910	Generic TXS task wrapper which waits both on the TXS and the session tasks.
2911
2912	Returns False on error, logged.
2913
2914	Returns task result on success.
2915	"""
2916	# All async methods ends with the following to args.
2917	cMsTimeout = aArgs[-2];
2918	fIgnoreErrors = aArgs[-1];
2919
2920	fRemoveVm = self.addTask(oSession);
2921	fRemoveTxs = self.addTask(oTxsSession);
2922
2923	rc = fnAsync(*aArgs); # pylint: disable=W0142
2924	if rc is True:
2925	rc = False;
2926	oTask = self.waitForTasks(cMsTimeout + 1);
2927	if oTask is oTxsSession:
2928	if oTxsSession.isSuccess():
2929	rc = oTxsSession.getResult();
2930	elif fIgnoreErrors is True:
2931	reporter.log( 'txsDoTask: task failed (%s)' % (oTxsSession.getLastReply()[1],));
2932	else:
2933	reporter.error('txsDoTask: task failed (%s)' % (oTxsSession.getLastReply()[1],));
2934	else:
2935	oTxsSession.cancelTask();
2936	if oTask is None:
2937	if fIgnoreErrors is True:
2938	reporter.log( 'txsDoTask: The task timed out.');
2939	else:
2940	reporter.errorTimeout('txsDoTask: The task timed out.');
2941	elif oTask is oSession:
2942	reporter.error('txsDoTask: The VM terminated unexpectedly');
2943	else:
2944	if fIgnoreErrors is True:
2945	reporter.log( 'txsDoTask: An unknown task %s was returned' % (oTask,));
2946	else:
2947	reporter.error('txsDoTask: An unknown task %s was returned' % (oTask,));
2948	else:
2949	reporter.error('txsDoTask: fnAsync returned %s' % (rc,));
2950
2951	if fRemoveTxs:
2952	self.removeTask(oTxsSession);
2953	if fRemoveVm:
2954	self.removeTask(oSession);
2955	return rc;
2956
2957	# pylint: disable=C0111
2958
2959	def txsDisconnect(self, oSession, oTxsSession, cMsTimeout = 30000, fIgnoreErrors = False):
2960	return self.txsDoTask(oSession, oTxsSession, oTxsSession.asyncDisconnect,
2961	(self.adjustTimeoutMs(cMsTimeout), fIgnoreErrors));
2962
2963	def txsUuid(self, oSession, oTxsSession, cMsTimeout = 30000, fIgnoreErrors = False):
2964	return self.txsDoTask(oSession, oTxsSession, oTxsSession.asyncUuid,
2965	(self.adjustTimeoutMs(cMsTimeout), fIgnoreErrors));
2966
2967	def txsMkDir(self, oSession, oTxsSession, sRemoteDir, fMode = 0700, cMsTimeout = 30000, fIgnoreErrors = False):
2968	return self.txsDoTask(oSession, oTxsSession, oTxsSession.asyncMkDir,
2969	(sRemoteDir, fMode, self.adjustTimeoutMs(cMsTimeout), fIgnoreErrors));
2970
2971	def txsMkDirPath(self, oSession, oTxsSession, sRemoteDir, fMode = 0700, cMsTimeout = 30000, fIgnoreErrors = False):
2972	return self.txsDoTask(oSession, oTxsSession, oTxsSession.asyncMkDirPath,
2973	(sRemoteDir, fMode, self.adjustTimeoutMs(cMsTimeout), fIgnoreErrors));
2974
2975	def txsMkSymlink(self, oSession, oTxsSession, sLinkTarget, sLink, cMsTimeout = 30000, fIgnoreErrors = False):
2976	return self.txsDoTask(oSession, oTxsSession, oTxsSession.asyncMkSymlink,
2977	(sLinkTarget, sLink, self.adjustTimeoutMs(cMsTimeout), fIgnoreErrors));
2978
2979	def txsRmDir(self, oSession, oTxsSession, sRemoteDir, cMsTimeout = 30000, fIgnoreErrors = False):
2980	return self.txsDoTask(oSession, oTxsSession, oTxsSession.asyncRmDir,
2981	(sRemoteDir, self.adjustTimeoutMs(cMsTimeout), fIgnoreErrors));
2982
2983	def txsRmFile(self, oSession, oTxsSession, sRemoteFile, cMsTimeout = 30000, fIgnoreErrors = False):
2984	return self.txsDoTask(oSession, oTxsSession, oTxsSession.asyncRmFile,
2985	(sRemoteFile, self.adjustTimeoutMs(cMsTimeout), fIgnoreErrors));
2986
2987	def txsRmSymlink(self, oSession, oTxsSession, sRemoteSymlink, cMsTimeout = 30000, fIgnoreErrors = False):
2988	return self.txsDoTask(oSession, oTxsSession, oTxsSession.asyncRmSymlink,
2989	(sRemoteSymlink, self.adjustTimeoutMs(cMsTimeout), fIgnoreErrors));
2990
2991	def txsRmTree(self, oSession, oTxsSession, sRemoteTree, cMsTimeout = 30000, fIgnoreErrors = False):
2992	return self.txsDoTask(oSession, oTxsSession, oTxsSession.asyncRmTree,
2993	(sRemoteTree, self.adjustTimeoutMs(cMsTimeout), fIgnoreErrors));
2994
2995	def txsIsDir(self, oSession, oTxsSession, sRemoteDir, cMsTimeout = 30000, fIgnoreErrors = False):
2996	return self.txsDoTask(oSession, oTxsSession, oTxsSession.asyncIsDir,
2997	(sRemoteDir, self.adjustTimeoutMs(cMsTimeout), fIgnoreErrors));
2998
2999	def txsIsFile(self, oSession, oTxsSession, sRemoteFile, cMsTimeout = 30000, fIgnoreErrors = False):
3000	return self.txsDoTask(oSession, oTxsSession, oTxsSession.asyncIsFile,
3001	(sRemoteFile, self.adjustTimeoutMs(cMsTimeout), fIgnoreErrors));
3002
3003	def txsIsSymlink(self, oSession, oTxsSession, sRemoteSymlink, cMsTimeout = 30000, fIgnoreErrors = False):
3004	return self.txsDoTask(oSession, oTxsSession, oTxsSession.asyncIsSymlink,
3005	(sRemoteSymlink, self.adjustTimeoutMs(cMsTimeout), fIgnoreErrors));
3006
3007	def txsUploadFile(self, oSession, oTxsSession, sLocalFile, sRemoteFile, cMsTimeout = 30000, fIgnoreErrors = False):
3008	return self.txsDoTask(oSession, oTxsSession, oTxsSession.asyncUploadFile, \
3009	(sLocalFile, sRemoteFile, self.adjustTimeoutMs(cMsTimeout), fIgnoreErrors));
3010
3011	def txsUploadString(self, oSession, oTxsSession, sContent, sRemoteFile, cMsTimeout = 30000, fIgnoreErrors = False):
3012	return self.txsDoTask(oSession, oTxsSession, oTxsSession.asyncUploadString, \
3013	(sContent, sRemoteFile, self.adjustTimeoutMs(cMsTimeout), fIgnoreErrors));
3014
3015	def txsDownloadFile(self, oSession, oTxsSession, sRemoteFile, sLocalFile, cMsTimeout = 30000, fIgnoreErrors = False):
3016	return self.txsDoTask(oSession, oTxsSession, oTxsSession.asyncDownloadFile, \
3017	(sRemoteFile, sLocalFile, self.adjustTimeoutMs(cMsTimeout), fIgnoreErrors));
3018
3019	def txsDownloadFiles(self, oSession, oTxsSession, asFiles, fIgnoreErrors = False):
3020	"""
3021	Convenience function to get files from the guest and stores it
3022	into the scratch directory for later (manual) review.
3023
3024	Returns True on success.
3025
3026	Returns False on failure, logged.
3027	"""
3028	fRc = True;
3029	for sGstFile in asFiles:
3030	## @todo Check for already existing files on the host and create a new
3031	# name for the current file to download.
3032	sTmpFile = os.path.join(self.sScratchPath, 'tmp-' + os.path.basename(sGstFile));
3033	reporter.log2('Downloading file "%s" to "%s" ...' % (sGstFile, sTmpFile));
3034	fRc = self.txsDownloadFile(oSession, oTxsSession, sGstFile, sTmpFile, 30 * 1000, fIgnoreErrors);
3035	try: os.unlink(sTmpFile);
3036	except: pass;
3037	if fRc:
3038	reporter.addLogFile(sTmpFile, 'misc/other', 'guest - ' + sGstFile);
3039	else:
3040	if fIgnoreErrors is not True:
3041	reporter.error('error downloading file "%s" to "%s"' % (sGstFile, sTmpFile));
3042	return fRc;
3043	reporter.log('warning: file "%s" was not downloaded, ignoring.' % (sGstFile,));
3044	return True;
3045
3046	def txsDownloadString(self, oSession, oTxsSession, sRemoteFile, cMsTimeout = 30000, fIgnoreErrors = False):
3047	return self.txsDoTask(oSession, oTxsSession, oTxsSession.asyncDownloadString,
3048	(sRemoteFile, self.adjustTimeoutMs(cMsTimeout), fIgnoreErrors));
3049
3050	def txsUnpackFile(self, oSession, oTxsSession, sRemoteFile, sRemoteDir, cMsTimeout = 30000, fIgnoreErrors = False):
3051	return self.txsDoTask(oSession, oTxsSession, oTxsSession.asyncUnpackFile, \
3052	(sRemoteFile, sRemoteDir, self.adjustTimeoutMs(cMsTimeout), fIgnoreErrors));
3053
3054	# pylint: enable=C0111
3055
3056	def txsCdWait(self, oSession, oTxsSession, cMsTimeout = 30000, sFileCdWait = 'vboxtxs-readme.txt'):
3057	"""
3058	Mostly an internal helper for txsRebootAndReconnectViaTcp and
3059	startVmAndConnectToTxsViaTcp that waits for the CDROM drive to become
3060	ready. It does this by polling for a file it knows to exist on the CD.
3061
3062	Returns True on success.
3063
3064	Returns False on failure, logged.
3065	"""
3066
3067	fRemoveVm = self.addTask(oSession);
3068	fRemoveTxs = self.addTask(oTxsSession);
3069	cMsTimeout = self.adjustTimeoutMs(cMsTimeout);
3070	msStart = base.timestampMilli();
3071	cMsTimeout2 = cMsTimeout;
3072	fRc = oTxsSession.asyncIsFile('${CDROM}/%s' % (sFileCdWait), cMsTimeout2);
3073	if fRc is True:
3074	while True:
3075	# wait for it to complete.
3076	oTask = self.waitForTasks(cMsTimeout2 + 1);
3077	if oTask is not oTxsSession:
3078	oTxsSession.cancelTask();
3079	if oTask is None:
3080	reporter.errorTimeout('txsToCdWait: The task timed out (after %s ms).'
3081	% (base.timestampMilli() - msStart,));
3082	elif oTask is oSession:
3083	reporter.error('txsToCdWait: The VM terminated unexpectedly');
3084	else:
3085	reporter.error('txsToCdWait: An unknown task %s was returned' % (oTask,));
3086	fRc = False;
3087	break;
3088	if oTxsSession.isSuccess():
3089	break;
3090
3091	# Check for timeout.
3092	cMsElapsed = base.timestampMilli() - msStart;
3093	if cMsElapsed >= cMsTimeout:
3094	reporter.error('txsToCdWait: timed out');
3095	fRc = False;
3096	break;
3097
3098	# delay.
3099	self.sleep(1);
3100
3101	# resubmitt the task.
3102	cMsTimeout2 = msStart + cMsTimeout - base.timestampMilli();
3103	if cMsTimeout2 < 500:
3104	cMsTimeout2 = 500;
3105	fRc = oTxsSession.asyncIsFile('${CDROM}/%s' % (sFileCdWait), cMsTimeout2);
3106	if fRc is not True:
3107	reporter.error('txsToCdWait: asyncIsFile failed');
3108	break;
3109	else:
3110	reporter.error('txsToCdWait: asyncIsFile failed');
3111
3112	if fRemoveTxs:
3113	self.removeTask(oTxsSession);
3114	if fRemoveVm:
3115	self.removeTask(oSession);
3116	return fRc;
3117
3118	def txsDoConnectViaTcp(self, oSession, cMsTimeout, fNatForwardingForTxs = False):
3119	"""
3120	Mostly an internal worker for connecting to TXS via TCP used by the
3121	*ViaTcp methods.
3122
3123	Returns a tuplet with True/False and TxsSession/None depending on the
3124	result. Errors are logged.
3125	"""
3126
3127	reporter.log2('txsDoConnectViaTcp: oSession=%s, cMsTimeout=%s, fNatForwardingForTxs=%s'
3128	% (oSession, cMsTimeout, fNatForwardingForTxs));
3129
3130	cMsTimeout = self.adjustTimeoutMs(cMsTimeout);
3131	oTxsConnect = oSession.txsConnectViaTcp(cMsTimeout, fNatForwardingForTxs = fNatForwardingForTxs);
3132	if oTxsConnect is not None:
3133	self.addTask(oTxsConnect);
3134	fRemoveVm = self.addTask(oSession);
3135	oTask = self.waitForTasks(cMsTimeout + 1);
3136	reporter.log2('txsDoConnectViaTcp: waitForTasks returned %s' % (oTask,));
3137	self.removeTask(oTxsConnect);
3138	if oTask is oTxsConnect:
3139	oTxsSession = oTxsConnect.getResult();
3140	if oTxsSession is not None:
3141	reporter.log('txsDoConnectViaTcp: Connected to TXS on %s.' % (oTxsSession.oTransport.sHostname,));
3142	return (True, oTxsSession);
3143
3144	reporter.error('txsDoConnectViaTcp: failed to connect to TXS.');
3145	else:
3146	oTxsConnect.cancelTask();
3147	if oTask is None:
3148	reporter.errorTimeout('txsDoConnectViaTcp: connect stage 1 timed out');
3149	elif oTask is oSession:
3150	oSession.reportPrematureTermination('txsDoConnectViaTcp: ');
3151	else:
3152	reporter.error('txsDoConnectViaTcp: unknown/wrong task %s' % (oTask,));
3153	if fRemoveVm:
3154	self.removeTask(oSession);
3155	else:
3156	reporter.error('txsDoConnectViaTcp: txsConnectViaTcp failed');
3157	return (False, None);
3158
3159	def startVmAndConnectToTxsViaTcp(self, sVmName, fCdWait = False, cMsTimeout = 15*60000, \
3160	cMsCdWait = 30000, sFileCdWait = 'vboxtxs-readme.txt', \
3161	fNatForwardingForTxs = False):
3162	"""
3163	Starts the specified VM and tries to connect to its TXS via TCP.
3164	The VM will be powered off if TXS doesn't respond before the specified
3165	time has elapsed.
3166
3167	Returns a the VM and TXS sessions (a two tuple) on success. The VM
3168	session is in the task list, the TXS session is not.
3169	Returns (None, None) on failure, fully logged.
3170	"""
3171
3172	# Zap the guest IP to make sure we're not getting a stale entry
3173	# (unless we're restoring the VM of course).
3174	oTestVM = self.oTestVmSet.findTestVmByName(sVmName) if self.oTestVmSet is not None else None;
3175	if oTestVM is None \
3176	or oTestVM.fSnapshotRestoreCurrent is False:
3177	try:
3178	oSession1 = self.openSession(self.getVmByName(sVmName));
3179	oSession1.delGuestPropertyValue('/VirtualBox/GuestInfo/Net/0/V4/IP');
3180	oSession1.saveSettings(True);
3181	del oSession1;
3182	except:
3183	reporter.logXcpt();
3184
3185	# Start the VM.
3186	reporter.log('startVmAndConnectToTxsViaTcp: Starting(/preparing) "%s" (timeout %s s)...' % (sVmName, cMsTimeout / 1000));
3187	oSession = self.startVmByName(sVmName);
3188	if oSession is not None:
3189	# Connect to TXS.
3190	reporter.log2('startVmAndConnectToTxsViaTcp: Started(/prepared) "%s", connecting to TXS ...' % (sVmName,));
3191	(fRc, oTxsSession) = self.txsDoConnectViaTcp(oSession, cMsTimeout, fNatForwardingForTxs);
3192	if fRc is True:
3193	if fCdWait:
3194	# Wait for CD?
3195	fRc = self.txsCdWait(oSession, oTxsSession, cMsCdWait, sFileCdWait);
3196	if fRc is not True:
3197	reporter.error('startVmAndConnectToTxsViaTcp: txsCdWait failed');
3198	if fRc is True:
3199	# Success!
3200	return (oSession, oTxsSession);
3201	else:
3202	reporter.error('startVmAndConnectToTxsViaTcp: txsDoConnectViaTcp failed');
3203	# If something went wrong while waiting for TXS to be started - take VM screenshot before terminate it
3204	self.terminateVmBySession(oSession);
3205	return (None, None);
3206
3207	def txsRebootAndReconnectViaTcp(self, oSession, oTxsSession, fCdWait = False, cMsTimeout = 15*60000, \
3208	cMsCdWait = 30000, sFileCdWait = 'vboxtxs-readme.txt', fNatForwardingForTxs = False):
3209	"""
3210	Executes the TXS reboot command
3211
3212	Returns A tuple of True and the new TXS session on success.
3213
3214	Returns A tuple of False and either the old TXS session or None on failure.
3215	"""
3216	reporter.log2('txsRebootAndReconnect: cMsTimeout=%u' % (cMsTimeout,));
3217
3218	#
3219	# This stuff is a bit complicated because of rebooting being kind of
3220	# disruptive to the TXS and such... The protocol is that TXS will:
3221	# - ACK the reboot command.
3222	# - Shutdown the transport layer, implicitly disconnecting us.
3223	# - Execute the reboot operation.
3224	# - On failure, it will be re-init the transport layer and be
3225	# available pretty much immediately. UUID unchanged.
3226	# - On success, it will be respawed after the reboot (hopefully),
3227	# with a different UUID.
3228	#
3229	fRc = False;
3230	iStart = base.timestampMilli();
3231
3232	# Get UUID.
3233	cMsTimeout2 = min(60000, cMsTimeout);
3234	sUuidBefore = self.txsUuid(oSession, oTxsSession, self.adjustTimeoutMs(cMsTimeout2, 60000));
3235	if sUuidBefore is not False:
3236	# Reboot.
3237	cMsElapsed = base.timestampMilli() - iStart;
3238	cMsTimeout2 = cMsTimeout - cMsElapsed;
3239	fRc = self.txsDoTask(oSession, oTxsSession, oTxsSession.asyncReboot,
3240	(self.adjustTimeoutMs(cMsTimeout2, 60000), False));
3241	if fRc is True:
3242	# Reconnect.
3243	if fNatForwardingForTxs is True:
3244	self.sleep(22); # NAT fudge - Two fixes are wanted: 1. TXS connect retries. 2. Main API reboot/reset hint.
3245	cMsElapsed = base.timestampMilli() - iStart;
3246	(fRc, oTxsSession) = self.txsDoConnectViaTcp(oSession, cMsTimeout - cMsElapsed, fNatForwardingForTxs);
3247	if fRc is True:
3248	# Check the UUID.
3249	cMsElapsed = base.timestampMilli() - iStart;
3250	cMsTimeout2 = min(60000, cMsTimeout - cMsElapsed);
3251	sUuidAfter = self.txsDoTask(oSession, oTxsSession, oTxsSession.asyncUuid,
3252	(self.adjustTimeoutMs(cMsTimeout2, 60000), False));
3253	if sUuidBefore is not False:
3254	if sUuidAfter != sUuidBefore:
3255	reporter.log('The guest rebooted (UUID %s -> %s)' % (sUuidBefore, sUuidAfter))
3256
3257	# Do CD wait if specified.
3258	if fCdWait:
3259	fRc = self.txsCdWait(oSession, oTxsSession, cMsCdWait, sFileCdWait);
3260	if fRc is not True:
3261	reporter.error('txsRebootAndReconnectViaTcp: txsCdWait failed');
3262	else:
3263	reporter.error('txsRebootAndReconnectViaTcp: failed to get UUID (after)');
3264	else:
3265	reporter.error('txsRebootAndReconnectViaTcp: did not reboot (UUID %s)' % (sUuidBefore,));
3266	else:
3267	reporter.error('txsRebootAndReconnectViaTcp: txsDoConnectViaTcp failed');
3268	else:
3269	reporter.error('txsRebootAndReconnectViaTcp: reboot failed');
3270	else:
3271	reporter.error('txsRebootAndReconnectViaTcp: failed to get UUID (before)');
3272	return (fRc, oTxsSession);
3273
3274	# pylint: disable=R0914,R0913
3275
3276	def txsRunTest(self, oTxsSession, sTestName, cMsTimeout, sExecName, asArgs = (), asAddEnv = (), sAsUser = ""):
3277	"""
3278	Executes the specified test task, waiting till it completes or times out.
3279
3280	The VM session (if any) must be in the task list.
3281
3282	Returns True if we executed the task and nothing abnormal happend.
3283	Query the process status from the TXS session.
3284
3285	Returns False if some unexpected task was signalled or we failed to
3286	submit the job.
3287	"""
3288	reporter.testStart(sTestName);
3289	reporter.log2('txsRunTest: cMsTimeout=%u sExecName=%s asArgs=%s' % (cMsTimeout, sExecName, asArgs));
3290
3291	# Submit the job.
3292	fRc = False;
3293	if oTxsSession.asyncExec(sExecName, asArgs, asAddEnv, sAsUser, cMsTimeout = self.adjustTimeoutMs(cMsTimeout)):
3294	self.addTask(oTxsSession);
3295
3296	# Wait for the job to complete.
3297	while True:
3298	oTask = self.waitForTasks(cMsTimeout + 1);
3299	if oTask is None:
3300	reporter.log('txsRunTest: waitForTasks timed out');
3301	break;
3302	if oTask is oTxsSession:
3303	fRc = True;
3304	reporter.log('txsRunTest: isSuccess=%s getResult=%s' % (oTxsSession.isSuccess(), oTxsSession.getResult()));
3305	break;
3306	if not self.handleTask(oTask, 'txsRunTest'):
3307	break;
3308
3309	self.removeTask(oTxsSession);
3310	if not oTxsSession.pollTask():
3311	oTxsSession.cancelTask();
3312	else:
3313	reporter.error('txsRunTest: asyncExec failed');
3314
3315	reporter.testDone();
3316	return fRc;
3317
3318	def txsRunTestRedirectStd(self, oTxsSession, sTestName, cMsTimeout, sExecName, asArgs = (), asAddEnv = (), sAsUser = "",
3319	oStdIn = '/dev/null', oStdOut = '/dev/null', oStdErr = '/dev/null', oTestPipe = '/dev/null'):
3320	"""
3321	Executes the specified test task, waiting till it completes or times out,
3322	redirecting stdin, stdout and stderr to the given objects.
3323
3324	The VM session (if any) must be in the task list.
3325
3326	Returns True if we executed the task and nothing abnormal happend.
3327	Query the process status from the TXS session.
3328
3329	Returns False if some unexpected task was signalled or we failed to
3330	submit the job.
3331	"""
3332	reporter.testStart(sTestName);
3333	reporter.log2('txsRunTestRedirectStd: cMsTimeout=%u sExecName=%s asArgs=%s' % (cMsTimeout, sExecName, asArgs));
3334
3335	# Submit the job.
3336	fRc = False;
3337	if oTxsSession.asyncExecEx(sExecName, asArgs, asAddEnv, oStdIn, oStdOut, oStdErr,
3338	oTestPipe, sAsUser, cMsTimeout = self.adjustTimeoutMs(cMsTimeout)):
3339	self.addTask(oTxsSession);
3340
3341	# Wait for the job to complete.
3342	while True:
3343	oTask = self.waitForTasks(cMsTimeout + 1);
3344	if oTask is None:
3345	reporter.log('txsRunTestRedirectStd: waitForTasks timed out');
3346	break;
3347	if oTask is oTxsSession:
3348	fRc = True;
3349	reporter.log('txsRunTestRedirectStd: isSuccess=%s getResult=%s'
3350	% (oTxsSession.isSuccess(), oTxsSession.getResult()));
3351	break;
3352	if not self.handleTask(oTask, 'txsRunTestRedirectStd'):
3353	break;
3354
3355	self.removeTask(oTxsSession);
3356	if not oTxsSession.pollTask():
3357	oTxsSession.cancelTask();
3358	else:
3359	reporter.error('txsRunTestRedirectStd: asyncExec failed');
3360
3361	reporter.testDone();
3362	return fRc;
3363
3364	def txsRunTest2(self, oTxsSession1, oTxsSession2, sTestName, cMsTimeout,
3365	sExecName1, asArgs1,
3366	sExecName2, asArgs2,
3367	asAddEnv1 = (), sAsUser1 = '', fWithTestPipe1 = True,
3368	asAddEnv2 = (), sAsUser2 = '', fWithTestPipe2 = True):
3369	"""
3370	Executes the specified test tasks, waiting till they complete or
3371	times out. The 1st task is started after the 2nd one.
3372
3373	The VM session (if any) must be in the task list.
3374
3375	Returns True if we executed the task and nothing abnormal happend.
3376	Query the process status from the TXS sessions.
3377
3378	Returns False if some unexpected task was signalled or we failed to
3379	submit the job.
3380	"""
3381	reporter.testStart(sTestName);
3382
3383	# Submit the jobs.
3384	fRc = False;
3385	if oTxsSession1.asyncExec(sExecName1, asArgs1, asAddEnv1, sAsUser1, fWithTestPipe1, '1-',
3386	self.adjustTimeoutMs(cMsTimeout)):
3387	self.addTask(oTxsSession1);
3388
3389	self.sleep(2); # fudge! grr
3390
3391	if oTxsSession2.asyncExec(sExecName2, asArgs2, asAddEnv2, sAsUser2, fWithTestPipe2, '2-',
3392	self.adjustTimeoutMs(cMsTimeout)):
3393	self.addTask(oTxsSession2);
3394
3395	# Wait for the jobs to complete.
3396	cPendingJobs = 2;
3397	while True:
3398	oTask = self.waitForTasks(cMsTimeout + 1);
3399	if oTask is None:
3400	reporter.log('txsRunTest2: waitForTasks timed out');
3401	break;
3402
3403	if oTask is oTxsSession1 or oTask is oTxsSession2:
3404	if oTask is oTxsSession1: iTask = 1;
3405	else: iTask = 2;
3406	reporter.log('txsRunTest2: #%u - isSuccess=%s getResult=%s' \
3407	% (iTask, oTask.isSuccess(), oTask.getResult()));
3408	self.removeTask(oTask);
3409	cPendingJobs -= 1;
3410	if cPendingJobs <= 0:
3411	fRc = True;
3412	break;
3413
3414	elif not self.handleTask(oTask, 'txsRunTest'):
3415	break;
3416
3417	self.removeTask(oTxsSession2);
3418	if not oTxsSession2.pollTask():
3419	oTxsSession2.cancelTask();
3420	else:
3421	reporter.error('txsRunTest2: asyncExec #2 failed');
3422
3423	self.removeTask(oTxsSession1);
3424	if not oTxsSession1.pollTask():
3425	oTxsSession1.cancelTask();
3426	else:
3427	reporter.error('txsRunTest2: asyncExec #1 failed');
3428
3429	reporter.testDone();
3430	return fRc;
3431
3432	# pylint: enable=R0914,R0913
3433

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

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

Download in other formats: