debian-forge-composer/vendor/github.com/osbuild/images/pkg/disk/filesystem.go

package disk

import (
	"encoding/json"
	"fmt"
	"math/rand"
	"reflect"

	"github.com/google/uuid"
)

type MkfsOption int

const ( // MkfsOption type enum
	MkfsVerity MkfsOption = iota // Enable fs-verity option if needed (typically for EXT4)
)

func getMkfsOptionMapping() []string {
	return []string{"verity"}
}

// String converts MkfsOption into a human readable string
func (option MkfsOption) String() string {
	return getMkfsOptionMapping()[int(option)]
}

func unmarshalHelper(data []byte, mapping []string) (int, error) {
	var stringInput string
	err := json.Unmarshal(data, &stringInput)
	if err != nil {
		return 0, err
	}
	for n, str := range mapping {
		if str == stringInput {
			return n, nil
		}
	}
	return 0, fmt.Errorf("invalid mkfsoption: %s", stringInput)
}

// UnmarshalJSON converts a JSON string into an MkfsOption
func (option *MkfsOption) UnmarshalJSON(data []byte) error {
	val, err := unmarshalHelper(data, getMkfsOptionMapping())
	if err != nil {
		return err
	}
	*option = MkfsOption(val)
	return nil
}

func (option MkfsOption) MarshalJSON() ([]byte, error) {
	return json.Marshal(getMkfsOptionMapping()[option])
}

// Filesystem related functions
type Filesystem struct {
	Type string `json:"type" yaml:"type"`

	// ID of the filesystem, vfat doesn't use traditional UUIDs, therefore this
	// is just a string.
	UUID       string `json:"uuid,omitempty" yaml:"uuid,omitempty"`
	Label      string `json:"label,omitempty" yaml:"label,omitempty"`
	Mountpoint string `json:"mountpoint,omitempty" yaml:"mountpoint,omitempty"`
	// The fourth field of fstab(5); fs_mntops
	FSTabOptions string `json:"fstab_options,omitempty" yaml:"fstab_options,omitempty"`
	// The fifth field of fstab(5); fs_freq
	FSTabFreq uint64 `json:"fstab_freq,omitempty" yaml:"fstab_freq,omitempty"`
	// The sixth field of fstab(5); fs_passno
	FSTabPassNo uint64 `json:"fstab_passno,omitempty" yaml:"fstab_passno,omitempty"`
	// Custom mkfs options
	MkfsOptions []MkfsOption `json:"mkfs_options,omitempty" yaml:"mkfs_options,omitempty"`
}

func init() {
	payloadEntityMap["filesystem"] = reflect.TypeOf(Filesystem{})
}

func (fs *Filesystem) EntityName() string {
	return "filesystem"
}

// Clone the filesystem structure
func (fs *Filesystem) Clone() Entity {
	if fs == nil {
		return nil
	}

	return &Filesystem{
		Type:         fs.Type,
		UUID:         fs.UUID,
		Label:        fs.Label,
		Mountpoint:   fs.Mountpoint,
		FSTabOptions: fs.FSTabOptions,
		FSTabFreq:    fs.FSTabFreq,
		FSTabPassNo:  fs.FSTabPassNo,
		MkfsOptions:  fs.MkfsOptions,
	}
}

func (fs *Filesystem) GetMountpoint() string {
	if fs == nil {
		return ""
	}
	return fs.Mountpoint
}

func (fs *Filesystem) GetFSFile() string {
	return fs.GetMountpoint()
}

func (fs *Filesystem) GetFSType() string {
	if fs == nil {
		return ""
	}
	return fs.Type
}

func (fs *Filesystem) GetFSSpec() FSSpec {
	if fs == nil {
		return FSSpec{}
	}
	return FSSpec{
		UUID:  fs.UUID,
		Label: fs.Label,
	}
}

func (fs *Filesystem) GetFSTabOptions() (FSTabOptions, error) {
	if fs == nil {
		return FSTabOptions{}, nil
	}
	return FSTabOptions{
		MntOps: fs.FSTabOptions,
		Freq:   fs.FSTabFreq,
		PassNo: fs.FSTabPassNo,
	}, nil
}

func (fs *Filesystem) GenUUID(rng *rand.Rand) {
	if fs.Type == "vfat" && fs.UUID == "" {
		// vfat has no uuids, it has "serial numbers" (volume IDs)
		fs.UUID = NewVolIDFromRand(rng)
		return
	}
	if fs.UUID == "" {
		fs.UUID = uuid.Must(newRandomUUIDFromReader(rng)).String()
	}
}