Explicitly clarify the difference between unit and system test files#9419
Conversation
This aims to clarify for new contributors how to run the tests they've may have edited.
Codecov Report
@@ Coverage Diff @@
## master #9419 +/- ##
==========================================
- Coverage 60.93% 60.47% -0.46%
==========================================
Files 529 544 +15
Lines 28578 29313 +735
Branches 4338 4439 +101
==========================================
+ Hits 17413 17727 +314
- Misses 10214 10595 +381
- Partials 951 991 +40
Continue to review full report at Codecov.
|
|
|
||
| ### Running System Tests | ||
|
|
||
| Note: System tests are those in files with extension `.test.ts` but which are not `.unit.test.ts`. |
There was a problem hiding this comment.
They are not necessarily test.ts, it can be test*.ts (For eg. testvirtualenvs.ts)
| Note: System tests are those in files with extension `.test.ts` but which are not `.unit.test.ts`. | |
| Note: System tests are those in files with extension `.test*.ts` but which are not `.unit.test.ts`. |
There was a problem hiding this comment.
Ah right, thanks. Are there any other types which might be worth mentioning explicitly?
There was a problem hiding this comment.
Ah yes. There is these .functional.test.ts files, which are run just like unit tests, not system ones. That is, you don't need to follow steps mentioned for system tests to run those.
There was a problem hiding this comment.
Ah, yeah, I see there's npm run test:functional. Is there some documentation somewhere on what sorts of things those tests cover?
There was a problem hiding this comment.
Are you referring to what tests with suffix .functional.test.ts cover?
I don't think we've documentation for those. They're kind of like system tests, but test a smaller block of code.
But they are run just like unit tests. So for purposes of this PR, you can just mention steps to run .functional.test.ts are just like steps to run unit.test.ts.
There was a problem hiding this comment.
Apologies for the delay. I've added a small section on functional tests: f6a9b10
For example: `.testvirtualenvs.ts`.
|
SonarCloud Quality Gate failed.
|
This aims to clarify for new contributors how to run the tests they've may have edited.
Has a news entry file (remember to thank yourself!)Not sure this tiny change is worth a news entry
(other bullets don't apply to docs changes)