Skip to content

Commit 329bbb8

Browse files
ljharbljharb
committed
[New] t.match/`t.doesNotMatch: fail the test instead of throw on wrong input types.
Turns out throwing is much less useful than failing the test.
1 parent 728e190 commit 329bbb8

File tree

3 files changed

+186
-78
lines changed

3 files changed

+186
-78
lines changed

‎lib/test.js

+58-35
Original file line numberDiff line numberDiff line change
@@ -706,45 +706,68 @@ Test.prototype.doesNotThrow = function doesNotThrow(fn, expected, msg, extra) {
706706

707707
Test.prototype.match = function match(string, regexp, msg, extra) {
708708
if (!isRegExp(regexp)) {
709-
throw new TypeError('The "regexp" argument must be an instance of RegExp. Received type ' + typeof regexp + ' (' + inspect(regexp) + ')');
710-
}
711-
if (typeof string !== 'string') {
712-
throw new TypeError('The "string" argument must be of type string. Received type ' + typeof string + ' (' + inspect(string) + ')');
713-
}
714-
715-
var matches = $test(regexp, string);
716-
var message = defined(
717-
msg,
718-
'The input ' + (matches ? 'matched' : 'did not match') + ' the regular expression ' + inspect(regexp) + '. Input: ' + inspect(string)
719-
);
720-
this._assert(matches, {
721-
message: message,
722-
operator: 'match',
723-
actual: string,
724-
expected: regexp,
725-
extra: extra
726-
});
709+
this._assert(false, {
710+
message: defined(msg, 'The "regexp" argument must be an instance of RegExp. Received type ' + typeof regexp + ' (' + inspect(regexp) + ')'),
711+
operator: 'match',
712+
actual: objectToString(regexp),
713+
expected: '[object RegExp]',
714+
extra: extra
715+
});
716+
} else if (typeof string !== 'string') {
717+
this._assert(false, {
718+
message: defined(msg, 'The "string" argument must be of type string. Received type ' + typeof string + ' (' + inspect(string) + ')'),
719+
operator: 'match',
720+
actual: string === null ? null : typeof string,
721+
expected: 'string',
722+
extra: extra
723+
});
724+
} else {
725+
var matches = $test(regexp, string);
726+
var message = defined(
727+
msg,
728+
'The input ' + (matches ? 'matched' : 'did not match') + ' the regular expression ' + inspect(regexp) + '. Input: ' + inspect(string)
729+
);
730+
this._assert(matches, {
731+
message: message,
732+
operator: 'match',
733+
actual: string,
734+
expected: regexp,
735+
extra: extra
736+
});
737+
}
727738
};
728739

729740
Test.prototype.doesNotMatch = function doesNotMatch(string, regexp, msg, extra) {
730741
if (!isRegExp(regexp)) {
731-
throw new TypeError('The "regexp" argument must be an instance of RegExp. Received type ' + typeof regexp + ' (' + inspect(regexp) + ')');
732-
}
733-
if (typeof string !== 'string') {
734-
throw new TypeError('The "string" argument must be of type string. Received type ' + typeof string + ' (' + inspect(string) + ')');
735-
}
736-
var matches = $test(regexp, string);
737-
var message = defined(
738-
msg,
739-
'The input ' + (matches ? 'was expected to not match' : 'did not match') + ' the regular expression ' + inspect(regexp) + '. Input: ' + inspect(string)
740-
);
741-
this._assert(!matches, {
742-
message: message,
743-
operator: 'doesNotMatch',
744-
actual: string,
745-
expected: regexp,
746-
extra: extra
747-
});
742+
this._assert(false, {
743+
message: defined(msg, 'The "regexp" argument must be an instance of RegExp. Received type ' + typeof regexp + ' (' + inspect(regexp) + ')'),
744+
operator: 'doesNotMatch',
745+
actual: objectToString(regexp),
746+
expected: '[object RegExp]',
747+
extra: extra
748+
});
749+
} else if (typeof string !== 'string') {
750+
this._assert(false, {
751+
message: defined(msg, 'The "string" argument must be of type string. Received type ' + typeof string + ' (' + inspect(string) + ')'),
752+
operator: 'doesNotMatch',
753+
actual: string === null ? null : typeof string,
754+
expected: 'string',
755+
extra: extra
756+
});
757+
} else {
758+
var matches = $test(regexp, string);
759+
var message = defined(
760+
msg,
761+
'The input ' + (matches ? 'was expected to not match' : 'did not match') + ' the regular expression ' + inspect(regexp) + '. Input: ' + inspect(string)
762+
);
763+
this._assert(!matches, {
764+
message: message,
765+
operator: 'doesNotMatch',
766+
actual: string,
767+
expected: regexp,
768+
extra: extra
769+
});
770+
}
748771
};
749772

750773
// eslint-disable-next-line no-unused-vars

‎readme.markdown

+2-2
Original file line numberDiff line numberDiff line change
@@ -346,11 +346,11 @@ Multiline output will be split by `\n` characters, and each one printed as a com
346346

347347
## t.match(string, regexp, message)
348348

349-
Assert that `string` matches the RegExp `regexp`. Will throw (not just fail) when the first two arguments are the wrong type.
349+
Assert that `string` matches the RegExp `regexp`. Will fail when the first two arguments are the wrong type.
350350

351351
## t.doesNotMatch(string, regexp, message)
352352

353-
Assert that `string` does not match the RegExp `regexp`. Will throw (not just fail) when the first two arguments are the wrong type.
353+
Assert that `string` does not match the RegExp `regexp`. Will fail when the first two arguments are the wrong type.
354354

355355
## var htest = test.createHarness()
356356

‎test/match.js

+126-41
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,55 @@ tap.test('match', function (tt) {
1414
tt.same(stripFullStack(rows.toString('utf8')), [
1515
'TAP version 13',
1616
'# match',
17-
'ok 1 regex arg must be a regex',
18-
'ok 2 string arg must be a string',
19-
'not ok 3 The input did not match the regular expression /abc/. Input: \'string\'',
17+
'not ok 1 The "regexp" argument must be an instance of RegExp. Received type string (\'string\')',
18+
' ---',
19+
' operator: match',
20+
' expected: \'[object RegExp]\'',
21+
' actual: \'[object String]\'',
22+
' at: Test.<anonymous> ($TEST/match.js:$LINE:$COL)',
23+
' stack: |-',
24+
' Error: The "regexp" argument must be an instance of RegExp. Received type string (\'string\')',
25+
' [... stack stripped ...]',
26+
' at Test.<anonymous> ($TEST/match.js:$LINE:$COL)',
27+
' [... stack stripped ...]',
28+
' ...',
29+
'not ok 2 regex arg must not be a string',
30+
' ---',
31+
' operator: match',
32+
' expected: \'[object RegExp]\'',
33+
' actual: \'[object String]\'',
34+
' at: Test.<anonymous> ($TEST/match.js:$LINE:$COL)',
35+
' stack: |-',
36+
' Error: regex arg must not be a string',
37+
' [... stack stripped ...]',
38+
' at Test.<anonymous> ($TEST/match.js:$LINE:$COL)',
39+
' [... stack stripped ...]',
40+
' ...',
41+
'not ok 3 The "string" argument must be of type string. Received type object ({ abc: 123 })',
42+
' ---',
43+
' operator: match',
44+
' expected: \'string\'',
45+
' actual: \'object\'',
46+
' at: Test.<anonymous> ($TEST/match.js:$LINE:$COL)',
47+
' stack: |-',
48+
' Error: The "string" argument must be of type string. Received type object ({ abc: 123 })',
49+
' [... stack stripped ...]',
50+
' at Test.<anonymous> ($TEST/match.js:$LINE:$COL)',
51+
' [... stack stripped ...]',
52+
' ...',
53+
'not ok 4 string arg must not be an object',
54+
' ---',
55+
' operator: match',
56+
' expected: \'string\'',
57+
' actual: \'object\'',
58+
' at: Test.<anonymous> ($TEST/match.js:$LINE:$COL)',
59+
' stack: |-',
60+
' Error: string arg must not be an object',
61+
' [... stack stripped ...]',
62+
' at Test.<anonymous> ($TEST/match.js:$LINE:$COL)',
63+
' [... stack stripped ...]',
64+
' ...',
65+
'not ok 5 The input did not match the regular expression /abc/. Input: \'string\'',
2066
' ---',
2167
' operator: match',
2268
' expected: /abc/',
@@ -28,7 +74,7 @@ tap.test('match', function (tt) {
2874
' at Test.<anonymous> ($TEST/match.js:$LINE:$COL)',
2975
' [... stack stripped ...]',
3076
' ...',
31-
'not ok 4 "string" does not match /abc/',
77+
'not ok 6 "string" does not match /abc/',
3278
' ---',
3379
' operator: match',
3480
' expected: /abc/',
@@ -40,33 +86,27 @@ tap.test('match', function (tt) {
4086
' at Test.<anonymous> ($TEST/match.js:$LINE:$COL)',
4187
' [... stack stripped ...]',
4288
' ...',
43-
'ok 5 The input matched the regular expression /pass$/. Input: \'I will pass\'',
44-
'ok 6 "I will pass" matches /pass$/',
89+
'ok 7 The input matched the regular expression /pass$/. Input: \'I will pass\'',
90+
'ok 8 "I will pass" matches /pass$/',
4591
'',
46-
'1..6',
47-
'# tests 6',
48-
'# pass 4',
49-
'# fail 2',
92+
'1..8',
93+
'# tests 8',
94+
'# pass 2',
95+
'# fail 6',
5096
''
5197
]);
5298
};
5399

54100
test.createStream().pipe(concat(tc));
55101

56102
test('match', function (t) {
57-
t.plan(6);
103+
t.plan(8);
58104

59-
t.throws(
60-
function () { t.match(/abc/, 'string'); },
61-
TypeError,
62-
'regex arg must be a regex'
63-
);
105+
t.match(/abc/, 'string');
106+
t.match(/abc/, 'string', 'regex arg must not be a string');
64107

65-
t.throws(
66-
function () { t.match({ abc: 123 }, /abc/); },
67-
TypeError,
68-
'string arg must be a string'
69-
);
108+
t.match({ abc: 123 }, /abc/);
109+
t.match({ abc: 123 }, /abc/, 'string arg must not be an object');
70110

71111
t.match('string', /abc/);
72112
t.match('string', /abc/, '"string" does not match /abc/');
@@ -86,9 +126,55 @@ tap.test('doesNotMatch', function (tt) {
86126
tt.same(stripFullStack(rows.toString('utf8')), [
87127
'TAP version 13',
88128
'# doesNotMatch',
89-
'ok 1 regex arg must be a regex',
90-
'ok 2 string arg must be a string',
91-
'not ok 3 The input was expected to not match the regular expression /string/. Input: \'string\'',
129+
'not ok 1 The "regexp" argument must be an instance of RegExp. Received type string (\'string\')',
130+
' ---',
131+
' operator: doesNotMatch',
132+
' expected: \'[object RegExp]\'',
133+
' actual: \'[object String]\'',
134+
' at: Test.<anonymous> ($TEST/match.js:$LINE:$COL)',
135+
' stack: |-',
136+
' Error: The "regexp" argument must be an instance of RegExp. Received type string (\'string\')',
137+
' [... stack stripped ...]',
138+
' at Test.<anonymous> ($TEST/match.js:$LINE:$COL)',
139+
' [... stack stripped ...]',
140+
' ...',
141+
'not ok 2 regex arg must not be a string',
142+
' ---',
143+
' operator: doesNotMatch',
144+
' expected: \'[object RegExp]\'',
145+
' actual: \'[object String]\'',
146+
' at: Test.<anonymous> ($TEST/match.js:$LINE:$COL)',
147+
' stack: |-',
148+
' Error: regex arg must not be a string',
149+
' [... stack stripped ...]',
150+
' at Test.<anonymous> ($TEST/match.js:$LINE:$COL)',
151+
' [... stack stripped ...]',
152+
' ...',
153+
'not ok 3 The "string" argument must be of type string. Received type object ({ abc: 123 })',
154+
' ---',
155+
' operator: doesNotMatch',
156+
' expected: \'string\'',
157+
' actual: \'object\'',
158+
' at: Test.<anonymous> ($TEST/match.js:$LINE:$COL)',
159+
' stack: |-',
160+
' Error: The "string" argument must be of type string. Received type object ({ abc: 123 })',
161+
' [... stack stripped ...]',
162+
' at Test.<anonymous> ($TEST/match.js:$LINE:$COL)',
163+
' [... stack stripped ...]',
164+
' ...',
165+
'not ok 4 string arg must not be an object',
166+
' ---',
167+
' operator: doesNotMatch',
168+
' expected: \'string\'',
169+
' actual: \'object\'',
170+
' at: Test.<anonymous> ($TEST/match.js:$LINE:$COL)',
171+
' stack: |-',
172+
' Error: string arg must not be an object',
173+
' [... stack stripped ...]',
174+
' at Test.<anonymous> ($TEST/match.js:$LINE:$COL)',
175+
' [... stack stripped ...]',
176+
' ...',
177+
'not ok 5 The input was expected to not match the regular expression /string/. Input: \'string\'',
92178
' ---',
93179
' operator: doesNotMatch',
94180
' expected: /string/',
@@ -100,7 +186,7 @@ tap.test('doesNotMatch', function (tt) {
100186
' at Test.<anonymous> ($TEST/match.js:$LINE:$COL)',
101187
' [... stack stripped ...]',
102188
' ...',
103-
'not ok 4 "string" should not match /string/',
189+
'not ok 6 "string" should not match /string/',
104190
' ---',
105191
' operator: doesNotMatch',
106192
' expected: /string/',
@@ -112,7 +198,7 @@ tap.test('doesNotMatch', function (tt) {
112198
' at Test.<anonymous> ($TEST/match.js:$LINE:$COL)',
113199
' [... stack stripped ...]',
114200
' ...',
115-
'not ok 5 The input was expected to not match the regular expression /pass$/. Input: \'I will pass\'',
201+
'not ok 7 The input was expected to not match the regular expression /pass$/. Input: \'I will pass\'',
116202
' ---',
117203
' operator: doesNotMatch',
118204
' expected: /pass$/',
@@ -124,7 +210,7 @@ tap.test('doesNotMatch', function (tt) {
124210
' at Test.<anonymous> ($TEST/match.js:$LINE:$COL)',
125211
' [... stack stripped ...]',
126212
' ...',
127-
'not ok 6 "I will pass" should not match /pass$/',
213+
'not ok 8 "I will pass" should not match /pass$/',
128214
' ---',
129215
' operator: doesNotMatch',
130216
' expected: /pass$/',
@@ -136,38 +222,37 @@ tap.test('doesNotMatch', function (tt) {
136222
' at Test.<anonymous> ($TEST/match.js:$LINE:$COL)',
137223
' [... stack stripped ...]',
138224
' ...',
225+
'ok 9 The input did not match the regular expression /pass$/. Input: \'I will fail\'',
226+
'ok 10 "I will fail" does not match /pass$/',
139227
'',
140-
'1..6',
141-
'# tests 6',
228+
'1..10',
229+
'# tests 10',
142230
'# pass 2',
143-
'# fail 4',
231+
'# fail 8',
144232
''
145233
]);
146234
};
147235

148236
test.createStream().pipe(concat(tc));
149237

150238
test('doesNotMatch', function (t) {
151-
t.plan(6);
239+
t.plan(10);
152240

153-
t.throws(
154-
function () { t.doesNotMatch(/abc/, 'string'); },
155-
TypeError,
156-
'regex arg must be a regex'
157-
);
241+
t.doesNotMatch(/abc/, 'string');
242+
t.doesNotMatch(/abc/, 'string', 'regex arg must not be a string');
158243

159-
t.throws(
160-
function () { t.doesNotMatch({ abc: 123 }, /abc/); },
161-
TypeError,
162-
'string arg must be a string'
163-
);
244+
t.doesNotMatch({ abc: 123 }, /abc/);
245+
t.doesNotMatch({ abc: 123 }, /abc/, 'string arg must not be an object');
164246

165247
t.doesNotMatch('string', /string/);
166248
t.doesNotMatch('string', /string/, '"string" should not match /string/');
167249

168250
t.doesNotMatch('I will pass', /pass$/);
169251
t.doesNotMatch('I will pass', /pass$/, '"I will pass" should not match /pass$/');
170252

253+
t.doesNotMatch('I will fail', /pass$/);
254+
t.doesNotMatch('I will fail', /pass$/, '"I will fail" does not match /pass$/');
255+
171256
t.end();
172257
});
173258
});

0 commit comments

Comments
 (0)