use released version as reference; improve Parse error

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

Author: liangchenye

cmd/runtimetest/main.go

@@ -332,7 +332,7 @@ func validateDefaultFS(spec *rspec.Spec) error {
 
 	for fs, fstype := range defaultFS {
 		if !(mountsMap[fs] == fstype) {
-			return ociErr.NewError(ociErr.DefaultFilesystems, fmt.Sprintf("%v must exist and expected type is %v", fs, fstype))
+			return ociErr.NewError(ociErr.DefaultFilesystems, fmt.Sprintf("%v SHOULD exist and expected type is %v", fs, fstype))
 		}
 	}
 
@@ -696,7 +696,11 @@ func validate(context *cli.Context) error {
 	t.Header(0)
 
 	complianceLevelString := context.String("compliance-level")
-	complianceLevel := ociErr.ParseLevel(complianceLevelString)
+	complianceLevel, err := ociErr.ParseLevel(complianceLevelString)
+	if err != nil {
+		complianceLevel = ociErr.ComplianceMust
+		logrus.Warningf("%s, using 'MUST' by default.", err.Error())
+	}
 	var validationErrors error
 	for _, v := range defaultValidations {
 		err := v.test(spec)

completions/bash/oci-runtime-tool

@@ -121,8 +121,9 @@ __oci-runtime-tool_complete_log_level() {
 
 __oci-runtime-tool_complete_compliance_level() {
 	COMPREPLY=( $( compgen -W "
-		must
+		may
 		should
+		must
 	" -- "$cur" ) )
 }
 

validate/error.go

@@ -4,32 +4,51 @@ import (
 	"errors"
 	"fmt"
 	"strings"
+
+	rspec "github.com/opencontainers/runtime-spec/specs-go"
 )
 
 // ComplianceLevel represents the OCI compliance levels
 type ComplianceLevel int
 
 const (
 	// MAY-level
+
+	// ComplianceMay represents 'MAY' in RFC2119
 	ComplianceMay ComplianceLevel = iota
+	// ComplianceOptional represents 'OPTIONAL' in RFC2119
 	ComplianceOptional
+
 	// SHOULD-level
+
+	// ComplianceShould represents 'SHOULD' in RFC2119
 	ComplianceShould
+	// ComplianceShouldNot represents 'SHOULD NOT' in RFC2119
 	ComplianceShouldNot
+	// ComplianceRecommended represents 'RECOMMENDED' in RFC2119
 	ComplianceRecommended
+	// ComplianceNotRecommended represents 'NOT RECOMMENDED' in RFC2119
 	ComplianceNotRecommended
+
 	// MUST-level
+
+	// ComplianceMust represents 'MUST' in RFC2119
 	ComplianceMust
+	// ComplianceMustNot represents 'MUST NOT' in RFC2119
 	ComplianceMustNot
+	// ComplianceShall represents 'SHALL' in RFC2119
 	ComplianceShall
+	// ComplianceShallNot represents 'SHALL NOT' in RFC2119
 	ComplianceShallNot
+	// ComplianceRequired represents 'REQUIRED' in RFC2119
 	ComplianceRequired
 )
 
 // ErrorCode represents the compliance content
 type ErrorCode int
 
 const (
+	// DefaultFilesystems represents the error code of default filesystems test
 	DefaultFilesystems ErrorCode = iota
 )
 
@@ -40,28 +59,27 @@ type Error struct {
 	Err       error
 }
 
-//FIXME: change to tagged spec releases
-const referencePrefix = "https://github.com/opencontainers/runtime-spec/blob/master/"
+const referencePrefix = "https://github.com/opencontainers/runtime-spec/blob"
 
 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 {
+func ParseLevel(level string) (ComplianceLevel, error) {
 	switch strings.ToUpper(level) {
 	case "MAY":
 		fallthrough
 	case "OPTIONAL":
-		return ComplianceMay
+		return ComplianceMay, nil
 	case "SHOULD":
 		fallthrough
 	case "SHOULDNOT":
 		fallthrough
 	case "RECOMMENDED":
 		fallthrough
 	case "NOTRECOMMENDED":
-		return ComplianceShould
+		return ComplianceShould, nil
 	case "MUST":
 		fallthrough
 	case "MUSTNOT":
@@ -71,10 +89,11 @@ func ParseLevel(level string) ComplianceLevel {
 	case "SHALLNOT":
 		fallthrough
 	case "REQUIRED":
-		return ComplianceMust
-	default:
-		return ComplianceMust
+		return ComplianceMust, nil
 	}
+
+	var l ComplianceLevel
+	return l, fmt.Errorf("%q is not a valid compliance level", level)
 }
 
 // NewError creates an Error by ErrorCode and message
@@ -87,5 +106,5 @@ func NewError(code ErrorCode, msg string) error {
 
 // Error returns the error message with OCI reference
 func (oci *Error) Error() string {
-	return fmt.Sprintf("%s\nRefer to: %s%s", oci.Err.Error(), referencePrefix, oci.Reference)
+	return fmt.Sprintf("%s\nRefer to: %s/v%s/%s", oci.Err.Error(), referencePrefix, rspec.Version, oci.Reference)
 }