openapi-sampler/test/unit/string.spec.js at ccab37376ee9291dee4fb96404e7da0f37ba8e64 · Redocly/openapi-sampler · GitHub

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
import { sampleString } from '../../src/samplers/string.js';

import Ajv from 'ajv';
import addFormats from 'ajv-formats';

const ajv = new Ajv({ allErrors: true, messages: true, strict: true });

addFormats(ajv);

require('it-each')();

const IPV4_REGEXP = /^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$/;
const IPV6_REGEXP = /^(([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9]))$/;
const HOSTNAME_REGEXP = /^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\-]*[a-zA-Z0-9])\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\-]*[A-Za-z0-9])$/;
const URI_REGEXP = new RegExp('([A-Za-z][A-Za-z0-9+\\-.]*):(?:(//)(?:((?:[A-Za-z0-9\\-._~!$&\'()*+,;=:]|%[0-9A-Fa-f]{2})*)@)?((?:\\[(?:(?:(?:(?:[0-9A-Fa-f]{1,4}:){6}|::(?:[0-9A-Fa-f]{1,4}:){5}|(?:[0-9A-Fa-f]{1,4})?::(?:[0-9A-Fa-f]{1,4}:){4}|(?:(?:[0-9A-Fa-f]{1,4}:){0,1}[0-9A-Fa-f]{1,4})?::(?:[0-9A-Fa-f]{1,4}:){3}|(?:(?:[0-9A-Fa-f]{1,4}:){0,2}[0-9A-Fa-f]{1,4})?::(?:[0-9A-Fa-f]{1,4}:){2}|(?:(?:[0-9A-Fa-f]{1,4}:){0,3}[0-9A-Fa-f]{1,4})?::[0-9A-Fa-f]{1,4}:|(?:(?:[0-9A-Fa-f]{1,4}:){0,4}[0-9A-Fa-f]{1,4})?::)(?:[0-9A-Fa-f]{1,4}:[0-9A-Fa-f]{1,4}|(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))|(?:(?:[0-9A-Fa-f]{1,4}:){0,5}[0-9A-Fa-f]{1,4})?::[0-9A-Fa-f]{1,4}|(?:(?:[0-9A-Fa-f]{1,4}:){0,6}[0-9A-Fa-f]{1,4})?::)|[Vv][0-9A-Fa-f]+\\.[A-Za-z0-9\\-._~!$&\'()*+,;=:]+)\\]|(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|(?:[A-Za-z0-9\\-._~!$&\'()*+,;=]|%[0-9A-Fa-f]{2})*))(?::([0-9]*))?((?:/(?:[A-Za-z0-9\\-._~!$&\'()*+,;=:@]|%[0-9A-Fa-f]{2})*)*)|/((?:(?:[A-Za-z0-9\\-._~!$&\'()*+,;=:@]|%[0-9A-Fa-f]{2})+(?:/(?:[A-Za-z0-9\\-._~!$&\'()*+,;=:@]|%[0-9A-Fa-f]{2})*)*)?)|((?:[A-Za-z0-9\\-._~!$&\'()*+,;=:@]|%[0-9A-Fa-f]{2})+(?:/(?:[A-Za-z0-9\\-._~!$&\'()*+,;=:@]|%[0-9A-Fa-f]{2})*)*)|)(?:\\?((?:[A-Za-z0-9\\-._~!$&\'()*+,;=:@/?]|%[0-9A-Fa-f]{2})*))?(?:\\#((?:[A-Za-z0-9\\-._~!$&\'()*+,;=:@/?]|%[0-9A-Fa-f]{2})*))?');
const UUID_REGEXP = /^[0-9A-Fa-f]{8}(?:-[0-9A-Fa-f]{4}){3}-[0-9A-Fa-f]{12}$/;

describe('sampleString', () => {
  let res;
  it('should return "string" by default', () => {
    res = sampleString({});
    expect(res).to.equal('string');
  });

  it('should return string of appropriate length if minLength specified', () => {
    res = sampleString({minLength: 20});
    expect(res.length).to.equal(20);
  });

  it('should return string of appropriate length if maxLength specified', () => {
    res = sampleString({maxLength: 2});
    expect(res.length).to.equal(2);
  });

  it('should return email for format email', () => {
    res = sampleString({format: 'email'});
    expect(res).to.equal('user@example.com');
  });

  it('should return email for format email', () => {
    res = sampleString({format: 'email'});
    expect(res).to.equal('user@example.com');
  });

  it('should return password for format password', () => {
    res = sampleString({format: 'password'});
    expect(res).to.equal('pa$$word');
  });

  it('should return password of appropriate length if minLength specified', () => {
    res = sampleString({format: 'password', minLength: 20});
    expect(res.substring(0, 9)).to.equal('pa$$word_');
    expect(res.length).to.equal(20);
  });

  it('should return date string for format date', () => {
    res = sampleString({format: 'date'});
    expect(Date.parse(res)).not.to.be.NaN;
  });

  it('should return deterministic date string for format date', () => {
    res = sampleString({format: 'date'});
    expect(res).to.equal('2019-08-24');
  });

  it('should return date string for format date', () => {
    res = sampleString({format: 'date-time'});
    expect(Date.parse(res)).not.to.be.NaN;
  });

  it('should return deterministic date string for format date-time', () => {
    res = sampleString({format: 'date-time'});
    expect(res).to.equal('2019-08-24T14:15:22Z');
  });

  it('should not throw if incorrect maxLength applied to date-time', () => {
    res = sampleString({format: 'date-time', maxLength: 5});
    expect(res).to.equal('2019-08-24T14:15:22Z')
  });

  it('should not throw if incorrect minLength applied to date-time', () => {
    res = sampleString({format: 'date-time', minLength: 100});
    expect(res).to.equal('2019-08-24T14:15:22Z')
  });

  it('should return deterministic time string for format date-time', () => {
    res = sampleString({format: 'time'});
    expect(res).to.equal('14:15:22Z');
  });

  it('should not throw if incorrect maxLength applied to time', () => {
    res = sampleString({format: 'time', maxLength: 5});
    expect(res).to.equal('14:15:22Z')
  });

  it('should not throw if incorrect minLength applied to time', () => {
    res = sampleString({format: 'time', minLength: 100});
    expect(res).to.equal('14:15:22Z')
  });

  it('should return ip for ipv4 format', () => {
    res = sampleString({format: 'ipv4'});
    expect(res).to.match(IPV4_REGEXP);
  });

  it('should return ipv6 for ipv6 format', () => {
    res = sampleString({format: 'ipv6'});
    expect(res).to.match(IPV6_REGEXP);
  });

  it('should return vaild hostname for hostname format', () => {
    res = sampleString({format: 'hostname'});
    expect(res).to.match(HOSTNAME_REGEXP);
  });

  it('should return vaild URI for uri format', () => {
    res = sampleString({format: 'uri'});
    expect(res).to.match(URI_REGEXP);
  });

  it('should return valid uuid for uuid format without propertyName context', () => {
    res = sampleString({format: 'uuid'});
    expect(res).to.match(UUID_REGEXP);
    expect(res).to.equal('497f6eca-6276-4993-bfeb-53cbbbba6f08');
  });

  it('should return valid uuid for uuid format with propertyName context', () => {
    res = sampleString({format: 'uuid'}, null, null, {propertyName: 'fooId'});
    expect(res).to.match(UUID_REGEXP);
    expect(res).to.equal('fb4274c7-4fcd-4035-8958-a680548957ff');
  });

  it('should return null if it is omissible', () => {
    res = sampleString({}, { omissible: true });
    expect(res).to.be.null;
  });

  it.each([
    'email',
    // 'idn-email', // unsupported by ajv-formats
    // 'password', // unsupported by ajv-formats
    'date-time',
    'date',
    'time',
    'ipv4',
    'ipv6',
    'hostname',
    // 'idn-hostname', // unsupported by ajv-formats
    'uri',
    'uri-reference',
    'uri-template',
    // 'iri', // unsupported by ajv-formats
    // 'iri-reference', // unsupported by ajv-formats
    'uuid',
    'json-pointer',
    'relative-json-pointer',
    'regex'
  ], 'should return valid %s', format => {
    const schema = {type: 'string',format};
    expect(ajv.compile(schema)(sampleString(schema))).to.be.true;
  });
});