Make test data helpers more 'unique' #452
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-4144 We've been investigating changing our unit test framework recently (see [Investigate switching to jest](#430) and [water-abstraction-ava](https://github.com/DEFRA/water-abstraction-ava)). A key issue we'll have if we switch is that most other frameworks run tests asynchronously. This means our pattern of clean-setup-assert won't work. At best we can clean before any tests run but then the test data we setup must not clash. To achieve that we need to make the test data the helpers generate as unique as possible, which means moving away from hard coded values. We're still playing with frameworks but there is nothing stopping us making this change now ahead of a decision. So, this change covers making the helpers generate more unique and fixing any tests that breaks.
Cruikshanks
added
the
housekeeping
Where a helper is hard coding a UUID for a field is going to be easy to make unique; we just call our `GeneralLib.generateUUID()` function. But many helpers also need to generate references, licence number being a good example. If we are going to make these unique we're going to need a means to generate random numbers. Often they need to be within a certain range, for example, 100 to 999 because the number must be a certain number of digits long. So, we're adding a new `randomInteger()` function which can handle this requirement. Doing so forced us to make a decision as to where to put it. We decided to create a `GeneralHelper` module that can be used going forward for any shared functionality in the helpers.
The tests relied on known uprn and company numbers. They needed to be tweaked to work with generated numbers which meant the tests needed to access the same reference generators as the helpers.
Cruikshanks
force-pushed
the
make-test-helper-records-unique
branch
from
fea9cf3 to
01b5be8
Compare
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
test/services/billing/supplementary/fetch-previous-transactions.service.test.js
Dismissed
Show dismissed
Hide dismissed
test/services/billing/supplementary/fetch-previous-transactions.service.test.js
Dismissed
Show dismissed
Hide dismissed
|
This is bigger than I'd like it to be. But it made sense to do all the helpers at the same time, especially as the changes are generally consistent across them. Happy to walk/talk through anything if anyone has questions. |
Beckyrose200
reviewed
Oct 6, 2023
test/services/billing/supplementary/fetch-previous-transactions.service.test.js
Outdated
Show resolved
Hide resolved
test/services/billing/supplementary/fetch-previous-transactions.service.test.js
Outdated
Show resolved
Hide resolved
Jozzey
requested changes
Oct 6, 2023
test/services/billing/supplementary/fetch-previous-transactions.service.test.js
Outdated
Show resolved
Hide resolved
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-4144
We've been investigating changing our unit test framework recently (see Investigate switching to jest and water-abstraction-ava).
A key issue we'll have if we switch is that most other frameworks run tests asynchronously. This means our pattern of clean-setup-assert won't work. At best we can clean before any tests run but then the test data we set up must not clash.
To achieve that we need to make the test data the helpers generate as unique as possible, which means moving away from hard-coded values.
We're still playing with frameworks but there is nothing stopping us from making this change now ahead of a decision.
So, this change covers making the helpers generate more unique and fixing any tests that break.
Notes
Where a helper is hard-coding a UUID for a field is going to be easy to make it unique; we just call our
GeneralLib.generateUUID()function.But many helpers also need to generate references, licence numbers being a good example. If we are going to make these unique we're going to need a means to generate random numbers. Often they need to be within a certain range, for example, 100 to 999 because the number must be a certain number of digits long.
So, we're adding a new
randomInteger()function which can handle this requirement. Doing so forced us to make a decision as to where to put it. We decided to create aGeneralHelpermodule that can be used going forward for any shared functionality in the helpers.