[GRADLE-1141] Filtering in a copyspec is broken when a bare backslash is present in the input file. Created: 03/Sep/10  Updated: 10/Feb/17  Resolved: 10/Feb/17

Status: Resolved
Project: Gradle
Affects Version/s: 0.9.1
Fix Version/s: None

Type: Bug
Reporter: Jeroen van Erp Assignee: Unassigned
Resolution: Won't Fix Votes: 4

Attachments: Zip Archive filterBackslash.zip    


When you filter files during the copy, using the expand(kay: value) method, it crashes when a bare backslash '\' character is present in the file.


Caused by: groovy.lang.GroovyRuntimeException: Failed to parse template script (your template may contain an error or be trying to use expressions not currently supported): startup failed:
SimpleTemplateScript1.groovy: 3: unexpected char: '\' @ line 3, column 38.
out.print("this contains a backslash \ character.\n");

1 error

at groovy.text.SimpleTemplateEngine.createTemplate(SimpleTemplateEngine.java:124)
at org.gradle.api.internal.file.copy.FilterChain$3.transform(FilterChain.java:90)
at org.gradle.api.internal.file.copy.FilterChain$3.transform(FilterChain.java:84)
at org.gradle.api.internal.ChainingTransformer.transform(ChainingTransformer.java:37)
at org.gradle.api.internal.file.copy.FilterChain.transform(FilterChain.java:39)
at org.gradle.api.internal.file.copy.FilterChain.transform(FilterChain.java:46)
at org.gradle.api.internal.file.copy.MappingCopySpecVisitor$FileVisitDetailsImpl.open(MappingCopySpecVisitor.java:101)
at org.gradle.api.internal.file.AbstractFileTreeElement.copyTo(AbstractFileTreeElement.java:43)
at org.gradle.api.internal.file.copy.MappingCopySpecVisitor$FileVisitDetailsImpl.copyTo(MappingCopySpecVisitor.java:109)
at org.gradle.api.internal.file.AbstractFileTreeElement.copyFile(AbstractFileTreeElement.java:77)
at org.gradle.api.internal.file.AbstractFileTreeElement.copyTo(AbstractFileTreeElement.java:65)

Attached you can find the project to reproduce this.

Comment by Andrew Phillips [ 06/Sep/10 ]

According the the AbstractCopyTask docs [1], the input file is passed to the SimpleTemplateEngine [2] for processing. Since the SimpleTemplateEngine format uses '\' for escaping [3], the observed behaviour is to be expected.

However, I don't think it is "natural" to expect that text files in which users want to replace simple placeholders are written in the SimpleTemplateEngine format. Whilst that's an option that one might want to add for more advanced usage, I certainly think there's a case for a "dumb" string search-and-replace on files.

A workaround could be to use the Ant tasks for this, but since we're talking about the native Gradle copy task here it would seem odd if this only supported an "advanced" use case.

[1] http://www.gradle.org/0.9-rc-1/docs/javadoc/org/gradle/api/tasks/AbstractCopyTask.html#expand%28java.util.Map%29
[2] http://groovy.codehaus.org/gapi/groovy/text/SimpleTemplateEngine.html
[3] http://groovy.codehaus.org/Groovy+Templates

Comment by Benjamin Muschko [ 15/Nov/16 ]

As announced on the Gradle blog we are planning to completely migrate issues from JIRA to GitHub.

We intend to prioritize issues that are actionable and impactful while working more closely with the community. Many of our JIRA issues are inactionable or irrelevant. We would like to request your help to ensure we can appropriately prioritize JIRA issues you’ve contributed to.

Please confirm that you still advocate for your JIRA issue before December 10th, 2016 by:

  • Checking that your issues contain requisite context, impact, behaviors, and examples as described in our published guidelines.
  • Leave a comment on the JIRA issue or open a new GitHub issue confirming that the above is complete.

We look forward to collaborating with you more closely on GitHub. Thank you for your contribution to Gradle!

Comment by Benjamin Muschko [ 10/Feb/17 ]

Thanks again for reporting this issue. We haven't heard back from you after our inquiry from November 15th. We are closing this issue now. Please create an issue on GitHub if you still feel passionate about getting it resolved.

Generated at Wed Jun 30 11:47:59 CDT 2021 using Jira 8.4.2#804003-sha1:d21414fc212e3af190e92c2d2ac41299b89402cf.