/
channels_spec.js
393 lines (324 loc) · 13.8 KB
/
channels_spec.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
var should = require('should'),
sinon = require('sinon'),
Promise = require('bluebird'),
_ = require('lodash'),
// Stuff we are testing
channels = require('../../../../server/controllers/frontend/channels'),
api = require('../../../../server/api'),
themes = require('../../../../server/themes'),
sandbox = sinon.sandbox.create();
describe('Channels', function () {
var channelRouter, req, res, hasTemplateStub, themeConfigStub;
// Initialise 'req' with the bare minimum properties
function setupRequest() {
req = {
method: 'get'
};
}
// Prevent unit tests from failing via timeout when they should just immediately fail
function failTest(done) {
return function (err) {
done(err || 'Next was called with no Error');
};
}
// Run a test which should result in a render
function testChannelRender(props, assertions, done) {
res = {
redirect: sandbox.spy()
};
res.render = function (view) {
assertions(view);
res.redirect.called.should.be.false();
done();
};
_.extend(req, props);
channelRouter(req, res, failTest(done));
}
// Run a test which should result in a redirect
function testChannelRedirect(props, assertions, done) {
res = {
render: sandbox.spy(),
set: sandbox.spy()
};
res.redirect = function (status, path) {
assertions(status, path);
res.render.called.should.be.false();
done();
};
_.extend(req, props);
channelRouter(req, res, failTest(done));
}
// Run a test which should result in next() being called
function testChannelNext(props, assertions, done) {
res = {
redirect: sandbox.spy(),
render: sandbox.spy(),
set: sandbox.spy()
};
_.extend(req, props);
channelRouter(req, res, function (empty) {
assertions(empty);
res.redirect.called.should.be.false();
res.render.called.should.be.false();
done();
});
}
// Run a test which results in next being called with an error
function testChannelError(props, assertions, done) {
testChannelNext(props, function (error) {
should.exist(error);
assertions(error);
}, done);
}
// Run a test which results in an explicit 404
function testChannel404(props, done) {
testChannelError(props, function (error) {
error.errorType.should.eql('NotFoundError');
error.statusCode.should.eql(404);
}, done);
}
// Ensure hasTemplate returns values
function setupActiveTheme() {
hasTemplateStub = sandbox.stub().returns(false);
hasTemplateStub.withArgs('index').returns(true);
themeConfigStub = sandbox.stub().withArgs('posts_per_page').returns(5);
sandbox.stub(themes, 'getActive').returns({
hasTemplate: hasTemplateStub,
config: themeConfigStub
});
}
before(function () {
// We don't overwrite this, so only do it once
channelRouter = channels.router();
});
afterEach(function () {
sandbox.restore();
});
describe('Index', function () {
var postAPIStub;
// Stub the posts api
function setupPostsAPIStub() {
postAPIStub = sandbox.stub(api.posts, 'browse', function () {
return Promise.resolve({posts: [{}], meta: {pagination: {pages: 3}}});
});
}
beforeEach(function () {
// Setup Env for tests
setupPostsAPIStub();
setupActiveTheme();
setupRequest();
});
it('should render the first page of the index channel', function (done) {
testChannelRender({url: '/'}, function (view) {
should.exist(view);
view.should.eql('index');
postAPIStub.calledOnce.should.be.true();
}, done);
});
it('should render the first page of the index channel using home.hbs if available', function (done) {
hasTemplateStub.withArgs('home').returns(true);
testChannelRender({url: '/'}, function (view) {
should.exist(view);
view.should.eql('home');
postAPIStub.calledOnce.should.be.true();
}, done);
});
describe('Paged', function () {
it('should render the second page of the index channel', function (done) {
testChannelRender({url: '/page/2/'}, function (view) {
should.exist(view);
view.should.eql('index');
postAPIStub.calledOnce.should.be.true();
}, done);
});
it('should use index.hbs for second page even if home.hbs is available', function (done) {
testChannelRender({url: '/page/2/'}, function (view) {
should.exist(view);
view.should.eql('index');
postAPIStub.calledOnce.should.be.true();
}, done);
});
it('should render the third page of the index channel', function (done) {
testChannelRender({url: '/page/3/'}, function (view) {
should.exist(view);
view.should.eql('index');
postAPIStub.calledOnce.should.be.true();
}, done);
});
it('should redirect /page/1/ to /', function (done) {
testChannelRedirect({url: '/page/1/'}, function (status, path) {
status.should.eql(301);
path.should.eql('/');
res.set.called.should.be.true();
postAPIStub.called.should.be.false();
}, done);
});
it('should 404 for /page/0/', function (done) {
testChannel404({url: '/page/0/'}, done);
});
it('should 404 for /page/4/', function (done) {
testChannel404({url: '/page/4/'}, done);
});
});
describe('RSS', function () {
it('should redirect /feed/ to /rss/', function (done) {
testChannelRedirect({url: '/feed/'}, function (status, path) {
status.should.eql(301);
path.should.eql('/rss/');
res.set.called.should.be.true();
postAPIStub.called.should.be.false();
}, done);
});
it('should redirect /rss/1/ to /rss/', function (done) {
testChannelRedirect({url: '/rss/1/'}, function (status, path) {
status.should.eql(301);
path.should.eql('/rss/');
res.set.called.should.be.true();
postAPIStub.called.should.be.false();
}, done);
});
it('should 404 for /rss/0/', function (done) {
testChannel404({url: '/rss/0/'}, done);
});
it('should 404 for /rss/4/', function (done) {
testChannel404({url: '/rss/4/'}, done);
});
});
describe('Edit', function () {
it('should NOT redirect /edit/, should pass through', function (done) {
testChannelNext({url: '/edit/'}, done);
});
});
});
describe('Tag', function () {
var postAPIStub, tagAPIStub;
// Stub the posts and tags api
function setupAPIStubs() {
postAPIStub = sandbox.stub(api.posts, 'browse', function () {
return Promise.resolve({posts: [{}], meta: {pagination: {pages: 3}}});
});
tagAPIStub = sandbox.stub(api.tags, 'read', function () {
return Promise.resolve({tags: [{}]});
});
}
beforeEach(function () {
// Setup Env for tests
setupAPIStubs();
setupActiveTheme();
setupRequest();
});
it('should render the first page of the tag channel using index.hbs by default', function (done) {
testChannelRender({url: '/tag/my-tag/'}, function (view) {
should.exist(view);
view.should.eql('index');
postAPIStub.calledOnce.should.be.true();
tagAPIStub.calledOnce.should.be.true();
}, done);
});
it('should render the first page of the tag channel using tag.hbs by default', function (done) {
hasTemplateStub.withArgs('tag').returns(true);
testChannelRender({url: '/tag/my-tag/'}, function (view) {
should.exist(view);
view.should.eql('tag');
postAPIStub.calledOnce.should.be.true();
tagAPIStub.calledOnce.should.be.true();
}, done);
});
it('should render the first page of the tag channel using tag-:slug.hbs if available', function (done) {
hasTemplateStub.withArgs('tag').returns(true);
hasTemplateStub.withArgs('tag-my-tag').returns(true);
testChannelRender({url: '/tag/my-tag/'}, function (view) {
should.exist(view);
view.should.eql('tag-my-tag');
postAPIStub.calledOnce.should.be.true();
tagAPIStub.calledOnce.should.be.true();
}, done);
});
describe('Paged', function () {
it('should render the second page of the tag channel', function (done) {
testChannelRender({url: '/tag/my-tag/page/2/'}, function (view) {
should.exist(view);
view.should.eql('index');
postAPIStub.calledOnce.should.be.true();
}, done);
});
it('should use tag.hbs to render the tag channel if available', function (done) {
hasTemplateStub.withArgs('tag').returns(true);
testChannelRender({url: '/tag/my-tag/page/2/'}, function (view) {
should.exist(view);
view.should.eql('tag');
postAPIStub.calledOnce.should.be.true();
}, done);
});
it('should use tag-:slug.hbs to render the tag channel if available', function (done) {
hasTemplateStub.withArgs('tag').returns(true);
hasTemplateStub.withArgs('tag-my-tag').returns(true);
testChannelRender({url: '/tag/my-tag/page/2/'}, function (view) {
should.exist(view);
view.should.eql('tag-my-tag');
postAPIStub.calledOnce.should.be.true();
}, done);
});
it('should render the second page of the tag channel', function (done) {
testChannelRender({url: '/tag/my-tag/page/2/'}, function (view) {
should.exist(view);
view.should.eql('index');
postAPIStub.calledOnce.should.be.true();
}, done);
});
it('should render the third page of the tag channel', function (done) {
testChannelRender({url: '/tag/my-tag/page/3/'}, function (view) {
should.exist(view);
view.should.eql('index');
postAPIStub.calledOnce.should.be.true();
}, done);
});
it('should redirect /tag/my-tag/page/1/ to /tag/my-tag/', function (done) {
testChannelRedirect({url: '/tag/my-tag/page/1/'}, function (status, path) {
status.should.eql(301);
path.should.eql('/tag/my-tag/');
res.set.called.should.be.true();
postAPIStub.called.should.be.false();
}, done);
});
it('should 404 for /tag/my-tag/page/0/', function (done) {
testChannel404({url: '/tag/my-tag/page/0/'}, done);
});
it('should 404 for /tag/my-tag/page/4/', function (done) {
testChannel404({url: '/tag/my-tag/page/4/'}, done);
});
});
describe('RSS', function () {
it('should redirect /tag/my-tag/feed/ to /tag/my-tag/rss/', function (done) {
testChannelRedirect({url: '/tag/my-tag/feed/'}, function (status, path) {
status.should.eql(301);
path.should.eql('/tag/my-tag/rss/');
res.set.called.should.be.true();
postAPIStub.called.should.be.false();
}, done);
});
it('should redirect /tag/my-tag/rss/1/ to /tag/my-tag/rss/', function (done) {
testChannelRedirect({url: '/tag/my-tag/rss/1/'}, function (status, path) {
status.should.eql(301);
path.should.eql('/tag/my-tag/rss/');
res.set.called.should.be.true();
postAPIStub.called.should.be.false();
}, done);
});
it('should 404 for /tag/my-tag/rss/0/', function (done) {
testChannel404({url: '/tag/my-tag/rss/0/'}, done);
});
it('should 404 for /tag/my-tag/rss/4/', function (done) {
testChannel404({url: '/tag/my-tag/rss/4/'}, done);
});
});
describe('Edit', function () {
it('should redirect /edit/ to ghost admin', function (done) {
testChannelRedirect({url: '/tag/my-tag/edit/'}, function (path) {
path.should.eql('/ghost/#/settings/tags/my-tag/');
postAPIStub.called.should.be.false();
}, done);
});
});
});
});