distro/test: test ostree options

Test all combinations of ostree options and verify the ostree commit
source spec returned by the manifest.

internal/distro/distro_test_common/distro_test_common.go

@@ -6,6 +6,7 @@ import (
 	"os"
 	"path"
 	"path/filepath"
+	"strings"
 	"testing"
 
 	"github.com/google/go-cmp/cmp"
@@ -318,3 +319,301 @@ func TestDistro_KernelOption(t *testing.T, d distro.Distro) {
 		}
 	}
 }
+
+func TestDistro_OSTreeOptions(t *testing.T, d distro.Distro) {
+	// test that ostree parameters are properly resolved by image functions that should support them
+	typesWithParent := map[string]bool{ // image types that support specifying a parent commit
+		"edge-commit":    true,
+		"edge-container": true,
+		"iot-commit":     true,
+		"iot-container":  true,
+	}
+
+	typesWithPayload := map[string]bool{
+		"edge-ami":                  true,
+		"edge-installer":            true,
+		"edge-raw-image":            true,
+		"edge-simplified-installer": true,
+		"iot-ami":                   true,
+		"iot-installer":             true,
+		"iot-raw-image":             true,
+		"iot-simplified-installer":  true,
+	}
+
+	assert := assert.New(t)
+
+	{ // empty options: payload ref should equal default
+		for _, archName := range d.ListArches() {
+			arch, err := d.GetArch(archName)
+			assert.NoError(err)
+			for _, typeName := range arch.ListImageTypes() {
+				bp := &blueprint.Blueprint{}
+				if strings.HasSuffix(typeName, "simplified-installer") {
+					// simplified installers require installation device
+					bp = &blueprint.Blueprint{
+						Customizations: &blueprint.Customizations{
+							InstallationDevice: "/dev/sda42",
+						},
+					}
+				}
+				imgType, err := arch.GetImageType(typeName)
+				assert.NoError(err)
+
+				ostreeOptions := ostree.ImageOptions{}
+				if typesWithPayload[typeName] {
+					// payload types require URL
+					ostreeOptions.URL = "https://example.com/repo"
+				}
+				options := distro.ImageOptions{OSTree: &ostreeOptions}
+
+				m, _, err := imgType.Manifest(bp, options, nil, 0)
+				assert.NoError(err)
+
+				nrefs := 0
+				// If a manifest returns an ostree source spec, the ref should
+				// match the default.
+				for _, commits := range m.GetOSTreeSourceSpecs() {
+					for _, commit := range commits {
+						assert.Equal(options.OSTree.URL, commit.URL, "url does not match expected for image type %q\n", typeName)
+						assert.Equal(imgType.OSTreeRef(), commit.Ref, "ref does not match expected for image type %q\n", typeName)
+						nrefs++
+					}
+				}
+				nexpected := 0
+				if typesWithPayload[typeName] {
+					// image types with payload should return a ref
+					nexpected = 1
+				}
+				assert.Equal(nexpected, nrefs, "incorrect ref count for image type %q\n", typeName)
+			}
+		}
+	}
+
+	{ // ImageRef set: should be returned as payload ref - no parent for commits and containers
+		for _, archName := range d.ListArches() {
+			arch, err := d.GetArch(archName)
+			assert.NoError(err)
+			for _, typeName := range arch.ListImageTypes() {
+				bp := &blueprint.Blueprint{}
+				if strings.HasSuffix(typeName, "simplified-installer") {
+					// simplified installers require installation device
+					bp = &blueprint.Blueprint{
+						Customizations: &blueprint.Customizations{
+							InstallationDevice: "/dev/sda42",
+						},
+					}
+				}
+
+				imgType, err := arch.GetImageType(typeName)
+				assert.NoError(err)
+
+				ostreeOptions := ostree.ImageOptions{
+					ImageRef: "test/x86_64/01",
+				}
+				if typesWithPayload[typeName] {
+					// payload types require URL
+					ostreeOptions.URL = "https://example.com/repo"
+				}
+				options := distro.ImageOptions{OSTree: &ostreeOptions}
+				m, _, err := imgType.Manifest(bp, options, nil, 0)
+				assert.NoError(err)
+
+				nrefs := 0
+				// if a manifest returns an ostree source spec, the ref should
+				// match the default
+				for _, commits := range m.GetOSTreeSourceSpecs() {
+					for _, commit := range commits {
+						assert.Equal(options.OSTree.URL, commit.URL, "url does not match expected for image type %q\n", typeName)
+						assert.Equal(options.OSTree.ImageRef, commit.Ref, "ref does not match expected for image type %q\n", typeName)
+						nrefs++
+					}
+				}
+				nexpected := 0
+				if typesWithPayload[typeName] {
+					// image types with payload should return a ref
+					nexpected = 1
+				}
+				assert.Equal(nexpected, nrefs, "incorrect ref count for image type %q\n", typeName)
+			}
+		}
+	}
+
+	{ // URL always specified: should add a parent to image types that support it and the ref should match the option
+		for _, archName := range d.ListArches() {
+			arch, err := d.GetArch(archName)
+			assert.NoError(err)
+			for _, typeName := range arch.ListImageTypes() {
+				bp := &blueprint.Blueprint{}
+				if strings.HasSuffix(typeName, "simplified-installer") {
+					// simplified installers require installation device
+					bp = &blueprint.Blueprint{
+						Customizations: &blueprint.Customizations{
+							InstallationDevice: "/dev/sda42",
+						},
+					}
+				}
+
+				imgType, err := arch.GetImageType(typeName)
+				assert.NoError(err)
+
+				ostreeOptions := ostree.ImageOptions{
+					ImageRef: "test/x86_64/01",
+					URL:      "https://example.com/repo",
+				}
+				options := distro.ImageOptions{OSTree: &ostreeOptions}
+				m, _, err := imgType.Manifest(bp, options, nil, 0)
+				assert.NoError(err)
+
+				nrefs := 0
+				for _, commits := range m.GetOSTreeSourceSpecs() {
+					for _, commit := range commits {
+						assert.Equal(options.OSTree.URL, commit.URL, "url does not match expected for image type %q\n", typeName)
+						assert.Equal(options.OSTree.ImageRef, commit.Ref, "ref does not match expected for image type %q\n", typeName)
+						nrefs++
+					}
+				}
+				nexpected := 0
+				if typesWithPayload[typeName] || typesWithParent[typeName] {
+					// image types with payload or parent should return a ref
+					nexpected = 1
+				}
+				assert.Equal(nexpected, nrefs, "incorrect ref count for image type %q\n", typeName)
+			}
+		}
+	}
+
+	{ // URL and parent ref always specified: payload ref should be default - parent ref should match option
+		for _, archName := range d.ListArches() {
+			arch, err := d.GetArch(archName)
+			assert.NoError(err)
+			for _, typeName := range arch.ListImageTypes() {
+				bp := &blueprint.Blueprint{}
+				if strings.HasSuffix(typeName, "simplified-installer") {
+					// simplified installers require installation device
+					bp = &blueprint.Blueprint{
+						Customizations: &blueprint.Customizations{
+							InstallationDevice: "/dev/sda42",
+						},
+					}
+				}
+
+				imgType, err := arch.GetImageType(typeName)
+				assert.NoError(err)
+
+				ostreeOptions := ostree.ImageOptions{
+					ParentRef: "test/x86_64/01",
+					URL:       "https://example.com/repo",
+				}
+				options := distro.ImageOptions{OSTree: &ostreeOptions}
+				m, _, err := imgType.Manifest(bp, options, nil, 0)
+				assert.NoError(err)
+
+				nrefs := 0
+				for _, commits := range m.GetOSTreeSourceSpecs() {
+					for _, commit := range commits {
+						assert.Equal(options.OSTree.URL, commit.URL, "url does not match expected for image type %q\n", typeName)
+						if typesWithPayload[typeName] {
+							// payload ref should fall back to default
+							assert.Equal(imgType.OSTreeRef(), commit.Ref, "ref does not match expected for image type %q\n", typeName)
+						} else if typesWithParent[typeName] {
+							// parent ref should match option
+							assert.Equal(options.OSTree.ParentRef, commit.Ref, "ref does not match expected for image type %q\n", typeName)
+						} else {
+							// image type requires ostree commit but isn't specified: this shouldn't happen
+							panic(fmt.Sprintf("image type %q requires ostree commit but is not covered by test", typeName))
+						}
+						nrefs++
+					}
+				}
+				nexpected := 0
+				if typesWithPayload[typeName] || typesWithParent[typeName] {
+					// image types with payload or parent should return a ref
+					nexpected = 1
+				}
+				assert.Equal(nexpected, nrefs, "incorrect ref count for image type %q\n", typeName)
+			}
+		}
+	}
+
+	{ // All options set: all refs should match the corresponding option
+		for _, archName := range d.ListArches() {
+			arch, err := d.GetArch(archName)
+			assert.NoError(err)
+			for _, typeName := range arch.ListImageTypes() {
+				bp := &blueprint.Blueprint{}
+				if strings.HasSuffix(typeName, "simplified-installer") {
+					// simplified installers require installation device
+					bp = &blueprint.Blueprint{
+						Customizations: &blueprint.Customizations{
+							InstallationDevice: "/dev/sda42",
+						},
+					}
+				}
+
+				imgType, err := arch.GetImageType(typeName)
+				assert.NoError(err)
+
+				ostreeOptions := ostree.ImageOptions{
+					ImageRef:  "test/x86_64/01",
+					ParentRef: "test/x86_64/02",
+					URL:       "https://example.com/repo",
+				}
+				options := distro.ImageOptions{OSTree: &ostreeOptions}
+				m, _, err := imgType.Manifest(bp, options, nil, 0)
+				assert.NoError(err)
+
+				nrefs := 0
+				for _, commits := range m.GetOSTreeSourceSpecs() {
+					for _, commit := range commits {
+						assert.Equal(options.OSTree.URL, commit.URL, "url does not match expected for image type %q\n", typeName)
+						if typesWithPayload[typeName] {
+							// payload ref should match image ref
+							assert.Equal(options.OSTree.ImageRef, commit.Ref, "ref does not match expected for image type %q\n", typeName)
+						} else if typesWithParent[typeName] {
+							// parent ref should match option
+							assert.Equal(options.OSTree.ParentRef, commit.Ref, "ref does not match expected for image type %q\n", typeName)
+						} else {
+							// image type requires ostree commit but isn't specified: this shouldn't happen
+							panic(fmt.Sprintf("image type %q requires ostree commit but is not covered by test", typeName))
+						}
+						nrefs++
+					}
+				}
+				nexpected := 0
+				if typesWithPayload[typeName] || typesWithParent[typeName] {
+					// image types with payload or parent should return a ref
+					nexpected = 1
+				}
+				assert.Equal(nexpected, nrefs, "incorrect ref count for image type %q\n", typeName)
+			}
+		}
+	}
+
+	{ // Parent set without URL: always causes error
+		for _, archName := range d.ListArches() {
+			arch, err := d.GetArch(archName)
+			assert.NoError(err)
+			for _, typeName := range arch.ListImageTypes() {
+				bp := &blueprint.Blueprint{}
+				if strings.HasSuffix(typeName, "simplified-installer") {
+					// simplified installers require installation device
+					bp = &blueprint.Blueprint{
+						Customizations: &blueprint.Customizations{
+							InstallationDevice: "/dev/sda42",
+						},
+					}
+				}
+
+				imgType, err := arch.GetImageType(typeName)
+				assert.NoError(err)
+
+				ostreeOptions := ostree.ImageOptions{
+					ParentRef: "test/x86_64/02",
+				}
+				options := distro.ImageOptions{OSTree: &ostreeOptions}
+				_, _, err = imgType.Manifest(bp, options, nil, 0)
+				assert.Error(err)
+			}
+		}
+	}
+}

internal/distro/fedora/distro_test.go

@@ -557,6 +557,10 @@ func TestFedora37_KernelOption(t *testing.T) {
 	distro_test_common.TestDistro_KernelOption(t, fedora.NewF37())
 }
 
+func TestFedora_OSTreeOptions(t *testing.T) {
+	distro_test_common.TestDistro_OSTreeOptions(t, fedora.NewF37())
+}
+
 func TestDistro_CustomFileSystemManifestError(t *testing.T) {
 	fedoraDistro := fedora.NewF37()
 	bp := blueprint.Blueprint{

internal/distro/rhel8/distro_test.go

@@ -636,6 +636,10 @@ func TestRhel86_KernelOption(t *testing.T) {
 	distro_test_common.TestDistro_KernelOption(t, rhel8.New())
 }
 
+func TestRhel8_OSTreeOptions(t *testing.T) {
+	distro_test_common.TestDistro_OSTreeOptions(t, rhel8.New())
+}
+
 func TestDistro_CustomFileSystemManifestError(t *testing.T) {
 	r8distro := rhel8.New()
 	bp := blueprint.Blueprint{

internal/distro/rhel9/distro_test.go

@@ -625,6 +625,10 @@ func TestRhel9_KernelOption(t *testing.T) {
 	distro_test_common.TestDistro_KernelOption(t, rhel9.New())
 }
 
+func TestRhel9_OSTreeOptions(t *testing.T) {
+	distro_test_common.TestDistro_OSTreeOptions(t, rhel9.New())
+}
+
 func TestDistro_CustomFileSystemManifestError(t *testing.T) {
 	r9distro := rhel9.New()
 	bp := blueprint.Blueprint{