Fix generated gdsl code display names #674
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Calling https://localhost/pipeline-syntax/gdsl creates a document that escapes forward slashes.
The use of
groovy.json.StringEscapeUtils.escapeJavaScript(java.lang.String)
, will break parsing of the resulting content within an IDE (i.e. IntelliJ Idea), if described plugin steps have a forward slash in theirdisplayName
content.plugin samples:
envVarsForTool
of plugin "pipeline-model-definition" (contains single quote) LinksshGet
,sshPut
of plugin "ssh-steps" (contain forward slash) LinkAccording to Groovy API doc of escapeJavaScript :
which is not 100% true to their code, as it also escapes forward slashes, which in turn breaks the parsing.
So to have the
displayName
properly escaped, it is sufficient to switch toescapeJava(String)
and also escape single quotes afterwards.(Using
escapeJavaStyleString(<String>, true, false)
whould also be sufficient, but that worker function is markedprivate
ingroovy.json.StringEscapeUtils
)JENKINS-70755