__init__.py 45 KB

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