FastAPI Unit Testing

[Sovamorco]

Backend Testing

Problem

The backend repository lacks comprehensive unit tests. Without proper test coverage, it’s challenging to ensure code correctness, detect regressions, and maintain reliability. Introducing a robust unit testing framework will enhance code quality, boost confidence, and facilitate future development. By prioritizing unit testing, your backend codebase will be more robust, maintainable, and reliable.

Proposed Solution

Introduce basic unit testing to the repository using a testing framework (PyTest, Coverage, etc.) and a GitHub action that will run the test against all PR’s made against the main branch. Establish a baseline test coverage (start low and increase as the code becomes more resilient). This will force the habit of testing code, maintain established functionality, and ensure that code quality is checked before making it’s way to functionality.

Acceptance Criteria

• Directory Containing Tests for the API
• GitHub Action that runs Tests on PR’s Made to the Main branch
• Code Coverage Enforcement

Resources

• Testing - FastAPI (tiangolo.com)
• https://youtu.be/jM-zWp8dNQA?si=5MCoNERqpYt6m5EL
• Building and testing Python - GitHub Docs
• Coverage monitor · Actions · GitHub Marketplace

---

Imported from trello Members: datpieceofcake

[Sovamorco]

Imported from trello Original author: datpieceofcake

---

I’ve mostly put this on hold until the buy order branch is merged.