test_qube_manager.py 59 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479
  1. #!/usr/bin/python3
  2. #
  3. # The Qubes OS Project, https://www.qubes-os.org/
  4. #
  5. # Copyright (C) 2016 Marta Marczykowska-Górecka
  6. # <marmarta@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 asyncio
  23. import contextlib
  24. import logging.handlers
  25. import unittest
  26. import unittest.mock
  27. import subprocess
  28. import datetime
  29. import time
  30. from PyQt5 import QtTest, QtCore, QtWidgets
  31. from qubesadmin import Qubes, events, exc
  32. import qubesmanager.qube_manager as qube_manager
  33. from qubesmanager.tests import init_qtapp
  34. class QubeManagerTest(unittest.TestCase):
  35. def setUp(self):
  36. super(QubeManagerTest, self).setUp()
  37. self.qtapp, self.loop = init_qtapp()
  38. self.mock_qprogress = unittest.mock.patch(
  39. 'PyQt5.QtWidgets.QProgressDialog')
  40. self.mock_qprogress.start()
  41. self.addCleanup(self.mock_qprogress.stop)
  42. self.qapp = Qubes()
  43. self.dispatcher = events.EventsDispatcher(self.qapp)
  44. self.dialog = qube_manager.VmManagerWindow(
  45. self.qtapp, self.qapp, self.dispatcher)
  46. def test_000_window_loads(self):
  47. self.assertTrue(self.dialog.table is not None, "Window did not load")
  48. def test_001_correct_vms_listed(self):
  49. vms_in_table = []
  50. for row in range(self.dialog.table.rowCount()):
  51. vm = self._get_table_item(row, "Name").vm
  52. self.assertIsNotNone(vm)
  53. vms_in_table.append(vm.name)
  54. # check that name is listed correctly
  55. name_item = self._get_table_item(row, "Name")
  56. self.assertEqual(name_item.text(), vm.name,
  57. "Incorrect VM name for {}".format(vm.name))
  58. actual_vms = [vm.name for vm in self.qapp.domains]
  59. self.assertEqual(len(vms_in_table), len(actual_vms),
  60. "Incorrect number of VMs loaded")
  61. self.assertListEqual(sorted(vms_in_table), sorted(actual_vms),
  62. "Incorrect VMs loaded")
  63. def test_002_correct_template_listed(self):
  64. for row in range(self.dialog.table.rowCount()):
  65. vm = self._get_table_item(row, "Name").vm
  66. # check that template is listed correctly
  67. template_item = self._get_table_item(row, "Template")
  68. if getattr(vm, "template", None):
  69. self.assertEqual(vm.template,
  70. template_item.text(),
  71. "Incorrect template for {}".format(vm.name))
  72. else:
  73. self.assertEqual(vm.klass, template_item.text(),
  74. "Incorrect class for {}".format(vm.name))
  75. def test_003_correct_netvm_listed(self):
  76. for row in range(self.dialog.table.rowCount()):
  77. vm = self._get_table_item(row, "Name").vm
  78. # check that netvm is listed correctly
  79. netvm_item = self._get_table_item(row, "NetVM")
  80. netvm_value = getattr(vm, "netvm", None)
  81. netvm_value = "n/a" if not netvm_value else netvm_value
  82. if netvm_value and hasattr(vm, "netvm") \
  83. and vm.property_is_default("netvm"):
  84. netvm_value = "default ({})".format(netvm_value)
  85. self.assertEqual(netvm_value,
  86. netvm_item.text(),
  87. "Incorrect netvm for {}".format(vm.name))
  88. def test_004_correct_disk_usage_listed(self):
  89. for row in range(self.dialog.table.rowCount()):
  90. vm = self._get_table_item(row, "Name").vm
  91. size_item = self._get_table_item(row, "Size")
  92. if vm.klass == 'AdminVM':
  93. size_value = "n/a"
  94. else:
  95. size_value = round(vm.get_disk_utilization() / (1024 * 1024), 2)
  96. size_value = str(size_value) + " MiB"
  97. self.assertEqual(size_value,
  98. size_item.text(),
  99. "Incorrect size for {}".format(vm.name))
  100. def test_005_correct_internal_listed(self):
  101. for row in range(self.dialog.table.rowCount()):
  102. vm = self._get_table_item(row, "Name").vm
  103. internal_item = self._get_table_item(row, "Internal")
  104. internal_value = "Yes" if vm.features.get('internal', False) else ""
  105. self.assertEqual(internal_item.text(), internal_value,
  106. "Incorrect internal value for {}".format(vm.name))
  107. def test_006_correct_ip_listed(self):
  108. for row in range(self.dialog.table.rowCount()):
  109. vm = self._get_table_item(row, "Name").vm
  110. ip_item = self._get_table_item(row, "IP")
  111. if hasattr(vm, 'ip'):
  112. ip_value = getattr(vm, 'ip')
  113. ip_value = "" if ip_value is None else ip_value
  114. else:
  115. ip_value = "n/a"
  116. self.assertEqual(ip_value, ip_item.text(),
  117. "Incorrect ip value for {}".format(vm.name))
  118. def test_007_incl_in_backups_listed(self):
  119. for row in range(self.dialog.table.rowCount()):
  120. vm = self._get_table_item(row, "Name").vm
  121. incl_backups_item = self._get_table_item(row, "Include in backups")
  122. incl_backups_value = getattr(vm, 'include_in_backups', False)
  123. incl_backups_value = "Yes" if incl_backups_value else ""
  124. self.assertEqual(
  125. incl_backups_value, incl_backups_item.text(),
  126. "Incorrect include in backups value for {}".format(vm.name))
  127. def test_008_last_backup_listed(self):
  128. for row in range(self.dialog.table.rowCount()):
  129. vm = self._get_table_item(row, "Name").vm
  130. last_backup_item = self._get_table_item(row, "Last backup")
  131. last_backup_value = getattr(vm, 'backup_timestamp', None)
  132. if last_backup_value:
  133. last_backup_value = str(
  134. datetime.datetime.fromtimestamp(last_backup_value))
  135. else:
  136. last_backup_value = ""
  137. self.assertEqual(
  138. last_backup_value, last_backup_item.text(),
  139. "Incorrect last backup value for {}".format(vm.name))
  140. def test_009_def_dispvm_listed(self):
  141. for row in range(self.dialog.table.rowCount()):
  142. vm = self._get_table_item(row, "Name").vm
  143. def_dispvm_item = self._get_table_item(row, "Default DispVM")
  144. if vm.property_is_default("default_dispvm"):
  145. def_dispvm_value = "default ({})".format(
  146. self.qapp.default_dispvm)
  147. else:
  148. def_dispvm_value = getattr(vm, "default_dispvm", None)
  149. self.assertEqual(
  150. str(def_dispvm_value), def_dispvm_item.text(),
  151. "Incorrect default dispvm value for {}".format(vm.name))
  152. def test_010_is_dvm_template_listed(self):
  153. for row in range(self.dialog.table.rowCount()):
  154. vm = self._get_table_item(row, "Name").vm
  155. is_dvm_template_item = self._get_table_item(row, "Is DVM Template")
  156. is_dvm_template_value = "Yes" if \
  157. getattr(vm, "template_for_dispvms", False) else ""
  158. self.assertEqual(
  159. is_dvm_template_value, is_dvm_template_item.text(),
  160. "Incorrect is DVM template value for {}".format(vm.name))
  161. def test_011_is_label_correct(self):
  162. for row in range(self.dialog.table.rowCount()):
  163. vm = self._get_table_item(row, "Name").vm
  164. label_item = self._get_table_item(row, "Label")
  165. self.assertEqual(label_item.icon_path, vm.label.icon)
  166. def test_012_is_state_correct(self):
  167. for row in range(self.dialog.table.rowCount()):
  168. vm = self._get_table_item(row, "Name").vm
  169. state_item = self._get_table_item(row, "State")
  170. # this should not be done like that in table_widgets
  171. displayed_power_state = state_item.on_icon.status
  172. if vm.is_running():
  173. correct_power_state = 3
  174. else:
  175. correct_power_state = 0
  176. self.assertEqual(
  177. displayed_power_state, correct_power_state,
  178. "Wrong power state displayed for {}".format(vm.name))
  179. def test_013_incorrect_settings_file(self):
  180. mock_settings = unittest.mock.MagicMock(spec=QtCore.QSettings)
  181. settings_result_dict = {"view/sort_column": "Cthulhu",
  182. "view/sort_order": "Fhtagn",
  183. "view/menubar_visible": "R'lyeh"
  184. }
  185. mock_settings.side_effect = (
  186. lambda x, *args, **kwargs: settings_result_dict.get(x))
  187. with unittest.mock.patch('PyQt5.QtCore.QSettings.value',
  188. mock_settings),\
  189. unittest.mock.patch('PyQt5.QtWidgets.QMessageBox.warning')\
  190. as mock_warning:
  191. self.dialog = qube_manager.VmManagerWindow(
  192. self.qtapp, self.qapp, self.dispatcher)
  193. self.assertEqual(mock_warning.call_count, 1)
  194. def test_100_sorting(self):
  195. self.dialog.table.sortByColumn(self.dialog.columns_indices["Template"],
  196. QtCore.Qt.AscendingOrder)
  197. self.__check_sorting("Template")
  198. self.dialog.table.sortByColumn(self.dialog.columns_indices["Name"],
  199. QtCore.Qt.AscendingOrder)
  200. self.__check_sorting("Name")
  201. @unittest.mock.patch('qubesmanager.qube_manager.QtCore.QSettings.setValue')
  202. @unittest.mock.patch('qubesmanager.qube_manager.QtCore.QSettings.sync')
  203. def test_101_hide_column(self, mock_sync, mock_settings):
  204. self.dialog.action_is_dvm_template.trigger()
  205. mock_settings.assert_called_with('columns/Is DVM Template', False)
  206. self.assertEqual(mock_sync.call_count, 1, "Hidden column not synced")
  207. self.dialog.action_is_dvm_template.trigger()
  208. mock_settings.assert_called_with('columns/Is DVM Template', True)
  209. self.assertEqual(mock_sync.call_count, 2, "Hidden column not synced")
  210. @unittest.mock.patch('qubesmanager.settings.VMSettingsWindow')
  211. def test_200_vm_open_settings(self, mock_window):
  212. selected_vm = self._select_non_admin_vm()
  213. self.assertIsNotNone(selected_vm, "No valid non-admin VM found")
  214. widget = self.dialog.toolbar.widgetForAction(
  215. self.dialog.action_settings)
  216. QtTest.QTest.mouseClick(widget,
  217. QtCore.Qt.LeftButton)
  218. mock_window.assert_called_once_with(
  219. selected_vm, qapp=self.qtapp, init_page="basic", qubesapp=self.qapp)
  220. def test_201_vm_open_settings_admin(self):
  221. self._select_admin_vm()
  222. self.assertFalse(self.dialog.action_settings.isEnabled(),
  223. "Settings not disabled for admin VM")
  224. self.assertFalse(self.dialog.action_editfwrules.isEnabled(),
  225. "Settings not disabled for admin VM")
  226. self.assertFalse(self.dialog.action_appmenus.isEnabled(),
  227. "Settings not disabled for admin VM")
  228. @unittest.mock.patch('qubesmanager.settings.VMSettingsWindow')
  229. def test_202_vm_open_firewall(self, mock_window):
  230. selected_vm = self._select_non_admin_vm()
  231. self.assertIsNotNone(selected_vm, "No valid non-admin VM found")
  232. widget = self.dialog.toolbar.widgetForAction(
  233. self.dialog.action_editfwrules)
  234. QtTest.QTest.mouseClick(widget,
  235. QtCore.Qt.LeftButton)
  236. mock_window.assert_called_once_with(
  237. selected_vm, qapp=self.qtapp, init_page="firewall",
  238. qubesapp=self.qapp)
  239. @unittest.mock.patch('qubesmanager.settings.VMSettingsWindow')
  240. def test_203_vm_open_apps(self, mock_window):
  241. selected_vm = self._select_non_admin_vm()
  242. self.assertIsNotNone(selected_vm, "No valid non-admin VM found")
  243. widget = self.dialog.toolbar.widgetForAction(
  244. self.dialog.action_appmenus)
  245. QtTest.QTest.mouseClick(widget,
  246. QtCore.Qt.LeftButton)
  247. mock_window.assert_called_once_with(
  248. selected_vm, qapp=self.qtapp, init_page="applications",
  249. qubesapp=self.qapp)
  250. def test_204_vm_keyboard(self):
  251. selected_vm = self._select_non_admin_vm(running=True)
  252. self.assertIsNotNone(selected_vm, "No valid non-admin VM found")
  253. widget = self.dialog.toolbar.widgetForAction(
  254. self.dialog.action_set_keyboard_layout)
  255. with unittest.mock.patch.object(selected_vm, 'run') as mock_run:
  256. QtTest.QTest.mouseClick(widget,
  257. QtCore.Qt.LeftButton)
  258. mock_run.assert_called_once_with("qubes-change-keyboard-layout")
  259. def test_205_vm_keyboard_not_running(self):
  260. selected_vm = self._select_non_admin_vm(running=False)
  261. self.assertIsNotNone(selected_vm, "No valid non-admin VM found")
  262. widget = self.dialog.toolbar.widgetForAction(
  263. self.dialog.action_set_keyboard_layout)
  264. with unittest.mock.patch.object(selected_vm, 'run') as mock_run:
  265. QtTest.QTest.mouseClick(widget,
  266. QtCore.Qt.LeftButton)
  267. self.assertEqual(mock_run.call_count, 0,
  268. "Keyboard change called on a halted VM")
  269. def test_206_dom0_keyboard(self):
  270. self._select_admin_vm()
  271. self.assertFalse(self.dialog.action_set_keyboard_layout.isEnabled())
  272. @unittest.mock.patch("PyQt5.QtWidgets.QMessageBox.question",
  273. return_value=QtWidgets.QMessageBox.Yes)
  274. def test_207_update_vm_not_running(self, _):
  275. selected_vm = self._select_templatevm(running=False)
  276. self.assertIsNotNone(selected_vm, "No valid template VM found")
  277. widget = self.dialog.toolbar.widgetForAction(
  278. self.dialog.action_updatevm)
  279. with unittest.mock.patch('qubesmanager.qube_manager.UpdateVMThread') \
  280. as mock_update:
  281. QtTest.QTest.mouseClick(widget,
  282. QtCore.Qt.LeftButton)
  283. mock_update.assert_called_once_with(selected_vm)
  284. mock_update().start.assert_called_once_with()
  285. def test_208_update_vm_admin(self):
  286. selected_vm = self._select_admin_vm()
  287. self.assertIsNotNone(selected_vm, "No valid admin VM found")
  288. widget = self.dialog.toolbar.widgetForAction(
  289. self.dialog.action_updatevm)
  290. with unittest.mock.patch('qubesmanager.qube_manager.UpdateVMThread') \
  291. as mock_update:
  292. QtTest.QTest.mouseClick(widget,
  293. QtCore.Qt.LeftButton)
  294. mock_update.assert_called_once_with(selected_vm)
  295. mock_update().start.assert_called_once_with()
  296. @unittest.mock.patch("PyQt5.QtWidgets.QInputDialog.getText",
  297. return_value=("command to run", True))
  298. def test_209_run_command_in_vm(self, _):
  299. selected_vm = self._select_non_admin_vm()
  300. self.assertIsNotNone(selected_vm, "No valid non-admin VM found")
  301. with unittest.mock.patch('qubesmanager.qube_manager.RunCommandThread') \
  302. as mock_thread:
  303. self.dialog.action_run_command_in_vm.trigger()
  304. mock_thread.assert_called_once_with(selected_vm, "command to run")
  305. mock_thread().finished.connect.assert_called_once_with(
  306. self.dialog.clear_threads)
  307. mock_thread().start.assert_called_once_with()
  308. def test_210_run_command_in_adminvm(self):
  309. self._select_admin_vm()
  310. self.assertFalse(self.dialog.action_run_command_in_vm.isEnabled(),
  311. "Should not be able to run commands for dom0")
  312. @unittest.mock.patch("PyQt5.QtWidgets.QMessageBox.warning")
  313. def test_211_pausevm(self, mock_warn):
  314. selected_vm = self._select_non_admin_vm(running=True)
  315. self.assertTrue(self.dialog.action_pausevm.isEnabled(),
  316. "Pause not enabled for a running VM")
  317. with unittest.mock.patch.object(selected_vm, 'pause') as mock_pause:
  318. self.dialog.action_pausevm.trigger()
  319. mock_pause.assert_called_once_with()
  320. mock_pause.side_effect = exc.QubesException('Error')
  321. self.dialog.action_pausevm.trigger()
  322. self.assertEqual(mock_warn.call_count, 1)
  323. def test_212_resumevm(self):
  324. selected_vm = self._select_non_admin_vm(running=False)
  325. with unittest.mock.patch.object(selected_vm, 'get_power_state')\
  326. as mock_state, \
  327. unittest.mock.patch.object(selected_vm, 'unpause')\
  328. as mock_unpause:
  329. mock_state.return_value = 'Paused'
  330. self.dialog.action_resumevm.trigger()
  331. mock_unpause.assert_called_once_with()
  332. with unittest.mock.patch('qubesmanager.qube_manager.StartVMThread') \
  333. as mock_thread:
  334. self.dialog.action_resumevm.trigger()
  335. mock_thread.assert_called_once_with(selected_vm)
  336. mock_thread().finished.connect.assert_called_once_with(
  337. self.dialog.clear_threads)
  338. mock_thread().start.assert_called_once_with()
  339. def test_213_resume_running_vm(self):
  340. self._select_non_admin_vm(running=True)
  341. self.assertFalse(self.dialog.action_resumevm.isEnabled())
  342. @unittest.mock.patch("PyQt5.QtWidgets.QMessageBox.question",
  343. return_value=QtWidgets.QMessageBox.Yes)
  344. @unittest.mock.patch('PyQt5.QtCore.QTimer.singleShot')
  345. @unittest.mock.patch('qubesmanager.qube_manager.VmShutdownMonitor')
  346. def test_214_shutdownvm(self, mock_monitor, mock_timer, _):
  347. selected_vm = self._select_non_admin_vm(running=True)
  348. with unittest.mock.patch.object(selected_vm, 'shutdown')\
  349. as mock_shutdown:
  350. self.dialog.action_shutdownvm.trigger()
  351. mock_shutdown.assert_called_once_with()
  352. mock_monitor.assert_called_once_with(
  353. selected_vm,
  354. unittest.mock.ANY, unittest.mock.ANY,
  355. unittest.mock.ANY, unittest.mock.ANY)
  356. mock_timer.assert_called_once_with(unittest.mock.ANY,
  357. unittest.mock.ANY)
  358. def test_215_shutdown_halted_vm(self):
  359. self._select_non_admin_vm(running=False)
  360. self.assertFalse(self.dialog.action_shutdownvm.isEnabled())
  361. @unittest.mock.patch('qubesmanager.create_new_vm.NewVmDlg')
  362. def test_216_create_vm(self, mock_new_vm):
  363. action = self.dialog.action_createvm
  364. self.assertTrue(action.isEnabled())
  365. action.trigger()
  366. self.assertEqual(mock_new_vm.call_count, 1,
  367. "Create New VM window did not appear")
  368. def test_217_remove_admin_vm(self):
  369. self._select_admin_vm()
  370. self.assertFalse(self.dialog.action_removevm.isEnabled())
  371. @unittest.mock.patch("PyQt5.QtWidgets.QMessageBox")
  372. @unittest.mock.patch('qubesadmin.utils.vm_dependencies')
  373. def test_218_remove_vm_dependencies(self, mock_dependencies, mock_msgbox):
  374. action = self.dialog.action_removevm
  375. mock_vm = unittest.mock.Mock(spec=['name'],
  376. **{'name.return_value': 'test-vm'})
  377. mock_dependencies.return_value = [(mock_vm, "test_prop")]
  378. action.trigger()
  379. mock_msgbox().show.assert_called_with()
  380. @unittest.mock.patch('PyQt5.QtWidgets.QMessageBox.warning')
  381. @unittest.mock.patch("PyQt5.QtWidgets.QInputDialog.getText")
  382. @unittest.mock.patch('qubesadmin.utils.vm_dependencies')
  383. def test_219_remove_vm_no_depencies(
  384. self, mock_dependencies, mock_input, mock_warning):
  385. action = self.dialog.action_removevm
  386. selected_vm = self._select_non_admin_vm(running=False)
  387. # test with no dependencies
  388. mock_dependencies.return_value = None
  389. with unittest.mock.patch('qubesmanager.common_threads.RemoveVMThread')\
  390. as mock_thread:
  391. mock_input.return_value = (selected_vm.name, False)
  392. action.trigger()
  393. self.assertEqual(mock_thread.call_count, 0,
  394. "VM removed despite user clicking 'cancel")
  395. mock_input.return_value = ("wrong_name", True)
  396. action.trigger()
  397. self.assertEqual(mock_warning.call_count, 1)
  398. self.assertEqual(mock_thread.call_count, 0,
  399. "VM removed despite user not confirming the name")
  400. mock_input.return_value = (selected_vm.name, True)
  401. action.trigger()
  402. mock_thread.assert_called_once_with(selected_vm)
  403. mock_thread().finished.connect.assert_called_once_with(
  404. self.dialog.clear_threads)
  405. mock_thread().start.assert_called_once_with()
  406. def test_220_restartvm_halted_vm(self):
  407. self._select_non_admin_vm(running=False)
  408. self.assertFalse(self.dialog.action_restartvm.isEnabled())
  409. @unittest.mock.patch('PyQt5.QtCore.QTimer.singleShot')
  410. @unittest.mock.patch('qubesmanager.qube_manager.VmShutdownMonitor')
  411. @unittest.mock.patch("PyQt5.QtWidgets.QMessageBox.question",
  412. return_value=QtWidgets.QMessageBox.Yes)
  413. def test_221_restartvm_running_vm(self, _msgbox, mock_monitor, _qtimer):
  414. selected_vm = self._select_non_admin_vm(running=True)
  415. action = self.dialog.action_restartvm
  416. # currently the VM is running
  417. with unittest.mock.patch.object(selected_vm, 'shutdown')\
  418. as mock_shutdown:
  419. action.trigger()
  420. mock_shutdown.assert_called_once_with()
  421. mock_monitor.assert_called_once_with(
  422. selected_vm, unittest.mock.ANY,
  423. unittest.mock.ANY, True, unittest.mock.ANY)
  424. @unittest.mock.patch('qubesmanager.qube_manager.StartVMThread')
  425. @unittest.mock.patch("PyQt5.QtWidgets.QMessageBox.question",
  426. return_value=QtWidgets.QMessageBox.Yes)
  427. def test_222_restartvm_shutdown_meantime(self, _, mock_thread):
  428. selected_vm = self._select_non_admin_vm(running=True)
  429. action = self.dialog.action_restartvm
  430. # it was shutdown in the meantime
  431. with unittest.mock.patch.object(
  432. selected_vm, 'is_running', **{'return_value': False}):
  433. action.trigger()
  434. mock_thread.assert_called_once_with(selected_vm)
  435. mock_thread().finished.connect.assert_called_once_with(
  436. self.dialog.clear_threads)
  437. mock_thread().start.assert_called_once_with()
  438. @unittest.mock.patch('qubesmanager.qube_manager.UpdateVMThread')
  439. def test_223_updatevm_running(self, mock_thread):
  440. selected_vm = self._select_non_admin_vm(running=True)
  441. self.dialog.action_updatevm.trigger()
  442. mock_thread.assert_called_once_with(selected_vm)
  443. mock_thread().finished.connect.assert_called_once_with(
  444. self.dialog.clear_threads)
  445. mock_thread().start.assert_called_once_with()
  446. @unittest.mock.patch("PyQt5.QtWidgets.QMessageBox.question",
  447. return_value=QtWidgets.QMessageBox.Yes)
  448. @unittest.mock.patch('qubesmanager.qube_manager.UpdateVMThread')
  449. def test_224_updatevm_halted(self, mock_thread, _):
  450. selected_vm = self._select_non_admin_vm(running=False)
  451. self.dialog.action_updatevm.trigger()
  452. mock_thread.assert_called_once_with(selected_vm)
  453. mock_thread().finished.connect.assert_called_once_with(
  454. self.dialog.clear_threads)
  455. mock_thread().start.assert_called_once_with()
  456. @unittest.mock.patch("PyQt5.QtWidgets.QMessageBox.question",
  457. return_value=QtWidgets.QMessageBox.Yes)
  458. def test_224_killvm(self, _):
  459. selected_vm = self._select_non_admin_vm(running=True)
  460. action = self.dialog.action_killvm
  461. with unittest.mock.patch.object(selected_vm, 'kill') as mock_kill:
  462. action.trigger()
  463. mock_kill.assert_called_once_with()
  464. @unittest.mock.patch("PyQt5.QtWidgets.QMessageBox.question",
  465. return_value=QtWidgets.QMessageBox.Cancel)
  466. def test_225_killvm_cancel(self, _):
  467. selected_vm = self._select_non_admin_vm(running=True)
  468. action = self.dialog.action_killvm
  469. with unittest.mock.patch.object(selected_vm, 'kill') as mock_kill:
  470. action.trigger()
  471. self.assertEqual(mock_kill.call_count, 0,
  472. "Ignored Cancel on kill VM")
  473. @unittest.mock.patch('qubesmanager.global_settings.GlobalSettingsWindow')
  474. def test_226_global_settings(self, mock_settings):
  475. self._select_non_admin_vm()
  476. self.dialog.action_global_settings.trigger()
  477. self.assertEqual(mock_settings.call_count, 1,
  478. "Global Settings not opened")
  479. self._select_admin_vm()
  480. self.dialog.action_global_settings.trigger()
  481. self.assertEqual(mock_settings.call_count, 2,
  482. "Global Settings not opened for the second time")
  483. @unittest.mock.patch('qubesmanager.backup.BackupVMsWindow')
  484. def test_227_backup(self, mock_backup):
  485. self.dialog.action_backup.trigger()
  486. self.assertTrue(self.dialog.action_backup.isEnabled())
  487. self.assertEqual(mock_backup.call_count, 1,
  488. "Backup window does not appear")
  489. @unittest.mock.patch('qubesmanager.restore.RestoreVMsWindow')
  490. def test_228_restore(self, mock_restore):
  491. self.dialog.action_restore.trigger()
  492. self.assertTrue(self.dialog.action_restore.isEnabled())
  493. self.assertEqual(mock_restore.call_count, 1,
  494. "Backup window does not appear")
  495. @unittest.mock.patch('qubesmanager.qube_manager.AboutDialog')
  496. def test_229_about_qubes(self, mock_about):
  497. self.assertTrue(self.dialog.action_about_qubes.isEnabled())
  498. self.dialog.action_about_qubes.trigger()
  499. self.assertEqual(
  500. mock_about.call_count, 1, "About window does not appear")
  501. def test_230_exit_action(self):
  502. self.assertTrue(self.dialog.action_exit.isEnabled())
  503. with unittest.mock.patch.object(self.dialog, 'close') as mock_close:
  504. self.dialog.action_exit.trigger()
  505. mock_close.assert_called_once_with()
  506. @unittest.mock.patch('subprocess.check_call')
  507. def test_231_template_manager(self, mock_subprocess):
  508. self.assertTrue(self.dialog.action_manage_templates.isEnabled())
  509. self.dialog.action_manage_templates.trigger()
  510. mock_subprocess.assert_called_once_with('qubes-template-manager')
  511. @unittest.mock.patch('qubesmanager.common_threads.CloneVMThread')
  512. @unittest.mock.patch('PyQt5.QtWidgets.QInputDialog.getText')
  513. def test_232_clonevm(self, mock_input, mock_thread):
  514. action = self.dialog.action_clonevm
  515. self._select_admin_vm()
  516. self.assertFalse(action.isEnabled())
  517. selected_vm = self._select_non_admin_vm()
  518. self.assertTrue(action.isEnabled())
  519. mock_input.return_value = (selected_vm.name + "clone1", False)
  520. action.trigger()
  521. self.assertEqual(mock_thread.call_count, 0,
  522. "Ignores cancelling clone VM")
  523. mock_input.return_value = (selected_vm.name + "clone1", True)
  524. action.trigger()
  525. mock_thread.assert_called_once_with(selected_vm,
  526. selected_vm.name + "clone1")
  527. mock_thread().finished.connect.assert_called_once_with(
  528. self.dialog.clear_threads)
  529. mock_thread().start.assert_called_once_with()
  530. def test_233_search_action(self):
  531. self.qtapp.setActiveWindow(self.dialog.searchbox)
  532. self.dialog.action_search.trigger()
  533. self.assertTrue(self.dialog.searchbox.hasFocus())
  534. # input text
  535. self.dialog.searchbox.setText("sys")
  536. # click outside the widget
  537. QtTest.QTest.mouseClick(self.dialog.table, QtCore.Qt.LeftButton)
  538. # click the widget, check if it is correctly activated and the whole
  539. # text was selected
  540. QtTest.QTest.mouseClick(self.dialog.searchbox, QtCore.Qt.LeftButton)
  541. self.assertTrue(self.dialog.searchbox.hasFocus())
  542. self.assertEqual(self.dialog.searchbox.selectedText(), "sys")
  543. def test_234_searchbox(self):
  544. # look for sys
  545. self.dialog.searchbox.setText("sys")
  546. expected_number = \
  547. len([vm for vm in self.qapp.domains if "sys" in vm.name])
  548. actual_number = self._count_visible_table_rows()
  549. self.assertEqual(expected_number, actual_number,
  550. "Incorrect number of vms shown for 'sys'")
  551. # clear search
  552. self.dialog.searchbox.setText("")
  553. expected_number = len([vm for vm in self.qapp.domains])
  554. actual_number = self._count_visible_table_rows()
  555. self.assertEqual(expected_number, actual_number,
  556. "Incorrect number of vms shown for cleared search box")
  557. def test_235_hide_show_toolbars(self):
  558. with unittest.mock.patch('PyQt5.QtCore.QSettings.setValue')\
  559. as mock_setvalue:
  560. self.dialog.action_menubar.trigger()
  561. mock_setvalue.assert_called_with('view/menubar_visible', False)
  562. self.dialog.action_toolbar.trigger()
  563. mock_setvalue.assert_called_with('view/toolbar_visible', False)
  564. self.assertFalse(self.dialog.menubar.isVisible(),
  565. "Menubar not hidden correctly")
  566. self.assertFalse(self.dialog.toolbar.isVisible(),
  567. "Toolbar not hidden correctly")
  568. def test_236_clear_searchbox(self):
  569. self.dialog.searchbox.setText("text")
  570. self.assertEqual(self.dialog.searchbox.text(), "text")
  571. QtTest.QTest.keyPress(self.dialog, QtCore.Qt.Key_Escape)
  572. self.assertEqual(self.dialog.searchbox.text(), "",
  573. "Escape failed to clear searchbox")
  574. expected_number = len([vm for vm in self.qapp.domains])
  575. actual_number = self._count_visible_table_rows()
  576. self.assertEqual(expected_number, actual_number,
  577. "Incorrect number of vms shown for cleared search box")
  578. @unittest.mock.patch('PyQt5.QtWidgets.QMessageBox.information')
  579. @unittest.mock.patch('PyQt5.QtWidgets.QMessageBox.warning')
  580. def test_300_clear_threads(self, mock_warning, mock_info):
  581. mock_thread_finished_ok = unittest.mock.Mock(
  582. spec=['isFinished', 'msg', 'msg_is_success'],
  583. msg=None, msg_is_success=False,
  584. **{'isFinished.return_value': True})
  585. mock_thread_not_finished = unittest.mock.Mock(
  586. spec=['isFinished', 'msg', 'msg_is_success'],
  587. msg=None, msg_is_success=False,
  588. **{'isFinished.return_value': False})
  589. mock_thread_finished_error = unittest.mock.Mock(
  590. spec=['isFinished', 'msg', 'msg_is_success'],
  591. msg=("Error", "Error"), msg_is_success=False,
  592. **{'isFinished.return_value': True})
  593. mock_thread_fin_error_success = unittest.mock.Mock(
  594. spec=['isFinished', 'msg', 'msg_is_success'],
  595. msg=("Done", "Done"), msg_is_success=True,
  596. **{'isFinished.return_value': True})
  597. # single finished thread
  598. self.dialog.threads_list = [mock_thread_not_finished,
  599. mock_thread_finished_ok]
  600. self.dialog.clear_threads()
  601. self.assertEqual(mock_warning.call_count, 0)
  602. self.assertEqual(mock_info.call_count, 0)
  603. self.assertEqual(len(self.dialog.threads_list), 1)
  604. # an error thread and some in-progress ones
  605. self.dialog.threads_list = [mock_thread_not_finished,
  606. mock_thread_not_finished,
  607. mock_thread_finished_error]
  608. self.dialog.clear_threads()
  609. self.assertEqual(mock_warning.call_count, 1)
  610. self.assertEqual(mock_info.call_count, 0)
  611. self.assertEqual(len(self.dialog.threads_list), 2)
  612. # an error-success thread and some in-progress ones
  613. self.dialog.threads_list = [mock_thread_not_finished,
  614. mock_thread_not_finished,
  615. mock_thread_fin_error_success,
  616. mock_thread_finished_error]
  617. self.dialog.clear_threads()
  618. self.assertEqual(mock_warning.call_count, 1)
  619. self.assertEqual(mock_info.call_count, 1)
  620. self.assertEqual(len(self.dialog.threads_list), 3)
  621. def test_400_event_domain_added(self):
  622. number_of_vms = self.dialog.table.rowCount()
  623. self.addCleanup(subprocess.call, ["qvm-remove", "-f", "test-vm"])
  624. self._run_command_and_process_events(
  625. ["qvm-create", "--label", "red", "test-vm"])
  626. # a single row was added to the table
  627. self.assertEqual(self.dialog.table.rowCount(), number_of_vms + 1)
  628. # table contains the correct vms
  629. vms_in_table = self._create_set_of_current_vms()
  630. vms_in_system = set([vm.name for vm in self.qapp.domains])
  631. self.assertEqual(vms_in_table, vms_in_system, "Table not updated "
  632. "correctly after add")
  633. # check if sorting works
  634. self.dialog.table.sortItems(self.dialog.columns_indices["Name"],
  635. QtCore.Qt.AscendingOrder)
  636. self.__check_sorting("Name")
  637. # try opening settings for the added vm
  638. for row in range(self.dialog.table.rowCount()):
  639. name = self._get_table_item(row, "Name")
  640. if name.text() == "test-vm":
  641. self.dialog.table.setCurrentItem(name)
  642. break
  643. with unittest.mock.patch('qubesmanager.settings.VMSettingsWindow')\
  644. as mock_settings:
  645. self.dialog.action_settings.trigger()
  646. mock_settings.assert_called_once_with(
  647. self.qapp.domains["test-vm"], qapp = self.qtapp,
  648. init_page = "basic", qubesapp = self.qapp)
  649. def test_401_event_domain_removed(self):
  650. initial_vms = self._create_set_of_current_vms()
  651. self._run_command_and_process_events(
  652. ["qvm-create", "--label", "red", "test-vm"])
  653. current_vms = self._create_set_of_current_vms()
  654. self.assertEqual(len(initial_vms) + 1, len(current_vms))
  655. self._run_command_and_process_events(
  656. ["qvm-remove", "--force", "test-vm"])
  657. current_vms = self._create_set_of_current_vms()
  658. self.assertEqual(initial_vms, current_vms)
  659. # check if sorting works
  660. self.dialog.table.sortItems(self.dialog.columns_indices["Name"],
  661. QtCore.Qt.AscendingOrder)
  662. self.__check_sorting("Name")
  663. def test_403_event_dispvm_added(self):
  664. initial_vms = self._create_set_of_current_vms()
  665. dispvm_template = None
  666. for vm in self.qapp.domains:
  667. if getattr(vm, "template_for_dispvms", False):
  668. dispvm_template = vm.name
  669. break
  670. self.assertIsNotNone(dispvm_template,
  671. "Cannot find a template for dispVMs")
  672. # this requires very long timeout, because it takes time for the
  673. # dispvm to vanish
  674. self._run_command_and_process_events(
  675. ["qvm-run", "--dispvm", dispvm_template, "true"], timeout=60)
  676. final_vms = self._create_set_of_current_vms()
  677. self.assertEqual(initial_vms, final_vms,
  678. "Failed handling of a created-and-removed dispvm")
  679. def test_404_crashing_dispvm(self):
  680. initial_vms = self._create_set_of_current_vms()
  681. dispvm_template = None
  682. for vm in self.qapp.domains:
  683. if getattr(vm, "template_for_dispvms", False):
  684. dispvm_template = vm.name
  685. break
  686. self.assertIsNotNone(dispvm_template,
  687. "Cannot find a template for dispVMs")
  688. current_memory = getattr(self.qapp.domains[dispvm_template], "memory")
  689. self.addCleanup(
  690. subprocess.call,
  691. ["qvm-prefs", dispvm_template, "memory", str(current_memory)])
  692. subprocess.check_call(
  693. ["qvm-prefs", dispvm_template, "memory", "600000"])
  694. self._run_command_and_process_events(
  695. ["qvm-run", "--dispvm", dispvm_template, "true"], timeout=30)
  696. final_vms = self._create_set_of_current_vms()
  697. self.assertEqual(initial_vms, final_vms,
  698. "Failed handling of dispvm that crashed on start")
  699. def test_405_prop_change_label(self):
  700. target_vm_name = "work"
  701. vm_row = self._find_vm_row(target_vm_name)
  702. current_label_path = self._get_table_item(vm_row, "Label").icon_path
  703. self.addCleanup(
  704. subprocess.call, ["qvm-prefs", target_vm_name, "label", "blue"])
  705. self._run_command_and_process_events(
  706. ["qvm-prefs", target_vm_name, "label", "red"])
  707. new_label_path = self._get_table_item(vm_row, "Label").icon_path
  708. self.assertNotEqual(current_label_path, new_label_path,
  709. "Label path did not change")
  710. self.assertEqual(
  711. new_label_path,
  712. self.qapp.domains[target_vm_name].label.icon,
  713. "Incorrect label")
  714. def test_406_prop_change_template(self):
  715. target_vm_name = "work"
  716. vm_row = self._find_vm_row(target_vm_name)
  717. old_template = self._get_table_item(vm_row, "Template").text()
  718. new_template = None
  719. for vm in self.qapp.domains:
  720. if vm.klass == 'TemplateVM' and vm.name != old_template:
  721. new_template = vm.name
  722. break
  723. self.addCleanup(
  724. subprocess.call,
  725. ["qvm-prefs", target_vm_name, "template", old_template])
  726. self._run_command_and_process_events(
  727. ["qvm-prefs", target_vm_name, "template", new_template])
  728. self.assertNotEqual(old_template,
  729. self._get_table_item(vm_row, "Template").text(),
  730. "Template did not change")
  731. self.assertEqual(
  732. self._get_table_item(vm_row, "Template").text(),
  733. self.qapp.domains[target_vm_name].template.name,
  734. "Incorrect template")
  735. def test_407_prop_change_netvm(self):
  736. target_vm_name = "work"
  737. vm_row = self._find_vm_row(target_vm_name)
  738. old_netvm = self._get_table_item(vm_row, "NetVM").text()
  739. new_netvm = None
  740. for vm in self.qapp.domains:
  741. if getattr(vm, "provides_network", False) and vm.name != old_netvm:
  742. new_netvm = vm.name
  743. break
  744. self.addCleanup(
  745. subprocess.call, ["qvm-prefs", target_vm_name, "netvm", old_netvm])
  746. self._run_command_and_process_events(
  747. ["qvm-prefs", target_vm_name, "netvm", new_netvm])
  748. self.assertNotEqual(old_netvm,
  749. self._get_table_item(vm_row, "NetVM").text(),
  750. "NetVM did not change")
  751. self.assertEqual(
  752. self._get_table_item(vm_row, "NetVM").text(),
  753. self.qapp.domains[target_vm_name].netvm.name,
  754. "Incorrect NetVM")
  755. @unittest.expectedFailure
  756. def test_408_prop_change_internal(self):
  757. target_vm_name = "work"
  758. vm_row = self._find_vm_row(target_vm_name)
  759. self.addCleanup(subprocess.call,
  760. ["qvm-features", "--unset", "work", "interal"])
  761. self._run_command_and_process_events(
  762. ["qvm-features", "work", "interal", "1"])
  763. self.assertEqual(
  764. self._get_table_item(vm_row, "Internal").text(),
  765. "Yes",
  766. "Incorrect value for internal VM")
  767. self._run_command_and_process_events(
  768. ["qvm-features", "--unset", "work", "interal"])
  769. self.assertEqual(
  770. self._get_table_item(vm_row, "Internal").text(),
  771. "",
  772. "Incorrect value for non-internal VM")
  773. def test_409_prop_change_ip(self):
  774. target_vm_name = "work"
  775. vm_row = self._find_vm_row(target_vm_name)
  776. old_ip = self._get_table_item(vm_row, "IP").text()
  777. new_ip = old_ip.replace(".0.", ".5.")
  778. self.addCleanup(
  779. subprocess.call, ["qvm-prefs", target_vm_name, "ip", old_ip])
  780. self._run_command_and_process_events(
  781. ["qvm-prefs", target_vm_name, "ip", new_ip])
  782. self.assertNotEqual(old_ip,
  783. self._get_table_item(vm_row, "IP").text(),
  784. "IP did not change")
  785. self.assertEqual(
  786. self._get_table_item(vm_row, "IP").text(),
  787. self.qapp.domains[target_vm_name].ip,
  788. "Incorrect IP")
  789. def test_410_prop_change_in_backups(self):
  790. target_vm_name = "work"
  791. vm_row = self._find_vm_row(target_vm_name)
  792. old_value = self.qapp.domains[target_vm_name].include_in_backups
  793. new_value = not old_value
  794. self.addCleanup(
  795. subprocess.call,
  796. ["qvm-prefs", target_vm_name, "include_in_backups", str(old_value)])
  797. self._run_command_and_process_events(
  798. ["qvm-prefs", target_vm_name, "include_in_backups", str(new_value)])
  799. self.assertEqual(
  800. self._get_table_item(vm_row, "Internal").text(),
  801. "Yes" if new_value else "",
  802. "Incorrect value for include_in_backups")
  803. def test_411_prop_change_last_backup(self):
  804. target_vm_name = "work"
  805. target_timestamp = "2015-01-01 17:00:00"
  806. vm_row = self._find_vm_row(target_vm_name)
  807. old_value = self._get_table_item(vm_row, "Last backup").text()
  808. new_value = datetime.datetime.strptime(
  809. target_timestamp, "%Y-%m-%d %H:%M:%S")
  810. self.addCleanup(
  811. subprocess.call,
  812. ["qvm-prefs", '-D', target_vm_name, "backup_timestamp"])
  813. self._run_command_and_process_events(
  814. ["qvm-prefs", target_vm_name, "backup_timestamp",
  815. str(int(new_value.timestamp()))])
  816. self.assertNotEqual(old_value,
  817. self._get_table_item(vm_row, "Last backup").text(),
  818. "Last backup date did not change")
  819. self.assertEqual(
  820. self._get_table_item(vm_row, "Last backup").text(),
  821. target_timestamp,
  822. "Incorrect Last backup date")
  823. def test_412_prop_change_defdispvm(self):
  824. target_vm_name = "work"
  825. vm_row = self._find_vm_row(target_vm_name)
  826. old_default_dispvm =\
  827. self._get_table_item(vm_row, "Default DispVM").text()
  828. new_default_dispvm = None
  829. for vm in self.qapp.domains:
  830. if getattr(vm, "template_for_dispvms", False) and vm.name !=\
  831. old_default_dispvm:
  832. new_default_dispvm = vm.name
  833. break
  834. self.addCleanup(
  835. subprocess.call,
  836. ["qvm-prefs", target_vm_name, "default_dispvm", old_default_dispvm])
  837. self._run_command_and_process_events(
  838. ["qvm-prefs", target_vm_name, "default_dispvm", new_default_dispvm])
  839. self.assertNotEqual(
  840. old_default_dispvm,
  841. self._get_table_item(vm_row, "Default DispVM").text(),
  842. "Default DispVM did not change")
  843. self.assertEqual(
  844. self._get_table_item(vm_row, "Default DispVM").text(),
  845. self.qapp.domains[target_vm_name].default_dispvm.name,
  846. "Incorrect Default DispVM")
  847. def test_413_prop_change_templ_disp(self):
  848. target_vm_name = "work"
  849. vm_row = self._find_vm_row(target_vm_name)
  850. self.addCleanup(
  851. subprocess.call,
  852. ["qvm-prefs", "--default", target_vm_name, "template_for_dispvms"])
  853. self._run_command_and_process_events(
  854. ["qvm-prefs", target_vm_name, "template_for_dispvms", "True"])
  855. self.assertEqual(
  856. self._get_table_item(vm_row, "Is DVM Template").text(),
  857. "Yes",
  858. "Incorrect value for DVM Template")
  859. self._run_command_and_process_events(
  860. ["qvm-prefs", "--default", target_vm_name, "template_for_dispvms"])
  861. self.assertEqual(
  862. self._get_table_item(vm_row, "Is DVM Template").text(),
  863. "",
  864. "Incorrect value for not DVM Template")
  865. def test_414_vm_state_change(self):
  866. target_vm_name = "work"
  867. vm_row = self._find_vm_row(target_vm_name)
  868. self.assertFalse(self.qapp.domains[target_vm_name].is_running())
  869. self.addCleanup(
  870. subprocess.call,
  871. ["qvm-shutdown", "--wait", target_vm_name])
  872. self._run_command_and_process_events(
  873. ["qvm-start", target_vm_name], timeout=60)
  874. status_item = self._get_table_item(vm_row, "State")
  875. displayed_power_state = status_item.on_icon.status
  876. self.assertEqual(displayed_power_state, 3,
  877. "Power state failed to update on start")
  878. self._run_command_and_process_events(
  879. ["qvm-shutdown", "--wait", target_vm_name], timeout=30)
  880. displayed_power_state = status_item.on_icon.status
  881. self.assertEqual(displayed_power_state, 0,
  882. "Power state failed to update on shutdown")
  883. def test_415_template_vm_started(self):
  884. # check whether changing state of a template_vm causes all other
  885. # vms depending on it to check theirs
  886. target_vm_name = None
  887. for vm in self.qapp.domains:
  888. if vm.klass == 'TemplateVM':
  889. for vm2 in self.qapp.domains:
  890. if getattr(vm2, 'template', None) == vm.name:
  891. target_vm_name = vm.name
  892. break
  893. if target_vm_name:
  894. break
  895. for i in range(self.dialog.table.rowCount()):
  896. self._get_table_item(i, "State").update_vm_state =\
  897. unittest.mock.Mock()
  898. self.addCleanup(
  899. subprocess.call,
  900. ["qvm-shutdown", "--wait", target_vm_name])
  901. self._run_command_and_process_events(
  902. ["qvm-start", target_vm_name], timeout=60)
  903. for i in range(self.dialog.table.rowCount()):
  904. call_count = self._get_table_item(
  905. i, "State").update_vm_state.call_count
  906. if self._get_table_item(i, "Template").text() == target_vm_name:
  907. self.assertGreater(call_count, 0)
  908. elif self._get_table_item(i, "Name").text() == target_vm_name:
  909. self.assertGreater(call_count, 0)
  910. else:
  911. self.assertEqual(call_count, 0)
  912. def test_500_logs(self):
  913. self._select_admin_vm()
  914. self.assertTrue(self.dialog.logs_menu.isEnabled())
  915. dom0_logs = set()
  916. for c in self.dialog.logs_menu.actions():
  917. dom0_logs.add(c.text())
  918. self.assertIsNotNone(
  919. c.data(), "Empty log file found: {}".format(c.text()))
  920. self.assertIn("hypervisor", c.text(),
  921. "Log for dom0 does not contain 'hypervisor'")
  922. selected_vm = self._select_non_admin_vm(running=True).name
  923. self.assertTrue(self.dialog.logs_menu.isEnabled())
  924. vm_logs = set()
  925. for c in self.dialog.logs_menu.actions():
  926. vm_logs.add(c.text())
  927. self.assertIsNotNone(
  928. c.data(),
  929. "Empty log file found: {}".format(c.text()))
  930. self.assertIn(
  931. selected_vm,
  932. c.text(),
  933. "Log for {} does not contain its name".format(selected_vm))
  934. self.assertNotEqual(dom0_logs, vm_logs,
  935. "Same logs found for dom0 and non-adminVM")
  936. def _find_vm_row(self, vm_name):
  937. for row in range(self.dialog.table.rowCount()):
  938. name = self._get_table_item(row, "Name")
  939. if name.text() == vm_name:
  940. return row
  941. return None
  942. def _count_visible_table_rows(self):
  943. result = 0
  944. for i in range(self.dialog.table.rowCount()):
  945. if not self.dialog.table.isRowHidden(i):
  946. result += 1
  947. return result
  948. def _run_command_and_process_events(self, command, timeout=5):
  949. """
  950. helper function to run a given command and process eventsDispatcher
  951. events
  952. :param command: list of strings, containing the command and all its
  953. parameters
  954. :param timeout: default 5 seconds
  955. :return:
  956. """
  957. asyncio.set_event_loop(self.loop)
  958. future1 = asyncio.ensure_future(self.dispatcher.listen_for_events())
  959. self.loop.run_until_complete(asyncio.sleep(0))
  960. future2 = asyncio.create_subprocess_exec(*command,
  961. stdout=subprocess.DEVNULL,
  962. stderr=subprocess.DEVNULL)
  963. (done, pending) = self.loop.run_until_complete(
  964. asyncio.wait({future1, future2}, timeout=timeout))
  965. for task in pending:
  966. with contextlib.suppress(asyncio.CancelledError):
  967. task.cancel()
  968. self.loop.call_soon(self.loop.stop)
  969. self.loop.run_forever()
  970. def _create_set_of_current_vms(self):
  971. result = set()
  972. for i in range(self.dialog.table.rowCount()):
  973. result.add(self._get_table_item(i, "Name").vm.name)
  974. return result
  975. def _select_admin_vm(self):
  976. for row in range(self.dialog.table.rowCount()):
  977. template = self.dialog.table.item(
  978. row, self.dialog.columns_indices["Template"])
  979. if template.text() == 'AdminVM':
  980. self.dialog.table.setCurrentItem(template)
  981. return template.vm
  982. return None
  983. def _select_non_admin_vm(self, running=None):
  984. for row in range(self.dialog.table.rowCount()):
  985. template = self.dialog.table.item(
  986. row, self.dialog.columns_indices["Template"])
  987. status = self.dialog.table.item(
  988. row, self.dialog.columns_indices["State"])
  989. if template.text() != 'AdminVM' and \
  990. (running is None
  991. or (running and status.on_icon.status == 3)
  992. or (not running and status.on_icon.status != 3)):
  993. self.dialog.table.setCurrentItem(template)
  994. return template.vm
  995. return None
  996. def _select_templatevm(self, running=None):
  997. for row in range(self.dialog.table.rowCount()):
  998. template = self.dialog.table.item(
  999. row, self.dialog.columns_indices["Template"])
  1000. status = self.dialog.table.item(
  1001. row, self.dialog.columns_indices["State"])
  1002. if template.text() == 'TemplateVM' and \
  1003. (running is None
  1004. or (running and status.on_icon.status == 3)
  1005. or (not running and status.on_icon.status != 3)):
  1006. self.dialog.table.setCurrentItem(template)
  1007. return template.vm
  1008. return None
  1009. def __check_sorting(self, column_name):
  1010. last_text = None
  1011. last_vm = None
  1012. for row in range(self.dialog.table.rowCount()):
  1013. vm = self._get_table_item(row, "Name").vm.name
  1014. text = self._get_table_item(row, column_name).text().lower()
  1015. if row == 0:
  1016. self.assertEqual(vm, "dom0", "dom0 is not sorted first")
  1017. elif last_text is None:
  1018. last_text = text
  1019. last_vm = vm
  1020. else:
  1021. if last_text == text:
  1022. self.assertGreater(
  1023. vm, last_vm,
  1024. "Incorrect sorting for {}".format(column_name))
  1025. else:
  1026. self.assertGreater(
  1027. text, last_text,
  1028. "Incorrect sorting for {}".format(column_name))
  1029. last_text = text
  1030. last_vm = vm
  1031. def _get_table_item(self, row, column_name):
  1032. value = self.dialog.table.cellWidget(
  1033. row, self.dialog.columns_indices[column_name])
  1034. if not value:
  1035. value = self.dialog.table.item(
  1036. row, self.dialog.columns_indices[column_name])
  1037. return value
  1038. class QubeManagerThreadTest(unittest.TestCase):
  1039. def test_01_startvm_thread(self):
  1040. vm = unittest.mock.Mock(spec=['start'])
  1041. thread = qube_manager.StartVMThread(vm)
  1042. thread.run()
  1043. vm.start.assert_called_once_with()
  1044. def test_02_startvm_thread_error(self):
  1045. vm = unittest.mock.Mock(
  1046. spec=['start'],
  1047. **{'start.side_effect': exc.QubesException('Error')})
  1048. thread = qube_manager.StartVMThread(vm)
  1049. thread.run()
  1050. self.assertIsNotNone(thread.msg)
  1051. def test_10_run_command_thread(self):
  1052. vm = unittest.mock.Mock(spec=['run'])
  1053. thread = qube_manager.RunCommandThread(vm, "test_command")
  1054. thread.run()
  1055. vm.run.assert_called_once_with("test_command")
  1056. def test_11_run_command_thread_error(self):
  1057. vm = unittest.mock.Mock(spec=['run'],
  1058. **{'run.side_effect': ChildProcessError})
  1059. thread = qube_manager.RunCommandThread(vm, "test_command")
  1060. thread.run()
  1061. self.assertIsNotNone(thread.msg)
  1062. @unittest.mock.patch('subprocess.check_call')
  1063. def test_20_update_vm_thread_dom0(self, check_call):
  1064. vm = unittest.mock.Mock(spec=['qid'])
  1065. vm.qid = 0
  1066. thread = qube_manager.UpdateVMThread(vm)
  1067. thread.run()
  1068. check_call.assert_called_once_with(
  1069. ["/usr/bin/qubes-dom0-update", "--clean", "--gui"])
  1070. @unittest.mock.patch('builtins.open')
  1071. @unittest.mock.patch('subprocess.call')
  1072. def test_21_update_vm_thread_running(self, mock_call, mock_open):
  1073. vm = unittest.mock.Mock(
  1074. spec=['qid', 'is_running', 'run_service_for_stdio', 'run_service'],
  1075. **{'is_running.return_value': True})
  1076. vm.qid = 1
  1077. vm.run_service_for_stdio.return_value = (b'changed=no\n', None)
  1078. thread = qube_manager.UpdateVMThread(vm)
  1079. thread.run()
  1080. mock_open.assert_called_with(
  1081. '/usr/libexec/qubes-manager/dsa-4371-update', 'rb')
  1082. vm.run_service_for_stdio.assert_called_once_with(
  1083. "qubes.VMShell", user='root', input=unittest.mock.ANY)
  1084. vm.run_service.assert_called_once_with(
  1085. "qubes.InstallUpdatesGUI", user="root", wait=False)
  1086. self.assertEqual(mock_call.call_count, 0)
  1087. @unittest.mock.patch('builtins.open')
  1088. @unittest.mock.patch('subprocess.call')
  1089. def test_22_update_vm_thread_not_running(self, mock_call, mock_open):
  1090. vm = unittest.mock.Mock(
  1091. spec=['qid', 'is_running', 'run_service_for_stdio',
  1092. 'run_service', 'start', 'name'],
  1093. **{'is_running.return_value': False})
  1094. vm.qid = 1
  1095. vm.run_service_for_stdio.return_value = (b'changed=yes\n', None)
  1096. thread = qube_manager.UpdateVMThread(vm)
  1097. thread.run()
  1098. mock_open.assert_called_with(
  1099. '/usr/libexec/qubes-manager/dsa-4371-update', 'rb')
  1100. vm.start.assert_called_once_with()
  1101. vm.run_service_for_stdio.assert_called_once_with(
  1102. "qubes.VMShell", user='root', input=unittest.mock.ANY)
  1103. vm.run_service.assert_called_once_with(
  1104. "qubes.InstallUpdatesGUI", user="root", wait=False)
  1105. self.assertEqual(mock_call.call_count, 1)
  1106. @unittest.mock.patch('builtins.open')
  1107. @unittest.mock.patch('subprocess.check_call')
  1108. def test_23_update_vm_thread_error(self, *_args):
  1109. vm = unittest.mock.Mock(
  1110. spec=['qid', 'is_running'],
  1111. **{'is_running.side_effect': ChildProcessError})
  1112. vm.qid = 1
  1113. thread = qube_manager.UpdateVMThread(vm)
  1114. thread.run()
  1115. self.assertIsNotNone(thread.msg)
  1116. class VMShutdownMonitorTest(unittest.TestCase):
  1117. @unittest.mock.patch('PyQt5.QtWidgets.QMessageBox')
  1118. @unittest.mock.patch('PyQt5.QtCore.QTimer')
  1119. def test_01_vm_shutdown_correct(self, mock_timer, mock_question):
  1120. mock_vm = unittest.mock.Mock()
  1121. mock_vm.is_running.return_value = False
  1122. monitor = qube_manager.VmShutdownMonitor(mock_vm)
  1123. monitor.restart_vm_if_needed = unittest.mock.Mock()
  1124. monitor.check_if_vm_has_shutdown()
  1125. self.assertEqual(mock_question.call_count, 0)
  1126. self.assertEqual(mock_timer.call_count, 0)
  1127. monitor.restart_vm_if_needed.assert_called_once_with()
  1128. @unittest.mock.patch('PyQt5.QtWidgets.QMessageBox')
  1129. @unittest.mock.patch('PyQt5.QtCore.QTimer.singleShot')
  1130. def test_02_vm_not_shutdown_wait(self, mock_timer, mock_question):
  1131. mock_question().clickedButton.return_value = 1
  1132. mock_question().addButton.return_value = 0
  1133. mock_vm = unittest.mock.Mock()
  1134. mock_vm.is_running.return_value = True
  1135. mock_vm.start_time = datetime.datetime.now().timestamp() - 3000
  1136. monitor = qube_manager.VmShutdownMonitor(mock_vm, shutdown_time=1)
  1137. time.sleep(3)
  1138. monitor.check_if_vm_has_shutdown()
  1139. self.assertEqual(mock_timer.call_count, 1)
  1140. @unittest.mock.patch('PyQt5.QtWidgets.QMessageBox')
  1141. @unittest.mock.patch('PyQt5.QtCore.QTimer.singleShot')
  1142. def test_03_vm_kill(self, mock_timer, mock_question):
  1143. mock_question().clickedButton.return_value = 1
  1144. mock_question().addButton.return_value = 1
  1145. mock_vm = unittest.mock.Mock()
  1146. mock_vm.is_running.return_value = True
  1147. mock_vm.start_time = datetime.datetime.now().timestamp() - 3000
  1148. monitor = qube_manager.VmShutdownMonitor(mock_vm, shutdown_time=1)
  1149. time.sleep(3)
  1150. monitor.restart_vm_if_needed = unittest.mock.Mock()
  1151. monitor.check_if_vm_has_shutdown()
  1152. self.assertEqual(mock_timer.call_count, 0)
  1153. mock_vm.kill.assert_called_once_with()
  1154. monitor.restart_vm_if_needed.assert_called_once_with()
  1155. @unittest.mock.patch('PyQt5.QtWidgets.QMessageBox')
  1156. @unittest.mock.patch('PyQt5.QtCore.QTimer.singleShot')
  1157. def test_04_check_later(self, mock_timer, mock_question):
  1158. mock_vm = unittest.mock.Mock()
  1159. mock_vm.is_running.return_value = True
  1160. mock_vm.start_time = datetime.datetime.now().timestamp() - 3000
  1161. monitor = qube_manager.VmShutdownMonitor(mock_vm, shutdown_time=3000)
  1162. time.sleep(1)
  1163. monitor.check_if_vm_has_shutdown()
  1164. self.assertEqual(mock_question.call_count, 0)
  1165. self.assertEqual(mock_timer.call_count, 1)
  1166. if __name__ == "__main__":
  1167. ha_syslog = logging.handlers.SysLogHandler('/dev/log')
  1168. ha_syslog.setFormatter(
  1169. logging.Formatter('%(name)s[%(process)d]: %(message)s'))
  1170. logging.root.addHandler(ha_syslog)
  1171. unittest.main()