Tests API project controller

Author: andrewn

server/controllers/__test__/project.controller.test.js

@@ -2,9 +2,10 @@
  * @jest-environment node
  */
 import { Response } from 'jest-express';
+import sinon from 'sinon';
 
-import { createMock } from '../../models/project';
-import createProject from '../project.controller/createProject';
+import Project, { createMock, createInstanceMock } from '../../models/project';
+import createProject, { apiCreateProject } from '../project.controller/createProject';
 
 jest.mock('../../models/project');
 
@@ -152,4 +153,119 @@ describe('project.controller', () => {
       promise.then(expectations, expectations).catch(expectations);
     });
   });
+
+  describe('apiCreateProject()', () => {
+    let ProjectMock;
+    let ProjectInstanceMock;
+
+    beforeEach(() => {
+      ProjectMock = createMock();
+      ProjectInstanceMock = createInstanceMock();
+    });
+
+    afterEach(() => {
+      ProjectMock.restore();
+      ProjectInstanceMock.restore();
+    });
+
+    it('returns 201 with id of created sketch', (done) => {
+      const request = {
+        user: { _id: 'abc123' },
+        body: {
+          name: 'My sketch',
+          files: {}
+        }
+      };
+      const response = new Response();
+
+      const result = {
+        _id: 'abc123',
+        id: 'abc123',
+        name: 'Project name',
+        serveSecure: false,
+        files: []
+      };
+
+      ProjectInstanceMock.expects('save')
+        .resolves(new Project(result));
+
+      const promise = apiCreateProject(request, response);
+
+      function expectations() {
+        const doc = response.json.mock.calls[0][0];
+
+        expect(response.status).toHaveBeenCalledWith(201);
+        expect(response.json).toHaveBeenCalled();
+
+        expect(JSON.parse(JSON.stringify(doc))).toMatchObject({
+          id: 'abc123'
+        });
+
+        done();
+      }
+
+      promise.then(expectations, expectations).catch(expectations);
+    });
+
+    it('returns validation errors on files input', (done) => {
+      const request = {
+        user: {},
+        body: {
+          name: 'My sketch',
+          files: {
+            'index.html': {
+              // missing content or url
+            }
+          }
+        }
+      };
+      const response = new Response();
+
+      const promise = apiCreateProject(request, response);
+
+      function expectations() {
+        const doc = response.json.mock.calls[0][0];
+
+        const responseBody = JSON.parse(JSON.stringify(doc));
+
+        expect(response.status).toHaveBeenCalledWith(422);
+        expect(responseBody.name).toBe('File Validation Failed');
+        expect(responseBody.errors.length).toBe(1);
+        expect(responseBody.errors).toEqual([
+          { name: 'index.html', message: 'missing \'url\' or \'content\'' }
+        ]);
+
+        done();
+      }
+
+      promise.then(expectations, expectations).catch(expectations);
+    });
+
+    it('rejects file parameters not in object format', (done) => {
+      const request = {
+        user: { _id: 'abc123' },
+        body: {
+          name: 'Wriggly worm',
+          files: [{ name: 'file.js', content: 'var hello = true;' }]
+        }
+      };
+      const response = new Response();
+
+      const promise = apiCreateProject(request, response);
+
+      function expectations() {
+        const doc = response.json.mock.calls[0][0];
+
+        const responseBody = JSON.parse(JSON.stringify(doc));
+
+        expect(response.status).toHaveBeenCalledWith(422);
+        expect(responseBody.name).toBe('File Validation Failed');
+        expect(responseBody.message).toBe('\'files\' must be an object');
+
+        done();
+      }
+
+      promise.then(expectations, expectations).catch(expectations);
+    });
+  });
 });

server/controllers/project.controller/createProject.js

@@ -1,5 +1,5 @@
 import Project from '../../models/project';
-import { toModel } from '../../domain-objects/Project';
+import { toModel, FileValidationError } from '../../domain-objects/Project';
 
 export default function createProject(req, res) {
   let projectValues = {
@@ -36,22 +36,35 @@ export default function createProject(req, res) {
 export function apiCreateProject(req, res) {
   const params = Object.assign({ user: req.user._id }, req.body);
 
+  function sendValidationErrors(err) {
+    res.status(422).json({
+      name: 'File Validation Failed',
+      message: err.message,
+      errors: err.files,
+    });
+  }
+
   // TODO: Error handling to match spec
   function sendFailure() {
-    res.json({ success: false });
+    res.status(500).json({ success: false });
   }
 
   try {
     const model = toModel(params);
 
-    model
+    return model
       .save()
       .then((newProject) => {
         res.status(201).json({ id: newProject.id });
       })
       .catch(sendFailure);
   } catch (err) {
-    // TODO: Catch custom err object and return correct status code
-    res.status(422).json({ error: 'Validation error' });
+    if (err instanceof FileValidationError) {
+      sendValidationErrors(err);
+    } else {
+      sendFailure();
+    }
+
+    return Promise.reject();
   }
 }

server/domain-objects/Project.js

@@ -1,3 +1,4 @@
+import isPlainObject from 'lodash/isPlainObject';
 import pick from 'lodash/pick';
 import Project from '../models/project';
 import createId from '../utils/createId';
@@ -110,8 +111,10 @@ export function transformFiles(tree = {}) {
 export function toModel(object) {
   let files = [];
 
-  if (typeof object.files === 'object') {
+  if (isPlainObject(object.files)) {
     files = transformFiles(object.files);
+  } else if (object.files != null) {
+    throw new FileValidationError('\'files\' must be an object');
   }
 
   const projectValues = pick(object, ['user', 'name', 'slug']);

server/models/__mocks__/project.js

@@ -11,6 +11,19 @@ export function createMock() {
   return sinon.mock(Project);
 }
 
+// Wraps the Project.prototype i.e. the
+// instance methods in a mock so
+// Project.save() can be mocked
+export function createInstanceMock() {
+  // See: https://stackoverflow.com/questions/40962960/sinon-mock-of-mongoose-save-method-for-all-future-instances-of-a-model-with-pro
+  Object.defineProperty(Project.prototype, 'save', {
+    value: Project.prototype.save,
+    configurable: true,
+  });
+
+  return sinon.mock(Project.prototype);
+}
+
 // Re-export the model, it will be
 // altered by mockingoose whenever
 // we call methods on the MockConfig