-
Notifications
You must be signed in to change notification settings - Fork 116
Expand file tree
/
Copy pathcommit-lint.test.ts
More file actions
291 lines (256 loc) · 9.14 KB
/
commit-lint.test.ts
File metadata and controls
291 lines (256 loc) · 9.14 KB
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
import { expect, jest, test } from "@jest/globals";
import { ILintError, ILintOptions, LintCommit } from "../lib/commit-lint.js";
import { IPRCommit } from "../lib/github-glue.js";
jest.setTimeout(180000);
/**
* Check one commit's linter result
*
* If the `check` parameter is set, it expects the linter to produce a
* `lintError`. If the `check` parameter is unspecified, it expects the linter
* _not_ to produce an error.
*
* @param commit the commit to lint
* @param check a function to verify the lint result
* @param options extra linter options, if any
*/
function lintCheck(commit: IPRCommit, check?: (error: ILintError) => void, options?: ILintOptions) {
const linter = new LintCommit(commit, options);
const lintError = linter.lint();
if (!check) {
expect(lintError).toBeUndefined();
} else {
expect(lintError).not.toBeUndefined();
if (lintError) {
check(lintError);
}
}
}
test("basic lint tests", () => {
const commit = {
author: {
email: "ggg@example.com",
login: "ggg",
name: "e. e. cummings",
},
commit: "BAD1FEEDBEEF",
committer: {
email: "ggg@example.com",
login: "ggg",
name: "e. e. cummings",
},
message: "Message has no description",
parentCount: 1,
};
lintCheck(commit, (lintError) => {
expect(lintError.checkFailed).toBe(true);
expect(lintError.message).toMatch(/too short/);
});
commit.message = "Missing blank line is bad\nhere\nSigned-off-by: x";
lintCheck(commit, (lintError) => {
expect(lintError.checkFailed).toBe(true);
expect(lintError.message).toMatch(/empty line/);
});
commit.message = "";
lintCheck(commit, (lintError) => {
expect(lintError.checkFailed).toBe(true);
expect(lintError.message).toMatch(/too short/);
});
commit.message = [
"1234578901234567890123456789012345678901234567890123456789012345678901234567890",
"more bad",
"Signed-off-by: x",
].join("\n");
lintCheck(commit, (lintError) => {
expect(lintError.checkFailed).toBe(true);
expect(lintError.message).toMatch(/too long/);
expect(lintError.message).toMatch(/empty line/);
});
commit.message = "squash! This needs rebase\n\nSigned-off-by: x";
lintCheck(commit, (lintError) => {
expect(lintError.checkFailed).toBe(true);
expect(lintError.message).toMatch(/Rebase/);
});
commit.message = "fixup! This needs rebase\n\nSigned-off-by: x";
lintCheck(commit, (lintError) => {
expect(lintError.checkFailed).toBe(true);
expect(lintError.message).toMatch(/Rebase/);
});
commit.message = "amend! This needs rebase\n\nSigned-off-by: x";
lintCheck(commit, (lintError) => {
expect(lintError.checkFailed).toBe(true);
expect(lintError.message).toMatch(/Rebase/);
});
commit.message = "amend This is okay\n\nSigned-off-by: x";
lintCheck(commit);
commit.message = "tests: This should be lower case\n\nSigned-off-by: x";
lintCheck(commit, (lintError) => {
expect(lintError.checkFailed).toBe(true);
expect(lintError.message).toMatch(/lower/);
});
commit.message = `tests: A title that should also be lower case\n
Signed-off-by: x`;
lintCheck(commit, (lintError) => {
expect(lintError.checkFailed).toBe(true);
expect(lintError.message).toMatch(/lower/);
});
commit.message = "tests: THIS can be all-caps\n\nSigned-off-by: x";
lintCheck(commit);
commit.message = "doc: success as Lower Case\n\nSigned-off-by: x";
lintCheck(commit);
commit.message = `doc: a single-letter Lower Case message also succeeds\n
Signed-off-by: x`;
lintCheck(commit);
commit.message = "Fail not signed off\n\nNotSigned-off-by: x";
lintCheck(commit, (lintError) => {
expect(lintError.checkFailed).toBe(true);
expect(lintError.message).toMatch(/not signed/);
});
commit.message = "Success signed off\n\n foo bar\nSigned-off-by: x";
lintCheck(commit);
commit.message = `Success signed off\n\n foo bar
Signed-off-by: x
Reviewed-by: y`;
lintCheck(commit);
commit.message = "Fail blanks in sign off\n\n Signed-off-by: x";
lintCheck(commit, (lintError) => {
expect(lintError.checkFailed).toBe(true);
expect(lintError.message).toMatch(/whitespace/);
});
commit.message = `Fail just a link\n
http://www.github.com\n\nSigned-off-by: x`;
lintCheck(commit, (lintError) => {
expect(lintError.checkFailed).toBe(true);
expect(lintError.message).toMatch(/explanation/);
});
commit.message = `Success more than a link\n
http://www.github.com\nblah\n\nSigned-off-by: x`;
lintCheck(commit);
commit.message = `Success more than a link\n
http://www.github.com blah\n\nSigned-off-by: x`;
lintCheck(commit);
commit.message = `Success more than a link\n
blah http://www.github.com\n\nSigned-off-by: x`;
lintCheck(commit);
commit.message = [
"wrapped but too long",
"",
"1234578901234567890123456789012345678901234567890 23456789012345678901234567890",
"more bad",
"Signed-off-by: x",
].join("\n");
lintCheck(commit, (lintError) => {
expect(lintError.checkFailed).toBe(true);
expect(lintError.message).toMatch(/should be wrapped/);
});
commit.message = [
"contains a long URL that cannot be wrapped",
"",
"[2] https://lore.kernel.org/git/CABPp-BH9tju7WVm=QZDOvaMDdZbpNXrVWQdN-jmfN8wC6YVhmw@mail.gmail.com/",
"",
"Signed-off-by: x}",
].join("\n");
lintCheck(commit);
commit.message = [
"contains a long, whitespace-prefixed error message",
"",
" ld-elf.so.1: /usr/local/lib/perl5/5.32/mach/CORE/libperl.so.5.32: " +
'Undefined symbol "strerror_l@FBSD_1.6"',
"",
"Signed-off-by: x}",
].join("\n");
lintCheck(commit);
});
test("combo lint tests", () => {
const commit = {
author: {
email: "ggg@example.com",
login: "ggg",
name: "e. e. cummings",
},
commit: "BAD1FEEDBEEF",
committer: {
email: "ggg@example.com",
login: "ggg",
name: "e. e. cummings",
},
message: "Message has no description",
parentCount: 1,
};
lintCheck(commit, (lintError) => {
expect(lintError.checkFailed).toBe(true);
expect(lintError.message).toMatch(/too short/);
expect(lintError.message).toMatch(/not signed/);
});
commit.message = `x: A 34578901234567890123456789012345678901234567890123456789012345678901234567890`;
lintCheck(commit, (lintError) => {
expect(lintError.checkFailed).toBe(true);
expect(lintError.message).toMatch(/too short/);
expect(lintError.message).toMatch(/not signed/);
expect(lintError.message).toMatch(/is too long/);
expect(lintError.message).toMatch(/lower/);
});
commit.message = [
"1234578901234567890123456789012345678901234567890123456789012345678901234567890",
"more bad",
"Signed-off-by: x",
].join("\n");
lintCheck(commit, (lintError) => {
expect(lintError.checkFailed).toBe(true);
expect(lintError.message).toMatch(/is too long/);
expect(lintError.message).toMatch(/empty line/);
});
commit.message = [
"all good but too long",
"1234578901234567890123456789012345678901234567890 23456789012345678901234567890",
"more bad",
"Signed-off-by: x",
].join("\n");
lintCheck(commit, (lintError) => {
expect(lintError.checkFailed).toBe(true);
expect(lintError.message).toMatch(/should be wrapped/);
expect(lintError.message).toMatch(/empty line/);
});
});
test("lint options tests", () => {
const commit = {
author: {
email: "ggg@example.com",
login: "ggg",
name: "e. e. cummings",
},
commit: "BAD1FEEDBEEF",
committer: {
email: "ggg@example.com",
login: "ggg",
name: "e. e. cummings",
},
message: [
"all good but too long 1234567890 234578901234567890123456789012345678901234567890",
"",
"1234578901234567890123456789012345678901234567890 23456789012345678901234567890",
"more bad",
"Signed-off-by: x",
].join("\n"),
parentCount: 1,
};
lintCheck(
commit,
(lintError) => {
expect(lintError.checkFailed).toBe(true);
expect(lintError.message).toMatch(/is too long/);
expect(lintError.message).toMatch(/should be wrapped/);
expect(lintError.message).toMatch(/76/);
},
{},
);
lintCheck(
commit,
(lintError) => {
expect(lintError.checkFailed).toBe(true);
expect(lintError.message).toMatch(/is too long/);
expect(lintError.message).toMatch(/should be wrapped/);
expect(lintError.message).toMatch(/66/);
},
{ maxColumns: 66 },
);
});