SONARGROOV-39 Escape value of CodeNarc properties

pmayweg · Aug 3, 2015 · 7442229 · 7442229
1 parent d07a93a
commit 7442229
Show file tree

Hide file tree

Showing 3 changed files with 24 additions and 1 deletion.
diff --git a/src/main/java/org/sonar/plugins/groovy/codenarc/CodeNarcProfileExporter.java b/src/main/java/org/sonar/plugins/groovy/codenarc/CodeNarcProfileExporter.java
@@ -19,6 +19,7 @@
  */
 package org.sonar.plugins.groovy.codenarc;
 
+import org.apache.commons.lang.StringEscapeUtils;
 import org.apache.commons.lang.StringUtils;
 import org.sonar.api.profiles.RulesProfile;
 import org.sonar.api.rules.ActiveRule;
@@ -82,7 +83,7 @@ private void appendRule(ActiveRule activeRule) throws IOException {
           writer.append("<property name=\"")
             .append(activeRuleParam.getKey())
             .append("\" value=\"")
-            .append(value)
+            .append(StringEscapeUtils.escapeXml(value))
             .append(AUTO_CLOSING_TAG);
         }
       }

diff --git a/src/test/java/org/sonar/plugins/groovy/codenarc/CodeNarcProfileExporterTest.java b/src/test/java/org/sonar/plugins/groovy/codenarc/CodeNarcProfileExporterTest.java
@@ -102,6 +102,19 @@ public void shouldNotExportParametersWithDefaultValue() throws Exception {
       writer.toString());
   }
 
+  @Test
+  public void shouldEscapeExportedParameters() throws Exception {
+    Rule rule = Rule.create(CodeNarcRulesDefinition.REPOSITORY_KEY, "org.codenarc.rule.naming.ClassNameRule", "Class Name");
+    rule.createParameter("regex").setDefaultValue("([A-Z]\\w*\\$?)*");
+    profile.activateRule(rule, RulePriority.MAJOR).setParameter("regex", "[A-Z]+[a-z&&[^bc]]");
+
+    exporter.exportProfile(profile);
+
+    assertSimilarXml(
+      TestUtils.getResource("/org/sonar/plugins/groovy/codenarc/exportProfile/exportEscapedParameters.xml"),
+      writer.toString());
+  }
+
   private void assertSimilarXml(File expectedFile, String xml) throws Exception {
     XMLUnit.setIgnoreWhitespace(true);
     Reader reader = new FileReader(expectedFile);

diff --git a/...est/resources/org/sonar/plugins/groovy/codenarc/exportProfile/exportEscapedParameters.xml b/...est/resources/org/sonar/plugins/groovy/codenarc/exportProfile/exportEscapedParameters.xml
@@ -0,0 +1,9 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<ruleset xmlns="http://codenarc.org/ruleset/1.0"
+         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:schemaLocation="http://codenarc.org/ruleset/1.0 http://codenarc.org/ruleset-schema.xsd"
+         xsi:noNamespaceSchemaLocation="http://codenarc.org/ruleset-schema.xsd">
+  <rule class="org.codenarc.rule.naming.ClassNameRule">
+    <property name="regex" value="[A-Z]+[a-z&amp;&amp;[^bc]]"/>
+  </rule>
+</ruleset>