ndif-team/ndif

Set up basic pytest unit tests for API service

Open

#172 ouverte le 20 oct. 2025

Voir sur GitHub
 (0 commentaires) (0 réactions) (0 assignés)Python (17 forks)github user discovery
enhancementgood first issuehelp wanted

Métriques du dépôt

Stars
 (45 stars)
Métriques de merge PR
 (Métriques PR en attente)

Description

Description

Currently, NDIF has very few tests written for it, with the barrier to entry being the lack of an existing testing framework. Getting basic unit tests set up with pytest will both help make it easier to start writing more tests and would set the foundations for developing a more diverse testing suite (integration, end-to-end, ..)

Goal

Have a way of running unit tests (that can be run without spinning up the service). The following would meet the requirements of completing this ticket:

  • From src/services/api, have a pytest config, and be able to run unit tests from command line
  • Add (at least) 4 basic tests, one which is basically a "hello world" test, one which tests something from auth.py, one from app.py. and one from util.py
  • Instructions on how to run tests added to README, and informative doc strings.

See the Queue service for an example of what this could look like (ignore the actual tests, they serve more as "proof of concept").

Guide contributeur

Direction de recherche
Examinez la configuration de test existante du service Queue (src/services/queue) comme référence. Comprenez la structure de la configuration pytest et comment les tests sont organisés. Étudiez ensuite les modules auth.py, app.py et util.py dans src/services/api pour écrire un test significatif pour chaque module. Ajoutez des instructions au README.
Stack technique
python
Domaine
backendtesting
Type d'issue
Test
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 heures
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
PythonGit
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
80