bootloader: Remove extlinux and GRUB1 code

extlinux and GRUB1 are no longer used for installed systems so remove
the code that handles them.

Signed-off-by: Ross Lagerwall <ross.lagerwall@citrix.com>

Author: rosslagerwall

tests/test_bootloader.py

@@ -8,28 +8,6 @@
 from xcp.compat import open_with_codec_handling
 
 
-def test_writeGrubWithTempFile(tmpdir):
-    """Test xcp.bootloader.{writeGrub,writeExtLinux}.open_with_codec_handling with tmpdir fixture"""
-    bootloader = Bootloader.readGrub2("tests/data/grub.cfg")
-    filename = str(tmpdir.mkdir("grub").join("menu.lst"))
-    bootloader.writeGrub(filename)
-    Bootloader.readGrub(filename)
-    bootloader.writeExtLinux(filename)
-    Bootloader.readExtLinux(filename)
-
-
-def test_GrubLegacyExtLinuxWithTempFile(tmpdir):
-    """Note: GRUB-Legacy and EXTLINUX code can likely be removed (pending approval)"""
-    bootloader = Bootloader.readGrub2("tests/data/grub-linux.cfg")
-    filename = str(tmpdir.mkdir("grub").join("menu.lst"))
-    bootloader.writeExtLinux(filename)
-    Bootloader.readExtLinux(filename)
-    bootloader.menu.pop("xe-tboot")
-    bootloader.menu_order.remove("xe-tboot")
-    bootloader.writeGrub(filename)
-    Bootloader.readGrub(filename)
-
-
 class TestBootloader(unittest.TestCase):
     def test_grub2(self):
         bl = Bootloader.readGrub2("tests/data/grub.cfg")
@@ -100,24 +78,15 @@ def setUp(self):
         self.bl = Bootloader.readGrub2("tests/data/grub.cfg")
         check_config(self.bl)
 
-    def test_grub(self):
+    def test_grub2(self):
         with NamedTemporaryFile("w", delete=False) as temp:
-            self.bl.writeGrub(temp)
-        bl2 = Bootloader.readGrub(temp.name)
+            self.bl.writeGrub2(temp)
+        bl2 = Bootloader.readGrub2(temp.name)
         # Check config from tests/data/grub.cfg:
         os.unlink(temp.name)
         assert bl2.serial == {"port": 0, "baud": 115200}
         check_config(bl2)
 
-    def test_extlinux(self):
-        with NamedTemporaryFile("w", delete=False) as temp:
-            self.bl.writeExtLinux(temp)
-        bl2 = Bootloader.readExtLinux(temp.name)
-        os.unlink(temp.name)
-        # readExtLinux tries to read flow-control (there is none in tests/data/grub.cfg):
-        assert bl2.serial == {"port": 0, "baud": 115200, "flow": None}
-        check_config(bl2)
-
 
 def check_config(bl):
     # Check config from tests/data/grub.cfg:

xcp/bootloader.py

@@ -106,200 +106,6 @@ def remove(self, label):
         del self.menu[label]
         self.menu_order.remove(label)
 
-    @classmethod
-    def readExtLinux(cls, src_file):
-        # type:(str) -> Bootloader
-        menu = {}  # type: dict[str, MenuEntry | dict[str, str]]
-        menu_order = []
-        default = None
-        timeout = None
-        location = None
-        serial = None
-        label = None
-        title = None
-        kernel = None
-
-        fh = open_textfile(src_file, "r")
-        try:
-            for line in fh:
-                l = line.strip()
-                els = l.split(None, 2)
-                if len(els) == 0:
-                    continue
-                keywrd = els[0].lower()
-
-                # header
-                if l.startswith('# location ') and len(els) == 3 and els[2] in ['mbr', 'partition']:
-                    location = els[2]
-                elif keywrd == 'serial' and len(els) > 1:
-                    baud = '9600'
-                    flow = None
-                    if len(els) > 2:
-                        if ' ' in els[2]:
-                            baud, flow = els[2].split(None, 1)
-                        else:
-                            baud = els[2]
-                    serial = {'port': int(els[1]), 'baud': int(baud), 'flow': flow}
-                elif keywrd == 'default' and len(els) == 2:
-                    default = els[1]
-                elif keywrd == 'timeout' and len(els) == 2:
-                    timeout = int(els[1])
-
-                # menu
-                elif keywrd == 'label' and len(els) == 2:
-                    label = els[1]
-                    menu[label] = {}
-                    menu_order.append(label)
-                    title = None
-                elif label:
-                    if keywrd == '#':
-                        title = l[1:].lstrip()
-                    elif keywrd == 'kernel' and len(els) > 1:
-                        kernel = els[1]
-                    elif keywrd == 'append' and len(els) > 1 and kernel == 'mboot.c32':
-                        if 'tboot' in els[1]:
-                            # els[2] contains tboot args, hypervisor,
-                            # hypervisor args, kernel,
-                            # kernel args & initrd
-                            args = [x.strip() for x in els[2].split('---')]
-                            if len(args) == 4:
-                                hypervisor = args[1].split(None, 1)
-                                kernel = args[2].split(None, 1)  # type:ignore[assignment] # mypy
-                                if len(hypervisor) == 2 and len(kernel) == 2:
-                                    menu[label] = MenuEntry(tboot = els[1],
-                                                            tboot_args = args[0],
-                                                            hypervisor = hypervisor[0],
-                                                            hypervisor_args = hypervisor[1],
-                                                            kernel = kernel[0],
-                                                            kernel_args = kernel[1],
-                                                            initrd = args[3],
-                                                            title = title)
-                        elif 'xen' in els[1]:
-                            # els[2] contains hypervisor args, kernel,
-                            # kernel args & initrd
-                            args = [x.strip() for x in els[2].split('---')]
-                            if len(args) == 3:
-                                kernel = args[1].split(None, 1)  # type:ignore[assignment] # mypy
-                                if len(kernel) == 2:
-                                    menu[label] = MenuEntry(hypervisor = els[1],
-                                                            hypervisor_args = args[0],
-                                                            kernel = kernel[0],
-                                                            kernel_args = kernel[1],
-                                                            initrd = args[2],
-                                                            title = title)
-        finally:
-            fh.close()
-
-        return cls('extlinux', src_file, menu, menu_order, default, timeout,
-                   serial, location)
-
-    @classmethod
-    def readGrub(cls, src_file):
-        # type: (str) -> Bootloader
-        menu = {}
-        menu_order = []
-        default = 0
-        timeout = None
-        location = None
-        serial = None
-        label = None
-        title = None
-        hypervisor = None
-        hypervisor_args = None
-        kernel = None
-        kernel_args = None
-
-        def create_label(title):
-            global COUNTER
-
-            if title == branding.PRODUCT_BRAND:
-                return 'xe'
-
-            if title.endswith('(Serial)'):
-                return 'xe-serial'
-            if title.endswith('Safe Mode'):
-                return 'safe'
-            if ' / ' in title:
-                if '(Serial,' in title:
-                    return 'fallback-serial'
-                else:
-                    return 'fallback'
-            COUNTER += 1
-            return "label%d" % COUNTER
-
-        fh = open_textfile(src_file, "r")
-        try:
-            for line in fh:
-                l = line.strip()
-                els = l.split(None, 2)
-                if len(els) == 0:
-                    continue
-
-                # header
-                if l.startswith('# location ') and len(els) == 3 and els[2] in ['mbr', 'partition']:
-                    location = els[2]
-                elif els[0] == 'serial' and len(els) > 1:
-                    port = 0
-                    baud = 9600
-                    for arg in l.split(None, 1)[1].split():
-                        if '=' in arg:
-                            opt, val = arg.split('=')
-                            if opt == '--unit':
-                                port = int(val)
-                            elif opt == '--speed':
-                                baud = int(val)
-                    serial = {'port': port, 'baud': baud}
-                elif els[0] == 'default' and len(els) == 2:
-                    # default is index into menu list, fixup later
-                    default = int(els[1])
-                elif els[0] == 'timeout' and len(els) == 2:
-                    timeout = int(els[1]) * 10
-
-                # menu
-                elif els[0] == 'title' and len(els) > 1:
-                    title = l.split(None, 1)[1]
-                elif title:
-                    if els[0] == 'kernel' and len(els) > 2:
-                        hypervisor, hypervisor_args = (l.split(None, 1)
-                                                       [1].split(None, 1))
-                    elif els[0] == 'module' and len(els) > 1:
-                        if kernel and hypervisor:
-                            # second module == initrd
-                            label = create_label(title)
-                            menu_order.append(label)
-                            menu[label] = MenuEntry(hypervisor = hypervisor,
-                                                    hypervisor_args = hypervisor_args,
-                                                    kernel = kernel,
-                                                    kernel_args = kernel_args,
-                                                    initrd = els[1], title = title)
-                            hypervisor = None
-                            kernel = None
-                        else:
-                            kernel, kernel_args = (l.split(None, 1)
-                                                   [1].split(None, 1))
-                    elif els[0] == 'initrd' and len(els) > 1:
-                        # not multiboot
-                        kernel = hypervisor
-                        kernel_args = hypervisor_args
-                        label = create_label(title)
-                        menu_order.append(label)
-                        menu[label] = MenuEntry(None,
-                                                None,
-                                                kernel = kernel,
-                                                kernel_args = kernel_args,
-                                                initrd = els[1], title = title)
-                        hypervisor = None
-                        hypervisor_args = None
-
-            # fixup default
-            if len(menu_order) > default:
-                default = menu_order[default]
-        finally:
-            fh.close()
-
-        return cls('grub', src_file, menu, menu_order, default,
-                   timeout, serial, location)
-
     @classmethod
     def readGrub2(cls, src_file):
         # type:(str) -> Bootloader
@@ -472,89 +278,9 @@ def loadExisting(cls, root = '/'):
             return cls.readGrub2(os.path.join(root, "boot/grub/grub.cfg"))
         elif os.path.exists(os.path.join(root, "boot/grub2/grub.cfg")):
             return cls.readGrub2(os.path.join(root, "boot/grub2/grub.cfg"))
-        elif os.path.exists(os.path.join(root, "boot/extlinux.conf")):
-            return cls.readExtLinux(os.path.join(root, "boot/extlinux.conf"))
-        elif os.path.exists(os.path.join(root, "boot/grub/menu.lst")):
-            return cls.readGrub(os.path.join(root, "boot/grub/menu.lst"))
         else:
             raise RuntimeError("No existing bootloader configuration found")
 
-    def writeExtLinux(self, dst_file = None):
-        if dst_file and hasattr(dst_file, 'name'):
-            fh = dst_file
-        else:
-            fh = open_textfile(cast(str, dst_file), "w")
-        print("# location " + self.location, file=fh)
-
-        if self.serial:
-            if self.serial.get("flow", None) is None:
-                print("serial %s %s" % (self.serial['port'],
-                                        self.serial['baud']), file=fh)
-            else:
-                print("serial %s %s %s" % (self.serial['port'],
-                                           self.serial['baud'],
-                                           self.serial['flow']), file=fh)
-        if self.default:
-            print("default " + self.default, file=fh)
-        print("prompt 1", file=fh)
-        if self.timeout:
-            print("timeout %d" % self.timeout, file=fh)
-
-        for label in self.menu_order:
-            print("\nlabel " + label, file=fh)
-            m = self.menu[label]
-            if m.title:
-                print("  # " + m.title, file=fh)
-            if m.tboot:
-                print("  kernel mboot.c32", file=fh)
-                print("  append %s %s --- %s %s --- %s %s --- %s" %
-                      (m.tboot, m.tboot_args, m.hypervisor, m.hypervisor_args,
-                       m.kernel, m.kernel_args, m.initrd), file=fh)
-            elif m.hypervisor:
-                print("  kernel mboot.c32", file=fh)
-                print("  append %s %s --- %s %s --- %s" %
-                      (m.hypervisor, m.hypervisor_args, m.kernel, m.kernel_args, m.initrd), file=fh)
-            else:
-                print("  kernel " + m.kernel, file=fh)
-                print("  append " + m.kernel_args, file=fh)
-                print("  initrd " + m.initrd, file=fh)
-        if not hasattr(dst_file, 'name'):
-            fh.close()
-
-    def writeGrub(self, dst_file = None):
-        if dst_file and hasattr(dst_file, 'name'):
-            fh = dst_file
-        else:
-            fh = open_textfile(cast(str, dst_file), "w")
-        print("# location " + self.location, file=fh)
-
-        if self.serial:
-            print("serial --unit=%s --speed=%s" %
-                  (self.serial['port'], self.serial['baud']), file=fh)
-            print("terminal --timeout=10 console serial", file=fh)
-        else:
-            print("terminal console", file=fh)
-        if self.default:
-            for i in range(len(self.menu_order)):
-                if self.menu_order[i] == self.default:
-                    print("default %d" % i, file=fh)
-                    break
-        if self.timeout:
-            print("timeout %d" % (self.timeout // 10), file=fh)
-
-        for label in self.menu_order:
-            m = self.menu[label]
-            print("\ntitle " + m.title, file=fh)
-            if m.hypervisor:
-                print("   kernel " + m.hypervisor + " " + m.hypervisor_args, file=fh)
-                print("   module " + m.kernel + " " + m.kernel_args, file=fh)
-                print("   module " + m.initrd, file=fh)
-            else:
-                print("   kernel " + m.kernel + " " + m.kernel_args, file=fh)
-                print("   initrd " + m.initrd, file=fh)
-        if not hasattr(dst_file, 'name'):
-            fh.close()
-
     def writeGrub2(self, dst_file = None):
         if dst_file and hasattr(dst_file, 'name'):
             fh = dst_file
@@ -626,12 +352,8 @@ def commit(self, dst_file = None):
         # write to temp file in final destination directory
         fd, tmp_file = tempfile.mkstemp(dir = os.path.dirname(dst_file))
 
-        if self.src_fmt == 'extlinux':
-            self.writeExtLinux(tmp_file)
-        elif self.src_fmt == 'grub':
-            self.writeGrub(tmp_file)
-        elif self.src_fmt == 'grub2':
-            self.writeGrub2(tmp_file)
+        assert self.src_fmt == 'grub2'
+        self.writeGrub2(tmp_file)
 
         # atomically replace destination file
         os.close(fd)