Revert to red label while restoring on missing labels

If we allow users to create custom labels and they backup such qubes,
restore operation will fail on new systems without those custom labels.
Fix this by reverting to red label and allow users to restore their
backup.

fixes: QubesOS/qubes-issues#9781

Author: alimirjamali

qubesadmin/backup/restore.py

@@ -2020,6 +2020,12 @@ def _restore_vms_metadata(self, restore_info):
                 # can't create vm, but need backup info
                 new_vm = self.backup_app.domains[vm_name]
             else:
+                # do not fail if VM had a custom label. revert to red label
+                if not vm.label in self.app.labels:
+                    self.log.warning(
+                        'Reverting to red label while restoring %s ' \
+                        'since %s label does not exist', vm.name, vm.label)
+                    vm.label = "red"
                 try:
                     # first only create VMs, later setting may require other VMs
                     # be already created

qubesadmin/tests/backup/backupcompatibility.py

@@ -695,7 +695,7 @@
         },
         'test-net': {
             'klass': 'AppVM',
-            'label': 'red',
+            'label': 'scarlet',
             'properties': {
                 'maxmem': '300',
                 'memory': '300',
@@ -749,8 +749,11 @@ def assertCorrectlyConverted(self, backup_app, expected_data):
                 expected_data['domains'][vm]['template'], vm)
             self.assertEqual(backup_app.domains[vm].klass,
                 expected_data['domains'][vm]['klass'], vm)
-            self.assertEqual(backup_app.domains[vm].label,
-                expected_data['domains'][vm]['label'], vm)
+            if expected_data['domains'][vm]['label'] == 'scarlet':
+                self.assertEqual(backup_app.domains[vm].label, 'red', vm)
+            else:
+                self.assertEqual(backup_app.domains[vm].label,
+                    expected_data['domains'][vm]['label'], vm)
             self.assertEqual(backup_app.domains[vm].backup_path,
                 expected_data['domains'][vm]['backup_path'], vm)
             self.assertEqual(backup_app.domains[vm].included_in_backup,
@@ -1357,18 +1360,19 @@ def setup_expected_calls(self, parsed_qubes_xml, templates_map=None):
             if name == 'dom0':
                 continue
 
+            label = 'red' if vm['label'] == 'scarlet' else vm['label']
             if self.storage_pool:
                 self.app.expected_calls[
                     ('dom0', 'admin.vm.CreateInPool.' + vm['klass'],
                      templates_map.get(vm['template'], vm['template']),
                     'name={} label={} pool={}'.format(
-                        name, vm['label'], self.storage_pool).encode())] = \
+                        name, label, self.storage_pool).encode())] = \
                     b'0\0'
             else:
                 self.app.expected_calls[
                     ('dom0', 'admin.vm.Create.' + vm['klass'],
                      templates_map.get(vm['template'], vm['template']),
-                    'name={} label={}'.format(name, vm['label']).encode())] =\
+                    'name={} label={}'.format(name, label).encode())] =\
                     b'0\0'
             extra_vm_list_lines.append(
                 '{} class={} state=Halted\n'.format(name, vm['klass']).encode())
@@ -1487,6 +1491,9 @@ def setup_expected_calls(self, parsed_qubes_xml, templates_map=None):
             [orig_admin_vm_list] + \
             [orig_admin_vm_list + b''.join(extra_vm_list_lines)] * \
             len(extra_vm_list_lines)
+        self.app.expected_calls[('dom0', 'admin.label.List', None, None)] = (
+            b'0\0red\norange\nyellow\ngreen\ngray\nblue\npurple\nblack\n'
+        )
 
     def mock_appmenus(self, queue, vm, stream):
         queue.put((vm.name, 'appmenus', None, stream.read()))

qubesadmin/tests/backup/v4-qubes.xml

@@ -8,6 +8,7 @@
     <label color="0x3465a4" id="label-6">blue</label>
     <label color="0x75507b" id="label-7">purple</label>
     <label color="0x000000" id="label-8">black</label>
+    <label color="0xff2400" id="label-9">scarlet</label>
   </labels>
   <pools>
     <pool driver="lvm_thin" name="lvm" thin_pool="pool3" volume_group="core3"/>
@@ -392,7 +393,7 @@
     </domain>
     <domain id="domain-6" class="AppVM">
       <properties>
-        <property name="label">label-1</property>
+        <property name="label">label-9</property>
         <property name="maxmem">300</property>
         <property name="name">test-net</property>
         <property name="netvm"></property>