swagger-api/swagger-codegen

Various variable name escape issues

Open

#5949 opened on Jun 29, 2017

View on GitHub
 (0 comments) (0 reactions) (0 assignees)HTML (12,701 stars) (5,474 forks)batch import
Issue: Bughelp wanted

Description

Description

Using the code search engine in, lgtm.com various toVarName or toParamName methods does not seem to have properly escaped special characters:

https://lgtm.com/query/2023430003/project:12070014/lang:java/

The above shows methods toVarName and toParamName that do not call sanitizeName. Not all of these are problematic, as special characters may have been escaped in another way, but some of them needs fixing. In particular, in the case of c++, this can lead to uncompilable code.

Swagger-codegen version

master branch: cbd7301

Swagger declaration file content or url

e.g. For cpp.

Command line used for generation
Steps to reproduce
java -jar swagger-codegen/modules/swagger-codegen-cli/target/swagger-codegen-cli.jar generate -l cpprest -i cpp.yaml -o ./test
Suggest a Fix

I will create a PR for the c++ case, but perhaps others can take a look at the other languages to see if it is ok. Once a method is found to be correct, I can update the query to exclude it (or others can take a look at the docs https://lgtm.com/docs/ql/primer/ql-primer). Once everything is either fixed or excluded, we can close the issue. Note: The link posted to the query result is cached for the commit cbd7301 and will require updating from time to time. To do so, copy the content of the query console on the page, enter swagger-api/swagger-codegen in the search box, then click 'Query this project' on the right, paste back the content to the console and click run once it is compiled.

Contributor guide

Tech stack
javacpp
Domain
tooling
Issue type
bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
Java knowledgeC++ knowledgeSwagger codegen architecture
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
30
Research direction
Examine the toVarName and toParamName methods in swagger codegen's templates for Java and C++. The issue identifies that these methods do not call sanitizeName, leading to unescaped special characters. Start by fixing the C++ case as mentioned, then extend the fix to other languages by referencing the LGTM query provided. Review the swagger codegen generators module for relevant template files and consult the project's documentation on sanitization.