Socialify

Folder ..

Viewing random.spec.ts
277 lines (240 loc) • 9.0 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
import { describe, expect, it, vi } from 'vitest';
import { faker } from '../dist/cjs';
import { Mersenne } from '../dist/cjs/mersenne';

const mersenne = new Mersenne();

describe('random.js', () => {
  describe('number', () => {
    it('random.number() uses datatype module and prints deprecation warning', () => {
      const spy_console_log = vi.spyOn(console, 'log');
      const spy_datatype_number = vi.spyOn(faker.datatype, 'number');
      faker.random.number();
      expect(spy_datatype_number).toHaveBeenCalled();
      expect(spy_console_log).toHaveBeenCalledWith(
        'Deprecation Warning: faker.random.number is now located in faker.datatype.number'
      );
      spy_datatype_number.mockRestore();
      spy_console_log.mockRestore();
    });

    it('should return deterministic results when seeded with integer', () => {
      faker.seed(100);
      const name = faker.name.findName();
      expect(name).toBe('Eva Jenkins');
    });

    it('should return deterministic results when seeded with 0', () => {
      faker.seed(0);
      const name = faker.name.findName();
      expect(name).toBe('Lola Sporer');
    });

    it('should return deterministic results when seeded with array - one element', () => {
      faker.seed([10]);
      const name = faker.name.findName();
      expect(name).toBe('Duane Kshlerin');
    });

    it('should return deterministic results when seeded with array - multiple elements', () => {
      faker.seed([10, 100, 1000]);
      const name = faker.name.findName();
      expect(name).toBe('Alma Shanahan');
    });
  });

  describe('float', () => {
    it('random.float() uses datatype module and prints deprecation warning', () => {
      const spy_console_log = vi.spyOn(console, 'log');
      const spy_datatype_float = vi.spyOn(faker.datatype, 'float');
      faker.random.float();
      expect(spy_datatype_float).toHaveBeenCalled();
      expect(spy_console_log).toHaveBeenCalledWith(
        'Deprecation Warning: faker.random.float is now located in faker.datatype.float'
      );
      spy_datatype_float.mockRestore();
      spy_console_log.mockRestore();
    });
  });

  describe('arrayElement', () => {
    it('returns a random element in the array', () => {
      const testArray = ['hello', 'to', 'you', 'my', 'friend'];
      expect(
        testArray.indexOf(faker.random.arrayElement(testArray))
      ).greaterThan(-1);
    });

    it('returns a random element in the array when there is only 1', () => {
      const testArray = ['hello'];
      expect(
        testArray.indexOf(faker.random.arrayElement(testArray))
      ).greaterThan(-1);
    });
  });

  describe('arrayElements', () => {
    it('returns a subset with random elements in the array', () => {
      const testArray = ['hello', 'to', 'you', 'my', 'friend'];
      const subset = faker.random.arrayElements(testArray);

      // Check length
      expect(subset.length).greaterThanOrEqual(1);
      expect(subset.length).lessThanOrEqual(testArray.length);

      // Check elements
      subset.forEach((element) => {
        expect(testArray).toContain(element);
      });

      // Check uniqueness
      subset.forEach((element) => {
        expect(!Object.prototype.hasOwnProperty.call(subset, element)).toBe(
          true
        );
        subset[element] = true;
      }, {});
    });

    it('returns a subset of fixed length with random elements in the array', () => {
      const testArray = ['hello', 'to', 'you', 'my', 'friend'];
      const subset = faker.random.arrayElements(testArray, 3);

      // Check length
      expect(subset).toHaveLength(3);

      // Check elements
      subset.forEach((element) => {
        expect(testArray).toContain(element);
      });

      // Check uniqueness
      subset.forEach((element) => {
        expect(!Object.prototype.hasOwnProperty.call(subset, element)).toBe(
          true
        );
        subset[element] = true;
      }, {});
    });
  });

  describe('UUID', () => {
    it('random.uuid() uses datatype module and prints deprecation warning', () => {
      const spy_console_log = vi.spyOn(console, 'log');
      const spy_datatype_uuid = vi.spyOn(faker.datatype, 'uuid');
      faker.random.uuid();
      expect(spy_datatype_uuid).toHaveBeenCalled();
      expect(spy_console_log).toHaveBeenCalledWith(
        'Deprecation Warning: faker.random.uuid is now located in faker.datatype.uuid'
      );
      spy_datatype_uuid.mockRestore();
      spy_console_log.mockRestore();
    });
  });

  describe('boolean', () => {
    it('random.boolean() uses datatype module and prints deprecation warning', () => {
      const spy_console_log = vi.spyOn(console, 'log');
      const spy_datatype_boolean = vi.spyOn(faker.datatype, 'boolean');
      faker.random.boolean();
      expect(spy_datatype_boolean).toHaveBeenCalled();
      expect(spy_console_log).toHaveBeenCalledWith(
        'Deprecation Warning: faker.random.boolean is now located in faker.datatype.boolean'
      );
      spy_datatype_boolean.mockRestore();
      spy_console_log.mockRestore();
    });
  });

  describe('semver', () => {
    const semver = faker.system.semver();

    it('should generate a string', () => {
      expect(typeof semver).toBe('string');
    });

    it('should generate a valid semver', () => {
      expect(semver).match(/^\d+\.\d+\.\d+$/);
    });
  });

  describe('alpha', () => {
    const alpha = faker.random.alpha;

    it('should return single letter when no count provided', () => {
      expect(alpha()).toHaveLength(1);
    });

    it('should return lowercase letter when no upcase option provided', () => {
      expect(alpha()).match(/[a-z]/);
    });

    it('should return uppercase when upcase option is true', () => {
      expect(
        alpha(
          // @ts-expect-error
          { upcase: true }
        )
      ).match(/[A-Z]/);
    });

    it('should generate many random letters', () => {
      expect(alpha(5)).toHaveLength(5);
    });

    it('should be able to ban some characters', () => {
      const alphaText = alpha(
        5,
        // @ts-expect-error
        { bannedChars: ['a', 'p'] }
      );
      expect(alphaText).toHaveLength(5);
      expect(alphaText).match(/[b-oq-z]/);
    });
    it('should be able handle mistake in banned characters array', () => {
      const alphaText = alpha(
        5,
        // @ts-expect-error
        { bannedChars: ['a', 'a', 'p'] }
      );
      expect(alphaText).toHaveLength(5);
      expect(alphaText).match(/[b-oq-z]/);
    });
  });

  describe('alphaNumeric', () => {
    const alphaNumeric = faker.random.alphaNumeric;

    it('should generate single character when no additional argument was provided', () => {
      expect(alphaNumeric()).toHaveLength(1);
    });

    it('should generate many random characters', () => {
      expect(alphaNumeric(5)).toHaveLength(5);
    });

    it('should be able to ban some characters', () => {
      const alphaText = alphaNumeric(5, { bannedChars: ['a', 'p'] });
      expect(alphaText).toHaveLength(5);
      expect(alphaText).match(/[b-oq-z]/);
    });
    it('should be able handle mistake in banned characters array', () => {
      const alphaText = alphaNumeric(5, { bannedChars: ['a', 'p', 'a'] });
      expect(alphaText).toHaveLength(5);
      expect(alphaText).match(/[b-oq-z]/);
    });
  });

  describe('hexaDecimal', () => {
    it('random.hexaDecimal() uses datatype module and prints deprecation warning', () => {
      const spy_console_log = vi.spyOn(console, 'log');
      const spy_datatype_hexaDecimal = vi.spyOn(faker.datatype, 'hexaDecimal');
      faker.random.hexaDecimal();
      expect(spy_datatype_hexaDecimal).toHaveBeenCalled();
      expect(spy_console_log).toHaveBeenCalledWith(
        'Deprecation Warning: faker.random.hexaDecimal is now located in faker.datatype.hexaDecimal'
      );
      spy_datatype_hexaDecimal.mockRestore();
      spy_console_log.mockRestore();
    });
  });

  describe('image', () => {
    it('random.image() uses image module and prints deprecation warning', () => {
      const spy_console_log = vi.spyOn(console, 'log');
      const spy_image_image = vi.spyOn(faker.image, 'image');
      faker.random.image();
      expect(spy_image_image).toHaveBeenCalled();
      expect(spy_console_log).toHaveBeenCalledWith(
        'Deprecation Warning: faker.random.image is now located in faker.image.image'
      );
      spy_image_image.mockRestore();
      spy_console_log.mockRestore();
    });
  });

  describe('mersenne twister', () => {
    it('returns a random number without given min / max arguments', () => {
      const randomNumber = mersenne.rand();
      expect(typeof randomNumber).toBe('number');
    });

    it('throws an error when attempting to seed() a non-integer', () => {
      expect(() =>
        mersenne.seed(
          // @ts-expect-error
          'abc'
        )
      ).toThrowError(Error('seed(S) must take numeric argument; is string'));
    });

    it('throws an error when attempting to seed() a non-integer', () => {
      expect(() => mersenne.seed_array('abc')).toThrowError(
        Error('seed_array(A) must take array of numbers; is string')
      );
    });
  });
});