[Airam Toscano] - Backend-Test-Two

.github/workflows/eslint.yml

@@ -0,0 +1,32 @@
+name: Lint
+
+on:
+  # Trigger the workflow on push or pull request,
+  # but only for the main branch
+  pull_request:
+    types: [opened, synchronize]
+
+jobs:
+  run-linters:
+    name: Run linters
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Check out Git repository
+        uses: actions/checkout@v2
+
+      - name: Set up Node.js
+        uses: actions/setup-node@v1
+        with:
+          node-version: 12
+
+      - name: Install ESLint
+        run: |
+          npm install eslint@8.10.0
+          npm install @microsoft/eslint-formatter-sarif@2.1.7
+
+      - name: Run ESLint backend
+        run:  |
+         cd app/backend
+         npm i
+         npm run lint

README.md

@@ -1,61 +1,96 @@
-# **TESTE DE BACKEND**
+# Desafio para o processo seletivo Orma Carbon
 
-## SITUAÇÃO-PROBLEMA
+Repositório destinado aos interessados em participar do processo seletivo da Orma Carbon
 
-Você acabou de ser contratado para uma vaga de desenvolvedor backend de uma empresa que revende cervejas do mundo inteiro. O desenvolvedor anterior corrompeu completamente o banco de dados e a API anterior e sobrou apenas um arquivo .JSON com todas as informações do banco. Seu líder confiou a tarefa de recriar a API e o banco de dados a você.
 
-Neste teste, você deverá criar uma API com endpoints a serem consumidos via REST e um banco de dados, utilizando os dados fornecidos no arquivo. ````db.json````.
+## 🚀 Começando
 
----------------------------------------------------------------------
+Antes de utilizar o projeto, é necessario ter Git, Docker/Docker-compose e npm/yarn instalado na máquina.
 
-## REQUISITOS OBRIGATÓRIOS:
 
-- Seja original, projetos suspeitos de serem copiados serão descartados.
-- Queremos ver o seu código, e não o de outros.
-- Criar coleção no Postman (seu teste será testado por aqui).
 
-## GIT
+## 📃 Sobre
+  <p>
+    Estruturar uma aplicação backend, dockerizada, cujo objetivo é salvar o banco de dados e criar uma nova API com dados do json, e também realizar alguns desafios propostos pela empresa Orma Carbon.
+  </p>
 
-- Faça um fork deste repositório.
-- Crie uma branch para codar as suas features.
-- Faça um pull-request quando o teste for finalizado.
 
-##### **NOTA: Será avaliado também se o nome da branch, títulos de commit, push e comentários possuem boa legibilidade.**
+## 🛠️ Ferramentas
 
------------------------------------------------------
+## - Front-End:
+  - React
+  - Typescript
+  - Vite
+  - React Router Dom
+  - React Hooks
+  - Css modules
+  - Axios
+
+## - Back-End:
+  - Node
+  - Typescript
+  - Express
+  - Cors
+  - Mongodb
+  - Swagger
+  - Eslint
+  - GitHub CI/CD
+  - Chai/Mocha
+  - mongoose
+  - Shell
+  - Migrate-mongo
 
-## FRAMEWORK -
+## ⚙️ Como executar
 
-- Servidor: Express (Javascript/Typescript) *<u>**OU**</u>* Gin (Golang)
-- Banco de dados: MongoDB, DynamoDB, MySQL, Postgres...
+Será necessário que a porta 3000 e 3001 estejam disponíveis para a aplicação, Mongodb usará a porta 27017.
 
------------------------------------------------------
+1 - Clone o repositório em uma pasta de sua preferencia 
+```
+git@github.com:AiramToscano/backend-test-two.git
+```
+2 - Suba o docker-compose, todas as depêndencias serão automaticamente instaladas
+```
+npm run compose:up   // para subir a aplicação
+npm run compose:down // para parar completamente a aplicação
+```
+3 - Após rodar o comando, aguarde um pouco que a aplicação irá ficar disponivel nas seguintes rotas:
 
-## PROJETO
+  `- Front-End: http://localhost:3000`
 
-- Api deve conter pelo menos 1 endpoint para cada operação crud (Create, Read, Update, Delete).
-- Um endpoint para listagem de conteúdo.
-- Banco de dados a escolha do dev.
+  `- Back-End: http://localhost:3001`
 
--------------------------------------------------------
+  <p> Caso algum container tiver com o status unhealty, você poderá acessar a aplicação localmente, instalando as dependências  `npm install`, tanto no <code>/app/frontend</code> quanto no <code>/app/backend</code></p>
 
-## REQUISITOS DIFERENCIAIS:
+  <p>E logo após a instalação das dependências, rode os comandos <code>npm run dev</code> no Frontend e o comando <code>npm run dev</code> no Backend</p>
 
-- Seguir os princípios de SOLID.
-- Fazer o teste em GoLang.
-- Codar um código performático.
-- Utilizar inglês no projeto todo.
-- Utilizar Injeção de dependências.
-- Criar um frontend que consuma a API
-- Fazer deploy do mesmo (heroku, aws, google cloud ou outro da preferência).
+  <p>Caso queria rodar localmente, irá precisar ter o mongoDB instalado na máquina ou em um container docker, com o a url `mongodb://localhost:27017/testtwo` </p>
 
+# Back-End
 
+## 1 - Rotas dos estoques da Cerveja - Beers
 
----
+Para testar as rotas basta subir o backend, as rotas estão documentadas no swagger.
 
-## ENTREGA
+- `http://localhost:3001/api-docs/` - Documentada pelo Swagger.
 
-- Faça um pull request e nomeie-o como no ex.: Teste de (Seu nome aqui).
-- Envie um email para schmidt@repenso.eco e kevin@repenso.eco com o link do pull request, do deploy (tanto do front quanto do back se feito), e anexe a coleção do postman.
-- Assim que avaliarmos seu teste, enviaremos uma devolutiva de sucesso ou falha, e caso seja aprovado, um link para agendar sua entrevista técnica.
 
+### ⚙️ Executando os testes
+
+Para essa aplicação back-end, foi feito testes unitarios, cobrindo 100% da aplicação.
+
+- `npm run test:dev` - Para rodar os testes unitários.
+
+- `npm run test:coverage` - Para rodar os testes junto com a cobertura da aplicação.
+
+Testes back-end com quase 100% de cobertura.
+
+
+
+# Front-End
+
+![recipes](https://github.com/AiramToscano/backend-test-two/blob/main/app/gif/testProject.gif)
+
+
+# 🎁 Expressões de gratidão
+
+- Gostaria de agradecer a Orma Carbon  por esse desafio, aprendi muito com esse projeto, a cada um novo desafio se torna um novo aprendizado.

app/backend/.env

@@ -0,0 +1,2 @@
+APP_PORT=3001
+MONGO_URI=mongodb://localhost:27017/testtwo

app/backend/.eslintrc.js

@@ -0,0 +1,29 @@
+module.exports = {
+  parser: '@typescript-eslint/parser',
+  parserOptions: {
+    project: 'tsconfig.json',
+    tsconfigRootDir: __dirname,
+    sourceType: 'module',
+  },
+  plugins: ['@typescript-eslint/eslint-plugin'],
+  extends: [
+    'plugin:@typescript-eslint/recommended',
+    'airbnb-base',
+    'plugin:editorconfig/noconflict',
+    'plugin:mocha/recommended',
+    'airbnb-typescript/base'
+  ],
+  root: true,
+  env: {
+    node: true,
+    jest: true,
+  },
+  ignorePatterns: ['.eslintrc.js'],
+  rules: {
+    '@typescript-eslint/interface-name-prefix': 'off',
+    '@typescript-eslint/explicit-function-return-type': 'off',
+    '@typescript-eslint/explicit-module-boundary-types': 'off',
+    '@typescript-eslint/no-explicit-any': 'off',
+    "no-console": "off",
+  },
+};

app/backend/.gitignore

@@ -0,0 +1,23 @@
+# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
+
+# dependencies
+/node_modules
+
+
+# testing
+/coverage
+/.nyc_output
+
+# production
+/build
+
+# misc
+.DS_Store
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*

app/backend/.nyc_output/processinfo/index.json

@@ -0,0 +1 @@
+{"processes":{"17b53a63-5be5-4edb-98f2-7268be738a4b":{"parent":null,"children":["1b21971c-4645-4137-a8ee-545f8d58ed3c"]},"1b21971c-4645-4137-a8ee-545f8d58ed3c":{"parent":"17b53a63-5be5-4edb-98f2-7268be738a4b","children":[]}},"files":{"/home/toscano/backend-test-two/backend-test-two/app/backend/src/controllers/BeersControllers.ts":["1b21971c-4645-4137-a8ee-545f8d58ed3c"],"/home/toscano/backend-test-two/backend-test-two/app/backend/src/models/BeersModel.ts":["1b21971c-4645-4137-a8ee-545f8d58ed3c"],"/home/toscano/backend-test-two/backend-test-two/app/backend/src/models/MongoModel.ts":["1b21971c-4645-4137-a8ee-545f8d58ed3c"],"/home/toscano/backend-test-two/backend-test-two/app/backend/src/services/BeersService.ts":["1b21971c-4645-4137-a8ee-545f8d58ed3c"],"/home/toscano/backend-test-two/backend-test-two/app/backend/src/tests/mocks/BeerMock.ts":["1b21971c-4645-4137-a8ee-545f8d58ed3c"]},"externalIds":{}}

app/backend/Dockerfile

@@ -0,0 +1,13 @@
+FROM node:16-alpine
+
+WORKDIR /app-backend
+
+COPY package.json /app-backend
+
+RUN ["npm", "i"] 
+
+COPY . /app-backend
+
+EXPOSE 3001
+
+CMD ["npm" , "run", "dev"]

app/backend/migrations/migrate-mongo-config.js

@@ -0,0 +1,37 @@
+// In this file you can configure migrate-mongo
+require('dotenv').config()
+
+const config = {
+  mongodb: {
+    // TODO Change (or review) the url to your MongoDB:
+    url: process.env.MONGO_URI || 'mongodb://0.0.0.0:27017/testtwo',
+
+    // TODO Change this to your database name:
+    databaseName: "testtwo",
+
+    options: {
+      useNewUrlParser: true, // removes a deprecation warning when connecting
+      useUnifiedTopology: true, // removes a deprecating warning when connecting
+      //   connectTimeoutMS: 3600000, // increase connection timeout to 1 hour
+      //   socketTimeoutMS: 3600000, // increase socket timeout to 1 hour
+    }
+  },
+
+  // The migrations dir, can be an relative or absolute path. Only edit this when really necessary.
+  migrationsDir: "migrations",
+
+  // The mongodb collection where the applied changes are stored. Only edit this when really necessary.
+  changelogCollectionName: "changelog",
+
+  // The file extension to create migrations and search for in migration dir 
+  migrationFileExtension: ".js",
+
+  // Enable the algorithm to create a checksum of the file contents and use that in the comparison to determine
+  // if the file should be run.  Requires that scripts are coded to be run multiple times.
+  useFileHash: false,
+
+  // Don't change this, unless you know what you're doing
+  moduleSystem: 'commonjs',
+};
+
+module.exports = config;

app/backend/migrations/migrations/db.js

@@ -0,0 +1,11 @@
+const config = require('./db.json');
+
+module.exports = {
+    up(db, callback) {
+      return db.collection('beers').insertMany(config, {$set: {blacklisted: true}}, callback);
+    },
+
+    down(db, _callback) {
+      return db.dropDatabase();
+    }
+  };