1
0
Fork 0
salty-dog/test/rule/TestLoadRule.ts

162 lines
3.5 KiB
TypeScript
Raw Normal View History

import { expect } from 'chai';
import mockFS from 'mock-fs';
import { NullLogger } from 'noicejs';
import { spy, stub } from 'sinon';
import { loadRuleFiles, loadRuleModules, loadRulePaths } from '../../src/rule';
import { VisitorContext } from '../../src/visitor/VisitorContext';
import { describeLeaks, itLeaks } from '../helpers/async';
const EXAMPLE_EMPTY = '{name: foo, definitions: {}, rules: []}';
const EXAMPLE_RULES = `{
name: foo,
definitions: {},
rules: [{
name: test,
level: info,
tags: []
}]
}`;
describeLeaks('load rule file helper', async () => {
itLeaks('should add schema', async () => {
mockFS({
test: EXAMPLE_EMPTY,
});
const ctx = new VisitorContext({
logger: NullLogger.global,
schemaOptions: {
coerce: false,
defaults: false,
mutate: false,
},
});
const schemaSpy = spy(ctx, 'addSchema');
const rules = await loadRuleFiles([
'test',
], ctx);
mockFS.restore();
expect(schemaSpy).to.have.been.calledWith('foo');
expect(rules.length).to.equal(0);
});
itLeaks('should load rules', async () => {
mockFS({
test: EXAMPLE_RULES,
});
const ctx = new VisitorContext({
logger: NullLogger.global,
schemaOptions: {
coerce: false,
defaults: false,
mutate: false,
},
});
const rules = await loadRuleFiles([
'test',
], ctx);
mockFS.restore();
expect(rules.length).to.equal(1);
});
});
describeLeaks('load rule path helper', async () => {
itLeaks('should only load matching rule files', async () => {
mockFS({
test: {
'bin.nope': '{}', // will parse but throw on lack of rules
'foo.yml': EXAMPLE_RULES,
},
});
const ctx = new VisitorContext({
logger: NullLogger.global,
schemaOptions: {
coerce: false,
defaults: false,
mutate: false,
},
});
const rules = await loadRulePaths([
'test',
], ctx);
mockFS.restore();
expect(rules.length).to.equal(1);
});
itLeaks('should recursively load rule files', async () => {
mockFS({
test: {
'bar-dir': {
'bar.yml': EXAMPLE_RULES.replace(/foo/g, 'bar'),
},
'bin.nope': '{}', // will parse but throw on lack of rules
'some-dir': {
'foo.yml': EXAMPLE_RULES,
},
},
});
const ctx = new VisitorContext({
logger: NullLogger.global,
schemaOptions: {
coerce: false,
defaults: false,
mutate: false,
},
});
const rules = await loadRulePaths([
'test',
], ctx);
mockFS.restore();
expect(rules.length).to.equal(2);
});
});
describeLeaks('load rule module helper', async () => {
itLeaks('should load rule modules', async () => {
const ctx = new VisitorContext({
logger: NullLogger.global,
schemaOptions: {
coerce: false,
defaults: false,
mutate: false,
},
});
const requireStub = stub().withArgs('test').returns({
definitions: {
foo: {
type: 'string',
},
},
name: 'test',
rules: [{
check: {},
desc: 'testing rule',
level: 'info',
name: 'test-rule',
tags: [],
}],
/* eslint-disable-next-line @typescript-eslint/no-explicit-any */
}) as any;
const rules = await loadRuleModules(['test'], ctx, requireStub);
expect(rules.length).to.equal(1);
});
itLeaks('should validate rule module exports');
});