Implementa ambiente completo de testes

[filipedeschamps]

Turma, não engatei isso no CI então não há a garantia que irá funcionar por completo mas ao mesmo tempo eu estou extremamente feliz com o ambiente de testes local.

Em resumo, depois de instalar as novas dependências, você pode:

$ npm test              # rodar uma única vez
$ npm run test:watch    # rodar a cada alteração de arquivo

E isso vai automaticamente levantar e matar todos os serviços caso você escolha fazer um test E2E. E caso essa seja a escolha, basta dentro do seu teste você fazer o seguinte:

import allServicesFactory from "tests/services.js";
const allServices = allServicesFactory();

beforeAll(async () => {
  return await allServices.start();
});

// Seus testes, que podem usar qualquer serviço disponível

afterAll(async () => {
  return await allServices.stop();
});

E como é teste, cada vez que você rodar ele, o script de serviço irá subir um novo banco de dados do zero (sem state) para começar de um estado conhecido. E caso seu teste quebre no meio e deixe alguma porta presa, não tem problema, quando você rodar de novo ele vai matar o processo que ficou preso e subir tudo de novo, começando do zero. Isso inclusive se você estiver com a estrela do Mario implementando no modo npm run test:watch.

E tem muita coisa para fazer conforme as necessidades forem chegando, como por exemplo ao resetar o banco deixar ele num estado específico que você quer, e tudo isso a gente vai implementando conforme as implementações dos recursos do site.

Resumo

1. Crie um arquivo de teste com o sufixo .test.js ao lado do arquivo que você quer testar.
2. Não importa se é um teste Unitário ou E2E.
3. Nesse PR estou testando a rota /api/v1/migrations então na pasta /pages/api/v1/migrations você encontra o arquivo index.public.js e ao lado criei o arquivo index.test.js.
4. Pronto, basta escrever seu teste.
5. Caso ele seja E2E, não se esqueça de levantar os serviços usando o helper de allServices mostrado acima.

Próximo passo

Engatar no CI aqui do Github. To empolgado, espero que funcione sem muitas complicações 👍

[edit]

O jest foi configurado para aceitar módulos do ES6 e também os absolute imports do Next.js 👍

[edit2]

Os containers criados para o ambiente de teste e desenvolvimento não são os mesmos, então você não vai perder o state do seu banco de desenvolvimento ao rodar o teste 👍

[vercel]

This pull request is being automatically deployed with Vercel (learn more).
To see the status of your deployment, click below or on the icon next to each commit.

🔍 Inspect: https://vercel.com/tabnews/tabnews/GbGLxztuebBhCQAZ8PEk5buRhZxK
✅ Preview: https://tabnews-git-tests-tabnews.vercel.app