Implement service and endpoint mocking support in tests #1005
Conversation
|
All committers have signed the CLA. |
Test Results 2 files + 1 227 suites +65 14m 55s ⏱️ - 9m 15s Results for commit c597051. ± Comparison against base commit 4092684. This pull request removes 18 and adds 222 tests. Note that renamed tests count towards both.♻️ This comment has been updated with latest results. |
| if mockedAPI, found := c.server.testingMgr.GetAPIMock(d.Service, d.Endpoint); found && mockedAPI.Function != nil { | ||
| function, err := d.getMockFunction(mockedAPI) | ||
| if err != nil { | ||
| return respData, errs.Wrap(err, "unable to call mocked API due to an issue with the mock") | ||
| } | ||
| return d.mockedCall(c, function, req) | ||
| } else if mockedService, found := c.server.testingMgr.GetServiceMock(d.Service); found && mockedService != nil { | ||
| method, err := d.getMockMethod(mockedService) | ||
| if err != nil { | ||
| return respData, errs.Wrap(err, "unable to call mocked API due to an issue with the mock") | ||
| } | ||
| return d.mockedCall(c, method, req) | ||
| } else { | ||
| return d.internalCall(c, req) | ||
| } |
There was a problem hiding this comment.
Would be nice to extract this to a d.testingCall method like for d.internalCall below
There was a problem hiding this comment.
The extraction is already d.mockedCall - seemed a little rediciously do have let another d.testingCall then d.mockedCall, d.internalCall and d.externalCall
Given that Call was the place where we decided what actual type of call we're going to make, it felt right to keep the logic all here
| holder InstanceHolder[T] | ||
| } | ||
|
|
||
| type InstanceHolder[T any] struct { |
There was a problem hiding this comment.
Would be nice to document why this exists
| @@ -357,15 +357,15 @@ func (i BuilderImpl) GenUserFacing(ctx context.Context, p builder.GenUserFacingP | |||
| // Service structs are not needed if there is no implementation to be generated | |||
| svcStruct := option.None[*codegen.VarDecl]() | |||
|
|
|||
| buf.Reset() | |||
There was a problem hiding this comment.
What's the reason for the change here?
There was a problem hiding this comment.
You introduced a bug in v2 which has been iterating me all year ;)
Without the reset, it causes us to generate empty encore.gen.go files when they are not needed. (As you unconditionally always add the prelude comments). I explicly didn't do this in v1, and this fixes it in v2.
There was a problem hiding this comment.
Ah nice. We also have an outstanding issue where we keep encore.gen.go files around after a service has been renamed. Think that would be easy to address, too, or is that a separate issue?
There was a problem hiding this comment.
Seperate issue, mainly because we don't track services in the CLI so we have no way of detecting that easily (apart from maybe looking for encore.gen.go files being the only thing in a folder - but I say let's keep that as a separate issue
Co-authored-by: André Eriksson <andre@encore.dev>
This PR implements three new features into the
et(Encore Testing) package.et.MockEndpointallows you to replace a specific endpoint during a test with another implementation.et.MockServiceallows you to replace entire services during a test with either a different instance of the service struct or with a wholly mocked-out object.et.EnableServiceInstanceIsolationallows you to force a test to have it's own isolated instance of any service struct that is accessed during that test.All three of these functions can be called in the test entry point (
TestMain) or in your tests themselves. They all cascade their behaviour down from the point called to any sub-tests as well.