Skip to content

Commit 782922d

Browse files
fix readme
1 parent 7552984 commit 782922d

File tree

1 file changed

+27
-16
lines changed

1 file changed

+27
-16
lines changed

README.md

Lines changed: 27 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -12,21 +12,28 @@ Este projeto é uma arquitetura de testes automatizados para APIs REST, utilizan
1212

1313
## Estrutura de Pastas
1414
```
15-
constants/ # Configurações globais
16-
constants.ts
17-
db-connection/ # Conexão com bancos
15+
constants/ # Configurações globais
16+
└── constants.ts
17+
18+
db-connection/ # Conexão com bancos de dados
19+
1820
integration/
19-
data/ # Dados para testes (JSON, CSV)
20-
entity/ # Entidades prontas de exemplo
21-
routes/ # Rotas das APIs
22-
tests/ # Testes automatizados
23-
exemplos-test-usando-db/ # Exemplos de testes com conexão a banco de dados
24-
exemplos-usando-data-driven/ # Exemplos de testes usando data-driven
25-
utils/ # Utilitários (ex: leitura de CSV/JSON)
26-
custom-sequencer.js # Sequenciador customizado do Jest
27-
jest.config.ts # Configuração personalizada do Jest
28-
.gitlab-ci.yml # Pipeline para GitLab CI
29-
.env # Arquivo de secrets
21+
├── data/ # Dados para testes
22+
│ ├── json/ # Arquivos JSON para data-driven
23+
│ └── csv/ # Arquivos CSV para data-driven
24+
├── entity/ # Entidades prontas de exemplo
25+
├── routes/ # Rotas das APIs
26+
├── tests/ # Testes automatizados
27+
│ ├── exemplos-test-usando-db/ # Exemplos de testes com conexão a banco de dados
28+
│ └── exemplos-usando-data-driven/ # Exemplos de testes usando data-driven
29+
│ └── exemplo-usando-entities.test.ts # Exemplos de testes usando o padrão de entidades
30+
│ └── exemplo-uso-padrao.test.ts # Exemplos de testes sem padrão
31+
└── utils/ # Utilitários (ex: leitura de CSV/JSON)
32+
33+
custom-sequencer.js # Sequenciador customizado do Jest
34+
jest.config.ts # Configuração personalizada do Jest
35+
.gitlab-ci.yml # Pipeline para GitLab CI
36+
.env # Arquivo de secrets
3037
```
3138

3239
## Instalação
@@ -51,8 +58,8 @@ jest.config.ts # Configuração personalizada do Jest
5158
```
5259

5360
## Relatórios de Teste
54-
- **HTML:** Gerado em `html-report/report.html` (detalhado, com logs e status)
55-
- **JUnit XML:** Gerado em `junit.xml` (compatível com CI/CD)
61+
- **HTML:** Gerado através do [jest-html-reporters](https://www.npmjs.com/package/jest-html-reporters) em `html-report/report.html`
62+
- **JUnit XML:** Gerado através do [jest-junit](https://www.npmjs.com/package/jest-junit) em `junit.xml`
5663

5764
## Pipeline GitLab CI
5865
O arquivo `.gitlab-ci.yml` já está configurado para:
@@ -72,6 +79,10 @@ O arquivo `.gitlab-ci.yml` já está configurado para:
7279
- **@types/supertest**: ^6.0.2
7380
- **typescript**: ^5.3.3
7481
- **ts-node**: ^10.9.2
82+
- **mssql**: ^11.0.1
83+
- **mysql2**: ^3.14.1
84+
- **pg**: ^8.16.0
85+
- **csvtojson**: ^2.0.10
7586

7687
## Observações
7788
- Os dados de teste devem estar em `integration/data/json/` ou `integration/data/csv/`.

0 commit comments

Comments
 (0)