feat: register an user

Closes #2

.eslintrc.js

@@ -1,7 +1,8 @@
 module.exports = {
   env: {
     es6: true,
-    node: true
+    node: true,
+    jest: true
   },
   extends: [
     'plugin:@typescript-eslint/recommended',

__tests__/factories.ts

@@ -0,0 +1,12 @@
+import faker from 'faker'
+import { factory } from 'factory-girl'
+
+import User from '../src/schemas/User'
+
+factory.define('User', User, {
+  name: faker.name.findName(),
+  email: faker.internet.email(),
+  password: faker.internet.password()
+})
+
+export default factory

__tests__/helpers/MongooseConnection.ts

@@ -0,0 +1,28 @@
+import '../../src/bootstrap'
+
+import mongoose from 'mongoose'
+
+class MongooseConnection {
+  async connect (): Promise<void> {
+    mongoose.connect(process.env.MONGO_URI, {
+      useNewUrlParser: true,
+      useUnifiedTopology: true,
+      useCreateIndex: true
+    }, async (error) => {
+      if (error) {
+        throw error
+      }
+
+      const collections = Object.keys(mongoose.connection.collections)
+      for (const collection of collections) {
+        await mongoose.connection.collections[collection].deleteMany({})
+      }
+    })
+  }
+
+  async disconnect (): Promise<void> {
+    await mongoose.connection.close()
+  }
+}
+
+export default new MongooseConnection()

__tests__/integration/controllers/UserController.test.ts

@@ -0,0 +1,60 @@
+import request from 'supertest'
+import omit from 'lodash/omit'
+
+import MongooseConnection from '../../helpers/MongooseConnection'
+import app from '../../../src/app'
+import factory from '../../factories'
+
+describe('UserController', () => {
+  beforeEach(() => {
+    MongooseConnection.connect()
+  })
+
+  afterEach(() => {
+    MongooseConnection.disconnect()
+  })
+
+  describe('register', () => {
+    it('should register an user with valid arguments', async () => {
+      const user = await factory.attrs('User')
+
+      const response = await request(app)
+        .post('/register')
+        .send(user)
+
+      expect(response.body).toHaveProperty('_id')
+    })
+
+    it('should not be able to register with duplicated email', async () => {
+      const user = await factory.create('User')
+
+      const response = await request(app)
+        .post('/register')
+        .send(user.toString())
+
+      expect(response.status).toBe(400)
+    })
+
+    it('should not be able to register with invalid args', async () => {
+      const user = await factory.attrs('User')
+
+      const responseWithoutName = await request(app)
+        .post('/register')
+        .send(omit(user, ['name']))
+
+      expect(responseWithoutName.status).toBe(400)
+
+      const responseWithoutEmail = await request(app)
+        .post('/register')
+        .send(omit(user, ['email']))
+
+      expect(responseWithoutEmail.status).toBe(400)
+
+      const responseWithoutPassword = await request(app)
+        .post('/register')
+        .send(omit(user, ['password']))
+
+      expect(responseWithoutPassword.status).toBe(400)
+    })
+  })
+})

__tests__/unit/schemas/User.test.ts

@@ -0,0 +1,9 @@
+import bcrypt from 'bcryptjs'
+
+describe('User', () => {
+  it('should encrypt user password', async () => {
+    const hash = await bcrypt.hash('123456', 8)
+
+    expect(await bcrypt.compare('123456', hash)).toBe(true)
+  })
+})

jest.config.js

@@ -0,0 +1,187 @@
+// For a detailed explanation regarding each configuration property, visit:
+// https://jestjs.io/docs/en/configuration.html
+
+module.exports = {
+  // All imported modules in your tests should be mocked automatically
+  // automock: false,
+
+  // Stop running tests after `n` failures
+  bail: 1,
+
+  // Respect "browser" field in package.json when resolving modules
+  // browser: false,
+
+  // The directory where Jest should store its cached dependency information
+  // cacheDirectory: "/private/var/folders/94/q33r7nr943zdmbf6jlqrc54w0000gn/T/jest_dx",
+
+  // Automatically clear mock calls and instances between every test
+  clearMocks: true,
+
+  // Indicates whether the coverage information should be collected while executing the test
+  collectCoverage: true,
+
+  // An array of glob patterns indicating a set of files for which coverage information should be collected
+  collectCoverageFrom: ['src/**/*.ts'],
+
+  // The directory where Jest should output its coverage files
+  coverageDirectory: '__tests__/coverage',
+
+  // An array of regexp pattern strings used to skip coverage collection
+  // coveragePathIgnorePatterns: [
+  //   "/node_modules/"
+  // ],
+
+  // A list of reporter names that Jest uses when writing coverage reports
+  coverageReporters: [
+    'text',
+    'lcov'
+  ],
+
+  // An object that configures minimum threshold enforcement for coverage results
+  // coverageThreshold: null,
+
+  // A path to a custom dependency extractor
+  // dependencyExtractor: null,
+
+  // Make calling deprecated APIs throw helpful error messages
+  // errorOnDeprecated: false,
+
+  // Force coverage collection from ignored files using an array of glob patterns
+  // forceCoverageMatch: [],
+
+  // A path to a module which exports an async function that is triggered once before all test suites
+  // globalSetup: null,
+
+  // A path to a module which exports an async function that is triggered once after all test suites
+  // globalTeardown: null,
+
+  // A set of global variables that need to be available in all test environments
+  // globals: {},
+
+  // The maximum amount of workers used to run your tests. Can be specified as % or a number. E.g. maxWorkers: 10% will use 10% of your CPU amount + 1 as the maximum worker number. maxWorkers: 2 will use a maximum of 2 workers.
+  // maxWorkers: "50%",
+
+  // An array of directory names to be searched recursively up from the requiring module's location
+  // moduleDirectories: [
+  //   "node_modules"
+  // ],
+
+  // An array of file extensions your modules use
+  // moduleFileExtensions: [
+  //   "js",
+  //   "json",
+  //   "jsx",
+  //   "ts",
+  //   "tsx",
+  //   "node"
+  // ],
+
+  // A map from regular expressions to module names that allow to stub out resources with a single module
+  // moduleNameMapper: {},
+
+  // An array of regexp pattern strings, matched against all module paths before considered 'visible' to the module loader
+  // modulePathIgnorePatterns: [],
+
+  // Activates notifications for test results
+  // notify: false,
+
+  // An enum that specifies notification mode. Requires { notify: true }
+  // notifyMode: "failure-change",
+
+  // A preset that is used as a base for Jest's configuration
+  // preset: null,
+
+  // Run tests from one or more projects
+  // projects: null,
+
+  // Use this configuration option to add custom reporters to Jest
+  // reporters: undefined,
+
+  // Automatically reset mock state between every test
+  // resetMocks: false,
+
+  // Reset the module registry before running each individual test
+  // resetModules: false,
+
+  // A path to a custom resolver
+  // resolver: null,
+
+  // Automatically restore mock state between every test
+  // restoreMocks: false,
+
+  // The root directory that Jest should scan for tests and modules within
+  // rootDir: null,
+
+  // A list of paths to directories that Jest should use to search for files in
+  // roots: [
+  //   "<rootDir>"
+  // ],
+
+  // Allows you to use a custom runner instead of Jest's default test runner
+  // runner: "jest-runner",
+
+  // The paths to modules that run some code to configure or set up the testing environment before each test
+  // setupFiles: [],
+
+  // A list of paths to modules that run some code to configure or set up the testing framework before each test
+  // setupFilesAfterEnv: ['./__tests__/helpers/setup.ts'],
+
+  // A list of paths to snapshot serializer modules Jest should use for snapshot testing
+  // snapshotSerializers: [],
+
+  // The test environment that will be used for testing
+  testEnvironment: 'node',
+
+  // Options that will be passed to the testEnvironment
+  // testEnvironmentOptions: {},
+
+  // Adds a location field to test results
+  // testLocationInResults: false,
+
+  // The glob patterns Jest uses to detect test files
+  testMatch: [
+    '**/__tests__/**/*.test.ts?(x)'
+  ],
+
+  // An array of regexp pattern strings that are matched against all test paths, matched tests are skipped
+  // testPathIgnorePatterns: [
+  //   "/node_modules/"
+  // ],
+
+  // The regexp pattern or array of patterns that Jest uses to detect test files
+  // testRegex: [],
+
+  // This option allows the use of a custom results processor
+  // testResultsProcessor: null,
+
+  // This option allows use of a custom test runner
+  // testRunner: "jasmine2",
+
+  // This option sets the URL for the jsdom environment. It is reflected in properties such as location.href
+  // testURL: "http://localhost",
+
+  // Setting this value to "fake" allows the use of fake timers for functions such as "setTimeout"
+  // timers: "real",
+
+  // A map from regular expressions to paths to transformers
+  transform: {
+    '.(js|jsx|ts|tsx)': '@sucrase/jest-plugin'
+  }
+
+  // An array of regexp pattern strings that are matched against all source file paths, matched files will skip transformation
+  // transformIgnorePatterns: [
+  //   "/node_modules/"
+  // ],
+
+  // An array of regexp pattern strings that are matched against all modules before the module loader will automatically return a mock for them
+  // unmockedModulePathPatterns: undefined,
+
+  // Indicates whether each individual test should be reported during the run
+  // verbose: null,
+
+  // An array of regexp patterns that are matched against all source file paths before re-running tests in watch mode
+  // watchPathIgnorePatterns: [],
+
+  // Whether to use watchman for file crawling
+  // watchman: true,
+}

nodemon.json

@@ -3,5 +3,6 @@
   "ext": "ts",
   "execMap": {
     "ts": "sucrase-node src/server.ts"
-  }
+  },
+  "ignore": ["__tests__"]
 }

package.json

@@ -10,7 +10,8 @@
   "scripts": {
     "commit": "git-cz",
     "dev": "nodemon src/server.ts",
-    "build": ""
+    "build": "",
+    "test": "NODE_ENV=test jest"
   },
   "husky": {
     "hooks": {
@@ -25,14 +26,20 @@
   "dependencies": {
     "bcryptjs": "^2.4.3",
     "cors": "^2.8.5",
+    "dotenv": "^8.1.0",
     "express": "^4.17.1",
     "lodash": "^4.17.15",
-    "mongoose": "^5.7.3"
+    "mongoose": "^5.7.3",
+    "yup": "^0.27.0"
   },
   "devDependencies": {
+    "@sucrase/jest-plugin": "^2.0.0",
+    "@types/bcryptjs": "^2.4.2",
     "@types/cors": "^2.8.6",
     "@types/express": "^4.17.1",
+    "@types/jest": "^24.0.18",
     "@types/mongoose": "^5.5.19",
+    "@types/supertest": "^2.0.8",
     "@typescript-eslint/eslint-plugin": "^2.3.2",
     "@typescript-eslint/parser": "^2.3.2",
     "commitizen": "^4.0.3",
@@ -45,10 +52,14 @@
     "eslint-plugin-prettier": "^3.1.1",
     "eslint-plugin-promise": "^4.2.1",
     "eslint-plugin-standard": "^4.0.1",
+    "factory-girl": "^5.0.4",
+    "faker": "^4.1.0",
     "husky": "^3.0.8",
+    "jest": "^24.9.0",
     "nodemon": "^1.19.3",
     "prettier": "^1.18.2",
     "sucrase": "^3.10.1",
+    "supertest": "^4.0.2",
     "typescript": "^3.6.3"
   }
 }

src/app.ts

@@ -1,3 +1,5 @@
+import './bootstrap'
+
 import express from 'express'
 import cors from 'cors'
 import mongoose from 'mongoose'
@@ -20,10 +22,14 @@ class App {
   }
 
   private database ():void {
-    mongoose.connect('mongodb://localhost:27017/post-api', {
+    mongoose.connect(process.env.MONGO_URI, {
       useNewUrlParser: true,
       useUnifiedTopology: true,
       useCreateIndex: true
+    }, (error) => {
+      if (error) {
+        throw error
+      }
     })
   }
 

src/bootstrap.ts

@@ -0,0 +1,5 @@
+import dotenv from 'dotenv'
+
+dotenv.config({
+  path: process.env.NODE_ENV === 'test' ? '.env.test' : '.env'
+})