Skip to content

Commit

Permalink
add section with test coverage rules for the new modules
Browse files Browse the repository at this point in the history
  • Loading branch information
SidestreamColdMelon committed Nov 18, 2024
1 parent 5208017 commit a3b6d93
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 1 deletion.
6 changes: 5 additions & 1 deletion spell/spell-crafter-mainnet-workflow.md
Original file line number Diff line number Diff line change
Expand Up @@ -126,9 +126,13 @@ Repo: https://github.com/makerdao/spells-mainnet
* [ ] Test DAI/MKR streams and payments, lerps
* [ ] Test the sum of all DAI/MKR payments matches the Exec Sheet
* Run tests via `make test` (or `make test match=<test_name>` to inspect debug traces)
* [ ] Ensure good coverage (every spell action is tested)
- [ ] Ensure good coverage (every spell action is tested)
* [ ] Ensure every test function is declared as `public`
* [ ] IF the test needs to run, it MUST NOT have the `skipped` modifier; OTHERWISE, it MUST have the `skipped` modifier
- Testing of modules initialised via the spell
- [ ] Sanity checks of the constructor arguments
- [ ] Sanity checks of all values added/updated by the spell/init function
- [ ] End-to-end "happy path" interaction with the module
* [ ] Tests PASS via `make test`
* [ ] 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)
* [ ] Push committed content to already opened PR
Expand Down
4 changes: 4 additions & 0 deletions spell/spell-reviewer-mainnet-checklist.md
Original file line number Diff line number Diff line change
Expand Up @@ -314,6 +314,10 @@
* [ ] Ensure each spell action has sufficient test coverage
_List actions for which coverage was checked here_
* [ ] Ensure that any other env variable does not affect execution of the tests (for example, by inspecting the output of `printenv | grep "FOUNDRY_\|DAPP_"`)
- Testing of modules initialised via the spell
- [ ] Sanity checks of the constructor arguments
- [ ] Sanity checks of all values added/updated by the spell/init function
- [ ] End-to-end "happy path" interaction with the module
* [ ] Check all tests are passing locally using `make test`
* [ ] Ensure every test listed in the _coverage_ item above is present in the logs and with the `[PASS]` prefix.
Expand Down

0 comments on commit a3b6d93

Please sign in to comment.