Merge remote-tracking branch 'upstream/master' into part_five_mongo_config

davidmatas · davidmatas · commit ddc1554adb47 · 2020-11-22T13:30:33.000+01:00
diff --git a/.gitignore b/.gitignore
@@ -4,3 +4,4 @@ dist/
 logs/
 src/Contexts/Mooc/Courses/infrastructure/persistence/courses.*
 data
+test-results.xml
diff --git a/Makefile b/Makefile
@@ -1,5 +1,7 @@
 .PHONY = default deps build test start-mooc-backend clean start-database start-backoffice-frontend
 
+# Shell to use for running scripts
+SHELL := $(shell which bash)
 IMAGE_NAME := codelytv/typescript-ddd-skeleton
 SERVICE_NAME := app
 MOOC_APP_NAME := mooc
diff --git a/cypress.json b/cypress.json
@@ -0,0 +1,8 @@
+{
+  "video": false,
+  "screenshotOnRunFailure": false,
+  "testFiles": "**/*.cypress.*",
+  "integrationFolder": "tests/apps",
+  "fixturesFolder": "tests/utils/cypress/fixtures",
+  "pluginsFile": "tests/utils/cypress/plugins/index.ts"
+}
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -13,7 +13,7 @@
   "scripts": {
     "dev": "NODE_ENV=dev ts-node-dev --ignore-watch node_modules --inspect=0.0.0.0:9267 ./src/apps/mooc_backend/server.ts",
     "dev:backoffice:frontend": "NODE_ENV=dev ts-node-dev --ignore-watch node_modules ./src/apps/backoffice/frontend/server.ts",
-    "test": "npm run test:unit && npm run test:features",
+    "test": "npm run test:unit && npm run test:features && npm run cypress:run",
     "test:unit": "NODE_ENV=test jest",
     "test:features": "NODE_ENV=test cucumber-js -p default",
     "lint": "tslint src/**/*.ts{,x}",
@@ -22,7 +22,9 @@
     "build": "npm run build:clean && npm run build:tsc && npm run build:di",
     "build:tsc": "tsc -p tsconfig.prod.json",
     "build:di": "copy 'src/**/*.{json,yaml,html,png}' dist/src",
-    "build:clean": "rm -r dist; exit 0"
+    "build:clean": "rm -r dist; exit 0",
+    "cypress:open": "NODE_ENV=test ts-node tests/utils/cypress/open",
+    "cypress:run": "NODE_ENV=test ts-node tests/utils/cypress/run"
   },
   "dependencies": {
     "@types/bson": "^4.0.2",
@@ -46,6 +48,7 @@
     "copy": "^0.3.2",
     "errorhandler": "^1.5.1",
     "express": "^4.17.1",
+    "express-promise-router": "^4.0.1",
     "express-validator": "^6.6.1",
     "glob": "^7.1.6",
     "helmet": "^4.1.1",
@@ -66,11 +69,12 @@
     "@types/cookie-parser": "^1.4.2",
     "@types/cookie-session": "^2.0.41",
     "@types/cucumber": "^6.0.1",
-    "@types/faker": "^5.1.0",
+    "@types/faker": "^5.1.2",
     "@types/jest": "^26.0.14",
     "@types/nunjucks": "^3.1.3",
     "@types/supertest": "^2.0.10",
     "cucumber": "^6.0.5",
+    "cypress": "^5.2.0",
     "faker": "^5.1.0",
     "husky": "^4.3.0",
     "jest": "^26.4.2",
diff --git a/src/Contexts/Mooc/Courses/application/CourseCreator.ts b/src/Contexts/Mooc/Courses/application/CourseCreator.ts
@@ -22,13 +22,9 @@ export class CourseCreator {
   }
 
   async run({ courseId, courseName, courseDuration }: Params): Promise<void> {
-    const course = Course.create(
-      courseId,
-      courseName,
-      courseDuration
-    );
+    const course = Course.create(courseId, courseName, courseDuration);
 
     await this.repository.save(course);
-    this.eventBus.publish(course.pullDomainEvents());
+    await this.eventBus.publish(course.pullDomainEvents());
   }
 }
diff --git a/src/Contexts/Mooc/Courses/infrastructure/persistence/FileCourseRepository.ts b/src/Contexts/Mooc/Courses/infrastructure/persistence/FileCourseRepository.ts
diff --git a/src/Contexts/Mooc/CoursesCounter/application/Increment/CoursesCounterIncrementer.ts b/src/Contexts/Mooc/CoursesCounter/application/Increment/CoursesCounterIncrementer.ts
@@ -14,7 +14,7 @@ export class CoursesCounterIncrementer {
       counter.increment(courseId);
 
       await this.repository.save(counter);
-      this.bus.publish(counter.pullDomainEvents());
+      await this.bus.publish(counter.pullDomainEvents());
     }
   }
 
diff --git a/src/apps/backoffice/frontend/controllers/CoursesPostController.ts b/src/apps/backoffice/frontend/controllers/CoursesPostController.ts
@@ -11,9 +11,9 @@ export class CoursesPostController extends WebController {
 
   static validator(): ValidationChain[] {
     return [
-      body('id').isUUID(),
-      body('name').isLength({ min: 1, max: 255 }),
-      body('duration').isLength({ min: 4, max: 100 })
+      body('id').isUUID().withMessage('Invalid course id'),
+      body('name').isLength({ min: 1, max: 30 }).withMessage('Invalid name'),
+      body('duration').isLength({ min: 4, max: 100 }).withMessage('Invalid duration')
     ];
   }
 
diff --git a/src/apps/backoffice/frontend/controllers/WebController.ts b/src/apps/backoffice/frontend/controllers/WebController.ts
@@ -40,7 +40,7 @@ export abstract class WebController {
 
   protected render(req: Request, res: Response, template: string, data: { [key: string]: any }) {
     const flash = this.feedFlash(req, data);
-    res.render('pages/courses/courses', {
+    res.render(template, {
       ...data,
       ...flash
     });
diff --git a/src/apps/backoffice/frontend/seed.ts b/src/apps/backoffice/frontend/seed.ts
@@ -10,7 +10,7 @@ export async function seed() {
   const alreadyExists = await repository.search();
   const isTestEnvironment = process.env.NODE_ENV === 'test';
 
-  if (!alreadyExists && !isTestEnvironment) {
+  if (!alreadyExists) {
     logger.info('[Seed] Initializing CourseCounter');
     const courseCounter = CoursesCounter.initialize(CoursesCounterId.random());
     await repository.save(courseCounter);
diff --git a/src/apps/mooc_backend/app.ts b/src/apps/mooc_backend/app.ts
@@ -2,6 +2,7 @@ import bodyParser from 'body-parser';
 import express from 'express';
 import helmet from 'helmet';
 import compress from 'compression';
+import Router from 'express-promise-router';
 import { registerRoutes } from './routes';
 import { registerSubscribers } from './subscribers';
 
@@ -17,7 +18,9 @@ app.use(helmet.hidePoweredBy());
 app.use(helmet.frameguard({ action: 'deny' }));
 app.use(compress());
 
-registerRoutes(app);
+const router = Router();
+app.use(router);
+registerRoutes(router);
 registerSubscribers();
 
 export default app;
diff --git a/src/apps/mooc_backend/routes/courses.route.ts b/src/apps/mooc_backend/routes/courses.route.ts
@@ -1,10 +1,10 @@
-import { Express } from 'express';
+import { Router, Request, Response } from 'express';
 import container from '../config/dependency-injection';
 
-export const register = (app: Express) => {
+export const register = (router: Router) => {
   const coursePutController = container.get('Apps.mooc.controllers.CoursePutController');
-  app.put('/courses/:id', coursePutController.run.bind(coursePutController));
+  router.put('/courses/:id', (req: Request, res: Response) => coursePutController.run(req, res));
 
   const coursesCounterGetController = container.get('Apps.mooc.controllers.CoursesCounterGetController');
-  app.get('/courses-counter', coursesCounterGetController.run.bind(coursesCounterGetController));
+  router.get('/courses-counter', (req: Request, res: Response) => coursesCounterGetController.run(req, res));
 };
diff --git a/src/apps/mooc_backend/routes/index.ts b/src/apps/mooc_backend/routes/index.ts
@@ -1,12 +1,12 @@
-import { Express } from 'express';
+import { Router } from 'express';
 import glob from 'glob';
 
-export function registerRoutes(app: Express) {
+export function registerRoutes(router: Router) {
   const routes = glob.sync(__dirname + '/**/*.route.*');
-  routes.map(route => register(route, app));
+  routes.map(route => register(route, router));
 }
 
-function register(routePath: string, app: Express) {
-    const route = require(routePath);
-    route.register(app);
+function register(routePath: string, router: Router) {
+  const route = require(routePath);
+  route.register(router);
 }
diff --git a/src/apps/mooc_backend/routes/status.route.ts b/src/apps/mooc_backend/routes/status.route.ts
@@ -1,8 +1,8 @@
-import { Express } from 'express';
+import { Router, Request, Response } from 'express';
 import container from '../config/dependency-injection';
 import StatusController from '../controllers/StatusGetController';
 
-export const register = (app: Express) => {
+export const register = (router: Router) => {
   const controller: StatusController = container.get('Apps.mooc.controllers.StatusGetController');
-  app.get('/status', controller.run.bind(controller));
+  router.get('/status', (req: Request, res: Response) => controller.run(req, res));
 };
diff --git a/tests/apps/backoffice/frontend/features/courses/create_course.cypress.ts b/tests/apps/backoffice/frontend/features/courses/create_course.cypress.ts
@@ -0,0 +1,132 @@
+import faker from 'faker';
+
+describe('Courses', () => {
+  before(() => {
+    cy.task('reset:db');
+  });
+
+  beforeEach(() => {
+    cy.visit('courses');
+  });
+
+  it('can create courses', () => {
+    cy.contains('Actualmente CodelyTV Pro cuenta con 0 cursos.');
+
+    let i = 0;
+    while (i <= 3) {
+      i++;
+      const courseName = faker.random.words(1);
+      cy.get('input[name="name"]').type(courseName);
+      cy.get('input[name="duration"]').type('8 days');
+      cy.get('form').submit();
+
+      cy.get('div[role="alert"]').contains(`Felicidades, el curso ${courseName} ha sido creado!`);
+      cy.contains(`Actualmente CodelyTV Pro cuenta con ${i} cursos.`);
+    }
+  });
+
+  describe('Course id field', () => {
+    it('has value by default', () => {
+      cy.get('input[name="id"]').invoke('val').should('not.be.empty');
+    });
+
+    it('has flash messages when is invalid', () => {
+      cy.get('input[name="id"]').clear().type('invalid course id');
+      cy.get('form').submit();
+
+      cy.get('input[name="id"] + p').contains('Invalid course id');
+    });
+
+    it('maintain the value introduced by the user when invalid', () => {
+      cy.get('input[name="id"]').clear().type('invalid course id');
+      cy.get('form').submit();
+
+      cy.get('input[name="id"]').should('have.value', 'invalid course id');
+    });
+
+    it('maintain the value introduced by the user when valid', () => {
+      const uuid = faker.random.uuid();
+
+      cy.get('input[name="id"]').clear().type(uuid);
+      cy.get('form').submit();
+
+      cy.get('input[name="id"]').should('have.value', uuid);
+    });
+  });
+
+  describe('Name field', () => {
+    it('has flash messages when is empty', () => {
+      cy.get('form').submit();
+
+      cy.get('input[name="name"] + p').contains('Invalid name');
+    });
+
+    it('has flash messages when is longer than 30 character', () => {
+      cy.get('input[name="name"]').type(faker.random.alphaNumeric(31));
+
+      cy.get('form').submit();
+
+      cy.get('input[name="name"] + p').contains('Invalid name');
+    });
+
+    it('maintain the value introduced by the user when invalid', () => {
+      const invalidCourseName = faker.random.alphaNumeric(3);
+
+      cy.get('input[name="name"]').clear().type(invalidCourseName);
+      cy.get('form').submit();
+
+      cy.get('input[name="name"]').should('have.value', invalidCourseName);
+    });
+
+    it('maintain the value introduced by the user when valid', () => {
+      const validCourseName = faker.random.alphaNumeric(1);
+
+      cy.get('input[name="name"]').clear().type(validCourseName);
+      cy.get('form').submit();
+
+      cy.get('input[name="name"]').should('have.value', validCourseName);
+    });
+  });
+
+  describe('Duration field', () => {
+    it('has flash messages when is empty', () => {
+      cy.get('form').submit();
+
+      cy.get('input[name="duration"] + p').contains('Invalid duration');
+    });
+
+    it('has flash messages when is shorter than 4 character', () => {
+      cy.get('input[name="duration"]').type(faker.random.alphaNumeric(3));
+
+      cy.get('form').submit();
+
+      cy.get('input[name="duration"] + p').contains('Invalid duration');
+    });
+
+    it('has flash messages when is longer than 100 character', () => {
+      cy.get('input[name="duration"]').type(faker.random.alphaNumeric(101));
+
+      cy.get('form').submit();
+
+      cy.get('input[name="duration"] + p').contains('Invalid duration');
+    });
+
+    it('maintain the value introduced by the user when invalid', () => {
+      const invalidCourseDuration = faker.random.alphaNumeric(101);
+
+      cy.get('input[name="duration"]').clear().type(invalidCourseDuration);
+      cy.get('form').submit();
+
+      cy.get('input[name="duration"]').should('have.value', invalidCourseDuration);
+    });
+
+    it('maintain the value introduced by the user when valid', () => {
+      const validCourseDuration = faker.random.alphaNumeric(5);
+
+      cy.get('input[name="duration"]').clear().type(validCourseDuration);
+      cy.get('form').submit();
+
+      cy.get('input[name="duration"]').should('have.value', validCourseDuration);
+    });
+  });
+});
diff --git a/tests/apps/mooc_backend/features/step_definitions/eventBus.steps.ts b/tests/apps/mooc_backend/features/step_definitions/eventBus.steps.ts
diff --git a/tests/apps/tsconfig.json b/tests/apps/tsconfig.json
@@ -0,0 +1,9 @@
+{
+  "extends": "../../tsconfig.json",
+  "compilerOptions": {
+    "lib": ["es2015", "dom"],
+    "types": ["cypress"]
+  },
+  "include": ["**/*.ts"]
+}
+
diff --git a/tests/utils/cypress/fixtures/example.json b/tests/utils/cypress/fixtures/example.json
@@ -0,0 +1,5 @@
+{
+  "name": "Using fixtures to represent data",
+  "email": "hello@cypress.io",
+  "body": "Fixtures are a great way to mock data for responses to routes"
+}
diff --git a/tests/utils/cypress/open.ts b/tests/utils/cypress/open.ts
@@ -0,0 +1,22 @@
+import cypress from 'cypress';
+import { startBackofficeFrontend } from './startBackofficeFrontend';
+import app from '../../../src/apps/backoffice/frontend/app';
+
+async function open() {
+  const server = await startBackofficeFrontend();
+  await openCypress();
+  server.close(() => {
+    process.exit(0);
+  });
+}
+
+async function openCypress() {
+  return cypress.open({
+    config: {
+      supportFile: false,
+      baseUrl: `http://localhost:${app.get('port')}`
+    }
+  });
+}
+
+open();
diff --git a/tests/utils/cypress/plugins/index.ts b/tests/utils/cypress/plugins/index.ts
diff --git a/tests/utils/cypress/run.ts b/tests/utils/cypress/run.ts
diff --git a/tests/utils/cypress/startBackofficeFrontend.ts b/tests/utils/cypress/startBackofficeFrontend.ts
diff --git a/tsconfig.json b/tsconfig.json

Original file line number	Diff line number	Diff line change
`@@ -22,13 +22,9 @@ export class CourseCreator {`
`22`	`22`	`}`
`23`	`23`
`24`	`24`	`async run({ courseId, courseName, courseDuration }: Params): Promise<void> {`
`25`		`- const course = Course.create(`
`26`		`- courseId,`
`27`		`- courseName,`
`28`		`- courseDuration`
`29`		`- );`
	`25`	`+ const course = Course.create(courseId, courseName, courseDuration);`
`30`	`26`
`31`	`27`	`await this.repository.save(course);`
`32`		`- this.eventBus.publish(course.pullDomainEvents());`
	`28`	`+ await this.eventBus.publish(course.pullDomainEvents());`
`33`	`29`	`}`
`34`	`30`	`}`
Original file line number	Diff line number	Diff line change
`@@ -14,7 +14,7 @@ export class CoursesCounterIncrementer {`
`14`	`14`	`counter.increment(courseId);`
`15`	`15`
`16`	`16`	`await this.repository.save(counter);`
`17`		`- this.bus.publish(counter.pullDomainEvents());`
	`17`	`+ await this.bus.publish(counter.pullDomainEvents());`
`18`	`18`	`}`
`19`	`19`	`}`
`20`	`20`