Skip to content

Commit c03eca6

Browse files
committed
docs: list the unit tests CI does not run, and how to run them
The Test Util Scripts workflow runs flow/test/test_*.py. The unit tests under flow/scripts/memories/, flow/util/genMetrics_test.py and tools/FakeRAM2.0/test/ are not hooked up to CI and are run locally when the code they cover changes. Say so in the developer guide, with the command for each, so a contributor knows they exist and that a green CI run says nothing about them. Signed-off-by: Øyvind Harboe <oyvind.harboe@zylin.com>
1 parent 9ca2a9e commit c03eca6

1 file changed

Lines changed: 13 additions & 0 deletions

File tree

‎docs/contrib/DeveloperGuide.md‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -67,3 +67,16 @@ bytes on macOS).
6767
```bash
6868
python3 -m pytest flow/test/test_run_command.py -v
6969
```
70+
71+
## Unit tests that CI does not run
72+
73+
CI runs the `flow/test/test_*.py` files (`Test Util Scripts` in
74+
`.github/workflows/github-actions-cron-util-test.yml`). The unit tests
75+
below are not hooked up to CI. Run them locally when changing the code
76+
they cover:
77+
78+
| Tests | Cover | Run |
79+
|---|---|---|
80+
| `flow/scripts/memories/*_test.py` | `AUTO_MEMORIES` detection, schema and macro generation | `for t in flow/scripts/memories/*_test.py; do python3 $t; done` |
81+
| `flow/util/genMetrics_test.py` | `genMetrics.py` | `python3 flow/util/genMetrics_test.py` |
82+
| `tools/FakeRAM2.0/test/*_test.py` | FakeRAM2.0 | `tools/FakeRAM2.0/test/test_all.sh` |

0 commit comments

Comments
 (0)