Ghost/test/unit/server/web/api/middleware/version-match.test.js
Hannah Wolfe 9e96b04542
Moved server unit tests into the server folder
- this is a small part of a bit of cleanup of our test files
- the goal is to make the existing tests clearer with a view to making it easier to write more tests
- this makes the test structure follow the codebase structure more closely
- eventually we will colocate the tests as we break the codebase down further
2021-10-06 12:01:09 +01:00

126 lines
3.8 KiB
JavaScript

const should = require('should');
const sinon = require('sinon');
const versionMatch = require('../../../../../../core/server/web/api/middleware/version-match');
describe('Version Mismatch', function () {
let req;
let res;
let getStub;
let nextStub;
afterEach(function () {
sinon.restore();
});
beforeEach(function () {
getStub = sinon.stub();
nextStub = sinon.stub();
req = {
get: getStub
};
res = {
locals: {}
};
});
function testVersionMatch(serverVersion, clientVersion) {
// Set the server version
res.locals.version = serverVersion;
if (clientVersion) {
// Optionally set the client version
getStub.returns(clientVersion);
}
versionMatch(req, res, nextStub);
}
it('should call next if request does not include a version', function () {
const server = '1.5.1';
testVersionMatch(server);
nextStub.calledOnce.should.be.true();
nextStub.firstCall.args.should.be.empty();
});
it('should call next if versions are an exact match', function () {
const server = '1.5.0';
const client = '1.5';
testVersionMatch(server, client);
nextStub.calledOnce.should.be.true();
nextStub.firstCall.args.should.be.empty();
});
it('should call next if client version is earlier than server', function () {
const server = '1.5.0';
const client = '1.3';
testVersionMatch(server, client);
nextStub.calledOnce.should.be.true();
nextStub.firstCall.args.should.be.empty();
});
it('should throw VersionMismatchError if client version is earlier by a major version', function () {
const server = '2.5.0';
const client = '1.3';
testVersionMatch(server, client);
nextStub.calledOnce.should.be.true();
nextStub.firstCall.args.should.have.lengthOf(1);
nextStub.firstCall.args[0].should.have.property('errorType', 'VersionMismatchError');
nextStub.firstCall.args[0].should.have.property('statusCode', 400);
});
it('should throw VersionMismatchError if client version is later than server', function () {
const server = '1.3.0';
const client = '1.5';
testVersionMatch(server, client);
nextStub.calledOnce.should.be.true();
nextStub.firstCall.args.should.have.lengthOf(1);
nextStub.firstCall.args[0].should.have.property('errorType', 'VersionMismatchError');
nextStub.firstCall.args[0].should.have.property('statusCode', 400);
});
it('should throw VersionMismatchError if client version is later by a major version', function () {
const server = '1.5.0';
const client = '2.3';
testVersionMatch(server, client);
nextStub.calledOnce.should.be.true();
nextStub.firstCall.args.should.have.lengthOf(1);
nextStub.firstCall.args[0].should.have.property('errorType', 'VersionMismatchError');
nextStub.firstCall.args[0].should.have.property('statusCode', 400);
});
it('should call next if pre-release is allowed', function () {
const server = '1.5.0-pre';
const client = '1.4';
testVersionMatch(server, client);
nextStub.calledOnce.should.be.true();
nextStub.firstCall.args.should.be.empty();
});
it('throws error if server is a pre-release, but later by major version', function () {
const server = '2.0.0-alpha';
const client = '1.5';
testVersionMatch(server, client);
nextStub.calledOnce.should.be.true();
nextStub.firstCall.args.should.have.lengthOf(1);
nextStub.firstCall.args[0].should.have.property('errorType', 'VersionMismatchError');
nextStub.firstCall.args[0].should.have.property('statusCode', 400);
});
});