[crystal] Fix some issues in crystal client templates #10629

cyangle · 2021-10-19T04:39:28Z

@wing328 Fixed some issues found when using crystal generator to generate client library for google drive v3 api
tests failed with below errors:

366313 [ERROR] Failed to execute goal org.apache.maven.plugins:maven-surefire-plugin:3.0.0-M5:test (default-test) on project openapi-generator: There are test failures.
366313 [ERROR] 
366313 [ERROR] Please refer to /gen/modules/openapi-generator/target/surefire-reports for the individual test results.
366313 [ERROR] Please refer to dump files (if any exist) [date].dump, [date]-jvmRun[N].dump and [date].dumpstream.
366313 [ERROR] ExecutionException The forked VM terminated without properly saying goodbye. VM crash or System.exit called?
366313 [ERROR] Command was /bin/sh -c cd /gen/modules/openapi-generator && /usr/local/openjdk-8/jre/bin/java -Xmx1024m -XX:MaxPermSize=256m org.apache.maven.surefire.booter.ForkedBooter /gen/modules/openapi-generator/target/surefire 2021-10-19T04-17-42_620-jvmRun1 surefire1215040486184154595tmp surefire_32415854988303674911tmp
366313 [ERROR] Error occurred in starting fork, check output in log
366314 [ERROR] Process Exit Code: 137
366314 [ERROR] Crashed tests:
366314 [ERROR] org.openapitools.codegen.kotlin.spring.KotlinSpringServerCodegenTest
366314 [ERROR] org.apache.maven.surefire.booter.SurefireBooterForkException: ExecutionException The forked VM terminated without properly saying goodbye. VM crash or System.exit called?
366314 [ERROR] Command was /bin/sh -c cd /gen/modules/openapi-generator && /usr/local/openjdk-8/jre/bin/java -Xmx1024m -XX:MaxPermSize=256m org.apache.maven.surefire.booter.ForkedBooter /gen/modules/openapi-generator/target/surefire 2021-10-19T04-17-42_620-jvmRun1 surefire1215040486184154595tmp surefire_32415854988303674911tmp

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.

…3 api spec

wing328 · 2021-10-19T10:22:03Z

modules/openapi-generator/src/main/resources/crystal/api_client.mustache

@@ -245,18 +146,19 @@ module {{moduleName}}
      when :pipes
        param.join("|")
      when :multi
+        # TODO: Need to fix this


What about raise an error saying multi is not supported in the client?

wing328 · 2021-10-19T10:26:47Z

modules/openapi-generator/src/main/resources/crystal/partial_model_enum_class.mustache

+      when {{{value}}}
+        {{{name}}}
+      {{/enumVars}} {{/allowableValues}}
+      else


Suggestion to allow trailing spaces:

{{#allowableValues}} {{#enumVars}} when {{{value}}} {{{name}}} {{/enumVars}} {{/allowableValues}}

…rator into crystal

Raises on unsupported feature clean up extra new lines in partial_model_enum_class.mustache

length is undefined for String or Array

wing328 · 2021-10-20T07:37:30Z

modules/openapi-generator/src/main/resources/crystal/api_client.mustache

-        # return the array directly as typhoeus will handle it as expected
-        param
+        # TODO: Need to fix this
+        raise "mult is not supported yet"


typo mult => multi

…rator into crystal

wing328 · 2021-10-21T03:05:24Z

I ran the crystal petstore integration tests (samples/client/petstore/crystal/pom.xml) locally but got

In src/petstore/models/pet.cr:63:69

 63 | def initialize(@id : Int64? = nil, @category : Category? = nil, @name : String, @photo_urls : Array(String), @tags : Array(Tag)? = nil, @status : String? = nil)
                                                                      ^
Error: parameter must have a default value

Looks like there's a breaking change in initializing the model (pet in this case)?

Can we remove the breaking change for the time being so that rest of the fixes/enhancements can be merged into master first?

…rator into crystal

The spec could also have a File model

wing328 · 2021-10-22T01:41:05Z

samples/client/petstore/crystal/src/petstore/api/pet_api.cr

@@ -432,7 +432,7 @@ module Petstore
    # uploads an image
    # @param pet_id [Int64] ID of pet to update
    # @return [ApiResponse]
-    def upload_file(pet_id : Int64, additional_metadata : String?, file : File?)
+    def upload_file(pet_id : Int64, additional_metadata : String? = nil, file : File? = nil)


@cyangle Is this (default to nil) also breaking change when it comes to calling the operations? If yes, please revert the change for the time being?

I missed it

single quotes are used for single char in crystal

…rator into crystal

cyangle · 2021-10-22T03:48:57Z

@wing328 I have reverted the breaking changes and also added file upload support and other bug fixes

cyangle · 2021-10-22T04:22:30Z

I have no idea how to fix this issue:

$ crystal test.cr 
In src/google_drive/api/about_api.cr:22:49

 22 | def drive_about_get(alt : String? = "json", fields : String?, key : String?, oauth_token : String?, pretty_print : Bool? = true, quota_user : String?, user_ip : String?)
                                                  ^
Error: parameter must have a default value

In crystal, a method can specify default values for the last parameters from here

wing328 · 2021-10-22T10:33:07Z

I reran the tests and now I got

Showing last frame. Use --error-trace for full trace.

In spec/api/pet_api_spec.cr:100:23

 100 | result.category.id.should eq pet_id + 10
                       ^-
Error: undefined method 'id' for Nil (compile-time type is (Petstore::Category | Nil))
[ERROR] Command execution failed.

Has there been any breaking changes to the model properties?

wing328 · 2021-10-22T10:33:55Z

Btw, here is how you can run the test locally with a petstore server running in your machine:

https://github.com/OpenAPITools/openapi-generator/wiki/Integration-Tests#how-to-add-integration-tests-for-new-petstore-samples

…rator into crystal

wing328 · 2021-10-23T03:26:56Z

All local tests passed:

In /usr/local/Cellar/crystal/1.2.0/src/uri/encoding.cr:119:25

 119 | String.build { |io| encode(string, io, space_to_plus: space_to_plus) }
                           ^-----
Warning: Deprecated URI.encode:space_to_plus. Use `.encode_path` instead.

In src/petstore/api/pet_api.cr:277:68

 277 | local_var_path = "/pet/{petId}".sub("{" + "petId" + "}", URI.encode(pet_id.to_s).gsub("%2F", "/"))
                                                                    ^-----
Warning: Deprecated URI.encode. Use `.encode_path` instead.

A total of 2 warnings were found.
..............................................................

Finished in 378.8 milliseconds
62 examples, 0 failures, 0 errors, 0 pending
[INFO] ----------------------------------------

cyangle added 2 commits October 18, 2021 23:12

Fix some issues in crystal client templates using google drive v3 oas…

9291810

…3 api spec

update crystal petstore sample code

638b447

cyangle changed the title ~~Fix some issues in crystal client templates~~ [crystal] Fix some issues in crystal client templates Oct 19, 2021

wing328 reviewed Oct 19, 2021

View reviewed changes

wing328 added Client: Crystal Issue: Bug labels Oct 19, 2021

cyangle added 3 commits October 19, 2021 16:36

Merge branch 'master' of https://github.com/OpenAPITools/openapi-gene…

961afec

…rator into crystal

Address PR comments

28db021

Raises on unsupported feature clean up extra new lines in partial_model_enum_class.mustache

Use size instead of length

42d3658

length is undefined for String or Array

wing328 reviewed Oct 20, 2021

View reviewed changes

cyangle added 2 commits October 20, 2021 12:56

Fix typo

15c8edc

Merge branch 'master' of https://github.com/OpenAPITools/openapi-gene…

6439537

…rator into crystal

cyangle added 5 commits October 21, 2021 00:56

Use default value instead of nil

e6c6666

Merge branch 'master' of https://github.com/OpenAPITools/openapi-gene…

b825728

…rator into crystal

remove unused template file

4c9ec63

Use ::File instead of File as file type to avoid conflicts

00431a2

The spec could also have a File model

support file upload in multipart/form-data post body

ec60ecf

wing328 reviewed Oct 22, 2021

View reviewed changes

cyangle added 5 commits October 21, 2021 22:17

Revert breaking changes in api template

d65cad2

Use double quotes to quote string values

2c17a6f

single quotes are used for single char in crystal

Merge branch 'crystal-multipart' into crystal

4825d2a

Update api_client to use global ::File and update petstore samples

dce8bbb

Merge branch 'master' of https://github.com/OpenAPITools/openapi-gene…

e8242dd

…rator into crystal

JSON Annotation Field key's value should be double quoted

acf8050

cyangle added 2 commits October 21, 2021 23:25

Handle nil values for form_params

edd01d3

Remove default values from method definitions due to grammar error

0192e50

cyangle added 2 commits October 22, 2021 17:24

Fix integration tests

210e149

Merge branch 'master' of https://github.com/OpenAPITools/openapi-gene…

e575bd2

…rator into crystal

wing328 merged commit 27459b5 into OpenAPITools:master Oct 23, 2021

wing328 added this to the 5.3.0 milestone Oct 23, 2021

cyangle deleted the crystal branch October 23, 2021 04:03

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[crystal] Fix some issues in crystal client templates #10629

[crystal] Fix some issues in crystal client templates #10629

cyangle commented Oct 19, 2021 •

edited

Loading

wing328 Oct 19, 2021

wing328 Oct 19, 2021

wing328 Oct 20, 2021

wing328 commented Oct 21, 2021 •

edited

Loading

wing328 Oct 22, 2021

cyangle Oct 22, 2021 •

edited

Loading

cyangle commented Oct 22, 2021

cyangle commented Oct 22, 2021

wing328 commented Oct 22, 2021

wing328 commented Oct 22, 2021

wing328 commented Oct 23, 2021

[crystal] Fix some issues in crystal client templates #10629

[crystal] Fix some issues in crystal client templates #10629

Conversation

cyangle commented Oct 19, 2021 • edited Loading

PR checklist

wing328 Oct 19, 2021

Choose a reason for hiding this comment

wing328 Oct 19, 2021

Choose a reason for hiding this comment

wing328 Oct 20, 2021

Choose a reason for hiding this comment

wing328 commented Oct 21, 2021 • edited Loading

wing328 Oct 22, 2021

Choose a reason for hiding this comment

cyangle Oct 22, 2021 • edited Loading

Choose a reason for hiding this comment

cyangle commented Oct 22, 2021

cyangle commented Oct 22, 2021

wing328 commented Oct 22, 2021

wing328 commented Oct 22, 2021

wing328 commented Oct 23, 2021

cyangle commented Oct 19, 2021 •

edited

Loading

wing328 commented Oct 21, 2021 •

edited

Loading

cyangle Oct 22, 2021 •

edited

Loading