Skip to content
This repository has been archived by the owner on Jun 30, 2023. It is now read-only.

Automated Testing / Unit Testing Framework for JOSS #78

Closed
medewitt opened this issue May 24, 2021 · 2 comments
Closed

Automated Testing / Unit Testing Framework for JOSS #78

medewitt opened this issue May 24, 2021 · 2 comments

Comments

@medewitt
Copy link
Contributor

medewitt commented May 24, 2021

Is your feature request related to a problem? Please describe.
CRAN build checks appear to be the only automated testing implemented in the package. Additionally, many of the examples in the documentation are wrapped in "don't run" which means they are not checked on CRAN (which makes sense for CRAN checks, but not for ensuring unit tests).

Describe the solution you'd like

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

Ideally, continuous integration could be deployed to verify continuity of functionality with new pulls. This could be implemented through GitHub Actions. Additionally, automated tests could be written to verify that functions are working properly. This is challenging with API related packages, but it could be done through minimally testing non-API key required features or with the use of secrets, some basic api features could be tested. And example is available in a forthcoming PR. Totally open to pushback on this point.

Describe alternatives you've considered
Testthat or tinytest both offer good options for unit testing.

Additional context
See openjournals/joss-reviews#3272

@medewitt
Copy link
Contributor Author

See #79 (comment) for an example of continuous integration and unit testing.

@justinchuntingho
Copy link
Collaborator

Thanks for pointing out. Merged #79 for the unit testing.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants