mirror of
https://github.com/edgelesssys/constellation.git
synced 2025-09-20 13:04:36 -04:00
cdbg: make endpoint deployment failure more transparent (#1883)
* add retry + timeout + intercept grpc logs * LogStateChanges inside grplog pkg * remove retry and tj/assert * rename nit * Update debugd/internal/cdbg/cmd/deploy.go Co-authored-by: Paul Meyer <49727155+katexochen@users.noreply.github.com> * Update debugd/internal/cdbg/cmd/deploy.go Co-authored-by: Paul Meyer <49727155+katexochen@users.noreply.github.com> * paul feedback * return waitFn instead of WaitGroup * Revert "return waitFn instead of WaitGroup" This reverts commit 45700f30e341ce3af509b687febbc0125f7ddb38. * log routine inside debugd constructor * test doubles names * Update debugd/internal/cdbg/cmd/deploy.go Co-authored-by: Paul Meyer <49727155+katexochen@users.noreply.github.com> * fix newDebugClient closeFn --------- Co-authored-by: Paul Meyer <49727155+katexochen@users.noreply.github.com>
This commit is contained in:
Adrian Stobbe
GitHub
parent
167052d443
commit
e738f15f0f
8 changed files with 221 additions and 53 deletions
|
|
@ -1,9 +1,24 @@
|
|||
load("@io_bazel_rules_go//go:def.bzl", "go_library")
|
||||
load("//bazel/go:go_test.bzl", "go_test")
|
||||
|
||||
go_library(
|
||||
name = "grpclog",
|
||||
srcs = ["grplog.go"],
|
||||
srcs = ["grpclog.go"],
|
||||
importpath = "github.com/edgelesssys/constellation/v2/internal/grpc/grpclog",
|
||||
visibility = ["//:__subpackages__"],
|
||||
deps = ["@org_golang_google_grpc//peer"],
|
||||
deps = [
|
||||
"@org_golang_google_grpc//connectivity",
|
||||
"@org_golang_google_grpc//peer",
|
||||
],
|
||||
)
|
||||
|
||||
go_test(
|
||||
name = "grpclog_test",
|
||||
srcs = ["grpclog_test.go"],
|
||||
embed = [":grpclog"],
|
||||
deps = [
|
||||
"@com_github_stretchr_testify//assert",
|
||||
"@com_github_stretchr_testify//require",
|
||||
"@org_golang_google_grpc//connectivity",
|
||||
],
|
||||
)
|
||||
|
|
|
|||
53
internal/grpc/grpclog/grpclog.go
Normal file
53
internal/grpc/grpclog/grpclog.go
Normal file
|
|
@ -0,0 +1,53 @@
|
|||
/*
|
||||
Copyright (c) Edgeless Systems GmbH
|
||||
|
||||
SPDX-License-Identifier: AGPL-3.0-only
|
||||
*/
|
||||
|
||||
// grpclog provides a logging utilities for gRPC.
|
||||
package grpclog
|
||||
|
||||
import (
|
||||
"context"
|
||||
"sync"
|
||||
|
||||
"google.golang.org/grpc/connectivity"
|
||||
"google.golang.org/grpc/peer"
|
||||
)
|
||||
|
||||
// PeerAddrFromContext returns a peer's address from context, or "unknown" if not found.
|
||||
func PeerAddrFromContext(ctx context.Context) string {
|
||||
p, ok := peer.FromContext(ctx)
|
||||
if !ok {
|
||||
return "unknown"
|
||||
}
|
||||
return p.Addr.String()
|
||||
}
|
||||
|
||||
// LogStateChangesUntilReady logs the state changes of a gRPC connection.
|
||||
func LogStateChangesUntilReady(ctx context.Context, conn getStater, log debugLog, wg *sync.WaitGroup, isReadyCallback func()) {
|
||||
wg.Add(1)
|
||||
go func() {
|
||||
defer wg.Done()
|
||||
state := conn.GetState()
|
||||
log.Debugf("Connection state started as %s", state)
|
||||
for ; state != connectivity.Ready && conn.WaitForStateChange(ctx, state); state = conn.GetState() {
|
||||
log.Debugf("Connection state changed to %s", state)
|
||||
}
|
||||
if state == connectivity.Ready {
|
||||
log.Debugf("Connection ready")
|
||||
isReadyCallback()
|
||||
} else {
|
||||
log.Debugf("Connection state ended with %s", state)
|
||||
}
|
||||
}()
|
||||
}
|
||||
|
||||
type getStater interface {
|
||||
GetState() connectivity.State
|
||||
WaitForStateChange(context.Context, connectivity.State) bool
|
||||
}
|
||||
|
||||
type debugLog interface {
|
||||
Debugf(format string, args ...any)
|
||||
}
|
||||
115
internal/grpc/grpclog/grpclog_test.go
Normal file
115
internal/grpc/grpclog/grpclog_test.go
Normal file
|
|
@ -0,0 +1,115 @@
|
|||
/*
|
||||
Copyright (c) Edgeless Systems GmbH
|
||||
|
||||
SPDX-License-Identifier: AGPL-3.0-only
|
||||
*/
|
||||
|
||||
// grpclog provides a logging utilities for gRPC.
|
||||
package grpclog
|
||||
|
||||
import (
|
||||
"context"
|
||||
"fmt"
|
||||
"sync"
|
||||
"testing"
|
||||
|
||||
"github.com/stretchr/testify/assert"
|
||||
"github.com/stretchr/testify/require"
|
||||
"google.golang.org/grpc/connectivity"
|
||||
)
|
||||
|
||||
func TestLogStateChanges(t *testing.T) {
|
||||
testCases := map[string]struct {
|
||||
name string
|
||||
conn getStater
|
||||
assert func(t *testing.T, lg *spyLog, isReadyCallbackCalled bool)
|
||||
}{
|
||||
"state: connecting, ready": {
|
||||
conn: &stubConn{
|
||||
states: []connectivity.State{
|
||||
connectivity.Connecting,
|
||||
connectivity.Ready,
|
||||
connectivity.Ready,
|
||||
},
|
||||
},
|
||||
assert: func(t *testing.T, lg *spyLog, isReadyCallbackCalled bool) {
|
||||
require.Len(t, lg.msgs, 3)
|
||||
assert.Equal(t, "Connection state started as CONNECTING", lg.msgs[0])
|
||||
assert.Equal(t, "Connection state changed to CONNECTING", lg.msgs[1])
|
||||
assert.Equal(t, "Connection ready", lg.msgs[2])
|
||||
assert.True(t, isReadyCallbackCalled)
|
||||
},
|
||||
},
|
||||
"state: ready": {
|
||||
conn: &stubConn{
|
||||
states: []connectivity.State{
|
||||
connectivity.Ready,
|
||||
connectivity.Idle,
|
||||
},
|
||||
stopWaitForChange: false,
|
||||
},
|
||||
assert: func(t *testing.T, lg *spyLog, isReadyCallbackCalled bool) {
|
||||
require.Len(t, lg.msgs, 2)
|
||||
assert.Equal(t, "Connection state started as READY", lg.msgs[0])
|
||||
assert.Equal(t, "Connection ready", lg.msgs[1])
|
||||
assert.True(t, isReadyCallbackCalled)
|
||||
},
|
||||
},
|
||||
"no WaitForStateChange (e.g. when context is canceled)": {
|
||||
conn: &stubConn{
|
||||
states: []connectivity.State{
|
||||
connectivity.Connecting,
|
||||
connectivity.Idle,
|
||||
},
|
||||
stopWaitForChange: true,
|
||||
},
|
||||
assert: func(t *testing.T, lg *spyLog, isReadyCallbackCalled bool) {
|
||||
require.Len(t, lg.msgs, 2)
|
||||
assert.Equal(t, "Connection state started as CONNECTING", lg.msgs[0])
|
||||
assert.Equal(t, "Connection state ended with CONNECTING", lg.msgs[1])
|
||||
assert.False(t, isReadyCallbackCalled)
|
||||
},
|
||||
},
|
||||
}
|
||||
for name, tc := range testCases {
|
||||
t.Run(name, func(t *testing.T) {
|
||||
logger := &spyLog{}
|
||||
|
||||
var wg sync.WaitGroup
|
||||
isReadyCallbackCalled := false
|
||||
LogStateChangesUntilReady(context.Background(), tc.conn, logger, &wg, func() { isReadyCallbackCalled = true })
|
||||
wg.Wait()
|
||||
tc.assert(t, logger, isReadyCallbackCalled)
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
type spyLog struct {
|
||||
msgs []string
|
||||
}
|
||||
|
||||
func (f *spyLog) Debugf(format string, args ...any) {
|
||||
f.msgs = append(f.msgs, fmt.Sprintf(format, args...))
|
||||
}
|
||||
|
||||
type stubConn struct {
|
||||
states []connectivity.State
|
||||
idx int
|
||||
stopWaitForChange bool
|
||||
}
|
||||
|
||||
func (f *stubConn) GetState() connectivity.State {
|
||||
if f.idx > len(f.states)-1 {
|
||||
return f.states[len(f.states)-1]
|
||||
}
|
||||
res := f.states[f.idx]
|
||||
f.idx++
|
||||
return res
|
||||
}
|
||||
|
||||
func (f *stubConn) WaitForStateChange(context.Context, connectivity.State) bool {
|
||||
if f.stopWaitForChange {
|
||||
return false
|
||||
}
|
||||
return f.idx < len(f.states)
|
||||
}
|
||||
|
|
@ -1,23 +0,0 @@
|
|||
/*
|
||||
Copyright (c) Edgeless Systems GmbH
|
||||
|
||||
SPDX-License-Identifier: AGPL-3.0-only
|
||||
*/
|
||||
|
||||
// grpclog provides a logging utilities for gRPC.
|
||||
package grpclog
|
||||
|
||||
import (
|
||||
"context"
|
||||
|
||||
"google.golang.org/grpc/peer"
|
||||
)
|
||||
|
||||
// PeerAddrFromContext returns a peer's address from context, or "unknown" if not found.
|
||||
func PeerAddrFromContext(ctx context.Context) string {
|
||||
p, ok := peer.FromContext(ctx)
|
||||
if !ok {
|
||||
return "unknown"
|
||||
}
|
||||
return p.Addr.String()
|
||||
}
|
||||
Loading…
Add table
Add a link
Reference in a new issue