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

Update unit testing guidelines #43

Open
fredjaya opened this issue Oct 19, 2023 · 1 comment
Open

Update unit testing guidelines #43

fredjaya opened this issue Oct 19, 2023 · 1 comment
Assignees
Labels
docs: dev_cycle Related to documentation for the development cycle (linting, testing, git etc.) question Further information is requested

Comments

@fredjaya
Copy link
Collaborator

fredjaya commented Oct 19, 2023

Writing tests still under unittest for PyCogent, instead of pytest.

Will need either discussion with others to outline the testing guidelines, or refer to pytest best practices.

@fredjaya fredjaya added the question Further information is requested label Oct 19, 2023
@fredjaya fredjaya added docs: install Related to documentation for installing the development environment docs: dev_cycle Related to documentation for the development cycle (linting, testing, git etc.) and removed docs: install Related to documentation for installing the development environment labels Oct 20, 2023
@GavinHuttley
Copy link
Collaborator

A few things to note. First, cogent3 is migrating to using only pytest based tests. That said, the migration is incomplete. So we have a mixture of unittest and pytest. All new tests should be pytest only. Migration of unittest tests is not a high priority, and thus conversion is now done opportunistically. For example, if I'm updating test code for a new API change, I'll refactor any affected unittest test methods to pytest.

In terms of the docs, new devs need to abide by the above. For instructions on how to develop using pytest, point them to specific examples within our own test suite. They can ask questions on Discussions, or the relevant Issue.

@GavinHuttley GavinHuttley assigned fredjaya and unassigned GavinHuttley Nov 5, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs: dev_cycle Related to documentation for the development cycle (linting, testing, git etc.) question Further information is requested
Projects
None yet
Development

No branches or pull requests

2 participants