Advanced partitioning customizations (COMPOSER-2355)

pkg/blueprint/customizations.go

@@ -20,6 +20,7 @@ type Customizations struct {
 	Firewall           *FirewallCustomization         `json:"firewall,omitempty" toml:"firewall,omitempty"`
 	Services           *ServicesCustomization         `json:"services,omitempty" toml:"services,omitempty"`
 	Filesystem         []FilesystemCustomization      `json:"filesystem,omitempty" toml:"filesystem,omitempty"`
+	Partitioning       *PartitioningCustomization     `json:"partitioning,omitempty" toml:"partitioning,omitempty"`
 	InstallationDevice string                         `json:"installation_device,omitempty" toml:"installation_device,omitempty"`
 	FDO                *FDOCustomization              `json:"fdo,omitempty" toml:"fdo,omitempty"`
 	OpenSCAP           *OpenSCAPCustomization         `json:"openscap,omitempty" toml:"openscap,omitempty"`

pkg/blueprint/filesystem_customizations.go

@@ -9,9 +9,60 @@ import (
 	"github.com/osbuild/images/pkg/pathpolicy"
 )
 
+// TODO: validate input:
+// - Duplicate mountpoints
+// - No mixing of btrfs and LVM
+// - Only one swap partition or file
+
+type PartitioningCustomization struct {
+	MinSize uint64                        `json:"minsize,omitempty" toml:"minsize,omitempty"`
+	Plain   *PlainFilesystemCustomization `json:"plain,omitempty" toml:"plain,omitempty"`
+	LVM     *LVMCustomization             `json:"lvm,omitempty" toml:"lvm,omitempty"`
+	Btrfs   *BtrfsCustomization           `json:"btrfs,omitempty" toml:"btrfs,omitempty"`
+}
+
+type PlainFilesystemCustomization struct {
+	Filesystems []FilesystemCustomization `json:"filesystems,omitempty" toml:"filesystems,omitempty"`
+}
+
 type FilesystemCustomization struct {
-	Mountpoint string `json:"mountpoint,omitempty" toml:"mountpoint,omitempty"`
+	Mountpoint string `json:"mountpoint" toml:"mountpoint"`
 	MinSize    uint64 `json:"minsize,omitempty" toml:"minsize,omitempty"`
+	Label      string `json:"label,omitempty" toml:"label,omitempty"`
+	Type       string `json:"type,omitempty" toml:"type,omitempty"`
+}
+
+type LVMCustomization struct {
+	VolumeGroups []VGCustomization `json:"volume_groups,omitempty" toml:"volume_groups,omitempty"`
+}
+
+type VGCustomization struct {
+	// Volume group name
+	Name string `json:"name" toml:"name"`
+	// Size of the partition that contains the volume group
+	MinSize        uint64            `json:"minsize" toml:"minsize"`
+	LogicalVolumes []LVCustomization `json:"logical_volumes,omitempty" toml:"logical_volumes,omitempty"`
+}
+
+type LVCustomization struct {
+	// Logical volume name
+	Name string `json:"name,omitempty" toml:"name,omitempty"`
+	FilesystemCustomization
+}
+
+type BtrfsCustomization struct {
+	Volumes []BtrfsVolumeCustomization
+}
+
+type BtrfsVolumeCustomization struct {
+	// Size of the btrfs partition/volume.
+	MinSize    uint64 `json:"minsize" toml:"minsize"`
+	Subvolumes []BtrfsSubvolumeCustomization
+}
+
+type BtrfsSubvolumeCustomization struct {
+	Name       string `json:"name" toml:"name"`
+	Mountpoint string `json:"mountpoint" toml:"mountpoint"`
 }
 
 func (fsc *FilesystemCustomization) UnmarshalTOML(data interface{}) error {
@@ -24,6 +75,24 @@ func (fsc *FilesystemCustomization) UnmarshalTOML(data interface{}) error {
 		return fmt.Errorf("TOML unmarshal: mountpoint must be string, got %v of type %T", d["mountpoint"], d["mountpoint"])
 	}
 
+	switch d["type"].(type) {
+	case nil:
+		// empty allowed
+	case string:
+		fsc.Type = d["type"].(string)
+	default:
+		return fmt.Errorf("TOML unmarshal: type must be string, got %v of type %T", d["type"], d["type"])
+	}
+
+	switch d["label"].(type) {
+	case nil:
+		// empty allowed
+	case string:
+		fsc.Label = d["label"].(string)
+	default:
+		return fmt.Errorf("TOML unmarshal: label must be string, got %v of type %T", d["label"], d["label"])
+	}
+
 	switch d["minsize"].(type) {
 	case int64:
 		fsc.MinSize = uint64(d["minsize"].(int64))
@@ -54,6 +123,24 @@ func (fsc *FilesystemCustomization) UnmarshalJSON(data []byte) error {
 		return fmt.Errorf("JSON unmarshal: mountpoint must be string, got %v of type %T", d["mountpoint"], d["mountpoint"])
 	}
 
+	switch d["type"].(type) {
+	case nil:
+		// empty allowed
+	case string:
+		fsc.Type = d["type"].(string)
+	default:
+		return fmt.Errorf("JSON unmarshal: type must be string, got %v of type %T", d["type"], d["type"])
+	}
+
+	switch d["label"].(type) {
+	case nil:
+		// empty allowed
+	case string:
+		fsc.Label = d["label"].(string)
+	default:
+		return fmt.Errorf("JSON unmarshal: label must be string, got %v of type %T", d["label"], d["label"])
+	}
+
 	// The JSON specification only mentions float64 and Go defaults to it: https://go.dev/blog/json
 	switch d["minsize"].(type) {
 	case float64:

pkg/blueprint/filesystem_customizations_test.go

@@ -15,6 +15,8 @@ import (
 var allFieldsFsc = blueprint.FilesystemCustomization{
 	Mountpoint: "/data",
 	MinSize:    1234567890,
+	Label:      "data",
+	Type:       "xfs",
 }
 
 func TestFilesystemCustomizationMarshalUnmarshalTOML(t *testing.T) {
@@ -61,6 +63,16 @@ func TestFilesystemCustomizationUnmarshalTOMLUnhappy(t *testing.T) {
 			minsize = "20 KG"`,
 			err: "toml: line 0: TOML unmarshal: minsize is not valid filesystem size (unknown data size units in string: 20 KG)",
 		},
+		{
+			name:  "label not string",
+			input: "label=13\nmountpoint=\"/\"",
+			err:   "toml: line 0: TOML unmarshal: label must be string, got 13 of type int64",
+		},
+		{
+			name:  "fstype not string",
+			input: "type=true\nmountpoint=\"/\"",
+			err:   "toml: line 0: TOML unmarshal: type must be string, got true of type bool",
+		},
 	}
 
 	for _, c := range cases {
@@ -93,6 +105,16 @@ func TestFilesystemCustomizationUnmarshalJSONUnhappy(t *testing.T) {
 			input: `{ "mountpoint": "/", "minsize": "20 KG"}`,
 			err:   "JSON unmarshal: minsize is not valid filesystem size (unknown data size units in string: 20 KG)",
 		},
+		{
+			name:  "label not string",
+			input: `{ "mountpoint": "/", "label": 13}`,
+			err:   "JSON unmarshal: label must be string, got 13 of type float64",
+		},
+		{
+			name:  "type not string",
+			input: `{ "mountpoint": "/", "type": true}`,
+			err:   "JSON unmarshal: type must be string, got true of type bool",
+		},
 	}
 
 	for _, c := range cases {

pkg/disk/disk.go

@@ -19,6 +19,7 @@ package disk
 
 import (
 	"encoding/hex"
+	"fmt"
 	"io"
 	"math/rand"
 	"reflect"
@@ -58,6 +59,54 @@ const (
 	XBootLDRPartitionGUID = "BC13C2FF-59E6-4262-A352-B275FD6F7172"
 )
 
+// FSType is the filesystem type enum.
+//
+// There should always be one value for each filesystem type supported by
+// osbuild stages (stages/org.osbuild.mkfs.*) and the unset/none value.
+type FSType uint64
+
+const (
+	FS_NONE FSType = iota
+	FS_VFAT
+	FS_EXT4
+	FS_XFS
+	FS_BTRFS
+)
+
+func (f FSType) String() string {
+	switch f {
+	case FS_NONE:
+		return ""
+	case FS_VFAT:
+		return "vfat"
+	case FS_EXT4:
+		return "ext4"
+	case FS_XFS:
+		return "xfs"
+	case FS_BTRFS:
+		return "btrfs"
+	default:
+		panic(fmt.Sprintf("unknown or unsupported filesystem type with enum value %d", f))
+	}
+}
+
+func FSTypeFromString(s string) (FSType, error) {
+	switch s {
+	case "":
+		return FS_NONE, nil
+	case "vfat":
+		return FS_VFAT, nil
+	case "ext4":
+		return FS_EXT4, nil
+	case "xfs":
+		return FS_XFS, nil
+	case "btrfs":
+		return FS_BTRFS, nil
+	default:
+		return FS_NONE, fmt.Errorf("unknown or unsupported filesystem type name: %s", s)
+	}
+}
+
 // Entity is the base interface for all disk-related entities.
 type Entity interface {
 	// Clone returns a deep copy of the entity.