Skip to content

Commit a3b6d93

Browse files
add section with test coverage rules for the new modules
1 parent 5208017 commit a3b6d93

File tree

2 files changed

+9
-1
lines changed

2 files changed

+9
-1
lines changed

spell/spell-crafter-mainnet-workflow.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -126,9 +126,13 @@ Repo: https://github.com/makerdao/spells-mainnet
126126
* [ ] Test DAI/MKR streams and payments, lerps
127127
* [ ] Test the sum of all DAI/MKR payments matches the Exec Sheet
128128
* Run tests via `make test` (or `make test match=<test_name>` to inspect debug traces)
129-
* [ ] Ensure good coverage (every spell action is tested)
129+
- [ ] Ensure good coverage (every spell action is tested)
130130
* [ ] Ensure every test function is declared as `public`
131131
* [ ] IF the test needs to run, it MUST NOT have the `skipped` modifier; OTHERWISE, it MUST have the `skipped` modifier
132+
- Testing of modules initialised via the spell
133+
- [ ] Sanity checks of the constructor arguments
134+
- [ ] Sanity checks of all values added/updated by the spell/init function
135+
- [ ] End-to-end "happy path" interaction with the module
132136
* [ ] Tests PASS via `make test`
133137
* [ ] Ensure `DssExecLib` address used in current spell (`DssExecLib.address`) matches `dss-exec-lib` [Latest Release Tag](https://github.com/makerdao/dss-exec-lib/releases/latest)
134138
* [ ] Push committed content to already opened PR

spell/spell-reviewer-mainnet-checklist.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -314,6 +314,10 @@
314314
* [ ] Ensure each spell action has sufficient test coverage
315315
_List actions for which coverage was checked here_
316316
* [ ] Ensure that any other env variable does not affect execution of the tests (for example, by inspecting the output of `printenv | grep "FOUNDRY_\|DAPP_"`)
317+
- Testing of modules initialised via the spell
318+
- [ ] Sanity checks of the constructor arguments
319+
- [ ] Sanity checks of all values added/updated by the spell/init function
320+
- [ ] End-to-end "happy path" interaction with the module
317321
* [ ] Check all tests are passing locally using `make test`
318322
* [ ] Ensure every test listed in the _coverage_ item above is present in the logs and with the `[PASS]` prefix.
319323

0 commit comments

Comments
 (0)