fix(build/rofl): Fix artifact upgrade to not overwrite everything

Author: kostko

build/rofl/artifacts.go

@@ -14,6 +14,5 @@ var LatestContainerArtifacts = ArtifactsConfig{
 	Stage2:   "https://github.com/oasisprotocol/oasis-boot/releases/download/v0.6.2/stage2-podman.tar.bz2#b2ea2a0ca769b6b2d64e3f0c577ee9c08f0bb81a6e33ed5b15b2a7e50ef9a09f",
 	Container: ContainerArtifactsConfig{
 		Runtime: "https://github.com/oasisprotocol/oasis-sdk/releases/download/rofl-containers%2Fv0.7.1/rofl-containers#0a7f821f36793b9409c623d795ea0edd996ac5cd96f05f3e8a81da409deb1880",
-		Compose: "compose.yaml",
 	},
 }

build/rofl/manifest.go

@@ -500,10 +500,55 @@ type ArtifactsConfig struct {
 	Container ContainerArtifactsConfig `yaml:"container,omitempty" json:"container,omitempty"`
 }
 
+type artifactUpgrade struct {
+	existing *string
+	new      string
+}
+
+func upgradeArtifacts(upgrade []artifactUpgrade) bool {
+	var changed bool
+	for _, artifact := range upgrade {
+		if artifact.new == "" {
+			continue
+		}
+		if *artifact.existing == artifact.new {
+			continue
+		}
+		*artifact.existing = artifact.new
+		changed = true
+	}
+	return changed
+}
+
+// UpgradeTo upgrades the artifacts to the latest version by updating any relevant fields.
+//
+// Returns true iff any artifacts have been updated.
+func (ac *ArtifactsConfig) UpgradeTo(latest *ArtifactsConfig) bool {
+	var changed bool
+	changed = upgradeArtifacts([]artifactUpgrade{
+		{&ac.Builder, latest.Builder},
+		{&ac.Firmware, latest.Firmware},
+		{&ac.Kernel, latest.Kernel},
+		{&ac.Stage2, latest.Stage2},
+	})
+	changed = ac.Container.UpgradeTo(&latest.Container) || changed
+	return changed
+}
+
 // ContainerArtifactsConfig is the container artifacts configuration.
 type ContainerArtifactsConfig struct {
 	// Runtime is the URI/path to the container runtime artifact (empty to use default).
 	Runtime string `yaml:"runtime,omitempty" json:"runtime,omitempty"`
 	// Compose is the URI/path to the docker-compose.yaml artifact (empty to use default).
 	Compose string `yaml:"compose,omitempty" json:"compose,omitempty"`
 }
+
+// UpgradeTo upgrades the artifacts to the latest version by updating any relevant fields.
+//
+// Returns true iff any artifacts have been updated.
+func (cc *ContainerArtifactsConfig) UpgradeTo(latest *ContainerArtifactsConfig) bool {
+	return upgradeArtifacts([]artifactUpgrade{
+		{&cc.Compose, latest.Compose},
+		{&cc.Runtime, latest.Runtime},
+	})
+}

build/rofl/manifest_test.go

@@ -211,3 +211,37 @@ func TestLoadManifest(t *testing.T) {
 	require.Contains(m.Deployments, "default")
 	require.Equal("rofl1qpa9ydy3qmka3yrqzx0pxuvyfexf9mlh75hker5j", m.Deployments["default"].AppID)
 }
+
+func TestUpgradeArtifacts(t *testing.T) {
+	require := require.New(t)
+
+	existing := ArtifactsConfig{
+		Builder:  "a",
+		Firmware: "b",
+		Kernel:   "c",
+		Stage2:   "d",
+		Container: ContainerArtifactsConfig{
+			Runtime: "e",
+			Compose: "f",
+		},
+	}
+	latest := ArtifactsConfig{
+		Firmware: "b2",
+		Kernel:   "c2",
+		Stage2:   "d2",
+		Container: ContainerArtifactsConfig{
+			Runtime: "e2",
+		},
+	}
+	changed := existing.UpgradeTo(&latest)
+	require.True(changed)
+	require.Equal("a", existing.Builder)
+	require.Equal("b2", existing.Firmware)
+	require.Equal("c2", existing.Kernel)
+	require.Equal("d2", existing.Stage2)
+	require.Equal("e2", existing.Container.Runtime)
+	require.Equal("f", existing.Container.Compose)
+
+	changed = existing.UpgradeTo(&latest)
+	require.False(changed)
+}

cmd/rofl/mgmt.go

@@ -2,7 +2,6 @@ package rofl
 
 import (
 	"bufio"
-	"bytes"
 	"context"
 	_ "embed"
 	"encoding/json"
@@ -521,33 +520,30 @@ var (
 			manifest, err := buildRofl.LoadManifest()
 			cobra.CheckErr(err)
 
-			var changes bool
+			var latestArtifacts buildRofl.ArtifactsConfig
 			switch manifest.TEE {
 			case buildRofl.TEETypeTDX:
 				switch manifest.Kind {
 				case buildRofl.AppKindRaw:
-					artifacts := buildRofl.LatestBasicArtifacts // Copy.
-					changes, err = replaceArtifacts(manifest, &artifacts)
-					cobra.CheckErr(err)
+					latestArtifacts = buildRofl.LatestBasicArtifacts // Copy.
 				case buildRofl.AppKindContainer:
-					artifacts := buildRofl.LatestContainerArtifacts // Copy.
-					changes, err = replaceArtifacts(manifest, &artifacts)
-					cobra.CheckErr(err)
+					latestArtifacts = buildRofl.LatestContainerArtifacts // Copy.
 				default:
 				}
 			default:
 			}
 
+			if !manifest.Artifacts.UpgradeTo(&latestArtifacts) {
+				fmt.Printf("Artifacts already up-to-date.\n")
+				return
+			}
+
 			// Update manifest.
 			if err := manifest.Save(); err != nil {
 				cobra.CheckErr(fmt.Errorf("failed to update manifest: %w", err))
 			}
 
-			if changes {
-				fmt.Printf("Run `oasis rofl build` to build your ROFL app.\n")
-			} else {
-				fmt.Printf("Artifacts already up-to-date.\n")
-			}
+			fmt.Printf("Run `oasis rofl build` to build your ROFL app.\n")
 		},
 	}
 
@@ -806,24 +802,6 @@ var (
 	}
 )
 
-// replaceArtifacts replaces existing manifest artifacts with new ones and returns true, if there were changes.
-func replaceArtifacts(manifest *buildRofl.Manifest, newArtifacts *buildRofl.ArtifactsConfig) (bool, error) {
-	oldRaw, err := json.Marshal(manifest.Artifacts)
-	if err != nil {
-		return false, err
-	}
-
-	newRaw, err := json.Marshal(newArtifacts)
-	if err != nil {
-		return false, err
-	}
-
-	changes := !bytes.Equal(oldRaw, newRaw)
-	manifest.Artifacts = newArtifacts
-
-	return changes, nil
-}
-
 // detectOrCreateComposeFile detects the existing compose.yaml-like file and returns its filename. If it doesn't exist, it creates compose.yaml and populates it.
 func detectOrCreateComposeFile() string {
 	for _, filename := range []string{"rofl-compose.yaml", "rofl-compose.yml", "docker-compose.yaml", "docker-compose.yml", "compose.yml", "compose.yaml"} {