tools: qvm-service tool

This really use features, but keep compatibility with Qubes 3.x

Fixes QubesOS/qubes-issues#1227

qubesadmin/tests/tools/qvm_service.py

@@ -0,0 +1,203 @@
+# -*- encoding: utf8 -*-
+#
+# The Qubes OS Project, http://www.qubes-os.org
+#
+# Copyright (C) 2017 Marek Marczykowski-Górecki
+#                               <marmarek@invisiblethingslab.com>
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation; either version 2.1 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License along
+# with this program; if not, see <http://www.gnu.org/licenses/>.
+import unittest
+
+import qubesadmin.tests
+import qubesadmin.tools.qvm_service
+
+
+class TC_00_qvm_service(qubesadmin.tests.QubesTestCase):
+    def test_000_list(self):
+        self.app.expected_calls[
+            ('dom0', 'admin.vm.List', None, None)] = \
+            b'0\x00some-vm class=AppVM state=Running\n'
+        self.app.expected_calls[
+            ('some-vm', 'admin.vm.feature.List', None, None)] = \
+            b'0\x00feature1\nservice.service1\nservice.service2\n'
+        self.app.expected_calls[
+            ('some-vm', 'admin.vm.feature.Get', 'service.service1', None)] = \
+            b'0\x00value1'
+        self.app.expected_calls[
+            ('some-vm', 'admin.vm.feature.Get', 'service.service2', None)] = \
+            b'0\x00'
+        with qubesadmin.tests.tools.StdoutBuffer() as stdout:
+            self.assertEqual(
+                qubesadmin.tools.qvm_service.main(['some-vm'], app=self.app),
+                0)
+            self.assertEqual(stdout.getvalue(),
+                'service1  on\n'
+                'service2  off\n')
+        self.assertAllCalled()
+
+    def test_001_list_l(self):
+        self.app.expected_calls[
+            ('dom0', 'admin.vm.List', None, None)] = \
+            b'0\x00some-vm class=AppVM state=Running\n'
+        self.app.expected_calls[
+            ('some-vm', 'admin.vm.feature.List', None, None)] = \
+            b'0\x00feature1\nservice.service1\nservice.service2\n'
+        self.app.expected_calls[
+            ('some-vm', 'admin.vm.feature.Get', 'service.service1', None)] = \
+            b'0\x00value1'
+        self.app.expected_calls[
+            ('some-vm', 'admin.vm.feature.Get', 'service.service2', None)] = \
+            b'0\x00'
+        with qubesadmin.tests.tools.StdoutBuffer() as stdout:
+            self.assertEqual(
+                qubesadmin.tools.qvm_service.main(['-l', 'some-vm'],
+                    app=self.app),
+                0)
+            self.assertEqual(stdout.getvalue(),
+                'service1  on\n'
+                'service2  off\n')
+        self.assertAllCalled()
+
+    def test_002_enable(self):
+        self.app.expected_calls[
+            ('dom0', 'admin.vm.List', None, None)] = \
+            b'0\x00some-vm class=AppVM state=Running\n'
+        self.app.expected_calls[
+            ('some-vm', 'admin.vm.feature.Set',
+             'service.service1', b'1')] = b'0\x00'
+        self.assertEqual(
+            qubesadmin.tools.qvm_service.main(['some-vm', 'service1',
+                'on'],
+                app=self.app),
+            0)
+        self.assertAllCalled()
+
+    def test_003_enable_opt(self):
+        self.app.expected_calls[
+            ('dom0', 'admin.vm.List', None, None)] = \
+            b'0\x00some-vm class=AppVM state=Running\n'
+        self.app.expected_calls[
+            ('some-vm', 'admin.vm.feature.Set',
+             'service.service1', b'1')] = b'0\x00'
+        self.assertEqual(
+            qubesadmin.tools.qvm_service.main(['--enable', 'some-vm',
+                'service1'],
+                app=self.app),
+            0)
+        self.assertAllCalled()
+
+    @unittest.expectedFailure
+    def test_004_enable_opt_mixed(self):
+        self.app.expected_calls[
+            ('dom0', 'admin.vm.List', None, None)] = \
+            b'0\x00some-vm class=AppVM state=Running\n'
+        self.app.expected_calls[
+            ('some-vm', 'admin.vm.feature.Set',
+             'service.service1', b'1')] = b'0\x00'
+        with self.assertNotRaises(SystemExit):
+            self.assertEqual(
+                qubesadmin.tools.qvm_service.main(
+                    ['some-vm', '--enable', 'service1'],
+                    app=self.app),
+                0)
+        self.assertAllCalled()
+
+    def test_005_disable(self):
+        self.app.expected_calls[
+            ('dom0', 'admin.vm.List', None, None)] = \
+            b'0\x00some-vm class=AppVM state=Running\n'
+        self.app.expected_calls[
+            ('some-vm', 'admin.vm.feature.Set',
+             'service.service1', b'')] = b'0\x00'
+        self.assertEqual(
+            qubesadmin.tools.qvm_service.main(
+                ['some-vm', 'service1', 'off'],
+                app=self.app),
+            0)
+        self.assertAllCalled()
+
+    def test_006_disable_opt(self):
+        self.app.expected_calls[
+            ('dom0', 'admin.vm.List', None, None)] = \
+            b'0\x00some-vm class=AppVM state=Running\n'
+        self.app.expected_calls[
+            ('some-vm', 'admin.vm.feature.Set',
+             'service.service1', b'')] = b'0\x00'
+        with self.assertNotRaises(SystemExit):
+            self.assertEqual(
+                qubesadmin.tools.qvm_service.main(
+                    ['--disable', 'some-vm', 'service1'],
+                    app=self.app),
+                0)
+        self.assertAllCalled()
+
+    def test_007_get(self):
+        self.app.expected_calls[
+            ('dom0', 'admin.vm.List', None, None)] = \
+            b'0\x00some-vm class=AppVM state=Running\n'
+        self.app.expected_calls[
+            ('some-vm', 'admin.vm.feature.Get', 'service.service3', None)] = \
+            b'0\x00value2 with spaces'
+        with qubesadmin.tests.tools.StdoutBuffer() as stdout:
+            self.assertEqual(
+                qubesadmin.tools.qvm_service.main(['some-vm', 'service3'],
+                    app=self.app),
+                0)
+            self.assertEqual(stdout.getvalue(),
+                'on\n')
+        self.assertAllCalled()
+
+    def test_008_del(self):
+        self.app.expected_calls[
+            ('dom0', 'admin.vm.List', None, None)] = \
+            b'0\x00some-vm class=AppVM state=Running\n'
+        self.app.expected_calls[
+            ('some-vm', 'admin.vm.feature.Remove', 'service.srv4', None)] = \
+            b'0\x00'
+        with qubesadmin.tests.tools.StdoutBuffer() as stdout:
+            self.assertEqual(
+                qubesadmin.tools.qvm_service.main(
+                    ['--unset', 'some-vm', 'srv4'],
+                    app=self.app),
+                0)
+            self.assertEqual(stdout.getvalue(),
+                '')
+        self.assertAllCalled()
+
+    def test_009_del_legacy(self):
+        self.app.expected_calls[
+            ('dom0', 'admin.vm.List', None, None)] = \
+            b'0\x00some-vm class=AppVM state=Running\n'
+        self.app.expected_calls[
+            ('some-vm', 'admin.vm.feature.Remove', 'service.srv4', None)] = \
+            b'0\x00'
+        with qubesadmin.tests.tools.StdoutBuffer() as stdout:
+            self.assertEqual(
+                qubesadmin.tools.qvm_service.main(
+                    ['--default', 'some-vm', 'srv4'],
+                    app=self.app),
+                0)
+            self.assertEqual(stdout.getvalue(),
+                '')
+        self.assertAllCalled()
+
+    def test_010_set_invalid(self):
+        self.app.expected_calls[
+            ('dom0', 'admin.vm.List', None, None)] = \
+            b'0\x00some-vm class=AppVM state=Running\n'
+        with self.assertRaises(SystemExit):
+            qubesadmin.tools.qvm_service.main(
+                ['some-vm', 'service1', 'invalid-value'],
+                app=self.app),
+        self.assertAllCalled()

qubesadmin/tools/qvm_service.py

@@ -0,0 +1,136 @@
+# coding=utf-8
+#
+# The Qubes OS Project, https://www.qubes-os.org/
+#
+# Copyright (C) 2010-2016  Joanna Rutkowska <joanna@invisiblethingslab.com>
+# Copyright (C) 2016       Wojtek Porczyk <woju@invisiblethingslab.com>
+# Copyright (C) 2017       Marek Marczykowski-Górecki
+#                                           <marmarek@invisiblethingslab.com>
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation; either version 2.1 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License along
+# with this program; if not, write to the Free Software Foundation, Inc.,
+# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+#
+
+'''qvm-service - Manage domain's services'''
+
+from __future__ import print_function
+
+import argparse
+import sys
+
+import qubesadmin
+import qubesadmin.exc
+import qubesadmin.tools
+
+parser = qubesadmin.tools.QubesArgumentParser(
+    vmname_nargs=1,
+    argument_default=argparse.SUPPRESS,
+    description='manage domain\'s services')
+
+parser.add_argument('service', metavar='FEATURE',
+    action='store', nargs='?',
+    help='name of the feature')
+
+parser.add_argument('value', metavar='VALUE',
+    action='store', nargs='?',
+    help='new value of the service')
+
+parser.add_argument('--unset', '--default', '--delete', '-D',
+    dest='delete', default=False,
+    action='store_true',
+    help='unset service (default to VM preference)')
+
+parser.add_argument('--list', '-l',
+    dest='list',
+    action='store_true',
+    help='list services (default action)')
+
+parser.add_argument('--enable', '-e',
+    dest='value',
+    action='store_const', const='1',
+    help='enable service')
+
+parser.add_argument('--disable', '-d',
+    dest='value',
+    action='store_const', const='0',
+    help='disable service')
+
+def parse_bool(value):
+    '''Convert string value to bool according to well known representations
+
+    It accepts (case-insensitive) ``'0'``, ``'no'`` and ``false`` as
+        :py:obj:`False` and ``'1'``, ``'yes'`` and ``'true'`` as
+        :py:obj:`True`.
+    '''
+    if isinstance(value, str):
+        lcvalue = value.lower()
+        if lcvalue in ('0', 'no', 'false', 'off'):
+            return False
+        if lcvalue in ('1', 'yes', 'true', 'on'):
+            return True
+        raise qubesadmin.exc.QubesValueError(
+            'Invalid literal for boolean value: {!r}'.format(value))
+
+    return bool(value)
+
+
+def main(args=None, app=None):
+    '''Main routine of :program:`qvm-features`.
+
+    :param list args: Optional arguments to override those delivered from \
+        command line.
+    '''
+
+    args = parser.parse_args(args, app=app)
+    vm = args.domains[0]
+
+    if not hasattr(args, 'service'):
+        if args.delete:
+            parser.error('--unset requires a feature')
+
+        services = [(feat[len('service.'):],
+            'on' if vm.features[feat] else 'off') for feat in
+            vm.features if feat.startswith('service.')]
+        qubesadmin.tools.print_table(services)
+
+    elif args.delete:
+        if hasattr(args, 'value'):
+            parser.error('cannot both set and unset a value')
+        try:
+            del vm.features['service.' + args.service]
+        except KeyError:
+            pass
+        except qubesadmin.exc.QubesException as err:
+            parser.error_runtime(str(err))
+
+    elif hasattr(args, 'value'):
+        try:
+            vm.features['service.' + args.service] = parse_bool(args.value)
+        except qubesadmin.exc.QubesException as err:
+            parser.error_runtime(str(err))
+
+    else:
+        try:
+            print('on' if vm.features['service.' + args.service] else 'off')
+            return 0
+        except KeyError:
+            return 1
+        except qubesadmin.exc.QubesException as err:
+            parser.error_runtime(str(err))
+
+    return 0
+
+
+if __name__ == '__main__':
+    sys.exit(main())