Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Kotlin][Multiplatform] Fix Enum Generation #10923

Conversation

tkirshboim
Copy link
Contributor

PR Description

Fixes #10902

  • Fix broken generation of enum classes by removing unnecessary template code that broke the compilation of the generated code.

Testing

Reproducing the issue

To validate that this PR fixes the issue you should first reproduce the issue. This can be done on the master branch by generating the kotlin-multiplatform template code with the petstore-with-fake-endpoints-models-for-testing.yaml API spec, and then trying to compile the generated code:

./bin/generate-samples.sh bin/configs/kotlin-multiplatform.yaml -- -i modules/openapi-generator/src/test/resources/2_0/petstore-with-fake-endpoints-models-for-testing.yaml
./mvnw integration-test -f samples/client/petstore/kotlin-multiplatform/pom.xml

The test fails due to several compilation errors. The errors that are relevant for the purpose of this PR, as reported in #10902 , can be observed in OuterEnum.kt and EnumClass.kt:

[redacted]
e: ./openapi-generator/samples/client/petstore/kotlin-multiplatform/src/commonMain/kotlin/org/openapitools/client/models/EnumClass.kt: (31, 32): Unresolved reference: Serializer
[redacted]
e: ./openapi-generator/samples/client/petstore/kotlin-multiplatform/src/commonMain/kotlin/org/openapitools/client/models/OuterEnum.kt: (31, 32): Unresolved reference: Serializer

To validate that this PR fixes the issue, checkout this PR's code and re-run the two commands from above. The compile errors in OuterEnum.kt and EnumClass.kt are no longer present.

CCs

Kotlin technical committee: @jimschubert @dr4ke616 @karismann @Zomzog @andrewemery @4brunu @yutaka0m

Reporter of #10902 : @Qbit982

PR checklist

  • Read the contribution guidelines.
  • Pull Request title clearly describes the work in the pull request and Pull Request description provides details about how to validate the work. Missing information here may result in delayed response from the community.
  • Run the following to build the project and update samples:
    ./mvnw clean package 
    ./bin/generate-samples.sh
    ./bin/utils/export_docs_generators.sh
    
    Commit all changed files.
    This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master.
    These must match the expectations made by your contribution.
    You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example ./bin/generate-samples.sh bin/configs/java*.
    For Windows users, please run the script in Git BASH.
  • File the PR against the correct branch: master (5.3.0), 6.0.x
  • If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.

@4brunu
Copy link
Contributor

4brunu commented Nov 22, 2021

Hey @tkirshboim, thanks for opening this PR.
Could you please run the following PR to generate the sample projects?

./mvnw clean package 
./bin/generate-samples.sh

Thanks

@tkirshboim
Copy link
Contributor Author

tkirshboim commented Nov 22, 2021

Hey @tkirshboim, thanks for opening this PR. Could you please run the following PR to generate the sample projects?

./mvnw clean package 
./bin/generate-samples.sh

Thanks

@4brunu Thanks for the prompt response.
I've ran these commands and there are no local changes to commit when they've completed. This is probably because modules/openapi-generator/src/test/resources/2_0/petstore.yaml does not contain the enum definitions that cause the enum_class.mustache template to be used. This is the reason why I used petstore-with-fake-endpoints-models-for-testing.yaml to validate that the issue is resolved, as mentioned in the PR description.

@4brunu
Copy link
Contributor

4brunu commented Nov 22, 2021

I see.
Did you test this in your local local project? Is it working?

@tkirshboim
Copy link
Contributor Author

I see. Did you test this in your local local project? Is it working?

@4brunu Yes. I was experiencing the same issue as #10902 and this change resolved the issue. The project compiled again and worked as expected with this change.

@4brunu
Copy link
Contributor

4brunu commented Nov 22, 2021

Thanks, looks good to me 👍

@wing328 wing328 added this to the 5.3.1 milestone Nov 23, 2021
@wing328 wing328 merged commit 3a12b61 into OpenAPITools:master Nov 23, 2021
@tkirshboim tkirshboim deleted the kotlin-multiplatform-fix-enum-class-generation branch November 23, 2021 18:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[BUG] Kotlin multiplatform, Kotlinx Serialization, Error while generating enum classes
3 participants