__init__.py 53 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456
  1. # pylint: disable=invalid-name
  2. #
  3. # The Qubes OS Project, https://www.qubes-os.org/
  4. #
  5. # Copyright (C) 2014-2015 Joanna Rutkowska <joanna@invisiblethingslab.com>
  6. # Copyright (C) 2014-2015
  7. # Marek Marczykowski-Górecki <marmarek@invisiblethingslab.com>
  8. # Copyright (C) 2014-2015 Wojtek Porczyk <woju@invisiblethingslab.com>
  9. #
  10. # This library is free software; you can redistribute it and/or
  11. # modify it under the terms of the GNU Lesser General Public
  12. # License as published by the Free Software Foundation; either
  13. # version 2.1 of the License, or (at your option) any later version.
  14. #
  15. # This library is distributed in the hope that it will be useful,
  16. # but WITHOUT ANY WARRANTY; without even the implied warranty of
  17. # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  18. # Lesser General Public License for more details.
  19. #
  20. # You should have received a copy of the GNU Lesser General Public
  21. # License along with this library; if not, see <https://www.gnu.org/licenses/>.
  22. #
  23. """
  24. .. warning::
  25. The test suite hereby claims any domain whose name starts with
  26. :py:data:`VMPREFIX` as fair game. This is needed to enforce sane
  27. test executing environment. If you have domains named ``test-*``,
  28. don't run the tests.
  29. """
  30. import asyncio
  31. import collections
  32. import functools
  33. import logging
  34. import os
  35. import pathlib
  36. import shlex
  37. import shutil
  38. import subprocess
  39. import sys
  40. import tempfile
  41. import time
  42. import traceback
  43. import unittest
  44. import warnings
  45. from distutils import spawn
  46. import gc
  47. import lxml.etree
  48. import pkg_resources
  49. import qubes
  50. import qubes.api
  51. import qubes.api.admin
  52. import qubes.api.internal
  53. import qubes.api.misc
  54. import qubes.backup
  55. import qubes.config
  56. import qubes.devices
  57. import qubes.events
  58. import qubes.exc
  59. import qubes.ext.pci
  60. import qubes.vm.standalonevm
  61. import qubes.vm.templatevm
  62. XMLPATH = '/var/lib/qubes/qubes-test.xml'
  63. CLASS_XMLPATH = '/var/lib/qubes/qubes-class-test.xml'
  64. TEMPLATE = 'fedora-23'
  65. VMPREFIX = 'test-inst-'
  66. CLSVMPREFIX = 'test-cls-'
  67. if 'DEFAULT_LVM_POOL' in os.environ.keys():
  68. DEFAULT_LVM_POOL = os.environ['DEFAULT_LVM_POOL']
  69. else:
  70. DEFAULT_LVM_POOL = 'qubes_dom0/pool00'
  71. POOL_CONF = {'name': 'test-lvm',
  72. 'driver': 'lvm_thin',
  73. 'volume_group': DEFAULT_LVM_POOL.split('/')[0],
  74. 'thin_pool': DEFAULT_LVM_POOL.split('/')[1]}
  75. #: :py:obj:`True` if running in dom0, :py:obj:`False` otherwise
  76. in_dom0 = False
  77. #: :py:obj:`False` if outside of git repo,
  78. #: path to root of the directory otherwise
  79. in_git = False
  80. try:
  81. import libvirt
  82. libvirt.openReadOnly(qubes.config.defaults['libvirt_uri']).close()
  83. in_dom0 = True
  84. except libvirt.libvirtError:
  85. pass
  86. if in_dom0:
  87. import libvirtaio
  88. libvirt_event_impl = None
  89. try:
  90. in_git = subprocess.check_output(
  91. ['git', 'rev-parse', '--show-toplevel'], stderr=subprocess.DEVNULL
  92. ).decode().strip()
  93. qubes.log.LOGPATH = '/tmp'
  94. qubes.log.LOGFILE = '/tmp/qubes.log'
  95. except subprocess.CalledProcessError:
  96. # git returned nonzero, we are outside git repo
  97. pass
  98. except OSError:
  99. # command not found; let's assume we're outside
  100. pass
  101. ha_syslog = None
  102. def skipUnlessDom0(test_item):
  103. """Decorator that skips test outside dom0.
  104. Some tests (especially integration tests) have to be run in more or less
  105. working dom0. This is checked by connecting to libvirt.
  106. """
  107. return unittest.skipUnless(in_dom0, 'outside dom0')(test_item)
  108. def skipUnlessGit(test_item):
  109. """Decorator that skips test outside git repo.
  110. There are very few tests that an be run only in git. One example is
  111. correctness of example code that won't get included in RPM.
  112. """
  113. return unittest.skipUnless(in_git, 'outside git tree')(test_item)
  114. def skipUnlessEnv(varname):
  115. """Decorator generator for skipping tests without environment variable set.
  116. Some tests require working X11 display, like those using GTK library, which
  117. segfaults without connection to X.
  118. Other require their own, custom variables.
  119. """
  120. return unittest.skipUnless(os.getenv(varname), 'no {} set'.format(varname))
  121. class TestEmitter(qubes.events.Emitter):
  122. """Dummy event emitter which records events fired on it.
  123. Events are counted in :py:attr:`fired_events` attribute, which is
  124. :py:class:`collections.Counter` instance. For each event, ``(event, args,
  125. kwargs)`` object is counted. *event* is event name (a string), *args* is
  126. tuple with positional arguments and *kwargs* is sorted tuple of items from
  127. keyword arguments.
  128. >>> emitter = TestEmitter()
  129. >>> emitter.fired_events
  130. Counter()
  131. >>> emitter.fire_event('event', spam='eggs', foo='bar')
  132. >>> emitter.fired_events
  133. Counter({('event', (1, 2, 3), (('foo', 'bar'), ('spam', 'eggs'))): 1})
  134. """
  135. def __init__(self, *args, **kwargs):
  136. super(TestEmitter, self).__init__(*args, **kwargs)
  137. #: :py:class:`collections.Counter` instance
  138. self.fired_events = collections.Counter()
  139. def fire_event(self, event, **kwargs):
  140. effects = super(TestEmitter, self).fire_event(event, **kwargs)
  141. ev_kwargs = frozenset(
  142. (key,
  143. frozenset(value.items()) if isinstance(value, dict)
  144. else tuple(value) if isinstance(value, list)
  145. else value)
  146. for key, value in kwargs.items()
  147. )
  148. self.fired_events[(event, ev_kwargs)] += 1
  149. return effects
  150. @asyncio.coroutine
  151. def fire_event_async(self, event, pre_event=False, **kwargs):
  152. effects = yield from super(TestEmitter, self).fire_event_async(
  153. event, pre_event=pre_event, **kwargs)
  154. ev_kwargs = frozenset(
  155. (key,
  156. frozenset(value.items()) if isinstance(value, dict) else value)
  157. for key, value in kwargs.items()
  158. )
  159. self.fired_events[(event, ev_kwargs)] += 1
  160. return effects
  161. def expectedFailureIfTemplate(templates):
  162. """
  163. Decorator for marking specific test as expected to fail only for some
  164. templates. Template name is compared as substring, so 'whonix' will
  165. handle both 'whonix-ws' and 'whonix-gw'.
  166. templates can be either a single string, or an iterable
  167. """
  168. def decorator(func):
  169. @functools.wraps(func)
  170. def wrapper(self, *args, **kwargs):
  171. template = self.template
  172. if isinstance(templates, str):
  173. should_expect_fail = template in templates
  174. else:
  175. should_expect_fail = any([template in x for x in templates])
  176. if should_expect_fail:
  177. try:
  178. func(self, *args, **kwargs)
  179. except Exception:
  180. raise unittest.case._ExpectedFailure(sys.exc_info())
  181. raise unittest.case._UnexpectedSuccess()
  182. else:
  183. # Call directly:
  184. func(self, *args, **kwargs)
  185. return wrapper
  186. return decorator
  187. def wait_on_fail(func):
  188. """Test decorator for debugging. It pause test execution on failure and wait
  189. for user input. It's useful to manually inspect system state just after test
  190. fails, before executing any cleanup.
  191. Usage: decorate a test you are debugging.
  192. DO IT ONLY TEMPORARILY, DO NOT COMMIT!
  193. """
  194. @functools.wraps(func)
  195. def wrapper(self, *args, **kwargs):
  196. try:
  197. func(self, *args, **kwargs)
  198. except:
  199. print('FAIL\n')
  200. traceback.print_exc()
  201. print('Press return to continue:', end='')
  202. sys.stdout.flush()
  203. reader = asyncio.StreamReader(loop=self.loop)
  204. transport, protocol = self.loop.run_until_complete(
  205. self.loop.connect_read_pipe(
  206. lambda: asyncio.StreamReaderProtocol(reader),
  207. sys.stdin))
  208. self.loop.run_until_complete(reader.readline())
  209. raise
  210. return wrapper
  211. class _AssertNotRaisesContext(object):
  212. """A context manager used to implement TestCase.assertNotRaises methods.
  213. Stolen from unittest and hacked. Regexp support stripped.
  214. """ # pylint: disable=too-few-public-methods
  215. def __init__(self, expected, test_case, expected_regexp=None):
  216. if expected_regexp is not None:
  217. raise NotImplementedError('expected_regexp is unsupported')
  218. self.expected = expected
  219. self.exception = None
  220. self.failureException = test_case.failureException
  221. def __enter__(self):
  222. return self
  223. def __exit__(self, exc_type, exc_value, tb):
  224. if exc_type is None:
  225. return True
  226. if issubclass(exc_type, self.expected):
  227. raise self.failureException(
  228. "{!r} raised, traceback:\n{!s}".format(
  229. exc_value, ''.join(traceback.format_tb(tb))))
  230. else:
  231. # pass through
  232. return False
  233. self.exception = exc_value # store for later retrieval
  234. class _QrexecPolicyContext(object):
  235. """Context manager for SystemTestCase.qrexec_policy"""
  236. def __init__(self, service, source, destination, allow=True, action=None):
  237. try:
  238. source = source.name
  239. except AttributeError:
  240. pass
  241. try:
  242. destination = destination.name
  243. except AttributeError:
  244. pass
  245. self._filename = pathlib.Path('/etc/qubes-rpc/policy') / service
  246. if action is None:
  247. action = 'allow' if allow else 'deny'
  248. self._rule = '{} {} {}\n'.format(source, destination, action)
  249. self._did_create = False
  250. self._handle = None
  251. def load(self):
  252. if self._handle is None:
  253. try:
  254. self._handle = self._filename.open('r+')
  255. except FileNotFoundError:
  256. self._handle = self._filename.open('w+')
  257. self._did_create = True
  258. self._handle.seek(0)
  259. return self._handle.readlines()
  260. def save(self, rules):
  261. assert self._handle is not None
  262. self._handle.truncate(0)
  263. self._handle.seek(0)
  264. self._handle.write(''.join(rules))
  265. self._handle.flush()
  266. def close(self):
  267. assert self._handle is not None
  268. self._handle.close()
  269. self._handle = None
  270. def __enter__(self):
  271. rules = self.load()
  272. rules.insert(0, self._rule)
  273. self.save(rules)
  274. return self
  275. def __exit__(self, exc_type, exc_value, tb):
  276. if not self._did_create:
  277. try:
  278. rules = self.load()
  279. rules.remove(self._rule)
  280. self.save(rules)
  281. finally:
  282. self.close()
  283. else:
  284. self.close()
  285. self._filename.unlink()
  286. class substitute_entry_points(object):
  287. """Monkey-patch pkg_resources to substitute one group in iter_entry_points
  288. This is for testing plugins, like device classes.
  289. :param str group: The group that is to be overloaded.
  290. :param str tempgroup: The substitute group.
  291. Inside this context, if one iterates over entry points in overloaded group,
  292. the iteration actually happens over the other group.
  293. This context manager is stackable. To substitute more than one entry point
  294. group, just nest two contexts.
  295. """ # pylint: disable=invalid-name
  296. def __init__(self, group, tempgroup):
  297. self.group = group
  298. self.tempgroup = tempgroup
  299. self._orig_iter_entry_points = None
  300. def _iter_entry_points(self, group, *args, **kwargs):
  301. if group == self.group:
  302. group = self.tempgroup
  303. return self._orig_iter_entry_points(group, *args, **kwargs)
  304. def __enter__(self):
  305. self._orig_iter_entry_points = pkg_resources.iter_entry_points
  306. pkg_resources.iter_entry_points = self._iter_entry_points
  307. return self
  308. def __exit__(self, exc_type, exc_value, tb):
  309. pkg_resources.iter_entry_points = self._orig_iter_entry_points
  310. self._orig_iter_entry_points = None
  311. class QubesTestCase(unittest.TestCase):
  312. """Base class for Qubes unit tests.
  313. """
  314. def __init__(self, *args, **kwargs):
  315. super(QubesTestCase, self).__init__(*args, **kwargs)
  316. self.longMessage = True
  317. self.log = logging.getLogger('{}.{}.{}'.format(
  318. self.__class__.__module__,
  319. self.__class__.__name__,
  320. self._testMethodName))
  321. self.addTypeEqualityFunc(qubes.devices.DeviceManager,
  322. self.assertDevicesEqual)
  323. self.loop = None
  324. global libvirt_event_impl
  325. if in_dom0 and not libvirt_event_impl:
  326. libvirt_event_impl = libvirtaio.virEventRegisterAsyncIOImpl()
  327. def __str__(self):
  328. return '{}/{}/{}'.format(
  329. self.__class__.__module__,
  330. self.__class__.__name__,
  331. self._testMethodName)
  332. def setUp(self):
  333. super().setUp()
  334. self.addCleanup(self.cleanup_gc)
  335. self.loop = asyncio.get_event_loop()
  336. self.addCleanup(self.cleanup_loop)
  337. self.addCleanup(self.cleanup_traceback)
  338. def cleanup_traceback(self):
  339. """Remove local variables reference from tracebacks to allow garbage
  340. collector to clean all Qubes*() objects, otherwise file descriptors
  341. held by them will leak"""
  342. exc_infos = [e for test_case, e in self._outcome.errors
  343. if test_case is self]
  344. if self._outcome.expectedFailure:
  345. exc_infos.append(self._outcome.expectedFailure)
  346. for exc_info in exc_infos:
  347. if exc_info is None:
  348. continue
  349. ex = exc_info[1]
  350. while ex is not None:
  351. if isinstance(ex, qubes.exc.QubesVMError):
  352. ex.vm = None
  353. traceback.clear_frames(ex.__traceback__)
  354. ex = ex.__context__
  355. def cleanup_gc(self):
  356. gc.collect()
  357. leaked = [obj for obj in gc.get_objects() + gc.garbage
  358. if isinstance(obj,
  359. (qubes.Qubes, qubes.vm.BaseVM,
  360. libvirt.virConnect, libvirt.virDomain))]
  361. if leaked:
  362. try:
  363. import objgraph
  364. objgraph.show_backrefs(leaked,
  365. max_depth=15, extra_info=extra_info,
  366. filename='/tmp/objgraph-{}.png'.format(
  367. self.id()))
  368. except ImportError:
  369. pass
  370. # do not keep leaked object references in locals()
  371. leaked = bool(leaked)
  372. assert not leaked
  373. def cleanup_loop(self):
  374. """Check if the loop is empty"""
  375. # XXX BEWARE this is touching undocumented, implementation-specific
  376. # attributes of the loop. This is most certainly unsupported and likely
  377. # will break when messing with: Python version, kernel family, loop
  378. # implementation, a combination thereof, or other things.
  379. # KEYWORDS for searching:
  380. # win32, SelectorEventLoop, ProactorEventLoop, uvloop, gevent
  381. global libvirt_event_impl
  382. # really destroy all objects that could have used loop and/or libvirt
  383. gc.collect()
  384. # Check for unfinished libvirt business.
  385. if libvirt_event_impl is not None:
  386. try:
  387. self.loop.run_until_complete(asyncio.wait_for(
  388. libvirt_event_impl.drain(), timeout=4))
  389. except asyncio.TimeoutError:
  390. raise AssertionError('libvirt event impl drain timeout')
  391. # this is stupid, but apparently it requires two passes
  392. # to cleanup SIGCHLD handlers
  393. self.loop.stop()
  394. self.loop.run_forever()
  395. self.loop.stop()
  396. self.loop.run_forever()
  397. # Check there are no Tasks left.
  398. assert not self.loop._ready
  399. assert not self.loop._scheduled
  400. # Check the loop watches no descriptors.
  401. # NOTE the loop has a pipe for self-interrupting, created once per
  402. # lifecycle, and it is unwatched only at loop.close(); so we cannot just
  403. # check selector for non-emptiness
  404. assert len(self.loop._selector.get_map()) \
  405. == int(self.loop._ssock is not None)
  406. del self.loop
  407. def assertNotRaises(self, excClass, callableObj=None, *args, **kwargs):
  408. """Fail if an exception of class excClass is raised
  409. by callableObj when invoked with arguments args and keyword
  410. arguments kwargs. If a different type of exception is
  411. raised, it will not be caught, and the test case will be
  412. deemed to have suffered an error, exactly as for an
  413. unexpected exception.
  414. If called with callableObj omitted or None, will return a
  415. context object used like this::
  416. with self.assertRaises(SomeException):
  417. do_something()
  418. The context manager keeps a reference to the exception as
  419. the 'exception' attribute. This allows you to inspect the
  420. exception after the assertion::
  421. with self.assertRaises(SomeException) as cm:
  422. do_something()
  423. the_exception = cm.exception
  424. self.assertEqual(the_exception.error_code, 3)
  425. """
  426. context = _AssertNotRaisesContext(excClass, self)
  427. if callableObj is None:
  428. return context
  429. with context:
  430. callableObj(*args, **kwargs)
  431. def assertXMLEqual(self, xml1, xml2, msg=''):
  432. """Check for equality of two XML objects.
  433. :param xml1: first element
  434. :param xml2: second element
  435. :type xml1: :py:class:`lxml.etree._Element`
  436. :type xml2: :py:class:`lxml.etree._Element`
  437. """
  438. self.assertEqual(xml1.tag, xml2.tag)
  439. msg += '/' + str(xml1.tag)
  440. if xml1.text is not None and xml2.text is not None:
  441. self.assertEqual(xml1.text.strip(), xml2.text.strip(), msg)
  442. else:
  443. self.assertEqual(xml1.text, xml2.text, msg)
  444. self.assertCountEqual(xml1.keys(), xml2.keys(), msg)
  445. for key in xml1.keys():
  446. self.assertEqual(xml1.get(key), xml2.get(key), msg)
  447. self.assertEqual(len(xml1), len(xml2), msg + ' children count')
  448. for child1, child2 in zip(xml1, xml2):
  449. self.assertXMLEqual(child1, child2, msg=msg)
  450. def assertDevicesEqual(self, devices1, devices2, msg=None):
  451. self.assertEqual(devices1.keys(), devices2.keys(), msg)
  452. for dev_class in devices1.keys():
  453. self.assertEqual(
  454. [str(dev) for dev in devices1[dev_class]],
  455. [str(dev) for dev in devices2[dev_class]],
  456. "Devices of class {} differs{}".format(
  457. dev_class, (": " + msg) if msg else "")
  458. )
  459. def assertEventFired(self, subject, event, kwargs=None):
  460. """Check whether event was fired on given emitter and fail if it did
  461. not.
  462. :param subject: emitter which is being checked
  463. :type emitter: :py:class:`TestEmitter`
  464. :param str event: event identifier
  465. :param dict kwargs: when given, all items must appear in kwargs passed \
  466. to an event
  467. """
  468. will_not_match = object()
  469. for ev, ev_kwargs in subject.fired_events:
  470. if ev != event:
  471. continue
  472. if kwargs is not None:
  473. ev_kwargs = dict(ev_kwargs)
  474. if any(ev_kwargs.get(k, will_not_match) != v
  475. for k, v in kwargs.items()):
  476. continue
  477. return
  478. self.fail('event {!r} {}did not fire on {!r}'.format(
  479. event, ('' if kwargs is None else '{!r} '.format(kwargs)), subject))
  480. def assertEventNotFired(self, subject, event, kwargs=None):
  481. """Check whether event was fired on given emitter. Fail if it did.
  482. :param subject: emitter which is being checked
  483. :type emitter: :py:class:`TestEmitter`
  484. :param str event: event identifier
  485. :param list kwargs: when given, all items must appear in kwargs passed \
  486. to an event
  487. """
  488. will_not_match = object()
  489. for ev, ev_kwargs in subject.fired_events:
  490. if ev != event:
  491. continue
  492. if kwargs is not None:
  493. ev_kwargs = dict(ev_kwargs)
  494. if any(ev_kwargs.get(k, will_not_match) != v
  495. for k, v in kwargs.items()):
  496. continue
  497. self.fail('event {!r} {}did fire on {!r}'.format(
  498. event,
  499. ('' if kwargs is None else '{!r} '.format(kwargs)),
  500. subject))
  501. return
  502. def assertXMLIsValid(self, xml, file=None, schema=None):
  503. """Check whether given XML fulfills Relax NG schema.
  504. Schema can be given in a couple of ways:
  505. - As separate file. This is most common, and also the only way to
  506. handle file inclusion. Call with file name as second argument.
  507. - As string containing actual schema. Put that string in *schema*
  508. keyword argument.
  509. :param lxml.etree._Element xml: XML element instance to check
  510. :param str file: filename of Relax NG schema
  511. :param str schema: optional explicit schema string
  512. """ # pylint: disable=redefined-builtin
  513. if schema is not None and file is None:
  514. relaxng = schema
  515. if isinstance(relaxng, str):
  516. relaxng = lxml.etree.XML(relaxng)
  517. # pylint: disable=protected-access
  518. if isinstance(relaxng, lxml.etree._Element):
  519. relaxng = lxml.etree.RelaxNG(relaxng)
  520. elif file is not None and schema is None:
  521. if not os.path.isabs(file):
  522. basedirs = ['/usr/share/doc/qubes/relaxng']
  523. if in_git:
  524. basedirs.insert(0, os.path.join(in_git, 'relaxng'))
  525. for basedir in basedirs:
  526. abspath = os.path.join(basedir, file)
  527. if os.path.exists(abspath):
  528. file = abspath
  529. break
  530. relaxng = lxml.etree.RelaxNG(file=file)
  531. else:
  532. raise TypeError("There should be excactly one of 'file' and "
  533. "'schema' arguments specified.")
  534. # We have to be extra careful here in case someone messed up with
  535. # self.failureException. It should by default be AssertionError, just
  536. # what is spewed by RelaxNG(), but who knows what might happen.
  537. try:
  538. relaxng.assert_(xml)
  539. except self.failureException:
  540. raise
  541. except AssertionError as e:
  542. self.fail(str(e))
  543. @staticmethod
  544. def make_vm_name(name, class_teardown=False):
  545. if class_teardown:
  546. return CLSVMPREFIX + name
  547. else:
  548. return VMPREFIX + name
  549. class SystemTestCase(QubesTestCase):
  550. """
  551. Mixin for integration tests. All the tests here should use self.app
  552. object and when need qubes.xml path - should use :py:data:`XMLPATH`
  553. defined in this file.
  554. Every VM created by test, must use :py:meth:`SystemTestCase.make_vm_name`
  555. for VM name.
  556. By default self.app represents empty collection, if anything is needed
  557. there from the real collection it can be imported from self.host_app in
  558. :py:meth:`SystemTestCase.setUp`. But *can not be modified* in any way -
  559. this include both changing attributes in
  560. :py:attr:`SystemTestCase.host_app` and modifying files of such imported
  561. VM. If test need to make some modification, it must clone the VM first.
  562. If some group of tests needs class-wide initialization, first of all the
  563. author should consider if it is really needed. But if so, setUpClass can
  564. be used to create Qubes(CLASS_XMLPATH) object and create/import required
  565. stuff there. VMs created in :py:meth:`TestCase.setUpClass` should
  566. use self.make_vm_name('...', class_teardown=True) for name creation.
  567. Such (group of) test need to take care about
  568. :py:meth:`TestCase.tearDownClass` implementation itself.
  569. """
  570. # noinspection PyAttributeOutsideInit
  571. def setUp(self):
  572. if not in_dom0:
  573. self.skipTest('outside dom0')
  574. super(SystemTestCase, self).setUp()
  575. self.remove_test_vms()
  576. global ha_syslog
  577. if ha_syslog is None:
  578. ha_syslog = logging.handlers.SysLogHandler('/dev/log')
  579. ha_syslog.setFormatter(
  580. logging.Formatter('%(name)s[%(process)d]: %(message)s'))
  581. logging.root.addHandler(ha_syslog)
  582. self.log.critical('starting')
  583. # need some information from the real qubes.xml - at least installed
  584. # templates; should not be used for testing, only to initialize self.app
  585. self.host_app = qubes.Qubes(os.path.join(
  586. qubes.config.qubes_base_dir,
  587. qubes.config.system_path['qubes_store_filename']))
  588. if os.path.exists(CLASS_XMLPATH):
  589. shutil.copy(CLASS_XMLPATH, XMLPATH)
  590. else:
  591. shutil.copy(self.host_app.store, XMLPATH)
  592. self.app = qubes.Qubes(XMLPATH)
  593. os.environ['QUBES_XML_PATH'] = XMLPATH
  594. self.app.register_event_handlers()
  595. self.qubesd = self.loop.run_until_complete(
  596. qubes.api.create_servers(
  597. qubes.api.admin.QubesAdminAPI,
  598. qubes.api.internal.QubesInternalAPI,
  599. qubes.api.misc.QubesMiscAPI,
  600. app=self.app, debug=True))
  601. self.addCleanup(self.cleanup_app)
  602. self.app.add_handler('domain-delete', self.close_qdb_on_remove)
  603. def close_qdb_on_remove(self, app, event, vm, **kwargs):
  604. # only close QubesDB connection, do not perform other (destructive)
  605. # actions of vm.close()
  606. if vm._qdb_connection_watch is not None:
  607. asyncio.get_event_loop().remove_reader(
  608. vm._qdb_connection_watch.watch_fd())
  609. vm._qdb_connection_watch.close()
  610. vm._qdb_connection_watch = None
  611. def cleanup_app(self):
  612. self.remove_test_vms()
  613. server = None
  614. for server in self.qubesd:
  615. for sock in server.sockets:
  616. os.unlink(sock.getsockname())
  617. server.close()
  618. del server
  619. # close all existing connections, especially this will interrupt
  620. # running admin.Events calls, which do keep reference to Qubes() and
  621. # libvirt connection
  622. conn = None
  623. for conn in qubes.api.QubesDaemonProtocol.connections:
  624. if conn.transport:
  625. conn.transport.abort()
  626. del conn
  627. self.loop.run_until_complete(asyncio.wait([
  628. server.wait_closed() for server in self.qubesd]))
  629. del self.qubesd
  630. # remove all references to any complex qubes objects, to release
  631. # resources - most importantly file descriptors; this object will live
  632. # during the whole test run, but all the file descriptors would be
  633. # depleted earlier
  634. self.app.close()
  635. self.host_app.close()
  636. del self.app
  637. del self.host_app
  638. for attr in dir(self):
  639. obj_type = type(getattr(self, attr))
  640. if obj_type.__module__.startswith('qubes'):
  641. delattr(self, attr)
  642. # then trigger garbage collector to really destroy those objects
  643. gc.collect()
  644. def init_default_template(self, template=None):
  645. if template is None:
  646. template = self.host_app.default_template
  647. elif isinstance(template, str):
  648. template = self.host_app.domains[template]
  649. self.app.default_template = str(template)
  650. def init_networking(self):
  651. if not self.app.default_template:
  652. self.skipTest('Default template required for testing networking')
  653. default_netvm = self.host_app.default_netvm
  654. # if testing Whonix Workstation based VMs, try to use sys-whonix instead
  655. if self.app.default_template.name.startswith('whonix-ws'):
  656. if 'sys-whonix' in self.host_app.domains:
  657. default_netvm = self.host_app.domains['sys-whonix']
  658. if default_netvm is None:
  659. self.skipTest('Default netvm required')
  660. if not default_netvm.is_running():
  661. self.skipTest('VM {} required to be running'.format(
  662. default_netvm.name))
  663. self.app.default_netvm = str(default_netvm)
  664. def _find_pool(self, volume_group, thin_pool):
  665. """ Returns the pool matching the specified ``volume_group`` &
  666. ``thin_pool``, or None.
  667. """
  668. pools = [p for p in self.app.pools
  669. if issubclass(p.__class__, qubes.storage.lvm.ThinPool)]
  670. for pool in pools:
  671. if pool.volume_group == volume_group \
  672. and pool.thin_pool == thin_pool:
  673. return pool
  674. return None
  675. def init_lvm_pool(self):
  676. volume_group, thin_pool = DEFAULT_LVM_POOL.split('/', 1)
  677. path = "/dev/mapper/{!s}-{!s}".format(volume_group, thin_pool)
  678. if not os.path.exists(path):
  679. self.skipTest('LVM thin pool {!r} does not exist'.
  680. format(DEFAULT_LVM_POOL))
  681. self.pool = self._find_pool(volume_group, thin_pool)
  682. if not self.pool:
  683. self.pool = self.loop.run_until_complete(
  684. self.app.add_pool(**POOL_CONF))
  685. self.created_pool = True
  686. def _remove_vm_qubes(self, vm):
  687. vmname = vm.name
  688. app = vm.app
  689. try:
  690. del app.domains[vm.qid]
  691. except KeyError:
  692. pass
  693. try:
  694. self.loop.run_until_complete(vm.remove_from_disk())
  695. except: # pylint: disable=bare-except
  696. pass
  697. vm.close()
  698. del vm
  699. app.save()
  700. del app
  701. # Now ensure it really went away. This may not have happened,
  702. # for example if vm.libvirt_domain malfunctioned.
  703. try:
  704. conn = libvirt.open(qubes.config.defaults['libvirt_uri'])
  705. except: # pylint: disable=bare-except
  706. pass
  707. else:
  708. try:
  709. dom = conn.lookupByName(vmname)
  710. except: # pylint: disable=bare-except
  711. pass
  712. else:
  713. self._remove_vm_libvirt(dom)
  714. conn.close()
  715. self._remove_vm_disk(vmname)
  716. @staticmethod
  717. def _remove_vm_libvirt(dom):
  718. try:
  719. dom.destroy()
  720. except libvirt.libvirtError: # not running
  721. pass
  722. dom.undefine()
  723. @staticmethod
  724. def _remove_vm_disk(vmname):
  725. for dirspec in (
  726. 'qubes_appvms_dir',
  727. 'qubes_templates_dir'):
  728. dirpath = os.path.join(qubes.config.qubes_base_dir,
  729. qubes.config.system_path[dirspec], vmname)
  730. if os.path.exists(dirpath):
  731. if os.path.isdir(dirpath):
  732. shutil.rmtree(dirpath)
  733. else:
  734. os.unlink(dirpath)
  735. @staticmethod
  736. def _remove_vm_disk_lvm(prefix=VMPREFIX):
  737. """ Remove LVM volumes with given prefix
  738. This is "a bit" drastic, as it removes volumes regardless of volume
  739. group, thin pool etc. But we assume no important data on test system.
  740. """
  741. try:
  742. volumes = subprocess.check_output(
  743. ['lvs', '--noheadings', '-o', 'vg_name,name',
  744. '--separator', '/']).decode()
  745. if ('/vm-' + prefix) not in volumes:
  746. return
  747. subprocess.check_call(['sudo', 'lvremove', '-f'] +
  748. [vol.strip() for vol in volumes.splitlines()
  749. if ('/vm-' + prefix) in vol],
  750. stdout=subprocess.DEVNULL)
  751. except subprocess.CalledProcessError:
  752. pass
  753. def remove_vms(self, vms):
  754. vms = list(vms)
  755. if not vms:
  756. return
  757. # workaround for https://phabricator.whonix.org/T930
  758. # unregister all the VMs from sys-whonix, otherwise it will start them
  759. # again (possibly in further test)
  760. if hasattr(self, 'app') and 'whonix' in self.app.default_netvm.name:
  761. for vm in vms:
  762. try:
  763. self.loop.run_until_complete(
  764. self.app.default_netvm.run_service_for_stdio(
  765. 'whonix.NewStatus+{}_shutdown'.format(vm.name)))
  766. except:
  767. pass
  768. locked_vms = set()
  769. # first take startup lock
  770. for vm in vms:
  771. self.loop.run_until_complete(vm.startup_lock.acquire())
  772. locked_vms.add(vm)
  773. # first kill all the domains, to avoid side effects of changing netvm
  774. for vm in vms:
  775. try:
  776. # XXX .is_running() may throw libvirtError if undefined
  777. if vm.is_running():
  778. self.loop.run_until_complete(vm._kill_locked())
  779. except: # pylint: disable=bare-except
  780. pass
  781. # break dependencies
  782. for vm in vms:
  783. vm.default_dispvm = None
  784. vm.netvm = None
  785. # take app instance from any VM to be removed
  786. app = vms[0].app
  787. if app.default_dispvm in vms:
  788. app.default_dispvm = None
  789. if app.default_netvm in vms:
  790. app.default_netvm = None
  791. del app
  792. # then remove in reverse topological order (wrt template), using naive
  793. # algorithm
  794. # this heavily depends on lack of template loops, but those are
  795. # impossible
  796. while vms:
  797. vm = vms.pop(0)
  798. # make sure that all connected VMs are going to be removed,
  799. # otherwise this will loop forever
  800. child_vms = list(getattr(vm, 'appvms', []))
  801. assert all(x in vms for x in child_vms)
  802. if child_vms:
  803. # if still something use this VM, put it at the end of queue
  804. # and try next one
  805. vms.append(vm)
  806. continue
  807. self._remove_vm_qubes(vm)
  808. # release startup_lock, if anything was waiting at vm.start(),
  809. # it will detect the VM is gone
  810. for vm in locked_vms:
  811. vm.startup_lock.release()
  812. def remove_test_vms(self, xmlpath=XMLPATH, prefix=VMPREFIX):
  813. """Aggressively remove any domain that has name in testing namespace.
  814. :param prefix: name prefix of VMs to remove, can be a list of prefixes
  815. """
  816. if isinstance(prefix, str):
  817. prefixes = [prefix]
  818. else:
  819. prefixes = prefix
  820. del prefix
  821. # first, remove them Qubes-way
  822. if os.path.exists(xmlpath):
  823. try:
  824. try:
  825. app = self.app
  826. except AttributeError:
  827. app = qubes.Qubes(xmlpath)
  828. try:
  829. host_app = self.host_app
  830. except AttributeError:
  831. host_app = qubes.Qubes()
  832. self.remove_vms([vm for vm in app.domains
  833. if any(
  834. vm.name.startswith(prefix) for prefix in prefixes) or
  835. (isinstance(vm,
  836. qubes.vm.dispvm.DispVM) and vm.name
  837. not in host_app.domains)])
  838. if not hasattr(self, 'host_app'):
  839. host_app.close()
  840. del host_app
  841. if not hasattr(self, 'app'):
  842. app.close()
  843. del app
  844. except qubes.exc.QubesException:
  845. pass
  846. os.unlink(xmlpath)
  847. # now remove what was only in libvirt
  848. conn = libvirt.open(qubes.config.defaults['libvirt_uri'])
  849. for dom in conn.listAllDomains():
  850. if any(dom.name().startswith(prefix) for prefix in prefixes):
  851. self._remove_vm_libvirt(dom)
  852. conn.close()
  853. # finally remove anything that is left on disk
  854. vmnames = set()
  855. for dirspec in (
  856. 'qubes_appvms_dir',
  857. 'qubes_templates_dir'):
  858. dirpath = os.path.join(qubes.config.qubes_base_dir,
  859. qubes.config.system_path[dirspec])
  860. if not os.path.exists(dirpath):
  861. continue
  862. for name in os.listdir(dirpath):
  863. if any(name.startswith(prefix) for prefix in prefixes):
  864. vmnames.add(name)
  865. for vmname in vmnames:
  866. self._remove_vm_disk(vmname)
  867. for prefix in prefixes:
  868. self._remove_vm_disk_lvm(prefix)
  869. def qrexec_policy(self, service, source, destination, allow=True,
  870. action=None):
  871. """
  872. Allow qrexec calls for duration of the test
  873. :param service: service name
  874. :param source: source VM name
  875. :param destination: destination VM name
  876. :param allow: add rule with 'allow' action, otherwise 'deny'
  877. :param action: custom action, if specified *allow* argument is ignored
  878. :return:
  879. """
  880. return _QrexecPolicyContext(service, source, destination,
  881. allow=allow, action=action)
  882. @asyncio.coroutine
  883. def wait_for_window_hide_coro(self, title, winid, timeout=30):
  884. """
  885. Wait for window do disappear
  886. :param winid: window id
  887. :return:
  888. """
  889. wait_count = 0
  890. while subprocess.call(['xdotool', 'getwindowname', str(winid)],
  891. stdout=subprocess.DEVNULL,
  892. stderr=subprocess.STDOUT) == 0:
  893. wait_count += 1
  894. if wait_count > timeout * 10:
  895. self.fail("Timeout while waiting for {}({}) window to "
  896. "disappear".format(title, winid))
  897. yield from asyncio.sleep(0.1)
  898. @asyncio.coroutine
  899. def wait_for_window_coro(self, title, search_class=False, timeout=30,
  900. show=True):
  901. """
  902. Wait for a window with a given title. Depending on show parameter,
  903. it will wait for either window to show or to disappear.
  904. :param title: title of the window to wait for
  905. :param timeout: timeout of the operation, in seconds
  906. :param show: if True - wait for the window to be visible,
  907. otherwise - to not be visible
  908. :param search_class: search based on window class instead of title
  909. :return: window id of found window, if show=True
  910. """
  911. xdotool_search = ['xdotool', 'search', '--onlyvisible']
  912. if search_class:
  913. xdotool_search.append('--class')
  914. else:
  915. xdotool_search.append('--name')
  916. if show:
  917. xdotool_search.append('--sync')
  918. if not show:
  919. try:
  920. winid = subprocess.check_output(xdotool_search + [title],
  921. stderr=subprocess.DEVNULL).decode()
  922. except subprocess.CalledProcessError:
  923. # already gone
  924. return
  925. yield from self.wait_for_window_hide_coro(winid, title,
  926. timeout=timeout)
  927. return
  928. winid = None
  929. while not winid:
  930. p = yield from asyncio.create_subprocess_exec(
  931. *xdotool_search, title,
  932. stderr=subprocess.DEVNULL, stdout=subprocess.PIPE)
  933. try:
  934. (winid, _) = yield from asyncio.wait_for(
  935. p.communicate(), timeout)
  936. # don't check exit code, getting winid on stdout is enough
  937. # indicator of success; specifically ignore xdotool failing
  938. # with BadWindow or such - when some window appears only for a
  939. # moment by xdotool didn't manage to get its properties
  940. except asyncio.TimeoutError:
  941. self.fail(
  942. "Timeout while waiting for {} window to show".format(title))
  943. return winid.decode().strip()
  944. def wait_for_window(self, *args, **kwargs):
  945. """
  946. Wait for a window with a given title. Depending on show parameter,
  947. it will wait for either window to show or to disappear.
  948. :param title: title of the window to wait for
  949. :param timeout: timeout of the operation, in seconds
  950. :param show: if True - wait for the window to be visible,
  951. otherwise - to not be visible
  952. :param search_class: search based on window class instead of title
  953. :return: window id of found window, if show=True
  954. """
  955. return self.loop.run_until_complete(
  956. self.wait_for_window_coro(*args, **kwargs))
  957. def enter_keys_in_window(self, title, keys):
  958. """
  959. Search for window with given title, then enter listed keys there.
  960. The function will wait for said window to appear.
  961. :param title: title of window
  962. :param keys: list of keys to enter, as for `xdotool key`
  963. :return: None
  964. """
  965. # 'xdotool search --sync' sometimes crashes on some race when
  966. # accessing window properties
  967. self.wait_for_window(title)
  968. command = ['xdotool', 'search', '--name', title,
  969. 'windowactivate', '--sync',
  970. 'key'] + keys
  971. subprocess.check_call(command)
  972. def shutdown_and_wait(self, vm, timeout=60):
  973. try:
  974. self.loop.run_until_complete(
  975. vm.shutdown(wait=True, timeout=timeout))
  976. except qubes.exc.QubesException:
  977. name = vm.name
  978. del vm
  979. self.fail("Timeout while waiting for VM {} shutdown".format(name))
  980. def prepare_hvm_system_linux(self, vm, init_script, extra_files=None):
  981. if not os.path.exists('/usr/lib/grub/i386-pc'):
  982. self.skipTest('grub2 not installed')
  983. if not spawn.find_executable('grub2-install'):
  984. self.skipTest('grub2-tools not installed')
  985. if not spawn.find_executable('dracut'):
  986. self.skipTest('dracut not installed')
  987. # create a single partition
  988. p = subprocess.Popen(['sfdisk', '-q', '-L', vm.storage.root_img],
  989. stdin=subprocess.PIPE,
  990. stdout=subprocess.DEVNULL,
  991. stderr=subprocess.STDOUT)
  992. p.communicate('2048,\n')
  993. assert p.returncode == 0, 'sfdisk failed'
  994. # TODO: check if root_img is really file, not already block device
  995. p = subprocess.Popen(['sudo', 'losetup', '-f', '-P', '--show',
  996. vm.storage.root_img], stdout=subprocess.PIPE)
  997. (loopdev, _) = p.communicate()
  998. loopdev = loopdev.strip()
  999. looppart = loopdev + 'p1'
  1000. assert p.returncode == 0, 'losetup failed'
  1001. subprocess.check_call(['sudo', 'mkfs.ext2', '-q', '-F', looppart])
  1002. mountpoint = tempfile.mkdtemp()
  1003. subprocess.check_call(['sudo', 'mount', looppart, mountpoint])
  1004. try:
  1005. subprocess.check_call(['sudo', 'grub2-install',
  1006. '--target', 'i386-pc',
  1007. '--modules', 'part_msdos ext2',
  1008. '--boot-directory', mountpoint, loopdev],
  1009. stderr=subprocess.DEVNULL
  1010. )
  1011. grub_cfg = '{}/grub2/grub.cfg'.format(mountpoint)
  1012. subprocess.check_call(
  1013. ['sudo', 'chown', '-R', os.getlogin(), mountpoint])
  1014. with open(grub_cfg, 'w') as f:
  1015. f.write(
  1016. "set timeout=1\n"
  1017. "menuentry 'Default' {\n"
  1018. " linux /vmlinuz root=/dev/xvda1 "
  1019. "rd.driver.blacklist=bochs_drm "
  1020. "rd.driver.blacklist=uhci_hcd console=hvc0\n"
  1021. " initrd /initrd\n"
  1022. "}"
  1023. )
  1024. p = subprocess.Popen(['uname', '-r'], stdout=subprocess.PIPE)
  1025. (kernel_version, _) = p.communicate()
  1026. kernel_version = kernel_version.strip()
  1027. kernel = '/boot/vmlinuz-{}'.format(kernel_version)
  1028. shutil.copy(kernel, os.path.join(mountpoint, 'vmlinuz'))
  1029. init_path = os.path.join(mountpoint, 'init')
  1030. with open(init_path, 'w') as f:
  1031. f.write(init_script)
  1032. os.chmod(init_path, 0o755)
  1033. dracut_args = [
  1034. '--kver', kernel_version,
  1035. '--include', init_path,
  1036. '/usr/lib/dracut/hooks/pre-pivot/initscript.sh',
  1037. '--no-hostonly', '--nolvmconf', '--nomdadmconf',
  1038. ]
  1039. if extra_files:
  1040. dracut_args += ['--install', ' '.join(extra_files)]
  1041. subprocess.check_call(
  1042. ['dracut'] + dracut_args + [os.path.join(mountpoint,
  1043. 'initrd')],
  1044. stderr=subprocess.DEVNULL
  1045. )
  1046. finally:
  1047. subprocess.check_call(['sudo', 'umount', mountpoint])
  1048. shutil.rmtree(mountpoint)
  1049. subprocess.check_call(['sudo', 'losetup', '-d', loopdev])
  1050. def create_bootable_iso(self):
  1051. """Create simple bootable ISO image.
  1052. Type 'poweroff' to it to terminate that VM.
  1053. """
  1054. isolinux_cfg = (
  1055. 'prompt 1\n'
  1056. 'label poweroff\n'
  1057. ' kernel poweroff.c32\n'
  1058. )
  1059. output_fd, output_path = tempfile.mkstemp('.iso')
  1060. with tempfile.TemporaryDirectory() as tmp_dir:
  1061. try:
  1062. shutil.copy('/usr/share/syslinux/isolinux.bin', tmp_dir)
  1063. shutil.copy('/usr/share/syslinux/ldlinux.c32', tmp_dir)
  1064. shutil.copy('/usr/share/syslinux/poweroff.c32', tmp_dir)
  1065. with open(os.path.join(tmp_dir, 'isolinux.cfg'), 'w') as cfg:
  1066. cfg.write(isolinux_cfg)
  1067. subprocess.check_call(['genisoimage', '-o', output_path,
  1068. '-c', 'boot.cat',
  1069. '-b', 'isolinux.bin',
  1070. '-no-emul-boot',
  1071. '-boot-load-size', '4',
  1072. '-boot-info-table',
  1073. '-q',
  1074. tmp_dir])
  1075. except FileNotFoundError:
  1076. self.skipTest('syslinux or genisoimage not installed')
  1077. os.close(output_fd)
  1078. self.addCleanup(os.unlink, output_path)
  1079. return output_path
  1080. def create_local_file(self, filename, content, mode='w'):
  1081. with open(filename, mode) as file:
  1082. file.write(content)
  1083. self.addCleanup(os.unlink, filename)
  1084. def create_remote_file(self, vm, filename, content, mode=0o755):
  1085. self.loop.run_until_complete(vm.run_for_stdio(
  1086. 'cat > {0}; chmod {1:o} {0}'.format(shlex.quote(filename), mode),
  1087. user='root', input=content.encode('utf-8')))
  1088. @asyncio.coroutine
  1089. def wait_for_session(self, vm):
  1090. timeout = 30
  1091. if getattr(vm, 'template', None) and 'whonix-ws' in vm.template.name:
  1092. # first boot of whonix-ws takes more time because of /home
  1093. # initialization, including Tor Browser copying
  1094. timeout = 120
  1095. yield from asyncio.wait_for(
  1096. vm.run_service_for_stdio(
  1097. 'qubes.WaitForSession', input=vm.default_user.encode()),
  1098. timeout=timeout)
  1099. _templates = None
  1100. def list_templates():
  1101. """Returns tuple of template names available in the system."""
  1102. global _templates
  1103. if _templates is None:
  1104. if 'QUBES_TEST_TEMPLATES' in os.environ:
  1105. _templates = os.environ['QUBES_TEST_TEMPLATES'].split()
  1106. if _templates is None:
  1107. try:
  1108. app = qubes.Qubes()
  1109. _templates = tuple(vm.name for vm in app.domains
  1110. if isinstance(vm,
  1111. qubes.vm.templatevm.TemplateVM) and
  1112. vm.features.get('os', None) != 'Windows')
  1113. app.close()
  1114. del app
  1115. except OSError:
  1116. _templates = ()
  1117. return _templates
  1118. def create_testcases_for_templates(name, *bases, module, **kwds):
  1119. """Do-it-all helper for generating per-template tests via load_tests proto
  1120. This does several things:
  1121. - creates per-template classes
  1122. - adds them to module's :py:func:`globals`
  1123. - returns an iterable suitable for passing to loader.loadTestsFromNames
  1124. TestCase classes created by this function have implicit `.template`
  1125. attribute, which contains name of the respective template. They are also
  1126. named with given prefix, underscore and template name. If template name
  1127. contains characters not valid as part of Python identifier, they are
  1128. impossible to get via standard ``.`` operator, though :py:func:`getattr` is
  1129. still usable.
  1130. >>> class MyTestsMixIn:
  1131. ... def test_000_my_test(self):
  1132. ... assert self.template.startswith('debian')
  1133. >>> def load_tests(loader, tests, pattern):
  1134. ... tests.addTests(loader.loadTestsFromNames(
  1135. ... qubes.tests.create_testcases_for_templates(
  1136. ... 'TC_00_MyTests', MyTestsMixIn, qubes.tests.SystemTestCase,
  1137. ... module=sys.modules[__name__])))
  1138. *NOTE* adding ``module=sys.modules[__name__]`` is *mandatory*, and to allow
  1139. enforcing this, it uses keyword-only argument syntax, which is only in
  1140. Python 3.
  1141. """
  1142. # Do not attempt to grab the module from traceback, since we are actually
  1143. # a generator and loadTestsFromNames may also be a generator, so it's not
  1144. # possible to correctly guess frame from stack. Explicit is better than
  1145. # implicit!
  1146. for template in list_templates():
  1147. clsname = name + '_' + template
  1148. if hasattr(module, clsname):
  1149. continue
  1150. cls = type(clsname, bases, {'template': template, **kwds})
  1151. cls.__module__ = module.__name__
  1152. # XXX I wonder what other __dunder__ attrs did I miss
  1153. setattr(module, clsname, cls)
  1154. yield '.'.join((module.__name__, clsname))
  1155. def maybe_create_testcases_on_import(create_testcases_gen):
  1156. """If certain conditions are met, call *create_testcases_gen* to create
  1157. testcases for templates tests. The purpose is to use it on integration
  1158. tests module(s) import, so the test runner could discover tests without
  1159. using load tests protocol.
  1160. The conditions - any of:
  1161. - QUBES_TEST_TEMPLATES present in the environment (it's possible to
  1162. create test cases without opening qubes.xml)
  1163. - QUBES_TEST_LOAD_ALL present in the environment
  1164. """
  1165. if 'QUBES_TEST_TEMPLATES' in os.environ or \
  1166. 'QUBES_TEST_LOAD_ALL' in os.environ:
  1167. list(create_testcases_gen())
  1168. def extra_info(obj):
  1169. """Return short info identifying object.
  1170. For example, if obj is a qube, return its name. This is for use with
  1171. :py:mod:`objgraph` package.
  1172. """
  1173. # Feel free to extend to other cases.
  1174. if isinstance(obj, qubes.vm.qubesvm.QubesVM):
  1175. try:
  1176. return obj.name
  1177. except AttributeError:
  1178. pass
  1179. if isinstance(obj, unittest.TestCase):
  1180. return obj.id()
  1181. return ''
  1182. def load_tests(loader, tests, pattern): # pylint: disable=unused-argument
  1183. # discard any tests from this module, because it hosts base classes
  1184. tests = unittest.TestSuite()
  1185. for modname in (
  1186. # unit tests
  1187. 'qubes.tests.events',
  1188. 'qubes.tests.devices',
  1189. 'qubes.tests.devices_block',
  1190. 'qubes.tests.firewall',
  1191. 'qubes.tests.init',
  1192. 'qubes.tests.vm.init',
  1193. 'qubes.tests.storage',
  1194. 'qubes.tests.storage_file',
  1195. 'qubes.tests.storage_reflink',
  1196. 'qubes.tests.storage_lvm',
  1197. 'qubes.tests.storage_kernels',
  1198. 'qubes.tests.ext',
  1199. 'qubes.tests.vm.qubesvm',
  1200. 'qubes.tests.vm.mix.net',
  1201. 'qubes.tests.vm.adminvm',
  1202. 'qubes.tests.vm.appvm',
  1203. 'qubes.tests.vm.dispvm',
  1204. 'qubes.tests.app',
  1205. 'qubes.tests.tarwriter',
  1206. 'qubes.tests.api',
  1207. 'qubes.tests.api_admin',
  1208. 'qubes.tests.api_misc',
  1209. 'qubes.tests.api_internal',
  1210. 'qubes.tests.rpc_import',
  1211. ):
  1212. tests.addTests(loader.loadTestsFromName(modname))
  1213. tests.addTests(loader.discover(
  1214. os.path.join(os.path.dirname(__file__), 'tools')))
  1215. if not in_dom0:
  1216. return tests
  1217. for modname in (
  1218. 'qrexec.tests',
  1219. 'qrexec.tests.cli',
  1220. 'qrexec.tests.gtkhelpers',
  1221. 'qrexec.tests.rpcconfirmation',
  1222. # integration tests
  1223. 'qubes.tests.integ.basic',
  1224. 'qubes.tests.integ.storage',
  1225. 'qubes.tests.integ.grub',
  1226. 'qubes.tests.integ.devices_block',
  1227. 'qubes.tests.integ.devices_pci',
  1228. 'qubes.tests.integ.dom0_update',
  1229. 'qubes.tests.integ.network',
  1230. 'qubes.tests.integ.dispvm',
  1231. 'qubes.tests.integ.vm_qrexec_gui',
  1232. 'qubes.tests.integ.mime',
  1233. 'qubes.tests.integ.salt',
  1234. 'qubes.tests.integ.backup',
  1235. 'qubes.tests.integ.backupcompatibility',
  1236. # external modules
  1237. 'qubes.tests.extra',
  1238. ):
  1239. tests.addTests(loader.loadTestsFromName(modname))
  1240. return tests