mkdir api-integration-tests
cd api-integration-tests
npm init -y

📋 Copiar

npm install express dotenv
npm install --save-dev jest supertest

📋 Copiar

"scripts": {
  "start": "node src/server.js",
  "test": "jest --detectOpenHandles"
}

📋 Copiar

// jest.config.js
module.exports = {
  testEnvironment: 'node', // Define o ambiente de teste como Node.js
  // Padrão para encontrar arquivos de teste (neste caso, .test.js e .spec.js em qualquer pasta src)
  testMatch: ['/__tests__//.js', '/?(.)+(spec|test).js'],
  // Ignora o diretório node_modules
  testPathIgnorePatterns: ['/node_modules/'],
  // Roda testes em paralelo para maior velocidade
  maxWorkers: '50%',
  // Define o tempo limite para cada teste (em ms)
  testTimeout: 10000,
  // Define que arquivos devem ser coletados para cobertura de código
  collectCoverageFrom: [
    'src/*/.js',
    '!src/server.js', // Exclui o arquivo principal do servidor da cobertura
  ],
  // Limpa mocks antes de cada teste
  clearMocks: true,
};

📋 Copiar

// src/app.js
const express = require('express');
const app = express(); // Instancia a aplicação Express
const morgan = require('morgan'); // Middleware de logging para requisições HTTP
const { v4: uuidv4 } = require('uuid'); // Para gerar IDs únicos (instale com: npm install uuid)

// Para este exemplo, simularemos um banco de dados com um array em memória.
// Em um cenário enterprise, aqui você teria sua conexão com PostgreSQL, MySQL, MongoDB, etc.
let produtos = [
  { id: '1', nome: 'Monitor Gamer', preco: 1500 },
  { id: '2', nome: 'Teclado Mecânico', preco: 400 },
];
// Configuração de middlewares
app.use(express.json()); // Habilita o parsing de JSON no corpo das requisições
app.use(morgan('dev')); // 'dev' é um formato de log conciso para desenvolvimento
// Middleware de logging profissional (exemplo simplificado)
// Em um ambiente de produção, usaria bibliotecas como Winston ou Pino
app.use((req, res, next) => {
  console.log([${new Date().toISOString()}] ${req.method} ${req.originalUrl});
  next(); // Continua para a próxima função middleware/rota
});
// Rotas da API
// GET /produtos - Retorna todos os produtos
app.get('/produtos', (req, res) => {
  console.log('GET /produtos: Retornando todos os produtos.');
  res.status(200).json(produtos); // Retorna status 200 OK e a lista de produtos
});
// GET /produtos/:id - Retorna um produto específico pelo ID
app.get('/produtos/:id', (req, res) => {
  const { id } = req.params; // Extrai o ID dos parâmetros da URL
  const produto = produtos.find(p => p.id === id); // Busca o produto
  if (!produto) {
    console.warn(GET /produtos/${id}: Produto não encontrado.);
    // Retorna status 404 Not Found se o produto não existir
    return res.status(404).json({ mensagem: 'Produto não encontrado.' });
  }
  console.log(GET /produtos/${id}: Retornando produto.);
  res.status(200).json(produto); // Retorna status 200 OK e o produto
});
// POST /produtos - Adiciona um novo produto
app.post('/produtos', (req, res) => {
  const { nome, preco } = req.body; // Extrai nome e preco do corpo da requisição
  // Validação de entrada robusta
  if (!nome || typeof nome !== 'string' || !preco || typeof preco !== 'number' || preco <= 0) {
    console.error('POST /produtos: Dados de produto inválidos.', req.body);
    // Retorna status 400 Bad Request para dados inválidos
    return res.status(400).json({ mensagem: 'Dados de produto inválidos. Nome (string) e Preço (número positivo) são obrigatórios.' });
  }
  const novoProduto = { id: uuidv4(), nome, preco }; // Cria um novo produto com ID único
  produtos.push(novoProduto); // Adiciona ao array (nosso "banco de dados")
  console.log('POST /produtos: Produto criado com sucesso.', novoProduto);
  // Retorna status 201 Created e o novo produto
  res.status(201).json(novoProduto);
});
// PUT /produtos/:id - Atualiza um produto existente
app.put('/produtos/:id', (req, res) => {
    const { id } = req.params;
    const { nome, preco } = req.body;
    let produtoIndex = produtos.findIndex(p => p.id === id);
    if (produtoIndex === -1) {
        console.warn(PUT /produtos/${id}: Produto para atualização não encontrado.);
        return res.status(404).json({ mensagem: 'Produto não encontrado para atualização.' });
    }
    // Validação robusta para atualizações
    if ((nome && typeof nome !== 'string') || (preco && (typeof preco !== 'number' || preco <= 0))) {
        console.error('PUT /produtos: Dados de atualização inválidos.', req.body);
        return res.status(400).json({ mensagem: 'Dados de atualização inválidos. Nome (string) e Preço (número positivo) são opcionais, mas devem ser válidos se presentes.' });
    }
    // Aplica as atualizações
    produtos[produtoIndex] = {
        ...produtos[produtoIndex],
        ...(nome && { nome }),
        ...(preco && { preco })
    };
    console.log(PUT /produtos/${id}: Produto atualizado com sucesso., produtos[produtoIndex]);
    res.status(200).json(produtos[produtoIndex]);
});
// Middleware de tratamento de erros global (melhores práticas enterprise)
app.use((err, req, res, next) => {
  console.error('Erro na requisição:', err.stack);
  res.status(500).send('Algo deu errado no servidor!');
});
// Exporta a aplicação Express para que possa ser usada nos testes
module.exports = app;

📋 Copiar

// src/server.js
const app = require('./app'); // Importa a aplicação Express que definimos
require('dotenv').config(); // Carrega variáveis de ambiente do .env

const PORT = process.env.PORT || 3000; // Define a porta, pegando de variáveis de ambiente ou default 3000
// Inicia o servidor apenas se este arquivo for executado diretamente
// Isso permite que os testes importem app sem iniciar o servidor HTTP real
if (require.main === module) {
  app.listen(PORT, () => {
    console.log(Servidor rodando na porta ${PORT});
    console.log(Ambiente: ${process.env.NODE_ENV || 'development'});
  });
}

📋 Copiar

PORT=3001
NODE_ENV=development

📋 Copiar

// __tests__/integration/produtos.test.js
const request = require('supertest'); // Importa o Supertest
const app = require('../../src/app'); // Importa a aplicação Express

// A variável produtos é global na nossa app de exemplo.
// Para testes de integração, é crucial isolar o estado.
// Para fins didáticos, vamos redefinir os produtos a cada teste.
// Em um cenário real, você teria uma função beforeEach que:
// 1. Limpa o banco de dados.
// 2. Popula com dados de teste conhecidos.
let mockProdutos = [];
// Função auxiliar para resetar os dados de teste
const resetProdutos = () => {
  mockProdutos = [
    { id: 'prod1', nome: 'Smartphone X', preco: 2500 },
    { id: 'prod2', nome: 'Smart TV 50"', preco: 3500 },
    { id: 'prod3', nome: 'Fones de Ouvido Bluetooth', preco: 300 },
  ];
  // Simulando a atualização dos produtos na app.js
  // Em uma aplicação real, você faria um mock ou limparia/populária o BD
  const appModule = require('../../src/app');
  appModule.produtos = mockProdutos.map(p => ({...p})); // Clonar para evitar mutação direta
};
// Hook beforeEach: Executa antes de CADA teste
beforeEach(() => {
  resetProdutos(); // Garante que cada teste comece com um estado limpo e conhecido
});
// Grupo de testes para o endpoint /produtos
describe('API de Produtos - Testes de Integração', () => {
  // Teste 1: Deve retornar todos os produtos (GET /produtos)
  test('GET /produtos deve retornar todos os produtos com status 200', async () => {
    console.log('Executando teste: GET /produtos');
    const response = await request(app) // Usa o Supertest com a aplicação Express
      .get('/produtos') // Faz uma requisição GET para /produtos
      .expect(200); // Espera um status HTTP 200 OK
    // Verifica se o corpo da resposta é um array
    expect(Array.isArray(response.body)).toBeTruthy();
    // Verifica se a quantidade de produtos é a esperada (mockProdutos tem 3)
    expect(response.body.length).toBe(3);
    // Verifica se um produto específico está presente
    expect(response.body).toEqual(expect.arrayContaining([
      expect.objectContaining({ id: 'prod1', nome: 'Smartphone X' })
    ]));
  });
  // Teste 2: Deve retornar um produto pelo ID (GET /produtos/:id)
  test('GET /produtos/:id deve retornar um produto específico com status 200', async () => {
    console.log('Executando teste: GET /produtos/:id (existente)');
    const produtoId = mockProdutos[0].id;
    const response = await request(app)
      .get(/produtos/${produtoId}) // Faz GET para um ID específico
      .expect(200);
    // Verifica o corpo da resposta
    expect(response.body).toHaveProperty('id', produtoId);
    expect(response.body).toHaveProperty('nome', 'Smartphone X');
    expect(response.body).toHaveProperty('preco', 2500);
  });
  // Teste 3: Deve retornar 404 para produto não encontrado (GET /produtos/:id)
  test('GET /produtos/:id deve retornar 404 se o produto não for encontrado', async () => {
    console.log('Executando teste: GET /produtos/:id (não existente)');
    const produtoIdInexistente = '99999';
    const response = await request(app)
      .get(/produtos/${produtoIdInexistente})
      .expect(404); // Espera status 404 Not Found
    expect(response.body).toHaveProperty('mensagem', 'Produto não encontrado.');
  });
  // Teste 4: Deve criar um novo produto (POST /produtos)
  test('POST /produtos deve criar um novo produto com status 201', async () => {
    console.log('Executando teste: POST /produtos (sucesso)');
    const novoProdutoData = {
      nome: 'Mouse Sem Fio',
      preco: 150
    };
    const response = await request(app)
      .post('/produtos')
      .send(novoProdutoData) // Envia os dados do novo produto no corpo da requisição
      .expect(201); // Espera status 201 Created
    expect(response.body).toHaveProperty('id'); // Verifica se um ID foi gerado
    expect(response.body).toHaveProperty('nome', novoProdutoData.nome);
    expect(response.body).toHaveProperty('preco', novoProdutoData.preco);
    // Opcional: Verificar se o produto foi realmente adicionado à lista (ao nosso "BD")
    // Note: Isso acessa o estado interno da app, o que pode ser considerado menos "black-box"
    const appModule = require('../../src/app');
    expect(appModule.produtos.length).toBe(mockProdutos.length + 1); // Mock tinha 3, agora deve ter 4
    expect(appModule.produtos).toEqual(expect.arrayContaining([
      expect.objectContaining({ nome: 'Mouse Sem Fio', preco: 150 })
    ]));
  });
  // Teste 5: Deve retornar 400 para dados inválidos na criação de produto (POST /produtos)
  test('POST /produtos deve retornar 400 para dados inválidos', async () => {
    console.log('Executando teste: POST /produtos (dados inválidos)');
    const dadosInvalidos = {
      nome: '', // Nome vazio
      preco: -10 // Preço negativo
    };
    const response = await request(app)
      .post('/produtos')
      .send(dadosInvalidos)
      .expect(400); // Espera status 400 Bad Request
    expect(response.body).toHaveProperty('mensagem', 'Dados de produto inválidos. Nome (string) e Preço (número positivo) são obrigatórios.');
    // Verifica se o número de produtos não mudou
    const appModule = require('../../src/app');
    expect(appModule.produtos.length).toBe(mockProdutos.length); // Deve continuar com 3 produtos
  });
  // Teste 6: Deve atualizar um produto existente (PUT /produtos/:id)
  test('PUT /produtos/:id deve atualizar um produto existente com status 200', async () => {
    console.log('Executando teste: PUT /produtos/:id (sucesso)');
    const produtoParaAtualizarId = mockProdutos[0].id; // ID do Smartphone X
    const dadosAtualizados = {
      nome: 'Smartphone X Pro Max',
      preco: 2800
    };
    const response = await request(app)
      .put(/produtos/${produtoParaAtualizarId})
      .send(dadosAtualizados)
      .expect(200);
    expect(response.body).toHaveProperty('id', produtoParaAtualizarId);
    expect(response.body).toHaveProperty('nome', 'Smartphone X Pro Max');
    expect(response.body).toHaveProperty('preco', 2800);
    // Opcional: verificar se o produto foi realmente atualizado na lista
    const appModule = require('../../src/app');
    const produtoAtualizadoNoDB = appModule.produtos.find(p => p.id === produtoParaAtualizarId);
    expect(produtoAtualizadoNoDB).toEqual(expect.objectContaining(dadosAtualizados));
  });
  // Teste 7: Deve retornar 404 ao tentar atualizar produto não existente (PUT /produtos/:id)
  test('PUT /produtos/:id deve retornar 404 para produto não encontrado', async () => {
    console.log('Executando teste: PUT /produtos/:id (não existente)');
    const produtoIdInexistente = '99999-update';
    const dadosAtualizados = { nome: 'Produto Fantasma' };
    const response = await request(app)
      .put(/produtos/${produtoIdInexistente})
      .send(dadosAtualizados)
      .expect(404);
    expect(response.body).toHaveProperty('mensagem', 'Produto não encontrado para atualização.');
  });
  // Teste 8: Deve retornar 400 para dados de atualização inválidos (PUT /produtos/:id)
  test('PUT /produtos/:id deve retornar 400 para dados de atualização inválidos', async () => {
    console.log('Executando teste: PUT /produtos/:id (dados inválidos)');
    const produtoParaAtualizarId = mockProdutos[0].id;
    const dadosInvalidos = { preco: -50 }; // Preço negativo
    const response = await request(app)
      .put(/produtos/${produtoParaAtualizarId})
      .send(dadosInvalidos)
      .expect(400);
    expect(response.body).toHaveProperty('mensagem', 'Dados de atualização inválidos. Nome (string) e Preço (número positivo) são opcionais, mas devem ser válidos se presentes.');
  });
});

📋 Copiar

npm test

📋 Copiar

// DELETE /produtos/:id - Remove um produto
app.delete('/produtos/:id', (req, res) => {
    const { id } = req.params;
    const produtoIndex = produtos.findIndex(p => p.id === id);

    if (produtoIndex === -1) {
        console.warn(DELETE /produtos/${id}: Produto não encontrado para exclusão.);
        return res.status(404).json({ mensagem: 'Produto não encontrado para exclusão.' });
    }
    produtos.splice(produtoIndex, 1); // Remove o produto do array
    console.log(DELETE /produtos/${id}: Produto removido com sucesso.);
    res.status(204).send(); // Retorna 204 No Content para indicar sucesso sem corpo na resposta
});

📋 Copiar

  // Teste 9: Deve remover um produto existente (DELETE /produtos/:id)
  test('DELETE /produtos/:id deve remover um produto existente com status 204', async () => {
    console.log('Executando teste: DELETE /produtos/:id (sucesso)');
    const produtoParaRemoverId = mockProdutos[0].id; // ID do Smartphone X
    const initialProductCount = mockProdutos.length;

    await request(app)
      .delete(/produtos/${produtoParaRemoverId})
      .expect(204); // Espera status 204 No Content
    // Verifica se o produto foi realmente removido da lista
    const appModule = require('../../src/app');
    expect(appModule.produtos.length).toBe(initialProductCount - 1); // Deve ter um produto a menos
    expect(appModule.produtos.find(p => p.id === produtoParaRemoverId)).toBeUndefined(); // Produto não deve existir
  });
  // Teste 10: Deve retornar 404 ao tentar remover produto não existente (DELETE /produtos/:id)
  test('DELETE /produtos/:id deve retornar 404 para produto não encontrado', async () => {
    console.log('Executando teste: DELETE /produtos/:id (não existente)');
    const produtoIdInexistente = '99999-delete';
    const initialProductCount = mockProdutos.length;
    const response = await request(app)
      .delete(/produtos/${produtoIdInexistente})
      .expect(404);
    expect(response.body).toHaveProperty('mensagem', 'Produto não encontrado para exclusão.');
    // Verifica se o número de produtos não mudou
    const appModule = require('../../src/app');
    expect(appModule.produtos.length).toBe(initialProductCount); // Deve continuar com o mesmo número de produtos
  });

📋 Copiar

npm test

📋 Copiar

🚀 Pronto para a próxima aula?

Continue sua jornada no desenvolvimento de APIs e domine Node.js & Express!

📚 Ver todas as aulas