committee 5.6.4 → 5.7.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/lib/committee/drivers/open_api_2/driver.rb +16 -0
- data/lib/committee/drivers/open_api_2/link.rb +2 -0
- data/lib/committee/drivers/open_api_3/schema.rb +6 -1
- data/lib/committee/drivers.rb +15 -8
- data/lib/committee/middleware/response_validation.rb +19 -5
- data/lib/committee/middleware/stub.rb +1 -1
- data/lib/committee/request_unpacker.rb +19 -9
- data/lib/committee/schema_locations.rb +96 -0
- data/lib/committee/schema_validator/hyper_schema/request_validator.rb +1 -1
- data/lib/committee/schema_validator/hyper_schema/response_validator.rb +13 -3
- data/lib/committee/schema_validator/hyper_schema.rb +5 -4
- data/lib/committee/schema_validator/open_api_3/operation_wrapper.rb +42 -17
- data/lib/committee/schema_validator/open_api_3/parameter_deserializer.rb +66 -20
- data/lib/committee/schema_validator/open_api_3/request_validator.rb +2 -3
- data/lib/committee/schema_validator/open_api_3/router.rb +1 -3
- data/lib/committee/schema_validator/open_api_3.rb +22 -18
- data/lib/committee/schema_validator.rb +1 -5
- data/lib/committee/test/except_parameter.rb +4 -4
- data/lib/committee/test/methods.rb +13 -0
- data/lib/committee/test/schema_coverage.rb +11 -2
- data/lib/committee/utils.rb +6 -0
- data/lib/committee/validation_error.rb +1 -1
- data/lib/committee/version.rb +1 -1
- data/lib/committee.rb +1 -0
- data/test/drivers/open_api_2/driver_test.rb +13 -0
- data/test/drivers_test.rb +39 -8
- data/test/middleware/request_validation_open_api_3_test.rb +668 -6
- data/test/middleware/request_validation_test.rb +50 -0
- data/test/middleware/response_validation_open_api_3_test.rb +77 -0
- data/test/middleware/response_validation_test.rb +134 -0
- data/test/middleware/stub_test.rb +10 -0
- data/test/request_unpacker_test.rb +34 -0
- data/test/schema_location_test.rb +111 -0
- data/test/schema_validator/open_api_3/parameter_deserializer_test.rb +145 -8
- data/test/schema_validator_test.rb +10 -0
- data/test/test/methods_test.rb +188 -0
- data/test/test/schema_coverage_test.rb +34 -0
- data/test/test_helper.rb +23 -0
- data/test/utils_test.rb +28 -0
- data/test/validation_error_test.rb +1 -1
- metadata +20 -3
|
@@ -12,15 +12,18 @@ module Committee
|
|
|
12
12
|
class ParameterDeserializer
|
|
13
13
|
# @param [OpenAPIParser::RequestOperation] request_operation
|
|
14
14
|
def initialize(request_operation)
|
|
15
|
-
@request_operation = request_operation
|
|
16
15
|
@parameters = request_operation.operation_object.parameters || []
|
|
16
|
+
if request_operation.respond_to?(:path_item) && request_operation.path_item
|
|
17
|
+
@parameters = (@parameters + (request_operation.path_item.parameters || [])).uniq { |param| [param.in, param.name] }
|
|
18
|
+
end
|
|
17
19
|
end
|
|
18
20
|
|
|
19
21
|
# Deserialize query parameters
|
|
20
22
|
# @param [Hash] raw_params Raw query parameters from Rack
|
|
23
|
+
# @param [Hash] query_values Query parameters with repeated keys preserved
|
|
21
24
|
# @return [Hash] Deserialized parameters according to OpenAPI schema
|
|
22
|
-
def deserialize_query_params(raw_params)
|
|
23
|
-
deserialize_params_by_location(raw_params, 'query')
|
|
25
|
+
def deserialize_query_params(raw_params, query_values = {})
|
|
26
|
+
deserialize_params_by_location(raw_params, 'query', query_values)
|
|
24
27
|
end
|
|
25
28
|
|
|
26
29
|
# Deserialize path parameters
|
|
@@ -34,6 +37,11 @@ module Committee
|
|
|
34
37
|
# @param [Hash] raw_headers Raw headers
|
|
35
38
|
# @return [Hash] Deserialized headers according to OpenAPI schema
|
|
36
39
|
def deserialize_headers(raw_headers)
|
|
40
|
+
return raw_headers if raw_headers.nil? || raw_headers.empty?
|
|
41
|
+
|
|
42
|
+
raw_headers = raw_headers.transform_keys do |name|
|
|
43
|
+
@parameters.find { |param| param.in == 'header' && param.name.casecmp?(name.to_s) }&.name || name
|
|
44
|
+
end
|
|
37
45
|
deserialize_params_by_location(raw_headers, 'header')
|
|
38
46
|
end
|
|
39
47
|
|
|
@@ -42,8 +50,9 @@ module Committee
|
|
|
42
50
|
# Deserialize parameters for a specific location (query, path, header)
|
|
43
51
|
# @param [Hash] raw_params Raw parameters
|
|
44
52
|
# @param [String] location Parameter location ('query', 'path', 'header')
|
|
53
|
+
# @param [Hash] query_values Query parameters with repeated keys preserved
|
|
45
54
|
# @return [Hash] Deserialized parameters
|
|
46
|
-
def deserialize_params_by_location(raw_params, location)
|
|
55
|
+
def deserialize_params_by_location(raw_params, location, query_values = {})
|
|
47
56
|
return raw_params if raw_params.nil? || raw_params.empty?
|
|
48
57
|
|
|
49
58
|
result = Committee::Utils.indifferent_hash
|
|
@@ -52,7 +61,7 @@ module Committee
|
|
|
52
61
|
# If no parameters are defined for this location, return raw params as-is
|
|
53
62
|
return raw_params if params_for_location.empty?
|
|
54
63
|
|
|
55
|
-
raw_params = normalize_raw_params(raw_params, location, params_for_location)
|
|
64
|
+
raw_params = normalize_raw_params(raw_params, location, params_for_location, query_values)
|
|
56
65
|
|
|
57
66
|
# Collect parameter names that will be deserialized
|
|
58
67
|
# This includes both the parameter name and any properties (for exploded objects)
|
|
@@ -71,7 +80,7 @@ module Committee
|
|
|
71
80
|
deserialized_keys.add(param_def.name)
|
|
72
81
|
|
|
73
82
|
# For form-style exploded objects, mark the property keys as deserialized
|
|
74
|
-
if param_def.schema
|
|
83
|
+
if Committee::Utils.schema_type(param_def.schema) == 'object' &&
|
|
75
84
|
(param_def.style.nil? || param_def.style == 'form') &&
|
|
76
85
|
(param_def.explode.nil? || param_def.explode)
|
|
77
86
|
param_def.schema.properties&.each_key do |prop_name|
|
|
@@ -107,15 +116,39 @@ module Committee
|
|
|
107
116
|
Committee::Utils.indifferent_hash.merge(hash)
|
|
108
117
|
end
|
|
109
118
|
|
|
110
|
-
#
|
|
111
|
-
# schema expects bracket-named params or deepObject query params.
|
|
119
|
+
# Restore repeated array values and normalize Rack-style nested query hashes
|
|
120
|
+
# when the schema expects bracket-named params or deepObject query params.
|
|
112
121
|
# Example: { "filter" => { "slug" => "/test" } } => { "filter[slug]" => "/test" }
|
|
113
122
|
# @param [Hash] raw_params
|
|
114
123
|
# @param [String] location
|
|
115
124
|
# @param [Array<OpenAPIParser::Schemas::Parameter>] params_for_location
|
|
125
|
+
# @param [Hash] query_values Query parameters with repeated keys preserved
|
|
116
126
|
# @return [Hash]
|
|
117
|
-
def normalize_raw_params(raw_params, location, params_for_location)
|
|
127
|
+
def normalize_raw_params(raw_params, location, params_for_location, query_values)
|
|
118
128
|
return raw_params unless location == 'query'
|
|
129
|
+
|
|
130
|
+
normalized = raw_params
|
|
131
|
+
params_for_location.each do |param_def|
|
|
132
|
+
next unless Committee::Utils.schema_type(param_def.schema) == 'array'
|
|
133
|
+
|
|
134
|
+
style = param_def.style || default_style(location)
|
|
135
|
+
explode = param_def.explode.nil? ? default_explode(style) : param_def.explode
|
|
136
|
+
|
|
137
|
+
if explode && query_values[param_def.name].is_a?(Array)
|
|
138
|
+
normalized = raw_params.dup if normalized.equal?(raw_params)
|
|
139
|
+
normalized[param_def.name] = query_values[param_def.name]
|
|
140
|
+
end
|
|
141
|
+
|
|
142
|
+
next unless param_def.name.end_with?('[]')
|
|
143
|
+
|
|
144
|
+
raw_name = param_def.name.delete_suffix('[]')
|
|
145
|
+
next unless normalized[raw_name].is_a?(Array)
|
|
146
|
+
|
|
147
|
+
normalized = raw_params.dup if normalized.equal?(raw_params)
|
|
148
|
+
normalized[param_def.name] = normalized.delete(raw_name)
|
|
149
|
+
end
|
|
150
|
+
|
|
151
|
+
raw_params = normalized
|
|
119
152
|
return raw_params unless raw_params.values.any? { |value| value.is_a?(Hash) }
|
|
120
153
|
return raw_params unless requires_query_param_flattening?(params_for_location)
|
|
121
154
|
|
|
@@ -229,7 +262,7 @@ module Committee
|
|
|
229
262
|
schema = param_def.schema
|
|
230
263
|
return nil unless schema
|
|
231
264
|
|
|
232
|
-
case schema
|
|
265
|
+
case Committee::Utils.schema_type(schema)
|
|
233
266
|
when 'object'
|
|
234
267
|
deserialize_form_object(param_name, schema, raw_params, explode)
|
|
235
268
|
when 'array'
|
|
@@ -270,8 +303,7 @@ module Committee
|
|
|
270
303
|
return nil unless value
|
|
271
304
|
|
|
272
305
|
if explode
|
|
273
|
-
#
|
|
274
|
-
# Just ensure it's an array
|
|
306
|
+
# Repeated query values are collected before deserialization.
|
|
275
307
|
Array(value)
|
|
276
308
|
else
|
|
277
309
|
# explode=false: comma-separated values
|
|
@@ -352,7 +384,7 @@ module Committee
|
|
|
352
384
|
schema = param_def.schema
|
|
353
385
|
return value unless schema
|
|
354
386
|
|
|
355
|
-
case schema
|
|
387
|
+
case Committee::Utils.schema_type(schema)
|
|
356
388
|
when 'array'
|
|
357
389
|
# Both explode true/false use comma separation for simple style
|
|
358
390
|
# Example: "1,2,3" → ["1", "2", "3"]
|
|
@@ -386,7 +418,7 @@ module Committee
|
|
|
386
418
|
schema = param_def.schema
|
|
387
419
|
return value unless schema
|
|
388
420
|
|
|
389
|
-
case schema
|
|
421
|
+
case Committee::Utils.schema_type(schema)
|
|
390
422
|
when 'array'
|
|
391
423
|
if explode
|
|
392
424
|
# explode=true: .3.4.5 → ["3", "4", "5"]
|
|
@@ -421,12 +453,22 @@ module Committee
|
|
|
421
453
|
schema = param_def.schema
|
|
422
454
|
return value unless schema
|
|
423
455
|
|
|
424
|
-
case schema
|
|
456
|
+
case Committee::Utils.schema_type(schema)
|
|
425
457
|
when 'array'
|
|
426
458
|
if explode
|
|
427
|
-
|
|
428
|
-
|
|
429
|
-
|
|
459
|
+
if value.is_a?(String)
|
|
460
|
+
prefix = "#{param_name}="
|
|
461
|
+
return [] if value == ";#{param_name}"
|
|
462
|
+
raise ArgumentError, 'invalid matrix array' unless value.start_with?(";#{prefix}")
|
|
463
|
+
|
|
464
|
+
value.split(';', -1).drop(1).map do |part|
|
|
465
|
+
raise ArgumentError, 'invalid matrix array' unless part.start_with?(prefix)
|
|
466
|
+
|
|
467
|
+
part.delete_prefix(prefix)
|
|
468
|
+
end
|
|
469
|
+
else
|
|
470
|
+
Array(value)
|
|
471
|
+
end
|
|
430
472
|
else
|
|
431
473
|
# explode=false: ;id=3,4,5
|
|
432
474
|
extract_matrix_array_compact(value, param_name)
|
|
@@ -450,12 +492,14 @@ module Committee
|
|
|
450
492
|
# @param [String] param_name Parameter name
|
|
451
493
|
# @return [Array] Extracted array
|
|
452
494
|
def extract_matrix_array_compact(value, param_name)
|
|
495
|
+
return [] if value == ";#{param_name}"
|
|
496
|
+
|
|
453
497
|
# ;id=3,4,5 → ["3", "4", "5"]
|
|
454
498
|
prefix = ";#{param_name}="
|
|
455
499
|
if value.start_with?(prefix)
|
|
456
500
|
value[prefix.length..-1].split(',')
|
|
457
501
|
else
|
|
458
|
-
|
|
502
|
+
raise ArgumentError, 'invalid matrix array'
|
|
459
503
|
end
|
|
460
504
|
end
|
|
461
505
|
|
|
@@ -482,12 +526,14 @@ module Committee
|
|
|
482
526
|
# @param [String] param_name Parameter name
|
|
483
527
|
# @return [Hash] Extracted object
|
|
484
528
|
def extract_matrix_object_compact(value, param_name)
|
|
529
|
+
return {} if value == ";#{param_name}"
|
|
530
|
+
|
|
485
531
|
# ;id=role,admin,status,active → { "role" => "admin", "status" => "active" }
|
|
486
532
|
prefix = ";#{param_name}="
|
|
487
533
|
if value.start_with?(prefix)
|
|
488
534
|
parse_comma_separated_object(value[prefix.length..-1])
|
|
489
535
|
else
|
|
490
|
-
|
|
536
|
+
raise ArgumentError, 'invalid matrix object'
|
|
491
537
|
end
|
|
492
538
|
end
|
|
493
539
|
|
|
@@ -21,8 +21,7 @@ module Committee
|
|
|
21
21
|
private
|
|
22
22
|
|
|
23
23
|
def check_content_type(request, content_type)
|
|
24
|
-
|
|
25
|
-
return true unless request.post? || request.put? || request.patch? || request.options?
|
|
24
|
+
return true unless @operation_object.body_method?
|
|
26
25
|
return true if @operation_object.valid_request_content_type?(content_type)
|
|
27
26
|
return true if @operation_object.optional_body? && empty_request?(request)
|
|
28
27
|
|
|
@@ -43,7 +42,7 @@ module Committee
|
|
|
43
42
|
return true if !request.body
|
|
44
43
|
|
|
45
44
|
data = request.body.read
|
|
46
|
-
request.body.rewind
|
|
45
|
+
request.body.rewind if request.body.respond_to?(:rewind)
|
|
47
46
|
data.empty?
|
|
48
47
|
end
|
|
49
48
|
end
|
|
@@ -27,9 +27,7 @@ module Committee
|
|
|
27
27
|
path = request.path
|
|
28
28
|
path = path.gsub(@prefix_regexp, '') if @prefix_regexp
|
|
29
29
|
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
@schema.operation_object(path, request_method)
|
|
30
|
+
@schema.operation_object(path, request.request_method)
|
|
33
31
|
end
|
|
34
32
|
|
|
35
33
|
private
|
|
@@ -21,10 +21,11 @@ module Committee
|
|
|
21
21
|
end
|
|
22
22
|
|
|
23
23
|
def response_validate(status, headers, response, test_method = false, custom_body_parser = nil)
|
|
24
|
-
full_body =
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
24
|
+
full_body = if response.is_a?(String)
|
|
25
|
+
response
|
|
26
|
+
else
|
|
27
|
+
response.each_with_object(String.new(encoding: Encoding::BINARY)) { |chunk, body| body << chunk.b }.force_encoding(Encoding::UTF_8)
|
|
28
|
+
end
|
|
28
29
|
|
|
29
30
|
parse_to_json = if validator_option.parse_response_by_content_type
|
|
30
31
|
content_type_key = headers.keys.detect { |k| k.casecmp?('Content-Type') }
|
|
@@ -58,8 +59,9 @@ module Committee
|
|
|
58
59
|
|
|
59
60
|
attr_reader :validator_option
|
|
60
61
|
|
|
61
|
-
def coerce_path_params
|
|
62
|
-
|
|
62
|
+
def coerce_path_params(deserializer)
|
|
63
|
+
path_params = deserializer&.deserialize_path_params(@operation_object.path_params)
|
|
64
|
+
Committee::RequestUnpacker.indifferent_params(@operation_object.coerce_path_parameter(@validator_option, path_params))
|
|
63
65
|
end
|
|
64
66
|
|
|
65
67
|
def request_schema_validation(request)
|
|
@@ -86,25 +88,26 @@ module Committee
|
|
|
86
88
|
end
|
|
87
89
|
|
|
88
90
|
def request_unpack(request)
|
|
89
|
-
|
|
91
|
+
media_type = @operation_object.request_operation.operation_object.request_body&.select_media_type(request.media_type)
|
|
92
|
+
allow_json_array = media_type&.schema&.type == 'array'
|
|
93
|
+
unpacker = Committee::RequestUnpacker.new(allow_empty_date_and_datetime: validator_option.allow_empty_date_and_datetime, allow_form_params: validator_option.allow_form_params, allow_get_body: validator_option.allow_get_body, allow_raw_body: true, allow_json_array: allow_json_array, allow_query_params: validator_option.allow_query_params, allow_non_get_query_params: validator_option.allow_non_get_query_params, optimistic_json: validator_option.optimistic_json,)
|
|
90
94
|
|
|
91
95
|
request.env[validator_option.headers_key] = unpacker.unpack_headers(request)
|
|
92
96
|
|
|
93
97
|
request_param, _is_form_params = unpacker.unpack_request_params(request)
|
|
94
98
|
request.env[validator_option.request_body_hash_key] = request_param
|
|
95
|
-
|
|
99
|
+
deserializer = ParameterDeserializer.new(@operation_object.request_operation) if validator_option.deserialize_parameters
|
|
100
|
+
request.env[validator_option.path_hash_key] = coerce_path_params(deserializer)
|
|
96
101
|
|
|
97
102
|
query_param = unpacker.unpack_query_params(request)
|
|
98
|
-
query_param.merge!(request_param) if request.get? && validator_option.allow_get_body
|
|
99
|
-
|
|
100
|
-
if @operation_object && validator_option.deserialize_parameters
|
|
101
|
-
deserializer = ParameterDeserializer.new(@operation_object.request_operation)
|
|
102
|
-
|
|
103
|
-
query_param = deserializer.deserialize_query_params(query_param)
|
|
103
|
+
query_param.merge!(request_param) if request.get? && validator_option.allow_get_body && request_param.is_a?(Hash)
|
|
104
104
|
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
request.
|
|
105
|
+
if deserializer
|
|
106
|
+
query_values = validator_option.allow_query_params ? Rack::Utils.parse_query(request.query_string, '&') : {}
|
|
107
|
+
# Do not restore query values that were overridden by the request body.
|
|
108
|
+
query_values.reject! { |name, _| request.POST.key?(name) } if validator_option.allow_non_get_query_params
|
|
109
|
+
query_values.reject! { |name, _| request_param.key?(name) } if request.get? && validator_option.allow_get_body && request_param.is_a?(Hash)
|
|
110
|
+
query_param = deserializer.deserialize_query_params(query_param, query_values)
|
|
108
111
|
|
|
109
112
|
headers = request.env[validator_option.headers_key]
|
|
110
113
|
headers = deserializer.deserialize_headers(headers)
|
|
@@ -125,7 +128,8 @@ module Committee
|
|
|
125
128
|
|
|
126
129
|
request.env[validator_option.params_key] = Committee::Utils.indifferent_hash
|
|
127
130
|
order.each do |key|
|
|
128
|
-
request.env[
|
|
131
|
+
value = request.env[key]
|
|
132
|
+
request.env[validator_option.params_key].merge!(Committee::Utils.deep_copy(value)) if value.is_a?(Hash)
|
|
129
133
|
end
|
|
130
134
|
end
|
|
131
135
|
end
|
|
@@ -19,11 +19,7 @@ module Committee
|
|
|
19
19
|
def build_prefix_regexp(prefix)
|
|
20
20
|
return nil unless prefix
|
|
21
21
|
|
|
22
|
-
|
|
23
|
-
/\A#{Regexp.escape(prefix)}/.freeze
|
|
24
|
-
else
|
|
25
|
-
/\A#{Regexp.escape(prefix)}(?=\/|\z)/.freeze
|
|
26
|
-
end
|
|
22
|
+
/\A#{Regexp.escape(prefix.chomp("/"))}(?=\/|\z)/.freeze
|
|
27
23
|
end
|
|
28
24
|
end
|
|
29
25
|
end
|
|
@@ -60,7 +60,7 @@ module Committee
|
|
|
60
60
|
path = path.gsub(Regexp.new("\\A#{Regexp.escape(prefix)}"), '')
|
|
61
61
|
end
|
|
62
62
|
|
|
63
|
-
schema.operation_object(path, @request.request_method
|
|
63
|
+
schema.operation_object(path, @request.request_method)
|
|
64
64
|
end
|
|
65
65
|
|
|
66
66
|
# Find the OpenAPI3 schema object for a parameter by name and location.
|
|
@@ -89,7 +89,7 @@ module Committee
|
|
|
89
89
|
return "dummy-#{key}" unless param_schema
|
|
90
90
|
return param_schema.enum.first.to_s if param_schema.enum&.any?
|
|
91
91
|
|
|
92
|
-
case param_schema
|
|
92
|
+
case Committee::Utils.schema_type(param_schema)
|
|
93
93
|
when 'integer', 'number' then '0'
|
|
94
94
|
when 'boolean' then 'true'
|
|
95
95
|
when 'array' then ['0']
|
|
@@ -367,7 +367,7 @@ module Committee
|
|
|
367
367
|
|
|
368
368
|
return prop_schema.enum.first if prop_schema.enum&.any?
|
|
369
369
|
|
|
370
|
-
case prop_schema
|
|
370
|
+
case Committee::Utils.schema_type(prop_schema)
|
|
371
371
|
when 'integer' then 0
|
|
372
372
|
when 'number' then 0.0
|
|
373
373
|
when 'boolean' then false
|
|
@@ -387,7 +387,7 @@ module Committee
|
|
|
387
387
|
|
|
388
388
|
return prop_schema.enum.first.to_s if prop_schema.enum&.any?
|
|
389
389
|
|
|
390
|
-
case prop_schema
|
|
390
|
+
case Committee::Utils.schema_type(prop_schema)
|
|
391
391
|
when 'integer', 'number' then '0'
|
|
392
392
|
when 'boolean' then 'true'
|
|
393
393
|
when 'array' then ['0']
|
|
@@ -25,6 +25,8 @@ module Committee
|
|
|
25
25
|
end
|
|
26
26
|
|
|
27
27
|
increment_assertion_count
|
|
28
|
+
rescue Committee::InvalidRequest, Committee::BadRequest => e
|
|
29
|
+
handle_test_failure(e)
|
|
28
30
|
end
|
|
29
31
|
|
|
30
32
|
def assert_response_schema_confirm(expected_status = nil)
|
|
@@ -50,6 +52,8 @@ module Committee
|
|
|
50
52
|
schema_validator.response_validate(status, headers, [body], true) if validate_response?(status)
|
|
51
53
|
|
|
52
54
|
increment_assertion_count
|
|
55
|
+
rescue Committee::InvalidResponse => e
|
|
56
|
+
handle_test_failure(e)
|
|
53
57
|
end
|
|
54
58
|
|
|
55
59
|
def committee_options
|
|
@@ -94,6 +98,15 @@ module Committee
|
|
|
94
98
|
|
|
95
99
|
private
|
|
96
100
|
|
|
101
|
+
# Passes a validation failure to the test_failure_handler option instead of
|
|
102
|
+
# raising it, so that the test framework can report it as a failure.
|
|
103
|
+
def handle_test_failure(error)
|
|
104
|
+
handler = committee_options.fetch(:test_failure_handler, nil)
|
|
105
|
+
raise error unless handler
|
|
106
|
+
|
|
107
|
+
handler.call(error)
|
|
108
|
+
end
|
|
109
|
+
|
|
97
110
|
# assert_*_schema_confirm signal failure by raising, not via `assert`,
|
|
98
111
|
# so Minitest would report "Test is missing assertions" on success.
|
|
99
112
|
# Bump the counter explicitly; no-op outside Minitest (e.g. RSpec).
|
|
@@ -46,7 +46,7 @@ module Committee
|
|
|
46
46
|
end
|
|
47
47
|
|
|
48
48
|
def update_response_coverage!(path, method, response_status)
|
|
49
|
-
method = method
|
|
49
|
+
method = coverage_method(path, method)
|
|
50
50
|
response_status = response_status.to_s
|
|
51
51
|
|
|
52
52
|
@covered[path] ||= {}
|
|
@@ -63,7 +63,8 @@ module Committee
|
|
|
63
63
|
path_item._openapi_all_child_objects.each do |object_name, object|
|
|
64
64
|
next unless object.is_a?(OpenAPIParser::Schemas::Operation)
|
|
65
65
|
|
|
66
|
-
|
|
66
|
+
# JSON Pointer segment (RFC 6901), so `SYNC~V2` appears as `SYNC~0V2`
|
|
67
|
+
method = object_name.split('/').last&.gsub('~1', '/')&.gsub('~0', '~')
|
|
67
68
|
next unless method
|
|
68
69
|
|
|
69
70
|
report[path_name][method] ||= {}
|
|
@@ -90,6 +91,14 @@ module Committee
|
|
|
90
91
|
def report_flatten
|
|
91
92
|
self.class.flatten_report(report)
|
|
92
93
|
end
|
|
94
|
+
|
|
95
|
+
private
|
|
96
|
+
|
|
97
|
+
# an exact additionalOperations key keeps its case; anything else is a lowercase standard method
|
|
98
|
+
def coverage_method(path, method)
|
|
99
|
+
method = method.to_s
|
|
100
|
+
schema.open_api.paths.path[path]&.additional_operations&.key?(method) ? method : method.downcase
|
|
101
|
+
end
|
|
93
102
|
end
|
|
94
103
|
end
|
|
95
104
|
end
|
data/lib/committee/utils.rb
CHANGED
data/lib/committee/version.rb
CHANGED
data/lib/committee.rb
CHANGED
|
@@ -44,6 +44,19 @@ describe Committee::Drivers::OpenAPI2::Driver do
|
|
|
44
44
|
end
|
|
45
45
|
end
|
|
46
46
|
|
|
47
|
+
it "resolves references to reusable parameters" do
|
|
48
|
+
schema_data = schema_data_with_responses({ '200' => { 'description' => 'ok' } })
|
|
49
|
+
schema_data['parameters'] = { 'limit' => { 'name' => 'limit', 'in' => 'query', 'type' => 'integer' }, 'authorization' => { 'name' => 'Authorization', 'in' => 'header', 'type' => 'string' }, }
|
|
50
|
+
schema_data['paths']['/foos']['get']['parameters'] = [{ '$ref' => '#/parameters/limit' }, { '$ref' => '#/parameters/authorization' },]
|
|
51
|
+
|
|
52
|
+
schema = @driver.parse(schema_data)
|
|
53
|
+
|
|
54
|
+
link = schema.routes['GET'][0][1]
|
|
55
|
+
assert_equal ['limit'], link.schema.properties.keys
|
|
56
|
+
assert_equal ['integer'], link.schema.properties['limit'].type
|
|
57
|
+
assert_equal ['Authorization'], link.header_schema.properties.keys
|
|
58
|
+
end
|
|
59
|
+
|
|
47
60
|
it "names capture groups into href regexes" do
|
|
48
61
|
schema = @driver.parse(open_api_2_data)
|
|
49
62
|
assert_equal %r{^\/api\/pets\/(?<id>[^\/]+)$}.inspect, schema.routes["DELETE"][0][0].inspect
|
data/test/drivers_test.rb
CHANGED
|
@@ -45,11 +45,14 @@ describe Committee::Drivers do
|
|
|
45
45
|
assert_kind_of Committee::Drivers::OpenAPI3::Schema, s
|
|
46
46
|
end
|
|
47
47
|
|
|
48
|
-
it '
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
48
|
+
it 'loads OpenAPI 3.1' do
|
|
49
|
+
s = Committee::Drivers.load_from_file(open_api_3_1_schema_path, parser_options: { strict_reference_validation: true })
|
|
50
|
+
assert_kind_of Committee::Drivers::OpenAPI3::Schema, s
|
|
51
|
+
end
|
|
52
|
+
|
|
53
|
+
it 'loads OpenAPI 3.2' do
|
|
54
|
+
s = Committee::Drivers.load_from_file(open_api_3_2_schema_path, parser_options: { strict_reference_validation: true })
|
|
55
|
+
assert_kind_of Committee::Drivers::OpenAPI3::Schema, s
|
|
53
56
|
end
|
|
54
57
|
|
|
55
58
|
it 'fails to load OpenAPI 3 with invalid reference' do
|
|
@@ -164,11 +167,39 @@ describe Committee::Drivers do
|
|
|
164
167
|
assert_kind_of Committee::Drivers::HyperSchema::Schema, s
|
|
165
168
|
end
|
|
166
169
|
|
|
167
|
-
it '
|
|
170
|
+
it 'loads OpenAPI 3.1' do
|
|
171
|
+
s = Committee::Drivers.load_from_data(open_api_3_1_data, nil, parser_options: { strict_reference_validation: true })
|
|
172
|
+
assert_kind_of Committee::Drivers::OpenAPI3::Schema, s
|
|
173
|
+
end
|
|
174
|
+
|
|
175
|
+
it 'loads OpenAPI 3.2' do
|
|
176
|
+
s = Committee::Drivers.load_from_data(open_api_3_2_data, nil, parser_options: { strict_reference_validation: true })
|
|
177
|
+
assert_kind_of Committee::Drivers::OpenAPI3::Schema, s
|
|
178
|
+
end
|
|
179
|
+
|
|
180
|
+
it 'loads an OpenAPI 3.2 prerelease' do
|
|
181
|
+
s = Committee::Drivers.load_from_data(open_api_3_2_data.merge('openapi' => '3.2.0-rc1'), nil, parser_options: { strict_reference_validation: true })
|
|
182
|
+
assert_kind_of Committee::Drivers::OpenAPI3::Schema, s
|
|
183
|
+
end
|
|
184
|
+
|
|
185
|
+
it 'fails to load OpenAPI 3.3+' do
|
|
168
186
|
e = assert_raises(Committee::OpenAPI3Unsupported) do
|
|
169
|
-
Committee::Drivers.load_from_data(
|
|
187
|
+
Committee::Drivers.load_from_data(open_api_3_2_data.merge('openapi' => '3.3.0'))
|
|
188
|
+
end
|
|
189
|
+
assert_equal 'Committee does not support OpenAPI 3.3+ yet', e.message
|
|
190
|
+
end
|
|
191
|
+
|
|
192
|
+
it 'fails to load an OpenAPI 3.3 prerelease' do
|
|
193
|
+
assert_raises(Committee::OpenAPI3Unsupported) do
|
|
194
|
+
Committee::Drivers.load_from_data(open_api_3_2_data.merge('openapi' => '3.3.0-rc1'))
|
|
195
|
+
end
|
|
196
|
+
end
|
|
197
|
+
|
|
198
|
+
it 'loads OpenAPI 3.1 without a patch version or as a YAML number' do
|
|
199
|
+
['3.1', 3.1].each do |version|
|
|
200
|
+
s = Committee::Drivers.load_from_data(open_api_3_1_data.merge('openapi' => version), nil, parser_options: { strict_reference_validation: true })
|
|
201
|
+
assert_kind_of Committee::Drivers::OpenAPI3::Schema, s
|
|
170
202
|
end
|
|
171
|
-
assert_equal 'Committee does not support OpenAPI 3.1+ yet', e.message
|
|
172
203
|
end
|
|
173
204
|
end
|
|
174
205
|
end
|