[MRESOURCES-110] escapeString is broken - break filtered output

• Type: Bug
• Status: Closed
• Priority: Critical
• Resolution: Fixed
• Affects Version/s: 2.4, 2.4.1
• Fix Version/s: 2.5
• Environment: Maven 2.0.9, WinXP
• Assignee: Olivier Lamy
• Reporter: Marco Rothe
• Created: 04/Nov/09 06:14
• Updated: 06/Apr/15 01:16
• Resolved: 11/Jan/11 12:28

Description

If the escapeString parameter is specified in plugin configuration this will break the filtered output.

For example the configuration

<plugin>
   <artifactId>maven-resources-plugin</artifactId>
   <version>2.4.1</version>
   <configuration>
     <escapeString>!</escapeString>
   </configuration>
</plugin>

an file to filter (an XML file)

<?xml version="1.0" encoding="UTF-8"?>
<root>
    <!-- This is a comment ... until filtering ... -->
   <broken-tag>Why are my !\${\}\! static.content broken if the escapeString occure ?!?</broken-tag>
   <broken-tag>Content with replacement: ${replaceThis} !</broken-tag>
   <broken-tag>Content with escaped replacement: Do not !${replaceThis} !</broken-tag>
</root>

and a property

 <properties>
        <replaceThis>I am the replacement</replaceThis>
 </properties>

from pom or profile.xml

result in

<?xml version="1.0" encoding="UTF-8"?>
<root>
    <!- This is a comment ... until filtering ... -->
   <broken-tag>Why are my !${\}\!static.content broken if the escapeString occure ?!</broken-tag>
   <broken-tag>Content with replacement: I am the replacement !/broken-tag>
   <broken-tag>Content with escaped replacement: Do not ${replaceThis} !/broken-tag>
</root>

Note the broken comment and tags!
If using Resources-Plugin 2.3 the output is like expected:

<?xml version="1.0" encoding="UTF-8"?>
<root>
    <!-- This is a comment ... until filtering ... -->
   <broken-tag>Why are my !\${\}\! static.content broken if the escapeString occure ?!?</broken-tag>
   <broken-tag>Content with replacement: I am the replacement !</broken-tag>
   <broken-tag>Content with escaped replacement: Do not ${replaceThis} !</broken-tag>
</root>

Got even worse when using a complex escape string like <escapeString>static</escapeString> (I know it's a silly example ). The result is

<?xml version=".0" encoding="UTF-8"?>
<root>
    <!-- This is acomment ... until filtering ... -->
   <broken-tag>Why are my !\${\}\! staticcontent broken if the escapeSring occure ?!?</broken-tag>
   <broken-tag>Content with replacement: I am the replacement !</broken-tag>
   <broken-tag>Content with escapedreplacement: Do not !I am the replacement !</broken-tag>
</root>

Note the missing characters all over the file ... :-/

So the actual state of the escapeString feature is unpredictable and nearly useless.

Issue Links

• depends upon: MSHARED-181 escapeString non follow by startToken remove character