ndif-team/ndif

Set up basic pytest unit tests for API service

Open

#172 aberto em 20 de out. de 2025

Ver no GitHub
 (0 comments) (0 reactions) (0 assignees)Python (17 forks)github user discovery
enhancementgood first issuehelp wanted

Métricas do repositório

Stars
 (45 stars)
Métricas de merge de PR
 (Métricas PR pendentes)

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").

Guia do colaborador

Direção de pesquisa
Examine a configuração de testes existente do serviço Queue (src/services/queue) como referência. Entenda a estrutura da configuração do pytest e como os testes são organizados. Em seguida, estude os módulos auth.py, app.py e util.py em src/services/api para escrever um teste significativo para cada módulo. Adicione instruções ao README.
Pilha de tecnologia
python
Domain
backendtesting
Tipo Issue
Teste
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
2
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-3 horas
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
PythonGit
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
80