Add ignoreOverlays param to skip overlay for COSI (#373)

<!-- Description: Please provide a summary of the changes and the
motivation behind them. -->

For COSI generation, connectToExistingImage is called after
customization is done, so when there is overlay in the config,
fstabEntriesToMountPoints() encounters an overlay entry with source
"overlay", isn't in the fstab source types. And overlay should be
excluded from partition metadata so this PR addresses this bug by adding
ignoreOverlays param

---

### **Checklist**
- [ ] Tests added/updated
- [ ] Documentation updated (if needed)
- [ ] Code conforms to style guidelines

Signed-off-by: Elaine Zhao <[email protected]>

Author: elainezhao1

toolkit/tools/pkg/imagecustomizerlib/artifactsinputoutput.go

@@ -387,7 +387,7 @@ func prepareImageConversionData(ctx context.Context, rawImageFile string, buildD
 	[]OsPackage, [randomization.UuidSize]byte, string, *CosiBootloader, error,
 ) {
 	imageConnection, partUuidToFstabEntry, baseImageVerityMetadata, _, err := connectToExistingImage(ctx,
-		rawImageFile, buildDir, chrootDir, true, true, false)
+		rawImageFile, buildDir, chrootDir, true, true, false, false)
 	if err != nil {
 		return nil, nil, "", nil, [randomization.UuidSize]byte{}, "", nil, fmt.Errorf("%w:\n%w", ErrArtifactImageConnectionForExtraction, err)
 	}

toolkit/tools/pkg/imagecustomizerlib/customizepartitionsfilecopy.go

@@ -25,7 +25,7 @@ func customizePartitionsUsingFileCopy(ctx context.Context, buildDir string, base
 	buildImageFile string, newBuildImageFile string,
 ) (map[string]string, error) {
 	existingImageConnection, _, _, _, err := connectToExistingImage(ctx, buildImageFile, buildDir, "imageroot", false,
-		true, false)
+		true, false, false)
 	if err != nil {
 		return nil, err
 	}

toolkit/tools/pkg/imagecustomizerlib/imagecreator.go

@@ -31,7 +31,7 @@ func CustomizeImageHelperImageCreator(ctx context.Context, buildDir string, base
 	defer toolsChroot.Close(false)
 
 	imageConnection, partUuidToFstabEntry, _, _, err := connectToExistingImage(ctx, rawImageFile, toolsChrootDir,
-		toolsRootImageDir, true, false, false)
+		toolsRootImageDir, true, false, false, false)
 	if err != nil {
 		return nil, "", err
 	}

toolkit/tools/pkg/imagecustomizerlib/imagecustomizer.go

@@ -1059,7 +1059,7 @@ func customizeImageHelper(ctx context.Context, buildDir string, baseConfigPath s
 	readOnlyVerity := config.Storage.ReinitializeVerity != imagecustomizerapi.ReinitializeVerityTypeAll
 
 	imageConnection, partUuidToFstabEntry, baseImageVerityMetadata, readonlyPartUuids, err := connectToExistingImage(
-		ctx, rawImageFile, buildDir, "imageroot", true, false, readOnlyVerity)
+		ctx, rawImageFile, buildDir, "imageroot", true, false, readOnlyVerity, false)
 	if err != nil {
 		return nil, nil, nil, "", err
 	}
@@ -1105,7 +1105,7 @@ func customizeImageHelper(ctx context.Context, buildDir string, baseConfigPath s
 func collectOSInfo(ctx context.Context, buildDir string, rawImageFile string,
 ) ([]OsPackage, *CosiBootloader, error) {
 	var err error
-	imageConnection, _, _, _, err := connectToExistingImage(ctx, rawImageFile, buildDir, "imageroot", true, true, false)
+	imageConnection, _, _, _, err := connectToExistingImage(ctx, rawImageFile, buildDir, "imageroot", true, true, false, true)
 	if err != nil {
 		return nil, nil, err
 	}

toolkit/tools/pkg/imagecustomizerlib/imageutils.go

@@ -24,14 +24,14 @@ import (
 type installOSFunc func(imageChroot *safechroot.Chroot) error
 
 func connectToExistingImage(ctx context.Context, imageFilePath string, buildDir string, chrootDirName string,
-	includeDefaultMounts bool, readonly bool, readOnlyVerity bool,
+	includeDefaultMounts bool, readonly bool, readOnlyVerity bool, ignoreOverlays bool,
 ) (*imageconnection.ImageConnection, map[string]diskutils.FstabEntry, []verityDeviceMetadata, []string, error) {
 	_, span := otel.GetTracerProvider().Tracer(OtelTracerName).Start(ctx, "connect_to_existing_image")
 	defer span.End()
 	imageConnection := imageconnection.NewImageConnection()
 
 	partUuidToMountPath, verityMetadata, readonlyPartUuids, err := connectToExistingImageHelper(imageConnection,
-		imageFilePath, buildDir, chrootDirName, includeDefaultMounts, readonly, readOnlyVerity)
+		imageFilePath, buildDir, chrootDirName, includeDefaultMounts, readonly, readOnlyVerity, ignoreOverlays)
 	if err != nil {
 		imageConnection.Close()
 		return nil, nil, nil, nil, err
@@ -42,6 +42,7 @@ func connectToExistingImage(ctx context.Context, imageFilePath string, buildDir
 
 func connectToExistingImageHelper(imageConnection *imageconnection.ImageConnection, imageFilePath string,
 	buildDir string, chrootDirName string, includeDefaultMounts bool, readonly bool, readOnlyVerity bool,
+	ignoreOverlays bool,
 ) (map[string]diskutils.FstabEntry, []verityDeviceMetadata, []string, error) {
 	// Connect to image file using loopback device.
 	err := imageConnection.ConnectLoopback(imageFilePath)
@@ -65,7 +66,7 @@ func connectToExistingImageHelper(imageConnection *imageconnection.ImageConnecti
 	}
 
 	mountPoints, partUuidToFstabEntry, verityMetadata, readonlyPartUuids, err := fstabEntriesToMountPoints(fstabEntries,
-		partitions, buildDir, readonly, readOnlyVerity)
+		partitions, buildDir, readonly, readOnlyVerity, ignoreOverlays)
 	if err != nil {
 		return nil, nil, nil, fmt.Errorf("failed to find mount info for fstab file entries:\n%w", err)
 	}
@@ -259,7 +260,7 @@ func createImageBoilerplate(targetOs targetos.TargetOs, imageConnection *imageco
 		return nil, "", err
 	}
 
-	mountPoints, _, _, _, err := fstabEntriesToMountPoints(fstabEntries, diskPartitions, buildDir, false, false)
+	mountPoints, _, _, _, err := fstabEntriesToMountPoints(fstabEntries, diskPartitions, buildDir, false, false, false)
 	if err != nil {
 		return nil, "", fmt.Errorf("failed to find mount info for fstab file entries:\n%w", err)
 	}

toolkit/tools/pkg/imagecustomizerlib/liveosisobuilder.go

@@ -198,7 +198,7 @@ func createLiveOSFromRawHelper(ctx context.Context, buildDir, baseConfigPath str
 
 	logger.Log.Debugf("Connecting to raw image (%s)", rawImageFile)
 	rawImageConnection, _, _, _, err := connectToExistingImage(ctx, rawImageFile, isoBuildDir, "readonly-rootfs-mount",
-		false /*includeDefaultMounts*/, false /*readonly*/, false /*readonlyVerity*/)
+		false /*includeDefaultMounts*/, false /*readonly*/, false /*readonlyVerity*/, false /*ignoreOverlays*/)
 	if err != nil {
 		return err
 	}

toolkit/tools/pkg/imagecustomizerlib/partitionutils.go

@@ -199,7 +199,7 @@ func readFstabEntriesFromRootfs(rootfsPartition *diskutils.PartitionInfo, diskPa
 }
 
 func fstabEntriesToMountPoints(fstabEntries []diskutils.FstabEntry, diskPartitions []diskutils.PartitionInfo,
-	buildDir string, readonly bool, readOnlyVerity bool,
+	buildDir string, readonly bool, readOnlyVerity bool, ignoreOverlays bool,
 ) ([]*safechroot.MountPoint, map[string]diskutils.FstabEntry, []verityDeviceMetadata, []string, error) {
 	filteredFstabEntries := filterOutSpecialPartitions(fstabEntries)
 
@@ -210,6 +210,9 @@ func fstabEntriesToMountPoints(fstabEntries []diskutils.FstabEntry, diskPartitio
 	verityMetadataList := []verityDeviceMetadata(nil)
 	readonlyPartUuids := []string(nil)
 	for _, fstabEntry := range filteredFstabEntries {
+		if ignoreOverlays && strings.ToLower(fstabEntry.FsType) == "overlay" {
+			continue // Skip overlay entries when requested
+		}
 		_, partition, _, verityMetadata, err := findSourcePartition(fstabEntry.Source, diskPartitions, buildDir)
 		if err != nil {
 			return nil, nil, nil, nil, err