Skip to content
Open
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 pkg/datastore/intent_rpc.go
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ func (d *Datastore) applyIntent(ctx context.Context, source targettypes.TargetSo
}

if d.sbi == nil {
return nil, fmt.Errorf("%s is not connected", d.config.Name)
return nil, fmt.Errorf("%s: %w", d.config.Name, targettypes.ErrNotConnected)
}

rsp, err = d.sbi.Set(ctx, source)
Expand Down
2 changes: 1 addition & 1 deletion pkg/datastore/target/gnmi/gnmi.go
Original file line number Diff line number Diff line change
Expand Up @@ -161,7 +161,7 @@ func (t *gnmiTarget) Set(ctx context.Context, source targetTypes.TargetSource) (
var err error

if t == nil {
return nil, fmt.Errorf("%s", "not connected")
return nil, targetTypes.ErrNotConnected
}

// deletes from protos
Expand Down
4 changes: 2 additions & 2 deletions pkg/datastore/target/netconf/nc.go
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,7 @@ func (t *ncTarget) internalGet(ctx context.Context, req *sdcpb.GetDataRequest) (
ctx = logf.IntoContext(ctx, log)

if !t.Status().IsConnected() {
return nil, fmt.Errorf("%s", types.TargetStatusNotConnected)
return nil, fmt.Errorf("%s: %w", t.name, types.ErrNotConnected)
}
source := "running"

Expand Down Expand Up @@ -163,7 +163,7 @@ func (t *ncTarget) Set(ctx context.Context, source types.TargetSource) (*sdcpb.S
log := logf.FromContext(ctx).WithName("Set")
ctx = logf.IntoContext(ctx, log)
if !t.Status().IsConnected() {
return nil, fmt.Errorf("%s", types.TargetStatusNotConnected)
return nil, fmt.Errorf("%s: %w", t.name, types.ErrNotConnected)
}

switch t.sbiConfig.NetconfOptions.CommitDatastore {
Expand Down
6 changes: 6 additions & 0 deletions pkg/datastore/target/types/targetstatus.go
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
package types

import "errors"

// ErrNotConnected indicates the southbound interface (device connection) of a
// datastore is not established
var ErrNotConnected = errors.New("not connected")

type TargetStatus struct {
Status TargetConnectionStatus
Details string
Expand Down
9 changes: 7 additions & 2 deletions pkg/server/transaction.go
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ import (
"time"

"github.com/sdcio/data-server/pkg/datastore"
targettypes "github.com/sdcio/data-server/pkg/datastore/target/types"
"github.com/sdcio/data-server/pkg/datastore/types"
"github.com/sdcio/data-server/pkg/tree/consts"
"github.com/sdcio/data-server/pkg/utils"
Expand Down Expand Up @@ -153,8 +154,12 @@ func (s *Server) TransactionCancel(ctx context.Context, req *sdcpb.TransactionCa

// translateInternalToGrpcError central function to map internal errors to grpc error codes
func translateInternalToGrpcError(err error) error {
if errors.Is(err, datastore.ErrDatastoreLocked) {
switch {
case errors.Is(err, datastore.ErrDatastoreLocked):
return status.Error(codes.Aborted, err.Error())
case errors.Is(err, targettypes.ErrNotConnected):
return status.Error(codes.Unavailable, err.Error())
default:
return err
}
return err
}
70 changes: 70 additions & 0 deletions pkg/server/transaction_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
package server

import (
"errors"
"fmt"
"testing"

"github.com/sdcio/data-server/pkg/datastore"
targettypes "github.com/sdcio/data-server/pkg/datastore/target/types"
"google.golang.org/grpc/codes"
"google.golang.org/grpc/status"
)

func TestTranslateInternalToGrpcError(t *testing.T) {
cases := map[string]struct {
err error
wantNil bool
wantSame bool // returned unchanged (non-status passthrough)
wantCode codes.Code
}{
"nil": {
err: nil,
wantNil: true,
},
"datastore locked -> Aborted": {
err: datastore.ErrDatastoreLocked,
wantCode: codes.Aborted,
},
"not connected -> Unavailable": {
err: targettypes.ErrNotConnected,
wantCode: codes.Unavailable,
},
"wrapped not connected -> Unavailable": {
err: fmt.Errorf("some.datastore: %w", targettypes.ErrNotConnected),
wantCode: codes.Unavailable,
},
"other error -> passthrough": {
err: errors.New("boom"),
wantSame: true,
},
}

for name, tc := range cases {
t.Run(name, func(t *testing.T) {
got := translateInternalToGrpcError(tc.err)

if tc.wantNil {
if got != nil {
t.Fatalf("expected nil, got %v", got)
}
return
}

if tc.wantSame {
if got != tc.err {
t.Fatalf("expected passthrough of the same error, got %v", got)
}
return
}

st, ok := status.FromError(got)
if !ok {
t.Fatalf("expected a gRPC status error, got %v", got)
}
if st.Code() != tc.wantCode {
t.Fatalf("expected code %v, got %v (%v)", tc.wantCode, st.Code(), got)
}
})
}
}
Loading