github/containerd
4
0
Fork 0
Code Issues Pull Requests Packages Projects Releases 2 Wiki Activity

errors: use errdefs errors in client and commands

Browse Source 
This change moves from specific, global errors to the errdefs errors.
This makes it easy to handle certain classes of errors while still
adding context to the failure.

Signed-off-by: Stephen Day <stephen.day@getcruise.com>
This commit is contained in:
Stephen Day
2019-07-15 18:30:10 -07:00
parent d6be45e151
commit 804ae89be6
8 changed files with 20 additions and 111 deletions
Download Patch File Download Diff File Expand all files Collapse all files

32
cmd/containerd/command/error.go
View File

@@ -1,32 +0,0 @@
/*
Copyright The containerd Authors.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
package command
import (
"github.com/pkg/errors"
)
var (
// ErrUnknownLevel is returned when an unknown debugging level is encountered
ErrUnknownLevel = errors.New("unknown level")
// ErrRegisterAndUnregisterService is returned when both register and unregister flags are specified
ErrRegisterAndUnregisterService = errors.New("--register-service and --unregister-service cannot be used together")
// ErrEmptyTopic is returned when no topic is provided
ErrEmptyTopic = errors.New("topic required to publish event")
// ErrEmptyGRCPAddress is returned when the grpc address is empty
ErrEmptyGRCPAddress = errors.New("grpc address cannot be empty")
)

3
cmd/containerd/command/main.go
View File

@@ -27,6 +27,7 @@ import (
"runtime"
"time"
"github.com/containerd/containerd/errdefs"
"github.com/containerd/containerd/log"
"github.com/containerd/containerd/mount"
"github.com/containerd/containerd/services/server"
@@ -152,7 +153,7 @@ func App() *cli.App {
ttrpcAddress = fmt.Sprintf("%s.ttrpc", config.GRPC.Address)
)
if address == "" {
return ErrEmptyGRCPAddress
return errors.Wrap(errdefs.ErrInvalidArgument, "grpc address cannot be empty")
}
log.G(ctx).WithFields(logrus.Fields{
"version": version.Version,

2
cmd/containerd/command/publish.go
View File

@@ -51,7 +51,7 @@ var publishCommand = cli.Command{
ctx := namespaces.WithNamespace(gocontext.Background(), context.String("namespace"))
topic := context.String("topic")
if topic == "" {
return ErrEmptyTopic
return errors.Wrap(errdefs.ErrInvalidArgument, "topic required to publish event")
}
payload, err := getEventPayload(os.Stdin)
if err != nil {

6
cmd/containerd/command/service_windows.go
View File

@@ -27,7 +27,9 @@ import (
"time"
"unsafe"
"github.com/containerd/containerd/errdefs"
"github.com/containerd/containerd/services/server"
"github.com/pkg/errors"
"github.com/sirupsen/logrus"
"github.com/urfave/cli"
"golang.org/x/sys/windows"
@@ -161,7 +163,7 @@ func (h *etwHook) Fire(e *logrus.Entry) error {
etype = windows.EVENTLOG_INFORMATION_TYPE
eid = eventDebug
default:
return ErrUnknownLevel
return errors.Wrap(errdefs.ErrInvalidArgument, "unknown level")
}
// If there is additional data, include it as a second string.
@@ -310,7 +312,7 @@ func registerUnregisterService(root string) (bool, error) {
if unregisterServiceFlag {
if registerServiceFlag {
return true, ErrRegisterAndUnregisterService
return true, errors.Wrap(errdefs.ErrInvalidArgument, "--register-service and --unregister-service cannot be used together")
}
return true, unregisterService()
}

14
cmd/ctr/commands/containers/containers.go
View File

@@ -28,8 +28,10 @@ import (
"github.com/containerd/containerd/cmd/ctr/commands"
"github.com/containerd/containerd/cmd/ctr/commands/run"
"github.com/containerd/containerd/containers"
"github.com/containerd/containerd/errdefs"
"github.com/containerd/containerd/log"
"github.com/containerd/typeurl"
"github.com/pkg/errors"
"github.com/urfave/cli"
)
@@ -64,17 +66,17 @@ var createCommand = cli.Command{
if config {
id = context.Args().First()
if context.NArg() > 1 {
return commands.ErrArgConfigFile
return errors.Wrap(errdefs.ErrInvalidArgument, "with spec config file, only container id should be provided")
}
} else {
id = context.Args().Get(1)
ref = context.Args().First()
if ref == "" {
return commands.ErrUnprovidedImageRef
return errors.Wrap(errdefs.ErrInvalidArgument, "image ref must be provided")
}
}
if id == "" {
return commands.ErrEmptyContainerID
return errors.Wrap(errdefs.ErrInvalidArgument, "container id must be provided")
}
client, ctx, cancel, err := commands.NewClient(context)
if err != nil {
@@ -167,7 +169,7 @@ var deleteCommand = cli.Command{
}
if context.NArg() == 0 {
return commands.ErrDeleteNoneContainer
return errors.Wrap(errdefs.ErrInvalidArgument, "must specify at least one container to delete")
}
for _, arg := range context.Args() {
if err := deleteContainer(ctx, client, arg, deleteOpts...); err != nil {
@@ -213,7 +215,7 @@ var setLabelsCommand = cli.Command{
Action: func(context *cli.Context) error {
containerID, labels := commands.ObjectWithLabelArgs(context)
if containerID == "" {
return commands.ErrEmptyContainerID
return errors.Wrap(errdefs.ErrInvalidArgument, "container id must be provided")
}
client, ctx, cancel, err := commands.NewClient(context)
if err != nil {
@@ -249,7 +251,7 @@ var infoCommand = cli.Command{
Action: func(context *cli.Context) error {
id := context.Args().First()
if id == "" {
return commands.ErrEmptyContainerID
return errors.Wrap(errdefs.ErrInvalidArgument, "container id must be provided")
}
client, ctx, cancel, err := commands.NewClient(context)
if err != nil {

32
cmd/ctr/commands/error.go
View File

@@ -1,32 +0,0 @@
/*
Copyright The containerd Authors.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
package commands
import (
"github.com/pkg/errors"
)
var (
// ErrArgConfigFile is returned when the configuration for a spec is provided
ErrArgConfigFile = errors.New("with spec config file, only container id should be provided")
// ErrUnprovidedImageRef is returned when no image reference is provided
ErrUnprovidedImageRef = errors.New("image ref must be provided")
// ErrEmptyContainerID is returned when no container id is provided
ErrEmptyContainerID = errors.New("container id must be provided")
// ErrDeleteNoneContainer is returned when no container ids are provided for deletion
ErrDeleteNoneContainer = errors.New("must specify at least one container to delete")
)