Merge pull request #2978 from OSInside/fix_bootloader_setup_with_custom_partitions

Fix bootloader setup with custom partitions

Author: Conan-Kudo

build-tests/x86/tumbleweed/test-image-partitions-and-volumes/appliance.kiwi

@@ -17,7 +17,7 @@
         <bootsplash-theme>breeze</bootsplash-theme>
         <bootloader-theme>openSUSE</bootloader-theme>
         <type image="oem" bootpartition="false" filesystem="xfs" kernelcmdline="console=ttyS0" firmware="uefi" format="qcow2">
-            <size unit="G">5</size>
+            <size unit="G">10</size>
             <oemconfig>
                 <oem-swap>true</oem-swap>
                 <oem-swapsize>512</oem-swapsize>
@@ -26,6 +26,7 @@
             <bootloader name="grub2" console="serial" timeout="10"/>
             <partitions>
                 <partition name="var" size="1G" mountpoint="/var" filesystem="ext3"/>
+                <partition name="usr" size="5G" mountpoint="/usr" filesystem="btrfs"/>
             </partitions>
             <systemdisk>
                 <volume name="home" freespace="all"/>

kiwi/bootloader/config/base.py

@@ -53,6 +53,7 @@ def __init__(self, xml_state, root_dir, boot_dir=None, custom_args={}):
 
         self.system_is_mounted = False
         self.volumes_mount = []
+        self.partitions_mount = []
         self.root_mount = None
         self.boot_mount = None
         self.efi_mount = None
@@ -495,8 +496,8 @@ def get_gfxmode(self, target):
             return gfxmode
 
     def _mount_system(
-        self, root_device, boot_device, efi_device=None,
-        volumes=None, root_volume_name=None
+        self, device_map, root_device, boot_device, efi_device=None,
+        volumes=None, root_volume_name=None, partitions=None
     ):
         self.root_mount = MountManager(
             device=root_device
@@ -538,6 +539,19 @@ def _mount_system(
                     options=[volumes[volume_path]['volume_options']]
                 )
 
+        if partitions:
+            for map_name in sorted(partitions.keys()):
+                if map_name in device_map:
+                    partition_mount = MountManager(
+                        device=device_map[map_name].get_device(),
+                        mountpoint=os.path.join(
+                            self.root_mount.mountpoint,
+                            partitions[map_name].mountpoint.lstrip(os.sep)
+                        )
+                    )
+                    self.partitions_mount.append(partition_mount)
+                    partition_mount.mount()
+
         if efi_device:
             self.efi_mount.mount()
 
@@ -590,6 +604,8 @@ def _umount_system(self):
                 self.boot_mount.umount()
             for volume_mount in reversed(self.volumes_mount):
                 volume_mount.umount()
+            for partition_mount in reversed(self.partitions_mount):
+                partition_mount.umount()
             if self.device_mount:
                 self.device_mount.umount()
             if self.proc_mount:

kiwi/bootloader/config/grub2.py

@@ -270,15 +270,19 @@ def setup_disk_image_config(
                 'system_volumes':
                     volume_manager_instance.get_volumes(),
                 'system_root_volume':
-                    volume_manager_instance.get_root_volume_name()
+                    volume_manager_instance.get_root_volume_name(),
+                'system_partitions':
+                    xml_state.get_partitions()
             }
         """
         self._mount_system(
+            boot_options.get('device_map'),
             boot_options.get('root_device'),
             boot_options.get('boot_device'),
             boot_options.get('efi_device'),
             boot_options.get('system_volumes'),
-            boot_options.get('system_root_volume')
+            boot_options.get('system_root_volume'),
+            boot_options.get('system_partitions')
         )
         config_file = os.sep.join(
             [

kiwi/bootloader/config/systemd_boot.py

@@ -75,10 +75,13 @@ def setup_loader(self, target: str) -> None:
             )
         boot_options = self.custom_args['boot_options']
         self._mount_system(
+            boot_options.get('device_map'),
             boot_options.get('root_device'),
             boot_options.get('boot_device'),
             boot_options.get('efi_device'),
-            boot_options.get('system_volumes')
+            boot_options.get('system_volumes'),
+            boot_options.get('system_root_volume'),
+            boot_options.get('system_partitions')
         )
         dracut_setup = self.xml_state.get_dracut_config('setup')
         self._run_bootctl(self.root_mount.mountpoint)

kiwi/bootloader/config/zipl.py

@@ -65,11 +65,13 @@ def setup_loader(self, target: str) -> None:
         boot_path = self.get_boot_path()
         boot_options = self.custom_args['boot_options']
         self._mount_system(
+            boot_options.get('device_map'),
             boot_options.get('root_device'),
             boot_options.get('boot_device'),
             boot_options.get('efi_device'),
             boot_options.get('system_volumes'),
-            boot_options.get('system_root_volume')
+            boot_options.get('system_root_volume'),
+            boot_options.get('system_partitions')
         )
         root_dir = self.root_mount.mountpoint
         kernel_info = BootImageBase(

kiwi/bootloader/install/grub2.py

@@ -71,12 +71,18 @@ def post_init(self, custom_args):
         self.root_mount = None
         self.sysfs_mount = None
         self.volumes = None
+        self.partitions = None
         self.root_volume_name = None
         self.target_removable = None
+        self.device_map = None
         if custom_args and 'target_removable' in custom_args:
             self.target_removable = custom_args['target_removable']
         if custom_args and 'system_volumes' in custom_args:
             self.volumes = custom_args['system_volumes']
+        if custom_args and 'system_partitions' in custom_args:
+            self.partitions = custom_args['system_partitions']
+        if custom_args and 'device_map' in custom_args:
+            self.device_map = custom_args['device_map']
         if custom_args and 'system_root_volume' in custom_args:
             self.root_volume_name = custom_args['system_root_volume']
         if custom_args and 'firmware' in custom_args:
@@ -358,6 +364,18 @@ def _mount_device_and_volumes(self, stack: ExitStack):
                 volume_mount.mount(
                     options=[self.volumes[volume_path]['volume_options']]
                 )
+        if self.partitions:
+            for map_name in sorted(self.partitions.keys()):
+                if map_name in self.device_map:
+                    partition_mount = MountManager(
+                        device=self.device_map[map_name].get_device(),
+                        mountpoint=os.path.join(
+                            self.root_mount.mountpoint,
+                            self.partitions[map_name].mountpoint.lstrip(os.sep)
+                        )
+                    )
+                    stack.push(partition_mount)
+                    partition_mount.mount()
         device_mount = MountManager(
             device='/dev',
             mountpoint=self.root_mount.mountpoint + '/dev'

kiwi/builder/disk.py

@@ -1942,6 +1942,7 @@ def _install_bootloader(
             boot_device = device_map['boot']
 
         custom_install_arguments = {
+            'device_map': device_map,
             'boot_image': boot_image,
             'boot_device': boot_device.get_device(),
             'root_device':
@@ -1976,6 +1977,11 @@ def _install_bootloader(
                 }
             )
 
+        if system and self.custom_partitions:
+            custom_install_arguments.update(
+                {'system_partitions': self.custom_partitions}
+            )
+
         # create bootloader config prior bootloader installation
         try:
             bootloader_config.setup_disk_image_config(

test/unit/bootloader/config/base_test.py

@@ -11,6 +11,8 @@
 from kiwi.xml_description import XMLDescription
 from kiwi.exceptions import KiwiBootLoaderTargetError
 from kiwi.bootloader.config.base import BootLoaderConfigBase
+from kiwi.storage.mapped_device import MappedDevice
+from kiwi.storage.disk import ptable_entry_type
 
 
 class BootLoaderConfigTestImpl(BootLoaderConfigBase):
@@ -360,7 +362,7 @@ def mount_managers_effect(**args):
 
         mock_MountManager.side_effect = mount_managers_effect
         self.bootloader._mount_system(
-            'rootdev', 'bootdev'
+            {}, 'rootdev', 'bootdev'
         )
         assert mock_MountManager.call_args_list == [
             call(device='rootdev'),
@@ -392,10 +394,11 @@ def test_mount_system(
         efi_mount = MagicMock()
         efi_mount.device = 'efidev'
         volume_mount = MagicMock()
+        partition_mount = MagicMock()
 
         mount_managers = [
             proc_mount, sys_mount, dev_mount, tmp_mount, etc_kernel_mount,
-            volume_mount, efi_mount, boot_mount, root_mount
+            partition_mount, volume_mount, efi_mount, boot_mount, root_mount
         ]
 
         def mount_managers_effect(**args):
@@ -406,18 +409,38 @@ def mount_managers_effect(**args):
         with BootLoaderConfigTestImpl(self.state, 'root_dir') as bootloader:
             bootloader.root_filesystem_is_overlay = True
             bootloader._mount_system(
-                'rootdev', 'bootdev', 'efidev', {
+                {
+                    'var': MappedDevice('/dev/var-device', Mock())
+                },
+                'rootdev',
+                'bootdev',
+                'efidev',
+                {
                     'boot/grub2': {
                         'volume_options': 'subvol=@/boot/grub2',
                         'volume_device': 'device'
                     }
-                }, root_volume_name='root'
+                },
+                'root',
+                {
+                    'var': ptable_entry_type(
+                        mbsize=100,
+                        clone=1,
+                        partition_name='p.lxvar',
+                        partition_type='t.linux',
+                        partition_id=None,
+                        mountpoint='/var',
+                        filesystem='ext3',
+                        label='var'
+                    )
+                }
             )
             assert mock_MountManager.call_args_list == [
                 call(device='rootdev'),
                 call(device='bootdev', mountpoint='root_mount_point/boot'),
                 call(device='efidev', mountpoint='root_mount_point/boot/efi'),
                 call(device='device', mountpoint='root_mount_point/boot/grub2'),
+                call(device='/dev/var-device', mountpoint='root_mount_point/var'),
                 call(device='/tmp', mountpoint='root_mount_point/tmp'),
                 call(device='efidev', mountpoint='root_mount_point/etc/kernel'),
                 call(device='/dev', mountpoint='root_mount_point/dev'),
@@ -429,6 +452,7 @@ def mount_managers_effect(**args):
             )
             boot_mount.mount.assert_called_once_with()
             efi_mount.mount.assert_called_once_with()
+            partition_mount.mount.assert_called_once_with()
             volume_mount.mount.assert_called_once_with(
                 options=['subvol=@/boot/grub2']
             )

test/unit/bootloader/config/grub2_test.py

@@ -1231,7 +1231,7 @@ def open_file(filename, mode=None):
                 }
             )
             mock_mount_system.assert_called_once_with(
-                'rootdev', 'bootdev', None, None, None
+                None, 'rootdev', 'bootdev', None, None, None, None
             )
             os.environ.update({'GRUB_DISABLE_OS_PROBER': 'true'})
             assert mock_Command_run.call_args_list == [

test/unit/bootloader/install/grub2_test.py

@@ -5,6 +5,8 @@
 from pytest import raises
 import unittest.mock as mock
 
+from kiwi.storage.mapped_device import MappedDevice
+from kiwi.storage.disk import ptable_entry_type
 from kiwi.bootloader.install.grub2 import BootLoaderInstallGrub2
 from kiwi.defaults import Defaults
 
@@ -17,24 +19,43 @@
 
 
 class TestBootLoaderInstallGrub2:
-    def setup(self):
+    @patch('os.path.exists')
+    def setup(self, mock_os_path_exists):
+        mock_os_path_exists.return_value = True
         Defaults.set_platform_name('x86_64')
 
         self.firmware = mock.Mock()
         self.firmware.efi_mode = mock.Mock(
             return_value=None
         )
-
+        self.device_map = {
+            'var': MappedDevice('/dev/var-device', Mock())
+        }
         self.custom_args = {
+            'device_map': self.device_map,
             'boot_device': '/dev/mapper/loop0p2',
             'root_device': '/dev/mapper/loop0p1',
             'efi_device': '/dev/mapper/loop0p3',
             'prep_device': '/dev/mapper/loop0p2',
             'system_root_volume': 'root',
-            'system_volumes': {'boot/grub2': {
-                'volume_options': 'subvol=@/boot/grub2',
-                'volume_device': 'device'
-            }},
+            'system_volumes': {
+                'boot/grub2': {
+                    'volume_options': 'subvol=@/boot/grub2',
+                    'volume_device': 'device'
+                }
+            },
+            'system_partitions': {
+                'var': ptable_entry_type(
+                    mbsize=100,
+                    clone=1,
+                    partition_name='p.lxvar',
+                    partition_type='t.linux',
+                    partition_id=None,
+                    mountpoint='/var',
+                    filesystem='ext3',
+                    label='var'
+                )
+            },
             'firmware': self.firmware,
             'target_removable': None,
             'install_options': [],
@@ -49,6 +70,10 @@ def setup(self):
         self.volume_mount.device = self.custom_args['root_device']
         self.volume_mount.mountpoint = 'tmp_volume'
 
+        self.partition_mount = mock.Mock()
+        self.partition_mount.device = self.custom_args['root_device']
+        self.partition_mount.mountpoint = 'tmp_partition'
+
         self.boot_mount = mock.Mock()
         self.boot_mount.device = self.custom_args['boot_device']
         self.boot_mount.mountpoint = 'tmp_boot'
@@ -74,6 +99,7 @@ def setup(self):
             self.sysfs_mount,
             self.proc_mount,
             self.device_mount,
+            self.partition_mount,
             self.volume_mount,
             self.efi_mount,
             self.boot_mount,
@@ -357,6 +383,7 @@ def side_effect(device, mountpoint=None):
         self.root_mount.mount.assert_called_once_with(
             options=['subvol=root']
         )
+        self.partition_mount.mount.assert_called_once_with()
         self.volume_mount.mount.assert_called_once_with(
             options=['subvol=@/boot/grub2']
         )
@@ -421,6 +448,7 @@ def side_effect(device, mountpoint=None):
         self.root_mount.mount.assert_called_once_with(
             options=['subvol=root']
         )
+        self.partition_mount.mount.assert_called_once_with()
         self.volume_mount.mount.assert_called_once_with(
             options=['subvol=@/boot/grub2']
         )
@@ -446,6 +474,7 @@ def side_effect(device, mountpoint=None):
         self.root_mount.mount.assert_called_once_with(
             options=['subvol=root']
         )
+        self.partition_mount.mount.assert_called_once_with()
         self.volume_mount.mount.assert_called_once_with(
             options=['subvol=@/boot/grub2']
         )