Ghost/test/unit/services/rss/generate-feed.test.js
Hannah Wolfe f08a55c21f
Renamed tests to .test.js & updated commands
refs: https://github.com/TryGhost/Team/issues/856
refs: https://github.com/TryGhost/Team/issues/756

- The .test.js extension is better than _spec.js as it's more obvious that it's an extension
- It also meaans we can use the --extension parameter in mocha, which should result in a better default behaviour for `yarn test`
- It also highlights that some of our tests were named incorrectly and were not (and still will not be) run (see https://github.com/TryGhost/Team/issues/856)
- Note: even with this change, `yarn test` is throwing errors, I believe because of this issue https://github.com/TryGhost/Team/issues/756
2021-07-06 20:45:01 +01:00

244 lines
11 KiB
JavaScript

const should = require('should');
const sinon = require('sinon');
const _ = require('lodash');
const testUtils = require('../../../utils');
const configUtils = require('../../../utils/configUtils');
const urlService = require('../../../../core/frontend/services/url');
const generateFeed = require('../../../../core/frontend/services/rss/generate-feed');
describe('RSS: Generate Feed', function () {
const data = {};
let baseUrl;
// Static set of posts
let posts;
before(function () {
posts = _.cloneDeep(testUtils.DataGenerator.forKnex.posts);
posts = _.filter(posts, function filter(post) {
return post.status === 'published' && post.type === 'post';
});
posts[2].meta_description = 'test stuffs';
_.each(posts, function (post) {
post.url = '/' + post.slug + '/';
post.primary_author = {name: 'Joe Bloggs'};
// data is from fixtures that are inserted directly into the database via knex
// that means it has raw __GHOST_URL__ values that would typically be modified by the model layer
// we're not using the model layer here so we need to transform manually
Object.entries(post).forEach(([key, value]) => {
if (value && typeof value === 'string') {
post[key] = value.replace(/__GHOST_URL__/g, 'http://my-ghost-blog.com');
}
});
});
});
afterEach(function () {
sinon.restore();
configUtils.restore();
});
beforeEach(function () {
sinon.stub(urlService, 'getUrlByResourceId');
baseUrl = '/rss/';
data.safeVersion = '0.6';
data.title = 'Test Title';
data.description = 'Testing Desc';
data.meta = {pagination: {pages: 1}};
});
describe('without subdirectory', function () {
beforeEach(function () {
configUtils.set({url: 'http://my-ghost-blog.com'});
});
it('should get the RSS tags correct', function (done) {
data.posts = [];
generateFeed(baseUrl, data).then(function (xmlData) {
should.exist(xmlData);
// xml & rss tags
xmlData.should.match(/^<\?xml version="1.0" encoding="UTF-8"\?>/);
xmlData.should.match(/<rss/);
xmlData.should.match(/xmlns:dc="http:\/\/purl.org\/dc\/elements\/1.1\/"/);
xmlData.should.match(/xmlns:content="http:\/\/purl.org\/rss\/1.0\/modules\/content\/"/);
xmlData.should.match(/xmlns:atom="http:\/\/www.w3.org\/2005\/Atom"/);
xmlData.should.match(/version="2.0"/);
xmlData.should.match(/xmlns:media="http:\/\/search.yahoo.com\/mrss\/"/);
// channel tags
xmlData.should.match(/<channel><title><!\[CDATA\[Test Title\]\]><\/title>/);
xmlData.should.match(/<description><!\[CDATA\[Testing Desc\]\]><\/description>/);
xmlData.should.match(/<link>http:\/\/my-ghost-blog.com\/<\/link>/);
xmlData.should.match(/<image><url>http:\/\/my-ghost-blog.com\/favicon.png<\/url><title>Test Title<\/title><link>http:\/\/my-ghost-blog.com\/<\/link><\/image>/);
xmlData.should.match(/<generator>Ghost 0.6<\/generator>/);
xmlData.should.match(/<lastBuildDate>.*?<\/lastBuildDate>/);
xmlData.should.match(/<atom:link href="http:\/\/my-ghost-blog.com\/rss\/" rel="self"/);
xmlData.should.match(/type="application\/rss\+xml"\/><ttl>60<\/ttl>/);
xmlData.should.match(/<\/channel><\/rss>$/);
done();
}).catch(done);
});
it('should get the item tags correct', function (done) {
data.posts = posts;
_.each(data.posts, function (post) {
urlService.getUrlByResourceId.withArgs(post.id, {secure: undefined, absolute: true}).returns('http://my-ghost-blog.com/' + post.slug + '/');
});
generateFeed(baseUrl, data).then(function (xmlData) {
should.exist(xmlData);
// item tags
xmlData.should.match(/<item><title><!\[CDATA\[HTML Ipsum\]\]><\/title>/);
xmlData.should.match(/<description><!\[CDATA\[<h1>HTML Ipsum Presents<\/h1>/);
xmlData.should.match(/<link>http:\/\/my-ghost-blog.com\/html-ipsum\/<\/link>/);
xmlData.should.match(/<image><url>http:\/\/my-ghost-blog.com\/favicon.png<\/url><title>Test Title<\/title><link>http:\/\/my-ghost-blog.com\/<\/link><\/image>/);
xmlData.should.match(/<guid isPermaLink="false">/);
xmlData.should.match(/<\/guid><dc:creator><!\[CDATA\[Joe Bloggs\]\]><\/dc:creator>/);
xmlData.should.match(/<pubDate>Thu, 01 Jan 2015/);
xmlData.should.match(/<content:encoded><!\[CDATA\[<h1>HTML Ipsum Presents<\/h1>/);
xmlData.should.match(/<\/code><\/pre>\]\]><\/content:encoded><\/item>/);
xmlData.should.not.match(/<author>/);
// basic structure check
const postEnd = '<\/code><\/pre>\]\]><\/content:encoded>';
const firstIndex = xmlData.indexOf(postEnd);
// The first title should be before the first content
xmlData.indexOf('HTML Ipsum').should.be.below(firstIndex);
// The second title should be after the first content
xmlData.indexOf('Ghostly Kitchen Sink').should.be.above(firstIndex);
done();
}).catch(done);
});
it('should only return visible tags', function (done) {
const postWithTags = posts[2];
postWithTags.tags = [
{name: 'public', visibility: 'public'},
{name: 'internal', visibility: 'internal'},
{name: 'visibility'}
];
data.posts = [postWithTags];
generateFeed(baseUrl, data).then(function (xmlData) {
should.exist(xmlData);
// item tags
xmlData.should.match(/<title><!\[CDATA\[Short and Sweet\]\]>/);
xmlData.should.match(/<description><!\[CDATA\[test stuff/);
xmlData.should.match(/<content:encoded><!\[CDATA\[<!--kg-card-begin: markdown--><h2 id="testing">testing<\/h2>\n/);
xmlData.should.match(/<img src="http:\/\/placekitten.com\/500\/200"/);
xmlData.should.match(/<media:content url="http:\/\/placekitten.com\/500\/200" medium="image"\/>/);
xmlData.should.match(/<category><!\[CDATA\[public\]\]/);
xmlData.should.match(/<category><!\[CDATA\[visibility\]\]/);
xmlData.should.not.match(/<category><!\[CDATA\[internal\]\]/);
done();
}).catch(done);
});
it('should not error if author is somehow not present', function (done) {
data.posts = [_.omit(posts[2], 'primary_author')];
generateFeed(baseUrl, data).then(function (xmlData) {
should.exist(xmlData);
// special/optional tags
xmlData.should.match(/<title><!\[CDATA\[Short and Sweet\]\]>/);
xmlData.should.match(/<description><!\[CDATA\[test stuff/);
xmlData.should.match(/<content:encoded><!\[CDATA\[<!--kg-card-begin: markdown--><h2 id="testing">testing<\/h2>\n/);
xmlData.should.match(/<img src="http:\/\/placekitten.com\/500\/200"/);
xmlData.should.match(/<media:content url="http:\/\/placekitten.com\/500\/200" medium="image"\/>/);
xmlData.should.not.match(/<dc:creator>/);
done();
}).catch(done);
});
it('should not error if post content is null', function (done) {
data.posts = [Object.assign({}, posts[2], {html: null})];
generateFeed(baseUrl, data).then(function (xmlData) {
should.exist(xmlData);
// special/optional tags
xmlData.should.match(/<title><!\[CDATA\[Short and Sweet\]\]>/);
xmlData.should.match(/<description><!\[CDATA\[test stuff/);
xmlData.should.match(/<content:encoded\/>/);
xmlData.should.match(/<media:content url="http:\/\/placekitten.com\/500\/200" medium="image"\/>/);
xmlData.should.match(/<dc:creator>/);
done();
}).catch(done);
});
it('should use meta_description and image where available', function (done) {
data.posts = [posts[2]];
generateFeed(baseUrl, data).then(function (xmlData) {
should.exist(xmlData);
// special/optional tags
xmlData.should.match(/<title><!\[CDATA\[Short and Sweet\]\]>/);
xmlData.should.match(/<description><!\[CDATA\[test stuff/);
xmlData.should.match(/<content:encoded><!\[CDATA\[<!--kg-card-begin: markdown--><h2 id="testing">testing<\/h2>\n/);
xmlData.should.match(/<img src="http:\/\/placekitten.com\/500\/200"/);
xmlData.should.match(/<media:content url="http:\/\/placekitten.com\/500\/200" medium="image"\/>/);
done();
}).catch(done);
});
it('should use excerpt when no meta_description is set', function (done) {
data.posts = [posts[0]];
_.each(data.posts, function (post) {
urlService.getUrlByResourceId.withArgs(post.id, {secure: undefined, absolute: true}).returns('http://my-ghost-blog.com/' + post.slug + '/');
});
generateFeed(baseUrl, data).then(function (xmlData) {
should.exist(xmlData);
// special/optional tags
xmlData.should.match(/<title><!\[CDATA\[HTML Ipsum\]\]>/);
xmlData.should.match(/<description><!\[CDATA\[This is my custom excerpt!/);
done();
}).catch(done);
});
it('should process urls correctly', function (done) {
data.posts = [posts[3]];
generateFeed(baseUrl, data).then(function (xmlData) {
should.exist(xmlData);
// anchor URL - <a href="#nowhere" title="Anchor URL">
xmlData.should.match(/<a href="#nowhere" title="Anchor URL">/);
// relative URL - <a href="/about#nowhere" title="Relative URL">
xmlData.should.match(/<a href="http:\/\/my-ghost-blog.com\/about#nowhere" title="Relative URL">/);
// protocol relative URL - <a href="//somewhere.com/link#nowhere" title="Protocol Relative URL">
xmlData.should.match(/<a href="\/\/somewhere.com\/link#nowhere" title="Protocol Relative URL">/);
// absolute URL - <a href="http://somewhere.com/link#nowhere" title="Absolute URL">
xmlData.should.match(/<a href="http:\/\/somewhere.com\/link#nowhere" title="Absolute URL">/);
done();
}).catch(done);
});
});
});