qvm_ls.py 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303
  1. # pylint: disable=protected-access,pointless-statement
  2. #
  3. # The Qubes OS Project, https://www.qubesmgmt-os.org/
  4. #
  5. # Copyright (C) 2015 Joanna Rutkowska <joanna@invisiblethingslab.com>
  6. # Copyright (C) 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 Lesser General Public License as published by
  10. # the Free Software Foundation; either version 2.1 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 Lesser General Public License for more details.
  17. #
  18. # You should have received a copy of the GNU Lesser General Public License along
  19. # with this program; if not, see <http://www.gnu.org/licenses/>.
  20. import unittest
  21. import qubesadmin
  22. import qubesadmin.vm
  23. import qubesadmin.tools.qvm_ls
  24. import qubesadmin.tests
  25. import qubesadmin.tests.tools
  26. from qubesadmin.tests import TestVM, TestVMCollection
  27. class TestApp(object):
  28. def __init__(self):
  29. self.domains = TestVMCollection(
  30. [
  31. ('dom0', TestVM('dom0')),
  32. ('test-vm', TestVM('test-vm')),
  33. ]
  34. )
  35. class TC_00_Column(qubesadmin.tests.QubesTestCase):
  36. def test_100_init(self):
  37. try:
  38. testcolumn = qubesadmin.tools.qvm_ls.Column('TESTCOLUMN')
  39. self.assertEqual(testcolumn.ls_head, 'TESTCOLUMN')
  40. finally:
  41. try:
  42. qubesadmin.tools.qvm_ls.Column.columns['TESTCOLUMN']
  43. except KeyError:
  44. pass
  45. class TC_10_globals(qubesadmin.tests.QubesTestCase):
  46. def test_100_simple_flag(self):
  47. flag = qubesadmin.tools.qvm_ls.simple_flag(1, 'T', 'internal')
  48. # TODO after serious testing of QubesVM and Qubes app, this should be
  49. # using normal components
  50. vm = TestVM('test-vm', internal=False)
  51. self.assertFalse(flag(None, vm))
  52. vm.internal = True
  53. self.assertTrue(flag(None, vm))
  54. @unittest.skip('column list generated dynamically')
  55. def test_900_formats_columns(self):
  56. for fmt in qubesadmin.tools.qvm_ls.formats:
  57. for col in qubesadmin.tools.qvm_ls.formats[fmt]:
  58. self.assertIn(col.upper(), qubesadmin.tools.qvm_ls.Column.columns)
  59. class TC_50_List(qubesadmin.tests.QubesTestCase):
  60. def test_100_list_with_status(self):
  61. app = TestApp()
  62. app.domains['test-vm'].internal = False
  63. app.domains['test-vm'].updateable = False
  64. app.domains['test-vm'].template = TestVM('template')
  65. app.domains['test-vm'].netvm = TestVM('sys-net')
  66. app.domains['test-vm'].label = 'green'
  67. app.domains['dom0'].label = 'black'
  68. with qubesadmin.tests.tools.StdoutBuffer() as stdout:
  69. qubesadmin.tools.qvm_ls.main([], app=app)
  70. self.assertEqual(stdout.getvalue(),
  71. 'NAME STATE CLASS LABEL TEMPLATE NETVM\n'
  72. 'dom0 Running TestVM black - -\n'
  73. 'test-vm Running TestVM green template sys-net\n')
  74. def test_101_list_with_underscore(self):
  75. app = TestApp()
  76. app.domains['test-vm'].virt_mode = 'pv'
  77. app.domains['test-vm'].label = 'green'
  78. app.domains['dom0'].label = 'black'
  79. with qubesadmin.tests.tools.StdoutBuffer() as stdout:
  80. qubesadmin.tools.qvm_ls.main(['-O', 'name,virt_mode,class'], app=app)
  81. self.assertEqual(stdout.getvalue(),
  82. 'NAME VIRT-MODE CLASS\n'
  83. 'dom0 - TestVM\n'
  84. 'test-vm pv TestVM\n')
  85. def test_102_list_selected(self):
  86. app = TestApp()
  87. app.domains['test-vm'].internal = False
  88. app.domains['test-vm'].updateable = False
  89. app.domains['test-vm'].template = TestVM('template')
  90. app.domains['test-vm'].netvm = TestVM('sys-net')
  91. app.domains['test-vm'].label = 'green'
  92. app.domains['dom0'].label = 'black'
  93. with qubesadmin.tests.tools.StdoutBuffer() as stdout:
  94. qubesadmin.tools.qvm_ls.main(['test-vm'], app=app)
  95. self.assertEqual(stdout.getvalue(),
  96. 'NAME STATE CLASS LABEL TEMPLATE NETVM\n'
  97. 'test-vm Running TestVM green template sys-net\n')
  98. def test_102_raw_list(self):
  99. app = TestApp()
  100. with qubesadmin.tests.tools.StdoutBuffer() as stdout:
  101. qubesadmin.tools.qvm_ls.main(['--raw-list'], app=app)
  102. self.assertEqual(stdout.getvalue(),
  103. 'dom0\n'
  104. 'test-vm\n')
  105. class TC_70_Tags(qubesadmin.tests.QubesTestCase):
  106. def setUp(self):
  107. self.app = TestApp()
  108. self.app.domains = TestVMCollection(
  109. [
  110. (
  111. 'dom0',
  112. TestVM(
  113. 'dom0',
  114. tags=['my'],
  115. label='black'
  116. )
  117. ),
  118. (
  119. 'test-vm',
  120. TestVM(
  121. 'test-vm',
  122. tags=['not-my', 'other'],
  123. label='red',
  124. netvm=TestVM('sys-firewall'),
  125. template=TestVM('template')
  126. )
  127. ),
  128. ]
  129. )
  130. def test_100_tag(self):
  131. with qubesadmin.tests.tools.StdoutBuffer() as stdout:
  132. qubesadmin.tools.qvm_ls.main(['--tags', 'my'], app=self.app)
  133. self.assertEqual(stdout.getvalue(),
  134. 'NAME STATE CLASS LABEL TEMPLATE NETVM\n'
  135. 'dom0 Running TestVM black - -\n')
  136. def test_100_tag_nomatch(self):
  137. with qubesadmin.tests.tools.StdoutBuffer() as stdout:
  138. qubesadmin.tools.qvm_ls.main(['--tags', 'nx'], app=self.app)
  139. self.assertEqual(stdout.getvalue(),
  140. 'NAME STATE CLASS LABEL TEMPLATE NETVM\n')
  141. def test_100_tags(self):
  142. with qubesadmin.tests.tools.StdoutBuffer() as stdout:
  143. qubesadmin.tools.qvm_ls.main(['--tags', 'my', 'other'], app=self.app)
  144. self.assertEqual(stdout.getvalue(),
  145. 'NAME STATE CLASS LABEL TEMPLATE NETVM\n'
  146. 'dom0 Running TestVM black - -\n'
  147. 'test-vm Running TestVM red template sys-firewall\n')
  148. def test_100_tags_nomatch(self):
  149. with qubesadmin.tests.tools.StdoutBuffer() as stdout:
  150. qubesadmin.tools.qvm_ls.main(['--tags', 'nx1', 'nx2'], app=self.app)
  151. self.assertEqual(stdout.getvalue(),
  152. 'NAME STATE CLASS LABEL TEMPLATE NETVM\n')
  153. class TC_80_Power_state_filters(qubesadmin.tests.QubesTestCase):
  154. def setUp(self):
  155. self.app = TestApp()
  156. self.app.domains = TestVMCollection(
  157. [
  158. ('a', TestVM('a', power_state='Halted')),
  159. ('b', TestVM('b', power_state='Transient')),
  160. ('c', TestVM('c', power_state='Running'))
  161. ]
  162. )
  163. def test_100_nofilter(self):
  164. with qubesadmin.tests.tools.StdoutBuffer() as stdout:
  165. qubesadmin.tools.qvm_ls.main([], app=self.app)
  166. self.assertEqual(stdout.getvalue(),
  167. 'NAME STATE CLASS LABEL TEMPLATE NETVM\n'
  168. 'a Halted TestVM - - -\n'
  169. 'b Transient TestVM - - -\n'
  170. 'c Running TestVM - - -\n')
  171. def test_100_running(self):
  172. with qubesadmin.tests.tools.StdoutBuffer() as stdout:
  173. qubesadmin.tools.qvm_ls.main(['--running'], app=self.app)
  174. self.assertEqual(stdout.getvalue(),
  175. 'NAME STATE CLASS LABEL TEMPLATE NETVM\n'
  176. 'c Running TestVM - - -\n')
  177. def test_100_running_or_halted(self):
  178. with qubesadmin.tests.tools.StdoutBuffer() as stdout:
  179. qubesadmin.tools.qvm_ls.main(['--running', '--halted'], app=self.app)
  180. self.assertEqual(stdout.getvalue(),
  181. 'NAME STATE CLASS LABEL TEMPLATE NETVM\n'
  182. 'a Halted TestVM - - -\n'
  183. 'c Running TestVM - - -\n')
  184. class TC_90_List_with_qubesd_calls(qubesadmin.tests.QubesTestCase):
  185. def test_100_list_with_status(self):
  186. self.app.expected_calls[
  187. ('dom0', 'admin.vm.List', None, None)] = \
  188. b'0\x00vm1 class=AppVM state=Running\n' \
  189. b'template1 class=TemplateVM state=Halted\n' \
  190. b'sys-net class=AppVM state=Running\n'
  191. self.app.expected_calls[
  192. ('vm1', 'admin.vm.List', None, None)] = \
  193. b'0\x00vm1 class=AppVM state=Running\n'
  194. self.app.expected_calls[
  195. ('sys-net', 'admin.vm.List', None, None)] = \
  196. b'0\x00sys-net class=AppVM state=Running\n'
  197. self.app.expected_calls[
  198. ('template1', 'admin.vm.List', None, None)] = \
  199. b'0\x00template1 class=TemplateVM state=Halted\n'
  200. props = {
  201. 'label': b'type=label green',
  202. 'template': b'type=vm template1',
  203. 'netvm': b'type=vm sys-net',
  204. # 'virt_mode': b'type=str pv',
  205. }
  206. for key, value in props.items():
  207. self.app.expected_calls[
  208. ('vm1', 'admin.vm.property.Get', key, None)] = \
  209. b'0\x00default=True ' + value
  210. # setup template1
  211. props['label'] = b'type=label black'
  212. for key, value in props.items():
  213. self.app.expected_calls[
  214. ('template1', 'admin.vm.property.Get', key, None)] = \
  215. b'0\x00default=True ' + value
  216. self.app.expected_calls[
  217. ('template1', 'admin.vm.property.Get', 'template', None)] = \
  218. b'' # request refused - no such property
  219. # setup sys-net
  220. props['label'] = b'type=label red'
  221. for key, value in props.items():
  222. self.app.expected_calls[
  223. ('sys-net', 'admin.vm.property.Get', key, None)] = \
  224. b'0\x00default=True ' + value
  225. with qubesadmin.tests.tools.StdoutBuffer() as stdout:
  226. qubesadmin.tools.qvm_ls.main([], app=self.app)
  227. self.assertEqual(stdout.getvalue(),
  228. 'NAME STATE CLASS LABEL TEMPLATE NETVM\n'
  229. 'sys-net Running AppVM red template1 sys-net\n'
  230. 'template1 Halted TemplateVM black - sys-net\n'
  231. 'vm1 Running AppVM green template1 sys-net\n')
  232. self.assertAllCalled()
  233. def test_101_list_selected(self):
  234. self.app.expected_calls[
  235. ('dom0', 'admin.vm.List', None, None)] = \
  236. b'0\x00vm1 class=AppVM state=Running\n' \
  237. b'template1 class=TemplateVM state=Halted\n' \
  238. b'sys-net class=AppVM state=Running\n'
  239. self.app.expected_calls[
  240. ('vm1', 'admin.vm.List', None, None)] = \
  241. b'0\x00vm1 class=AppVM state=Running\n'
  242. self.app.expected_calls[
  243. ('sys-net', 'admin.vm.List', None, None)] = \
  244. b'0\x00sys-net class=AppVM state=Running\n'
  245. props = {
  246. 'label': b'type=label green',
  247. 'template': b'type=vm template1',
  248. 'netvm': b'type=vm sys-net',
  249. # 'virt_mode': b'type=str pv',
  250. }
  251. for key, value in props.items():
  252. self.app.expected_calls[
  253. ('vm1', 'admin.vm.property.Get', key, None)] = \
  254. b'0\x00default=True ' + value
  255. # setup sys-net
  256. props['label'] = b'type=label red'
  257. for key, value in props.items():
  258. self.app.expected_calls[
  259. ('sys-net', 'admin.vm.property.Get', key, None)] = \
  260. b'0\x00default=True ' + value
  261. with qubesadmin.tests.tools.StdoutBuffer() as stdout:
  262. qubesadmin.tools.qvm_ls.main(['vm1', 'sys-net'], app=self.app)
  263. self.assertEqual(stdout.getvalue(),
  264. 'NAME STATE CLASS LABEL TEMPLATE NETVM\n'
  265. 'sys-net Running AppVM red template1 sys-net\n'
  266. 'vm1 Running AppVM green template1 sys-net\n')
  267. self.assertAllCalled()