init.py 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419
  1. # pylint: disable=protected-access,pointless-statement
  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 Wojtek Porczyk <woju@invisiblethingslab.com>
  7. #
  8. # This program is free software; you can redistribute it and/or modify
  9. # it under the terms of the GNU General Public License as published by
  10. # the Free Software Foundation; either version 2 of the License, or
  11. # (at your option) any later version.
  12. #
  13. # This program is distributed in the hope that it will be useful,
  14. # but WITHOUT ANY WARRANTY; without even the implied warranty of
  15. # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  16. # GNU General Public License for more details.
  17. #
  18. # You should have received a copy of the GNU General Public License along
  19. # with this program; if not, write to the Free Software Foundation, Inc.,
  20. # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  21. #
  22. import unittest
  23. import uuid
  24. import lxml.etree
  25. import qubes
  26. import qubes.app
  27. import qubes.events
  28. import qubes.vm
  29. import qubes.tests
  30. class TC_00_Label(qubes.tests.QubesTestCase):
  31. def test_000_constructor(self):
  32. label = qubes.Label(1, '#cc0000', 'red')
  33. self.assertEqual(label.index, 1)
  34. self.assertEqual(label.color, '#cc0000')
  35. self.assertEqual(label.name, 'red')
  36. self.assertEqual(label.icon, 'appvm-red')
  37. self.assertEqual(label.icon_dispvm, 'dispvm-red')
  38. def test_001_fromxml(self):
  39. xml = lxml.etree.XML('''
  40. <qubes version="3">
  41. <labels>
  42. <label id="label-1" color="#cc0000">red</label>
  43. </labels>
  44. </qubes>
  45. ''')
  46. node = xml.xpath('//label')[0]
  47. label = qubes.Label.fromxml(node)
  48. self.assertEqual(label.index, 1)
  49. self.assertEqual(label.color, '#cc0000')
  50. self.assertEqual(label.name, 'red')
  51. self.assertEqual(label.icon, 'appvm-red')
  52. self.assertEqual(label.icon_dispvm, 'dispvm-red')
  53. class TC_10_property(qubes.tests.QubesTestCase):
  54. def setUp(self):
  55. super().setUp()
  56. try:
  57. class MyTestHolder(qubes.tests.TestEmitter, qubes.PropertyHolder):
  58. testprop1 = qubes.property('testprop1')
  59. except: # pylint: disable=bare-except
  60. self.skipTest('MyTestHolder class definition failed')
  61. self.holder = MyTestHolder(None)
  62. def test_000_init(self):
  63. pass
  64. def test_001_hash(self):
  65. hash(self.holder.__class__.testprop1)
  66. def test_002_eq(self):
  67. self.assertEqual(qubes.property('testprop2'),
  68. qubes.property('testprop2'))
  69. def test_010_set(self):
  70. self.holder.testprop1 = 'testvalue'
  71. self.assertEventFired(self.holder, 'property-pre-set:testprop1')
  72. self.assertEventFired(self.holder, 'property-set:testprop1')
  73. def test_020_get(self):
  74. self.holder.testprop1 = 'testvalue'
  75. self.assertEqual(self.holder.testprop1, 'testvalue')
  76. def test_021_get_unset(self):
  77. with self.assertRaises(AttributeError):
  78. self.holder.testprop1
  79. def test_022_get_default(self):
  80. class MyTestHolder(qubes.tests.TestEmitter, qubes.PropertyHolder):
  81. testprop1 = qubes.property('testprop1', default='defaultvalue')
  82. holder = MyTestHolder(None)
  83. self.assertEqual(holder.testprop1, 'defaultvalue')
  84. def test_023_get_default_func(self):
  85. class MyTestHolder(qubes.tests.TestEmitter, qubes.PropertyHolder):
  86. testprop1 = qubes.property('testprop1',
  87. default=(lambda self: 'defaultvalue'))
  88. holder = MyTestHolder(None)
  89. self.assertEqual(holder.testprop1, 'defaultvalue')
  90. holder.testprop1 = 'testvalue'
  91. self.assertEqual(holder.testprop1, 'testvalue')
  92. def test_030_set_setter(self):
  93. def setter(self2, prop, value):
  94. self.assertIs(self2, holder)
  95. self.assertIs(prop, MyTestHolder.testprop1)
  96. self.assertEqual(value, 'testvalue')
  97. return 'settervalue'
  98. class MyTestHolder(qubes.tests.TestEmitter, qubes.PropertyHolder):
  99. testprop1 = qubes.property('testprop1', setter=setter)
  100. holder = MyTestHolder(None)
  101. holder.testprop1 = 'testvalue'
  102. self.assertEqual(holder.testprop1, 'settervalue')
  103. def test_031_set_type(self):
  104. class MyTestHolder(qubes.tests.TestEmitter, qubes.PropertyHolder):
  105. testprop1 = qubes.property('testprop1', type=int)
  106. holder = MyTestHolder(None)
  107. holder.testprop1 = '5'
  108. self.assertEqual(holder.testprop1, 5)
  109. self.assertNotEqual(holder.testprop1, '5')
  110. def test_080_delete(self):
  111. self.holder.testprop1 = 'testvalue'
  112. try:
  113. if self.holder.testprop1 != 'testvalue':
  114. self.skipTest('testprop1 value is wrong')
  115. except AttributeError:
  116. self.skipTest('testprop1 value is wrong')
  117. del self.holder.testprop1
  118. with self.assertRaises(AttributeError):
  119. self.holder.testprop1
  120. def test_081_delete_by_assign(self):
  121. self.holder.testprop1 = 'testvalue'
  122. try:
  123. if self.holder.testprop1 != 'testvalue':
  124. self.skipTest('testprop1 value is wrong')
  125. except AttributeError:
  126. self.skipTest('testprop1 value is wrong')
  127. self.holder.testprop1 = qubes.property.DEFAULT
  128. with self.assertRaises(AttributeError):
  129. self.holder.testprop1
  130. def test_082_delete_default(self):
  131. class MyTestHolder(qubes.tests.TestEmitter, qubes.PropertyHolder):
  132. testprop1 = qubes.property('testprop1', default='defaultvalue')
  133. holder = MyTestHolder(None)
  134. holder.testprop1 = 'testvalue'
  135. try:
  136. if holder.testprop1 != 'testvalue':
  137. self.skipTest('testprop1 value is wrong')
  138. except AttributeError:
  139. self.skipTest('testprop1 value is wrong')
  140. del holder.testprop1
  141. self.assertEqual(holder.testprop1, 'defaultvalue')
  142. def test_090_write_once_set(self):
  143. class MyTestHolder(qubes.tests.TestEmitter, qubes.PropertyHolder):
  144. testprop1 = qubes.property('testprop1', write_once=True)
  145. holder = MyTestHolder(None)
  146. holder.testprop1 = 'testvalue'
  147. with self.assertRaises(AttributeError):
  148. holder.testprop1 = 'testvalue2'
  149. def test_091_write_once_delete(self):
  150. class MyTestHolder(qubes.tests.TestEmitter, qubes.PropertyHolder):
  151. testprop1 = qubes.property('testprop1', write_once=True)
  152. holder = MyTestHolder(None)
  153. holder.testprop1 = 'testvalue'
  154. with self.assertRaises(AttributeError):
  155. del holder.testprop1
  156. class TestHolder(qubes.tests.TestEmitter, qubes.PropertyHolder):
  157. testprop1 = qubes.property('testprop1', order=0)
  158. testprop2 = qubes.property('testprop2', order=1, save_via_ref=True)
  159. testprop3 = qubes.property('testprop3', order=2, default='testdefault')
  160. testprop4 = qubes.property('testprop4', order=3)
  161. class TC_20_PropertyHolder(qubes.tests.QubesTestCase):
  162. def setUp(self):
  163. super().setUp()
  164. xml = lxml.etree.XML('''
  165. <qubes version="3">
  166. <properties>
  167. <property name="testprop1">testvalue1</property>
  168. <property name="testprop2" ref="testref2" />
  169. </properties>
  170. </qubes>
  171. ''')
  172. self.holder = TestHolder(xml)
  173. def test_000_property_list(self):
  174. self.assertListEqual([p.__name__ for p in self.holder.property_list()],
  175. ['testprop1', 'testprop2', 'testprop3', 'testprop4'])
  176. def test_001_property_get_def(self):
  177. self.assertIs(
  178. self.holder.property_get_def('testprop1'), TestHolder.testprop1)
  179. self.assertIs(self.holder.property_get_def(TestHolder.testprop1),
  180. TestHolder.testprop1)
  181. def test_002_load_properties(self):
  182. self.holder.load_properties()
  183. self.assertEventFired(self.holder, 'property-set:testprop1')
  184. self.assertEqual(self.holder.testprop1, 'testvalue1')
  185. self.assertEqual(self.holder.testprop2, 'testref2')
  186. self.assertEqual(self.holder.testprop3, 'testdefault')
  187. with self.assertRaises(AttributeError):
  188. self.holder.testprop4
  189. def test_003_property_is_default(self):
  190. self.holder.load_properties()
  191. self.assertFalse(self.holder.property_is_default('testprop1'))
  192. self.assertFalse(self.holder.property_is_default('testprop2'))
  193. self.assertTrue(self.holder.property_is_default('testprop3'))
  194. self.assertTrue(self.holder.property_is_default('testprop4'))
  195. with self.assertRaises(AttributeError):
  196. self.holder.property_is_default('testprop5')
  197. @unittest.skip('test not implemented')
  198. def test_004_property_init(self):
  199. pass
  200. @unittest.skip('test not implemented')
  201. def test_005_clone_properties(self):
  202. pass
  203. def test_006_xml_properties(self):
  204. self.holder.load_properties()
  205. elements = self.holder.xml_properties()
  206. elements_with_defaults = self.holder.xml_properties(with_defaults=True)
  207. self.assertEqual(len(elements), 2)
  208. self.assertEqual(len(elements_with_defaults), 3)
  209. expected_prop1 = lxml.etree.Element('property', name='testprop1')
  210. expected_prop1.text = 'testvalue1'
  211. self.assertXMLEqual(elements_with_defaults[0], expected_prop1)
  212. expected_prop2 = lxml.etree.Element('property',
  213. name='testprop2', ref='testref2')
  214. self.assertXMLEqual(elements_with_defaults[1], expected_prop2)
  215. expected_prop3 = lxml.etree.Element('property', name='testprop3')
  216. expected_prop3.text = 'testdefault'
  217. self.assertXMLEqual(elements_with_defaults[2], expected_prop3)
  218. @unittest.skip('test not implemented')
  219. def test_010_property_require(self):
  220. pass
  221. class TestVM(qubes.vm.BaseVM):
  222. qid = qubes.property('qid', type=int)
  223. name = qubes.property('name')
  224. netid = qid
  225. uuid = uuid.uuid5(uuid.NAMESPACE_DNS, 'testvm')
  226. def __lt__(self, other):
  227. try:
  228. return self.name < other.name
  229. except AttributeError:
  230. return NotImplemented
  231. class MockLibvirt(object):
  232. def undefine(self):
  233. pass
  234. libvirt_domain = MockLibvirt()
  235. def is_halted(self):
  236. return True
  237. def get_power_state(self):
  238. return "Halted"
  239. class TestApp(qubes.tests.TestEmitter):
  240. pass
  241. class TC_30_VMCollection(qubes.tests.QubesTestCase):
  242. def setUp(self):
  243. super().setUp()
  244. self.app = TestApp()
  245. self.vms = qubes.app.VMCollection(self.app)
  246. self.testvm1 = TestVM(None, None, qid=1, name='testvm1')
  247. self.testvm2 = TestVM(None, None, qid=2, name='testvm2')
  248. def test_000_contains(self):
  249. self.vms._dict = {1: self.testvm1}
  250. self.assertIn(1, self.vms)
  251. self.assertIn('testvm1', self.vms)
  252. self.assertIn(self.testvm1, self.vms)
  253. self.assertNotIn(2, self.vms)
  254. self.assertNotIn('testvm2', self.vms)
  255. self.assertNotIn(self.testvm2, self.vms)
  256. def test_001_getitem(self):
  257. self.vms._dict = {1: self.testvm1}
  258. self.assertIs(self.vms[1], self.testvm1)
  259. self.assertIs(self.vms['testvm1'], self.testvm1)
  260. self.assertIs(self.vms[self.testvm1], self.testvm1)
  261. def test_002_add(self):
  262. self.vms.add(self.testvm1)
  263. self.assertIn(1, self.vms)
  264. self.assertEventFired(self.app, 'domain-add',
  265. kwargs={'vm': self.testvm1})
  266. with self.assertRaises(TypeError):
  267. self.vms.add(object())
  268. testvm_qid_collision = TestVM(None, None, name='testvm2', qid=1)
  269. testvm_name_collision = TestVM(None, None, name='testvm1', qid=2)
  270. with self.assertRaises(ValueError):
  271. self.vms.add(testvm_qid_collision)
  272. with self.assertRaises(ValueError):
  273. self.vms.add(testvm_name_collision)
  274. def test_003_qids(self):
  275. self.vms.add(self.testvm1)
  276. self.vms.add(self.testvm2)
  277. self.assertCountEqual(self.vms.qids(), [1, 2])
  278. self.assertCountEqual(self.vms.keys(), [1, 2])
  279. def test_004_names(self):
  280. self.vms.add(self.testvm1)
  281. self.vms.add(self.testvm2)
  282. self.assertCountEqual(self.vms.names(), ['testvm1', 'testvm2'])
  283. def test_005_vms(self):
  284. self.vms.add(self.testvm1)
  285. self.vms.add(self.testvm2)
  286. self.assertCountEqual(self.vms.vms(), [self.testvm1, self.testvm2])
  287. self.assertCountEqual(self.vms.values(), [self.testvm1, self.testvm2])
  288. def test_006_items(self):
  289. self.vms.add(self.testvm1)
  290. self.vms.add(self.testvm2)
  291. self.assertCountEqual(self.vms.items(),
  292. [(1, self.testvm1), (2, self.testvm2)])
  293. def test_007_len(self):
  294. self.vms.add(self.testvm1)
  295. self.vms.add(self.testvm2)
  296. self.assertEqual(len(self.vms), 2)
  297. def test_008_delitem(self):
  298. self.vms.add(self.testvm1)
  299. self.vms.add(self.testvm2)
  300. del self.vms['testvm2']
  301. self.assertCountEqual(self.vms.vms(), [self.testvm1])
  302. self.assertEventFired(self.app, 'domain-delete',
  303. kwargs={'vm': self.testvm2})
  304. def test_100_get_new_unused_qid(self):
  305. self.vms.add(self.testvm1)
  306. self.vms.add(self.testvm2)
  307. self.vms.get_new_unused_qid()
  308. def test_101_get_new_unused_netid(self):
  309. self.vms.add(self.testvm1)
  310. self.vms.add(self.testvm2)
  311. self.vms.get_new_unused_netid()
  312. # def test_200_get_vms_based_on(self):
  313. # pass
  314. # def test_201_get_vms_connected_to(self):
  315. # pass