sort compliance level according to RFC2119

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

Author: liangchenye

cmd/runtimetest/main.go

@@ -322,7 +322,7 @@ func validateDefaultFS(spec *rspec.Spec) error {
 
 	mountInfos, err := mount.GetMounts()
 	if err != nil {
-		return ociErr.NewOCIError(ociErr.DefaultFilesystems, err.Error())
+		return ociErr.NewError(ociErr.DefaultFilesystems, err.Error())
 	}
 
 	mountsMap := make(map[string]string)
@@ -332,7 +332,7 @@ func validateDefaultFS(spec *rspec.Spec) error {
 
 	for fs, fstype := range defaultFS {
 		if !(mountsMap[fs] == fstype) {
-			return ociErr.NewOCIError(ociErr.DefaultFilesystems, fmt.Sprintf("%v must exist and expected type is %v", fs, fstype))
+			return ociErr.NewError(ociErr.DefaultFilesystems, fmt.Sprintf("%v must exist and expected type is %v", fs, fstype))
 		}
 	}
 
@@ -702,7 +702,7 @@ func validate(context *cli.Context) error {
 		err := v.test(spec)
 		t.Ok(err == nil, v.description)
 		if err != nil {
-			if e, ok := err.(*ociErr.OCIError); ok && e.Level < complianceLevel {
+			if e, ok := err.(*ociErr.Error); ok && e.Level < complianceLevel {
 				continue
 			}
 			validationErrors = multierror.Append(validationErrors, err)
@@ -714,7 +714,7 @@ func validate(context *cli.Context) error {
 			err := v.test(spec)
 			t.Ok(err == nil, v.description)
 			if err != nil {
-				if e, ok := err.(*ociErr.OCIError); ok && e.Level < complianceLevel {
+				if e, ok := err.(*ociErr.Error); ok && e.Level < complianceLevel {
 					continue
 				}
 				validationErrors = multierror.Append(validationErrors, err)
@@ -746,7 +746,7 @@ func main() {
 		cli.StringFlag{
 			Name:  "compliance-level",
 			Value: "must",
-			Usage: "Compliance level (must or should)",
+			Usage: "Compliance level (may, should or must)",
 		},
 	}
 

man/oci-runtime-tool.1.md

@@ -33,7 +33,7 @@ oci-runtime-tool is a collection of tools for working with the [OCI runtime spec
   Log level (panic, fatal, error, warn, info, or debug) (default: "error").
 
 **--compliance-level**=LEVEL
-  Compliance level (must or should) (default: "must").
+  Compliance level (may, should or must) (default: "must").
 
 **-v**, **--version**
   Print version information.

validate/error.go

@@ -10,27 +10,31 @@ import (
 type ComplianceLevel int
 
 const (
-	ComplianceOptional ComplianceLevel = iota
-	ComplianceMay
-	ComplianceRecommended
+	// MAY-level
+	ComplianceMay ComplianceLevel = iota
+	ComplianceOptional
+	// SHOULD-level
 	ComplianceShould
 	ComplianceShouldNot
+	ComplianceRecommended
+	ComplianceNotRecommended
+	// MUST-level
+	ComplianceMust
+	ComplianceMustNot
 	ComplianceShall
 	ComplianceShallNot
 	ComplianceRequired
-	ComplianceMustNot
-	ComplianceMust
 )
 
-// OCIErrorCode represents the compliance content
-type OCIErrorCode int
+// ErrorCode represents the compliance content
+type ErrorCode int
 
 const (
-	DefaultFilesystems OCIErrorCode = iota
+	DefaultFilesystems ErrorCode = iota
 )
 
-// OCIError represents an error with compliance level and OCI reference
-type OCIError struct {
+// Error represents an error with compliance level and OCI reference
+type Error struct {
 	Level     ComplianceLevel
 	Reference string
 	Err       error
@@ -39,31 +43,49 @@ type OCIError struct {
 //FIXME: change to tagged spec releases
 const referencePrefix = "https://github.com/opencontainers/runtime-spec/blob/master/"
 
-var ociErrors = map[OCIErrorCode]OCIError{
-	DefaultFilesystems: OCIError{Level: ComplianceShould, Reference: "config-linux.md#default-filesystems"},
+var ociErrors = map[ErrorCode]Error{
+	DefaultFilesystems: Error{Level: ComplianceShould, Reference: "config-linux.md#default-filesystems"},
 }
 
 // ParseLevel takes a string level and returns the OCI compliance level constant
 func ParseLevel(level string) ComplianceLevel {
 	switch strings.ToUpper(level) {
+	case "MAY":
+		fallthrough
+	case "OPTIONAL":
+		return ComplianceMay
 	case "SHOULD":
+		fallthrough
+	case "SHOULDNOT":
+		fallthrough
+	case "RECOMMENDED":
+		fallthrough
+	case "NOTRECOMMENDED":
 		return ComplianceShould
 	case "MUST":
+		fallthrough
+	case "MUSTNOT":
+		fallthrough
+	case "SHALL":
+		fallthrough
+	case "SHALLNOT":
+		fallthrough
+	case "REQUIRED":
 		return ComplianceMust
 	default:
 		return ComplianceMust
 	}
 }
 
-// NewOCIError creates an OCIError by OCIErrorCode and message
-func NewOCIError(code OCIErrorCode, msg string) error {
+// NewError creates an Error by ErrorCode and message
+func NewError(code ErrorCode, msg string) error {
 	err := ociErrors[code]
 	err.Err = errors.New(msg)
 
 	return &err
 }
 
 // Error returns the error message with OCI reference
-func (oci *OCIError) Error() string {
+func (oci *Error) Error() string {
 	return fmt.Sprintf("%s\nRefer to: %s%s", oci.Err.Error(), referencePrefix, oci.Reference)
 }