Skip to content

Commit

Permalink
types: move storage-related types to types/storage.py
Browse files Browse the repository at this point in the history 
Signed-off-by: Olivier Gayot <[email protected]>
  • Loading branch information
@ogayot
ogayot committed Jun 11, 2024
1 parent 8cd7362 commit 3fdb321
Show file tree
Hide file tree
Showing 6 changed files with 353 additions and 329 deletions.
2 changes: 1 addition & 1 deletion subiquity/client/controllers/filesystem.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
from subiquity.client.controller import SubiquityTuiController
from subiquity.common.filesystem import gaps
from subiquity.common.filesystem.manipulator import FilesystemManipulator
from subiquity.common.types import (
from subiquity.common.types.storage import (
GuidedCapability,
GuidedChoiceV2,
GuidedStorageResponseV2,
Expand Down
18 changes: 10 additions & 8 deletions subiquity/common/apidef.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,6 @@
AdAdminNameValidation,
AdConnectionInfo,
AdDomainNameValidation,
AddPartitionV2,
AdJoinResult,
AdPasswordValidation,
AnyStep,
Expand All @@ -35,12 +34,9 @@
CasperMd5Results,
Change,
CodecsData,
Disk,
DriversPayload,
DriversResponse,
ErrorReportRef,
GuidedChoiceV2,
GuidedStorageResponseV2,
IdentityData,
KeyboardSetting,
KeyboardSetup,
Expand All @@ -50,11 +46,9 @@
MirrorPost,
MirrorPostResponse,
MirrorSelectionFallback,
ModifyPartitionV2,
NetworkStatus,
OEMResponse,
PackageInstallState,
ReformatDisk,
RefreshStatus,
ShutdownMode,
SnapInfo,
Expand All @@ -63,8 +57,6 @@
SourceSelectionAndSetting,
SSHData,
SSHFetchIdResponse,
StorageResponse,
StorageResponseV2,
TimeZoneInfo,
UbuntuProCheckTokenAnswer,
UbuntuProGeneralInfo,
Expand All @@ -75,6 +67,16 @@
UsernameValidation,
ZdevInfo,
)
from subiquity.common.types.storage import (
AddPartitionV2,
Disk,
GuidedChoiceV2,
GuidedStorageResponseV2,
ModifyPartitionV2,
ReformatDisk,
StorageResponse,
StorageResponseV2,
)
from subiquitycore.models.network import (
BondConfig,
NetDevInfo,
Expand Down
318 changes: 0 additions & 318 deletions subiquity/common/types/__init__.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -263,324 +263,6 @@ class NetworkStatus:
wlan_support_install_state: PackageInstallState


class ProbeStatus(enum.Enum):
PROBING = enum.auto()
FAILED = enum.auto()
DONE = enum.auto()


class Bootloader(enum.Enum):
NONE = "NONE" # a system where the bootloader is external, e.g. s390x
BIOS = "BIOS" # BIOS, where the bootloader dd-ed to the start of a device
UEFI = "UEFI" # UEFI, ESPs and /boot/efi and all that (amd64 and arm64)
PREP = "PREP" # ppc64el, which puts grub on a PReP partition


@attr.s(auto_attribs=True)
class OsProber:
long: str
label: str
type: str
subpath: Optional[str] = None
version: Optional[str] = None


@attr.s(auto_attribs=True)
class Partition:
size: Optional[int] = None
number: Optional[int] = None
preserve: Optional[bool] = None
wipe: Optional[str] = None
annotations: List[str] = attr.ib(default=attr.Factory(list))
mount: Optional[str] = None
format: Optional[str] = None
# curtin's definition of partition.grub_device - in a UEFI environment,
# this is expected to be the ESP partition mounted at /boot/efi.
grub_device: Optional[bool] = None
# does this partition represent the actual boot partition for this device?
boot: Optional[bool] = None
os: Optional[OsProber] = None
offset: Optional[int] = None
estimated_min_size: Optional[int] = -1
resize: Optional[bool] = None
path: Optional[str] = None
# Was this partition mounted when the installer started?
is_in_use: bool = False


@attr.s(auto_attribs=True)
class ZFS:
volume: str
properties: Optional[dict] = None


@attr.s(auto_attribs=True)
class ZPool:
pool: str
mountpoint: str
zfses: Optional[ZFS] = None
pool_properties: Optional[dict] = None
fs_properties: Optional[dict] = None
default_features: Optional[bool] = True


class GapUsable(enum.Enum):
YES = enum.auto()
TOO_MANY_PRIMARY_PARTS = enum.auto()


@attr.s(auto_attribs=True)
class Gap:
offset: int
size: int
usable: GapUsable


@attr.s(auto_attribs=True)
class Disk:
id: str
label: str
type: str
size: int
usage_labels: List[str]
partitions: List[Union[Partition, Gap]]
ok_for_guided: bool
ptable: Optional[str]
preserve: bool
path: Optional[str]
boot_device: bool
can_be_boot_device: bool
model: Optional[str] = None
vendor: Optional[str] = None
has_in_use_partition: bool = False


class GuidedCapability(enum.Enum):
# The order listed here is the order they will be presented as options

MANUAL = enum.auto()
DIRECT = enum.auto()
LVM = enum.auto()
LVM_LUKS = enum.auto()
ZFS = enum.auto()
ZFS_LUKS_KEYSTORE = enum.auto()

CORE_BOOT_ENCRYPTED = enum.auto()
CORE_BOOT_UNENCRYPTED = enum.auto()
# These two are not valid as GuidedChoiceV2.capability:
CORE_BOOT_PREFER_ENCRYPTED = enum.auto()
CORE_BOOT_PREFER_UNENCRYPTED = enum.auto()

DD = enum.auto()

def __lt__(self, other) -> bool:
return self.value < other.value

def is_lvm(self) -> bool:
return self in [GuidedCapability.LVM, GuidedCapability.LVM_LUKS]

def is_core_boot(self) -> bool:
return self in [
GuidedCapability.CORE_BOOT_ENCRYPTED,
GuidedCapability.CORE_BOOT_UNENCRYPTED,
GuidedCapability.CORE_BOOT_PREFER_ENCRYPTED,
GuidedCapability.CORE_BOOT_PREFER_UNENCRYPTED,
]

def supports_manual_customization(self) -> bool:
# After posting this capability to guided_POST, is it possible
# for the user to customize the layout further?
return self in [
GuidedCapability.MANUAL,
GuidedCapability.DIRECT,
GuidedCapability.LVM,
GuidedCapability.LVM_LUKS,
]

def is_zfs(self) -> bool:
return self in [
GuidedCapability.ZFS,
GuidedCapability.ZFS_LUKS_KEYSTORE,
]


class GuidedDisallowedCapabilityReason(enum.Enum):
TOO_SMALL = enum.auto()
CORE_BOOT_ENCRYPTION_UNAVAILABLE = enum.auto()
NOT_UEFI = enum.auto()
THIRD_PARTY_DRIVERS = enum.auto()


@attr.s(auto_attribs=True)
class GuidedDisallowedCapability:
capability: GuidedCapability
reason: GuidedDisallowedCapabilityReason
message: Optional[str] = None


@attr.s(auto_attribs=True)
class StorageResponse:
status: ProbeStatus
error_report: Optional[ErrorReportRef] = None
bootloader: Optional[Bootloader] = None
orig_config: Optional[list] = None
config: Optional[list] = None
dasd: Optional[dict] = None
storage_version: int = 1


@attr.s(auto_attribs=True)
class StorageResponseV2:
status: ProbeStatus
error_report: Optional[ErrorReportRef] = None
disks: List[Disk] = attr.Factory(list)
# if need_root == True, there is not yet a partition mounted at "/"
need_root: Optional[bool] = None
# if need_boot == True, there is not yet a boot partition
need_boot: Optional[bool] = None
install_minimum_size: Optional[int] = None


class SizingPolicy(enum.Enum):
SCALED = enum.auto()
ALL = enum.auto()

@classmethod
def from_string(cls, value):
if value is None or value == "scaled":
return cls.SCALED
if value == "all":
return cls.ALL
raise Exception(f"Unknown SizingPolicy value {value}")


@attr.s(auto_attribs=True)
class GuidedResizeValues:
install_max: int
minimum: int
recommended: int
maximum: int


@attr.s(auto_attribs=True)
class GuidedStorageTargetReformat:
disk_id: str
allowed: List[GuidedCapability] = attr.Factory(list)
disallowed: List[GuidedDisallowedCapability] = attr.Factory(list)


@attr.s(auto_attribs=True)
class GuidedStorageTargetResize:
disk_id: str
partition_number: int
new_size: int
minimum: Optional[int]
recommended: Optional[int]
maximum: Optional[int]
allowed: List[GuidedCapability] = attr.Factory(list)
disallowed: List[GuidedDisallowedCapability] = attr.Factory(list)

@staticmethod
def from_recommendations(part, resize_vals, allowed):
return GuidedStorageTargetResize(
disk_id=part.device.id,
partition_number=part.number,
new_size=resize_vals.recommended,
minimum=resize_vals.minimum,
recommended=resize_vals.recommended,
maximum=resize_vals.maximum,
allowed=allowed,
)


@attr.s(auto_attribs=True)
class GuidedStorageTargetUseGap:
disk_id: str
gap: Gap
allowed: List[GuidedCapability] = attr.Factory(list)
disallowed: List[GuidedDisallowedCapability] = attr.Factory(list)


@attr.s(auto_attribs=True)
class GuidedStorageTargetManual:
allowed: List[GuidedCapability] = attr.Factory(lambda: [GuidedCapability.MANUAL])
disallowed: List[GuidedDisallowedCapability] = attr.Factory(list)


GuidedStorageTarget = Union[
GuidedStorageTargetReformat,
GuidedStorageTargetResize,
GuidedStorageTargetUseGap,
GuidedStorageTargetManual,
]


@attr.s(auto_attribs=True)
class RecoveryKey:
# Where to store the key in the live system.
live_location: Optional[str] = None
# Where to copy the key in the target system. /target will automatically be
# prefixed.
backup_location: Optional[str] = None

@classmethod
def from_autoinstall(
cls, config: Union[bool, Dict[str, Any]]
) -> Optional["RecoveryKey"]:
if config is False:
return None

# Recovery key with default values
if config is True:
return cls()

return cls(
backup_location=config.get("backup-location"),
live_location=config.get("live-location"),
)


@attr.s(auto_attribs=True)
class GuidedChoiceV2:
target: GuidedStorageTarget
capability: GuidedCapability

# Those two fields are only used when using LVM+LUKS
password: Optional[str] = attr.ib(default=None, repr=False)
recovery_key: Optional[RecoveryKey] = None

sizing_policy: Optional[SizingPolicy] = SizingPolicy.SCALED
reset_partition: bool = False
reset_partition_size: Optional[int] = None


@attr.s(auto_attribs=True)
class GuidedStorageResponseV2:
status: ProbeStatus
error_report: Optional[ErrorReportRef] = None
configured: Optional[GuidedChoiceV2] = None
targets: List[GuidedStorageTarget] = attr.Factory(list)


@attr.s(auto_attribs=True)
class AddPartitionV2:
disk_id: str
partition: Partition
gap: Gap


@attr.s(auto_attribs=True)
class ModifyPartitionV2:
disk_id: str
partition: Partition


@attr.s(auto_attribs=True)
class ReformatDisk:
disk_id: str
ptable: Optional[str] = None


@attr.s(auto_attribs=True)
class IdentityData:
realname: str = ""
Expand Down
Loading

0 comments on commit 3fdb321

Please sign in to comment.