Propagate json error object to the caller

When plugin errors out, it prints out a JSON object to stdout
describing the failure. This object needs to be propagated out
through the plugins and to the container runtime. This change
also adds Print method to both the result and error structs
for easy serialization to stdout.
This commit is contained in:
Eugene Yakubovich 2015-06-01 17:34:00 -07:00
parent a6a822268c
commit 31c0dbf110
3 changed files with 64 additions and 28 deletions

View File

@ -41,6 +41,22 @@ func Find(plugin string) string {
return ""
}
func pluginErr(err error, output []byte) error {
if _, ok := err.(*exec.ExitError); ok {
emsg := Error{}
if perr := json.Unmarshal(output, &emsg); perr != nil {
return fmt.Errorf("netplugin failed but error parsing its diagnostic message %q: %v", string(output), perr)
}
details := ""
if emsg.Details != "" {
details = fmt.Sprintf("; %v", emsg.Details)
}
return fmt.Errorf("%v%v", emsg.Msg, details)
}
return err
}
// ExecAdd executes IPAM plugin, assuming CNI_COMMAND == ADD.
// Parses and returns resulting IPConfig
func ExecAdd(plugin string, netconf []byte) (*Result, error) {
@ -63,7 +79,7 @@ func ExecAdd(plugin string, netconf []byte) (*Result, error) {
Stderr: os.Stderr,
}
if err := c.Run(); err != nil {
return nil, err
return nil, pluginErr(err, stdout.Bytes())
}
res := &Result{}
@ -82,13 +98,19 @@ func ExecDel(plugin string, netconf []byte) error {
return fmt.Errorf("could not find %q plugin", plugin)
}
stdout := &bytes.Buffer{}
c := exec.Cmd{
Path: pluginPath,
Args: []string{pluginPath},
Stdin: bytes.NewBuffer(netconf),
Stdout: stdout,
Stderr: os.Stderr,
}
return c.Run()
if err := c.Run(); err != nil {
return pluginErr(err, stdout.Bytes())
}
return nil
}
// ConfigureIface takes the result of IPAM plugin and
@ -124,22 +146,3 @@ func ConfigureIface(ifName string, res *Result) error {
return nil
}
// PrintResult writes out prettified Result JSON to stdout
func PrintResult(res *Result) error {
return prettyPrint(res)
}
// PrintError writes out prettified Error JSON to stdout
func PrintError(err *Error) error {
return prettyPrint(err)
}
func prettyPrint(obj interface{}) error {
data, err := json.MarshalIndent(obj, "", " ")
if err != nil {
return err
}
_, err = os.Stdout.Write(data)
return err
}

View File

@ -17,6 +17,7 @@ package plugin
import (
"encoding/json"
"net"
"os"
"github.com/appc/cni/pkg/ip"
)
@ -36,6 +37,10 @@ type Result struct {
IP6 *IPConfig `json:"ip6,omitempty"`
}
func (r *Result) Print() error {
return prettyPrint(r)
}
// IPConfig contains values necessary to configure an interface
type IPConfig struct {
IP net.IPNet
@ -54,6 +59,14 @@ type Error struct {
Details string `json:"details,omitempty"`
}
func (e *Error) Error() string {
return e.Msg
}
func (e *Error) Print() error {
return prettyPrint(e)
}
// net.IPNet is not JSON (un)marshallable so this duality is needed
// for our custom ip.IPNet type
@ -110,3 +123,12 @@ func (r *Route) MarshalJSON() ([]byte, error) {
return json.Marshal(rt)
}
func prettyPrint(obj interface{}) error {
data, err := json.MarshalIndent(obj, "", " ")
if err != nil {
return err
}
_, err = os.Stdout.Write(data)
return err
}

View File

@ -64,12 +64,12 @@ func PluginMain(cmdAdd, cmdDel func(_ *CmdArgs) error) {
}
if argsMissing {
die("required env variables missing")
dieMsg("required env variables missing")
}
stdinData, err := ioutil.ReadAll(os.Stdin)
if err != nil {
die("error reading from stdin: %v", err)
dieMsg("error reading from stdin: %v", err)
}
cmdArgs := &CmdArgs{
@ -89,18 +89,29 @@ func PluginMain(cmdAdd, cmdDel func(_ *CmdArgs) error) {
err = cmdDel(cmdArgs)
default:
die("unknown CNI_COMMAND: %v", cmd)
dieMsg("unknown CNI_COMMAND: %v", cmd)
}
if err != nil {
die(err.Error())
if e, ok := err.(*plugin.Error); ok {
// don't wrap Error in Error
dieErr(e)
}
dieMsg(err.Error())
}
}
func die(f string, args ...interface{}) {
plugin.PrintError(&plugin.Error{
func dieMsg(f string, args ...interface{}) {
e := &plugin.Error{
Code: 100,
Msg: fmt.Sprintf(f, args...),
})
}
dieErr(e)
}
func dieErr(e *plugin.Error) {
if err := e.Print(); err != nil {
log.Print("Error writing error JSON to stdout: ", err)
}
os.Exit(1)
}