Add first example reference model test (Regions) #14
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
Now we've imported and updated all our models it is time to start adding some example tests to drive research of node-test as an alternate to Lab further. In database terms, all models are accessed and used in the same way via Objection.js. However, we split them into two camps for testing; reference models and transaction models. Reference models are things we don't expect to be creating within the service as part of daily use. They are records that would be seeded, for example, regions. Transaction models are things we expect to be created, for example, bill runs or licences. When it comes to testing we seed the tables that back the reference models, hence their helpers generally have a `select()` method. Transaction models, when needed, will be created during the testing. Their helpers generally have an `add()` method. When we first tried this test, node-test wouldn't quit. It wouldn't even move to the next spec after `region.model.test.js`. This is a problem we first faced when pulling this project together. Time away has clearly helped because we were able to diagnose the cause as the database connection we create blocks node test from exiting (see [test_runner: allow to force exit after all tests finished](nodejs/node#49925) for a deeper dive into the issue which gave us our a-ha! moment). It does mean we'll need to add an `after()` block into any spec that results in a DB connection being made. But that should be simple enough. Completing this example has also highlighted that we'll probably want to extend `assert` in some way, to avoid 'messy duplication' in our tests. But for now, here is our first working model node-test!
`pretest` is not being called because we are using the custom script name `npm run test:lcov` rather than just `npm test`. So, first attempt is calling pretest explicitly before running the unit tests.
Cruikshanks
added a commit
that referenced
this pull request
Oct 14, 2024
In [Add first example reference model test (Regions)](#14) we added our first model test and chose a 'reference' type. In database terms, all models are accessed and used via Objection.js. However, for testing, we split them into two camps: reference models and transaction models. Reference models are things we don't expect to create within the service as part of daily use. They are records that would be seeded, such as regions. Transaction models are things we expect to be created, such as bill runs, licences or in this case, workflow. This change migrates the model tests for `WorkflowModel`.
Cruikshanks
added a commit
that referenced
this pull request
Oct 14, 2024
In [Add first example reference model test (Regions)](#14) we added our first model test and chose a 'reference' type. In database terms, all models are accessed and used via Objection.js. However, for testing, we split them into two camps: reference models and transaction models. Reference models are things we don't expect to create within the service as part of daily use. They are records that would be seeded, such as regions. Transaction models are things we expect to be created, such as bill runs, licences or in this case, workflow. This change migrates the model tests for `WorkflowModel`.
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.
Now that we've imported and updated all our models, it is time to start adding some example tests to further research node-test as an alternative to Lab.
In database terms, all models are accessed and used via Objection.js. However, for testing, we split them into two camps: reference models and transaction models.
Reference models are things we don't expect to create within the service as part of daily use. They are records that would be seeded, such as regions.
Transaction models are things we expect to be created, such as bill runs or licences.
When it comes to testing we seed the tables that back the reference models, hence their helpers generally have a
select()method. Transaction models, when needed, will be created during the testing. Their helpers generally have anadd()method.When we first tried this test, node-test wouldn't quit. It wouldn't even move to the next spec after
region.model.test.js. This is a problem we first faced when pulling this project together. Time away has clearly helped because we were able to diagnose the cause as the database connection we create blocks node test from exiting (see test_runner: allow to force exit after all tests finished for a deeper dive into the issue which gave us our a-ha! moment).This does mean we'll need to add an
after()block to any spec that results in a DB connection being made, but that should be simple enough.Completing this example has also highlighted that we'll probably want to extend
assertin some way, to avoid 'messy duplication' in our tests.But for now, here is our first working model node-test!