Skip to content

Commit 424c561

Browse files
Formalise test coverage rules (#43)
1 parent 6d7c6fe commit 424c561

File tree

2 files changed

+8
-0
lines changed

2 files changed

+8
-0
lines changed

spell/spell-crafter-mainnet-workflow.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -135,6 +135,10 @@ Repo: https://github.com/makerdao/spells-mainnet
135135
* [ ] Ensure good coverage (every spell action is tested)
136136
* [ ] Ensure every test function is declared as `public`
137137
* [ ] IF the test needs to run, it MUST NOT have the `skipped` modifier; OTHERWISE, it MUST have the `skipped` modifier
138+
* IF a new module is initialized via the spell, the tests must include
139+
* [ ] Sanity checks of the constructor arguments
140+
* [ ] Sanity checks of all values added/updated by the spell function
141+
* [ ] End-to-end "happy path" interaction with the module
138142
* [ ] Tests PASS via `make test`
139143
* [ ] 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)
140144
* [ ] 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
@@ -320,6 +320,10 @@
320320
* [ ] Ensure each spell action has sufficient test coverage
321321
_List actions for which coverage was checked here_
322322
* [ ] Ensure that any other env variable does not affect execution of the tests (for example, by inspecting the output of `printenv | grep "FOUNDRY_\|DAPP_"`)
323+
* IF a new module is initialized via the spell, the tests must include
324+
* [ ] Sanity checks of the constructor arguments
325+
* [ ] Sanity checks of all values added/updated by the spell function
326+
* [ ] End-to-end "happy path" interaction with the module
323327
* [ ] Check all tests are passing locally using `make test`
324328
* [ ] Ensure every test listed in the _coverage_ item above is present in the logs and with the `[PASS]` prefix.
325329

0 commit comments

Comments
 (0)