Ghost/test/unit/models/settings.test.js
Naz 4f78bf01a2 Moved default settings population test to regression suite
closes https://github.com/TryGhost/Team/issues/860
refs 5405b6ca7c

- The slow test was running slow because it's not a "unit test" it is testing much more. Moved it to a correct suite - regression which simplified the logic a lot (no need to mock db calls).
- Brought back the 2000ms limit as the bottleneck has been solved
2021-09-01 15:23:57 +04:00

341 lines
13 KiB
JavaScript

const should = require('should');
const sinon = require('sinon');
const mockDb = require('mock-knex');
const models = require('../../../core/server/models');
const {knex} = require('../../../core/server/data/db');
const events = require('../../../core/server/lib/common/events');
const errors = require('@tryghost/errors');
describe('Unit: models/settings', function () {
before(function () {
models.init();
});
describe('events', function () {
let tracker;
let eventSpy;
beforeEach(function () {
mockDb.mock(knex);
tracker = mockDb.getTracker();
tracker.install();
eventSpy = sinon.spy(events, 'emit');
});
afterEach(function () {
tracker.uninstall();
mockDb.unmock(knex);
sinon.restore();
});
it('emits add events', function () {
tracker.on('query', (query, step) => {
return [
function fetchAddQuery() {
query.response([{}]);
},
function addQuery() {
query.response([{
key: 'description',
value: 'added value'
}]);
}
][step - 1]();
});
return models.Settings.add({
key: 'description',
value: 'added value',
type: 'string'
})
.then(() => {
eventSpy.calledTwice.should.be.true();
eventSpy.firstCall.calledWith('settings.added').should.be.true();
eventSpy.secondCall.calledWith('settings.description.added').should.be.true();
});
});
it('emits edit events', function () {
tracker.on('query', (query, step) => {
if (query.method === 'select') {
return query.response([{
id: 1, // NOTE: `id` imitates existing value for 'edit' event
key: 'description',
value: 'db value'
}]);
}
return query.response([{}]);
});
return models.Settings.edit({
key: 'description',
value: 'edited value'
})
.then(() => {
eventSpy.calledTwice.should.be.true();
eventSpy.firstCall.calledWith('settings.edited').should.be.true();
eventSpy.secondCall.calledWith('settings.description.edited').should.be.true();
});
});
});
describe('format', function () {
it('transforms urls when persisting to db', function () {
const setting = models.Settings.forge();
let returns = setting.formatOnWrite({key: 'cover_image', value: 'http://127.0.0.1:2369/cover_image.png', type: 'string'});
should.equal(returns.value, '__GHOST_URL__/cover_image.png');
returns = setting.formatOnWrite({key: 'logo', value: 'http://127.0.0.1:2369/logo.png', type: 'string'});
should.equal(returns.value, '__GHOST_URL__/logo.png');
returns = setting.formatOnWrite({key: 'icon', value: 'http://127.0.0.1:2369/icon.png', type: 'string'});
should.equal(returns.value, '__GHOST_URL__/icon.png');
returns = setting.formatOnWrite({key: 'portal_button_icon', value: 'http://127.0.0.1:2369/portal_button_icon.png', type: 'string'});
should.equal(returns.value, '__GHOST_URL__/portal_button_icon.png');
returns = setting.formatOnWrite({key: 'og_image', value: 'http://127.0.0.1:2369/og_image.png', type: 'string'});
should.equal(returns.value, '__GHOST_URL__/og_image.png');
returns = setting.formatOnWrite({key: 'twitter_image', value: 'http://127.0.0.1:2369/twitter_image.png', type: 'string'});
should.equal(returns.value, '__GHOST_URL__/twitter_image.png');
});
});
describe('parse', function () {
it('ensure correct parsing when fetching from db', function () {
const setting = models.Settings.forge();
let returns = setting.parse({key: 'is_private', value: 'false', type: 'boolean'});
should.equal(returns.value, false);
returns = setting.parse({key: 'is_private', value: false, type: 'boolean'});
should.equal(returns.value, false);
returns = setting.parse({key: 'is_private', value: true, type: 'boolean'});
should.equal(returns.value, true);
returns = setting.parse({key: 'is_private', value: 'true', type: 'boolean'});
should.equal(returns.value, true);
returns = setting.parse({key: 'is_private', value: '0', type: 'boolean'});
should.equal(returns.value, false);
returns = setting.parse({key: 'is_private', value: '1', type: 'boolean'});
should.equal(returns.value, true);
returns = setting.parse({key: 'something', value: 'null'});
should.equal(returns.value, 'null');
returns = setting.parse({key: 'cover_image', value: '__GHOST_URL__/cover_image.png', type: 'string'});
should.equal(returns.value, 'http://127.0.0.1:2369/cover_image.png');
returns = setting.parse({key: 'logo', value: '__GHOST_URL__/logo.png', type: 'string'});
should.equal(returns.value, 'http://127.0.0.1:2369/logo.png');
returns = setting.parse({key: 'icon', value: '__GHOST_URL__/icon.png', type: 'string'});
should.equal(returns.value, 'http://127.0.0.1:2369/icon.png');
returns = setting.parse({key: 'portal_button_icon', value: '__GHOST_URL__/portal_button_icon.png', type: 'string'});
should.equal(returns.value, 'http://127.0.0.1:2369/portal_button_icon.png');
returns = setting.parse({key: 'og_image', value: '__GHOST_URL__/og_image.png', type: 'string'});
should.equal(returns.value, 'http://127.0.0.1:2369/og_image.png');
returns = setting.parse({key: 'twitter_image', value: '__GHOST_URL__/twitter_image.png', type: 'string'});
should.equal(returns.value, 'http://127.0.0.1:2369/twitter_image.png');
});
});
describe('validation', function () {
async function testInvalidSetting({key, value, type, group}) {
const setting = models.Settings.forge({key, value, type, group});
let error;
try {
await setting.save();
error = null;
} catch (err) {
error = err;
} finally {
should.exist(error, `Setting Model should throw when saving invalid ${key}`);
should.ok(error instanceof errors.ValidationError, 'Setting Model should throw ValidationError');
}
}
async function testValidSetting({key, value, type, group}) {
mockDb.mock(knex);
const tracker = mockDb.getTracker();
tracker.install();
tracker.on('query', (query) => {
query.response();
});
const setting = models.Settings.forge({key, value, type, group});
let error;
try {
await setting.save();
error = null;
} catch (err) {
error = err;
} finally {
tracker.uninstall();
mockDb.unmock(knex);
should.not.exist(error, `Setting Model should not throw when saving valid ${key}`);
}
}
it('throws when stripe_secret_key is invalid', async function () {
await testInvalidSetting({
key: 'stripe_secret_key',
value: 'INVALID STRIPE SECRET KEY',
type: 'string',
group: 'members'
});
});
it('throws when stripe_publishable_key is invalid', async function () {
await testInvalidSetting({
key: 'stripe_publishable_key',
value: 'INVALID STRIPE PUBLISHABLE KEY',
type: 'string',
group: 'members'
});
});
it('does not throw when stripe_secret_key is valid', async function () {
await testValidSetting({
key: 'stripe_secret_key',
value: 'rk_live_abcdefghijklmnopqrstuvwxyz0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ',
type: 'string',
group: 'members'
});
await testValidSetting({
key: 'stripe_secret_key',
value: 'sk_live_abcdefghijklmnopqrstuvwxyz0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ',
type: 'string',
group: 'members'
});
});
it('does not throw when stripe_publishable_key is valid', async function () {
await testValidSetting({
key: 'stripe_publishable_key',
value: 'pk_live_abcdefghijklmnopqrstuvwxyz0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ',
type: 'string',
group: 'members'
});
});
it('throws when stripe_connect_secret_key is invalid', async function () {
await testInvalidSetting({
key: 'stripe_connect_secret_key',
value: 'INVALID STRIPE CONNECT SECRET KEY',
type: 'string',
group: 'members'
});
});
it('throws when stripe_connect_publishable_key is invalid', async function () {
await testInvalidSetting({
key: 'stripe_connect_publishable_key',
value: 'INVALID STRIPE CONNECT PUBLISHABLE KEY',
type: 'string',
group: 'members'
});
});
it('does not throw when stripe_connect_secret_key is valid', async function () {
await testValidSetting({
key: 'stripe_connect_secret_key',
value: 'sk_live_abcdefghijklmnopqrstuvwxyz0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ',
type: 'string',
group: 'members'
});
});
it('does not throw when stripe_connect_publishable_key is valid', async function () {
await testValidSetting({
key: 'stripe_connect_publishable_key',
value: 'pk_live_abcdefghijklmnopqrstuvwxyz0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ',
type: 'string',
group: 'members'
});
});
it('throws when stripe_plans has invalid name', async function () {
await testInvalidSetting({
key: 'stripe_plans',
value: JSON.stringify([{
name: null,
amount: 500,
interval: 'month',
currency: 'usd'
}]),
type: 'string',
group: 'members'
});
});
it('throws when stripe_plans has invalid amount', async function () {
await testInvalidSetting({
key: 'stripe_plans',
value: JSON.stringify([{
name: 'Monthly',
amount: 0,
interval: 'month',
currency: 'usd'
}]),
type: 'string',
group: 'members'
});
});
it('throws when stripe_plans has invalid interval', async function () {
await testInvalidSetting({
key: 'stripe_plans',
value: JSON.stringify([{
name: 'Monthly',
amount: 500,
interval: 'monthly', // should be 'month'
currency: 'usd'
}]),
type: 'string',
group: 'members'
});
});
it('throws when stripe_plans has invalid currency', async function () {
await testInvalidSetting({
key: 'stripe_plans',
value: JSON.stringify([{
name: 'Monthly',
amount: 500,
interval: 'month',
currency: null
}]),
type: 'string',
group: 'members'
});
});
it('does not throw when stripe_plans is valid', async function () {
await testValidSetting({
key: 'stripe_plans',
value: JSON.stringify([{
name: 'Monthly',
amount: 500,
interval: 'month',
currency: 'usd'
}]),
type: 'string',
group: 'members'
});
});
});
});