service: remove stop method and use contexts (#7292)

tools/tm-signer-harness/internal/test_harness.go

@@ -89,7 +89,7 @@ type timeoutError interface {
 // NewTestHarness will load Tendermint data from the given files (including
 // validator public/private keypairs and chain details) and create a new
 // harness.
-func NewTestHarness(logger log.Logger, cfg TestHarnessConfig) (*TestHarness, error) {
+func NewTestHarness(ctx context.Context, logger log.Logger, cfg TestHarnessConfig) (*TestHarness, error) {
 	keyFile := ExpandPath(cfg.KeyFile)
 	stateFile := ExpandPath(cfg.StateFile)
 	logger.Info("Loading private validator configuration", "keyFile", keyFile, "stateFile", stateFile)
@@ -113,7 +113,7 @@ func NewTestHarness(logger log.Logger, cfg TestHarnessConfig) (*TestHarness, err
 		return nil, newTestHarnessError(ErrFailedToCreateListener, err, "")
 	}
 
-	signerClient, err := privval.NewSignerClient(spv, st.ChainID)
+	signerClient, err := privval.NewSignerClient(ctx, spv, st.ChainID)
 	if err != nil {
 		return nil, newTestHarnessError(ErrFailedToCreateListener, err, "")
 	}

tools/tm-signer-harness/internal/test_harness_test.go

@@ -1,6 +1,7 @@
 package internal
 
 import (
+	"context"
 	"fmt"
 	"os"
 	"testing"
@@ -73,17 +74,24 @@ const (
 )
 
 func TestRemoteSignerTestHarnessMaxAcceptRetriesReached(t *testing.T) {
+	ctx, cancel := context.WithCancel(context.Background())
+	defer cancel()
+
 	cfg := makeConfig(t, 1, 2)
 	defer cleanup(cfg)
 
-	th, err := NewTestHarness(log.TestingLogger(), cfg)
+	th, err := NewTestHarness(ctx, log.TestingLogger(), cfg)
 	require.NoError(t, err)
 	th.Run()
 	assert.Equal(t, ErrMaxAcceptRetriesReached, th.exitCode)
 }
 
 func TestRemoteSignerTestHarnessSuccessfulRun(t *testing.T) {
+	ctx, cancel := context.WithCancel(context.Background())
+	defer cancel()
+
 	harnessTest(
+		ctx,
 		t,
 		func(th *TestHarness) *privval.SignerServer {
 			return newMockSignerServer(t, th, th.fpv.Key.PrivKey, false, false)
@@ -93,7 +101,11 @@ func TestRemoteSignerTestHarnessSuccessfulRun(t *testing.T) {
 }
 
 func TestRemoteSignerPublicKeyCheckFailed(t *testing.T) {
+	ctx, cancel := context.WithCancel(context.Background())
+	defer cancel()
+
 	harnessTest(
+		ctx,
 		t,
 		func(th *TestHarness) *privval.SignerServer {
 			return newMockSignerServer(t, th, ed25519.GenPrivKey(), false, false)
@@ -103,7 +115,11 @@ func TestRemoteSignerPublicKeyCheckFailed(t *testing.T) {
 }
 
 func TestRemoteSignerProposalSigningFailed(t *testing.T) {
+	ctx, cancel := context.WithCancel(context.Background())
+	defer cancel()
+
 	harnessTest(
+		ctx,
 		t,
 		func(th *TestHarness) *privval.SignerServer {
 			return newMockSignerServer(t, th, th.fpv.Key.PrivKey, true, false)
@@ -113,7 +129,11 @@ func TestRemoteSignerProposalSigningFailed(t *testing.T) {
 }
 
 func TestRemoteSignerVoteSigningFailed(t *testing.T) {
+	ctx, cancel := context.WithCancel(context.Background())
+	defer cancel()
+
 	harnessTest(
+		ctx,
 		t,
 		func(th *TestHarness) *privval.SignerServer {
 			return newMockSignerServer(t, th, th.fpv.Key.PrivKey, false, true)
@@ -144,11 +164,16 @@ func newMockSignerServer(
 }
 
 // For running relatively standard tests.
-func harnessTest(t *testing.T, signerServerMaker func(th *TestHarness) *privval.SignerServer, expectedExitCode int) {
+func harnessTest(
+	ctx context.Context,
+	t *testing.T,
+	signerServerMaker func(th *TestHarness) *privval.SignerServer,
+	expectedExitCode int,
+) {
 	cfg := makeConfig(t, 100, 3)
 	defer cleanup(cfg)
 
-	th, err := NewTestHarness(log.TestingLogger(), cfg)
+	th, err := NewTestHarness(ctx, log.TestingLogger(), cfg)
 	require.NoError(t, err)
 	donec := make(chan struct{})
 	go func() {
@@ -157,7 +182,7 @@ func harnessTest(t *testing.T, signerServerMaker func(th *TestHarness) *privval.
 	}()
 
 	ss := signerServerMaker(th)
-	require.NoError(t, ss.Start())
+	require.NoError(t, ss.Start(ctx))
 	assert.True(t, ss.IsRunning())
 	defer ss.Stop() //nolint:errcheck // ignore for tests
 

tools/tm-signer-harness/main.go

@@ -1,6 +1,7 @@
 package main
 
 import (
+	"context"
 	"flag"
 	"fmt"
 	"os"
@@ -115,7 +116,7 @@ Usage:
 	}
 }
 
-func runTestHarness(acceptRetries int, bindAddr, tmhome string) {
+func runTestHarness(ctx context.Context, acceptRetries int, bindAddr, tmhome string) {
 	tmhome = internal.ExpandPath(tmhome)
 	cfg := internal.TestHarnessConfig{
 		BindAddr:         bindAddr,
@@ -128,7 +129,7 @@ func runTestHarness(acceptRetries int, bindAddr, tmhome string) {
 		SecretConnKey:    ed25519.GenPrivKey(),
 		ExitWhenComplete: true,
 	}
-	harness, err := internal.NewTestHarness(logger, cfg)
+	harness, err := internal.NewTestHarness(ctx, logger, cfg)
 	if err != nil {
 		logger.Error(err.Error())
 		if therr, ok := err.(*internal.TestHarnessError); ok {
@@ -156,6 +157,9 @@ func extractKey(tmhome, outputPath string) {
 }
 
 func main() {
+	ctx, cancel := context.WithCancel(context.Background())
+	defer cancel()
+
 	if err := rootCmd.Parse(os.Args[1:]); err != nil {
 		fmt.Printf("Error parsing flags: %v\n", err)
 		os.Exit(1)
@@ -183,7 +187,7 @@ func main() {
 			fmt.Printf("Error parsing flags: %v\n", err)
 			os.Exit(1)
 		}
-		runTestHarness(flagAcceptRetries, flagBindAddr, flagTMHome)
+		runTestHarness(ctx, flagAcceptRetries, flagBindAddr, flagTMHome)
 	case "extract_key":
 		if err := extractKeyCmd.Parse(os.Args[2:]); err != nil {
 			fmt.Printf("Error parsing flags: %v\n", err)