Ghost/test/unit/frontend/services/routing/controllers/collection.test.js
2021-10-19 07:29:09 +13:00

285 lines
9.4 KiB
JavaScript

const errors = require('@tryghost/errors');
const should = require('should');
const sinon = require('sinon');
const testUtils = require('../../../../../utils');
const security = require('@tryghost/security');
const themeEngine = require('../../../../../../core/frontend/services/theme-engine');
const routerManager = require('../../../../../../core/frontend/services/routing/').routerManager;
const controllers = require('../../../../../../core/frontend/services/routing/controllers');
const helpers = require('../../../../../../core/frontend/services/routing/helpers');
function failTest(done) {
return function (err) {
should.exist(err);
done(err);
};
}
describe('Unit - services/routing/controllers/collection', function () {
let req;
let res;
let fetchDataStub;
let secureStub;
let renderStub;
let posts;
let postsPerPage;
let ownsStub;
beforeEach(function () {
postsPerPage = 5;
posts = [
testUtils.DataGenerator.forKnex.createPost()
];
secureStub = sinon.stub();
fetchDataStub = sinon.stub();
renderStub = sinon.stub();
sinon.stub(helpers, 'fetchData').get(function () {
return fetchDataStub;
});
sinon.stub(security.string, 'safe').returns('safe');
sinon.stub(helpers, 'secure').get(function () {
return secureStub;
});
sinon.stub(themeEngine, 'getActive').returns({
updateTemplateOptions: sinon.stub(),
config: function (key) {
key.should.eql('posts_per_page');
return postsPerPage;
}
});
sinon.stub(helpers, 'renderEntries').returns(renderStub);
ownsStub = sinon.stub(routerManager, 'owns');
ownsStub.withArgs('identifier', posts[0].id).returns(true);
req = {
path: '/',
params: {},
route: {}
};
res = {
routerOptions: {
identifier: 'identifier'
},
render: sinon.spy(),
redirect: sinon.spy()
};
});
afterEach(function () {
sinon.restore();
});
it('no params', function (done) {
fetchDataStub.withArgs({page: 1, slug: undefined, limit: postsPerPage}, res.routerOptions)
.resolves({
posts: posts,
meta: {
pagination: {
pages: 5
}
}
});
controllers.collection(req, res, failTest(done)).then(function () {
themeEngine.getActive.calledOnce.should.be.true();
security.string.safe.calledOnce.should.be.false();
fetchDataStub.calledOnce.should.be.true();
secureStub.calledOnce.should.be.true();
ownsStub.calledOnce.should.be.true();
done();
}).catch(done);
});
it('pass page param', function (done) {
req.params.page = 2;
fetchDataStub.withArgs({page: 2, slug: undefined, limit: postsPerPage}, res.routerOptions)
.resolves({
posts: posts,
meta: {
pagination: {
pages: 5
}
}
});
controllers.collection(req, res, failTest(done)).then(function () {
themeEngine.getActive.calledOnce.should.be.true();
security.string.safe.calledOnce.should.be.false();
fetchDataStub.calledOnce.should.be.true();
secureStub.calledOnce.should.be.true();
ownsStub.calledOnce.should.be.true();
done();
}).catch(done);
});
it('update hbs engine: router defines limit', function (done) {
res.routerOptions.limit = 3;
req.params.page = 2;
fetchDataStub.withArgs({page: 2, slug: undefined, limit: 3}, res.routerOptions)
.resolves({
posts: posts,
meta: {
pagination: {
pages: 3
}
}
});
controllers.collection(req, res, failTest(done)).then(function () {
themeEngine.getActive.calledOnce.should.be.true();
themeEngine.getActive().updateTemplateOptions.withArgs({data: {config: {posts_per_page: 3}}}).calledOnce.should.be.true();
security.string.safe.calledOnce.should.be.false();
fetchDataStub.calledOnce.should.be.true();
secureStub.calledOnce.should.be.true();
ownsStub.calledOnce.should.be.true();
done();
}).catch(done);
});
it('page param too big', function (done) {
req.params.page = 6;
fetchDataStub.withArgs({page: 6, slug: undefined, limit: postsPerPage}, res.routerOptions)
.resolves({
posts: posts,
meta: {
pagination: {
pages: 5
}
}
});
controllers.collection(req, res, function (err) {
(err instanceof errors.NotFoundError).should.be.true();
themeEngine.getActive.calledOnce.should.be.true();
security.string.safe.calledOnce.should.be.false();
fetchDataStub.calledOnce.should.be.true();
renderStub.calledOnce.should.be.false();
secureStub.calledOnce.should.be.false();
ownsStub.calledOnce.should.be.false();
done();
});
});
it('slug param', function (done) {
req.params.slug = 'unsafe';
fetchDataStub.withArgs({page: 1, slug: 'safe', limit: postsPerPage}, res.routerOptions)
.resolves({
posts: posts,
meta: {
pagination: {
pages: 5
}
}
});
controllers.collection(req, res, failTest(done)).then(function () {
themeEngine.getActive.calledOnce.should.be.true();
security.string.safe.calledOnce.should.be.true();
fetchDataStub.calledOnce.should.be.true();
secureStub.calledOnce.should.be.true();
ownsStub.calledOnce.should.be.true();
done();
}).catch(done);
});
it('invalid posts per page', function (done) {
postsPerPage = -1;
fetchDataStub.withArgs({page: 1, slug: undefined}, res.routerOptions)
.resolves({
posts: posts,
meta: {
pagination: {
pages: 5
}
}
});
controllers.collection(req, res, failTest(done)).then(function () {
themeEngine.getActive.calledOnce.should.be.true();
security.string.safe.calledOnce.should.be.false();
fetchDataStub.calledOnce.should.be.true();
secureStub.calledOnce.should.be.true();
ownsStub.calledOnce.should.be.true();
done();
}).catch(done);
});
it('ensure secure helper get\'s called for data object', function (done) {
fetchDataStub.withArgs({page: 1, slug: undefined, limit: postsPerPage}, res.routerOptions)
.resolves({
posts: posts,
data: {
tag: [testUtils.DataGenerator.forKnex.createTag()]
},
meta: {
pagination: {
pages: 5
}
}
});
controllers.collection(req, res, failTest(done)).then(function () {
themeEngine.getActive.calledOnce.should.be.true();
security.string.safe.calledOnce.should.be.false();
fetchDataStub.calledOnce.should.be.true();
secureStub.calledTwice.should.be.true();
ownsStub.calledOnce.should.be.true();
done();
}).catch(done);
});
it('should verify if post belongs to collection', function (done) {
posts = [
testUtils.DataGenerator.forKnex.createPost({url: '/a/'}),
testUtils.DataGenerator.forKnex.createPost({url: '/b/'}),
testUtils.DataGenerator.forKnex.createPost({url: '/c/'}),
testUtils.DataGenerator.forKnex.createPost({url: '/d/'})
];
res.routerOptions.filter = 'featured:true';
ownsStub.reset();
ownsStub.withArgs('identifier', posts[0].id).returns(false);
ownsStub.withArgs('identifier', posts[1].id).returns(true);
ownsStub.withArgs('identifier', posts[2].id).returns(false);
ownsStub.withArgs('identifier', posts[3].id).returns(false);
fetchDataStub.withArgs({page: 1, slug: undefined, limit: postsPerPage}, res.routerOptions)
.resolves({
posts: posts,
data: {
tag: [testUtils.DataGenerator.forKnex.createTag()]
},
meta: {
pagination: {
pages: 5
}
}
});
controllers.collection(req, res, failTest(done)).then(function () {
themeEngine.getActive.calledOnce.should.be.true();
security.string.safe.calledOnce.should.be.false();
fetchDataStub.calledOnce.should.be.true();
secureStub.calledTwice.should.be.true();
ownsStub.callCount.should.eql(4);
done();
}).catch(done);
});
});