[powershell-experimental] Protects against stackoverflow when OAS spec has circular references (!5646) · Merge requests · OpenAPI Tools / openapi-generator

Merged Administrator requested to merge github/fork/vvb/fixes-stackoverflow into master Mar 20, 2020

Created by: vvb

fixes #5663 (closed) The powershell-experimental generator runs into the below stackoverflow when the OAS spec has circular references. This happens while generating example strings.

[main] INFO  o.o.codegen.AbstractGenerator - writing file /home/vvb/sdk/powershell/src/PSOpenAPITools/Api/AaaApi.ps1
[main] INFO  o.o.codegen.AbstractGenerator - writing file /home/vvb/sdk/powershell/tests/AaaApi.Tests.ps1
[main] INFO  o.o.codegen.AbstractGenerator - writing file /home/vvb/sdk/powershell/docs/AaaApi.md
Exception in thread "main" java.lang.StackOverflowError
	at java.lang.StringBuilder.append(StringBuilder.java:136)
	at org.openapitools.codegen.languages.PowerShellExperimentalClientCodegen.constructExampleCode(PowerShellExperimentalClientCodegen.java:760)
	at org.openapitools.codegen.languages.PowerShellExperimentalClientCodegen.constructExampleCode(PowerShellExperimentalClientCodegen.java:750)
	at org.openapitools.codegen.languages.PowerShellExperimentalClientCodegen.constructExampleCode(PowerShellExperimentalClientCodegen.java:718)
	at org.openapitools.codegen.languages.PowerShellExperimentalClientCodegen.constructExampleCode(PowerShellExperimentalClientCodegen.java:763)
	at org.openapitools.codegen.languages.PowerShellExperimentalClientCodegen.constructExampleCode(PowerShellExperimentalClientCodegen.java:750)
	at org.openapitools.codegen.languages.PowerShellExperimentalClientCodegen.constructExampleCode(PowerShellExperimentalClientCodegen.java:763)
	at org.openapitools.codegen.languages.PowerShellExperimentalClientCodegen.constructExampleCode(PowerShellExperimentalClientCodegen.java:750)
	at org.openapitools.codegen.languages.PowerShellExperimentalClientCodegen.constructExampleCode(PowerShellExperimentalClientCodegen.java:718)
	at org.openapitools.codegen.languages.PowerShellExperimentalClientCodegen.constructExampleCode(PowerShellExperimentalClientCodegen.java:763)
	at org.openapitools.codegen.languages.PowerShellExperimentalClientCodegen.constructExampleCode(PowerShellExperimentalClientCodegen.java:750)
	at org.openapitools.codegen.languages.PowerShellExperimentalClientCodegen.constructExampleCode(PowerShellExperimentalClientCodegen.java:718)
	at org.openapitools.codegen.languages.PowerShellExperimentalClientCodegen.constructExampleCode(PowerShellExperimentalClientCodegen.java:763)
	at org.openapitools.codegen.languages.PowerShellExperimentalClientCodegen.constructExampleCode(PowerShellExperimentalClientCodegen.java:750)
	at org.openapitools.codegen.languages.PowerShellExperimentalClientCodegen.constructExampleCode(PowerShellExperimentalClientCodegen.java:718)
	at org.openapitools.codegen.languages.PowerShellExperimentalClientCodegen.constructExampleCode(PowerShellExperimentalClientCodegen.java:763)
	at org.openapitools.codegen.languages.PowerShellExperimentalClientCodegen.constructExampleCode(PowerShellExperimentalClientCodegen.java:750)
	at org.openapitools.codegen.languages.PowerShellExperimentalClientCodegen.constructExampleCode(PowerShellExperimentalClientCodegen.java:718)
	at org.openapitools.codegen.languages.PowerShellExperimentalClientCodegen.constructExampleCode(PowerShellExperimentalClientCodegen.java:763)
	at org.openapitools.codegen.languages.PowerShellExperimentalClientCodegen.constructExampleCode(PowerShellExperimentalClientCodegen.java:750)
	at org.openapitools.codegen.languages.PowerShellExperimentalClientCodegen.constructExampleCode(PowerShellExperimentalClientCodegen.java:718)
	at org.openapitools.codegen.languages.PowerShellExperimentalClientCodegen.constructExampleCode(PowerShellExperimentalClientCodegen.java:763)
	at org.openapitools.codegen.languages.PowerShellExperimentalClientCodegen.constructExampleCode(PowerShellExperimentalClientCodegen.java:750)
	at org.openapitools.codegen.languages.PowerShellExperimentalClientCodegen.constructExampleCode(PowerShellExperimentalClientCodegen.java:718)
	at org.openapitools.codegen.languages.PowerShellExperimentalClientCodegen.constructExampleCode(PowerShellExperimentalClientCodegen.java:763)
	at org.openapitools.codegen.languages.PowerShellExperimentalClientCodegen.constructExampleCode(PowerShellExperimentalClientCodegen.java:750)
	at org.openapitools.codegen.languages.PowerShellExperimentalClientCodegen.constructExampleCode(PowerShellExperimentalClientCodegen.java:718)

OAS Spec used for testing: https://gist.github.com/26be250f0b0e2518e35bd80916d62bb8 With reference to the above mentioned OAS spec, the current example generation logic breaks because of : adapter.ConfigPolicy -> Mo.BaseMo -> ancestors -> mo.Optional.BaseMo -> Mo.BaseMo

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.