diff --git a/config/shared/errors/errors.go b/config/shared/errors/errors.go index 13742ab01..f837ff665 100644 --- a/config/shared/errors/errors.go +++ b/config/shared/errors/errors.go @@ -87,6 +87,8 @@ var ( ErrPathConflictsSystemd = errors.New("path conflicts with systemd unit or dropin") ErrCexWithClevis = errors.New("cannot use cex with clevis") ErrCexWithKeyFile = errors.New("cannot use key file with cex") + ErrBadSfdiskPretend = errors.New("sfdisk had unexpected output while pretending partition configuration on device") + ErrBadSfdiskCommit = errors.New("sfdisk had unexpected output while committing partition configuration to device") // Systemd section errors ErrInvalidSystemdExt = errors.New("invalid systemd unit extension") diff --git a/internal/distro/distro.go b/internal/distro/distro.go index e52546492..b70bb84f9 100644 --- a/internal/distro/distro.go +++ b/internal/distro/distro.go @@ -38,6 +38,7 @@ var ( mountCmd = "mount" partxCmd = "partx" sgdiskCmd = "sgdisk" + sfdiskCmd = "sfdisk" modprobeCmd = "modprobe" udevadmCmd = "udevadm" usermodCmd = "usermod" @@ -95,6 +96,7 @@ func MdadmCmd() string { return mdadmCmd } func MountCmd() string { return mountCmd } func PartxCmd() string { return partxCmd } func SgdiskCmd() string { return sgdiskCmd } +func SfdiskCmd() string { return sfdiskCmd } func ModprobeCmd() string { return modprobeCmd } func UdevadmCmd() string { return udevadmCmd } func UsermodCmd() string { return usermodCmd } diff --git a/internal/exec/stages/disks/partitions.go b/internal/exec/stages/disks/partitions.go index d867a5253..f7daf1393 100644 --- a/internal/exec/stages/disks/partitions.go +++ b/internal/exec/stages/disks/partitions.go @@ -20,12 +20,10 @@ package disks import ( "bufio" - "errors" "fmt" "os" "os/exec" "path/filepath" - "regexp" "sort" "strconv" "strings" @@ -34,13 +32,20 @@ import ( "github.com/coreos/ignition/v2/config/v3_5_experimental/types" "github.com/coreos/ignition/v2/internal/distro" "github.com/coreos/ignition/v2/internal/exec/util" - "github.com/coreos/ignition/v2/internal/sgdisk" + "github.com/coreos/ignition/v2/internal/log" + "github.com/coreos/ignition/v2/internal/partitioners" + "github.com/coreos/ignition/v2/internal/partitioners/sfdisk" + "github.com/coreos/ignition/v2/internal/partitioners/sgdisk" iutil "github.com/coreos/ignition/v2/internal/util" ) -var ( - ErrBadSgdiskOutput = errors.New("sgdisk had unexpected output") -) +func getDeviceManager(logger *log.Logger, dev string) partitioners.DeviceManager { + // To be replaced with build tag support or something similar. + if false { + return sgdisk.Begin(logger, dev) + } + return sfdisk.Begin(logger, dev) +} // createPartitions creates the partitions described in config.Storage.Disks. func (s stage) createPartitions(config types.Config) error { @@ -75,7 +80,7 @@ func (s stage) createPartitions(config types.Config) error { // partitionMatches determines if the existing partition matches the spec given. See doc/operator notes for what // what it means for an existing partition to match the spec. spec must have non-zero Start and Size. -func partitionMatches(existing util.PartitionInfo, spec sgdisk.Partition) error { +func partitionMatches(existing util.PartitionInfo, spec partitioners.Partition) error { if err := partitionMatchesCommon(existing, spec); err != nil { return err } @@ -87,13 +92,13 @@ func partitionMatches(existing util.PartitionInfo, spec sgdisk.Partition) error // partitionMatchesResize returns if the existing partition should be resized by evaluating if // `resize`field is true and partition matches in all respects except size. -func partitionMatchesResize(existing util.PartitionInfo, spec sgdisk.Partition) bool { +func partitionMatchesResize(existing util.PartitionInfo, spec partitioners.Partition) bool { return cutil.IsTrue(spec.Resize) && partitionMatchesCommon(existing, spec) == nil } // partitionMatchesCommon handles the common tests (excluding the partition size) to determine // if the existing partition matches the spec given. -func partitionMatchesCommon(existing util.PartitionInfo, spec sgdisk.Partition) error { +func partitionMatchesCommon(existing util.PartitionInfo, spec partitioners.Partition) error { if spec.Number != existing.Number { return fmt.Errorf("partition numbers did not match (specified %d, got %d). This should not happen, please file a bug.", spec.Number, existing.Number) } @@ -113,7 +118,7 @@ func partitionMatchesCommon(existing util.PartitionInfo, spec sgdisk.Partition) } // partitionShouldBeInspected returns if the partition has zeroes that need to be resolved to sectors. -func partitionShouldBeInspected(part sgdisk.Partition) bool { +func partitionShouldBeInspected(part partitioners.Partition) bool { if part.Number == 0 { return false } @@ -133,17 +138,17 @@ func convertMiBToSectors(mib *int, sectorSize int) *int64 { // getRealStartAndSize returns a map of partition numbers to a struct that contains what their real start // and end sector should be. It runs sgdisk --pretend to determine what the partitions would look like if // everything specified were to be (re)created. -func (s stage) getRealStartAndSize(dev types.Disk, devAlias string, diskInfo util.DiskInfo) ([]sgdisk.Partition, error) { - partitions := []sgdisk.Partition{} +func (s stage) getRealStartAndSize(dev types.Disk, devAlias string, diskInfo util.DiskInfo) ([]partitioners.Partition, error) { + partitions := []partitioners.Partition{} for _, cpart := range dev.Partitions { - partitions = append(partitions, sgdisk.Partition{ + partitions = append(partitions, partitioners.Partition{ Partition: cpart, StartSector: convertMiBToSectors(cpart.StartMiB, diskInfo.LogicalSectorSize), SizeInSectors: convertMiBToSectors(cpart.SizeMiB, diskInfo.LogicalSectorSize), }) } - op := sgdisk.Begin(s.Logger, devAlias) + op := getDeviceManager(s.Logger, devAlias) for _, part := range partitions { if info, exists := diskInfo.GetPartition(part.Number); exists { // delete all existing partitions @@ -176,20 +181,19 @@ func (s stage) getRealStartAndSize(dev types.Disk, devAlias string, diskInfo uti if err != nil { return nil, err } - - realDimensions, err := parseSgdiskPretend(output, partitionsToInspect) + realDimensions, err := op.ParseOutput(output, partitionsToInspect) if err != nil { return nil, err } - result := []sgdisk.Partition{} + result := []partitioners.Partition{} for _, part := range partitions { if dims, ok := realDimensions[part.Number]; ok { if part.StartSector != nil { - part.StartSector = &dims.start + part.StartSector = &dims.Start } if part.SizeInSectors != nil { - part.SizeInSectors = &dims.size + part.SizeInSectors = &dims.Size } } result = append(result, part) @@ -197,96 +201,9 @@ func (s stage) getRealStartAndSize(dev types.Disk, devAlias string, diskInfo uti return result, nil } -type sgdiskOutput struct { - start int64 - size int64 -} - -// parseLine takes a regexp that captures an int64 and a string to match on. On success it returns -// the captured int64 and nil. If the regexp does not match it returns -1 and nil. If it encountered -// an error it returns 0 and the error. -func parseLine(r *regexp.Regexp, line string) (int64, error) { - matches := r.FindStringSubmatch(line) - switch len(matches) { - case 0: - return -1, nil - case 2: - return strconv.ParseInt(matches[1], 10, 64) - default: - return 0, ErrBadSgdiskOutput - } -} - -// parseSgdiskPretend parses the output of running sgdisk pretend with --info specified for each partition -// number specified in partitionNumbers. E.g. if paritionNumbers is [1,4,5], it is expected that the sgdisk -// output was from running `sgdisk --pretend --info=1 --info=4 --info=5`. It assumes the the -// partition labels are well behaved (i.e. contain no control characters). It returns a list of partitions -// matching the partition numbers specified, but with the start and size information as determined by sgdisk. -// The partition numbers need to passed in because sgdisk includes them in its output. -func parseSgdiskPretend(sgdiskOut string, partitionNumbers []int) (map[int]sgdiskOutput, error) { - if len(partitionNumbers) == 0 { - return nil, nil - } - startRegex := regexp.MustCompile(`^First sector: (\d*) \(.*\)$`) - endRegex := regexp.MustCompile(`^Last sector: (\d*) \(.*\)$`) - const ( - START = iota - END = iota - FAIL_ON_START_END = iota - ) - - output := map[int]sgdiskOutput{} - state := START - current := sgdiskOutput{} - i := 0 - - lines := strings.Split(sgdiskOut, "\n") - for _, line := range lines { - switch state { - case START: - start, err := parseLine(startRegex, line) - if err != nil { - return nil, err - } - if start != -1 { - current.start = start - state = END - } - case END: - end, err := parseLine(endRegex, line) - if err != nil { - return nil, err - } - if end != -1 { - current.size = 1 + end - current.start - output[partitionNumbers[i]] = current - i++ - if i == len(partitionNumbers) { - state = FAIL_ON_START_END - } else { - current = sgdiskOutput{} - state = START - } - } - case FAIL_ON_START_END: - if len(startRegex.FindStringSubmatch(line)) != 0 || - len(endRegex.FindStringSubmatch(line)) != 0 { - return nil, ErrBadSgdiskOutput - } - } - } - - if state != FAIL_ON_START_END { - // We stopped parsing in the middle of a info block. Something is wrong - return nil, ErrBadSgdiskOutput - } - - return output, nil -} - // partitionShouldExist returns whether a bool is indicating if a partition should exist or not. // nil (unspecified in json) is treated the same as true. -func partitionShouldExist(part sgdisk.Partition) bool { +func partitionShouldExist(part partitioners.Partition) bool { return !cutil.IsFalse(part.ShouldExist) } @@ -438,7 +355,7 @@ func (s stage) partitionDisk(dev types.Disk, devAlias string) error { return fmt.Errorf("refusing to operate on directly active disk %q", devAlias) } if cutil.IsTrue(dev.WipeTable) { - op := sgdisk.Begin(s.Logger, devAlias) + op := getDeviceManager(s.Logger, devAlias) s.Logger.Info("wiping partition table requested on %q", devAlias) if len(activeParts) > 0 { return fmt.Errorf("refusing to wipe active disk %q", devAlias) @@ -457,7 +374,7 @@ func (s stage) partitionDisk(dev types.Disk, devAlias string) error { // Ensure all partitions with number 0 are last sort.Stable(PartitionList(dev.Partitions)) - op := sgdisk.Begin(s.Logger, devAlias) + op := getDeviceManager(s.Logger, devAlias) diskInfo, err := s.getPartitionMap(devAlias) if err != nil { diff --git a/internal/partitioners/partitioners.go b/internal/partitioners/partitioners.go new file mode 100644 index 000000000..ead517b71 --- /dev/null +++ b/internal/partitioners/partitioners.go @@ -0,0 +1,42 @@ +// Copyright 2024 Red Hat +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +package partitioners + +import ( + "github.com/coreos/ignition/v2/config/v3_5_experimental/types" +) + +type DeviceManager interface { + CreatePartition(p Partition) + DeletePartition(num int) + Info(num int) + WipeTable(wipe bool) + Pretend() (string, error) + Commit() error + ParseOutput(string, []int) (map[int]Output, error) +} + +type Partition struct { + types.Partition + StartSector *int64 + SizeInSectors *int64 + StartMiB string + SizeMiB string +} + +type Output struct { + Start int64 + Size int64 +} diff --git a/internal/partitioners/sfdisk/sfdisk.go b/internal/partitioners/sfdisk/sfdisk.go new file mode 100644 index 000000000..9c7237c89 --- /dev/null +++ b/internal/partitioners/sfdisk/sfdisk.go @@ -0,0 +1,271 @@ +// Copyright 2024 Red Hat +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +package sfdisk + +import ( + "bytes" + "fmt" + "io" + "os/exec" + "regexp" + "strconv" + "strings" + + sharedErrors "github.com/coreos/ignition/v2/config/shared/errors" + "github.com/coreos/ignition/v2/config/util" + "github.com/coreos/ignition/v2/internal/distro" + "github.com/coreos/ignition/v2/internal/log" + "github.com/coreos/ignition/v2/internal/partitioners" +) + +type Operation struct { + logger *log.Logger + dev string + wipe bool + parts []partitioners.Partition + deletions []int + infos []int +} + +// Begin begins an sfdisk operation +func Begin(logger *log.Logger, dev string) *Operation { + return &Operation{logger: logger, dev: dev} +} + +// CreatePartition adds the supplied partition to the list of partitions to be created as part of an operation +func (op *Operation) CreatePartition(p partitioners.Partition) { + op.parts = append(op.parts, p) +} + +func (op *Operation) DeletePartition(num int) { + op.deletions = append(op.deletions, num) +} + +func (op *Operation) Info(num int) { + op.infos = append(op.infos, num) +} + +// WipeTable toggles if the table is to be wiped first when committing this operation. +func (op *Operation) WipeTable(wipe bool) { + op.wipe = wipe +} + +// Pretend is like Commit() but uses the --no-act flag and returns the output +func (op *Operation) Pretend() (string, error) { + // Handle deletions first + if err := op.handleDeletions(); err != nil { + return "", err + } + + if err := op.handleInfo(); err != nil { + return "", err + } + + script := op.buildOptions() + cmd := exec.Command("sh", "-c", fmt.Sprintf("echo -e \"%s\" | sudo %s --no-act %s", script, distro.SfdiskCmd(), op.dev)) + stdout, err := cmd.StdoutPipe() + + if err != nil { + return "", err + } + stderr, err := cmd.StderrPipe() + if err != nil { + return "", err + } + + if err := cmd.Start(); err != nil { + return "", err + } + output, err := io.ReadAll(stdout) + if err != nil { + return "", err + } + + errors, err := io.ReadAll(stderr) + if err != nil { + return "", err + } + + if err := cmd.Wait(); err != nil { + return "", fmt.Errorf("failed to pretend to create partitions. Err: %v. Stderr: %v", err, string(errors)) + } + + return string(output), nil +} + +// Commit commits an partitioning operation. +func (op *Operation) Commit() error { + println("Commit: HERE") + fmt.Println(op.parts) + script := op.buildOptions() + if len(script) == 0 { + return nil + } + + // If wipe we need to reset the partition table + if op.wipe { + // Erase the existing partition tables + cmd := exec.Command(distro.WipefsCmd(), "-a", op.dev) + if _, err := op.logger.LogCmd(cmd, "option wipe selected, and failed to execute on %q", op.dev); err != nil { + return fmt.Errorf("wipe partition table failed: %v", err) + } + } + + op.runSfdisk(true) + + return nil +} + +func (op *Operation) runSfdisk(shouldWrite bool) error { + var opts []string + if !shouldWrite { + opts = append(opts, "--no-act") + } + opts = append(opts, "-X", "gpt", op.dev) + fmt.Printf("The options are %v", opts) + cmd := exec.Command(distro.SfdiskCmd(), opts...) + cmd.Stdin = strings.NewReader(op.buildOptions()) + if _, err := op.logger.LogCmd(cmd, "deleting %d partitions and creating %d partitions on %q", len(op.deletions), len(op.parts), op.dev); err != nil { + return fmt.Errorf("create partitions failed: %v", err) + } + + return nil +} + +// ParseOutput takes the output from sfdisk. Similarly to sgdisk +// it then uses regex to parse the output into understood values like 'start' 'size' and attempts +// to catch any failures and wrap them to return to the caller. +func (op *Operation) ParseOutput(sfdiskOutput string, partitionNumbers []int) (map[int]partitioners.Output, error) { + if len(partitionNumbers) == 0 { + return nil, nil + } + + // Look for new lines starting with /dev/ and the following string it + // Additionally Group on Start sector, and End sector + // Example output match would be "/dev/vda1 2048 2057 10 5K 83 Linux" + partitionRegex := regexp.MustCompile(`^/dev/\S+\s+\S*\s+(\d+)\s+(\d+)\s+\d+\s+\S+\s+\S+\s+\S+.*$`) + output := map[int]partitioners.Output{} + current := partitioners.Output{} + i := 0 + lines := strings.Split(sfdiskOutput, "\n") + for _, line := range lines { + matches := partitionRegex.FindStringSubmatch(line) + + // Sanity check number of partition entries + if i > len(partitionNumbers) { + return nil, sharedErrors.ErrBadSfdiskPretend + } + + // Verify that we are not reading a 'failed' or 'error' + errorRegex := regexp.MustCompile(`(?i)(failed|error)`) + if errorRegex.MatchString(line) { + return nil, fmt.Errorf("%w: sfdisk returned :%v", sharedErrors.ErrBadSfdiskPretend, line) + } + + // When we get a match it should be + // Whole line at [0] + // Start at [1] + // End at [2] + if len(matches) > 2 { + start, err := strconv.Atoi(matches[1]) + if err != nil { + return nil, err + } + end, err := strconv.Atoi(matches[2]) + if err != nil { + return nil, err + } + + current.Start = int64(start) + // Add one due to overlap + current.Size = int64(end - start + 1) + output[partitionNumbers[i]] = current + i++ + } + } + + return output, nil +} + +func (op Operation) buildOptions() string { + var script bytes.Buffer + + for _, p := range op.parts { + println("Starting Build Options Script Building") + + fmt.Println(p) + println(script.String()) + + if p.Number != 0 { + script.WriteString(fmt.Sprintf("%d : ", p.Number)) + } + + if p.StartSector != nil { + script.WriteString(fmt.Sprintf("start=%d ", *p.StartSector)) + + } + + if p.SizeInSectors != nil { + script.WriteString(fmt.Sprintf("size=%d ", *p.SizeInSectors)) + } + + if util.NotEmpty(p.TypeGUID) { + script.WriteString(fmt.Sprintf("type=%s ", *p.TypeGUID)) + } + + if util.NotEmpty(p.GUID) { + script.WriteString(fmt.Sprintf("uuid=%s ", *p.GUID)) + } + + if p.Label != nil { + script.WriteString(fmt.Sprintf("name=%s ", *p.Label)) + } + + // Add escaped new line to allow for 1 or more partitions + // i.e "1: size=50 \\n size=10" will result in part 1, and 2 + script.WriteString("\n") + println("here!") + println(script.String()) + + } + + return script.String() +} + +func (op *Operation) handleDeletions() error { + for _, num := range op.deletions { + cmd := exec.Command(distro.SfdiskCmd(), "--delete", op.dev, fmt.Sprintf("%d", num)) + op.logger.Info("running sfdisk to delete partition %d on %q", num, op.dev) + + if output, err := cmd.CombinedOutput(); err != nil { + return fmt.Errorf("failed to delete partition %d: %v, output: %s", num, err, output) + } + } + return nil +} + +func (op *Operation) handleInfo() error { + for _, num := range op.infos { + cmd := exec.Command(distro.SfdiskCmd(), "--list", op.dev) + op.logger.Info("retrieving information for partition %d on %q", num, op.dev) + + output, err := cmd.CombinedOutput() + if err != nil { + return fmt.Errorf("failed to retrieve partition info for %d: %v, output: %s", num, err, output) + } + op.logger.Info("partition info: %s", output) + } + return nil +} diff --git a/internal/partitioners/sfdisk/sfdisk_test.go b/internal/partitioners/sfdisk/sfdisk_test.go new file mode 100644 index 000000000..d4f040d2c --- /dev/null +++ b/internal/partitioners/sfdisk/sfdisk_test.go @@ -0,0 +1,122 @@ +// Copyright 2024 Red Hat +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +package sfdisk_test + +import ( + "errors" + "reflect" + "testing" + + internalErrors "github.com/coreos/ignition/v2/config/shared/errors" + "github.com/coreos/ignition/v2/internal/partitioners" + "github.com/coreos/ignition/v2/internal/partitioners/sfdisk" +) + +func TestPartitionParse(t *testing.T) { + // Define test cases + tests := []struct { + name string + sfdiskOut string + partitionNumbers []int + expectedOutput map[int]partitioners.Output + expectedError error + }{ + { + name: "valid input with single partition", + sfdiskOut: ` +Disk /dev/vda: 2 GiB, 2147483648 bytes, 4194304 sectors +Units: sectors of 1 * 512 = 512 bytes +Sector size (logical/physical): 512 bytes / 512 bytes +I/O size (minimum/optimal): 512 bytes / 512 bytes + +>>> Created a new DOS (MBR) disklabel with disk identifier 0x501fc254. +/dev/vda1: Created a new partition 1 of type 'Linux' and of size 5 KiB. +/dev/vda2: Done. + +New situation: +Disklabel type: dos +Disk identifier: 0x501fc254 + +Device Boot Start End Sectors Size Id Type +/dev/vda1 2048 2057 10 5K 83 Linux +The partition table is unchanged (--no-act).`, + partitionNumbers: []int{1}, + expectedOutput: map[int]partitioners.Output{ + 1: {Start: 2048, Size: 10}, + }, + expectedError: nil, + }, + { + name: "valid input with two partitions", + sfdiskOut: ` +Disk /dev/vda: 2 GiB, 2147483648 bytes, 4194304 sectors +Units: sectors of 1 * 512 = 512 bytes +Sector size (logical/physical): 512 bytes / 512 bytes +I/O size (minimum/optimal): 512 bytes / 512 bytes + +>>> Created a new DOS (MBR) disklabel with disk identifier 0x8d8dd38c. +/dev/vda1: Created a new partition 1 of type 'Linux' and of size 5 KiB. +/dev/vda2: Created a new partition 2 of type 'Linux' and of size 5 KiB. +/dev/vda3: Done. + +New situation: +Disklabel type: dos +Disk identifier: 0x8d8dd38c + +Device Boot Start End Sectors Size Id Type +/dev/vda1 2048 2057 10 5K 83 Linux +/dev/vda2 4096 4105 10 5K 83 Linux +The partition table is unchanged (--no-act).`, + partitionNumbers: []int{1, 2}, + expectedOutput: map[int]partitioners.Output{ + 1: {Start: 2048, Size: 10}, + 2: {Start: 4096, Size: 10}, + }, + expectedError: nil, + }, + { + name: "invalid input with 1 partition starting on sector 0", + sfdiskOut: ` +Disk /dev/vda: 2 GiB, 2147483648 bytes, 4194304 sectors +Units: sectors of 1 * 512 = 512 bytes +Sector size (logical/physical): 512 bytes / 512 bytes +I/O size (minimum/optimal): 512 bytes / 512 bytes + +>>> Created a new DOS (MBR) disklabel with disk identifier 0xdebbe997. +/dev/vda1: Start sector 0 out of range. +Failed to add #1 partition: Numerical result out of range +Leaving. +`, + partitionNumbers: []int{1}, + expectedOutput: map[int]partitioners.Output{ + 1: {Start: 0, Size: 0}, + }, + expectedError: internalErrors.ErrBadSfdiskPretend, + }, + } + op := sfdisk.Begin(nil, "") + for i, tt := range tests { + t.Run(tt.name, func(t *testing.T) { + output, err := op.ParseOutput(tt.sfdiskOut, tt.partitionNumbers) + if tt.expectedError != nil { + if !errors.Is(err, tt.expectedError) { + t.Errorf("#%d: bad error: result = %v, expected = %v", i, err, tt.expectedError) + } + } else if !reflect.DeepEqual(output, tt.expectedOutput) { + t.Errorf("#%d: result = %v, expected = %v", i, output, tt.expectedOutput) + } + }) + } +} diff --git a/internal/sgdisk/sgdisk.go b/internal/partitioners/sgdisk/sgdisk.go similarity index 57% rename from internal/sgdisk/sgdisk.go rename to internal/partitioners/sgdisk/sgdisk.go index 299158098..dd93c0c59 100644 --- a/internal/sgdisk/sgdisk.go +++ b/internal/partitioners/sgdisk/sgdisk.go @@ -15,44 +15,40 @@ package sgdisk import ( + "errors" "fmt" "io" "os/exec" + "regexp" + "strconv" + "strings" "github.com/coreos/ignition/v2/config/util" - "github.com/coreos/ignition/v2/config/v3_5_experimental/types" "github.com/coreos/ignition/v2/internal/distro" "github.com/coreos/ignition/v2/internal/log" + "github.com/coreos/ignition/v2/internal/partitioners" +) + +var ( + ErrBadSgdiskOutput = errors.New("sgdisk had unexpected output") ) type Operation struct { logger *log.Logger dev string wipe bool - parts []Partition + parts []partitioners.Partition deletions []int infos []int } -// We ignore types.Partition.StartMiB/SizeMiB in favor of -// StartSector/SizeInSectors. The caller is expected to do the conversion. -type Partition struct { - types.Partition - StartSector *int64 - SizeInSectors *int64 - - // shadow StartMiB/SizeMiB so they're not accidentally used - StartMiB string - SizeMiB string -} - // Begin begins an sgdisk operation func Begin(logger *log.Logger, dev string) *Operation { return &Operation{logger: logger, dev: dev} } // CreatePartition adds the supplied partition to the list of partitions to be created as part of an operation. -func (op *Operation) CreatePartition(p Partition) { +func (op *Operation) CreatePartition(p partitioners.Partition) { op.parts = append(op.parts, p) } @@ -104,7 +100,7 @@ func (op *Operation) Pretend() (string, error) { } if err := cmd.Wait(); err != nil { - return "", fmt.Errorf("Failed to pretend to create partitions. Err: %v. Stderr: %v", err, string(errors)) + return "", fmt.Errorf("failed to pretend to create partitions. Err: %v. Stderr: %v", err, string(errors)) } return string(output), nil @@ -125,6 +121,88 @@ func (op *Operation) Commit() error { return nil } +// ParseOutput parses the output of running sgdisk pretend with --info specified for each partition +// number specified in partitionNumbers. E.g. if paritionNumbers is [1,4,5], it is expected that the sgdisk +// output was from running `sgdisk --pretend --info=1 --info=4 --info=5`. It assumes the the +// partition labels are well behaved (i.e. contain no control characters). It returns a list of partitions +// matching the partition numbers specified, but with the start and size information as determined by sgdisk. +// The partition numbers need to passed in because sgdisk includes them in its output. +func (op *Operation) ParseOutput(sgdiskOutput string, partitionNumbers []int) (map[int]partitioners.Output, error) { + if len(partitionNumbers) == 0 { + return nil, nil + } + startRegex := regexp.MustCompile(`^First sector: (\d*) \(.*\)$`) + endRegex := regexp.MustCompile(`^Last sector: (\d*) \(.*\)$`) + const ( + START = iota + END = iota + FAIL_ON_START_END = iota + ) + + output := map[int]partitioners.Output{} + state := START + current := partitioners.Output{} + i := 0 + + lines := strings.Split(sgdiskOutput, "\n") + for _, line := range lines { + switch state { + case START: + start, err := parseLine(startRegex, line) + if err != nil { + return nil, err + } + if start != -1 { + current.Start = start + state = END + } + case END: + end, err := parseLine(endRegex, line) + if err != nil { + return nil, err + } + if end != -1 { + current.Size = 1 + end - current.Start + output[partitionNumbers[i]] = current + i++ + if i == len(partitionNumbers) { + state = FAIL_ON_START_END + } else { + current = partitioners.Output{} + state = START + } + } + case FAIL_ON_START_END: + if len(startRegex.FindStringSubmatch(line)) != 0 || + len(endRegex.FindStringSubmatch(line)) != 0 { + return nil, ErrBadSgdiskOutput + } + } + } + + if state != FAIL_ON_START_END { + // We stopped parsing in the middle of a info block. Something is wrong + return nil, ErrBadSgdiskOutput + } + + return output, nil +} + +// parseLine takes a regexp that captures an int64 and a string to match on. On success it returns +// the captured int64 and nil. If the regexp does not match it returns -1 and nil. If it encountered +// an error it returns 0 and the error. +func parseLine(r *regexp.Regexp, line string) (int64, error) { + matches := r.FindStringSubmatch(line) + switch len(matches) { + case 0: + return -1, nil + case 2: + return strconv.ParseInt(matches[1], 10, 64) + default: + return 0, ErrBadSgdiskOutput + } +} + func (op Operation) buildOptions() []string { opts := []string{} @@ -162,14 +240,14 @@ func (op Operation) buildOptions() []string { return opts } -func partitionGetStart(p Partition) string { +func partitionGetStart(p partitioners.Partition) string { if p.StartSector != nil { return fmt.Sprintf("%d", *p.StartSector) } return "0" } -func partitionGetSize(p Partition) string { +func partitionGetSize(p partitioners.Partition) string { if p.SizeInSectors != nil { return fmt.Sprintf("%d", *p.SizeInSectors) }