1c576e9043
Fairly straight forward. It became necessary to wrap `Plugin.Err` with a type
which implements `encoding.MarshalText` in order to have that field rendered
properly in the `docker info -f '{{json}}'` output.
Since I changed the type somewhat I also added a unit test for `formatInfo`.
Signed-off-by: Ian Campbell <ijc@docker.com>
44 lines
1.3 KiB
Go
44 lines
1.3 KiB
Go
package manager
|
|
|
|
import (
|
|
"github.com/pkg/errors"
|
|
)
|
|
|
|
// pluginError is set as Plugin.Err by NewPlugin if the plugin
|
|
// candidate fails one of the candidate tests. This exists primarily
|
|
// to implement encoding.TextMarshaller such that rendering a plugin as JSON
|
|
// (e.g. for `docker info -f '{{json .CLIPlugins}}'`) renders the Err
|
|
// field as a useful string and not just `{}`. See
|
|
// https://github.com/golang/go/issues/10748 for some discussion
|
|
// around why the builtin error type doesn't implement this.
|
|
type pluginError struct {
|
|
cause error
|
|
}
|
|
|
|
// Error satisfies the core error interface for pluginError.
|
|
func (e *pluginError) Error() string {
|
|
return e.cause.Error()
|
|
}
|
|
|
|
// Cause satisfies the errors.causer interface for pluginError.
|
|
func (e *pluginError) Cause() error {
|
|
return e.cause
|
|
}
|
|
|
|
// MarshalText marshalls the pluginError into a textual form.
|
|
func (e *pluginError) MarshalText() (text []byte, err error) {
|
|
return []byte(e.cause.Error()), nil
|
|
}
|
|
|
|
// wrapAsPluginError wraps an error in a pluginError with an
|
|
// additional message, analogous to errors.Wrapf.
|
|
func wrapAsPluginError(err error, msg string) error {
|
|
return &pluginError{cause: errors.Wrap(err, msg)}
|
|
}
|
|
|
|
// NewPluginError creates a new pluginError, analogous to
|
|
// errors.Errorf.
|
|
func NewPluginError(msg string, args ...interface{}) error {
|
|
return &pluginError{cause: errors.Errorf(msg, args...)}
|
|
}
|