IroGB Test Suite
Our tests are driven by the python bindings for convenience, as it allows us to easily pull down test roms from the internet without having to rely on them as a dependency. Preparing the test suite can be done as follows:
pip install pytest # We use pytest to drive all of our test cases
pip install pytest-xdist # Optional, but recommended to run test cases in parallel
pip install -e . # Compiles IroGB and exposes API via pip package
Then our tests can be run as you would run any other test suite driven by pytest. Keep in mind that most test cases will require an internet connection to pull the test roms down dynamically.
Heuristics
The only test cases with external dependencies lie in test_heuristic.py, since these tests require a roms directory and backing ground-truth database to evaluate our MBC detection heuristic. The database is a spreadsheet that can be downloaded from this link. We WILL NOT provide a source location or means for distribution for any ROMs.
To include the heuristic test cases, two additional arguments must be passed:
pytest testing/ \
--db <cartridges.csv> \ # A full path to the database spreadsheet
--roms <roms_dir> # A full path to the roms directory
Again, tests can be run without these dependencies, but the heuristic test cases will be skipped.