-
-
Notifications
You must be signed in to change notification settings - Fork 4.4k
/
eslint-fuzzer.js
281 lines (239 loc) · 11.6 KB
/
eslint-fuzzer.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
"use strict";
//------------------------------------------------------------------------------
// Requirements
//------------------------------------------------------------------------------
const assert = require("chai").assert;
const eslint = require("../..");
const espree = require("espree");
const sinon = require("sinon");
const configRule = require("../../tools/config-rule");
//------------------------------------------------------------------------------
// Tests
//------------------------------------------------------------------------------
describe("eslint-fuzzer", function() {
let fuzz;
/*
* These tests take awhile because isolating which rule caused an error requires running eslint up to hundreds of
* times, one rule at a time.
*/
this.timeout(15000); // eslint-disable-line no-invalid-this -- Mocha timeout
const linter = new eslint.Linter({ configType: "eslintrc" });
const coreRules = linter.getRules();
const fixableRuleNames = Array.from(coreRules)
.filter(rulePair => rulePair[1].meta && rulePair[1].meta.fixable)
.map(rulePair => rulePair[0]);
const CRASH_BUG = new TypeError("error thrown from a rule");
// A comment to disable all core fixable rules
const disableFixableRulesComment = `// eslint-disable-line ${fixableRuleNames.join(",")}`;
before(() => {
const realCoreRuleConfigs = configRule.createCoreRuleConfigs();
// Make sure the config generator generates a config for "test-fuzzer-rule"
sinon.stub(configRule, "createCoreRuleConfigs").returns(Object.assign(realCoreRuleConfigs, { "test-fuzzer-rule": [2] }));
fuzz = require("../../tools/eslint-fuzzer");
});
after(() => {
configRule.createCoreRuleConfigs.restore();
});
describe("when running in crash-only mode", () => {
describe("when a rule crashes on the given input", () => {
it("should report the crash with a minimal config", () => {
linter.defineRule("test-fuzzer-rule", {
create: context => ({
Program() {
if (context.sourceCode.text === "foo") {
throw CRASH_BUG;
}
}
})
});
const results = fuzz({ count: 1, codeGenerator: () => "foo", checkAutofixes: false, linter });
assert.strictEqual(results.length, 1);
assert.strictEqual(results[0].type, "crash");
assert.strictEqual(results[0].text, "foo");
assert.deepStrictEqual(results[0].config.rules, { "test-fuzzer-rule": 2 });
assert.strictEqual(results[0].error, CRASH_BUG.stack);
});
});
describe("when no rules crash", () => {
it("should return an empty array", () => {
linter.defineRule("test-fuzzer-rule", { create: () => ({}) });
assert.deepStrictEqual(fuzz({ count: 1, codeGenerator: () => "foo", checkAutofixes: false, linter }), []);
});
});
});
describe("when running in crash-and-autofix mode", () => {
const INVALID_SYNTAX = "this is not valid javascript syntax";
let expectedSyntaxError;
try {
espree.parse(INVALID_SYNTAX);
} catch (err) {
expectedSyntaxError = err;
}
describe("when a rule crashes on the given input", () => {
it("should report the crash with a minimal config", () => {
linter.defineRule("test-fuzzer-rule", {
create: context => ({
Program() {
if (context.sourceCode.text === "foo") {
throw CRASH_BUG;
}
}
})
});
const results = fuzz({ count: 1, codeGenerator: () => "foo", checkAutofixes: false, linter });
assert.strictEqual(results.length, 1);
assert.strictEqual(results[0].type, "crash");
assert.strictEqual(results[0].text, "foo");
assert.deepStrictEqual(results[0].config.rules, { "test-fuzzer-rule": 2 });
assert.strictEqual(results[0].error, CRASH_BUG.stack);
});
});
describe("when a rule's autofix produces valid syntax", () => {
it("does not report any errors", () => {
// Replaces programs that start with "foo" with "bar"
linter.defineRule("test-fuzzer-rule", {
meta: { fixable: "code" },
create: context => ({
Program(node) {
if (context.sourceCode.text === `foo ${disableFixableRulesComment}`) {
context.report({
node,
message: "no foos allowed",
fix: fixer => fixer.replaceText(node, `bar ${disableFixableRulesComment}`)
});
}
}
})
});
const results = fuzz({
count: 1,
/*
* To ensure that no other rules produce a different autofix and mess up the test, add a big disable
* comment for all core fixable rules.
*/
codeGenerator: () => `foo ${disableFixableRulesComment}`,
checkAutofixes: true,
linter
});
assert.deepStrictEqual(results, []);
});
});
describe("when a rule's autofix produces invalid syntax on the first pass", () => {
it("reports an autofix error with a minimal config", () => {
// Replaces programs that start with "foo" with invalid syntax
linter.defineRule("test-fuzzer-rule", {
meta: { fixable: "code" },
create: context => ({
Program(node) {
const sourceCode = context.sourceCode;
if (sourceCode.text === `foo ${disableFixableRulesComment}`) {
context.report({
node,
message: "no foos allowed",
fix: fixer => fixer.replaceTextRange([0, sourceCode.text.length], INVALID_SYNTAX)
});
}
}
})
});
const results = fuzz({
count: 1,
codeGenerator: () => `foo ${disableFixableRulesComment}`,
checkAutofixes: true,
linter
});
assert.strictEqual(results.length, 1);
assert.strictEqual(results[0].type, "autofix");
assert.strictEqual(results[0].text, `foo ${disableFixableRulesComment}`);
assert.deepStrictEqual(results[0].config.rules, { "test-fuzzer-rule": 2 });
assert.deepStrictEqual(results[0].error, {
ruleId: null,
fatal: true,
severity: 2,
message: `Parsing error: ${expectedSyntaxError.message}`,
line: expectedSyntaxError.lineNumber,
column: expectedSyntaxError.column,
nodeType: null
});
});
});
describe("when a rule's autofix produces invalid syntax on the second pass", () => {
it("reports an autofix error with a minimal config and the text from the second pass", () => {
const intermediateCode = `bar ${disableFixableRulesComment}`;
// Replaces programs that start with "foo" with invalid syntax
linter.defineRule("test-fuzzer-rule", {
meta: { fixable: "code" },
create: context => ({
Program(node) {
const sourceCode = context.sourceCode;
if (sourceCode.text.startsWith("foo") || sourceCode.text === intermediateCode) {
context.report({
node,
message: "no foos allowed",
fix(fixer) {
return fixer.replaceTextRange(
[0, sourceCode.text.length],
sourceCode.text === intermediateCode ? INVALID_SYNTAX : intermediateCode
);
}
});
}
}
})
});
const results = fuzz({
count: 1,
codeGenerator: () => `foo ${disableFixableRulesComment}`,
checkAutofixes: true,
linter
});
assert.strictEqual(results.length, 1);
assert.strictEqual(results[0].type, "autofix");
assert.strictEqual(results[0].text, intermediateCode);
assert.deepStrictEqual(results[0].config.rules, { "test-fuzzer-rule": 2 });
assert.deepStrictEqual(results[0].error, {
ruleId: null,
fatal: true,
severity: 2,
message: `Parsing error: ${expectedSyntaxError.message}`,
line: expectedSyntaxError.lineNumber,
column: expectedSyntaxError.column,
nodeType: null
});
});
});
describe("when a rule crashes on the second autofix pass", () => {
it("reports a crash error with a minimal config", () => {
// Replaces programs that start with "foo" with invalid syntax
linter.defineRule("test-fuzzer-rule", {
meta: { fixable: "code" },
create: context => ({
Program(node) {
const sourceCode = context.sourceCode;
if (sourceCode.text.startsWith("foo")) {
context.report({
node,
message: "no foos allowed",
fix: fixer => fixer.replaceText(node, "bar")
});
} else if (sourceCode.text === `bar ${disableFixableRulesComment}`) {
throw CRASH_BUG;
}
}
})
});
const results = fuzz({
count: 1,
codeGenerator: () => `foo ${disableFixableRulesComment}`,
checkAutofixes: true,
linter
});
assert.strictEqual(results.length, 1);
assert.strictEqual(results[0].type, "crash");
assert.strictEqual(results[0].text, `bar ${disableFixableRulesComment}`);
assert.deepStrictEqual(results[0].config.rules, { "test-fuzzer-rule": 2 });
assert.strictEqual(results[0].error, CRASH_BUG.stack);
});
});
});
});