[Feature]: Instructions to verify behavior and Tests

[wincowgerDEV]

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

[wincowgerDEV]

@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.

[wincowgerDEV]

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.

[wincowgerDEV]

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.

[Zesky665]

@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]

That would be amazing! Thanks so much.

…

On Wed, Jun 7, 2023, 5:02 PM Zesky665 ***@***.***> wrote: @wincowgerDEV <https://github.com/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. — Reply to this email directly, view it on GitHub <#108 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AGMUJU3XL3F5KDX3ZRRTJIDXKCJZZANCNFSM6AAAAAAU2MVPW4> . You are receiving this because you were mentioned.Message ID: ***@***.***>

[wincowgerDEV]

@Zesky665 should this be closed now thanks to your work in 8c56b8f?

[Zesky665]

@wincowgerDEV No, me and @shollingsworth still need to add the auto tests to the deployment workflow. We can declare it done after that.

[wincowgerDEV]

Ok, sounds good.

…

On Tue, Jun 27, 2023 at 4:05 PM Zesky665 ***@***.***> wrote: @wincowgerDEV <https://github.com/wincowgerDEV> No, me and @shollingsworth <https://github.com/shollingsworth> still need to add the auto tests to the deployment workflow. We can declare it done after that. — Reply to this email directly, view it on GitHub <#108 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AGMUJU55UE2JMH4N6CZHYBTXNNRMZANCNFSM6AAAAAAU2MVPW4> . You are receiving this because you were mentioned.Message ID: ***@***.***>

-- ´¯`·.¸¸.·´¯`·.´¯`·.¸¸.·´¯`ツ ------------------------------ --------------------- *Win Cowger, PhD * Pronouns: he/him Research Scientist Moore Institute for Plastic Pollution Research *Contact Info* 515-298-3869 | ***@***.*** | @Win_OpenData <https://twitter.com/Win_OpenData> *Websites* Personal Website: www.wincowger.com Currently Employed: https://mooreplasticresearch.org/ Alumni Of: https://www.thegraylab.org/ Project Websites: www.openspecy.org Research Gate: https://www.researchgate.net/profile/Win-Cowger Github: https://github.com/wincowgerDEV OSF: https://osf.io/kxeh5/ ------------------------------------------------------------------------------------

[wincowgerDEV]

Closing this because we added manual tests now.