Test/schema coverage #297
Test/schema coverage #297
Conversation
README.md
Outdated
| @@ -403,6 +403,38 @@ end | |||
|
|
|||
| The default assertion option in 2.* was `validate_success_only=true`, but this becomes `validate_success_only=false` in 3.*. For the smoothest possible upgrade, you should set it to `false` in your test suite before upgrading to 3.*. | |||
|
|
|||
| **Test schema coverage** | |||
| NOTE: Currently committee only supports schema coverage for openapi schemas, and only checks coverage on responses. | |||
There was a problem hiding this comment.
Now we support tests using 'assert_schema_conform' or 'assert_response_schema_confirm' only.
(i.e. the user who use committee middleware in test )
So please write NOTICE to these user
There was a problem hiding this comment.
I have added more details to the docs
| application/json: | ||
| schema: | ||
| type: object | ||
| '404': |
There was a problem hiding this comment.
OpenAPI 3 support default. When status code wasn't matched defined, use default` definithion.
https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.3.md#responses-object-example
So please implement and test it.
It was hard to tell which tests took part in current_schema_coverage
|
Just made this commit 32600b2 to fix committee accepting requests even when they don't have matching prefix (in tests) |
datbth
force-pushed
the
test/schema_coverage
branch
from
9f0be05
to
9c9f330
Compare
| path = request.path | ||
| path = path.gsub(@prefix_regexp, '') if prefix_request?(request) | ||
| path = path.gsub(@prefix_regexp, '') if @prefix_regexp |
| 2. Use `assert_response_schema_confirm` or `assert_schema_conform` | ||
| 3. Then use `SchemaCoverage#report` or `SchemaCoverage#report_flatten` to get coverage report | ||
|
|
||
| Example: |
There was a problem hiding this comment.
very nice!!!!!!!!!!!!!!!!! 👍 👍 👍 👍 👍 👍 👍 👍 👍
|
hmm I have just realized I put the docs in the changes/migration section, should have put it in the upper big Test Assertion section instead 😿 |
Track schema coverage in tests (see #296)
Other changes