fix menu file leftover on vm remove

Author: Jayant-kernel

.gitlab-ci.yml

@@ -6,7 +6,7 @@ checks:tests:
   - pip3 install --quiet -r ci/requirements.txt
   - git clone https://github.com/QubesOS/qubes-linux-utils ~/linux-utils
   - git clone https://github.com/QubesOS/qubes-core-admin-client ~/core-admin-client
-  - (cd ~/core-admin-client;python3 setup.py egg_info)
+  - (cd ~/core-admin-client; if [ -f setup.py ]; then python3 setup.py egg_info; else python3 -m pip install --quiet --no-deps -e .; fi)
   script:
   - export PYTHONPATH=~/core-admin-client:~/linux-utils/imgconverter
   - python3 -m pylint qubesappmenus

qubesappmenus/__init__.py

@@ -501,11 +501,36 @@ def appmenus_remove(self, vm, refresh_cache=True):
                     refresh_cache)
             shutil.rmtree(appmenus_dir)
 
+        self._remove_menu_files(vm)
+
         if refresh_cache:
             if 'KDE_SESSION_UID' in os.environ:
                 subprocess.call(['kbuildsycoca' +
                                  os.environ.get('KDE_SESSION_VERSION', '4')])
 
+    @staticmethod
+    def _remove_menu_files(vm):
+        """Remove .menu files for a VM from ~/.config/menus/applications-merged/
+
+        xdg-desktop-menu uninstall does not always clean these up (errors
+        are suppressed, partial installs can leave entries behind).
+        """
+        menus_dir = os.path.join(xdg.BaseDirectory.xdg_config_home,
+                                 'menus', 'applications-merged')
+        if not os.path.isdir(menus_dir):
+            return
+        vm_name = str(vm)
+        escaped = vm_name_escape(vm_name)
+        for prefix in ('qubes-vm-directory', 'qubes-dispvm-directory'):
+            with contextlib.suppress(FileNotFoundError):
+                os.unlink(os.path.join(menus_dir,
+                                       'user-' + prefix + escaped + '.menu'))
+            # also try old format (before VM name escaping was introduced)
+            with contextlib.suppress(FileNotFoundError):
+                os.unlink(os.path.join(menus_dir,
+                                       'user-' + prefix + '-' +
+                                       vm_name + '.menu'))
+
     def appicons_create(self, vm, srcdirs=(), force=False):
         """Create/update applications icons"""
         if not srcdirs:

qubesappmenus/tests.py

@@ -24,6 +24,7 @@
 
 import io
 import os
+import shutil
 import tempfile
 import sys
 
@@ -727,6 +728,64 @@ def test_131_set_get_default_whitelist(self, mock_subprocess):
         self.assertEqual(whitelist, self.ext.get_default_whitelist(tpl))
 
 
+    @unittest.mock.patch('subprocess.check_call')
+    def test_140_remove_cleans_menu_files(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)
+        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)
+
+        config_dir = tempfile.mkdtemp()
+        try:
+            menus_dir = os.path.join(config_dir, 'menus', 'applications-merged')
+            os.makedirs(menus_dir)
+            escaped = qubesappmenus.vm_name_escape(appvm.name)
+            # current-format .menu file
+            menu_file = os.path.join(menus_dir,
+                'user-qubes-vm-directory' + escaped + '.menu')
+            # old-format .menu file (pre-escaping)
+            old_menu_file = os.path.join(menus_dir,
+                'user-qubes-vm-directory-' + appvm.name + '.menu')
+            for path in (menu_file, old_menu_file):
+                with open(path, 'w', encoding='utf-8') as f:
+                    f.write('<Menu/>\n')
+
+            with unittest.mock.patch('xdg.BaseDirectory.xdg_config_home',
+                                     config_dir):
+                self.ext.appmenus_remove(appvm, refresh_cache=False)
+
+            self.assertPathNotExists(menu_file)
+            self.assertPathNotExists(old_menu_file)
+        finally:
+            shutil.rmtree(config_dir)
+
+    def test_141_remove_menu_files_missing_dir(self):
+        config_dir = tempfile.mkdtemp()
+        try:
+            menus_dir = os.path.join(config_dir, 'menus', 'applications-merged')
+            with unittest.mock.patch('xdg.BaseDirectory.xdg_config_home',
+                                     config_dir), \
+                 unittest.mock.patch('os.unlink') as mock_unlink:
+                # Missing applications-merged directory should be ignored.
+                qubesappmenus.Appmenus._remove_menu_files('test-vm')
+                mock_unlink.assert_not_called()
+            self.assertFalse(os.path.exists(menus_dir))
+        finally:
+            shutil.rmtree(config_dir)
+
+
 def list_tests():
     return (TC_00_Appmenus,)