Skip to content
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.

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

chore: update error definitions to conform the latest COSI runtime #160

Merged
merged 1 commit into from
Sep 12, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion go.mod
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ module github.com/cosi-project/state-etcd
go 1.23.0

require (
github.com/cosi-project/runtime v0.6.1
github.com/cosi-project/runtime v0.6.3
github.com/siderolabs/gen v0.5.0
github.com/stretchr/testify v1.9.0
go.etcd.io/etcd/api/v3 v3.5.15
Expand Down
4 changes: 2 additions & 2 deletions go.sum
Original file line number Diff line number Diff line change
Expand Up @@ -34,8 +34,8 @@ github.com/coreos/go-semver v0.3.0 h1:wkHLiw0WNATZnSG7epLsujiMCgPAc9xhjJ4tgnAxmf
github.com/coreos/go-semver v0.3.0/go.mod h1:nnelYz7RCh+5ahJtPPxZlU+153eP4D4r3EedlOD2RNk=
github.com/coreos/go-systemd/v22 v22.3.2 h1:D9/bQk5vlXQFZ6Kwuu6zaiXJ9oTPe68++AzAJc1DzSI=
github.com/coreos/go-systemd/v22 v22.3.2/go.mod h1:Y58oyj3AT4RCenI/lSvhwexgC+NSVTIJ3seZv2GcEnc=
github.com/cosi-project/runtime v0.6.1 h1:mKNACtmdO9rBdI83zpVDuDRap7w4kCyE40gYn7oricM=
github.com/cosi-project/runtime v0.6.1/go.mod h1:2iQ2Wu57UNm89ZksFLoMLGEZnPzUkk5g64+AlWHopo4=
github.com/cosi-project/runtime v0.6.3 h1:nCmEIY1jypCoraRaNsFvaLHkBI/ALYk/X1CGea7Ie1E=
github.com/cosi-project/runtime v0.6.3/go.mod h1:2iQ2Wu57UNm89ZksFLoMLGEZnPzUkk5g64+AlWHopo4=
github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
Expand Down
20 changes: 15 additions & 5 deletions pkg/state/impl/etcd/errors.go
Original file line number Diff line number Diff line change
Expand Up @@ -25,10 +25,15 @@ func ErrNotFound(r resource.Pointer) error {

type eConflict struct {
error
resource resource.Pointer
}

func (eConflict) ConflictError() {}

func (e eConflict) GetResource() resource.Pointer {
return e.resource
}

type eOwnerConflict struct {
eConflict
}
Expand All @@ -50,29 +55,33 @@ func (eUnsupported) UnsupportedError() {}
// ErrAlreadyExists generates error compatible with state.ErrConflict.
func ErrAlreadyExists(r resource.Reference) error {
return eConflict{
fmt.Errorf("resource %s already exists", r),
error: fmt.Errorf("resource %s already exists", r),
resource: r,
}
}

// ErrVersionConflict generates error compatible with state.ErrConflict.
func ErrVersionConflict(r resource.Pointer, expected, found int64) error {
return eConflict{
fmt.Errorf("resource %s update conflict: expected version %q, actual version %q", r, expected, found),
error: fmt.Errorf("resource %s update conflict: expected version %q, actual version %q", r, expected, found),
resource: r,
}
}

// ErrPendingFinalizers generates error compatible with state.ErrConflict.
func ErrPendingFinalizers(r resource.Metadata) error {
return eConflict{
fmt.Errorf("resource %s has pending finalizers %s", r, r.Finalizers()),
error: fmt.Errorf("resource %s has pending finalizers %s", r, r.Finalizers()),
resource: r,
}
}

// ErrOwnerConflict generates error compatible with state.ErrConflict.
func ErrOwnerConflict(r resource.Reference, owner string) error {
return eOwnerConflict{
eConflict{
fmt.Errorf("resource %s is owned by %q", r, owner),
error: fmt.Errorf("resource %s is owned by %q", r, owner),
resource: r,
},
}
}
Expand All @@ -81,7 +90,8 @@ func ErrOwnerConflict(r resource.Reference, owner string) error {
func ErrPhaseConflict(r resource.Reference, expectedPhase resource.Phase) error {
return ePhaseConflict{
eConflict{
fmt.Errorf("resource %s is not in phase %s", r, expectedPhase),
error: fmt.Errorf("resource %s is not in phase %s", r, expectedPhase),
resource: r,
},
}
}
Expand Down
30 changes: 30 additions & 0 deletions pkg/state/impl/etcd/errors_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
// This Source Code Form is subject to the terms of the Mozilla Public
// License, v. 2.0. If a copy of the MPL was not distributed with this
// file, You can obtain one at http://mozilla.org/MPL/2.0/.

package etcd_test

import (
"testing"

"github.com/cosi-project/runtime/pkg/resource"
"github.com/cosi-project/runtime/pkg/state"
"github.com/stretchr/testify/require"

"github.com/cosi-project/state-etcd/pkg/state/impl/etcd"
)

func TestErrors(t *testing.T) {
res := resource.NewMetadata("ns", "a", "b", resource.VersionUndefined)

require.Implements(t, (*state.ErrConflict)(nil), etcd.ErrAlreadyExists(res))
require.Implements(t, (*state.ErrConflict)(nil), etcd.ErrVersionConflict(res, 1, 2))
require.Implements(t, (*state.ErrConflict)(nil), etcd.ErrOwnerConflict(res, "owner"))
require.Implements(t, (*state.ErrConflict)(nil), etcd.ErrPendingFinalizers(res))
require.Implements(t, (*state.ErrConflict)(nil), etcd.ErrPhaseConflict(res, resource.PhaseRunning))
require.Implements(t, (*state.ErrNotFound)(nil), etcd.ErrNotFound(res))

require.True(t, state.IsConflictError(etcd.ErrAlreadyExists(res), state.WithResourceType("a")))
require.False(t, state.IsConflictError(etcd.ErrAlreadyExists(res), state.WithResourceType("b")))
require.True(t, state.IsConflictError(etcd.ErrAlreadyExists(res), state.WithResourceNamespace("ns")))
}
Loading