« get me outta code hell

validators.js « things « data « unit « test - hsmusic-wiki - HSMusic - static wiki software cataloguing collaborative creation
about summary refs log tree commit diff
path: root/test/unit/data/things/validators.js
blob: 11134a90077d5c39319592c02a2b399061387b9f (plain)
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
import t from 'tap';
import {showAggregate} from '#sugar';

import {
  // Basic types
  isBoolean,
  isCountingNumber,
  isDate,
  isNumber,
  isString,
  isStringNonEmpty,

  // Complex types
  isArray,
  isObject,
  validateArrayItems,

  // Wiki data
  isColor,
  isCommentary,
  isContentString,
  isContribution,
  isContributionList,
  isDimensions,
  isDirectory,
  isDuration,
  isFileExtension,
  isName,
  isURL,
  validateReference,
  validateReferenceList,

  // Compositional utilities
  anyOf,
} from '#validators';

function test(t, msg, fn) {
  t.test(msg, t => {
    try {
      fn(t);
    } catch (error) {
      if (error instanceof AggregateError) {
        showAggregate(error);
      }
      throw error;
    }
  });
}

// Basic types

test(t, 'isBoolean', t => {
  t.plan(4);
  t.ok(isBoolean(true));
  t.ok(isBoolean(false));
  t.throws(() => isBoolean(1), TypeError);
  t.throws(() => isBoolean('yes'), TypeError);
});

test(t, 'isNumber', t => {
  t.plan(6);
  t.ok(isNumber(123));
  t.ok(isNumber(0.05));
  t.ok(isNumber(0));
  t.ok(isNumber(-10));
  t.throws(() => isNumber('413'), TypeError);
  t.throws(() => isNumber(true), TypeError);
});

test(t, 'isCountingNumber', t => {
  t.plan(6);
  t.ok(isCountingNumber(3));
  t.ok(isCountingNumber(1));
  t.throws(() => isCountingNumber(1.75), TypeError);
  t.throws(() => isCountingNumber(0), TypeError);
  t.throws(() => isCountingNumber(-1), TypeError);
  t.throws(() => isCountingNumber('612'), TypeError);
});

test(t, 'isString', t => {
  t.plan(3);
  t.ok(isString('hello!'));
  t.ok(isString(''));
  t.throws(() => isString(100), TypeError);
});

test(t, 'isStringNonEmpty', t => {
  t.plan(4);
  t.ok(isStringNonEmpty('hello!'));
  t.throws(() => isStringNonEmpty(''), TypeError);
  t.throws(() => isStringNonEmpty('     '), TypeError);
  t.throws(() => isStringNonEmpty(100), TypeError);
});

// Complex types

test(t, 'isArray', t => {
  t.plan(3);
  t.ok(isArray([]));
  t.throws(() => isArray({}), TypeError);
  t.throws(() => isArray('1, 2, 3'), TypeError);
});

test(t, 'isDate', t => {
  t.plan(3);
  t.ok(isDate(new Date('2023-03-27 09:24:15')));
  t.throws(() => isDate(new Date(Infinity)), TypeError);
  t.throws(() => isDimensions('2023-03-27 09:24:15'), TypeError);
});

test(t, 'isObject', t => {
  t.plan(3);
  t.ok(isObject({}));
  t.ok(isObject([]));
  t.throws(() => isObject(null), TypeError);
});

test(t, 'validateArrayItems', t => {
  t.plan(9);

  t.ok(validateArrayItems(isNumber)([3, 4, 5]));
  t.ok(validateArrayItems(validateArrayItems(isNumber))([[3, 4], [4, 5], [6, 7]]));

  let caughtError = null;
  try {
    validateArrayItems(isNumber)([10, 20, 'one hundred million consorts', 30]);
  } catch (err) {
    caughtError = err;
  }

  t.not(caughtError, null);
  t.ok(caughtError instanceof AggregateError);
  t.equal(caughtError.errors.length, 1);
  t.ok(caughtError.errors[0] instanceof Error);
  t.equal(caughtError.errors[0][Symbol.for('hsmusic.annotateError.indexInSourceArray')], 2);
  t.not(caughtError.errors[0].cause, null);
  t.ok(caughtError.errors[0].cause instanceof TypeError);
});

// Wiki data

t.test('isColor', t => {
  t.plan(9);
  t.ok(isColor('#123'));
  t.ok(isColor('#1234'));
  t.ok(isColor('#112233'));
  t.ok(isColor('#11223344'));
  t.ok(isColor('#abcdef00'));
  t.ok(isColor('#ABCDEF'));
  t.throws(() => isColor('#ggg'), TypeError);
  t.throws(() => isColor('red'), TypeError);
  t.throws(() => isColor('hsl(150deg 30% 60%)'), TypeError);
});

t.test('isCommentary', t => {
  t.plan(9);

  // TODO: Test specific error messages.
  t.ok(isCommentary(`<i>Toby Fox:</i>\ndogsong.mp3`));
  t.ok(isCommentary(`<i>Toby Fox:</i> (music)\ndogsong.mp3`));
  t.throws(() => isCommentary(`dogsong.mp3\n<i>Toby Fox:</i>\ndogsong.mp3`));
  t.throws(() => isCommentary(`<i>Toby Fox:</i> dogsong.mp3`));
  t.throws(() => isCommentary(`<i>Toby Fox:</i> (music) dogsong.mp3`));
  t.throws(() => isCommentary(`<i>I Have Nothing To Say:</i>`));
  t.throws(() => isCommentary(123));
  t.throws(() => isCommentary(``));
  t.throws(() => isCommentary(`Technically, ah, er:</i>\nCorrect`));
});

t.test('isContentString', t => {
  t.plan(12);

  t.ok(isContentString(`Hello, world!`));
  t.ok(isContentString(`Hello...\nWorld!`));

  const quickThrows = (string, description) =>
    t.throws(() => isContentString(string), description);

  quickThrows(
    `Snooping\xa0as usual, I\xa0\xa0\xa0SEE.`,
    Object.assign(
      new AggregateError([
        new AggregateError([
          new TypeError(`Replace "\xa0" (non-breaking space) with " " (normal space) between "ing" and "as " (pos: 9)`),
          new TypeError(`Replace "\xa0\xa0\xa0" (non-breaking space) with "   " (normal space) between ", I" and "SEE" (pos: 21)`),
        ], `Illegal characters found in content string`),
      ], `Errors validating content string`),
      {[Symbol.for(`hsmusic.aggregate.translucent`)]: 'single'}));

  quickThrows(
    `Oh\u200bdear,\n` +
    `Oh dear,\n` +
    `oh-dear-oh-dear-oh\u200bdear.`,
    new AggregateError([
      new AggregateError([
        new TypeError(`Delete "\u200b" (zero-width space) between "Oh" and "dea" (line: 1, col: 3)`),
        new TypeError(`Delete "\u200b" (zero-width space) between "-oh" and "dea" (line: 3, col: 19)`),
      ]),
    ]));

  quickThrows(
    `Well the days start comin'\xa0\xa0\xa0\xa0\u200b\u200b\xa0\xa0\xa0\u200b\u200b\u200band they don't stop comin'`,
    new AggregateError([
      new AggregateError([
        new TypeError(`Replace "\xa0\xa0\xa0\xa0" (non-breaking space) with "    " (normal space) after "in'" (pos: 27)`),
        new TypeError(`Delete "\u200b\u200b" (zero-width space) (pos: 31)`),
        new TypeError(`Replace "\xa0\xa0\xa0" (non-breaking space) with "   " (normal space) (pos: 33)`),
        new TypeError(`Delete "\u200b\u200b\u200b" (zero-width space) before "and" (pos: 36)`),
      ]),
    ]));

  quickThrows(
    `It's go-\u200bin',\n` +
    `\u200bIt's goin',\u200b\n` +
    `\u200b\u200bIt's going!`,
    new AggregateError([
      new AggregateError([
        new TypeError(`Delete "\u200b" (zero-width space) between "go-" and "in'" (line: 1, col: 9)`),
        new TypeError(`Delete "\u200b" (zero-width space) before "It'" (line: 2, col: 1)`),
        new TypeError(`Delete "\u200b" (zero-width space) after "n'," (line: 2, col: 13)`),
        new TypeError(`Delete "\u200b\u200b" (zero-width space) before "It'" (line: 3, col: 1)`),
      ]),
    ]));

  quickThrows(
    `  Room at the start.`,
    new AggregateError([
      new AggregateError([
        new TypeError(`Matched "  " at start`),
      ], `Whitespace found at start or end`),
    ]));

  quickThrows(
    `Room at the end.      `,
    new AggregateError([
      new AggregateError([
        new TypeError(`Matched "      " at end`),
      ], `Whitespace found at start or end`),
    ]));

  quickThrows(
    `      Room on both sides. `,
    new AggregateError([
      new AggregateError([
        new TypeError(`Matched "      " at start`),
        new TypeError(`Matched " " at end`),
      ], `Whitespace found at start or end`),
    ]));

  quickThrows(
    `We're going multiline! \n` +
    `That we are, aye.    \n` +
    `      \n`,
    `Yessir.`,
    new AggregateError([
      new AggregateError([
        new TypeError(`Matched " " at end of line 1`),
        new TypeError(`Matched "    " at end of line 2`),
        new TypeError(`Matched "      " as all of line 3`),
      ], `Whitespace found at end of line`),
    ]));

  t.doesNotThrow(() =>
    isContentString(
      `It's cool.\n` +
      `  It's cool.\n` +
      `    It's cool.\n` +
      `      It's so cool.`));

  t.doesNotThrow(() =>
    isContentString(
      `\n` +
      `\n` +
      `It's okay for\n` +
      `blank lines\n` +
      `\n` +
      `just about anywhere.\n` +
      ``));
});

t.test('isContribution', t => {
  t.plan(4);
  t.ok(isContribution({who: 'artist:toby-fox', what: 'Music'}));
  t.ok(isContribution({who: 'Toby Fox'}));
  t.throws(() => isContribution(({who: 'group:umspaf', what: 'Organizing'})),
    {errors: /who/});
  t.throws(() => isContribution(({who: 'artist:toby-fox', what: 123})),
    {errors: /what/});
});

t.test('isContributionList', t => {
  t.plan(4);
  t.ok(isContributionList([{who: 'Beavis'}, {who: 'Butthead', what: 'Wrangling'}]));
  t.ok(isContributionList([]));
  t.throws(() => isContributionList(2));
  t.throws(() => isContributionList(['Charlie', 'Woodstock']));
});

test(t, 'isDimensions', t => {
  t.plan(6);
  t.ok(isDimensions([1, 1]));
  t.ok(isDimensions([50, 50]));
  t.ok(isDimensions([5000, 1]));
  t.throws(() => isDimensions([1]), TypeError);
  t.throws(() => isDimensions([413, 612, 1025]), TypeError);
  t.throws(() => isDimensions('800x200'), TypeError);
});

test(t, 'isDirectory', t => {
  t.plan(6);
  t.ok(isDirectory('savior-of-the-waking-world'));
  t.ok(isDirectory('MeGaLoVania'));
  t.ok(isDirectory('ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789-_'));
  t.throws(() => isDirectory(123), TypeError);
  t.throws(() => isDirectory(''), TypeError);
  t.throws(() => isDirectory('troll saint nicholas and the quest for the holy pail'), TypeError);
});

test(t, 'isDuration', t => {
  t.plan(5);
  t.ok(isDuration(60));
  t.ok(isDuration(0.02));
  t.ok(isDuration(0));
  t.throws(() => isDuration(-1), TypeError);
  t.throws(() => isDuration('10:25'), TypeError);
});

test(t, 'isFileExtension', t => {
  t.plan(6);
  t.ok(isFileExtension('png'));
  t.ok(isFileExtension('jpg'));
  t.ok(isFileExtension('sub_loc'));
  t.throws(() => isFileExtension(''), TypeError);
  t.throws(() => isFileExtension('.jpg'), TypeError);
  t.throws(() => isFileExtension('just an image bro!!!!'), TypeError);
});

t.test('isName', t => {
  t.plan(4);
  t.ok(isName('Dogz 2.0'));
  t.ok(isName('album:this-track-is-only-named-thusly-to-give-niklink-a-headache'));
  t.throws(() => isName(''));
  t.throws(() => isName(612));
});

t.test('isURL', t => {
  t.plan(4);
  t.ok(isURL(`https://hsmusic.wiki/foo/bar/hi?baz=25#hash`));
  t.throws(() => isURL(`/the/dog/zone/`));
  t.throws(() => isURL(25));
  t.throws(() => isURL(new URL(`https://hsmusic.wiki/perfectly/reasonable/`)));
});

test(t, 'validateReference', t => {
  t.plan(16);

  const typeless = validateReference();
  const track = validateReference('track');
  const album = validateReference('album');

  t.ok(track('track:doctor'));
  t.ok(track('track:MeGaLoVania'));
  t.ok(track('Showtime (Imp Strife Mix)'));
  t.throws(() => track('track:troll saint nic'), TypeError);
  t.throws(() => track('track:'), TypeError);
  t.throws(() => track('album:homestuck-vol-1'), TypeError);

  t.ok(album('album:sburb'));
  t.ok(album('album:the-wanderers'));
  t.ok(album('Homestuck Vol. 8'));
  t.throws(() => album('album:Hiveswap Friendsim'), TypeError);
  t.throws(() => album('album:'), TypeError);
  t.throws(() => album('track:showtime-piano-refrain'), TypeError);

  t.ok(typeless('Hopes and Dreams'));
  t.ok(typeless('track:snowdin-town'));
  t.throws(() => typeless(''), TypeError);
  t.throws(() => typeless('album:undertale-soundtrack'));
});

test(t, 'validateReferenceList', t => {
  const track = validateReferenceList('track');
  const artist = validateReferenceList('artist');

  t.plan(11);

  t.ok(track(['track:fallen-down', 'Once Upon a Time']));
  t.ok(artist(['artist:toby-fox', 'Mark Hadley']));
  t.ok(track(['track:amalgam']));
  t.ok(track([]));

  let caughtError = null;
  try {
    track(['Dog', 'album:vaporwave-2016', 'Cat', 'artist:john-madden']);
  } catch (err) {
    caughtError = err;
  }

  t.not(caughtError, null);
  t.ok(caughtError instanceof AggregateError);
  t.equal(caughtError.errors.length, 2);
  t.ok(caughtError.errors[0] instanceof Error);
  t.ok(caughtError.errors[0].cause instanceof TypeError);
  t.ok(caughtError.errors[1] instanceof Error);
  t.ok(caughtError.errors[0].cause instanceof TypeError);
});

test(t, 'anyOf', t => {
  t.plan(11);

  const isStringOrNumber = anyOf(isString, isNumber);

  t.ok(isStringOrNumber('hello world'));
  t.ok(isStringOrNumber(42));
  t.throws(() => isStringOrNumber(false));

  const mockError = new Error();
  const neverSucceeds = () => {
    throw mockError;
  };

  const isStringOrGetRekt = anyOf(isString, neverSucceeds);

  t.ok(isStringOrGetRekt('phew!'));

  let caughtError = null;
  try {
    isStringOrGetRekt(0xdeadbeef);
  } catch (err) {
    caughtError = err;
  }

  t.not(caughtError, null);
  t.ok(caughtError instanceof AggregateError);
  t.equal(caughtError.errors.length, 2);
  t.ok(caughtError.errors[0] instanceof TypeError);
  t.equal(caughtError.errors[0].check, isString);
  t.equal(caughtError.errors[1], mockError);
  t.equal(caughtError.errors[1].check, neverSucceeds);
});