specerror: Pull runtime-spec-specific error handling into its own package#455
Merged
liangchenye merged 2 commits intoopencontainers:masterfrom Sep 1, 2017
Merged
Conversation
wking
force-pushed
the
specerror-package
branch
from
9343391 to
c3a8d2c
Compare
Mashimiao
reviewed
Aug 31, 2017
validation/validation_test.go
Outdated
| {"", false, rerr.NewError(rerr.CreateWithID, "'Create' MUST generate an error if the ID is not provided", rspecs.Version)}, | ||
| {containerID, true, rerr.NewError(rerr.CreateNewContainer, "'Create' MUST create a new container", rspecs.Version)}, | ||
| {containerID, false, rerr.NewError(rerr.CreateWithUniqueID, "'Create' MUST generate an error if the ID provided is not unique", rspecs.Version)}, | ||
| {"", false, specerror.NewError(specerror.CreateWithID, "'Create' MUST generate an error if the ID is not provided", rspecs.Version)}, |
There was a problem hiding this comment.
I'm fine with new format of NewError(), but it seems you leave behind here three place. I wonder why there is no error when compiling.
Member
There was a problem hiding this comment.
validation_test.go will not run in our CI.
Contributor
Author
Member
|
I'm ok with this change. Only the test case issue need to be fixed. @wking |
wking
force-pushed
the
specerror-package
branch
from
c3a8d2c to
7e95c6f
Compare
…kage With 8f4d367 (error: Pull the RFC 2119 error representation into its own package, 2017-07-28, opencontainers#437), I'd created a package that was completely independent of runtime-spec. As I pointed out in that commit message, this made it possible for image-tools and other projects to reuse the generic RFC 2119 handling (which they care about) without involving the runtime-spec-specific error enumeration and such (which they don't care about). In 2520212 (add stretchr/testify/assert pkgs; use rfc code in bundle validation, 2017-08-29, opencontainers#451), some runtime-spec-specific functionality leaked into the error package. I'd recommended keeping configuration and runtime requirements separate [1], because you're unlikely to be testing both of those at once. But Liang wanted them collected [2,3]. And the NewError and FindError utilities would be the same regardless of target, so that's a good argument for keeping them together. This commit moves the runtime-spec-specific functionality into a new package where both config and runtime validators can share it, but where it won't pollute the generic RFC 2119 error package. I've also changed NewError to take an error argument instead of a string message, because creating an error from a string is easy (e.g. with fmt.Errorf(...)), and using an error allows you to preserve any additional structured information from a system error (e.g. as returned by GetMounts). [1]: opencontainers#451 (comment) [2]: opencontainers#451 (comment) [3]: opencontainers#451 (comment) Signed-off-by: W. Trevor King <wking@tremily.us>
Remove OCI references from the comments, because this is a generic RFC 2119 package and has nothing OCI-specific. Also document the Error properties. Signed-off-by: W. Trevor King <wking@tremily.us>
wking
force-pushed
the
specerror-package
branch
from
7e95c6f to
f9152f1
Compare
Contributor
Author
|
LGTM |
1 similar comment
|
LGTM |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
With #437, I'd created a package that was completely independent of runtime-spec. As I pointed out in that PR, this made it possible for image-tools and other projects to reuse the generic RFC 2119 handling (which they care about) without involving the runtime-spec-specific error enumeration and such (which they don't care about).
In #451, some runtime-spec-specific functionality leaked into the error package. I'd recommended keeping configuration and runtime requirements separate, because you're unlikely to be testing both of those at once. But @liangchenye wanted them collected. And the
NewErrorandFindErrorutilities would be the same regardless of target, so that's a good argument for keeping them together. This commit moves the runtime-spec-specific functionality into a newspecerrorpackage where both config and runtime validators can share it, but where it won't pollute the generic RFC 2119errorpackage.I've also changed
NewErrorto take an error argument instead of a string message, because creating an error from a string is easy (e.g. withfmt.Errorf(…)), and using an error allows you to preserve any additional structured information from a system error (e.g. as returned byGetMounts).The second commit in this PR cleans up some of the generic RFC 2119 package's godocs.