/
config-validator.js
469 lines (353 loc) · 19.2 KB
/
config-validator.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
/**
* @fileoverview Tests for config validator.
* @author Brandon Mills
*/
"use strict";
//------------------------------------------------------------------------------
// Requirements
//------------------------------------------------------------------------------
const assert = require("chai").assert,
{ Linter } = require("../../../lib/linter"),
validator = require("../../../lib/shared/config-validator"),
Rules = require("../../../lib/linter/rules");
const linter = new Linter();
//------------------------------------------------------------------------------
// Tests
//------------------------------------------------------------------------------
/**
* Fake a rule object
* @param {Object} context context passed to the rules by eslint
* @returns {Object} mocked rule listeners
* @private
*/
function mockRule(context) {
return {
Program(node) {
context.report(node, "Expected a validation error.");
}
};
}
mockRule.schema = [
{
enum: ["first", "second"]
}
];
/**
* Fake a rule object
* @param {Object} context context passed to the rules by eslint
* @returns {Object} mocked rule listeners
* @private
*/
function mockObjectRule(context) {
return {
Program(node) {
context.report(node, "Expected a validation error.");
}
};
}
mockObjectRule.schema = {
enum: ["first", "second"]
};
/**
* Fake a rule with no options
* @param {Object} context context passed to the rules by eslint
* @returns {Object} mocked rule listeners
* @private
*/
function mockNoOptionsRule(context) {
return {
Program(node) {
context.report(node, "Expected a validation error.");
}
};
}
mockNoOptionsRule.schema = [];
const mockRequiredOptionsRule = {
meta: {
schema: {
type: "array",
minItems: 1
}
},
create(context) {
return {
Program(node) {
context.report(node, "Expected a validation error.");
}
};
}
};
describe("Validator", () => {
/**
* Gets a loaded rule given a rule ID
* @param {string} ruleId The ID of the rule
* @returns {{create: Function}} The loaded rule
*/
function ruleMapper(ruleId) {
return linter.getRules().get(ruleId) || new Rules().get(ruleId);
}
beforeEach(() => {
linter.defineRule("mock-rule", mockRule);
linter.defineRule("mock-required-options-rule", mockRequiredOptionsRule);
});
describe("validate", () => {
it("should do nothing with an empty config", () => {
validator.validate({}, "tests", ruleMapper);
});
it("should do nothing with a valid eslint config", () => {
validator.validate(
{
$schema: "http://json.schemastore.org/eslintrc",
root: true,
globals: { globalFoo: "readonly" },
parser: "parserFoo",
env: { browser: true },
plugins: ["pluginFoo", "pluginBar"],
settings: { foo: "bar" },
extends: ["configFoo", "configBar"],
parserOptions: { foo: "bar" },
rules: {}
},
"tests",
ruleMapper
);
});
it("should throw with an unknown property", () => {
const fn = validator.validate.bind(
null,
{
foo: true
},
"tests",
ruleMapper
);
assert.throws(fn, "Unexpected top-level property \"foo\".");
});
describe("root", () => {
it("should throw with a string value", () => {
const fn = validator.validate.bind(null, { root: "true" }, null, ruleMapper);
assert.throws(fn, "Property \"root\" is the wrong type (expected boolean but got `\"true\"`).");
});
it("should throw with a numeric value", () => {
const fn = validator.validate.bind(null, { root: 0 }, null, ruleMapper);
assert.throws(fn, "Property \"root\" is the wrong type (expected boolean but got `0`).");
});
});
describe("globals", () => {
it("should throw with a string value", () => {
const fn = validator.validate.bind(null, { globals: "jQuery" }, null, ruleMapper);
assert.throws(fn, "Property \"globals\" is the wrong type (expected object but got `\"jQuery\"`).");
});
it("should throw with an array value", () => {
const fn = validator.validate.bind(null, { globals: ["jQuery"] }, null, ruleMapper);
assert.throws(fn, "Property \"globals\" is the wrong type (expected object but got `[\"jQuery\"]`).");
});
});
describe("parser", () => {
it("should not throw with a null value", () => {
validator.validate({ parser: null }, null, ruleMapper);
});
});
describe("env", () => {
it("should throw with an array environment", () => {
const fn = validator.validate.bind(null, { env: [] }, null, ruleMapper);
assert.throws(fn, "Property \"env\" is the wrong type (expected object but got `[]`).");
});
it("should throw with a primitive environment", () => {
const fn = validator.validate.bind(null, { env: 1 }, null, ruleMapper);
assert.throws(fn, "Property \"env\" is the wrong type (expected object but got `1`).");
});
it("should catch invalid environments", () => {
const fn = validator.validate.bind(null, { env: { browser: true, invalid: true } }, null, ruleMapper);
assert.throws(fn, "Environment key \"invalid\" is unknown\n");
});
it("should catch disabled invalid environments", () => {
const fn = validator.validate.bind(null, { env: { browser: true, invalid: false } }, null, ruleMapper);
assert.throws(fn, "Environment key \"invalid\" is unknown\n");
});
it("should do nothing with an undefined environment", () => {
validator.validate({}, null, ruleMapper);
});
});
describe("plugins", () => {
it("should not throw with an empty array", () => {
validator.validate({ plugins: [] }, null, ruleMapper);
});
it("should throw with a string", () => {
const fn = validator.validate.bind(null, { plugins: "react" }, null, ruleMapper);
assert.throws(fn, "Property \"plugins\" is the wrong type (expected array but got `\"react\"`).");
});
});
describe("settings", () => {
it("should not throw with an empty object", () => {
validator.validate({ settings: {} }, null, ruleMapper);
});
it("should throw with an array", () => {
const fn = validator.validate.bind(null, { settings: ["foo"] }, null, ruleMapper);
assert.throws(fn, "Property \"settings\" is the wrong type (expected object but got `[\"foo\"]`).");
});
});
describe("extends", () => {
it("should not throw with an empty array", () => {
validator.validate({ extends: [] }, null, ruleMapper);
});
it("should not throw with a string", () => {
validator.validate({ extends: "react" }, null, ruleMapper);
});
it("should throw with an object", () => {
const fn = validator.validate.bind(null, { extends: {} }, null, ruleMapper);
assert.throws(fn, "ESLint configuration in null is invalid:\n\t- Property \"extends\" is the wrong type (expected string but got `{}`).\n\t- Property \"extends\" is the wrong type (expected array but got `{}`).\n\t- \"extends\" should match exactly one schema in oneOf. Value: {}.");
});
});
describe("parserOptions", () => {
it("should not throw with an empty object", () => {
validator.validate({ parserOptions: {} }, null, ruleMapper);
});
it("should throw with an array", () => {
const fn = validator.validate.bind(null, { parserOptions: ["foo"] }, null, ruleMapper);
assert.throws(fn, "Property \"parserOptions\" is the wrong type (expected object but got `[\"foo\"]`).");
});
});
describe("rules", () => {
it("should do nothing with an empty rules object", () => {
validator.validate({ rules: {} }, "tests", ruleMapper);
});
it("should do nothing with a valid config with rules", () => {
validator.validate({ rules: { "mock-rule": [2, "second"] } }, "tests", ruleMapper);
});
it("should do nothing with a valid config when severity is off", () => {
validator.validate({ rules: { "mock-rule": ["off", "second"] } }, "tests", ruleMapper);
});
it("should do nothing with an invalid config when severity is off", () => {
validator.validate({ rules: { "mock-required-options-rule": "off" } }, "tests", ruleMapper);
});
it("should do nothing with an invalid config when severity is an array with 'off'", () => {
validator.validate({ rules: { "mock-required-options-rule": ["off"] } }, "tests", ruleMapper);
});
it("should do nothing with a valid config when severity is warn", () => {
validator.validate({ rules: { "mock-rule": ["warn", "second"] } }, "tests", ruleMapper);
});
it("should do nothing with a valid config when severity is error", () => {
validator.validate({ rules: { "mock-rule": ["error", "second"] } }, "tests", ruleMapper);
});
it("should do nothing with a valid config when severity is Off", () => {
validator.validate({ rules: { "mock-rule": ["Off", "second"] } }, "tests", ruleMapper);
});
it("should do nothing with a valid config when severity is Warn", () => {
validator.validate({ rules: { "mock-rule": ["Warn", "second"] } }, "tests", ruleMapper);
});
it("should do nothing with a valid config when severity is Error", () => {
validator.validate({ rules: { "mock-rule": ["Error", "second"] } }, "tests", ruleMapper);
});
it("should catch invalid rule options", () => {
const fn = validator.validate.bind(null, { rules: { "mock-rule": [3, "third"] } }, "tests", ruleMapper);
assert.throws(fn, "tests:\n\tConfiguration for rule \"mock-rule\" is invalid:\n\tSeverity should be one of the following: 0 = off, 1 = warn, 2 = error (you passed '3').\n");
});
it("should allow for rules with no options", () => {
linter.defineRule("mock-no-options-rule", mockNoOptionsRule);
validator.validate({ rules: { "mock-no-options-rule": 2 } }, "tests", ruleMapper);
});
it("should not allow options for rules with no options", () => {
linter.defineRule("mock-no-options-rule", mockNoOptionsRule);
const fn = validator.validate.bind(null, { rules: { "mock-no-options-rule": [2, "extra"] } }, "tests", ruleMapper);
assert.throws(fn, "tests:\n\tConfiguration for rule \"mock-no-options-rule\" is invalid:\n\tValue [\"extra\"] should NOT have more than 0 items.\n");
});
});
describe("globals", () => {
it("should disallow globals set to invalid values", () => {
assert.throws(
() => validator.validate({ globals: { foo: "AAAAA" } }, "tests", ruleMapper),
"ESLint configuration of global 'foo' in tests is invalid:\n'AAAAA' is not a valid configuration for a global (use 'readonly', 'writable', or 'off')"
);
});
});
describe("overrides", () => {
it("should not throw with an empty overrides array", () => {
validator.validate({ overrides: [] }, "tests", ruleMapper);
});
it("should not throw with a valid overrides array", () => {
validator.validate({ overrides: [{ files: "*", rules: {} }] }, "tests", ruleMapper);
});
it("should throw if override does not specify files", () => {
const fn = validator.validate.bind(null, { overrides: [{ rules: {} }] }, "tests", ruleMapper);
assert.throws(fn, "ESLint configuration in tests is invalid:\n\t- \"overrides[0]\" should have required property 'files'. Value: {\"rules\":{}}.\n");
});
it("should throw if override has an empty files array", () => {
const fn = validator.validate.bind(null, { overrides: [{ files: [] }] }, "tests", ruleMapper);
assert.throws(fn, "ESLint configuration in tests is invalid:\n\t- Property \"overrides[0].files\" is the wrong type (expected string but got `[]`).\n\t- \"overrides[0].files\" should NOT have fewer than 1 items. Value: [].\n\t- \"overrides[0].files\" should match exactly one schema in oneOf. Value: [].\n");
});
it("should not throw if override has nested overrides", () => {
validator.validate({ overrides: [{ files: "*", overrides: [{ files: "*", rules: {} }] }] }, "tests", ruleMapper);
});
it("should not throw if override extends", () => {
validator.validate({ overrides: [{ files: "*", extends: "eslint-recommended" }] }, "tests", ruleMapper);
});
it("should throw if override tries to set root", () => {
const fn = validator.validate.bind(null, { overrides: [{ files: "*", root: "true" }] }, "tests", ruleMapper);
assert.throws(fn, "ESLint configuration in tests is invalid:\n\t- Unexpected top-level property \"overrides[0].root\".\n");
});
describe("env", () => {
it("should catch invalid environments", () => {
const fn = validator.validate.bind(null, { overrides: [{ files: "*", env: { browser: true, invalid: true } }] }, null, ruleMapper);
assert.throws(fn, "Environment key \"invalid\" is unknown\n");
});
it("should catch disabled invalid environments", () => {
const fn = validator.validate.bind(null, { overrides: [{ files: "*", env: { browser: true, invalid: false } }] }, null, ruleMapper);
assert.throws(fn, "Environment key \"invalid\" is unknown\n");
});
});
describe("rules", () => {
it("should catch invalid rule options", () => {
const fn = validator.validate.bind(null, { overrides: [{ files: "*", rules: { "mock-rule": [3, "third"] } }] }, "tests", ruleMapper);
assert.throws(fn, "tests:\n\tConfiguration for rule \"mock-rule\" is invalid:\n\tSeverity should be one of the following: 0 = off, 1 = warn, 2 = error (you passed '3').\n");
});
it("should not allow options for rules with no options", () => {
linter.defineRule("mock-no-options-rule", mockNoOptionsRule);
const fn = validator.validate.bind(null, { overrides: [{ files: "*", rules: { "mock-no-options-rule": [2, "extra"] } }] }, "tests", ruleMapper);
assert.throws(fn, "tests:\n\tConfiguration for rule \"mock-no-options-rule\" is invalid:\n\tValue [\"extra\"] should NOT have more than 0 items.\n");
});
});
});
});
describe("getRuleOptionsSchema", () => {
it("should return null for a missing rule", () => {
assert.strictEqual(validator.getRuleOptionsSchema(ruleMapper("non-existent-rule")), null);
});
it("should not modify object schema", () => {
linter.defineRule("mock-object-rule", mockObjectRule);
assert.deepStrictEqual(validator.getRuleOptionsSchema(ruleMapper("mock-object-rule")), {
enum: ["first", "second"]
});
});
});
describe("validateRuleOptions", () => {
it("should throw for incorrect warning level number", () => {
const fn = validator.validateRuleOptions.bind(null, ruleMapper("mock-rule"), "mock-rule", 3, "tests");
assert.throws(fn, "tests:\n\tConfiguration for rule \"mock-rule\" is invalid:\n\tSeverity should be one of the following: 0 = off, 1 = warn, 2 = error (you passed '3').\n");
});
it("should throw for incorrect warning level string", () => {
const fn = validator.validateRuleOptions.bind(null, ruleMapper("mock-rule"), "mock-rule", "booya", "tests");
assert.throws(fn, "tests:\n\tConfiguration for rule \"mock-rule\" is invalid:\n\tSeverity should be one of the following: 0 = off, 1 = warn, 2 = error (you passed '\"booya\"').\n");
});
it("should throw for invalid-type warning level", () => {
const fn = validator.validateRuleOptions.bind(null, ruleMapper("mock-rule"), "mock-rule", [["error"]], "tests");
assert.throws(fn, "tests:\n\tConfiguration for rule \"mock-rule\" is invalid:\n\tSeverity should be one of the following: 0 = off, 1 = warn, 2 = error (you passed '[ \"error\" ]').\n");
});
it("should only check warning level for nonexistent rules", () => {
const fn = validator.validateRuleOptions.bind(null, ruleMapper("non-existent-rule"), "non-existent-rule", [3, "foobar"], "tests");
assert.throws(fn, "tests:\n\tConfiguration for rule \"non-existent-rule\" is invalid:\n\tSeverity should be one of the following: 0 = off, 1 = warn, 2 = error (you passed '3').\n");
});
it("should only check warning level for plugin rules", () => {
const fn = validator.validateRuleOptions.bind(null, ruleMapper("plugin/rule"), "plugin/rule", 3, "tests");
assert.throws(fn, "tests:\n\tConfiguration for rule \"plugin/rule\" is invalid:\n\tSeverity should be one of the following: 0 = off, 1 = warn, 2 = error (you passed '3').\n");
});
it("should throw for incorrect configuration values", () => {
const fn = validator.validateRuleOptions.bind(null, ruleMapper("mock-rule"), "mock-rule", [2, "frist"], "tests");
assert.throws(fn, "tests:\n\tConfiguration for rule \"mock-rule\" is invalid:\n\tValue \"frist\" should be equal to one of the allowed values.\n");
});
it("should throw for too many configuration values", () => {
const fn = validator.validateRuleOptions.bind(null, ruleMapper("mock-rule"), "mock-rule", [2, "first", "second"], "tests");
assert.throws(fn, "tests:\n\tConfiguration for rule \"mock-rule\" is invalid:\n\tValue [\"first\",\"second\"] should NOT have more than 1 items.\n");
});
});
});