search

dr-joe-wirth / primerForge

software to identify primers that can distinguish genomes
Apache License 2.0
11 stars 4 forks source link

How to run tests #21

Closed mbhall88 closed 3 weeks ago

mbhall88 commented 3 weeks ago

This issues is part of the JOSS review https://github.com/openjournals/joss-reviews/issues/6850

In relation to the documentation guideline Automated tests: Are there automated tests or manual steps described so that the functionality of the software can be verified?

I see there is a unit tests directory in your bin/ directory, but I don't see any documented way of running the tests - doesn't seem to be run on the CI so I couldn't figure it out.

dr-joe-wirth commented 3 weeks ago

Sorry about this. The instructions are in the README.md.

https://github.com/dr-joe-wirth/primerForge/tree/main?tab=readme-ov-file#running-unit-tests

mbhall88 commented 3 weeks ago

Out of interest. You say tests may take three hours to run. How come it takes so long?

dr-joe-wirth commented 3 weeks ago

It will run the software first, on a test case of five genomes which takes some time. The tests in results_test.py make sure that the results are sound and congruent with the input genomes.