feat: allow to read manifest annotations from file

Author: vanhtuan0409

examples/anduin/multi-modules/Makefile

@@ -1,15 +1,18 @@
+MODULE_1_VERSION:=v1.0.3
+MODULE_2_VERSION:=v1.0.0
+
 nuke:
 	sudo rm -rf ./cue.cache/mod && \
 		rm -rf ./data/* && \
 		mkdir -p ./cue.cache ./data
 
 publish-module1:
 	cd ./module1 && \
-		../cue.sh mod publish v1.0.1
+		../cue.sh mod publish ${MODULE_1_VERSION}
 
 publish-module2:
 	cd ./module2 && \
-		../cue.sh mod publish v1.0.0
+		../cue.sh mod publish ${MODULE_2_VERSION}
 
 eval-module2:
 	cd ./module2 && \
@@ -18,4 +21,4 @@ eval-module2:
 
 oras-pull:
 	cd data && \
-		oras pull localhost:5000/anduin.com/module1:v1.0.1
+		oras pull localhost:5000/anduin.com/module1:${MODULE_1_VERSION}

examples/anduin/multi-modules/module1/annotations.json

@@ -0,0 +1,5 @@
+{
+  "$manifest": {
+    "org.opencontainers.image.authors": "tuanvuong@anduintransact.com"
+  }
+}

examples/anduin/multi-modules/module2/cue.mod/module.cue

@@ -7,7 +7,7 @@ source: {
 }
 deps: {
 	"dev.anduintransact.com/module1@v1": {
-		v:       "v1.0.1"
+		v:       "v1.0.3"
 		default: true
 	}
 }

mod/modregistry/anduin.go

@@ -8,6 +8,7 @@ import (
 	"archive/zip"
 	"bytes"
 	"context"
+	"encoding/json"
 	"fmt"
 	"io"
 	"log"
@@ -23,6 +24,10 @@ import (
 	ocispec "github.com/opencontainers/image-spec/specs-go/v1"
 )
 
+const (
+	cueModuleAnnotationFileEnv = "ANDUIN_CUE_MODULE_ANNOTATION_FILE"
+)
+
 var logging, _ = strconv.ParseBool(os.Getenv("ANDUIN_CUE_DEBUG"))
 
 type anduinPatch struct {
@@ -87,6 +92,7 @@ func (p *anduinPatch) repackZipFile(repackZip *os.File, ctx context.Context, m *
 				Size:        int64(len(data)),
 				Annotations: annotation,
 			}
+			logf("pushing data layer for file %s", zf.Name)
 			if _, err := loc.Registry.PushBlob(ctx, loc.Repository, dataLayer, bytes.NewReader(data)); err != nil {
 				return fmt.Errorf("cannot push oras data layer: %v", err)
 			}
@@ -124,6 +130,36 @@ func (p *anduinPatch) repackZipFile(repackZip *os.File, ctx context.Context, m *
 	return orasLayers, nil
 }
 
+func (p *anduinPatch) mergeManifestAnnotations(annotations map[string]string) map[string]string {
+	annotationsFile := resolveModuleAnnotationFile()
+	f, err := os.Open(annotationsFile)
+	if err != nil && !os.IsNotExist(err) {
+		logf("warn: unable to open manifest annotations file. File: `%s`. Err: %v", annotationsFile, err)
+		return annotations
+	}
+	defer f.Close()
+	logf("reading manifest annotations file: %s", annotationsFile)
+
+	r := json.NewDecoder(f)
+	var content struct {
+		Manifest map[string]string `json:"$manifest"`
+	}
+	if err := r.Decode(&content); err != nil {
+		logf("warn: unable to parse manifest annotations file. Err :%v", err)
+		return annotations
+	}
+
+	// merging values
+	if annotations == nil {
+		annotations = map[string]string{}
+	}
+	annotations["com.anduintransact.annotations.file"] = annotationsFile
+	for key, val := range content.Manifest {
+		annotations[key] = val
+	}
+	return annotations
+}
+
 func shouldRepackFile(zf *zip.File) bool {
 	return strings.HasSuffix(zf.Name, ".cue") || strings.ToLower(zf.Name) == "license"
 }
@@ -162,6 +198,15 @@ func validateModVersion(mv module.Version, mf *modfile.File) (string, bool) {
 	return major, true
 }
 
+func resolveModuleAnnotationFile() string {
+	envFile := os.Getenv(cueModuleAnnotationFileEnv)
+	if envFile != "" {
+		return envFile
+	}
+	// default to cwd `annotations.json`
+	return "annotations.json"
+}
+
 func logf(f string, a ...any) {
 	if logging {
 		log.Printf("anduin: "+f, a...)

mod/modregistry/client.go

@@ -250,6 +250,8 @@ func (c *Client) putCheckedModule(ctx context.Context, m *checkedModule, meta *M
 		}
 		annotations = annotations0
 	}
+	annotations = c.anduin.mergeManifestAnnotations(annotations)
+
 	loc, err := c.resolve(m.mv)
 	if err != nil {
 		return err