Add finer-grain reference tests for translation phase #103
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
simonjbeaumont
changed the title
Signed-off-by: Si Beaumont <beaumont@apple.com>
simonjbeaumont
force-pushed
the
finer-grain-reference-tests
branch
from
f4f5110 to
1ab10fe
Compare
czechboy0
approved these changes
Jul 7, 2023
Tests/OpenAPIGeneratorReferenceTests/SnippetBasedReferenceTests.swift
Outdated
Show resolved
Hide resolved
Signed-off-by: Si Beaumont <beaumont@apple.com>
czechboy0
reviewed
Jul 11, 2023
Signed-off-by: Si Beaumont <beaumont@apple.com>
czechboy0
requested changes
Jul 12, 2023
simonjbeaumont
force-pushed
the
finer-grain-reference-tests
branch
from
9a56558 to
4b18a2b
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Motivation
We have a reference test, which we've been making use of to validate end-to-end generation from OpenAPI document matches handwritten Swift files. This started out life as the canonical Petstore example from the OpenAPI specification but has since been augmented in various ways to test out some edge cases. This approach isn't scaling too well as we have an all-or-nothing test.
We also don't have great test coverage over the translation phase of the generator pipeline, which translates between the parsed OpenAPI document to an intermediate representation.
Modifications
Add test harnesses for finer grain reference tests that exercise smaller sections of the translation phase. It should allow us to test a small OpenAPI document renders to equivalent Swift source (stripping comments and reformatting).
Result
Hopefully a more modular and maintainable testing strategy as we try to support more of the OpenAPI specification.
Test Plan
This PR is tests.