terraref / computing-pipeline

Pipeline to Extract Plant Phenotypes from Reference Data
BSD 3-Clause "New" or "Revised" License
23 stars 13 forks source link

Use pytest as a unit testing framework for pull requests #580

Open Chris-Schnaufer opened 5 years ago

Chris-Schnaufer commented 5 years ago

The use of a testing framework as part of a pull request provides some assurance that any changes in the Pull Request doesn't negatively impact existing code and functionality. This ticket suggests pytest as a mechanism for providing the testing framework.

Tags: pull request, python, pytest, testing, framework, quality

Description

Running a set of unit tests on a Pull Request as a part of acceptance criteria allows the inclusion of new unit tests as part of a pull request, as well as providing a level of assurance that changes haven't negatively impacted existing code.

### Completion Criteria - [ ] A testing framework is decided upon - [ ] Unit tests are run as part of a Pull Request - [ ] The use of unit tests are documented - [ ] How to write a unit test is documented (only the environment specifics, not the why or what coverage is & etc - references to non-environment specific documentation is encouraged)