p5.js-web-editor/server/controllers/project.controller/__test__/getProjectsForUser.test.js
Andrew Nicolaou 37fcf46972 Public API: Create new project (fixes #1095) (#1106)
* Converts import script to use public API endpoints

The endpoints don't exist yet, but this is a good way to see how
the implementation of the data structures differ.

* Exposes public API endpoint to fetch user's sketches

* Implements public API delete endpoint

* Adds helper to create custom ApplicationError classes

* Adds create project endpoint that understand API's data structure

This transforms the nested tree of file data into a mongoose
Project model

* Returns '201 Created' to match API spec

* Removes 'CustomError' variable assignment as it shows up in test output

* transformFiles will return file validation errors

* Tests API project controller

* Tests toModel()

* Creates default files if no root-level .html file is provided

* Do not auto-generate a slug if it is provided

Fixes a bug where the slug was auto-generated using the sketch name,
even if a slug property had been provided.

* Validates uniqueness of slugs for projects created by the public API

* Adds tests for slug uniqueness

* Configures node's Promise implementation for mongoose (fixes warnings)

* Moves createProject tests to match controller location

* Adds support for code to ApplicationErrors

* deleteProject controller tests

* getProjectsForUser controller tests

- implements tests
- update apiKey tests to use new User mocks

* Ensure error objects have consistent property names

`message` is used as a high-level description of the errors
`detail` is optional and has an plain language explanation of the
individual errors
`errors` is an array of each individual problem from `detail` in a
machine-readable format

* Assert environment variables are provided at script start

* Version public API

* Expect "files" property to always be provided

* Fixes linting error

* Converts import script to use public API endpoints

The endpoints don't exist yet, but this is a good way to see how
the implementation of the data structures differ.

* Exposes public API endpoint to fetch user's sketches

* Implements public API delete endpoint

* Adds helper to create custom ApplicationError classes

* Adds create project endpoint that understand API's data structure

This transforms the nested tree of file data into a mongoose
Project model

* Returns '201 Created' to match API spec

* Removes 'CustomError' variable assignment as it shows up in test output

* transformFiles will return file validation errors

* Tests API project controller

* Tests toModel()

* Creates default files if no root-level .html file is provided

* Do not auto-generate a slug if it is provided

Fixes a bug where the slug was auto-generated using the sketch name,
even if a slug property had been provided.

* Validates uniqueness of slugs for projects created by the public API

* Adds tests for slug uniqueness

* Configures node's Promise implementation for mongoose (fixes warnings)

* Moves createProject tests to match controller location

* deleteProject controller tests

* Adds support for code to ApplicationErrors

* getProjectsForUser controller tests

- implements tests
- update apiKey tests to use new User mocks

* Ensure error objects have consistent property names

`message` is used as a high-level description of the errors
`detail` is optional and has an plain language explanation of the
individual errors
`errors` is an array of each individual problem from `detail` in a
machine-readable format

* Assert environment variables are provided at script start

* Version public API

* Expect "files" property to always be provided

* Fixes linting error

* Checks that authenticated user has permission to create under this namespace

Previously, the project was always created under the authenticated user's
namespace, but this not obvious behaviour.
2019-09-08 16:45:58 +02:00

151 lines
4.1 KiB
JavaScript

/**
* @jest-environment node
*/
import { Request, Response } from 'jest-express';
import { createMock } from '../../../models/user';
import getProjectsForUser, { apiGetProjectsForUser } from '../../project.controller/getProjectsForUser';
jest.mock('../../../models/user');
jest.mock('../../aws.controller');
describe('project.controller', () => {
let UserMock;
beforeEach(() => {
UserMock = createMock();
});
afterEach(() => {
UserMock.restore();
});
describe('getProjectsForUser()', () => {
it('returns empty array user not supplied as parameter', (done) => {
const request = new Request();
request.setParams({});
const response = new Response();
const promise = getProjectsForUser(request, response);
function expectations() {
expect(response.status).toHaveBeenCalledWith(200);
expect(response.json).toHaveBeenCalledWith([]);
done();
}
promise.then(expectations, expectations).catch(expectations);
});
it('returns 404 if user does not exist', (done) => {
const request = new Request();
request.setParams({ username: 'abc123' });
const response = new Response();
UserMock
.expects('findOne')
.withArgs({ username: 'abc123' })
.yields(null, null);
const promise = getProjectsForUser(request, response);
function expectations() {
expect(response.status).toHaveBeenCalledWith(404);
expect(response.json).toHaveBeenCalledWith({ message: 'User with that username does not exist.' });
done();
}
promise.then(expectations, expectations).catch(expectations);
});
it('returns 500 on other errors', (done) => {
const request = new Request();
request.setParams({ username: 'abc123' });
const response = new Response();
UserMock
.expects('findOne')
.withArgs({ username: 'abc123' })
.yields(new Error(), null);
const promise = getProjectsForUser(request, response);
function expectations() {
expect(response.status).toHaveBeenCalledWith(500);
expect(response.json).toHaveBeenCalledWith({ message: 'Error fetching projects' });
done();
}
promise.then(expectations, expectations).catch(expectations);
});
});
describe('apiGetProjectsForUser()', () => {
it('returns validation error if user id not provided', (done) => {
const request = new Request();
request.setParams({});
const response = new Response();
const promise = apiGetProjectsForUser(request, response);
function expectations() {
expect(response.status).toHaveBeenCalledWith(422);
expect(response.json).toHaveBeenCalledWith({
message: 'Username not provided'
});
done();
}
promise.then(expectations, expectations).catch(expectations);
});
it('returns 404 if user does not exist', (done) => {
const request = new Request();
request.setParams({ username: 'abc123' });
const response = new Response();
UserMock
.expects('findOne')
.withArgs({ username: 'abc123' })
.yields(null, null);
const promise = apiGetProjectsForUser(request, response);
function expectations() {
expect(response.status).toHaveBeenCalledWith(404);
expect(response.json).toHaveBeenCalledWith({ message: 'User with that username does not exist.' });
done();
}
promise.then(expectations, expectations).catch(expectations);
});
it('returns 500 on other errors', (done) => {
const request = new Request();
request.setParams({ username: 'abc123' });
const response = new Response();
UserMock
.expects('findOne')
.withArgs({ username: 'abc123' })
.yields(new Error(), null);
const promise = apiGetProjectsForUser(request, response);
function expectations() {
expect(response.status).toHaveBeenCalledWith(500);
expect(response.json).toHaveBeenCalledWith({ message: 'Error fetching projects' });
done();
}
promise.then(expectations, expectations).catch(expectations);
});
});
});