Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[joss] Tests? #156

Closed
sneakers-the-rat opened this issue Jun 23, 2023 · 6 comments
Closed

[joss] Tests? #156

sneakers-the-rat opened this issue Jun 23, 2023 · 6 comments
Labels
ops Improvements to the project that don't impact the code
Milestone

Comments

@sneakers-the-rat
Copy link
Contributor

Hey! Sorry for the long delay. just started a new job and things have been hectic.

Orienting myself to the package, and I can't seem to find any tests? JOSS doesn't have a minimum test coverage requirement or anything like that, but it does ask that essential functionality is tested, and I have interpreted that in the past as meaning unit tests that cover most of the major operations described in the docs and the paper.

I'll tag all my issues from the review with [joss] and also link back to the review so we can track them from there

Part of:
openjournals/joss-reviews#5266

@juanmc2005
Copy link
Owner

Hi @sneakers-the-rat ! Thanks for your feedback! I've been wanting to add unit tests for some time (#94).
I will prioritize it so they are implemented for the main features of the library.

Otherwise, the core operations of the library can also be verified using the CLI interface: diart.stream for the microphone and individual files, and diart.benchmark to reproduce the performance that we claim (e.g. on the AMI dataset).

@juanmc2005 juanmc2005 added the ops Improvements to the project that don't impact the code label Jun 27, 2023
@juanmc2005 juanmc2005 added this to the Version 0.8 milestone Jun 27, 2023
@sneakers-the-rat
Copy link
Contributor Author

I'd be happy to make a pull request adding some tests as examples, if you haven't written them before :)

@juanmc2005
Copy link
Owner

That would be awesome, thank you!

@sneakers-the-rat
Copy link
Contributor Author

Here's an example test for the config:
sneakers-the-rat@b1a0cca

after installing with [tests], one can run pytest from the repo root to run the tests. Gave an example of using test fixtures for random value init to test that the inputs arent being ignored and defaults substituted

@juanmc2005 juanmc2005 modified the milestones: Version 0.8, Version 0.9 Oct 11, 2023
@sneakers-the-rat
Copy link
Contributor Author

I offered to help with how to write tests! So am happy to answer questions/give examples here :)

@juanmc2005 juanmc2005 modified the milestones: Version 0.9, Version 0.10 Nov 14, 2023
@juanmc2005
Copy link
Owner

Test PR #237 has been merged and will be included in the next release (v0.10)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ops Improvements to the project that don't impact the code
Projects
None yet
Development

No branches or pull requests

2 participants