[Feature]: Instructions to verify behavior and Tests
wincowgerDEV opened this issue · comments
Guidelines
- I agree to follow this project's Contributing Guidelines.
Description
There doesn't seem to be any automated tests. While the desired behavior here is relatively clear/trivial, there's no formal instructions to verify behavior.
Problem
NO
Proposed Solution
Need to add formal instructions to verify behavior and add clarity on the automated tests currently implemented.
Alternatives Considered
NA
@shollingsworth is it trivial to write some instructions to verify the automated tests? Another thing I could probably do instead is just make a test set and then make a video explaining how someone could use it to verify behavior.
Perhaps adding this is actually enough: #124
If we add that to the downloads and then I explain how to use the schema validator tool like https://www.jsonschemavalidator.net/ in the updated video then that should be proof enough that the pipeline is working as expected to create a data output useful for users.
Got some additional feedback from the reviewers on this: openjournals/joss-reviews#5136 (comment)
@shollingsworth I think they are ok with us doing manual tests, but they would prefer we implement some automated user-side tests on the website/container using selenium or something similar if it isn't too crazy to implement.
@wincowgerDEV I read the suggestion in the JOSS thread. I can implement all of those tests using something like Cypress, it shouldn't be much of a hassle.
@wincowgerDEV No, me and @shollingsworth still need to add the auto tests to the deployment workflow. We can declare it done after that.
Closing this because we added manual tests now.