[Kotlin][Client] new library support: Retrofit 2.x by javils · Pull Request #4518 · OpenAPITools/openapi-generator

javils · 2019-11-17T21:01:48Z

PR checklist

Read the contribution guidelines.
If contributing template-only or documentation-only changes which will change sample output, build the project before.
Run the shell script(s) under ./bin/ (or Windows batch scripts under.\bin\windows) to update Petstore samples related to your fix. This is important, as CI jobs will verify all generator outputs of your HEAD commit, and these must match the expectations made by your contribution. You only need to run ./bin/{LANG}-petstore.sh, ./bin/openapi3/{LANG}-petstore.sh if updating the code or mustache templates for a language ({LANG}) (e.g. php, ruby, python, etc).
File the PR against the correct branch: master, 4.3.x, 5.0.x. Default: master.
Copy the technical committee to review the pull request if your PR is targeting a particular programming language.

PR Description

This PR add support for retrofit2 as a HTTP library in kotlin-client generator. The reason to add this feature is that I want to port some old android java code to kotlin, but I couldn't because retrofit2 was not supported.

@jimschubert @dr4ke616 @karismann @Zomzog @andrewemery

… but it's not urgent.

auto-labeler · 2019-11-17T21:01:52Z

👍 Thanks for opening this issue!
🏷 I have applied any labels matching special text in your issue.

The team will review the labels and make any necessary changes.

# Conflicts: # bin/kotlin-client-all.sh # modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/KotlinClientCodegen.java

wing328 · 2019-11-22T05:48:07Z

bin/kotlin-client-all.sh

 ./bin/kotlin-client-string.sh
 ./bin/kotlin-client-threetenbp.sh
 ./bin/kotlin-client-nullable.sh
+./bin/kotlin-client-retrofti2.sh


typo: kotlin-client-retrofti2.sh => kotlin-client-retrofit2.sh

Thanks for reviewing!
It's solved in this commit: a3b34b5

wing328 · 2019-11-22T05:50:53Z

When using --library retrofit2, the following files are missing:

README.md
build.gradle
settings.gradle

Can we also auto-generate these files similar to what we've done for other library options in the kotlin generator?

# Conflicts: # modules/openapi-generator/src/main/resources/kotlin-client/data_class_opt_var.mustache # modules/openapi-generator/src/main/resources/kotlin-client/data_class_req_var.mustache

javils · 2019-11-30T16:49:04Z

When using --library retrofit2, the following files are missing:
README.md
build.gradle
settings.gradle
Can we also auto-generate these files similar to what we've done for other library options in the kotlin generator?

Thanks!
Solved in this commit: f37bfbb

4brunu · 2019-12-02T10:01:58Z

@javils can you please run on the terminal sh bin/utils/ensure-up-to-date --batch and commit the file docs/generators/kotlin.md to make the CI pass?
Overall the PR looks ok, but it's a bit scary to merge this, because it changes so many things.

4brunu · 2019-12-02T10:03:20Z

bin/kotlin-client-retrofit2.sh

+
+java ${JAVA_OPTS} -jar ${executable} ${ags}
+
+cp CI/samples.ci/client/petstore/kotlin-threetenbp/pom.xml samples/client/petstore/kotlin-threetenbp/pom.xml


@javils this like is not related to this sample, can you please remove it?

Thanks for reviewing!

Fixed here: 6e4566f

…brary/retrofit

javils · 2019-12-03T07:11:37Z

@javils can you please run on the terminal sh bin/utils/ensure-up-to-date --batch and commit the file docs/generators/kotlin.md to make the CI pass?
Overall the PR looks ok, but it's a bit scary to merge this, because it changes so many things.

When I run this command I got a lot of modified files and not update the kotlin.md file. Any idea?

javils · 2019-12-05T10:21:03Z

Thanks!
For the next PR I know the trick.

…brary/retrofit

javils · 2019-12-09T09:17:41Z

@wing328 @jimschubert @dr4ke616 @karismann @Zomzog @andrewemery
Can we merge this? Someone need to check something else?

wing328 · 2019-12-09T09:50:14Z

I did a test with the auto-generated Kotlin code (retrofit2) for Petstore but got the following errors:

Starting a Gradle Daemon (subsequent builds will be faster)

> Task :compileKotlin
e: /private/tmp/re/src/main/kotlin/org/openapitools/client/apis/PetApi.kt: (18, 51): Unresolved reference: CSVParams
e: /private/tmp/re/src/main/kotlin/org/openapitools/client/apis/PetApi.kt: (20, 6): No value passed for parameter 'message'
e: /private/tmp/re/src/main/kotlin/org/openapitools/client/apis/PetApi.kt: (22, 45): Unresolved reference: CSVParams
e: /private/tmp/re/src/main/kotlin/org/openapitools/client/apis/PetApi.kt: (36, 130): Unresolved reference: MultipartBody
e: /private/tmp/re/src/main/kotlin/org/openapitools/client/apis/StoreApi.kt: (14, 22): Parameter name expected
e: /private/tmp/re/src/main/kotlin/org/openapitools/client/apis/StoreApi.kt: (14, 79): Expecting comma or ')'
e: /private/tmp/re/src/main/kotlin/org/openapitools/client/apis/StoreApi.kt: (16, 5): Expecting ')'
e: /private/tmp/re/src/main/kotlin/org/openapitools/client/apis/StoreApi.kt: (16, 6): Expecting member declaration
e: /private/tmp/re/src/main/kotlin/org/openapitools/client/apis/StoreApi.kt: (16, 9): Expecting member declaration
e: /private/tmp/re/src/main/kotlin/org/openapitools/client/apis/StoreApi.kt: (16, 10): Expecting member declaration
e: /private/tmp/re/src/main/kotlin/org/openapitools/client/apis/StoreApi.kt: (16, 11): Expecting member declaration
e: /private/tmp/re/src/main/kotlin/org/openapitools/client/apis/StoreApi.kt: (16, 33): Expecting member declaration
e: /private/tmp/re/src/main/kotlin/org/openapitools/client/apis/StoreApi.kt: (16, 34): Expecting member declaration
e: /private/tmp/re/src/main/kotlin/org/openapitools/client/apis/UserApi.kt: (29, 20): Parameter name expected
e: /private/tmp/re/src/main/kotlin/org/openapitools/client/apis/UserApi.kt: (29, 32): Expecting comma or ')'
e: /private/tmp/re/src/main/kotlin/org/openapitools/client/apis/UserApi.kt: (31, 5): Expecting ')'
e: /private/tmp/re/src/main/kotlin/org/openapitools/client/apis/UserApi.kt: (31, 6): Expecting member declaration
e: /private/tmp/re/src/main/kotlin/org/openapitools/client/apis/UserApi.kt: (31, 9): Expecting member declaration
e: /private/tmp/re/src/main/kotlin/org/openapitools/client/apis/UserApi.kt: (31, 10): Expecting member declaration
e: /private/tmp/re/src/main/kotlin/org/openapitools/client/apis/UserApi.kt: (31, 11): Expecting member declaration
e: /private/tmp/re/src/main/kotlin/org/openapitools/client/apis/UserApi.kt: (31, 27): Expecting member declaration
e: /private/tmp/re/src/main/kotlin/org/openapitools/client/apis/UserApi.kt: (31, 28): Expecting member declaration
e: /private/tmp/re/src/main/kotlin/org/openapitools/client/infrastructure/ApiClient.kt: (20, 30): Unresolved reference: MoshiConverterFactory

> Task :compileKotlin FAILED

FAILURE: Build failed with an exception.

Can you please take a look?

javils · 2019-12-10T22:13:01Z

I did a test with the auto-generated Kotlin code (retrofit2) for Petstore but got the following errors:

Starting a Gradle Daemon (subsequent builds will be faster)

> Task :compileKotlin
e: /private/tmp/re/src/main/kotlin/org/openapitools/client/apis/PetApi.kt: (18, 51): Unresolved reference: CSVParams
e: /private/tmp/re/src/main/kotlin/org/openapitools/client/apis/PetApi.kt: (20, 6): No value passed for parameter 'message'
e: /private/tmp/re/src/main/kotlin/org/openapitools/client/apis/PetApi.kt: (22, 45): Unresolved reference: CSVParams
e: /private/tmp/re/src/main/kotlin/org/openapitools/client/apis/PetApi.kt: (36, 130): Unresolved reference: MultipartBody
e: /private/tmp/re/src/main/kotlin/org/openapitools/client/apis/StoreApi.kt: (14, 22): Parameter name expected
e: /private/tmp/re/src/main/kotlin/org/openapitools/client/apis/StoreApi.kt: (14, 79): Expecting comma or ')'
e: /private/tmp/re/src/main/kotlin/org/openapitools/client/apis/StoreApi.kt: (16, 5): Expecting ')'
e: /private/tmp/re/src/main/kotlin/org/openapitools/client/apis/StoreApi.kt: (16, 6): Expecting member declaration
e: /private/tmp/re/src/main/kotlin/org/openapitools/client/apis/StoreApi.kt: (16, 9): Expecting member declaration
e: /private/tmp/re/src/main/kotlin/org/openapitools/client/apis/StoreApi.kt: (16, 10): Expecting member declaration
e: /private/tmp/re/src/main/kotlin/org/openapitools/client/apis/StoreApi.kt: (16, 11): Expecting member declaration
e: /private/tmp/re/src/main/kotlin/org/openapitools/client/apis/StoreApi.kt: (16, 33): Expecting member declaration
e: /private/tmp/re/src/main/kotlin/org/openapitools/client/apis/StoreApi.kt: (16, 34): Expecting member declaration
e: /private/tmp/re/src/main/kotlin/org/openapitools/client/apis/UserApi.kt: (29, 20): Parameter name expected
e: /private/tmp/re/src/main/kotlin/org/openapitools/client/apis/UserApi.kt: (29, 32): Expecting comma or ')'
e: /private/tmp/re/src/main/kotlin/org/openapitools/client/apis/UserApi.kt: (31, 5): Expecting ')'
e: /private/tmp/re/src/main/kotlin/org/openapitools/client/apis/UserApi.kt: (31, 6): Expecting member declaration
e: /private/tmp/re/src/main/kotlin/org/openapitools/client/apis/UserApi.kt: (31, 9): Expecting member declaration
e: /private/tmp/re/src/main/kotlin/org/openapitools/client/apis/UserApi.kt: (31, 10): Expecting member declaration
e: /private/tmp/re/src/main/kotlin/org/openapitools/client/apis/UserApi.kt: (31, 11): Expecting member declaration
e: /private/tmp/re/src/main/kotlin/org/openapitools/client/apis/UserApi.kt: (31, 27): Expecting member declaration
e: /private/tmp/re/src/main/kotlin/org/openapitools/client/apis/UserApi.kt: (31, 28): Expecting member declaration
e: /private/tmp/re/src/main/kotlin/org/openapitools/client/infrastructure/ApiClient.kt: (20, 30): Unresolved reference: MoshiConverterFactory

> Task :compileKotlin FAILED

FAILURE: Build failed with an exception.

Can you please take a look?

Thanks for your feedback!
I've done some commits to solve the issues :-)

4brunu · 2019-12-11T09:12:43Z

@javils Since in your last commit you made a change in a mustache, you also need to update the pet projects, otherwise the CI will fail, because the pet projects are outdated.

javils · 2019-12-11T19:45:43Z

@4brunu done!

javils · 2019-12-12T06:42:01Z

The build failed 2 times because of this:

An error occurred during the signature verification. The repository is not updated and the previous index files will be used. GPG error: http://deb.opera.com/opera stable InRelease: The following signatures couldn't be verified because the public key is not available: NO_PUBKEY

wing328 · 2019-12-12T07:45:52Z

@javils the shippable failure has been fixed in the master. Can you please merge the latest master into this branch to retrigger the build?

…brary/retrofit

wing328 · 2019-12-13T06:03:27Z

I still got errors when testing the Petstore samples (kotlin retrofit2):

> Task :compileKotlin
e: /Users/williamcheng/Code/openapi-generator/samples/client/petstore/kotlin-retrofit2/src/main/kotlin/org/openapitools/client/apis/PetApi.kt: (20, 6): No value passed for parameter 'message'
e: /Users/williamcheng/Code/openapi-generator/samples/client/petstore/kotlin-retrofit2/src/main/kotlin/org/openapitools/client/apis/PetApi.kt: (36, 130): Unresolved reference: MultipartBody

Does it work for you locally?

@deprecated

@deprecated has a message param that java not. Add it with a default message.

…brary/retrofit

4brunu · 2019-12-14T22:13:50Z

I have tested this locally and I think now it's working.
Can anyone confirm? 🙂

wing328 · 2019-12-15T10:25:36Z

Tested locally and the result is good. Thanks for the PR.

wing328 · 2019-12-22T06:03:10Z

UPDATE: the library option has been renamed from retrofit2 to jvm-retrofit2

javils added 6 commits November 9, 2019 19:56

Some clean code.

b88f465

Add support for retrofit2 in models and apis. Need work in ApiClient,…

cd6bf93

… but it's not urgent.

Add ApiClient with retrofit2 support.

63d3a25

Remove unnecessary package.

c419ca3

Add scripts to generate samples.

bbe92d9

Generate sample of retrofit2

4d639d6

auto-labeler bot added the Client: Retrofit label Nov 17, 2019

javils added 3 commits November 17, 2019 22:15

Merge branch 'master' into feature/kotlin/library/retrofit

993ac5b

# Conflicts: # bin/kotlin-client-all.sh # modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/KotlinClientCodegen.java

Change toUpperCase to toUpperCase(Locale.ROOT) to fix compile.

ed0e0f0

Added GSON library when it's needed

07fd78f

wing328 added the Enhancement: Feature label Nov 19, 2019

wing328 added this to the 4.2.2 milestone Nov 19, 2019

wing328 reviewed Nov 22, 2019

View reviewed changes

javils added 4 commits November 30, 2019 17:29

Fix typo.

a3b34b5

Add some missing common files.

f37bfbb

Execute bin script.

818f249

Merge branch 'master' into feature/kotlin/library/retrofit

f27b5dc

# Conflicts: # modules/openapi-generator/src/main/resources/kotlin-client/data_class_opt_var.mustache # modules/openapi-generator/src/main/resources/kotlin-client/data_class_req_var.mustache

javils requested a review from wing328 November 30, 2019 17:41

wing328 modified the milestones: 4.2.2, 4.2.3 Dec 2, 2019

4brunu reviewed Dec 2, 2019

View reviewed changes

javils added 2 commits December 3, 2019 07:59

Remove copy&paste error in script.

6e4566f

Merge remote-tracking branch 'upstream/master' into feature/kotlin/li…

f81bbf3

…brary/retrofit

[kotlin] update outdated files

ce09949

4brunu mentioned this pull request Dec 3, 2019

[kotlin] update outdated files javils/openapi-generator#1

Merged

Merge remote-tracking branch 'upstream/master' into feature/kotlin/li…

e192465

…brary/retrofit

javils added 5 commits December 10, 2019 22:25

Fix apis with no params.

39ac24b

Add missing import in ApiClient

3ace985

Add support for CSV, SSV, TSV, PIPES, SPACES in retrofit 2 library.

f3d2c22

Fix package name.

930d767

Execute kotlin-client-retrofit2.sh script.

764cd51

force rebuild.

a60b39f

execute script again.

705e097

Merge remote-tracking branch 'upstream/master' into feature/kotlin/li…

bc78a38

…brary/retrofit

wing328 mentioned this pull request Dec 14, 2019

New generator: kotlin-retrofit (lightweight, Android, coroutines) #3195

Closed

javils added 4 commits December 14, 2019 13:48

Add missing imports from okhttp3.

d2efbfc

@deprecated has a message param that java not. Add it with a default message.

Execute retrofit2 script.

3274aa0

Merge remote-tracking branch 'upstream/master' into feature/kotlin/li…

a01609d

…brary/retrofit

Rerun script.

3b31e91

wing328 approved these changes Dec 15, 2019

View reviewed changes

wing328 merged commit bb4af91 into OpenAPITools:master Dec 15, 2019

wing328 changed the title ~~Feature/kotlin/library/retrofit~~ [Kotlin][Client] new library support: Retrofit 2.x Dec 15, 2019


		java ${JAVA_OPTS} -jar ${executable} ${ags}

		cp CI/samples.ci/client/petstore/kotlin-threetenbp/pom.xml samples/client/petstore/kotlin-threetenbp/pom.xml

Uh oh!

Conversation

javils commented Nov 17, 2019

PR checklist

PR Description

Uh oh!

auto-labeler bot commented Nov 17, 2019

Uh oh!

wing328 Nov 22, 2019

Choose a reason for hiding this comment

Uh oh!

javils Nov 30, 2019

Choose a reason for hiding this comment

Uh oh!

wing328 commented Nov 22, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

javils commented Nov 30, 2019

Uh oh!

4brunu commented Dec 2, 2019

Uh oh!

4brunu Dec 2, 2019

Choose a reason for hiding this comment

Uh oh!

javils Dec 3, 2019

Choose a reason for hiding this comment

Uh oh!

javils commented Dec 3, 2019

Uh oh!

javils commented Dec 5, 2019

Uh oh!

javils commented Dec 9, 2019

Uh oh!

wing328 commented Dec 9, 2019

Uh oh!

javils commented Dec 10, 2019

Uh oh!

4brunu commented Dec 11, 2019

Uh oh!

javils commented Dec 11, 2019

Uh oh!

javils commented Dec 12, 2019

Uh oh!

wing328 commented Dec 12, 2019

Uh oh!

wing328 commented Dec 13, 2019

Uh oh!

4brunu commented Dec 14, 2019

Uh oh!

wing328 commented Dec 15, 2019

Uh oh!

wing328 commented Dec 22, 2019

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

wing328 commented Nov 22, 2019 •

edited

Loading