compose/pkg/api/errors_test.go
Nicolas De Loof f5efe67ea3 feat(api): a typed error for a service with no running container
Exec, port, export, commit and attach fail with "service X is not running"
when they find no container to act on. A program driving Compose as a library
could only recognise that failure by matching the message.

Return a ServiceNotRunningError, which matches the new ErrNotRunning and
carries the service and the replica index. The message is unchanged.

Signed-off-by: Nicolas De Loof <nicolas.deloof@gmail.com>
2026-11-16 17:01:39 +01:00

67 lines
2 KiB
Go

/*
Copyright 2020 Docker Compose CLI 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 api
import (
"errors"
"fmt"
"testing"
"gotest.tools/v3/assert"
)
func TestIsNotFound(t *testing.T) {
err := fmt.Errorf(`object "name": %w`, ErrNotFound)
assert.Assert(t, IsNotFoundError(err))
assert.Assert(t, !IsNotFoundError(errors.New("another error")))
}
func TestIsAlreadyExists(t *testing.T) {
err := fmt.Errorf(`object "name": %w`, ErrAlreadyExists)
assert.Assert(t, IsAlreadyExistsError(err))
assert.Assert(t, !IsAlreadyExistsError(errors.New("another error")))
}
func TestIsForbidden(t *testing.T) {
err := fmt.Errorf(`object "name": %w`, ErrForbidden)
assert.Assert(t, IsForbiddenError(err))
assert.Assert(t, !IsForbiddenError(errors.New("another error")))
}
func TestIsUnknown(t *testing.T) {
err := fmt.Errorf(`object "name": %w`, ErrUnknown)
assert.Assert(t, IsUnknownError(err))
assert.Assert(t, !IsUnknownError(errors.New("another error")))
}
func TestServiceNotRunningError(t *testing.T) {
err := fmt.Errorf("exec: %w", &ServiceNotRunningError{Service: "web"})
assert.Assert(t, IsErrNotRunning(err))
assert.Assert(t, !IsNotFoundError(err))
assert.ErrorContains(t, err, `service "web" is not running`)
var notRunning *ServiceNotRunningError
assert.Assert(t, errors.As(err, &notRunning))
assert.Equal(t, notRunning.Service, "web")
assert.Error(t, &ServiceNotRunningError{Service: "web", Index: 3}, `service "web" is not running container #3`)
assert.Assert(t, !IsErrNotRunning(errors.New("another error")))
}