Ghost/test/unit/services/settings/yaml-parser.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

45 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/frontend/services/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, 'goodroutes.yaml');
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, 'badroutes.yaml');
should.not.exist(result);
} catch (error) {
should.exist(error);
error.message.should.eql('Could not parse badroutes.yaml: bad indentation of a mapping entry.');
error.context.should.containEql('bad indentation of a mapping entry (5:14)');
error.help.should.eql('Check your badroutes.yaml file for typos and fix the named issues.');
yamlSpy.calledOnce.should.be.true();
}
});
});
});