simularium / simulariumio

Python package that converts simulation outputs to the format consumed by the Simularium viewer website
Apache License 2.0
5 stars 3 forks source link

Rewrite converter tests #98

Closed meganrm closed 1 year ago

meganrm commented 2 years ago

What needs to happen?

Write clearer unit tests that test the particular functionality of the converter, with smaller chunks of expected data. Make sure both the default settings, and all the optional input data are covered in the tests.

The cellPACK converter tests are a good example of how we want to break up tests https://github.com/simularium/simulariumio/blob/main/simulariumio/tests/converters/test_cellpack_converter.py

Why should we do this?

Currently, the tests cover so much of the data, that if one thing changed, all the tests would fail, instead of just the tests that would tell you what particular thing had changed, so has a developer, it would be challenging to figure out if you had introduced a bug or if you just need to update the expected data in the test. It would also make the test files a lot easier to read.

When does this need to get done?