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

Missing tests? #4

Closed
deniederhut opened this issue Oct 29, 2021 · 5 comments
Closed

Missing tests? #4

deniederhut opened this issue Oct 29, 2021 · 5 comments

Comments

@deniederhut
Copy link

I'm not seeing where the test cases are for this repo. Am I looking in the wrong place?

@WarmCyan
Copy link
Collaborator

We have no explicit unit tests, I was initially wondering if the example notebooks were enough to count for ok in the review criteria?

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)

We should really probably have actual testing anyway, so I understand if that doesn't count!

@deniederhut
Copy link
Author

Yeah that's a great question. I think we'll want to kick this up the chain.

@fabian-s
Copy link

fabian-s commented Nov 9, 2021

It's sub-par but acceptable, I'd say. The examples provide a manual way to check that the tool is working as expected. Obviously proper unit or regression test and adding CI to the repo would be preferable

@deniederhut would you say that these two notebooks cover TX21's central functionality?
If so, I'd recommend to cross that item off the checklist.
If not, please identify what's missing, and then we can unblock once @WildfireXIII has added examples for those parts.

@deniederhut
Copy link
Author

Thanks for chiming in! I've tried that first notebook and it's failing with an error. I've filed a separate ticket about it, so I think we can close this one.

@WarmCyan
Copy link
Collaborator

WarmCyan commented Dec 6, 2021

Updating this thread for awareness - we ended up adding some basic unit tests to aid in some of our updates, the test suite can be run via pytest from the root directory. (I've updated the README to include this as well.)

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

No branches or pull requests

3 participants