tests: include unit tests for multiple appmenus templates directories

QubesOS/qubes-issues#4152

qubesappmenus/test-data/evince.desktop

@@ -0,0 +1,11 @@
+[Desktop Entry]
+Version=1.0
+Type=Application
+Terminal=false
+X-Qubes-VmName=test-inst-app
+Icon=%BASEDIR%/test-inst-app/apps.icons/evince.png
+Name=test-inst-app: Document Viewer
+Comment=View multi-page documents
+Categories=GNOME;GTK;Office;Viewer;Graphics;2DGraphics;VectorGraphics;X-Qubes-VM;
+Exec=qvm-run -q -a --service -- test-inst-app qubes.StartApp+evince
+X-Qubes-DispvmExec=qvm-run -q -a --service --dispvm=test-inst-app -- qubes.StartApp+evince

qubesappmenus/test-data/evince.desktop.template

@@ -0,0 +1,11 @@
+[Desktop Entry]
+Version=1.0
+Type=Application
+Terminal=false
+X-Qubes-VmName=%VMNAME%
+Icon=%VMDIR%/apps.icons/evince.png
+Name=%VMNAME%: Document Viewer
+Comment=View multi-page documents
+Categories=GNOME;GTK;Office;Viewer;Graphics;2DGraphics;VectorGraphics;X-Qubes-VM;
+Exec=qvm-run -q -a --service -- %VMNAME% qubes.StartApp+evince
+X-Qubes-DispvmExec=qvm-run -q -a --service --dispvm=%VMNAME% -- qubes.StartApp+evince

qubesappmenus/test-data/xterm.desktop

@@ -0,0 +1,12 @@
+[Desktop Entry]
+Version=1.0
+Type=Application
+Terminal=false
+X-Qubes-VmName=test-inst-app
+Icon=%BASEDIR%/test-inst-app/apps.icons/xterm.png
+Name=test-inst-app: XTerm
+GenericName=test-inst-app: Terminal
+Comment=standard terminal emulator for the X window system
+Categories=System;TerminalEmulator;X-Qubes-VM;
+Exec=qvm-run -q -a --service -- test-inst-app qubes.StartApp+xterm
+X-Qubes-DispvmExec=qvm-run -q -a --service --dispvm=test-inst-app -- qubes.StartApp+xterm

qubesappmenus/test-data/xterm.desktop.template

@@ -0,0 +1,12 @@
+[Desktop Entry]
+Version=1.0
+Type=Application
+Terminal=false
+X-Qubes-VmName=%VMNAME%
+Icon=%VMDIR%/apps.icons/xterm.png
+Name=%VMNAME%: XTerm
+GenericName=%VMNAME%: Terminal
+Comment=standard terminal emulator for the X window system
+Categories=System;TerminalEmulator;X-Qubes-VM;
+Exec=qvm-run -q -a --service -- %VMNAME% qubes.StartApp+xterm
+X-Qubes-DispvmExec=qvm-run -q -a --service --dispvm=%VMNAME% -- qubes.StartApp+xterm

qubesappmenus/tests.py

@@ -1,5 +1,6 @@
-#!/usr/bin/python2
+#!/usr/bin/python3
 # coding=utf-8
+# pylint: skip-file
 #
 # The Qubes OS Project, http://www.qubes-os.org
 #
@@ -22,10 +23,12 @@
 # USA.
 
 import colorsys
+import io
 import os
 import tempfile
 
 import unittest
+import unittest.mock
 import pkg_resources
 import qubesappmenus
 import qubesappmenus.receive
@@ -36,13 +39,28 @@ def __init__(self, index, color, name):
         self.index = index
         self.color = color
         self.name = name
+        self.icon = name + '.png'
 
 class TestApp(object):
     labels = {1: Label(1, '0xcc0000', 'red')}
 
     def __init__(self):
         self.domains = {}
 
+class TestFeatures(dict):
+
+    def __init__(self, vm, **kwargs) -> None:
+        self.vm = vm
+        super().__init__(**kwargs)
+
+    def check_with_template(self, feature, default=None):
+        if feature in self:
+            return self[feature]
+        if hasattr(self.vm, 'template'):
+            return self.vm.template.features.check_with_template(feature,
+                default)
+        else:
+            return default
 
 class TestVM(object):
     # pylint: disable=too-few-public-methods
@@ -52,6 +70,7 @@ def __init__(self, name, **kwargs):
         self.running = False
         self.is_template = False
         self.name = name
+        self.features = TestFeatures(self)
         for k, v in kwargs.items():
             setattr(self, k, v)
 
@@ -85,7 +104,25 @@ def setUp(self):
         )
         self.app = TestApp()
         self.ext = qubesappmenus.Appmenus()
-        self.basedir = os.path.expanduser('~/.local/share/qubes-appmenus')
+        self.basedir_obj = tempfile.TemporaryDirectory()
+        self.basedir = self.basedir_obj.name
+        self.basedir_patch = unittest.mock.patch('qubesappmenus.basedir',
+            self.basedir)
+        self.basedir_patch.start()
+
+    def tearDown(self):
+        self.basedir_patch.stop()
+        self.basedir_obj.cleanup()
+        super(TC_00_Appmenus, self).tearDown()
+
+    def assertPathExists(self, path):
+        if not os.path.exists(path):
+            self.fail("Path {} does not exist".format(path))
+
+    def assertPathNotExists(self, path):
+        if os.path.exists(path):
+            self.fail("Path {} exists while it should not".format(path))
+
 
     def test_000_templates_dirs(self):
         self.assertEqual(
@@ -159,6 +196,95 @@ def test_003_icons_dir(self):
                 self.appvm.name, 'apps.icons')
         )
 
+    def test_005_created_appvm(self):
+        tpl = TestVM('test-inst-tpl',
+            klass='TemplateVM',
+            virt_mode='pvh',
+            updateable=True,
+            provides_network=False,
+            label=self.app.labels[1])
+        self.ext.appmenus_init(tpl)
+        appvm = TestVM('test-inst-app',
+            klass='AppVM',
+            template=tpl,
+            virt_mode='pvh',
+            updateable=False,
+            provides_network=False,
+            label=self.app.labels[1])
+        self.ext.appmenus_init(appvm)
+        with open(os.path.join(self.ext.templates_dirs(tpl)[0],
+                'evince.desktop'), 'wb') as f:
+            f.write(pkg_resources.resource_string(__name__,
+                'test-data/evince.desktop.template'))
+        self.ext.appmenus_create(appvm, refresh_cache=False)
+        self.ext.appicons_create(appvm)
+        evince_path = os.path.join(
+            self.ext.appmenus_dir(appvm), appvm.name + '-evince.desktop')
+        self.assertPathExists(evince_path)
+        with open(evince_path, 'rb') as f:
+            self.assertEqual(
+                pkg_resources.resource_string(__name__,
+                    'test-data/evince.desktop').replace(b'%BASEDIR%',
+                    qubesappmenus.basedir.encode()),
+                f.read()
+            )
+
+    def test_006_created_appvm_custom(self):
+        tpl = TestVM('test-inst-tpl',
+            klass='TemplateVM',
+            virt_mode='pvh',
+            updateable=True,
+            provides_network=False,
+            label=self.app.labels[1])
+        self.ext.appmenus_init(tpl)
+        appvm = TestVM('test-inst-app',
+            klass='AppVM',
+            template=tpl,
+            virt_mode='pvh',
+            updateable=False,
+            provides_network=False,
+            label=self.app.labels[1])
+        self.ext.appmenus_init(appvm)
+        with open(os.path.join(self.ext.templates_dirs(tpl)[0],
+                'evince.desktop'), 'wb') as f:
+            f.write(pkg_resources.resource_string(__name__,
+                'test-data/evince.desktop.template'))
+        self.ext.appmenus_create(appvm, refresh_cache=False)
+        self.ext.appicons_create(appvm)
+
+        with open(os.path.join(self.ext.templates_dirs(tpl)[0],
+                'xterm.desktop'), 'wb') as f:
+            f.write(pkg_resources.resource_string(__name__,
+                'test-data/xterm.desktop.template'))
+        with open(os.path.join(self.ext.templates_dirs(tpl)[0],
+                'evince.desktop'), 'wb') as f:
+            f.write(pkg_resources.resource_string(__name__,
+                'test-data/evince.desktop.template').
+                replace(b'Document Viewer', b'Random Viewer'))
+        self.ext.appmenus_update(appvm)
+        evince_path = os.path.join(
+            self.ext.appmenus_dir(appvm), appvm.name + '-evince.desktop')
+        self.assertPathExists(evince_path)
+        with open(evince_path, 'rb') as f:
+            self.assertEqual(
+                pkg_resources.resource_string(__name__,
+                    'test-data/evince.desktop')
+                    .replace(b'%BASEDIR%', qubesappmenus.basedir.encode())
+                    .replace(b'Document Viewer', b'Random Viewer'),
+                f.read()
+            )
+
+        xterm_path = os.path.join(
+            self.ext.appmenus_dir(appvm), appvm.name + '-xterm.desktop')
+        self.assertPathExists(xterm_path)
+        with open(xterm_path, 'rb') as f:
+            self.assertEqual(
+                pkg_resources.resource_string(__name__,
+                    'test-data/xterm.desktop')
+                    .replace(b'%BASEDIR%', qubesappmenus.basedir.encode()),
+                f.read()
+            )
+
     def test_100_get_appmenus(self):
         self.maxDiff = None
         def _run(service, **kwargs):
@@ -275,6 +401,100 @@ def test_111_create_template_legacy(self):
                 actual_template = f.read()
             self.assertEqual(actual_template, expected_template)
 
+    @unittest.mock.patch('subprocess.check_call')
+    def test_120_create_appvm(self, mock_subprocess):
+        tpl = TestVM('test-inst-tpl',
+            klass='TemplateVM',
+            virt_mode='pvh',
+            updateable=True,
+            provides_network=False,
+            label=self.app.labels[1])
+        self.ext.appmenus_init(tpl)
+        with open(os.path.join(self.ext.templates_dirs(tpl)[0],
+                'evince.desktop'), 'wb') as f:
+            f.write(pkg_resources.resource_string(__name__,
+                'test-data/evince.desktop.template'))
+        appvm = TestVM('test-inst-app',
+            klass='AppVM',
+            template=tpl,
+            virt_mode='pvh',
+            updateable=False,
+            provides_network=False,
+            label=self.app.labels[1])
+        self.ext.appmenus_init(appvm)
+        self.ext.appmenus_create(appvm, refresh_cache=False)
+        evince_path = os.path.join(
+            self.ext.appmenus_dir(appvm), 'test-inst-app-evince.desktop')
+        self.assertPathExists(evince_path)
+        with open(evince_path, 'rb') as f:
+            self.assertEqual(
+                pkg_resources.resource_string(__name__,
+                    'test-data/evince.desktop').replace(b'%BASEDIR%',
+                    qubesappmenus.basedir.encode()),
+                f.read()
+            )
+        mock_subprocess.assert_called_once_with([
+            'xdg-desktop-menu', 'install', '--noupdate',
+            self.basedir + '/test-inst-app/apps/test-inst-app-vm.directory',
+            self.basedir + '/test-inst-app/apps/test-inst-app-evince.desktop',
+            self.basedir + '/test-inst-app/apps/test-inst-app-qubes-vm'
+                           '-settings.desktop',
+        ], env=unittest.mock.ANY)
+
+    def test_130_process_appmenus_templates(self):
+        def _run(service, **kwargs):
+            class PopenMockup(object):
+                pass
+            self.assertEqual(service, 'qubes.GetImageRGBA')
+            p = PopenMockup()
+            p.stdin = unittest.mock.Mock()
+            p.stdout = io.BytesIO(b'1 1\nxxxx')
+            p.wait = lambda: None
+            p.returncode = 0
+            return p
+        self.appvm.virt_mode = 'pvh'
+        self.appvm.run_service = _run
+        self.appvm.log = unittest.mock.Mock()
+        appmenus = {
+            'org.gnome.Cheese': {
+                'Name': 'Cheese',
+                'GenericName': 'Webcam Booth',
+                'Comment': 'Take photos and videos with your webcam, with fun graphical effects',
+                'Categories': 'GNOME;AudioVideo;Video;Recorder;',
+                'Exec': 'qubes-desktop-run '
+                        '/usr/share/applications/org.gnome.Cheese.desktop',
+                'Icon': 'cheese',
+            },
+            'evince': {
+                'Name': 'Document Viewer',
+                'Comment': 'View multi-page documents',
+                'Categories': 'GNOME;GTK;Office;Viewer;Graphics;2DGraphics;VectorGraphics;',
+                'Exec': 'qubes-desktop-run '
+                        '/usr/share/applications/evince.desktop',
+                'Icon': 'evince',
+            },
+        }
+
+        # function under test
+        qubesappmenus.receive.process_appmenus_templates(self.ext,
+            self.appvm, appmenus)
+
+        evince_path = os.path.join(
+            self.ext.templates_dirs(self.appvm)[0],
+            'evince.desktop')
+        self.assertPathExists(evince_path)
+        with open(evince_path, 'rb') as f:
+            self.assertEqual(
+                pkg_resources.resource_string(__name__,
+                    'test-data/evince.desktop.template'),
+                f.read()
+            )
+        self.assertEqual(self.appvm.log.mock_calls, [
+            ('info', ('Creating org.gnome.Cheese',), {}),
+            ('info', ('Creating evince',), {}),
+        ])
+
+
 
 def list_tests():
     return (TC_00_Appmenus,)

qubesappmenus/tests_integ.py

@@ -1,4 +1,4 @@
-# -*- encoding: utf8 -*-
+# pylint: skip-file
 #
 # The Qubes OS Project, http://www.qubes-os.org
 #
@@ -17,7 +17,6 @@
 #
 # You should have received a copy of the GNU General Public License along
 # with this program; if not, see <http://www.gnu.org/licenses/>.
-
 import os
 
 import asyncio