Sets mappings as arrays of maps to allow precedence

Author: pchila

dev-tools/mage/settings.go

@@ -314,9 +314,9 @@ func PackageManifest() (string, error) {
 		return "", fmt.Errorf("retrieving agent commit hash: %w", err)
 	}
 	m.Package.VersionedHome = fmt.Sprintf("%s-%s", BeatName, commitHashShort)
-	m.Package.PathMappings = map[string]string{}
-	m.Package.PathMappings["data/"+m.Package.VersionedHome] = fmt.Sprintf("data/elastic-agent-%s%s-%s", m.Package.Version, SnapshotSuffix(), commitHashShort)
-	m.Package.PathMappings["manifest.yaml"] = fmt.Sprintf("data/elastic-agent-%s%s-%s/manifest.yaml", m.Package.Version, SnapshotSuffix(), commitHashShort)
+	m.Package.PathMappings = []map[string]string{{}}
+	m.Package.PathMappings[0]["data/"+m.Package.VersionedHome] = fmt.Sprintf("data/elastic-agent-%s%s-%s", m.Package.Version, SnapshotSuffix(), commitHashShort)
+	m.Package.PathMappings[0]["manifest.yaml"] = fmt.Sprintf("data/elastic-agent-%s%s-%s/manifest.yaml", m.Package.Version, SnapshotSuffix(), commitHashShort)
 	yamlBytes, err := yaml.Marshal(m)
 	if err != nil {
 		return "", fmt.Errorf("marshaling manifest: %w", err)

dev-tools/packaging/package_test.go

@@ -229,9 +229,12 @@ func checkManifestFileContents(t *testing.T, pkgFS fs.FS) {
 	commitHashShort, err := mage.CommitHashShort()
 	if assert.NoError(t, err, "error getting commit hash for agent") {
 		pathInPackage := "data/elastic-agent-" + commitHashShort
-		assert.Contains(t, m.Package.PathMappings, pathInPackage, "path mappings in manifest do not contain the extraction path for versionedHome")
-		mappedPath := m.Package.PathMappings[pathInPackage]
-		assert.Contains(t, mappedPath, packageVersion, "mapped path for versionedHome does not contain the package version")
+		if assert.NotEmpty(t, m.Package.PathMappings, "path mappings in manifest are empty") {
+			assert.Contains(t, m.Package.PathMappings[0], pathInPackage, "path mappings in manifest do not contain the extraction path for versionedHome")
+			// the first map should have the mapping for the data/elastic-agent-****** path)
+			mappedPath := m.Package.PathMappings[0][pathInPackage]
+			assert.Contains(t, mappedPath, packageVersion, "mapped path for versionedHome does not contain the package version")
+		}
 	}
 }
 

pkg/api/v1/manifest.go

@@ -13,11 +13,35 @@ import (
 
 const ManifestKind = "PackageManifest"
 
+type PathMapping struct {
+	Source      string
+	Destination string
+}
+
+func (pm *PathMapping) UnmarshalYAML(unmarshal func(interface{}) error) error {
+	value := map[string]string{}
+	err := unmarshal(&value)
+	if err != nil {
+		return fmt.Errorf("accessing yaml: %w", err)
+	}
+
+	if len(value) != 1 {
+		return fmt.Errorf("value %q is not a single <src>:<dst> mapping", value)
+	}
+
+	for k, v := range value {
+		pm.Source = k
+		pm.Destination = v
+	}
+
+	return nil
+}
+
 type PackageDesc struct {
-	Version       string            `yaml:"version,omitempty" json:"version,omitempty"`
-	Snapshot      bool              `yaml:"snapshot,omitempty" json:"snapshot,omitempty"`
-	VersionedHome string            `yaml:"versioned-home,omitempty" json:"versionedHome,omitempty"`
-	PathMappings  map[string]string `yaml:"path-mappings,omitempty" json:"pathMappings,omitempty"`
+	Version       string              `yaml:"version,omitempty" json:"version,omitempty"`
+	Snapshot      bool                `yaml:"snapshot,omitempty" json:"snapshot,omitempty"`
+	VersionedHome string              `yaml:"versioned-home,omitempty" json:"versionedHome,omitempty"`
+	PathMappings  []map[string]string `yaml:"path-mappings,omitempty" json:"pathMappings,omitempty"`
 }
 
 type PackageManifest struct {

pkg/api/v1/manifest_test.go

@@ -33,7 +33,9 @@ package:
   # - key is a prefix representing a path relative to the top of the archive 
   # - value is the substitution to be applied when extracting the files
   path-mappings:
-    data/elastic-agent-4f2d39/ : data/elastic-agent-8.12.0/
+    - data/elastic-agent-4f2d39/ : data/elastic-agent-8.12.0/
+      foo: bar
+    - manifest.yaml : data/elastic-agent-8.12.0/manifest.yaml 
 `
 	m, err := ParseManifest(strings.NewReader(manifest))
 	assert.NoError(t, err)
@@ -43,5 +45,5 @@ package:
 	assert.Equal(t, m.Package.Version, "8.12.0")
 	assert.Equal(t, m.Package.Snapshot, false)
 	assert.Equal(t, m.Package.VersionedHome, "data/elastic-agent-4f2d39/")
-	assert.Equal(t, m.Package.PathMappings, map[string]string{"data/elastic-agent-4f2d39/": "data/elastic-agent-8.12.0/"})
+	assert.Equal(t, m.Package.PathMappings, []map[string]string{{"data/elastic-agent-4f2d39/": "data/elastic-agent-8.12.0/", "foo": "bar"}, {"manifest.yaml": "data/elastic-agent-8.12.0/manifest.yaml"}})
 }