vinisooo / kimoveisapi

KiMoveis is an API that allows the management of property information and scheduling of visits. With this API, it's possible to log in, register and edit information about real estate properties, and schedule visits to them.

🏁 Projeto Final: KImóveis - TypeORM com Relacionamentos

Para inciar este projeto, é necessário instalar as dependências, que serão utilizadas nos testes. Portanto utilize o comando abaixo para instalar tais dependências:

# caso use npm
npm run i

# caso use yarn
yarn

Instalação

Apenas as bibliotecas de teste, ou que os testes dependem, estão no package.json. Por isso, instale as dependências do projeto manualmente e não se esqueça de inicia-lo também.

# caso use npm
npm init -y

# caso use yarn
yarn init -y

Dependências dos testes

Para que os testes funcionem corretamente, existem algumas dependências.

• O app tem que ser exportado como default em src/app.ts. Exemplo:

export default app

• O AppDataSource tem que ser exportado em src/data-source.ts. Exemplo:

export { AppDataSource }

// ou

export const AppDataSource = new DataSource(dataSourceConfig());

• As Entities tem que ter os respectivos nomes e tem que ter a exportação centralizada em entities/index.ts. Exemplo:

import { Address } from './<arquivo>';
import { Category } from './<arquivo>';
import { RealEstate } from './<arquivo>';
import { Schedule } from './<arquivo>';
import { User } from './<arquivo>';

export { Address, RealEstate, Category, User, Schedule };

Sobre os testes

Essa aplicação possui testes, que serão utilizados para validar, se todas as regras de negócio foram aplicadas de maneira correta.

Os testes estão localizados em src/__tests__.

Na subpasta integration estão os testes.

Já na subpasta mocks estão os dados que serão utilizados para os testes.

No arquivo jest.config.ts estão algumas configurações necessárias para os testes rodarem.

De modo algum altere qualquer um desses arquivos. Isso poderá comprometer a integridade dos testes.

E também não altere o script de test localizado no package.json. Isso será utilizado para rodar os testes.

Rodando os testes

Para rodar os testes é necessário que no seu terminal, você esteja dentro do diretório do projeto.

Estando no terminal e dentro do caminho correto, você poderá utilizar os comandos a seguir:

Rodar todos os testes

# caso use npm
npm run test

# caso use yarn
yarn test

Rodar todos os testes e ter um log ainda mais completo

# caso use npm
npm run test --all

# caso use yarn
yarn test --all

Rodar os testes de uma pasta específica

detalhe: repare que tests está envolvido por 2 underlines. Isso se chama dunder.

# caso use npm
npm run test <subpasta>

# caso use yarn
yarn test <subpasta>

Rodar os testes de um arquivo específico

# caso use npm
npm run test <subpasta>/<arquivo>

# caso use yarn
yarn test <subpasta>/<arquivo>

Caso você queira verificar todas as opções de execução de testes, visite a Documentação oficial do Jest

Após rodar um dos comandos aparecerá um log no seu terminal, contendo as informações da execução do teste.

Observação: O teste pode demorar alguns segundos para ser finalizado. Quanto maior for o teste, mais tempo será consumido para a execução.

Agora que já sabe como iniciar o seu projeto e rodar os testes, é hora de colocar a mão no código