test/utils/Utils.test.ts

   1 import { hoursToMilliseconds } from 'date-fns';
   2 import { expect } from 'expect';
   3
   4 import { Constants } from '../../src/utils/Constants';
   5 import {
   6   cloneObject,
   7   convertToBoolean,
   8   convertToDate,
   9   convertToFloat,
  10   convertToInt,
  11   formatDurationMilliSeconds,
  12   generateUUID,
  13   getRandomFloat,
  14   getRandomInteger,
  15   hasOwnProp,
  16   isArraySorted,
  17   isEmptyArray,
  18   isEmptyObject,
  19   isEmptyString,
  20   isIterable,
  21   isNotEmptyArray,
  22   isNotEmptyString,
  23   isNullOrUndefined,
  24   isObject,
  25   isUndefined,
  26   isValidDate,
  27   roundTo,
  28   secureRandom,
  29   sleep,
  30   validateUUID,
  31 } from '../../src/utils/Utils';
  32
  33 describe('Utils test suite', () => {
  34   it('Verify generateUUID()/validateUUID()', () => {
  35     const uuid = generateUUID();
  36     expect(uuid).toBeDefined();
  37     expect(uuid.length).toEqual(36);
  38     expect(validateUUID(uuid)).toBe(true);
  39     expect(validateUUID('abcdef00-0000-4000-0000-000000000000')).toBe(true);
  40     expect(validateUUID('')).toBe(false);
  41     // Shall invalidate Nil UUID
  42     expect(validateUUID('00000000-0000-0000-0000-000000000000')).toBe(false);
  43     expect(validateUUID('987FBC9-4BED-3078-CF07A-9141BA07C9F3')).toBe(false);
  44   });
  45
  46   it('Verify sleep()', async () => {
  47     const start = performance.now();
  48     await sleep(1000);
  49     const end = performance.now();
  50     expect(end - start).toBeGreaterThanOrEqual(1000);
  51   });
  52
  53   it('Verify formatDurationMilliSeconds()', () => {
  54     expect(formatDurationMilliSeconds(0)).toBe('');
  55     expect(formatDurationMilliSeconds(1000)).toBe('1 second');
  56     expect(formatDurationMilliSeconds(hoursToMilliseconds(4380))).toBe('182 days 12 hours');
  57   });
  58
  59   it('Verify isValidDate()', () => {
  60     expect(isValidDate(undefined)).toBe(false);
  61     expect(isValidDate(null)).toBe(false);
  62     expect(isValidDate('')).toBe(false);
  63     expect(isValidDate({})).toBe(false);
  64     expect(isValidDate([])).toBe(false);
  65     expect(isValidDate(new Map())).toBe(false);
  66     expect(isValidDate(new Set())).toBe(false);
  67     expect(isValidDate(new WeakMap())).toBe(false);
  68     expect(isValidDate(new WeakSet())).toBe(false);
  69     expect(isValidDate(-1)).toBe(true);
  70     expect(isValidDate(0)).toBe(true);
  71     expect(isValidDate(1)).toBe(true);
  72     expect(isValidDate(-0.5)).toBe(true);
  73     expect(isValidDate(0.5)).toBe(true);
  74     expect(isValidDate(new Date())).toBe(true);
  75   });
  76
  77   it('Verify convertToDate()', () => {
  78     expect(convertToDate(undefined)).toBe(undefined);
  79     expect(convertToDate(null)).toBe(null);
  80     const invalidDate = convertToDate('');
  81     expect(invalidDate instanceof Date && !isNaN(invalidDate.getTime())).toBe(false);
  82     expect(convertToDate(0)).toStrictEqual(new Date('1970-01-01T00:00:00.000Z'));
  83     const dateStr = '2020-01-01T00:00:00.000Z';
  84     let date = convertToDate(dateStr);
  85     expect(date).toBeInstanceOf(Date);
  86     expect(date).toStrictEqual(new Date(dateStr));
  87     date = convertToDate(new Date(dateStr));
  88     expect(date).toBeInstanceOf(Date);
  89     expect(date).toStrictEqual(new Date(dateStr));
  90   });
  91
  92   it('Verify convertToInt()', () => {
  93     expect(convertToInt(undefined)).toBe(0);
  94     expect(convertToInt(null)).toBe(0);
  95     expect(convertToInt(0)).toBe(0);
  96     const randomInteger = getRandomInteger();
  97     expect(convertToInt(randomInteger)).toEqual(randomInteger);
  98     expect(convertToInt('-1')).toBe(-1);
  99     expect(convertToInt('1')).toBe(1);
 100     expect(convertToInt('1.1')).toBe(1);
 101     expect(convertToInt('1.9')).toBe(1);
 102     expect(convertToInt('1.999')).toBe(1);
 103     expect(convertToInt(-1)).toBe(-1);
 104     expect(convertToInt(1)).toBe(1);
 105     expect(convertToInt(1.1)).toBe(1);
 106     expect(convertToInt(1.9)).toBe(1);
 107     expect(convertToInt(1.999)).toBe(1);
 108     expect(() => {
 109       convertToInt('NaN');
 110     }).toThrow('Cannot convert to integer: NaN');
 111   });
 112
 113   it('Verify convertToFloat()', () => {
 114     expect(convertToFloat(undefined)).toBe(0);
 115     expect(convertToFloat(null)).toBe(0);
 116     expect(convertToFloat(0)).toBe(0);
 117     const randomFloat = getRandomFloat();
 118     expect(convertToFloat(randomFloat)).toEqual(randomFloat);
 119     expect(convertToFloat('-1')).toBe(-1);
 120     expect(convertToFloat('1')).toBe(1);
 121     expect(convertToFloat('1.1')).toBe(1.1);
 122     expect(convertToFloat('1.9')).toBe(1.9);
 123     expect(convertToFloat('1.999')).toBe(1.999);
 124     expect(convertToFloat(-1)).toBe(-1);
 125     expect(convertToFloat(1)).toBe(1);
 126     expect(convertToFloat(1.1)).toBe(1.1);
 127     expect(convertToFloat(1.9)).toBe(1.9);
 128     expect(convertToFloat(1.999)).toBe(1.999);
 129     expect(() => {
 130       convertToFloat('NaN');
 131     }).toThrow('Cannot convert to float: NaN');
 132   });
 133
 134   it('Verify convertToBoolean()', () => {
 135     expect(convertToBoolean(undefined)).toBe(false);
 136     expect(convertToBoolean(null)).toBe(false);
 137     expect(convertToBoolean('true')).toBe(true);
 138     expect(convertToBoolean('false')).toBe(false);
 139     expect(convertToBoolean('TRUE')).toBe(true);
 140     expect(convertToBoolean('FALSE')).toBe(false);
 141     expect(convertToBoolean('1')).toBe(true);
 142     expect(convertToBoolean('0')).toBe(false);
 143     expect(convertToBoolean(1)).toBe(true);
 144     expect(convertToBoolean(0)).toBe(false);
 145     expect(convertToBoolean(true)).toBe(true);
 146     expect(convertToBoolean(false)).toBe(false);
 147     expect(convertToBoolean('')).toBe(false);
 148     expect(convertToBoolean('NoNBoolean')).toBe(false);
 149   });
 150
 151   it('Verify secureRandom()', () => {
 152     const random = secureRandom();
 153     expect(typeof random === 'number').toBe(true);
 154     expect(random).toBeGreaterThanOrEqual(0);
 155     expect(random).toBeLessThan(1);
 156   });
 157
 158   it('Verify getRandomInteger()', () => {
 159     let randomInteger = getRandomInteger();
 160     expect(Number.isSafeInteger(randomInteger)).toBe(true);
 161     expect(randomInteger).toBeGreaterThanOrEqual(0);
 162     expect(randomInteger).toBeLessThanOrEqual(Constants.MAX_RANDOM_INTEGER);
 163     expect(randomInteger).not.toEqual(getRandomInteger());
 164     randomInteger = getRandomInteger(0, -Constants.MAX_RANDOM_INTEGER);
 165     expect(randomInteger).toBeGreaterThanOrEqual(-Constants.MAX_RANDOM_INTEGER);
 166     expect(randomInteger).toBeLessThanOrEqual(0);
 167     expect(() => getRandomInteger(0, 1)).toThrowError(
 168       'The value of "max" is out of range. It must be greater than the value of "min" (1). Received 1',
 169     );
 170     expect(() => getRandomInteger(-1)).toThrowError(
 171       'The value of "max" is out of range. It must be greater than the value of "min" (0). Received 0',
 172     );
 173     expect(() => getRandomInteger(Constants.MAX_RANDOM_INTEGER + 1)).toThrowError(
 174       `The value of "max" is out of range. It must be <= ${
 175         Constants.MAX_RANDOM_INTEGER + 1
 176       }. Received 281_474_976_710_656`,
 177     );
 178     randomInteger = getRandomInteger(2, 1);
 179     expect(randomInteger).toBeGreaterThanOrEqual(1);
 180     expect(randomInteger).toBeLessThanOrEqual(2);
 181     const max = 2.2,
 182       min = 1.1;
 183     randomInteger = getRandomInteger(max, min);
 184     expect(randomInteger).toBeGreaterThanOrEqual(Math.ceil(min));
 185     expect(randomInteger).toBeLessThanOrEqual(Math.floor(max));
 186   });
 187
 188   it('Verify roundTo()', () => {
 189     expect(roundTo(0, 2)).toBe(0);
 190     expect(roundTo(0.5, 0)).toBe(1);
 191     expect(roundTo(0.5, 2)).toBe(0.5);
 192     expect(roundTo(-0.5, 0)).toBe(-1);
 193     expect(roundTo(-0.5, 2)).toBe(-0.5);
 194     expect(roundTo(1.005, 0)).toBe(1);
 195     expect(roundTo(1.005, 2)).toBe(1.01);
 196     expect(roundTo(2.175, 2)).toBe(2.18);
 197     expect(roundTo(5.015, 2)).toBe(5.02);
 198     expect(roundTo(-1.005, 2)).toBe(-1.01);
 199     expect(roundTo(-2.175, 2)).toBe(-2.18);
 200     expect(roundTo(-5.015, 2)).toBe(-5.02);
 201   });
 202
 203   it('Verify getRandomFloat()', () => {
 204     let randomFloat = getRandomFloat();
 205     expect(typeof randomFloat === 'number').toBe(true);
 206     expect(randomFloat).toBeGreaterThanOrEqual(0);
 207     expect(randomFloat).toBeLessThanOrEqual(Number.MAX_VALUE);
 208     expect(randomFloat).not.toEqual(getRandomFloat());
 209     expect(() => getRandomFloat(0, 1)).toThrowError(new RangeError('Invalid interval'));
 210     expect(() => getRandomFloat(Number.MAX_VALUE, -Number.MAX_VALUE)).toThrowError(
 211       new RangeError('Invalid interval'),
 212     );
 213     randomFloat = getRandomFloat(0, -Number.MAX_VALUE);
 214     expect(randomFloat).toBeGreaterThanOrEqual(-Number.MAX_VALUE);
 215     expect(randomFloat).toBeLessThanOrEqual(0);
 216   });
 217
 218   it('Verify isObject()', () => {
 219     expect(isObject('test')).toBe(false);
 220     expect(isObject(undefined)).toBe(false);
 221     expect(isObject(null)).toBe(false);
 222     expect(isObject(0)).toBe(false);
 223     expect(isObject([])).toBe(false);
 224     expect(isObject([0, 1])).toBe(false);
 225     expect(isObject(['0', '1'])).toBe(false);
 226     expect(isObject({})).toBe(true);
 227     expect(isObject({ 1: 1 })).toBe(true);
 228     expect(isObject({ '1': '1' })).toBe(true);
 229     expect(isObject(new Map())).toBe(true);
 230     expect(isObject(new Set())).toBe(true);
 231     expect(isObject(new WeakMap())).toBe(true);
 232     expect(isObject(new WeakSet())).toBe(true);
 233   });
 234
 235   it('Verify cloneObject()', () => {
 236     const obj = { 1: 1 };
 237     expect(cloneObject(obj)).toStrictEqual(obj);
 238     expect(cloneObject(obj) === obj).toBe(false);
 239     const array = [1, 2];
 240     expect(cloneObject(array)).toStrictEqual(array);
 241     expect(cloneObject(array) === array).toBe(false);
 242     const date = new Date();
 243     expect(cloneObject(date)).toStrictEqual(date);
 244     expect(cloneObject(date) === date).toBe(false);
 245     const map = new Map([['1', '2']]);
 246     expect(cloneObject(map)).toStrictEqual(map);
 247     expect(cloneObject(map) === map).toBe(false);
 248     const set = new Set(['1']);
 249     expect(cloneObject(set)).toStrictEqual(set);
 250     expect(cloneObject(set) === set).toBe(false);
 251     // The URL object seems to have not enumerable properties
 252     const url = new URL('https://domain.tld');
 253     expect(cloneObject(url)).toStrictEqual(url);
 254     expect(cloneObject(url) === url).toBe(true);
 255     const weakMap = new WeakMap([[{ 1: 1 }, { 2: 2 }]]);
 256     expect(cloneObject(weakMap)).toStrictEqual(weakMap);
 257     expect(cloneObject(weakMap) === weakMap).toBe(true);
 258     const weakSet = new WeakSet([{ 1: 1 }, { 2: 2 }]);
 259     expect(cloneObject(weakSet)).toStrictEqual(weakSet);
 260     expect(cloneObject(weakSet) === weakSet).toBe(true);
 261   });
 262
 263   it('Verify hasOwnProp()', () => {
 264     expect(hasOwnProp('test', '')).toBe(false);
 265     expect(hasOwnProp(undefined, '')).toBe(false);
 266     expect(hasOwnProp(null, '')).toBe(false);
 267     expect(hasOwnProp([], '')).toBe(false);
 268     expect(hasOwnProp({}, '')).toBe(false);
 269     expect(hasOwnProp({ 1: 1 }, 1)).toBe(true);
 270     expect(hasOwnProp({ 1: 1 }, '1')).toBe(true);
 271     expect(hasOwnProp({ 1: 1 }, 2)).toBe(false);
 272     expect(hasOwnProp({ 1: 1 }, '2')).toBe(false);
 273     expect(hasOwnProp({ '1': '1' }, '1')).toBe(true);
 274     expect(hasOwnProp({ '1': '1' }, 1)).toBe(true);
 275     expect(hasOwnProp({ '1': '1' }, '2')).toBe(false);
 276     expect(hasOwnProp({ '1': '1' }, 2)).toBe(false);
 277   });
 278
 279   it('Verify isIterable()', () => {
 280     expect(isIterable('')).toBe(true);
 281     expect(isIterable(' ')).toBe(true);
 282     expect(isIterable('test')).toBe(true);
 283     expect(isIterable(undefined)).toBe(false);
 284     expect(isIterable(null)).toBe(false);
 285     expect(isIterable(0)).toBe(false);
 286     expect(isIterable([0, 1])).toBe(true);
 287     expect(isIterable({ 1: 1 })).toBe(false);
 288     expect(isIterable(new Map())).toBe(true);
 289     expect(isIterable(new Set())).toBe(true);
 290     expect(isIterable(new WeakMap())).toBe(false);
 291     expect(isIterable(new WeakSet())).toBe(false);
 292   });
 293
 294   it('Verify isEmptyString()', () => {
 295     expect(isEmptyString('')).toBe(true);
 296     expect(isEmptyString(' ')).toBe(true);
 297     expect(isEmptyString('     ')).toBe(true);
 298     expect(isEmptyString('test')).toBe(false);
 299     expect(isEmptyString(' test')).toBe(false);
 300     expect(isEmptyString('test ')).toBe(false);
 301     expect(isEmptyString(undefined)).toBe(true);
 302     expect(isEmptyString(null)).toBe(true);
 303     expect(isEmptyString(0)).toBe(false);
 304     expect(isEmptyString({})).toBe(false);
 305     expect(isEmptyString([])).toBe(false);
 306     expect(isEmptyString(new Map())).toBe(false);
 307     expect(isEmptyString(new Set())).toBe(false);
 308     expect(isEmptyString(new WeakMap())).toBe(false);
 309     expect(isEmptyString(new WeakSet())).toBe(false);
 310   });
 311
 312   it('Verify isNotEmptyString()', () => {
 313     expect(isNotEmptyString('')).toBe(false);
 314     expect(isNotEmptyString(' ')).toBe(false);
 315     expect(isNotEmptyString('     ')).toBe(false);
 316     expect(isNotEmptyString('test')).toBe(true);
 317     expect(isNotEmptyString(' test')).toBe(true);
 318     expect(isNotEmptyString('test ')).toBe(true);
 319     expect(isNotEmptyString(undefined)).toBe(false);
 320     expect(isNotEmptyString(null)).toBe(false);
 321     expect(isNotEmptyString(0)).toBe(false);
 322     expect(isNotEmptyString({})).toBe(false);
 323     expect(isNotEmptyString([])).toBe(false);
 324     expect(isNotEmptyString(new Map())).toBe(false);
 325     expect(isNotEmptyString(new Set())).toBe(false);
 326     expect(isNotEmptyString(new WeakMap())).toBe(false);
 327     expect(isNotEmptyString(new WeakSet())).toBe(false);
 328   });
 329
 330   it('Verify isUndefined()', () => {
 331     expect(isUndefined(undefined)).toBe(true);
 332     expect(isUndefined(null)).toBe(false);
 333     expect(isUndefined('')).toBe(false);
 334     expect(isUndefined(0)).toBe(false);
 335     expect(isUndefined({})).toBe(false);
 336     expect(isUndefined([])).toBe(false);
 337     expect(isUndefined(new Map())).toBe(false);
 338     expect(isUndefined(new Set())).toBe(false);
 339     expect(isUndefined(new WeakMap())).toBe(false);
 340     expect(isUndefined(new WeakSet())).toBe(false);
 341   });
 342
 343   it('Verify isNullOrUndefined()', () => {
 344     expect(isNullOrUndefined(undefined)).toBe(true);
 345     expect(isNullOrUndefined(null)).toBe(true);
 346     expect(isNullOrUndefined('')).toBe(false);
 347     expect(isNullOrUndefined(0)).toBe(false);
 348     expect(isNullOrUndefined({})).toBe(false);
 349     expect(isNullOrUndefined([])).toBe(false);
 350     expect(isNullOrUndefined(new Map())).toBe(false);
 351     expect(isNullOrUndefined(new Set())).toBe(false);
 352     expect(isNullOrUndefined(new WeakMap())).toBe(false);
 353     expect(isNullOrUndefined(new WeakSet())).toBe(false);
 354   });
 355
 356   it('Verify isEmptyArray()', () => {
 357     expect(isEmptyArray([])).toBe(true);
 358     expect(isEmptyArray([1, 2])).toBe(false);
 359     expect(isEmptyArray(['1', '2'])).toBe(false);
 360     expect(isEmptyArray(undefined)).toBe(false);
 361     expect(isEmptyArray(null)).toBe(false);
 362     expect(isEmptyArray('')).toBe(false);
 363     expect(isEmptyArray('test')).toBe(false);
 364     expect(isEmptyArray(0)).toBe(false);
 365     expect(isEmptyArray({})).toBe(false);
 366     expect(isEmptyArray(new Map())).toBe(false);
 367     expect(isEmptyArray(new Set())).toBe(false);
 368     expect(isEmptyArray(new WeakMap())).toBe(false);
 369     expect(isEmptyArray(new WeakSet())).toBe(false);
 370   });
 371
 372   it('Verify isNotEmptyArray()', () => {
 373     expect(isNotEmptyArray([])).toBe(false);
 374     expect(isNotEmptyArray([1, 2])).toBe(true);
 375     expect(isNotEmptyArray(['1', '2'])).toBe(true);
 376     expect(isNotEmptyArray(undefined)).toBe(false);
 377     expect(isNotEmptyArray(null)).toBe(false);
 378     expect(isNotEmptyArray('')).toBe(false);
 379     expect(isNotEmptyArray('test')).toBe(false);
 380     expect(isNotEmptyArray(0)).toBe(false);
 381     expect(isNotEmptyArray({})).toBe(false);
 382     expect(isNotEmptyArray(new Map())).toBe(false);
 383     expect(isNotEmptyArray(new Set())).toBe(false);
 384     expect(isNotEmptyArray(new WeakMap())).toBe(false);
 385     expect(isNotEmptyArray(new WeakSet())).toBe(false);
 386   });
 387
 388   it('Verify isEmptyObject()', () => {
 389     expect(isEmptyObject({})).toBe(true);
 390     expect(isEmptyObject({ 1: 1, 2: 2 })).toBe(false);
 391     expect(isEmptyObject(new Map())).toBe(false);
 392     expect(isEmptyObject(new Set())).toBe(false);
 393     expect(isEmptyObject(new WeakMap())).toBe(false);
 394     expect(isEmptyObject(new WeakSet())).toBe(false);
 395   });
 396
 397   it('Verify isArraySorted()', () => {
 398     expect(
 399       isArraySorted([], (a, b) => {
 400         return a - b;
 401       }),
 402     ).toBe(true);
 403     expect(
 404       isArraySorted([1], (a, b) => {
 405         return a - b;
 406       }),
 407     ).toBe(true);
 408     expect(isArraySorted<number>([1, 2, 3, 4, 5], (a, b) => a - b)).toBe(true);
 409     expect(isArraySorted<number>([1, 2, 3, 5, 4], (a, b) => a - b)).toBe(false);
 410   });
 411 });