/js-unit-tests

Project of Trybe school called Javascript Unit Tests, made by EliasEF

Primary LanguageJavaScript

Boas-vindas ao repositório do projeto ES6 e Testes Unitários!

Para realizar o projeto, atente-se a cada passo descrito a seguir, e se tiver qualquer dúvida, nos envie por Slack! #vqv 🚀

Aqui você vai encontrar os detalhes de como estruturar o desenvolvimento do seu projeto a partir desse repositório, utilizando uma branch específica e um Pull Request para colocar seus códigos.

Termos e acordos

Ao iniciar este projeto, você concorda com as diretrizes do Código de Conduta e do Manual da Pessoa Estudante da Trybe.

Entregáveis

🤷🏽‍♀️ Como entregar

Para entregar o seu projeto você deverá criar um Pull Request neste repositório.

Lembre-se que você pode consultar nosso conteúdo sobre Git & GitHub e nosso Blog - Git & GitHub sempre que precisar!

👨‍💻 O que deverá ser desenvolvido

Você implementará várias funções na resolução dos requisitos propostos e/ou testes unitários para garantir que as implementações das funções estão corretas, de acordo com o que está sendo solicitado em cada enunciado.

Nesse projeto, você será capaz de:

  • Escrever testes unitários utilizando o módulo Jest do NodeJS para verificar o correto funcionamento das funções;
  • Escrever funções de forma que elas atendam a testes já implementados;
  • Escrever testes e funções utilizando uma abordagem de desenvolvimento orientado a testes.

Desenvolvimento

  • Nos testes unitários que não estão implementados, você verá o comando fail('Teste vazio!'), que existe propositalmente para fazer o teste falhar.

Esse trecho de código deve ser removido a partir do momento que você começar a escrever o teste unitário

Sem o fail('Teste vazio!') nos blocos que ainda não contém código de teste, o resultado seria um falso positivo ou seja, a função testada passaria com sucesso mesmo sem de fato ter o teste implementado.

🗓 Data de Entrega
- Este projeto é individual;

  • Serão 2 dias de projeto;

  • Data de entrega para avaliação final do projeto: 19/05/2022 14:00

Orientações

📝 Instruções para entregar seu projeto: ES6 e Testes Unitários

Este repositório contém um template de uma aplicação NodeJS (observe a existência do arquivo package.json). Após clonar o projeto e instalar as dependências através do npm install, você não precisará realizar nenhuma configuração adicional. Todos os arquivos estritamente necessários para finalizar o projeto já estão criados, não sendo necessária a criação de outros arquivos. Você deverá completar as funções e testes unitários de forma a satisfazer os requisitos listados na seção Requisitos do projeto.

As funções a serem implementadas estão dentro da pasta src e seus respectivos testes estão na pasta tests. O nome dos arquivos também seguem uma ordem definida. Basicamente, os arquivos de teste possuem o nome do arquivo alvo (arquivo da funcionalidade) acrescido do nome .spec.js.

Há um arquivo como src/exemplo.js que contém a implementação de uma função e um arquivo como tests/exemplo.spec.js com os testes unitários referentes à função presente no arquivo src/exemplo.js.

Cada função possui um bloco de comentários em suas primeiras linhas explicando qual é o trabalho que a função deve realizar.

Você só deve alterar os arquivos indicados nos requisitos, caso contrário sua avaliação poderá ser comprometida.

Para entregar o seu projeto você deve criar um Pull Request neste repositório. Este Pull Request deve conter a implementação dos arquivos solicitados na seção Requisitos do projeto.

⚠️ É importante que seus arquivos permaneçam com os nomes fornecidos pelo projeto! Você pode adicionar outros arquivos somente se julgar necessário mas lembrando que novos arquivos não serão avaliados no projeto. Qualquer dúvida, procure a Pessoa Instrutora que acompanha a sua Tribo.

‼️ Antes de começar a desenvolver
  1. Clone o repositório
  • git clone git@github.com:tryber/sd-022-b-project-js-unit-tests.git.
  • Entre na pasta do repositório que você acabou de clonar:
    • cd sd-022-b-project-js-unit-tests
  1. Instale as dependências
  • npm install
  1. Crie uma branch a partir da branch master
  • Verifique que você está na branch master
    • Exemplo: git branch
  • Se não estiver, mude para a branch master
    • Exemplo: git checkout master
  • Agora crie uma branch para qual você vai submeter os commits do seu projeto
    • Você deve criar uma branch no seguinte formato: nome-de-usuario-nome-do-projeto
    • Exemplo: git checkout -b joaozinho-js-unit-tests
  1. Faça as alterações em qualquer uma das funções que pedem implementação. Por exemplo, a average.js em src/:
```javascript
const average = () => {
  // adicione seu código aqui
}

module.exports = average
```
  1. Adicione as mudanças ao stage do Git e faça um commit
  • Verifique que as mudanças ainda não estão no stage
    • Exemplo: git status (deve aparecer listado o arquivo src/nomeDoArquivo.js em vermelho)
  • Adicione o arquivo alterado ao stage do Git
    • Exemplo:
      • git add . (adicionando todas as mudanças - que estavam em vermelho - ao stage do Git)
      • git status (deve aparecer listado o arquivo src/nomeDoArquivo.js em verde)
  • Faça o commit inicial
    • Exemplo:
      • git commit -m 'Inicia o projeto. VAMOS COM TUDO :rocket:' (fazendo o primeiro commit)
      • git status (deve aparecer uma mensagem tipo: nothing to commit )
  1. Adicione a sua branch com o novo commit ao repositório remoto
  • Usando o exemplo anterior: git push -u origin joaozinho-js-unit-tests
  1. Crie um novo Pull Request (PR)
  • Vá até a página de Pull Requests do repositório no GitHub
  • Clique no botão verde "New pull request"
  • Clique na caixa de seleção "Compare" e escolha a sua branch com atenção
  • Clique no botão verde "Create pull request"
  • Adicione uma descrição para o Pull Request e clique no botão verde "Create pull request"
  • Não se preocupe em preencher mais nada por enquanto!
  • Volte até a página de Pull Requests do repositório e confira que o seu Pull Request está criado.
⌨️ Durante o desenvolvimento
* ⚠️ **PULL REQUESTS COM ISSUES NO LINTER NÃO SERÃO AVALIADAS. ATENTE-SE PARA RESOLVÊ-LAS ANTES DE FINALIZAR O DESENVOLVIMENTO!** ⚠️

  • Faça commits das alterações que você fizer no código regularmente

  • Lembre-se de sempre, após um (ou alguns) commits atualizar o repositório remoto

  • Os comandos que você utilizará com mais frequência são:

  1. git status (para verificar o que está em vermelho - fora do stage - e o que está em verde - em stage)
  2. git add (para adicionar arquivos ao stage do Git)
  3. git commit -m "Ação do commit (para criar um commit com os arquivos que estão no stage do Git)
  4. git push -u origin nome-da-branch (para enviar o commit para o repositório remoto na primeira vez que fizer o push de uma nova branch)
  5. git push (para enviar o commit para o repositório remoto após o passo anterior)
🤝 Depois de terminar o desenvolvimento (opcional)

Para sinalizar que o seu projeto está pronto para o "Code Review" dos seus colegas, faça o seguinte:

  • Vá até a página DO SEU Pull Request, adicione a label de "code-review" e marque seus colegas:

    • No menu à direita, clique no link "Labels" e escolha a label code-review;

    • No menu à direita, clique no link "Assignees" e escolha o seu usuário;

    • No menu à direita, clique no link "Reviewers" e digite students, selecione o time tryber/students-sd-022-b.

Caso tenha alguma dúvida, aqui tem um video explicativo.

⚠️ Lembre-se de garantir que todas as issues comentadas pelo Linter estão resolvidas! ⚠️

🕵🏿 Revisando um Pull Request

Use o conteúdo sobre Code Review para te ajudar a revisar os Pull Requests.

🎛 Linter

Usaremos o ESLint para fazer a análise estática do seu código.

Este projeto já vem com as dependências relacionadas ao linter configuradas nos arquivos package.json.

Para poder rodar o ESLint em um projeto basta executar o comando npm install dentro do projeto e depois npm run lint. Se a análise do ESLint encontrar problemas no seu código, tais problemas serão mostrados no seu terminal. Se não houver problema no seu código, nada será impresso no seu terminal.

Você pode também instalar o plugin do ESLint no VSCode. Para isso, basta fazer o download do plugin ESLint e instalá-lo.

🛠 Testes

Todos os requisitos do projeto serão testados automaticamente por meio do Jest.

  • Os comandos que você utilizará com mais frequência são:

    • npm test (executa todos os testes presentes na aplicação)
    • npm test caminho/para/arquivo (executa apenas os testes presentes no arquivo especificado)
    • Exemplo: npm test tests/average.spec.js
🗣 Nos dê feedbacks sobre o projeto!

Ao finalizar e submeter o projeto, não se esqueça de avaliar sua experiência preenchendo o formulário. Leva menos de 3 minutos!

VERIFIQUE COM CUIDADO SE O LINK SE REFERE AO PROJETO CORRETO!!!

Link: FORMULÁRIO DE AVALIAÇÃO DE PROJETO

⚠️ O avaliador automático não necessariamente avalia seu projeto na ordem em que os requisitos aparecem no README, pois o objetivo dele é tornar ágil a avaliação. Portanto, ao perceber esse processo não se preocupe, ok?.

🗂 Compartilhe seu Portfólio!

Você sabia que o LinkedIn é a principal rede social profissional? E que compartilhar o seu aprendizado por lá é muito importante para quem deseja construir uma carreira de sucesso? Compartilhe esse projeto no seu LinkedIn, marque o perfil da Trybe (@trybe) e mostre para a sua rede toda a sua evolução.

Requisitos Obrigatórios

⚠️ Lembre-se de que o seu projeto só será avaliado se estiver passando por todos os checks do Linter. Utilize o comando npm run lint no seu terminal para verificar os checks do Linter 😉 ⚠️

1. Implemente a função average

A função average recebe um array de tamanho variável e retorna a média dos valores recebidos. Caso a função receba algum valor não numérico ou um array vazio, o valor `undefined` deve ser retornado. Todos os resultados devem ser arredondados para valores inteiros. Ex: 4,6 vira 5; 1,3 vira 1. O arquivo `average.spec.js` contém os testes para `average` já implementados. Implemente a função no arquivo `src/average.js` de forma que ela atenda aos testes propostos.

O que será testado:

  • Será validado se, ao receber um array de números, a função average retorna a média de seus valores;
  • Será validado se, ao receber um array que contém valores não numéricos, a função average retorna undefined;
  • Será validado se, ao receber um array vazio, a função average retorna undefined.

2. Implemente os casos de teste para a função numbers

A função `numbers` recebe um array de tamanho variável e retorna `true` se todos os parâmetros forem do tipo 'number' e `false` caso contrário. Essa função já está implementada no arquivo `src/numbers.js`. Escreva pelo menos quatro testes para essa função para garantir que a implementação de `numbers` está correta.

O que será testado:

  • Será validado se no teste da função numbers, o retorno da função é true quando o array passado por parâmetro contém somente números.

3. Implemente a função vqv

Use template literals para escrever uma função que recebe seu nome e sua idade e retorna o parágrafo descrito abaixo:
`Oi, meu nome é Tunico!
Tenho 30 anos,
trabalho na Trybe e mando muito em programação!
#VQV!`

Caso a função seja chamada sem nenhum parâmetro, o valor undefined deve ser retornado. O arquivo vqv.spec.js contém os testes para vqv já implementados. Implemente a função no arquivo src/vqv.js de forma que ela atenda aos testes propostos.

O que será avaliado

  • Será validado se vqv é uma função;
  • Será validado se a função vqv retorna dados do tipo string;
  • Será validado se a função vqv retorna a frase esperada quando passados parâmetros de nome e idade;
  • Será validado se a função vqv, quando chamada sem parâmetro, retorna undefined.

4. Implemente os casos de teste para a função circle

A função `circle` recebe o raio de um círculo e retorna um objeto contendo suas informações: Raio, Área e Circunferência. Se não for especificado um raio, a função retorna `undefined`. Essa função já está implementada no arquivo `src/circle.js`. Escreva pelo menos seis testes para essa função para garantir que a implementação de `circle` está correta.

O que será avaliado

  • Será validado se no teste da função circle, ao receber um raio, o retorno da função é um objeto com as informações corretas (Raio, Área e Circunferência).

5. Implemente a função createStudent

A função `createStudent` recebe como parâmetro um **nome**, e retorna um objeto contendo duas chaves:
  1. name, contendo o nome passado como parâmetro;
  2. feedback, contendo uma função que retorna a frase 'Eita pessoa boa!' ao ser chamada.

O arquivo createStudent.spec.js contém os testes para createStudent já implementados. Implemente a função no arquivo src/createStudent.js de forma que ela atenda aos testes propostos.

O que será avaliado

  • Será validado se a função createStudent retorna um objeto que contenha duas chaves: name, contendo o nome passado como parâmetro; e feedback, contendo uma função que retorna a frase 'Eita pessoa boa!' ao ser chamada.

6. Implemente os casos de teste para a função productDetails

A função `productDetails` recebe duas strings que representam nomes de produtos, e retorna um array contendo dois objetos com os detalhes dos respectivos produtos:
productDetails('Alcool gel', 'Máscara');

Retorna:

[
  {
    name: 'Alcool gel'
    details: {
      productId: 'Alcool gel123'
    }
  },
  {
    name: 'Máscara'
    details: {
      productId: 'Máscara123'
    }
  }
]

Essa função já está implementada no arquivo src/productDetails.js. Escreva pelo menos cinco testes para essa função no arquivo tests/productDetails.js para garantir que a implementação de productDetails está correta.

O que será avaliado

  • Será validado se no teste da função productDetails, ao receber duas strings, o retorno da função é um array de objetos e se cada objeto contém os dados necessários.

7. Implemente as funções calculator e arrayGenerator

A função `calculator` recebe dois números inteiros como parâmetro e retorna um objeto com as seguintes chaves:
- sum; - mult; - div; - sub.

Para cada chave atribua como valor a operação correspondente à sua chave:

  • sum: retorna o resultado da soma dos dois números;
  • mult: retorna o resultado da multiplicação dos dois números;
  • div: retorna o resultado da divisão dos dois números;
  • sub: retorna o resultado da subtração dos dois números.

Os resultados das divisões devem sempre ser arredondados para baixo.

Parâmetros:

  • Dois números inteiros.

Comportamento:

calculator(1, 2); // { sum: 3, mult: 2, div: 0, sub: -1 }

Já a função arrayGenerator converte objetos em arrays, de chaves, valores ou ambos. Ela deve receber dois parâmetros:

  • o primeiro parâmetro deve ser uma string que indica o tipo de conversão;
  • o segundo parâmetro deve ser um objeto semelhante ao que é retornado pela função calculator que você acabou de desenvolver.

Parâmetros:

  • Uma string que indica o tipo de conversão;
  • Um objeto no formato { sum: 3, mult: 2, div: 0, sub: -1 };

Comportamento:

arrayGenerator('keys', { sum: 3, mult: 2, div: 1, sub: 0 }) // [ 'sum', 'mult', 'div', 'sub' ]
arrayGenerator('values', { sum: 3, mult: 2, div: 1, sub: 0 }) // [ 3, 2, 1, 0 ]
arrayGenerator('entries', { sum: 3, mult: 2, div: 1, sub: 0 }) // [ [ 'sum', 3 ], [ 'mult', 2 ], [ 'div', 1 ], [ 'sub', 0 ] ]

O arquivo objPlayground.spec.js contém os testes para calculator e arrayGenerator já implementados. Implemente as funções no arquivo src/objPlayground.js de forma que ela atenda aos testes propostos.

O que será avaliado

  • Será avaliado se a função calculator retorna os valores esperados;
  • Será avaliado se a função arrayGenerator retorna os valores esperados.

8. Implemente a função myCounter

A função myCounter possui dois loops aninhados que inserem valores dentro de um array. Como podemos perceber, eles vão adicionando valores ao array até sua condição de parada.

Corrija a função myCounter, sem eliminar nenhum dos loops de repetição, para que a função retorne o array correto. O arquivo myCounter.spec.js contém os testes para myCounter já implementados. Implemente a função no arquivo src/myCounter.js de forma que ela atenda aos testes propostos.

O que será avaliado

  • Será validado se a função myCounter retorna os dados esperados de acordo com o que está implementado no teste.

9. Implemente os casos de teste para a função getCharacter

A função `getCharacter` recebe uma string que representa o nome de um personagem e retorna um objeto contendo seu nome, sua classe e suas frases.
getCharacter('Arya');

Retorna:

{
  name: 'Arya Stark',
  class: 'Rogue',
  phrases: ['Not today', 'A girl has no name.']
}

Essa função já está implementada no arquivo src/getCharacter.js. Escreva pelo menos seis testes para essa função no arquivo tests/getCharacter.spec.js para garantir que a implementação de getCharacter está correta.

O que será avaliado

  • Será validado se no teste da função getCharacter ao receber uma string, o retorno da função é o esperado - de acordo com a tabela apresentada no arquivo de testes.
  • Será validado se no teste da função getCharacter ao não receber nenhum parâmetro, o retorno da função é undefined.
  • Será validado se o teste da função getCharacter verifica se o parâmetro é case sensitive.

10. Implemente a função createMenu, bem como seus casos de teste

Esse último requisito vai te guiar por um rico processo de Desenvolvimento Orientado a Testes ou TDD - Test Driven Development

Imagine a seguinte situação: você é responsável por escrever o código do sistema de pedidos de um restaurante através do qual será possível cadastrar um menu. Dado que um menu foi cadastrado, o sistema deve disponibilizar um objeto que permite:

  • Ler o menu cadastrado;
  • Fazer pedidos;
  • Verificar o que foi pedido;
  • Somar o valor da conta.

A estrutura deste código e deste objeto já está definida e você precisa implementá-la. Você encontrará mais detalhes sobre a estrutura a ser seguida e exemplos do retorno da função no arquivo src/restaurant.js. Você deverá se orientar através dos tópicos abaixo para garantir o bom desenvolvimento do sistema.

IMPORTANTE - BOAS PRÁTICAS TDD: COMECE PELO TESTE 1 DO ARQUIVO tests/restaurant.spec.js

Se surgirem dúvidas, não deixe de consultar o nosso conteúdo sobre TDD.

  1. No arquivo tests/restaurant.spec.js, escreva um teste que verifica se a função createMenu() retorna um objeto que possui a chave fetchMenu, a qual tem como valor uma função.

  2. No arquivo tests/restaurant.spec.js, escreva um teste que verifica se 'objetoRetornado.fetchMenu()' retorna um objeto cujas chaves são somente food e drink, considerando que a função createMenu() foi chamada com o objeto: { food: {}, drink: {} }.

  3. No arquivo tests/restaurant.spec.js, escreva um teste que verifica se o menu passado pra função createMenu() é idêntico ao menu recuperado pela função 'objetoRetornado.fetchMenu()'.

  4. No arquivo src/restaurant.js, crie uma função createMenu() que, recebendo um objeto como parâmetro, retorna esse objeto com o seguinte formato: { fetchMenu: () => objetoPassadoPorParametro }.

  5. No arquivo tests/restaurant.spec.js, escreva um teste que verifica se 'objetoRetornado.consumption', após a criação do menu, retorna um array vazio.

  6. No arquivo src/restaurant.js, adicione ao objeto retornado por createMenu() uma chave consumption que, como valor inicial, tem um array vazio.

  7. No arquivo tests/restaurant.spec.js, escreva um teste que verifica se ao chamar uma função associada à chave order no objeto retornado, passando uma string como parâmetro (como objetoRetornado.order('coxinha')), tal string é adicionada ao array retornado em objetoRetornado.consumption.

  8. No arquivo src/restaurant.js, crie uma função, separada da função createMenu(), que, ao receber uma string como parâmetro, adiciona essa string ao array de objetoRetornado.consumption. Essa nova função será adicionada à chave order.

  9. No arquivo tests/restaurant.spec.js, escreva um teste que verifica se ao adicionar três pedidos, dentre bebidas e comidas, o array objetoRetornado.consumption contém os itens pedidos.

  10. No arquivo tests/restaurant.spec.js, escreva um teste que verifica se a função order aceita que pedidos repetidos sejam acrescidos a consumption.

  11. No arquivo tests/restaurant.spec.js, escreva um teste que verifica que, ao chamar objetoRetornado.pay(), retorna-se a soma dos preços de tudo que foi pedido, conforme registrado em objetoRetornado.consumption.

  12. No arquivo src/restaurant.js, adicione ao objeto retornado por createMenu() uma chave pay com uma função que percorre por todos os itens de objetoRetornado.consumption, soma o preço deles e retorna o valor somado acrescido de 10%. DICA: para isso, você precisará percorrer tanto o objeto da chave food quanto o objeto da chave drink.

O que será avaliado

  • Será validado se a função createMenu() retorna os dados esperados.
  • Será validado se o teste da função createMenu() verifica cada um dos retornos da função e se estes retornos têm o comportamento esperado.