feat: module tests can declare config/secrets/DSNs and add verb mocks #1317

matt2e · 2024-04-22T01:15:34Z

Part of: https://hackmd.io/zNiBPIhVQN2hkeNHg2r8YA

This PR makes it easy to set up the following:

config
secrets
DSNs
mocks for verbs

"github.com/TBD54566975/ftl/go-runtime/ftltest"

func TestEcho(t *testing.T) {
    ctx := ftltest.Context (
        ftltest.WithConfig("default", "anonymous"),
        ftltest.WithSecret("example", "test123"),
        ftltest.WithDSN("db", ftltest.DBTypePostgres, "..."),
        ftltest.WhenVerb(time.Time, func(ctx context. Context, req time. TimeRequest) (time.TimeResponse, error) {
            return time.TimeResponse{Time: stdtime.Date(2021, 9, 1, 0, 0, 0, 0, stdtime.UTC)}, nil
        },
    )

    ...
}

Another improvement is when doing unit tests, a simple error message will be returned when attempting to make a ftl.Call when there isn't any rpc client set up. This error will be returned:

time.time: no mock found

Doc: https://hackmd.io/@ftl/SyynEK2eC Other PRs - [x] Pre-Req: protobuf changes #1312 - [ ] Possible future change for tests moved here: #1317 Changes: - Module server requests module context, instead of calculating them independently from envars - controller alculates values for module context (config, secrets, DSNs), returns it to module via gRPC - Within a module, `ftl.PostgresDatabase(name string)` now returns a handler, with `Get()` needing to be called to get `*sql.DB` - Module context builder is used to compose a module context. It can take in: - a GetModuleContext response, to read in values received over gRPC - manual entry (useful for testing) (see other PR above) - Added in-memory implementations of `configuration.MutableProvider` and `configuration.Resolver`. This allows us to have a backing store for configs and secrets for `ModuleContext` which shares the same behaviour for (un)marshalling json. - `configuration.Manager` now has raw data versions of `Get()` and `Set()` called `GetData()` and `SetData()` which expose the features without needing unnecessary conversion steps. This helps when moving values between configuration managers directly or over gRPC.

matt2e · 2024-04-29T06:02:12Z

go-runtime/ftl/call_overrider.go

+	"context"
+)
+
+type CallOverrider interface {


I didn't want this to be public to module code, but wasn't sure of a better place to put it...

matt2e · 2024-04-29T06:10:25Z

go-runtime/ftl/types.go

@@ -43,8 +43,8 @@ func (v *Ref) UnmarshalText(text []byte) error {
 	return nil
 }

-func (v *Ref) String() string { return v.Module + "." + v.Name }
-func (v *Ref) ToProto() *schemapb.Ref {
+func (v Ref) String() string { return v.Module + "." + v.Name }


this is because Ref not *Ref is used everywhere but printf wasn't formatting it nicely

deniseli · 2024-04-29T18:17:25Z

go-runtime/ftl/ftltest/mock.go

+// mockProvider keeps a mapping of verb references to mock functions.
+//
+// It implements the CallOverrider interface to intercept calls with the mock functions.
+type mockProvider struct {


Would it be worth renaming this to mockVerbProvider in case we want to support mocking of entities other than verbs down the road?

deniseli · 2024-04-29T18:25:28Z

go-runtime/ftl/ftltest/ftltest.go

+	DBTypePostgres = DBType(modulecontext.DBTypePostgres)
+)
+
+// Context suitable for use in testing FTL verbs with provided options


super nitty nit: would you mind adding some example code to this comment so that folks don't need to grep around to learn how to use this? Basically exactly what you put in your PR description:

ctx := ftltest.Context ( ftltest.WithConfig("default", "anonymous"), ftltest.WithSecret("example", "test123"), ftltest.WithDSN("db", ftltest.DBTypePostgres, "..."), ftltest.WithFakeVerb(time.Time, func(ctx context. Context, req time. TimeRequest) (time.TimeResponse, error) { return time.TimeResponse{Time: stdtime.Date(2021, 9, 1, 0, 0, 0, 0, stdtime.UTC)}, nil }, )

Definitely don't need to include every single option in the example if you want to keep the comment shorter, either. Thanks :)

deniseli

super useful addition! thanks :D

# Conflicts: # go-runtime/modulecontext/modulecontext.go # go-runtime/server/server.go

alecthomas mentioned this pull request Apr 22, 2024

Dashboard #728

Open

This was referenced Apr 22, 2024

feat: module context over gRPC #1311

Merged

Is there a way to specify which project toml to use in tests? #1309

Closed

matt2e force-pushed the matt2e/tests-declare-module-context branch 3 times, most recently from 8f6de76 to c10e481 Compare April 22, 2024 06:01

matt2e force-pushed the matt2e/tests-declare-module-context branch 2 times, most recently from 33cb463 to 2c1513b Compare April 22, 2024 06:48

matt2e changed the title ~~feat: module tests can declare config/secrets/DSNs explicitly~~ [Draft] feat: module tests can declare config/secrets/DSNs explicitly Apr 22, 2024

matt2e changed the title ~~[Draft] feat: module tests can declare config/secrets/DSNs explicitly~~ [WIP] feat: module tests can declare config/secrets/DSNs explicitly Apr 26, 2024

matt2e force-pushed the matt2e/tests-declare-module-context branch 2 times, most recently from a1dbff1 to 7bd914f Compare April 28, 2024 23:38

github-actions bot changed the title ~~[WIP] feat: module tests can declare config/secrets/DSNs explicitly~~ feat: [WIP] module tests can declare config/secrets/DSNs explicitly Apr 28, 2024

matt2e force-pushed the matt2e/tests-declare-module-context branch 5 times, most recently from 41f30a3 to 30f7b0c Compare April 29, 2024 06:00

matt2e commented Apr 29, 2024

View reviewed changes

matt2e force-pushed the matt2e/tests-declare-module-context branch from 30f7b0c to b338886 Compare April 29, 2024 06:04

matt2e changed the title ~~feat: [WIP] module tests can declare config/secrets/DSNs explicitly~~ feat: module tests can declare config/secrets/DSNs explicitly Apr 29, 2024

matt2e marked this pull request as ready for review April 29, 2024 06:07

matt2e requested a review from a team as a code owner April 29, 2024 06:07

matt2e requested review from deniseli and removed request for a team April 29, 2024 06:07

matt2e commented Apr 29, 2024

View reviewed changes

matt2e changed the title ~~feat: module tests can declare config/secrets/DSNs explicitly~~ feat: module tests can declare config/secrets/DSNs and add verb mocks Apr 29, 2024

deniseli reviewed Apr 29, 2024

View reviewed changes

deniseli approved these changes Apr 29, 2024

View reviewed changes

matt2e force-pushed the matt2e/tests-declare-module-context branch from 96accdb to e31dd78 Compare April 30, 2024 01:47

matt2e added 6 commits April 30, 2024 11:49

feat: module tests can declare modulecontext

4bd7b16

# Conflicts: # go-runtime/modulecontext/modulecontext.go # go-runtime/server/server.go

remove file from refactor

0366419

context builder takes in mocks

c80f635

test context uses functional options pattern

c195282

mock provider returns errors explaining what needs to be mocked

b622037

rename to mockVerbProvider

9e05028

matt2e force-pushed the matt2e/tests-declare-module-context branch from e31dd78 to 9e05028 Compare April 30, 2024 01:49

rename mocking func to WhenVerb(…)

e7a85b9

matt2e force-pushed the matt2e/tests-declare-module-context branch from c1bfd0c to e7a85b9 Compare April 30, 2024 03:00

matt2e merged commit 03ec498 into main Apr 30, 2024
11 checks passed

matt2e deleted the matt2e/tests-declare-module-context branch April 30, 2024 03:19

matt2e mentioned this pull request May 3, 2024

Testing module improvements #1394

Closed

10 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: module tests can declare config/secrets/DSNs and add verb mocks #1317

feat: module tests can declare config/secrets/DSNs and add verb mocks #1317

matt2e commented Apr 22, 2024 •

edited

Loading

matt2e Apr 29, 2024

matt2e Apr 29, 2024 •

edited

Loading

deniseli Apr 29, 2024

deniseli Apr 29, 2024

deniseli left a comment

feat: module tests can declare config/secrets/DSNs and add verb mocks #1317

feat: module tests can declare config/secrets/DSNs and add verb mocks #1317

Conversation

matt2e commented Apr 22, 2024 • edited Loading

matt2e Apr 29, 2024

Choose a reason for hiding this comment

matt2e Apr 29, 2024 • edited Loading

Choose a reason for hiding this comment

deniseli Apr 29, 2024

Choose a reason for hiding this comment

deniseli Apr 29, 2024

Choose a reason for hiding this comment

deniseli left a comment

Choose a reason for hiding this comment

matt2e commented Apr 22, 2024 •

edited

Loading

matt2e Apr 29, 2024 •

edited

Loading