Qualidade

Como testar uma integração de API CPF sem expor dados

Monte testes unitários e mocks para HTTP 200, 401, 402 e 429, sem usar CPF real nem chave de produção.

Imagem editorial sobre Testes e simulação de falhas
Testes e simulação de falhas.

Por que não testar sempre contra a API real

Testes automatizados de integração com API CPF precisam reproduzir sucesso e falhas com previsibilidade. Consultas reais dependem de rede, limite e créditos; além disso, dados cadastrais são pessoais. Use mocks para testar seu backend sem credenciais reais e sem CPF de terceiros. Reserve testes contra o serviço para um ambiente e fluxo expressamente autorizados.

Cenários essenciais de teste

Monte casos para HTTP 200 com JSON de demonstração, 400 por entrada inválida, 401 por credencial, 402 por crédito, 404 por rota e 429 por rate limit. Adicione timeout, conexão recusada, resposta não JSON e objeto data incompleto. Verifique também se logs, exceções e respostas públicas não contêm chave ou CPF completo.

Exemplo simplificado com unittest.mock

from unittest.mock import Mock, patch
import requests

# Suponha que seu módulo cliente.py define consultar_cpf().
from cliente import consultar_cpf

fake = Mock()
fake.status_code = 200
fake.raise_for_status.return_value = None
fake.json.return_value = {"code": 200, "data": {"nome": "Pessoa Exemplo"}}

with patch("cliente.requests.get", return_value=fake) as chamada:
    resultado = consultar_cpf("52998224725")
    assert resultado["nome"] == "Pessoa Exemplo"
    assert chamada.called

O trecho pressupõe que você adaptou a função do tutorial Python em cliente.py e que ela devolve data. A função de teste não faz nenhuma requisição real.

Como testar os erros sem abrir conexão

Crie objetos de resposta simulados cujo raise_for_status() lance requests.HTTPError com response.status_code correspondente. Para timeout, faça requests.get lançar requests.exceptions.Timeout. Sua aplicação deve classificar os cenários: corrigir configurações para 401, revisar créditos para 402 e controlar tentativas em 429.

Verificações de segurança nos testes

Não registre a API Key de produção em fixtures. Configure uma credencial fictícia claramente marcada como teste e certifique-se de que requests foram interceptados. Verifique que sua serialização pública não devolve nome da mãe ou data de nascimento se o endpoint interno só necessita nome. Também teste autenticação, autorização e limites do próprio backend.

Perguntas frequentes

Testes com mocks provam que a API externa está online?

Não. Eles provam sua lógica interna para respostas esperadas. Testes de integração controlados são um tipo diferente de verificação.

Preciso usar CPF real?

Não. Utilize apenas valores demonstrativos apropriados e respostas simuladas, sem acessar dados cadastrais reais nos testes.

Continue aprendendo