[BCI-3989][common] - CR methods err when service unstarted

pkg/codec/encodings/type_codec_test.go

@@ -126,7 +126,7 @@ func TestCodecFromTypeCodecs(t *testing.T) {
 
 type interfaceTesterBase struct{}
 
-func (*interfaceTesterBase) Setup(_ *testing.T) {}
+func (*interfaceTesterBase) Setup(_ *testing.T, _ bool) {}
 
 func (*interfaceTesterBase) GetAccountBytes(i int) []byte {
 	ib := byte(i)

pkg/loop/internal/relayer/pluginprovider/contractreader/codec_test.go

@@ -25,7 +25,7 @@ func TestCodecClient(t *testing.T) {
 
 	es := &errCodec{}
 	esTester := chaincomponentstest.WrapCodecTesterForLoop(&fakeCodecInterfaceTester{impl: es})
-	esTester.Setup(t)
+	esTester.Setup(t, false)
 	esCodec := esTester.GetCodec(t)
 
 	anyObj := &interfacetests.TestStruct{}
@@ -55,14 +55,14 @@ func TestCodecClient(t *testing.T) {
 	// make sure that errors come from client directly
 	es.err = nil
 	t.Run("Encode returns error if type cannot be encoded in the wire format", func(t *testing.T) {
-		interfaceTester.Setup(t)
+		interfaceTester.Setup(t, false)
 		c := interfaceTester.GetCodec(t)
 		_, err := c.Encode(tests.Context(t), &cannotEncode{}, "doesnotmatter")
 		assert.True(t, errors.Is(err, types.ErrInvalidType))
 	})
 
 	t.Run("Decode returns error if type cannot be decoded in the wire format", func(t *testing.T) {
-		interfaceTester.Setup(t)
+		interfaceTester.Setup(t, false)
 		c := interfaceTester.GetCodec(t)
 		fv := int32(1)
 		toDecode, err := c.Encode(tests.Context(t), &interfacetests.TestStruct{Field: &fv}, interfacetests.TestItemType)
@@ -74,7 +74,7 @@ func TestCodecClient(t *testing.T) {
 	t.Run("Nil esCodec returns unimplemented", func(t *testing.T) {
 		ctx := tests.Context(t)
 		nilTester := chaincomponentstest.WrapCodecTesterForLoop(&fakeCodecInterfaceTester{impl: nil})
-		nilTester.Setup(t)
+		nilTester.Setup(t, false)
 		nilCodec := nilTester.GetCodec(t)
 
 		item := &interfacetests.TestStruct{}
@@ -98,7 +98,7 @@ type fakeCodecInterfaceTester struct {
 	impl types.Codec
 }
 
-func (it *fakeCodecInterfaceTester) Setup(_ *testing.T) {}
+func (it *fakeCodecInterfaceTester) Setup(_ *testing.T, _ bool) {}
 
 func (it *fakeCodecInterfaceTester) GetCodec(_ *testing.T) types.Codec {
 	return it.impl

pkg/loop/internal/relayer/pluginprovider/contractreader/contract_reader_test.go

@@ -9,6 +9,7 @@ import (
 	"sort"
 	"strings"
 	"sync"
+	"sync/atomic"
 	"testing"
 	"time"
 
@@ -99,7 +100,7 @@ func TestBind(t *testing.T) {
 				contractreadertest.WithContractReaderLoopEncoding(version),
 			)
 
-			errTester.Setup(t)
+			errTester.Setup(t, false)
 			contractReader := errTester.GetContractReader(t)
 
 			for _, errorType := range errorTypes {
@@ -133,7 +134,7 @@ func TestGetLatestValue(t *testing.T) {
 				contractreadertest.WithContractReaderLoopEncoding(version),
 			)
 
-			errTester.Setup(t)
+			errTester.Setup(t, false)
 			contractReader := errTester.GetContractReader(t)
 
 			t.Run("nil reader should return unimplemented", func(t *testing.T) {
@@ -142,7 +143,7 @@ func TestGetLatestValue(t *testing.T) {
 				ctx := tests.Context(t)
 
 				nilTester := contractreadertest.WrapContractReaderTesterForLoop(&fakeContractReaderInterfaceTester{impl: nil})
-				nilTester.Setup(t)
+				nilTester.Setup(t, false)
 				nilCr := nilTester.GetContractReader(t)
 
 				err := nilCr.GetLatestValue(ctx, "method", primitives.Unconfirmed, "anything", "anything")
@@ -182,7 +183,7 @@ func TestBatchGetLatestValues(t *testing.T) {
 				contractreadertest.WithContractReaderLoopEncoding(version),
 			)
 
-			errTester.Setup(t)
+			errTester.Setup(t, false)
 			contractReader := errTester.GetContractReader(t)
 
 			t.Run("nil reader should return unimplemented", func(t *testing.T) {
@@ -191,7 +192,7 @@ func TestBatchGetLatestValues(t *testing.T) {
 				ctx := tests.Context(t)
 
 				nilTester := contractreadertest.WrapContractReaderTesterForLoop(&fakeContractReaderInterfaceTester{impl: nil})
-				nilTester.Setup(t)
+				nilTester.Setup(t, false)
 				nilCr := nilTester.GetContractReader(t)
 
 				_, err := nilCr.BatchGetLatestValues(ctx, types.BatchGetLatestValuesRequest{})
@@ -235,19 +236,19 @@ func TestQueryKey(t *testing.T) {
 
 			impl := &protoConversionTestContractReader{}
 			crTester := contractreadertest.WrapContractReaderTesterForLoop(&fakeContractReaderInterfaceTester{impl: impl}, contractreadertest.WithContractReaderLoopEncoding(version))
-			crTester.Setup(t)
+			crTester.Setup(t, true)
 			cr := crTester.GetContractReader(t)
 
 			es := &errContractReader{}
 			errTester := contractreadertest.WrapContractReaderTesterForLoop(&fakeContractReaderInterfaceTester{impl: es})
-			errTester.Setup(t)
+			errTester.Setup(t, false)
 			contractReader := errTester.GetContractReader(t)
 
 			t.Run("nil reader should return unimplemented", func(t *testing.T) {
 				ctx := tests.Context(t)
 
 				nilTester := contractreadertest.WrapContractReaderTesterForLoop(&fakeContractReaderInterfaceTester{impl: nil})
-				nilTester.Setup(t)
+				nilTester.Setup(t, false)
 				nilCr := nilTester.GetContractReader(t)
 
 				_, err := nilCr.QueryKey(ctx, types.BoundContract{}, query.KeyFilter{}, query.LimitAndSort{}, &[]interface{}{nil})
@@ -291,12 +292,16 @@ type fakeContractReaderInterfaceTester struct {
 	cw   fakeChainWriter
 }
 
-func (it *fakeContractReaderInterfaceTester) Setup(_ *testing.T) {
+func (it *fakeContractReaderInterfaceTester) Setup(t *testing.T, started bool) {
 	fake, ok := it.impl.(*fakeContractReader)
 	if ok {
 		fake.vals = []valConfidencePair{}
 		fake.triggers = []eventConfidencePair{}
 		fake.stored = []TestStruct{}
+		if started {
+			require.NoError(t, it.impl.Start(context.Background()))
+			t.Cleanup(func() { require.NoError(t, it.impl.Close()) })
+		}
 	}
 }
 
@@ -346,8 +351,11 @@ type fakeContractReader struct {
 	stored      []TestStruct
 	batchStored BatchCallEntry
 	lock        sync.Mutex
+	isStarted   atomic.Bool
 }
 
+var errServiceNotStarted = errors.New("ContractReader service not started")
+
 type fakeChainWriter struct {
 	types.ChainWriter
 	cr *fakeContractReader
@@ -394,9 +402,15 @@ func (f *fakeChainWriter) GetFeeComponents(ctx context.Context) (*types.ChainFee
 	return &types.ChainFeeComponents{}, nil
 }
 
-func (f *fakeContractReader) Start(_ context.Context) error { return nil }
+func (f *fakeContractReader) Start(_ context.Context) error {
+	f.isStarted.Store(true)
+	return nil
+}
 
-func (f *fakeContractReader) Close() error { return nil }
+func (f *fakeContractReader) Close() error {
+	f.isStarted.Store(false)
+	return nil
+}
 
 func (f *fakeContractReader) Ready() error { panic("unimplemented") }
 
@@ -434,6 +448,10 @@ func (f *fakeContractReader) SetBatchLatestValues(batchCallEntry BatchCallEntry)
 }
 
 func (f *fakeContractReader) GetLatestValue(_ context.Context, readIdentifier string, confidenceLevel primitives.ConfidenceLevel, params, returnVal any) error {
+	if !f.isStarted.Load() {
+		return errServiceNotStarted
+	}
+
 	if strings.HasSuffix(readIdentifier, MethodReturningAlterableUint64) {
 		r := returnVal.(*uint64)
 		for i := len(f.vals) - 1; i >= 0; i-- {
@@ -508,6 +526,10 @@ func (f *fakeContractReader) GetLatestValue(_ context.Context, readIdentifier st
 }
 
 func (f *fakeContractReader) BatchGetLatestValues(_ context.Context, request types.BatchGetLatestValuesRequest) (types.BatchGetLatestValuesResult, error) {
+	if !f.isStarted.Load() {
+		return nil, errServiceNotStarted
+	}
+
 	result := make(types.BatchGetLatestValuesResult)
 	for requestContract, requestContractBatch := range request {
 		storedContractBatch := f.batchStored[requestContract]
@@ -561,6 +583,10 @@ func (f *fakeContractReader) BatchGetLatestValues(_ context.Context, request typ
 }
 
 func (f *fakeContractReader) QueryKey(_ context.Context, _ types.BoundContract, filter query.KeyFilter, limitAndSort query.LimitAndSort, _ any) ([]types.Sequence, error) {
+	if !f.isStarted.Load() {
+		return nil, errServiceNotStarted
+	}
+
 	if filter.Key == EventName {
 		f.lock.Lock()
 		defer f.lock.Unlock()

pkg/loop/internal/relayer/pluginprovider/contractreader/test/codec_loop_tester.go

@@ -21,8 +21,8 @@ type codecReaderLoopTester struct {
 	lst loopServerTester
 }
 
-func (c *codecReaderLoopTester) Setup(t *testing.T) {
-	c.CodecInterfaceTester.Setup(t)
+func (c *codecReaderLoopTester) Setup(t *testing.T, _ bool) {
+	c.CodecInterfaceTester.Setup(t, false)
 	codec := c.CodecInterfaceTester.GetCodec(t)
 	c.lst.registerHook = func(server *grpc.Server) {
 		if codec != nil {

pkg/loop/internal/relayer/pluginprovider/contractreader/test/contract_reader_loop_tester.go

@@ -59,8 +59,8 @@ type contractReaderLoopTester struct {
 	encodeWith contractreader.EncodingVersion
 }
 
-func (c *contractReaderLoopTester) Setup(t *testing.T) {
-	c.ChainComponentsInterfaceTester.Setup(t)
+func (c *contractReaderLoopTester) Setup(t *testing.T, started bool) {
+	c.ChainComponentsInterfaceTester.Setup(t, started)
 	contractReader := c.ChainComponentsInterfaceTester.GetContractReader(t)
 
 	c.lst.registerHook = func(server *grpc.Server) {