Skip to content

[Pav-114] - criar-documentacao-de-desenvolvimento-local-e-padrao-de-testes - #211

Closed
Benevanio wants to merge 3 commits into
masterfrom
PAV-114
Closed

[Pav-114] - criar-documentacao-de-desenvolvimento-local-e-padrao-de-testes#211
Benevanio wants to merge 3 commits into
masterfrom
PAV-114

Conversation

@Benevanio

Copy link
Copy Markdown
Collaborator

Documentação de desenvolvimento local e padrão de testes automatizados

Objetivo

Criar uma documentação para facilitar o onboarding de novos contribuidores no projeto, centralizando informações sobre execução local da aplicação e o padrão utilizado para criação de testes automatizados.

O que foi alterado

Foi criada uma documentação contendo:

Desenvolvimento local

  • Pré-requisitos necessários para executar o projeto.
  • Configuração inicial do ambiente.
  • Instalação das dependências.
  • Configuração das variáveis de ambiente.
  • Comandos utilizados para executar os serviços localmente.
  • Orientações para execução e validação da aplicação.

Padrão de testes automatizados

Foi documentado o padrão utilizado no projeto para organização de testes utilizando:

  • TP (Test Plan)
  • TC (Test Case)

A documentação explica:

  • Diferença entre TP e TC.
  • Como estruturar cenários de teste.
  • Como criar novos casos de teste.
  • Boas práticas para testes unitários.
  • Quando utilizar it.each.
  • A importância de validar comportamento e regras do sistema, evitando testes acoplados a detalhes de implementação.

Exemplo utilizado

Foi utilizado como referência o fluxo de testes do Go Scraper:

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Este PR adiciona documentação para facilitar o onboarding (desenvolvimento local) e explicita o padrão TP/TC de testes automatizados, além de ajustar testes e a validação/entrada de telefone no formulário de cadastro para refletir o novo comportamento (telefone opcional e validação BR).

Changes:

  • Adiciona guias novos de desenvolvimento local e de padrão de testes automatizados (TP/TC).
  • Atualiza o formulário de cadastro para tornar telefone opcional e aplicar máscara/validação de telefone brasileiro.
  • Atualiza e refatora testes (frontend e backend) para cobrir os novos comportamentos e remover flakiness por mês fixo.

Reviewed changes

Copilot reviewed 16 out of 16 changed files in this pull request and generated 2 comments.

Show a summary per file
File Description
README.md Adiciona ponteiro para a nova documentação de desenvolvimento local e atualiza badge de CI.
LOCAL_DEVELOPMENT.md Novo guia de setup/execução local, Docker e comandos úteis.
GUIA_TESTES_AUTOMATIZADOS.md Novo guia explicando o padrão TP/TC e boas práticas de testes.
frontend/src/domains/auth/presentation/components/RegisterFormPanel.tsx Troca input de telefone para implementação custom (máscara/validação BR) e torna telefone opcional.
frontend/tests/unit/components/login/RegisterSide.test.tsx Ajusta/expande testes do cadastro para telefone opcional, máscara e validações.
frontend/tests/unit/new_dashboard/home.profile.test.tsx Remove dependência de mês hardcoded (evita flake).
frontend/tests/unit/new_dashboard/branch-coverage.test.tsx Remove dependência de mês hardcoded (evita flake).
backend/tests/unit/adapters/TP-01.goScraper.test.ts Introduz estrutura TP chamando TCs do adapter Go Scraper.
backend/tests/unit/adapters/goScrapper/goScraper.TC01.ts Novo TC01 (resposta válida).
backend/tests/unit/adapters/goScrapper/goScraper.TC02.ts Novo TC02 (erro HTTP).
backend/tests/unit/adapters/goScrapper/goScraper.TC03.ts Novo TC03 (contrato inválido + logWarn).
backend/tests/unit/adapters/goScrapper/goScraper.TC04.ts Novo TC04 (parâmetros inválidos sem chamar fetch).
backend/tests/unit/adapters/goScrapper/goScraper.TC05.ts Novo TC05 (payload preserva keywords/localização).
backend/tests/unit/adapters/goScrapper/goScraper.TC06.ts Novo TC06 (respeita GO_SCRAPER_URL).
backend/tests/unit/adapters/goScrapper/goScraper.TC.types.ts Tipos compartilhados para os TCs do Go Scraper.
backend/tests/unit/adapters/goScraper.test.ts Remove teste antigo em favor do padrão TP/TC.
Suppressed comments (1)

GUIA_TESTES_AUTOMATIZADOS.md:11

  • A frase usa termos sem acentuação ("cenarios", "voce"). Vale ajustar a ortografia para manter consistência e legibilidade.
Em vez de testar tudo manualmente toda vez, o teste automatizado executa cenarios e confirma o resultado por voce.

Comment on lines +5 to +9
Se voce esta contribuindo pela primeira vez no projeto, começe por aqui.

## O que e um teste automatizado?

Um teste automatizado e um pequeno programa que verifica se uma funcionalidade continua funcionando como esperado.
Comment on lines +2 to +7
import { TC01 } from "./goScrapper/goScraper.TC01.ts";
import { TC02 } from "./goScrapper/goScraper.TC02.ts";
import { TC03 } from "./goScrapper/goScraper.TC03.ts";
import { TC04 } from "./goScrapper/goScraper.TC04.ts";
import { TC05 } from "./goScrapper/goScraper.TC05.ts";
import { TC06 } from "./goScrapper/goScraper.TC06.ts";
@Benevanio
Benevanio deleted the PAV-114 branch August 2, 2026 15:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants