add tests that verify actual behavior of generated code #216
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
eli-bl
commented
Nov 7, 2024
|
|
||
| On entering this context, sys.path is changed to include the root directory of the | ||
| generated code, so its modules can be imported. On exit, the original sys.path is | ||
| restored, and any modules that were loaded within the context are removed. |
There was a problem hiding this comment.
Btw, the proof that this works is simply that running all the tests in generated_code_live_tests in a single pytest run passes. Since many of the test classes reuse the same generated modules and class names for different things, if the sandboxing didn't work then the tests would inevitably pollute each other and fail.
eli-bl
commented
Nov 7, 2024
| return importlib.import_module(f"{self.base_module}{module_path}") | ||
|
|
||
|
|
||
| def _run_command( |
eli-bl
force-pushed
the
live-generated-code-tests-bl
branch
from
03c6551 to
1aa1b51
Compare
eli-bl
commented
Nov 8, 2024
| ) | ||
|
|
||
|
|
||
| @with_generated_client_fixture( |
There was a problem hiding this comment.
The tests below are for all the new discriminator logic in the previous PR. I hope you'll agree that this makes it a lot easier to see what's going on.
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.
This is a tests-only change that I've also submitted to the main repo in openapi-generators#1156; see PR description there. The goal is to facilitate quicker development of features and bugfixes as I continue to make changes to the generator, by verifying that the generated classes actually work in unit tests.
Previously, if I wanted to check for instance that a model with a discriminator would deserialize correctly, I had to go to a shell, run the generator on an example spec, cd into the output directory, start a Python REPL, import the class and execute some test statements there. But now I could just write tests like these.
The new tests that I've included in this PR cover a variety of JSON encoding/decoding behaviors for model classes. I would add something similar for request encoding (query parameters, URLs, etc.) later. I think that'll avoid the need for unit tests of specific SDK model classes and methods, since it will basically prove that if an API spec has such-and-such type of thing then the generated code for that thing will behave correctly.