feat: add the filepath to the annotation

Signed-off-by: chlins <[email protected]>

Author: chlins

cmd/build.go

@@ -50,7 +50,7 @@ var buildCmd = &cobra.Command{
 func init() {
 	flags := buildCmd.Flags()
 	flags.StringVarP(&buildConfig.Target, "target", "t", "", "target model artifact name")
-	flags.StringVarP(&buildConfig.Modelfile, "modelfile", "f", "", "model file path")
+	flags.StringVarP(&buildConfig.Modelfile, "modelfile", "f", "Modelfile", "model file path")
 
 	if err := viper.BindPFlags(flags); err != nil {
 		panic(fmt.Errorf("bind cache list flags to viper: %w", err))

pkg/backend/build.go

@@ -114,7 +114,7 @@ func (b *backend) process(ctx context.Context, workDir string, repo string, proc
 		for _, p := range processors {
 			// process the file if it can be recognized.
 			if p.Identify(ctx, path, info) {
-				desc, err := p.Process(ctx, b.store, repo, path, info)
+				desc, err := p.Process(ctx, b.store, repo, path, workDir)
 				if err != nil {
 					return fmt.Errorf("failed to process file: %w", err)
 				}

pkg/backend/build/build.go

@@ -21,6 +21,7 @@ import (
 	"context"
 	"encoding/json"
 	"fmt"
+	"path/filepath"
 	"time"
 
 	modelspec "github.com/CloudNativeAI/modctl/pkg/spec"
@@ -38,7 +39,7 @@ type ModelConfig struct {
 }
 
 // BuildLayer converts the file to the image blob and push it to the storage.
-func BuildLayer(ctx context.Context, store storage.Storage, repo, path string) (ocispec.Descriptor, error) {
+func BuildLayer(ctx context.Context, store storage.Storage, repo, path, workDir string) (ocispec.Descriptor, error) {
 	reader, err := TarFileToStream(path)
 	if err != nil {
 		return ocispec.Descriptor{}, fmt.Errorf("failed to tar file: %w", err)
@@ -49,11 +50,24 @@ func BuildLayer(ctx context.Context, store storage.Storage, repo, path string) (
 		return ocispec.Descriptor{}, fmt.Errorf("failed to push blob to storage: %w", err)
 	}
 
+	absPath, err := filepath.Abs(workDir)
+	if err != nil {
+		return ocispec.Descriptor{}, fmt.Errorf("failed to get absolute path of workDir: %w", err)
+	}
+
+	filePath, err := filepath.Rel(absPath, path)
+	if err != nil {
+		return ocispec.Descriptor{}, fmt.Errorf("failed to get relative path: %w", err)
+	}
+
 	return ocispec.Descriptor{
 		ArtifactType: modelspec.ArtifactTypeModelLayer,
 		MediaType:    ocispec.MediaTypeImageLayer,
 		Digest:       godigest.Digest(digest),
 		Size:         size,
+		Annotations: map[string]string{
+			modelspec.AnnotationFilepath: filePath,
+		},
 	}, nil
 }
 

pkg/backend/processor/license.go

@@ -43,16 +43,17 @@ func (p *licenseProcessor) Identify(_ context.Context, path string, info os.File
 	return info.Name() == "LICENSE" || info.Name() == "LICENSE.txt"
 }
 
-func (p *licenseProcessor) Process(ctx context.Context, store storage.Storage, repo, path string, info os.FileInfo) (ocispec.Descriptor, error) {
-	desc, err := build.BuildLayer(ctx, store, repo, path)
+func (p *licenseProcessor) Process(ctx context.Context, store storage.Storage, repo, path, workDir string) (ocispec.Descriptor, error) {
+	desc, err := build.BuildLayer(ctx, store, repo, path, workDir)
 	if err != nil {
 		return ocispec.Descriptor{}, nil
 	}
 
 	// add license annotations.
-	desc.Annotations = map[string]string{
-		modelspec.AnnotationLicense: "true",
+	if desc.Annotations == nil {
+		desc.Annotations = map[string]string{}
 	}
 
+	desc.Annotations[modelspec.AnnotationLicense] = "true"
 	return desc, nil
 }

pkg/backend/processor/model.go

@@ -55,16 +55,17 @@ func (p *modelProcessor) Identify(_ context.Context, path string, info os.FileIn
 	return false
 }
 
-func (p *modelProcessor) Process(ctx context.Context, store storage.Storage, repo, path string, info os.FileInfo) (ocispec.Descriptor, error) {
-	desc, err := build.BuildLayer(ctx, store, repo, path)
+func (p *modelProcessor) Process(ctx context.Context, store storage.Storage, repo, path, workDir string) (ocispec.Descriptor, error) {
+	desc, err := build.BuildLayer(ctx, store, repo, path, workDir)
 	if err != nil {
 		return ocispec.Descriptor{}, nil
 	}
 
 	// add model annotations.
-	desc.Annotations = map[string]string{
-		modelspec.AnnotationModel: "true",
+	if desc.Annotations == nil {
+		desc.Annotations = map[string]string{}
 	}
 
+	desc.Annotations[modelspec.AnnotationModel] = "true"
 	return desc, nil
 }

pkg/backend/processor/model_config.go

@@ -55,16 +55,17 @@ func (p *modelConfigProcessor) Identify(_ context.Context, path string, info os.
 	return false
 }
 
-func (p *modelConfigProcessor) Process(ctx context.Context, store storage.Storage, repo, path string, info os.FileInfo) (ocispec.Descriptor, error) {
-	desc, err := build.BuildLayer(ctx, store, repo, path)
+func (p *modelConfigProcessor) Process(ctx context.Context, store storage.Storage, repo, path, workDir string) (ocispec.Descriptor, error) {
+	desc, err := build.BuildLayer(ctx, store, repo, path, workDir)
 	if err != nil {
 		return ocispec.Descriptor{}, nil
 	}
 
 	// add config annotations.
-	desc.Annotations = map[string]string{
-		modelspec.AnnotationConfig: "true",
+	if desc.Annotations == nil {
+		desc.Annotations = map[string]string{}
 	}
 
+	desc.Annotations[modelspec.AnnotationConfig] = "true"
 	return desc, nil
 }

pkg/backend/processor/processor.go

@@ -33,5 +33,5 @@ type Processor interface {
 	// then the Process will be called to process the file, otherwise it will be skipped.
 	Identify(ctx context.Context, path string, info os.FileInfo) bool
 	// Process processes the file.
-	Process(ctx context.Context, store storage.Storage, repo, path string, info os.FileInfo) (ocispec.Descriptor, error)
+	Process(ctx context.Context, store storage.Storage, repo, path, workDir string) (ocispec.Descriptor, error)
 }

pkg/backend/processor/readme.go

@@ -43,16 +43,17 @@ func (p *readmeProcessor) Identify(_ context.Context, path string, info os.FileI
 	return info.Name() == "README.md" || info.Name() == "README"
 }
 
-func (p *readmeProcessor) Process(ctx context.Context, store storage.Storage, repo, path string, info os.FileInfo) (ocispec.Descriptor, error) {
-	desc, err := build.BuildLayer(ctx, store, repo, path)
+func (p *readmeProcessor) Process(ctx context.Context, store storage.Storage, repo, path, workDir string) (ocispec.Descriptor, error) {
+	desc, err := build.BuildLayer(ctx, store, repo, path, workDir)
 	if err != nil {
 		return ocispec.Descriptor{}, nil
 	}
 
 	// add readme annotations.
-	desc.Annotations = map[string]string{
-		modelspec.AnnotationReadme: "true",
+	if desc.Annotations == nil {
+		desc.Annotations = map[string]string{}
 	}
 
+	desc.Annotations[modelspec.AnnotationReadme] = "true"
 	return desc, nil
 }

pkg/backend/progress.go

@@ -59,6 +59,7 @@ func (p *ProgressBar) Add(prompt string, desc ocispec.Descriptor, reader io.Read
 	// create a new bar if it does not exist.
 	bar := p.mpb.New(desc.Size,
 		mpbv8.BarStyle().Rbound("|"),
+		mpbv8.BarFillerClearOnComplete(),
 		mpbv8.PrependDecorators(
 			decor.Name(fmt.Sprintf("%s%s", prompt, desc.Digest.String())),
 		),

pkg/spec/annotations.go

@@ -68,4 +68,7 @@ const (
 
 	// AnnotationModel is the annotation key for the layer is a model file (boolean), such as `true` or `false`.
 	AnnotationModel = "org.cnai.model.model"
+
+	// AnnotationFilepath is the annotation key for the file path of the layer.
+	AnnotationFilepath = "org.cnai.model.filepath"
 )