1- package error
1+ // Package specerror implements runtime-spec-specific tooling for
2+ // tracking RFC 2119 violations.
3+ package specerror
24
35import (
4- "errors"
56 "fmt"
67
78 "github.com/hashicorp/go-multierror"
9+ rfc2119 "github.com/opencontainers/runtime-tools/error"
810)
911
1012const referenceTemplate = "https://github.com/opencontainers/runtime-spec/blob/v%s/%s"
1113
12- // SpecErrorCode represents the compliance content.
13- type SpecErrorCode int
14+ // Code represents the spec violation, enumerating both
15+ // configuration violations and runtime violations.
16+ type Code int
1417
1518const (
1619 // NonError represents that an input is not an error
17- NonError SpecErrorCode = iota
20+ NonError Code = iota
1821 // NonRFCError represents that an error is not a rfc2119 error
1922 NonRFCError
2023
@@ -53,10 +56,19 @@ const (
5356)
5457
5558type errorTemplate struct {
56- Level Level
59+ Level rfc2119. Level
5760 Reference func (version string ) (reference string , err error )
5861}
5962
63+ // Error represents a runtime-spec violation.
64+ type Error struct {
65+ // Err holds the RFC 2119 violation.
66+ Err rfc2119.Error
67+
68+ // Code is a matchable holds a Code
69+ Code Code
70+ }
71+
6072var (
6173 containerFormatRef = func (version string ) (reference string , err error ) {
6274 return fmt .Sprintf (referenceTemplate , version , "bundle.md#container-format" ), nil
@@ -75,62 +87,69 @@ var (
7587 }
7688)
7789
78- var ociErrors = map [SpecErrorCode ]errorTemplate {
90+ var ociErrors = map [Code ]errorTemplate {
7991 // Bundle.md
8092 // Container Format
81- ConfigFileExistence : {Level : Must , Reference : containerFormatRef },
82- ArtifactsInSingleDir : {Level : Must , Reference : containerFormatRef },
93+ ConfigFileExistence : {Level : rfc2119 . Must , Reference : containerFormatRef },
94+ ArtifactsInSingleDir : {Level : rfc2119 . Must , Reference : containerFormatRef },
8395
8496 // Config.md
8597 // Specification Version
86- SpecVersion : {Level : Must , Reference : specVersionRef },
98+ SpecVersion : {Level : rfc2119 . Must , Reference : specVersionRef },
8799 // Root
88- RootOnNonHyperV : {Level : Required , Reference : rootRef },
89- RootOnHyperV : {Level : Must , Reference : rootRef },
100+ RootOnNonHyperV : {Level : rfc2119 . Required , Reference : rootRef },
101+ RootOnHyperV : {Level : rfc2119 . Must , Reference : rootRef },
90102 // TODO: add tests for 'PathFormatOnWindows'
91- PathFormatOnWindows : {Level : Must , Reference : rootRef },
92- PathName : {Level : Should , Reference : rootRef },
93- PathExistence : {Level : Must , Reference : rootRef },
94- ReadonlyFilesystem : {Level : Must , Reference : rootRef },
95- ReadonlyOnWindows : {Level : Must , Reference : rootRef },
103+ PathFormatOnWindows : {Level : rfc2119 . Must , Reference : rootRef },
104+ PathName : {Level : rfc2119 . Should , Reference : rootRef },
105+ PathExistence : {Level : rfc2119 . Must , Reference : rootRef },
106+ ReadonlyFilesystem : {Level : rfc2119 . Must , Reference : rootRef },
107+ ReadonlyOnWindows : {Level : rfc2119 . Must , Reference : rootRef },
96108
97109 // Config-Linux.md
98110 // Default Filesystems
99- DefaultFilesystems : {Level : Should , Reference : defaultFSRef },
111+ DefaultFilesystems : {Level : rfc2119 . Should , Reference : defaultFSRef },
100112
101113 // Runtime.md
102114 // Create
103- CreateWithID : {Level : Must , Reference : runtimeCreateRef },
104- CreateWithUniqueID : {Level : Must , Reference : runtimeCreateRef },
105- CreateNewContainer : {Level : Must , Reference : runtimeCreateRef },
115+ CreateWithID : {Level : rfc2119 .Must , Reference : runtimeCreateRef },
116+ CreateWithUniqueID : {Level : rfc2119 .Must , Reference : runtimeCreateRef },
117+ CreateNewContainer : {Level : rfc2119 .Must , Reference : runtimeCreateRef },
118+ }
119+
120+ // Error returns the error message with specification reference.
121+ func (err * Error ) Error () string {
122+ return err .Err .Error ()
106123}
107124
108125// NewError creates an Error referencing a spec violation. The error
109- // can be cast to a *runtime-tools.error. Error for extracting
110- // structured information about the level of the violation and a
111- // reference to the violated spec condition.
126+ // can be cast to an * Error for extracting structured information
127+ // about the level of the violation and a reference to the violated
128+ // spec condition.
112129//
113130// A version string (for the version of the spec that was violated)
114131// must be set to get a working URL.
115- func NewError (code SpecErrorCode , msg string , version string ) ( err error ) {
132+ func NewError (code Code , err error , version string ) error {
116133 template := ociErrors [code ]
117- reference , err := template .Reference (version )
118- if err != nil {
119- return err
134+ reference , err2 := template .Reference (version )
135+ if err2 != nil {
136+ return err2
120137 }
121138 return & Error {
122- Level : template .Level ,
123- Reference : reference ,
124- Err : errors .New (msg ),
125- ErrCode : int (code ),
139+ Err : rfc2119.Error {
140+ Level : template .Level ,
141+ Reference : reference ,
142+ Err : err ,
143+ },
144+ Code : code ,
126145 }
127146}
128147
129148// FindError finds an error from a source error (multiple error) and
130- // returns the error code if founded .
149+ // returns the error code if found .
131150// If the source error is nil or empty, return NonError.
132151// If the source error is not a multiple error, return NonRFCError.
133- func FindError (err error , code SpecErrorCode ) SpecErrorCode {
152+ func FindError (err error , code Code ) Code {
134153 if err == nil {
135154 return NonError
136155 }
@@ -141,7 +160,7 @@ func FindError(err error, code SpecErrorCode) SpecErrorCode {
141160 }
142161 for _ , e := range merr .Errors {
143162 if rfcErr , ok := e .(* Error ); ok {
144- if rfcErr .ErrCode == int ( code ) {
163+ if rfcErr .Code == code {
145164 return code
146165 }
147166 }
0 commit comments