Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

actions/image-partition: truncate filesystem label to maximum supported length #271

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
50 changes: 42 additions & 8 deletions actions/image_partition_action.go
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@ Yaml syntax for partitions:
- name: partition name
partlabel: partition label
fs: filesystem
fslabel: filesystem label
start: offset
end: offset
features: list of filesystem features
Expand Down Expand Up @@ -72,6 +73,12 @@ Optional properties:
- partlabel -- label for the partition in the GPT partition table. Defaults
to the `name` property of the partition. May only be used for GPT partitions.

- fslabel -- (optional) Sets the volume name (label) of the filesystem. Defaults
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- fslabel -- (optional) Sets the volume name (label) of the filesystem. Defaults
- fslabel -- label for the filesystem. Defaults

to the `name` property of the partition. The filesystem label can be up to 11
characters long for vfat, 16 characters long for ext2/3/4, 255 characters long
for btrfs, 512 characters long for hfs/hfsplus and 12 characters long for xfs.
Any longer labels will be automatically truncated.

- parttype -- set the partition type in the partition table. The string should
be in a hexadecimal format (2-characters) for msdos partition tables and GUID format
(36-characters) for GPT partition tables. For instance, "82" for msdos sets the
Expand Down Expand Up @@ -168,6 +175,7 @@ type Partition struct {
number int
Name string
PartLabel string
FSLabel string
PartType string
Start string
End string
Expand Down Expand Up @@ -305,37 +313,37 @@ func (i ImagePartitionAction) formatPartition(p *Partition, context debos.DebosC
cmdline := []string{}
switch p.FS {
case "vfat":
cmdline = append(cmdline, "mkfs.vfat", "-F32", "-n", p.Name)
cmdline = append(cmdline, "mkfs.vfat", "-F32", "-n", p.FSLabel)
case "btrfs":
// Force formatting to prevent failure in case if partition was formatted already
cmdline = append(cmdline, "mkfs.btrfs", "-L", p.Name, "-f")
cmdline = append(cmdline, "mkfs.btrfs", "-L", p.FSLabel, "-f")
if len(p.Features) > 0 {
cmdline = append(cmdline, "-O", strings.Join(p.Features, ","))
}
if len(p.FSUUID) > 0 {
cmdline = append(cmdline, "-U", p.FSUUID)
}
case "f2fs":
cmdline = append(cmdline, "mkfs.f2fs", "-l", p.Name)
cmdline = append(cmdline, "mkfs.f2fs", "-l", p.FSLabel)
if len(p.Features) > 0 {
cmdline = append(cmdline, "-O", strings.Join(p.Features, ","))
}
case "hfs":
cmdline = append(cmdline, "mkfs.hfs", "-h", "-v", p.Name)
cmdline = append(cmdline, "mkfs.hfs", "-h", "-v", p.FSLabel)
case "hfsplus":
cmdline = append(cmdline, "mkfs.hfsplus", "-v", p.Name)
cmdline = append(cmdline, "mkfs.hfsplus", "-v", p.FSLabel)
case "hfsx":
cmdline = append(cmdline, "mkfs.hfsplus", "-s", "-v", p.Name)
cmdline = append(cmdline, "mkfs.hfsplus", "-s", "-v", p.FSLabel)
// hfsx is case-insensitive hfs+, should be treated as "normal" hfs+ from now on
p.FS = "hfsplus"
case "xfs":
cmdline = append(cmdline, "mkfs.xfs", "-L", p.Name)
cmdline = append(cmdline, "mkfs.xfs", "-L", p.FSLabel)
if len(p.FSUUID) > 0 {
cmdline = append(cmdline, "-m", "uuid="+p.FSUUID)
}
case "none":
default:
cmdline = append(cmdline, fmt.Sprintf("mkfs.%s", p.FS), "-L", p.Name)
cmdline = append(cmdline, fmt.Sprintf("mkfs.%s", p.FS), "-L", p.FSLabel)
if len(p.Features) > 0 {
cmdline = append(cmdline, "-O", strings.Join(p.Features, ","))
}
Expand Down Expand Up @@ -599,6 +607,7 @@ func (i *ImagePartitionAction) Verify(context *debos.DebosContext) error {

num := 1
for idx, _ := range i.Partitions {
var maxLength int = 0
p := &i.Partitions[idx]
p.number = num
num++
Expand Down Expand Up @@ -654,6 +663,31 @@ func (i *ImagePartitionAction) Verify(context *debos.DebosContext) error {
case "":
return fmt.Errorf("Partition %s missing fs type", p.Name)
}

if p.FSLabel == "" {
p.FSLabel = p.Name
}

switch p.FS {
case "vfat":
maxLength = 11
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

also warn if someone tries to set an fslabel for an unsupported fs (but ignore none type) ? :-)

case "ext2", "ext3", "ext4":
maxLength = 16
case "btrfs":
maxLength = 255
case "f2fs":
maxLength = 512
case "hfs", "hfsplus":
maxLength = 255
case "xfs":
maxLength = 12
}

if maxLength > 0 && len(p.FSLabel) > maxLength {
truncated := p.FSLabel[0:maxLength]
log.Printf("Warning: fs label for %s '%s' is too long; truncated to '%s'", p.Name, p.FSLabel, truncated)
p.FSLabel = truncated
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why truncate rather then erroring out?

}
}

for idx, _ := range i.Mountpoints {
Expand Down