Reliable test data clear down #215
Merged
Conversation
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
https://eaflood.atlassian.net/browse/WATER-3982 Using the existing acceptance tests a common issue we face is that we can’t clear down the existing test data. Because of the solution previously implemented, it only focuses on data flagged as `is_test === true`. The problem is when using this data for test purposes you will often create related data that is not flagged as `is_test`. This leads to errors in the existing clear down process that we then have to create a and run manual SQL delete scripts to deal with. If we’re often having to write SQL delete scripts manually, and these deal with the foreign key constraints that the existing process isn’t handling, it makes sense to us to use them always rather than the existing brittle process.
|
I've had a word with @Cruikshanks about the test coverage on the schema services. As they are just for deleting test data we've agreed that they are not worth spending time on full unit testing since this would involve significant work in creating the new schemas/data in the test DB. Testing has been added but just at the high level tear-down service and the controller. |
Cruikshanks
requested changes
May 10, 2023
Co-authored-by: Alan Cruikshanks <[email protected]>
Co-authored-by: Alan Cruikshanks <[email protected]>
Co-authored-by: Alan Cruikshanks <[email protected]>
Co-authored-by: Alan Cruikshanks <[email protected]>
Cruikshanks
approved these changes
May 11, 2023
Cruikshanks
added a commit
to DEFRA/water-abstraction-acceptance-tests
that referenced
this pull request
Jun 13, 2023
https://eaflood.atlassian.net/browse/WATER-3982 Using the existing acceptance tests a common issue we face is that we can't clear down the existing test data. Because of the solution previously implemented, it only focuses on data flagged as `is_test === true`. The problem is when using this data for test purposes you will often create related data that is not flagged as `is_test`. This leads to errors in the existing clear down process that we then have to create and run manual SQL delete scripts to deal with. On top of that everything is driven through the network calls across the services. We know they haven't been properly isolated as they should have if micro-services was the intent. Knowing that we can improve the performance by just using direct SQL calls to do the tear down. So we added a [Reliable test data clear down](DEFRA/water-abstraction-system#215) endpoint to the **water-abstraction-system** app. This change updates the acceptance tests to use it rather than the old mechanism. Timings will vary across machines and environments. But so far our tests all show the new endpoint is quicker leading to a reduced runtime for all tests.
Cruikshanks
added a commit
to DEFRA/water-abstraction-acceptance-tests
that referenced
this pull request
Jun 13, 2023
https://eaflood.atlassian.net/browse/WATER-3982 Using the existing acceptance tests a common issue we face is that we can't clear down the existing test data. Because of the solution previously implemented, it only focuses on data flagged as `is_test === true`. The problem is when using this data for test purposes you will often create related data that is not flagged as `is_test`. This leads to errors in the existing clear-down process that we then have to create and run manual SQL delete scripts to deal with. On top of that everything is driven through the network calls across the services. We know they haven't been properly isolated as they should have if micro-services was the intent. Knowing that we can improve the performance by just using direct SQL calls to do the teardown. So we added a [Reliable test data clear down](DEFRA/water-abstraction-system#215) endpoint to the **water-abstraction-system** app. This change updates the acceptance tests to use it rather than the old mechanism. Timings will vary across machines and environments. But so far our tests all show the new endpoint is quicker leading to a reduced runtime for all tests.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
https://eaflood.atlassian.net/browse/WATER-3982
Using the existing acceptance tests a common issue we face is that we can’t clear down the existing test data. Because of the solution previously implemented, it only focuses on data flagged as
is_test === true. The problem is when using this data for test purposes you will often create related data that is not flagged asis_test. This leads to errors in the existing clear down process that we then have to create a and run manual SQL delete scripts to deal with.If we’re often having to write SQL delete scripts manually, and these deal with the foreign key constraints that the existing process isn’t handling, it makes sense to us to use them always rather than the existing brittle process.
This PR creates an endpoint at
/data/tear-down. To run locally, send aPOSTrequest tohttp://localhost:8013/data/tear-down.