mirror of
https://github.com/TryGhost/Ghost.git
synced 2025-02-10 23:36:14 -05:00
99a2f12cb7
refs https://linear.app/tryghost/issue/CORE-35/refactor-route-and-redirect-settings
refs 5715aa2155 (diff-48644be82a9b957e5e627bf7b0f2f73cdb1d63851ffad68c7c178c5886495bb8R52-R57)
- Simplified the yaml parser implementation to take in a single parameter, this move will allove to simplify the logic in the route settings + opens a door to unify handling with redirects yaml parsing!
- We loose the "filename" from the error information but that was a generic "routes.yaml" anyway and would be thrown only when somebody uploaded a routes.yaml file (no real added value).
- The debug statement should be moved to contain related filepath+other info to the calling module instead
- An additional error handler was borrowed from the redirects yaml parsing logic that was introduced in a referenced commit - it still makes sense to keep it for routes.yaml configuration
44 lines
1.7 KiB
JavaScript
44 lines
1.7 KiB
JavaScript
const sinon = require('sinon');
|
|
const should = require('should');
|
|
const fs = require('fs-extra');
|
|
const yaml = require('js-yaml');
|
|
const path = require('path');
|
|
const yamlParser = require('../../../../core/server/services/route-settings/yaml-parser');
|
|
|
|
describe('UNIT > Settings Service yaml parser:', function () {
|
|
let yamlSpy;
|
|
|
|
beforeEach(function () {
|
|
yamlSpy = sinon.spy(yaml, 'load');
|
|
});
|
|
|
|
afterEach(function () {
|
|
sinon.restore();
|
|
});
|
|
|
|
describe('Yaml Parser', function () {
|
|
it('parses correct yaml file', function () {
|
|
const file = fs.readFileSync(path.join(__dirname, '../../../utils/fixtures/settings/', 'goodroutes.yaml'), 'utf8');
|
|
|
|
const result = yamlParser(file);
|
|
should.exist(result);
|
|
result.should.be.an.Object().with.properties('routes', 'collections', 'taxonomies');
|
|
yamlSpy.calledOnce.should.be.true();
|
|
});
|
|
|
|
it('rejects with clear error when parsing fails', function () {
|
|
const file = fs.readFileSync(path.join(__dirname, '../../../utils/fixtures/settings/', 'badroutes.yaml'), 'utf8');
|
|
|
|
try {
|
|
const result = yamlParser(file);
|
|
should.not.exist(result);
|
|
} catch (error) {
|
|
should.exist(error);
|
|
error.message.should.eql('Could not parse provided YAML file: bad indentation of a mapping entry.');
|
|
error.context.should.containEql('bad indentation of a mapping entry (5:14)');
|
|
error.help.should.eql('Check provided file for typos and fix the named issues.');
|
|
yamlSpy.calledOnce.should.be.true();
|
|
}
|
|
});
|
|
});
|
|
});
|