-
Notifications
You must be signed in to change notification settings - Fork 781
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add a WithFxOptionsForService option for our integration tests (#4895)
<!-- Describe what has changed in this PR --> **What changed?** I added an option that allows user to add fx graph modification to individual services when starting them in the SetupSuite lifecycle stage of their integration tests. <!-- Tell your future self why have you made these changes --> **Why?** This provides a super simple way to change test set ups or extract dependencies from the graph. It should make it a lot easier to write integration tests with more complex setups or assertions. I also need it for a subsequent PR that adds integration tests to the new DLQ. Specifically, I need a way to override the `ExecutableWrapper`, and I think this is simpler than adding it to the long and growing list of dependencies in the `TestClusterConfig`. <!-- How have you verified this change? Tested locally? Added a unit test? Checked in staging env? --> **How did you test it?** I added an integration test which sets this up and provides an `fx.Populate` option for the `primitives.ServiceName` variable in the current graph. I then verified that this service name matched the name of the service these options were supplied to, to ensure that the options were provided to the correct graph (because we have different graphs for each service). <!-- Assuming the worst case, what can be broken when deploying this change to production? --> **Potential risks** <!-- Is this PR a hotfix candidate or require that a notification be sent to the broader community? (Yes/No) --> **Is hotfix candidate?**
- Loading branch information
1 parent
5ab5265
commit 2f62c28
Showing
4 changed files
with
135 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,79 @@ | ||
| // The MIT License | ||
| // | ||
| // Copyright (c) 2020 Temporal Technologies Inc. All rights reserved. | ||
| // | ||
| // Copyright (c) 2020 Uber Technologies, Inc. | ||
| // | ||
| // Permission is hereby granted, free of charge, to any person obtaining a copy | ||
| // of this software and associated documentation files (the "Software"), to deal | ||
| // in the Software without restriction, including without limitation the rights | ||
| // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
| // copies of the Software, and to permit persons to whom the Software is | ||
| // furnished to do so, subject to the following conditions: | ||
| // | ||
| // The above copyright notice and this permission notice shall be included in | ||
| // all copies or substantial portions of the Software. | ||
| // | ||
| // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
| // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
| // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
| // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
| // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
| // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN | ||
| // THE SOFTWARE. | ||
|
|
||
| package tests | ||
|
|
||
| import ( | ||
| "testing" | ||
|
|
||
| "github.com/stretchr/testify/require" | ||
| "github.com/stretchr/testify/suite" | ||
| "go.uber.org/fx" | ||
|
|
||
| "go.temporal.io/server/common/primitives" | ||
| ) | ||
|
|
||
| type functionalTestBaseSuite struct { | ||
| *require.Assertions | ||
| FunctionalTestBase | ||
| frontendServiceName primitives.ServiceName | ||
| matchingServiceName primitives.ServiceName | ||
| historyServiceName primitives.ServiceName | ||
| workerServiceName primitives.ServiceName | ||
| } | ||
|
|
||
| func (s *functionalTestBaseSuite) SetupSuite() { | ||
| s.setupSuite("testdata/cluster.yaml", | ||
| WithFxOptionsForService(primitives.FrontendService, fx.Populate(&s.frontendServiceName)), | ||
| WithFxOptionsForService(primitives.MatchingService, fx.Populate(&s.matchingServiceName)), | ||
| WithFxOptionsForService(primitives.HistoryService, fx.Populate(&s.historyServiceName)), | ||
| WithFxOptionsForService(primitives.WorkerService, fx.Populate(&s.workerServiceName)), | ||
| ) | ||
|
|
||
| } | ||
|
|
||
| func (s *functionalTestBaseSuite) TearDownSuite() { | ||
| s.tearDownSuite() | ||
| } | ||
|
|
||
| func (s *functionalTestBaseSuite) TestWithFxOptionsForService() { | ||
| // This test works by using the WithFxOptionsForService option to obtain the ServiceName from the graph, and then | ||
| // it verifies that the ServiceName is correct. It does this because we are targeting the fx.App for a particular | ||
| // service, so we'll know our fx options were provided to the right service if, when we use them to get the current | ||
| // service name, it matches the target service. A more realistic example would use the option to obtain an actual | ||
| // useful object like a history shard controller, or do some graph modifications with fx.Decorate. | ||
|
|
||
| s.Equal(primitives.FrontendService, s.frontendServiceName) | ||
| s.Equal(primitives.MatchingService, s.matchingServiceName) | ||
| s.Equal(primitives.HistoryService, s.historyServiceName) | ||
| s.Equal(primitives.WorkerService, s.workerServiceName) | ||
| } | ||
|
|
||
| func (s *functionalTestBaseSuite) SetupTest() { | ||
| s.Assertions = require.New(s.T()) | ||
| } | ||
|
|
||
| func TestFunctionalTestBaseSuite(t *testing.T) { | ||
| suite.Run(t, new(functionalTestBaseSuite)) | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters