search

alicia-ziying-yang / conTEXT-explorer

ConTEXT Explorer is an open Web-based system for exploring and visualizing concepts (combinations of occurring words and phrases) over time in the text documents.
Apache License 2.0
9 stars 3 forks source link

[JOSS] Add automated unit tests #2

Closed faroit closed 3 years ago

faroit commented 3 years ago

As part of the JOSS review, I was checking if the software has automated tests included which currently is not the case.

The JOSS guidelines state:

Authors are strongly encouraged to include an automated test suite covering the core functionality of their software.

Good: An automated test suite hooked up to an external service such as Travis-CI or similar

OK: Documented manual steps that can be followed to objectively check the expected functionality of the software (e.g., a sample input file to assert behavior) Bad (not acceptable): No way for you, the reviewer, to objectively assess whether the software works

https://github.com/openjournals/joss-reviews/issues/3347

alicia-ziying-yang commented 3 years ago

Hi @faroit, Have done with Travis-CI, and have attached the build-pass badge to the README. Please check.

Thank you!

faroit commented 3 years ago

@alicia-ziying-yang thanks for adding this. For now, this only tests of the installation routine will pass and the software can be started. I suggest you also add some tests that test the functionality of the software and the data processing:

I guess https://dash.plotly.com/testing this would be a good start to read about testing with dash

alicia-ziying-yang commented 3 years ago

Hi @faroit,

Thanks for pointing out. Now I have added some test cases in https://github.com/alicia-ziying-yang/conTEXT-explorer/blob/main/test_cases.py and change the Travis-CI .yml file.

Please check the newest build: https://travis-ci.com/github/alicia-ziying-yang/conTEXT-explorer

Thank you.

faroit commented 3 years ago

@alicia-ziying-yang wow, this looks great. Happy to close this now!