Delete autogenerated test stubs #149
Merged
Conversation
This file contains 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
I propose that we delete the autogenerated test stubs. They are only stubs, containing commented out code to serve as a starting point for human written tests - they do not actually test anything. I suggest that it is unlikely that the project will ever make use of these test stubs for the purpose intended by the generator - I do not think anyone is going to be going through the API manually filling in tests that exercise all/most client methods against a Vault server. Additionally, in the case of the `src/Vault.Test/Api/*Tests.cs` files, they are generated by openapi-generator only if they do not already exist, and as a result are already out of date with various method renames that have occurred, as OpenAPI operation IDs have been tweaked over time. I have retained one file of non-generated tests. This change harmonizes with the sibling vault-client-go project, which already has generation of test stubs turned off.
|
This will also fix the "Unchanged files with check annotations" section showing up in every PR diff, complaining about unused code in the tests. |
maxb
commented
Jul 23, 2023
| # For example, you can ignore all files in a docs folder with the file extension .md: | ||
| #docs/*.md | ||
| # Then explicitly reverse the ignore rule for a single file: | ||
| #!docs/README.md |
There was a problem hiding this comment.
I simplified this comment to match the one in sibling project vault-client-go.
averche
approved these changes
Jul 23, 2023
|
Conflict resolved. |
AnPucel
approved these changes
Jul 24, 2023
|
Thanks - please go ahead and merge, if you are happy. |
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.
I propose that we delete the autogenerated test stubs.
They are only stubs, containing commented out code to serve as
a starting point for human written tests - they do not actually test
anything.
I suggest that it is unlikely that the project will ever make use of
these test stubs for the purpose intended by the generator - I do not
think anyone is going to be going through the API manually filling in
tests that exercise all/most client methods against a Vault server.
Additionally, in the case of the
src/Vault.Test/Api/*Tests.csfiles,they are generated by openapi-generator only if they do not already
exist, and as a result are already out of date with various method
renames that have occurred, as OpenAPI operation IDs have been tweaked
over time.
I have retained one file of non-generated tests.
This change harmonizes with the sibling vault-client-go project, which
already has generation of test stubs turned off.