Skip to content

validation: create: don't skip errors on state #626

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
liangchenye merged 1 commit into from
May 3, 2018
Merged

validation: create: don't skip errors on state #626

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions validation/create.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,14 +70,13 @@ func main() {

if err == nil {
state, err := r.State()
t.Ok(err == nil && state.ID == c.id, "'state' MUST return the state of a container")
Copy link
Copy Markdown
Contributor

@wking wking Apr 18, 2018 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

While we're touching this line, we may want to use the appropriate spec error. In this case, a failed state call would be violating the combination of EntityOperSameContainer, QueryStateImplement, and, from the CLI spec, “The runtime MUST support the entire API defined in this specification” and “Exit code: Zero if the state was successfully written to stdout and non-zero on errors” (which should really have a MUST, I'll file a PR for that). From among those, the most important seems like QueryStateImplement. Following this pattern would give us something like:

err = specerror.NewError(specerror.QueryStateImplement, errors.New("'state' returns the state of the container"), g.Config.Version)
runtimeError, ok := err.(*specerror.Error)
if !ok {
  return util.Fatal(fmt.Errorf("cannot convert %v to a runtime-spec error", err))
}
state, err := r.State()
t.Ok(err == nil && state.ID == c.id, runtimeError.Err.Err.Error())
diagnostic = map[string]string{
  "level": runtimeError.Err.Level.String(),
  "reference": runtimeError.Err.Reference,
  "container ID" = c.id,
}
if err == nil {
  diagnostic["state ID"] = state.ID
} else {
  diagnostic["error"] = err
  if e, ok := err.(*exec.ExitError); ok && len(e.Stderr) > 0 {
    diagnostic["stderr"] = string(e.Stderr)
  }
}
t.YAML(diagnostic)

Although we could make that a bit easier by adding a helper like func NewRFCError(code Code, err error, version string) rfc2119.Error to specerror. I've filed #627 to add NewRFCError.

if err == nil {
t.Ok(state.ID == c.id, "'state' MUST return the state of a container")
t.YAML(map[string]string{
"container ID": c.id,
"state ID": state.ID,
})
} else {
t.Skip(1, "'state' MUST return the state of a container")
Copy link
Copy Markdown
Contributor

@wking wking Apr 18, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This effectively rolls back part of d8d2396 (#564), but I didn't motivate the skip then, and can't remember why I'd felt it was a good idea. I'm fine returning to to stricter handling like you've done here.

diagnostic = map[string]string{
"error": err.Error(),
}
Expand Down