Merge branch 'master' into add-regsitry-utils

Signed-off-by: Lee Calcote <[email protected]>

Author: leecalcote

files/error.go

@@ -3,6 +3,7 @@ package files
 import (
 	"fmt"
 	"maps"
+	"path/filepath"
 	"slices"
 	"strings"
 
@@ -104,12 +105,14 @@ func ErrInvalidYaml(fileName string, err error) error {
 	probableCause := []string{
 		"The YAML file may contain syntax errors, such as incorrect indentation, missing colons, or invalid characters.",
 		"The file may have been corrupted or improperly edited.",
+		"The YAML does not conform to the Meshery model schema.",
 	}
 
 	remedy := []string{
 		"Review the YAML syntax in the file and correct any errors.",
 		"Use a YAML validator or linter to identify and fix issues.",
 		"Ensure the file adheres to the YAML specification.",
+		"Ensure the YAML conforms to the Meshery model schema. You can refer to the following documentation for more details: https://docs.meshery.io/project/contributing/contributing-models",
 	}
 
 	return errors.New(ErrInvalidYamlCode, errors.Critical, sdescription, ldescription, probableCause, remedy)
@@ -129,13 +132,15 @@ func ErrInvalidJson(fileName string, err error) error {
 		"The JSON file may contain syntax errors, such as missing commas, curly braces, or square brackets.",
 		"The file may have been corrupted or improperly edited.",
 		"Special characters or escape sequences may not have been properly formatted.",
+		"The JSON does not conform to the Meshery model schema.",
 	}
 
 	remedy := []string{
 		"Review the JSON syntax in the file and correct any errors.",
 		"Use a JSON validator or linter to identify and fix issues.",
 		"Ensure the file adheres to the JSON specification (e.g., double quotes for keys and strings).",
 		"Check for common issues like trailing commas or unescaped special characters.",
+		"Ensure the JSON conforms to the Meshery model schema. You can refer to the following documentation for more details: https://docs.meshery.io/project/contributing/contributing-models",
 	}
 
 	return errors.New(ErrInvalidJsonCode, errors.Critical, sdescription, ldescription, probableCause, remedy)
@@ -354,3 +359,57 @@ func ErrWaklingLocalDirectory(err error) error {
 func ErrDecodePattern(err error) error {
 	return errors.New(ErrDecodePatternCode, errors.Alert, []string{"Error failed to decode design data into go slice"}, []string{err.Error()}, []string{}, []string{})
 }
+
+var (
+	ErrInvalidModelCode        = "meshkit-11301"
+	ErrInvalidModelArchiveCode = "meshkit-11302"
+	ErrEmptyModelCode          = "meshkit-11303"
+)
+
+func ErrInvalidModel(operation string, filename string, err error) error {
+	// return error based on file extension
+	fileExt := filepath.Ext(filename)
+
+	switch {
+	case fileExt == ".json":
+		return ErrInvalidJson(filename, err)
+	case fileExt == ".yaml", fileExt == ".yml":
+		return ErrInvalidYaml(filename, err)
+	case strings.HasPrefix(fileExt, ".tar"), strings.HasPrefix(fileExt, ".tgz"), strings.HasPrefix(fileExt, ".tar.gz"):
+		// check prefix as random numeric suffix is appended to archive during file handling (eg: .tar becomes .tar263831)
+		return ErrInvalidModelArchive(filename, err)
+	default:
+		supportedExtensions := slices.Collect(maps.Keys(ValidIacExtensions))
+		supportedExtensions = slices.DeleteFunc(supportedExtensions, func(ext string) bool {
+			return ext == ".zip"
+		})
+		return ErrUnsupportedExtensionForOperation(operation, filename, fileExt, supportedExtensions)
+	}
+}
+
+func ErrInvalidModelArchive(fileName string, err error) error {
+	sdescription := []string{
+		fmt.Sprintf("Failed to extract the archive '%s'.", fileName),
+	}
+
+	ldescription := []string{
+		fmt.Sprintf("An error occurred while attempting to extract the TAR archive '%s'.", fileName),
+		fmt.Sprintf("Error details: %s", err.Error()),
+	}
+
+	probableCause := []string{
+		"The archive may be non OCI compliant.",
+		"The archive may have been created with a different tool or version that is incompatible.",
+	}
+
+	remedy := []string{
+		"Make sure the archive is OCI compliant. Meshery Models should be OCI compliant archive.",
+		"Ensure the archive is created using a compatible tool (eg: ORAS) and version that follows OCI standards.",
+	}
+
+	return errors.New(ErrInvalidModelArchiveCode, errors.Critical, sdescription, ldescription, probableCause, remedy)
+}
+
+func ErrEmptyModel() error {
+	return errors.New(ErrEmptyModelCode, errors.Alert, []string{"No component found in model provided."}, []string{"No component found in model provided. Models must have at least one component."}, []string{}, []string{})
+}

models/registration/dir.go

@@ -9,6 +9,7 @@ import (
 	"github.com/layer5io/meshkit/models/meshmodel/entity"
 	"github.com/layer5io/meshkit/models/oci"
 
+	meshkitFileUtils "github.com/layer5io/meshkit/files"
 	"github.com/layer5io/meshkit/utils"
 
 	"github.com/meshery/schemas/models/v1alpha3/relationship"
@@ -48,12 +49,7 @@ func (d Dir) PkgUnit(regErrStore RegistrationErrorStore) (_ PackagingUnit, err e
 	// Process the path (file or directory)
 	err = processDir(d.dirpath, &pkg, regErrStore)
 	if err != nil {
-		modelName := ""
-		if !reflect.ValueOf(pkg.Model).IsZero() {
-			modelName = pkg.Model.Name
-		}
-		regErrStore.InsertEntityRegError("", modelName, entity.EntityType("unknown"), filename, ErrDirPkgUnitParseFail(d.dirpath, fmt.Errorf("could not process the path: %w", err)))
-		return pkg, ErrDirPkgUnitParseFail(d.dirpath, fmt.Errorf("could not process the path: %w", err))
+		return pkg, err
 	}
 
 	if reflect.ValueOf(pkg.Model).IsZero() {
@@ -105,6 +101,7 @@ func processDir(dirPath string, pkg *PackagingUnit, regErrStore RegistrationErro
 			tempDirs = append(tempDirs, tempDir)
 			err = oci.UnCompressOCIArtifact(path, tempDir)
 			if err != nil {
+				err := meshkitFileUtils.ErrUnCompressOCIArtifact(err)
 				regErrStore.InsertEntityRegError("", "", entity.EntityType("unknown"), filepath.Base(path), err)
 				regErrStore.AddInvalidDefinition(path, err)
 				return nil
@@ -127,6 +124,7 @@ func processDir(dirPath string, pkg *PackagingUnit, regErrStore RegistrationErro
 			}
 			tempDirs = append(tempDirs, tempDir)
 			if err := utils.ExtractFile(path, tempDir); err != nil {
+				err := meshkitFileUtils.ErrFailedToExtractArchive(filepath.Base(path), err)
 				regErrStore.InsertEntityRegError("", "", entity.EntityType("unknown"), filepath.Base(path), err)
 				regErrStore.AddInvalidDefinition(path, err)
 				return nil
@@ -139,16 +137,20 @@ func processDir(dirPath string, pkg *PackagingUnit, regErrStore RegistrationErro
 		}
 
 		content := data
-		content, err = utils.YAMLToJSON(content)
-		if err != nil {
-			regErrStore.InsertEntityRegError("", "", entity.EntityType("unknown"), filepath.Base(path), err)
-			return nil
+		if utils.IsYaml(path) {
+			content, err = utils.YAMLToJSON(content)
+			if err != nil {
+				regErrStore.InsertEntityRegError("", "", entity.EntityType("unknown"), filepath.Base(path), err)
+				return nil
+			}
 		}
+
 		// Determine the entity type
 		entityType, err := utils.FindEntityType(content)
 		if err != nil {
-			regErrStore.InsertEntityRegError("", "", entity.EntityType("unknown"), filepath.Base(path), err)
-			regErrStore.AddInvalidDefinition(path, err)
+			errMsg := meshkitFileUtils.ErrInvalidModel("import", filepath.Base(path), err)
+			regErrStore.InsertEntityRegError("", filepath.Base(path), entity.EntityType("unknown"), filepath.Base(path), errMsg)
+			regErrStore.AddInvalidDefinition(path, errMsg)
 			return nil
 		}
 

schemas/configuration/modelImport.json

@@ -23,7 +23,7 @@
           "file": {
             "type": "string",
             "format": "file",
-            "description": "Browse the filter file from your file system",
+            "description": "Browse the model file from your file system. Ensure it's an OCI artifact in .tar, .tar.gz, or .tgz format.",
             "x-rjsf-grid-area": "12"
           }
         },

schemas/configuration/uiSchemaModelImport.json

@@ -2,5 +2,10 @@
   "uploadType": {
     "ui:widget": "radio"
   },
+
+  "url":{
+    "ui:disabled": true
+  },
+
   "ui:order": ["uploadType", "file", "url"]
 }