[Testing, Tooling] Expose integration app via gRPC/HTTP/WS #1017

bryanchriswhite · 2024-12-20T12:00:54Z

Summary

This branch is currently a spike towards a PoC of wrapping an integration.App in gRPC/HTTP/WS servers such that (off-chain) clients can be used in app integration level tests.

Issue

These testutils are necessary in order to cover client usage at this testing level, which is preferred over higher levels for most kinds of tests.

The client caching work (#543) will depend on this for coverage over its usage of EventsReplayClient, once event-drive cache warming is implemented (eminent - #994). Otherwise, this coverage can only be expressed at the in-memory network or E2E levels, which we SHOULD NOT do.

Type of change

Select one or more from the following:

New feature, functionality or library
Consensus breaking; add the consensus-breaking label if so. See [Infra] Automatically add the consensus-breaking label #791 for details
Bug fix
Code health or cleanup
Documentation
Other (specify): Test utilities

Testing

Documentation: make docusaurus_start; only needed if you make doc changes
Unit Tests: make go_develop_and_test
LocalNet E2E Tests: make test_e2e
DevNet E2E Tests: Add the devnet-test-e2e label to the PR.

Sanity Checklist

I have tested my changes using the available tooling
I have commented my code
I have performed a self-review of my own code; both comments & source code
I create and reference any new tickets, if applicable
I have left TODOs throughout the codebase, if applicable

github-actions · 2024-12-20T12:01:17Z

testutil/e2e/ws_server.go

+			resp := rpctypes.RPCResponse{
+				JSONRPC: "2.0",
+				ID:      req.ID,
+				// TODO_IN_THIS_COMMIT: generate a mock result...


[linter-name (fail-on-found)] _{reported by reviewdog 🐶}
// TODO_IN_THIS_COMMIT: generate a mock result...

github-actions · 2024-12-20T12:01:17Z

testutil/e2e/ws_server.go

+	}
+}
+
+// TODO_IN_THIS_COMMIT: also wrap RunMsgs...


[linter-name (fail-on-found)] _{reported by reviewdog 🐶}
// TODO_IN_THIS_COMMIT: also wrap RunMsgs...

github-actions · 2024-12-20T12:01:17Z

testutil/e2e/ws_server.go

+}
+
+// TODO_IN_THIS_COMMIT: also wrap RunMsgs...
+// TODO_IN_THIS_COMMIT: godoc...


[linter-name (fail-on-found)] _{reported by reviewdog 🐶}
// TODO_IN_THIS_COMMIT: godoc...

github-actions · 2025-01-09T14:14:43Z

testutil/testclient/localnet.go

+	return NewFlagSet(t, CometLocalTCPURL)
+}
+
+// TODO_IN_THIS_COMMIT: godoc...


[linter-name (fail-on-found)] _{reported by reviewdog 🐶}
// TODO_IN_THIS_COMMIT: godoc...

github-actions · 2025-01-09T14:14:44Z

testutil/testclient/testtx/context.go

+func NewE2ETxContext(
+	t *testing.T,
+	keyring cosmoskeyring.Keyring,
+	flagSet *pflag.FlagSet,


[linter-name (fail-on-found)] _{reported by reviewdog 🐶}
// TODO_IN_THIS_COMMIT: godoc...

github-actions · 2025-01-09T14:14:44Z

testutil/e2e/app_test.go

+
+func TestNewE2EApp(t *testing.T) {
+	initialHeight := int64(7553)
+	// TODO_IN_THIS_COMMIT: does this 👆 need to be reconciled with the internal height of app?


[linter-name (fail-on-found)] _{reported by reviewdog 🐶}
// TODO_IN_THIS_COMMIT: does this 👆 need to be reconciled with the internal height of app?

github-actions · 2025-01-09T14:14:44Z

testutil/e2e/app_test.go

+	gateway2Addr, err := rec.GetAddress()
+	require.NoError(t, err)
+
+	// TODO_IN_THIS_COMMOT: fund gateway2 account.


[linter-name (fail-on-found)] _{reported by reviewdog 🐶}
// TODO_IN_THIS_COMMOT: fund gateway2 account.

github-actions · 2025-01-09T14:14:44Z

testutil/e2e/app_test.go

+	blockClient, err := block.NewBlockClient(app.GetSdkCtx(), deps)
+	require.NoError(t, err)
+
+	// TODO_IN_THIS_COMMIT: NOT localnet flagset NOR context, should be


[linter-name (fail-on-found)] _{reported by reviewdog 🐶}
// TODO_IN_THIS_COMMIT: NOT localnet flagset NOR context, should be

github-actions · 2025-01-09T14:14:44Z

testutil/e2e/app_test.go

+		),
+	)
+
+	// TODO_IN_THIS_COMMIT: signal to the WS server to send another block result event...


[linter-name (fail-on-found)] _{reported by reviewdog 🐶}
// TODO_IN_THIS_COMMIT: signal to the WS server to send another block result event...

github-actions · 2025-01-09T14:14:44Z

testutil/e2e/ws_server.go

+	go app.handleWebSocketConnection(conn)
+}
+
+// TODO_IN_THIS_COMMIT: move


[linter-name (fail-on-found)] _{reported by reviewdog 🐶}
// TODO_IN_THIS_COMMIT: move

github-actions · 2025-01-09T14:14:45Z

testutil/e2e/ws_server.go

+				response := rpctypes.RPCResponse{
+					JSONRPC: "2.0",
+					ID:      nil, // Events don't have an ID
+					// TODO_IN_THIS_COMMIT: make this dynamic!


[linter-name (fail-on-found)] _{reported by reviewdog 🐶}
// TODO_IN_THIS_COMMIT: make this dynamic!

github-actions · 2025-01-09T14:14:45Z

testutil/integration/app.go

@@ -963,6 +966,11 @@ func (app *App) setupDefaultActorsState(
 	app.NextBlock(t)
 }

+// TODO_IN_THIS_COMMIT: godoc...


[linter-name (fail-on-found)] _{reported by reviewdog 🐶}
// TODO_IN_THIS_COMMIT: godoc...

github-actions · 2025-01-13T11:22:09Z

testutil/e2e/comet.go

+//	if req.Method != "abci_query" {
+//		fmt.Printf(">>>> WRONG METHOD")
+//
+//		// TODO_IN_THIS_COMMIT: consolidate with other error response logic...


[linter-name (fail-on-found)] _{reported by reviewdog 🐶}
// // TODO_IN_THIS_COMMIT: consolidate with other error response logic...

github-actions · 2025-01-13T11:22:09Z

testutil/integration/app.go

@@ -563,32 +563,43 @@ func NewCompleteIntegrationApp(t *testing.T, opts ...IntegrationAppOptionFn) *Ap
 		opts...,
 	)

+	configurator := module.NewConfigurator(cdc, msgRouter, queryHelper)
+	//// TODO_IN_THIS_COMMIT: clean up...


[linter-name (fail-on-found)] _{reported by reviewdog 🐶}
//// TODO_IN_THIS_COMMIT: clean up...

github-actions · 2025-01-13T11:22:09Z

testutil/integration/options.go

@@ -70,3 +73,10 @@ func WithTokenLogicModules(tokenLogicModules []tlm.TokenLogicModule) Integration
 		config.TokenLogicModules = tokenLogicModules
 	}
 }
+
+// TODO_IN_THIS_COMMIT: godoc...


[linter-name (fail-on-found)] _{reported by reviewdog 🐶}
// TODO_IN_THIS_COMMIT: godoc...

github-actions · 2025-01-14T10:06:43Z

testutil/e2e/comet.go

+	"github.com/grpc-ecosystem/grpc-gateway/runtime"
+)
+
+// TODO_IN_THIS_COMMIT: godoc...


[linter-name (fail-on-found)] _{reported by reviewdog 🐶}
// TODO_IN_THIS_COMMIT: godoc...

github-actions · 2025-01-14T10:06:43Z

testutil/e2e/comet.go

+// TODO_IN_THIS_COMMIT: godoc...
+type CometBFTMethod string
+
+// TODO_IN_THIS_COMMIT: godoc...


[linter-name (fail-on-found)] _{reported by reviewdog 🐶}
// TODO_IN_THIS_COMMIT: godoc...

github-actions · 2025-01-14T10:06:43Z

testutil/e2e/comet.go

+
+		var response rpctypes.RPCResponse
+		switch CometBFTMethod(req.Method) {
+		// TODO_IN_THIS_COMMIT: extract...


[linter-name (fail-on-found)] _{reported by reviewdog 🐶}
// TODO_IN_THIS_COMMIT: extract...

github-actions · 2025-01-14T10:06:44Z

testutil/e2e/comet.go

+	}
+}
+
+// TODO_IN_THIS_COMMIT: godoc...


[linter-name (fail-on-found)] _{reported by reviewdog 🐶}
// TODO_IN_THIS_COMMIT: godoc...

github-actions · 2025-01-14T10:06:44Z

testutil/e2e/comet.go

+	writeErrorResponse(w, req, errMsg, "")
+}
+
+// TODO_IN_THIS_COMMIT: godoc...


[linter-name (fail-on-found)] _{reported by reviewdog 🐶}
// TODO_IN_THIS_COMMIT: godoc...

github-actions · 2025-01-14T10:06:44Z

testutil/e2e/comet.go

+func writeErrorResponse(w http.ResponseWriter, req rpctypes.RPCRequest, msg, data string) {
+	errRes := rpctypes.NewRPCErrorResponse(req.ID, 500, msg, data)
+	if err := json.NewEncoder(w).Encode(errRes); err != nil {
+		// TODO_IN_THIS_COMMIT: log error


[linter-name (fail-on-found)] _{reported by reviewdog 🐶}
// TODO_IN_THIS_COMMIT: log error

github-actions · 2025-01-14T10:06:44Z

testutil/integration/app.go

+	return txMsgResps, nil
+}
+
+// TODO_IN_THIS_COMMIT: godoc...


[linter-name (fail-on-found)] _{reported by reviewdog 🐶}
// TODO_IN_THIS_COMMIT: godoc...

wip

3cf4cd3

bryanchriswhite self-assigned this Dec 20, 2024

bryanchriswhite added testing Test (or test utils) additions, fixes, improvements or other off-chain Off-chain business logic tooling Tooling - CLI, scripts, helpers, off-chain, etc... labels Dec 20, 2024

github-actions bot reviewed Dec 20, 2024

View reviewed changes

bryanchriswhite added this to the Shannon Quality of Life milestone Dec 20, 2024

wip

3d3e3f4

github-actions bot reviewed Jan 9, 2025

View reviewed changes

red-0ne and others added 3 commits January 10, 2025 16:51

fix: Working grpc server

9a5fc9d

wip

1714822

wip

f9091a3

github-actions bot reviewed Jan 13, 2025

View reviewed changes

bryanchriswhite added 3 commits January 14, 2025 09:17

wip

c76a958

wip: some cleanup

423067b

wip

2b76ef1

github-actions bot reviewed Jan 14, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Testing, Tooling] Expose integration app via gRPC/HTTP/WS #1017

[Testing, Tooling] Expose integration app via gRPC/HTTP/WS #1017

bryanchriswhite commented Dec 20, 2024

github-actions bot Dec 20, 2024

github-actions bot Dec 20, 2024

github-actions bot Dec 20, 2024

github-actions bot Jan 9, 2025

github-actions bot Jan 9, 2025

github-actions bot Jan 9, 2025

github-actions bot Jan 9, 2025

github-actions bot Jan 9, 2025

github-actions bot Jan 9, 2025

github-actions bot Jan 9, 2025

github-actions bot Jan 9, 2025

github-actions bot Jan 9, 2025

github-actions bot Jan 13, 2025

github-actions bot Jan 13, 2025

github-actions bot Jan 13, 2025

github-actions bot Jan 14, 2025

github-actions bot Jan 14, 2025

github-actions bot Jan 14, 2025

github-actions bot Jan 14, 2025

github-actions bot Jan 14, 2025

github-actions bot Jan 14, 2025

github-actions bot Jan 14, 2025

[Testing, Tooling] Expose integration app via gRPC/HTTP/WS #1017

Are you sure you want to change the base?

[Testing, Tooling] Expose integration app via gRPC/HTTP/WS #1017

Conversation

bryanchriswhite commented Dec 20, 2024

Summary

Issue

Type of change

Testing

Sanity Checklist

github-actions bot Dec 20, 2024

Choose a reason for hiding this comment

github-actions bot Dec 20, 2024

Choose a reason for hiding this comment

github-actions bot Dec 20, 2024

Choose a reason for hiding this comment

github-actions bot Jan 9, 2025

Choose a reason for hiding this comment

github-actions bot Jan 9, 2025

Choose a reason for hiding this comment

github-actions bot Jan 9, 2025

Choose a reason for hiding this comment

github-actions bot Jan 9, 2025

Choose a reason for hiding this comment

github-actions bot Jan 9, 2025

Choose a reason for hiding this comment

github-actions bot Jan 9, 2025

Choose a reason for hiding this comment

github-actions bot Jan 9, 2025

Choose a reason for hiding this comment

github-actions bot Jan 9, 2025

Choose a reason for hiding this comment

github-actions bot Jan 9, 2025

Choose a reason for hiding this comment

github-actions bot Jan 13, 2025

Choose a reason for hiding this comment

github-actions bot Jan 13, 2025

Choose a reason for hiding this comment

github-actions bot Jan 13, 2025

Choose a reason for hiding this comment

github-actions bot Jan 14, 2025

Choose a reason for hiding this comment

github-actions bot Jan 14, 2025

Choose a reason for hiding this comment

github-actions bot Jan 14, 2025

Choose a reason for hiding this comment

github-actions bot Jan 14, 2025

Choose a reason for hiding this comment

github-actions bot Jan 14, 2025

Choose a reason for hiding this comment

github-actions bot Jan 14, 2025

Choose a reason for hiding this comment

github-actions bot Jan 14, 2025

Choose a reason for hiding this comment