Add osPackages field in metadata for COSI 1.1 (#257)

<!-- Description: Please provide a summary of the changes and the
motivation behind them. -->
---
This is P1 for COSI 1.1 support (bootloader related will be P2)

changes:

- updated doc (referenced from trident cosi 1.1 revision doc)
- updated metadata to include the new field
- updated couple field names (verityConfig, FileSystem) to match the
updated cosi 1.1 schema

tested locally

![image](https://github.com/user-attachments/assets/4cbfaed1-4d83-475a-a37b-542bf6339491)


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

Author: elainezhao1

docs/imagecustomizer/api/cosi.md

@@ -10,16 +10,18 @@ import (
 	"path"
 	"path/filepath"
 	"runtime"
+	"strings"
 
 	"github.com/microsoft/azurelinux/toolkit/tools/imagegen/diskutils"
 	"github.com/microsoft/azurelinux/toolkit/tools/internal/logger"
 	"github.com/microsoft/azurelinux/toolkit/tools/internal/safeloopback"
+	"github.com/microsoft/azurelinux/toolkit/tools/internal/shell"
 )
 
 type ImageBuildData struct {
 	Source       string
 	KnownInfo    outputPartitionMetadata
-	Metadata     *Image
+	Metadata     *FileSystem
 	VeritySource string
 }
 
@@ -48,7 +50,7 @@ func convertToCosi(ic *ImageCustomizerParameters) error {
 	}
 
 	err = buildCosiFile(outputDir, ic.outputImageFile, partitionMetadataOutput, ic.verityMetadata,
-		ic.partUuidToFstabEntry, ic.imageUuidStr, ic.osRelease)
+		ic.partUuidToFstabEntry, ic.imageUuidStr, ic.osRelease, ic.osPackages)
 	if err != nil {
 		return fmt.Errorf("failed to build COSI file:\n%w", err)
 	}
@@ -65,7 +67,7 @@ func convertToCosi(ic *ImageCustomizerParameters) error {
 
 func buildCosiFile(sourceDir string, outputFile string, partitions []outputPartitionMetadata,
 	verityMetadata []verityDeviceMetadata, partUuidToFstabEntry map[string]diskutils.FstabEntry,
-	imageUuidStr string, osRelease string,
+	imageUuidStr string, osRelease string, osPackages []OsPackage,
 ) error {
 	// Pre-compute a map for quick lookup of partition metadata by UUID
 	partUuidToMetadata := make(map[string]outputPartitionMetadata)
@@ -94,7 +96,7 @@ func buildCosiFile(sourceDir string, outputFile string, partitions []outputParti
 			continue
 		}
 
-		metadataImage := Image{
+		metadataImage := FileSystem{
 			Image: ImageFile{
 				Path:             path.Join("images", partition.PartitionFilename),
 				UncompressedSize: partition.UncompressedSize,
@@ -119,7 +121,7 @@ func buildCosiFile(sourceDir string, outputFile string, partitions []outputParti
 					return fmt.Errorf("missing metadata for hash partition UUID:\n%s", verity.hashPartUuid)
 				}
 
-				metadataImage.Verity = &Verity{
+				metadataImage.Verity = &VerityConfig{
 					Roothash: verity.rootHash,
 					Image: ImageFile{
 						Path:             path.Join("images", hashPartition.PartitionFilename),
@@ -147,11 +149,12 @@ func buildCosiFile(sourceDir string, outputFile string, partitions []outputParti
 	}
 
 	metadata := MetadataJson{
-		Version:   "1.0",
-		OsArch:    getArchitectureForCosi(),
-		Id:        imageUuidStr,
-		Images:    make([]Image, len(imageData)),
-		OsRelease: osRelease,
+		Version:    "1.0",
+		OsArch:     getArchitectureForCosi(),
+		Id:         imageUuidStr,
+		Images:     make([]FileSystem, len(imageData)),
+		OsRelease:  osRelease,
+		OsPackages: osPackages,
 	}
 
 	// Copy updated metadata
@@ -282,7 +285,7 @@ func populateMetadata(data *ImageBuildData) error {
 	return nil
 }
 
-func populateVerityMetadata(source string, verity *Verity) error {
+func populateVerityMetadata(source string, verity *VerityConfig) error {
 	if source == "" && verity == nil {
 		return nil
 	}
@@ -304,3 +307,35 @@ func getArchitectureForCosi() string {
 	}
 	return runtime.GOARCH
 }
+
+func getAllPackagesFromChroot(imageConnection *ImageConnection) ([]OsPackage, error) {
+	var out string
+	err := imageConnection.Chroot().UnsafeRun(func() error {
+		var err error
+		out, _, err = shell.Execute(
+			"rpm", "-qa", "--queryformat", "%{NAME} %{VERSION} %{RELEASE} %{ARCH}\n",
+		)
+		return err
+	})
+	if err != nil {
+		return nil, fmt.Errorf("failed to get RPM output from chroot:\n%w", err)
+	}
+
+	lines := strings.Split(strings.TrimSpace(out), "\n")
+	var packages []OsPackage
+	for _, line := range lines {
+		parts := strings.Fields(line)
+		if len(parts) != 4 {
+			return nil, fmt.Errorf("malformed RPM line encountered while parsing installed RPMs for COSI: %q", line)
+		}
+		packages = append(packages, OsPackage{
+			Name:    parts[0],
+			Version: parts[1],
+			Release: parts[2],
+			Arch:    parts[3],
+		})
+	}
+
+	return packages, nil
+
+}

toolkit/tools/pkg/imagecustomizerlib/cosicommon.go

@@ -1,23 +1,24 @@
 package imagecustomizerlib
 
 type MetadataJson struct {
-	Version   string  `json:"version"`
-	OsArch    string  `json:"osArch"`
-	Images    []Image `json:"images"`
-	OsRelease string  `json:"osRelease"`
-	Id        string  `json:"id"`
+	Version    string       `json:"version"`
+	OsArch     string       `json:"osArch"`
+	Images     []FileSystem `json:"images"`
+	OsRelease  string       `json:"osRelease"`
+	Id         string       `json:"id"`
+	OsPackages []OsPackage  `json:"osPackages"`
 }
 
-type Image struct {
-	Image      ImageFile `json:"image"`
-	MountPoint string    `json:"mountPoint"`
-	FsType     string    `json:"fsType"`
-	FsUuid     string    `json:"fsUuid"`
-	PartType   string    `json:"partType"`
-	Verity     *Verity   `json:"verity"`
+type FileSystem struct {
+	Image      ImageFile     `json:"image"`
+	MountPoint string        `json:"mountPoint"`
+	FsType     string        `json:"fsType"`
+	FsUuid     string        `json:"fsUuid"`
+	PartType   string        `json:"partType"`
+	Verity     *VerityConfig `json:"verity"`
 }
 
-type Verity struct {
+type VerityConfig struct {
 	Image    ImageFile `json:"image"`
 	Roothash string    `json:"roothash"`
 }
@@ -28,3 +29,10 @@ type ImageFile struct {
 	UncompressedSize uint64 `json:"uncompressedSize"`
 	Sha384           string `json:"sha384"`
 }
+
+type OsPackage struct {
+	Name    string `json:"name"`
+	Version string `json:"version"`
+	Release string `json:"release"`
+	Arch    string `json:"arch"`
+}

toolkit/tools/pkg/imagecustomizerlib/cosimetadata.go

@@ -16,7 +16,7 @@ import (
 func customizePartitionsUsingFileCopy(buildDir string, baseConfigPath string, config *imagecustomizerapi.Config,
 	buildImageFile string, newBuildImageFile string,
 ) (map[string]string, error) {
-	existingImageConnection, _, _, err := connectToExistingImage(buildImageFile, buildDir, "imageroot", false)
+	existingImageConnection, _, _, _, err := connectToExistingImage(buildImageFile, buildDir, "imageroot", false)
 	if err != nil {
 		return nil, err
 	}

toolkit/tools/pkg/imagecustomizerlib/customizepartitionsfilecopy.go

@@ -84,6 +84,7 @@ type ImageCustomizerParameters struct {
 
 	partUuidToFstabEntry map[string]diskutils.FstabEntry
 	osRelease            string
+	osPackages           []OsPackage
 }
 
 type verityDeviceMetadata struct {
@@ -464,7 +465,7 @@ func customizeOSContents(ic *ImageCustomizerParameters) error {
 	}
 
 	// Customize the raw image file.
-	partUuidToFstabEntry, baseImageVerityMetadata, osRelease, err := customizeImageHelper(ic.buildDirAbs, ic.configPath,
+	partUuidToFstabEntry, baseImageVerityMetadata, osRelease, osPackages, err := customizeImageHelper(ic.buildDirAbs, ic.configPath,
 		ic.config, ic.rawImageFile, ic.rpmsSources, ic.useBaseImageRpmRepos, partitionsCustomized, ic.imageUuidStr, ic.packageSnapshotTime)
 	if err != nil {
 		return err
@@ -482,6 +483,7 @@ func customizeOSContents(ic *ImageCustomizerParameters) error {
 	ic.partUuidToFstabEntry = partUuidToFstabEntry
 	ic.baseImageVerityMetadata = baseImageVerityMetadata
 	ic.osRelease = osRelease
+	ic.osPackages = osPackages
 
 	// For COSI, always shrink the filesystems.
 	shrinkPartitions := ic.outputImageFormat == imagecustomizerapi.ImageFormatTypeCosi
@@ -854,20 +856,20 @@ func validateOutput(baseConfigPath string, output imagecustomizerapi.Output, out
 func customizeImageHelper(buildDir string, baseConfigPath string, config *imagecustomizerapi.Config,
 	rawImageFile string, rpmsSources []string, useBaseImageRpmRepos bool, partitionsCustomized bool,
 	imageUuidStr string, packageSnapshotTime string,
-) (map[string]diskutils.FstabEntry, []verityDeviceMetadata, string, error) {
+) (map[string]diskutils.FstabEntry, []verityDeviceMetadata, string, []OsPackage, error) {
 	logger.Log.Debugf("Customizing OS")
 
-	imageConnection, partUuidToFstabEntry, baseImageVerityMetadata, err := connectToExistingImage(rawImageFile,
+	imageConnection, partUuidToFstabEntry, baseImageVerityMetadata, osPackages, err := connectToExistingImage(rawImageFile,
 		buildDir, "imageroot", true)
 	if err != nil {
-		return nil, nil, "", err
+		return nil, nil, "", nil, err
 	}
 	defer imageConnection.Close()
 
 	// Extract OS release info from rootfs for COSI
 	osRelease, err := extractOSRelease(imageConnection)
 	if err != nil {
-		return nil, nil, "", fmt.Errorf("failed to extract OS release from rootfs partition:\n%w", err)
+		return nil, nil, "", nil, fmt.Errorf("failed to extract OS release from rootfs partition:\n%w", err)
 	}
 
 	imageConnection.Chroot().UnsafeRun(func() error {
@@ -879,7 +881,7 @@ func customizeImageHelper(buildDir string, baseConfigPath string, config *imagec
 
 	err = validateVerityMountPaths(imageConnection, config, partUuidToFstabEntry)
 	if err != nil {
-		return nil, nil, "", fmt.Errorf("verity validation failed:\n%w", err)
+		return nil, nil, "", nil, fmt.Errorf("verity validation failed:\n%w", err)
 	}
 
 	// Do the actual customizations.
@@ -891,15 +893,15 @@ func customizeImageHelper(buildDir string, baseConfigPath string, config *imagec
 	warnOnLowFreeSpace(buildDir, imageConnection)
 
 	if err != nil {
-		return nil, nil, "", err
+		return nil, nil, "", nil, err
 	}
 
 	err = imageConnection.CleanClose()
 	if err != nil {
-		return nil, nil, "", err
+		return nil, nil, "", nil, err
 	}
 
-	return partUuidToFstabEntry, baseImageVerityMetadata, osRelease, nil
+	return partUuidToFstabEntry, baseImageVerityMetadata, osRelease, osPackages, nil
 }
 
 func shrinkFilesystemsHelper(buildImageFile string) error {

toolkit/tools/pkg/imagecustomizerlib/imagecustomizer.go

@@ -21,16 +21,22 @@ import (
 type installOSFunc func(imageChroot *safechroot.Chroot) error
 
 func connectToExistingImage(imageFilePath string, buildDir string, chrootDirName string, includeDefaultMounts bool,
-) (*ImageConnection, map[string]diskutils.FstabEntry, []verityDeviceMetadata, error) {
+) (*ImageConnection, map[string]diskutils.FstabEntry, []verityDeviceMetadata, []OsPackage, error) {
 	imageConnection := NewImageConnection()
 
 	partUuidToMountPath, verityMetadata, err := connectToExistingImageHelper(imageConnection, imageFilePath, buildDir,
 		chrootDirName, includeDefaultMounts)
 	if err != nil {
 		imageConnection.Close()
-		return nil, nil, nil, err
+		return nil, nil, nil, nil, err
 	}
-	return imageConnection, partUuidToMountPath, verityMetadata, nil
+
+	packages, err := getAllPackagesFromChroot(imageConnection)
+	if err != nil {
+		return nil, nil, nil, nil, err
+	}
+
+	return imageConnection, partUuidToMountPath, verityMetadata, packages, nil
 }
 
 func connectToExistingImageHelper(imageConnection *ImageConnection, imageFilePath string,

toolkit/tools/pkg/imagecustomizerlib/imageutils.go

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