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
|
use Mojo::Base -strict;
use JSON::Validator::Schema::OpenAPIv3;
use Mojo::File;
use Test::Deep;
use Test::More;
my $cwd = Mojo::File->new(__FILE__)->dirname;
my $schema = JSON::Validator::Schema::OpenAPIv3->new;
my ($body, $p, @errors);
subtest 'basic' => sub {
is $schema->specification, 'https://spec.openapis.org/oas/3.0/schema/2019-04-02', 'specification';
is_deeply $schema->coerce, {booleans => 1, numbers => 1, strings => 1}, 'default coercion';
$schema = JSON::Validator->new->schema($cwd->child(qw(spec v3-petstore.json)))->schema;
isa_ok $schema, 'JSON::Validator::Schema::OpenAPIv3';
@errors = @{JSON::Validator->new->schema({openapi => '3.0.0', paths => {}})->schema->errors};
is "@errors", '/info: Missing property.', 'invalid schema';
is_deeply(
$schema->routes->to_array,
[
{method => 'get', operation_id => 'showPetById', path => '/pets/{petId}'},
{method => 'get', operation_id => 'listPets', path => '/pets'},
{method => 'post', operation_id => 'createPets', path => '/pets'},
],
'routes'
);
};
subtest base_url => sub {
is $schema->base_url, 'http://petstore.swagger.io/v1', 'get';
is $schema->base_url('https://api.example.com:8080/api'), $schema, 'set url';
is $schema->get('/servers/0/url'), 'https://api.example.com:8080/api', 'servers changed';
is $schema->base_url(Mojo::URL->new('//api2.example.com')), $schema, 'set without scheme';
is $schema->get('/servers/0/url'), 'https://api2.example.com', 'servers changed';
is $schema->base_url(Mojo::URL->new('/v1')), $schema, 'set path';
is $schema->base_url->to_string, 'https://api2.example.com/v1', 'get';
};
subtest 'parameters_for_request' => sub {
is $schema->parameters_for_request([GET => '/pets/nope']), undef, 'no such path';
cmp_deeply $schema->parameters_for_request([GET => '/pets']), [superhashof({in => 'query', name => 'limit'})],
'parameters_for_request inside path';
cmp_deeply $schema->parameters_for_request([post => '/pets']),
[
superhashof({in => 'cookie', name => 'debug'}),
superhashof({in => 'body', name => 'body', accepts => [qw(application/json application/x-www-form-urlencoded)]})
],
'parameters_for_request for body';
cmp_deeply $schema->parameters_for_request([get => '/pets/{petId}']),
[superhashof({in => 'path', name => 'petId'}), superhashof({in => 'query', name => 'wantAge'})],
'parameters_for_request inside method';
};
subtest 'parameters_for_response' => sub {
is $schema->parameters_for_response([GET => '/pets/nope']), undef, 'no such path';
cmp_deeply $schema->parameters_for_response([GET => '/pets']),
[
superhashof({in => 'header', name => 'x-next'}),
superhashof({in => 'body', name => 'body', accepts => [qw(application/json application/xml)]}),
],
'parameters_for_request inside path and default response code';
cmp_deeply $schema->parameters_for_response([GET => '/pets', 404]),
[superhashof({in => 'body', name => 'body', accepts => [qw(application/json application/xml)]})],
'default response';
};
subtest 'validate_request' => sub {
$p = Mojo::Parameters->new('limit=10&foo=42');
@errors = $schema->validate_request([get => '/pets'], {query => $p->to_hash});
is "@errors", '', 'limit ok, even as string';
@errors = $schema->validate_request([get => '/pets'], {query => {limit => 'foo'}});
is "@errors", '/limit: Expected integer - got string.', 'limit failed';
$body = {exists => 0};
@errors = $schema->validate_request([POST => '/pets'], {body => \&body});
is "@errors", '/body: Missing property.', 'default content type, but missing body';
is_deeply $body, {exists => 0, in => 'body', name => 'body', valid => 0}, 'input was mutated';
$body = {exists => 1, value => {name => 'kitty'}};
@errors = $schema->validate_request([POST => '/pets'], {body => \&body});
is "@errors", '/body/id: Missing property.', 'missing id in body';
$body = {exists => 1, value => {id => 42, name => 'kitty'}};
@errors = $schema->validate_request([POST => '/pets'], {body => \&body});
is "@errors", '', 'valid request body';
is_deeply $body,
{
content_type => 'application/json',
exists => 1,
in => 'body',
name => 'body',
valid => 1,
value => $body->{value}
},
'input was mutated';
};
subtest 'validate_response' => sub {
$body = {exists => 1, value => {id => 42, name => 'kitty'}};
@errors = $schema->validate_response([POST => '/pets', 201], {});
is "@errors", '', 'valid response body 201';
$body = {exists => 1, value => {code => 42}};
@errors = $schema->validate_response([post => '/pets', 200], {body => \&body});
is "@errors", '/body/message: Missing property.', 'valid response body default';
};
subtest 'validate_response - accept' => sub {
$body = {accept => 'text/plain'};
@errors = $schema->validate_response([get => '/pets'], {body => \&body});
is "@errors", '/header/Accept: Expected application/json, application/xml - got text/plain.', 'invalid accept';
is_deeply $body, {accept => 'text/plain', content_type => '', in => 'body', name => 'body', valid => 0},
'failed to negotiate content type';
$body = {accept => 'application/*'};
@errors = $schema->validate_response([get => '/pets'], {body => \&body});
is "@errors", '', 'valid accept';
is_deeply $body,
{accept => 'application/*', content_type => 'application/json', in => 'body', name => 'body', valid => 1},
'negotiated content type';
};
subtest 'validate_response - content_type' => sub {
$body = {content_type => 'text/plain'};
@errors = $schema->validate_response([get => '/pets'], {body => \&body});
is "@errors", '/body: Expected application/json, application/xml - got text/plain.', 'invalid content_type';
is_deeply $body, {content_type => 'text/plain', in => 'body', name => 'body', valid => 0},
'failed to negotiate content type';
$body = {content_type => 'application/json'};
@errors = $schema->validate_response([get => '/pets'], {body => \&body});
is "@errors", '', 'valid content_type';
is_deeply $body,
{content_type => 'application/json', content_type => 'application/json', in => 'body', name => 'body', valid => 1},
'negotiated content type';
};
subtest add_default_response => sub {
my $schema = JSON::Validator->new->schema($cwd->child(qw(spec v3-petstore.json)))->schema;
ok !$schema->get('/components/schemas/DefaultResponse'), 'default response missing';
ok !$schema->get([paths => '/petss', 'get', 'responses', '400']), 'default response missing for 400';
$schema->add_default_response;
ok $schema->get('/components/schemas/DefaultResponse'), 'default response added';
for my $status (400, 401, 404, 500, 501) {
ok $schema->get([paths => '/pets', 'get', 'responses', $status]), "default response for $status";
}
delete $schema->{errors};
is_deeply $schema->errors, [], 'errors';
};
subtest 'add_default_response do not overwrite $ref' => sub {
my $schema = JSON::Validator->new->schema($cwd->child(qw(spec v3-default-response-extra.yaml)))->schema;
$schema->add_default_response;
is $schema->get([qw(paths /item/{id} get summary)]), 'get a single item', 'summary';
is $schema->get([qw(paths /item/{id} get responses 200 content application/json schema type)]), 'object',
'responses 200';
is $schema->get([qw(paths /item/{id} get responses 404 description)]), 'Custom 404', 'responses 404';
is $schema->get([qw(paths /item/{id} get responses 500 description)]), 'Custom 500', 'responses 500';
};
subtest 'v3.1.x' => sub {
my $schema = JSON::Validator->new->schema({openapi => '3.1.0', paths => {}})->schema;
is $schema->specification, 'https://spec.openapis.org/oas/3.1/schema/2021-05-20', 'specification';
is join(', ', @{$schema->errors}), '/info: Missing property.', 'errors';
};
subtest 'coerce defaults' => sub {
my $schema = JSON::Validator->new->coerce('defaults')->schema($cwd->child(qw(spec v3-petstore.json)))->schema;
is_deeply $schema->errors, [], 'defaults turned off when validating the schema';
};
done_testing;
sub body {$body}
|
