chore: improved validate

Author: MarcStdt

cmd/scroll_validate.go

@@ -7,6 +7,8 @@ import (
 	"github.com/spf13/cobra"
 )
 
+var strict bool
+
 var ScrollValidateCmd = &cobra.Command{
 	Use:   "validate",
 	Short: "Validates the scroll file",
@@ -24,11 +26,15 @@ var ScrollValidateCmd = &cobra.Command{
 			return fmt.Errorf("failed to load scroll: %w", err)
 		}
 
-		if err := scroll.Validate(); err != nil {
+		if err := scroll.Validate(strict); err != nil {
 			return fmt.Errorf("failed to validate scroll: %w", err)
 		}
 
 		fmt.Println("Scroll validated successfully.")
 		return nil
 	},
 }
+
+func init() {
+	ScrollValidateCmd.Flags().BoolVar(&strict, "strict", false, "Enable strict validation mode")
+}

internal/core/domain/scroll.go

@@ -73,6 +73,7 @@ type File struct {
 
 type Scroll struct {
 	File
+	filePath string
 }
 
 type Procedure struct {
@@ -110,7 +111,9 @@ func NewScroll(scrollDir string) (*Scroll, error) {
 	if err != nil {
 		return nil, fmt.Errorf("failed to read scroll.yaml - %w", err)
 	}
-	scroll := Scroll{}
+	scroll := Scroll{
+		filePath: filePath,
+	}
 	if _, err = scroll.ParseFile(file); err != nil {
 		return nil, err
 	}
@@ -130,7 +133,7 @@ func (sc *Scroll) ParseFile(file []byte) (*Scroll, error) {
 	return sc, nil
 }
 
-func (sc *Scroll) Validate() error {
+func (sc *Scroll) Validate(strict bool) error {
 	if sc.Name == "" {
 		return fmt.Errorf("scroll name is required")
 	}
@@ -174,6 +177,28 @@ func (sc *Scroll) Validate() error {
 			ids[*p.Id] = true
 		}
 	}
+	//scan for files in sc.filePath
+	entries, err := os.ReadDir(sc.filePath)
+	if err != nil {
+		return fmt.Errorf("failed to read scroll directory - %w", err)
+	}
+	for _, entry := range entries {
+		var found = false
+		for fileName := range ScrollFiles {
+			if entry.Name() == fileName {
+				found = true
+				break
+			}
+		}
+		if !found {
+			if !strict {
+				logger.Log().Warn("Directory contains file that is not defined in ScrollFiles", zap.String("file", entry.Name()))
+			} else {
+				return fmt.Errorf("directory contains file that is not defined in ScrollFiles: %s", entry.Name())
+			}
+		}
+	}
+
 	return nil
 }
 
@@ -184,3 +209,12 @@ func (sc *Scroll) CanColdStart() bool {
 func (sc *Scroll) GetColdStartPorts() []Port {
 	return sc.Ports
 }
+
+var ScrollFiles = map[string]ArtifactType{
+	"update":         ArtifactTypeScrollFs,
+	"scroll.yaml":    ArtifactTypeScrollFs,
+	"packet_handler": ArtifactTypeScrollFs,
+	"public":         ArtifactTypeScrollFs,
+	"private":        ArtifactTypeScrollFs,
+	"data":           ArtifactTypeScrollData,
+}

internal/core/services/registry/oci.go

@@ -266,11 +266,13 @@ func (c *OciClient) PackFolders(fs *file.Store, dirs []string, artifactType doma
 // the root has to leaves, one is the real scroll (fs) and the other is meta information about the scroll
 func (c *OciClient) Push(folder string, repo string, tag string, overrides map[string]string, packMeta bool, scrollFile *domain.File) (v1.Descriptor, error) {
 
-	availableFileNames := []string{"update", "scroll.yaml", "packet_handler", "public", "private"}
 	fsFileNames := []string{}
 
 	//check if files exisits (file or folder) and remove from slice if not
-	for _, fileName := range availableFileNames {
+	for fileName, artifactType := range domain.ScrollFiles {
+		if artifactType != domain.ArtifactTypeScrollData {
+			continue
+		}
 		exists, _ := utils.FileExists(filepath.Join(folder, fileName))
 		if exists {
 			fsFileNames = append(fsFileNames, fileName)