calebweinreb / SNUB

MIT License
24 stars 4 forks source link

[Major] No testing #8

Closed vigji closed 8 months ago

vigji commented 10 months ago

The repo currently has no test modules, which is a major flow and would be highly recommended for deploying reliable and maintainable code.

Would you consider add testing modules to the codebase, and integrate a testing workflow using GitHub Actions?

niksirbi commented 9 months ago

Agreed, this is a major issue. I recommend at least starting with some smoke tests for the most important functionalities/workflows.

calebweinreb commented 9 months ago

Thanks for the suggestions! To address this, we have now added tests (https://github.com/calebweinreb/SNUB/pull/17). The test modules include:

niksirbi commented 9 months ago

I ran the tests locally and measured a test coverage of 54% (using pytest-cov). That's a great start! I opened a separate issue #19 where I suggest separating the "dev" dependencies (e.g. pytest), from the ones users require.

Ideally, you would want to run these tests across OS platforms and Python versions (e.g. using GitHub's CI features), but I'm fine with you adding those later.

vigji commented 8 months ago

I think this is a great start for testing, enough to at least check out basic functioning is someone wants to contribute to the project. Agreed that multiple platforms can come later, I'll close this for now!