GRADLE-3084 escaping of $ in unix scripts

subprojects/plugins/src/main/groovy/org/gradle/api/internal/plugins/StartScriptGenerator.groovy

@@ -39,6 +39,11 @@ class StartScriptGenerator {
     String mainClassName
 
     Iterable<String> defaultJvmOpts = []
+
+    /**
+     * Flag to turn on escaping of meta characters like $ in default jvm opts 
+     */
+    Boolean escapeMetaCharactersInDefaultJvmOpts = false
 
     /**
      * The classpath, relative to the application home directory.
@@ -73,6 +78,7 @@ class StartScriptGenerator {
         scriptGenerationDetails.applicationName = applicationName
         scriptGenerationDetails.mainClassName = mainClassName
         scriptGenerationDetails.defaultJvmOpts = defaultJvmOpts
+        scriptGenerationDetails.escapeMetaCharactersInDefaultJvmOpts = escapeMetaCharactersInDefaultJvmOpts
         scriptGenerationDetails.optsEnvironmentVar = optsEnvironmentVar
         scriptGenerationDetails.exitEnvironmentVar = exitEnvironmentVar
         scriptGenerationDetails.classpath = classpath

subprojects/plugins/src/main/groovy/org/gradle/api/plugins/ApplicationPlugin.groovy

@@ -102,6 +102,7 @@ class ApplicationPlugin implements Plugin<Project> {
         startScripts.conventionMapping.applicationName = { pluginConvention.applicationName }
         startScripts.conventionMapping.outputDir = { new File(project.buildDir, 'scripts') }
         startScripts.conventionMapping.defaultJvmOpts = { pluginConvention.applicationDefaultJvmArgs }
+        startScripts.conventionMapping.escapeMetaCharactersInDefaultJvmOpts = { pluginConvention.escapeMetaCharactersInDefaultJvmOpts }
     }
 
     private Task addInstallAppTask(Distribution distribution) {

subprojects/plugins/src/main/groovy/org/gradle/api/tasks/application/CreateStartScripts.groovy

@@ -47,6 +47,13 @@ public class CreateStartScripts extends ConventionTask {
     @Input
     @Optional
     Iterable<String> defaultJvmOpts = []
+
+    /**
+     * If script should escape meta characters like $
+     */
+    @Input
+    @Optional
+    Boolean escapeMetaCharactersInDefaultJvmOpts = false;
 
     /**
      * The application's name.
@@ -115,6 +122,7 @@ public class CreateStartScripts extends ConventionTask {
         generator.applicationName = getApplicationName()
         generator.mainClassName = getMainClassName()
         generator.defaultJvmOpts = getDefaultJvmOpts()
+        generator.escapeMetaCharactersInDefaultJvmOpts = getEscapeMetaCharactersInDefaultJvmOpts()
         generator.optsEnvironmentVar = getOptsEnvironmentVar()
         generator.exitEnvironmentVar = getExitEnvironmentVar()
         generator.classpath = getClasspath().collect { "lib/${it.name}".toString() }

subprojects/plugins/src/main/java/org/gradle/api/internal/plugins/UnixStartScriptGenerator.java

@@ -39,7 +39,8 @@ public Map<String, String> createBinding(JavaAppStartScriptGenerationDetails det
         binding.put("applicationName", details.getApplicationName());
         binding.put("optsEnvironmentVar", details.getOptsEnvironmentVar());
         binding.put("mainClassName", details.getMainClassName());
-        binding.put("defaultJvmOpts", createJoinedDefaultJvmOpts(details.getDefaultJvmOpts()));
+        binding.put("defaultJvmOpts", createJoinedDefaultJvmOpts(details.getDefaultJvmOpts(), details.getEscapeMetaCharactersInDefaultJvmOpts()));
+        binding.put("escapeMetaCharactersInDefaultJvmOpts", String.valueOf(details.getEscapeMetaCharactersInDefaultJvmOpts()));
         binding.put("appNameSystemProperty", details.getAppNameSystemProperty());
         binding.put("appHomeRelativePath", createJoinedAppHomeRelativePath(details.getScriptRelPath()));
         binding.put("classpath", createJoinedClasspath(details.getClasspath()));
@@ -58,15 +59,17 @@ public String apply(String input) {
         }));
     }
 
-    private String createJoinedDefaultJvmOpts(Iterable<String> defaultJvmOpts) {
+    private String createJoinedDefaultJvmOpts(Iterable<String> defaultJvmOpts, final Boolean escapeMetaCharactersInDefaultJvmOpts) {
         Iterable<String> quotedDefaultJvmOpts = Iterables.transform(defaultJvmOpts, new Function<String, String>() {
             public String apply(String jvmOpt) {
                 //quote ', ", \, $. Probably not perfect. TODO: identify non-working cases, fail-fast on them
                 jvmOpt = jvmOpt.replace("\\", "\\\\");
                 jvmOpt = jvmOpt.replace("\"", "\\\"");
                 jvmOpt = jvmOpt.replace("'", "'\"'\"'");
                 jvmOpt = jvmOpt.replace("`", "'\"`\"'");
-                jvmOpt = jvmOpt.replace("$", "\\$");
+                if(escapeMetaCharactersInDefaultJvmOpts){
+                  jvmOpt = jvmOpt.replace("$", "\\$");
+                }
                 StringBuilder quotedJvmOpt = new StringBuilder();
                 quotedJvmOpt.append("\"");
                 quotedJvmOpt.append(jvmOpt);

subprojects/plugins/src/main/java/org/gradle/api/scripting/JavaAppStartScriptGenerationDetails.java

@@ -40,6 +40,8 @@ public class JavaAppStartScriptGenerationDetails implements ScriptGenerationDeta
     private String mainClassName;
 
     private Iterable<String> defaultJvmOpts = new ArrayList<String>();
+
+    private Boolean escapeMetaCharactersInDefaultJvmOpts = false;
 
     /**
      * The classpath, relative to the application home directory.
@@ -96,6 +98,14 @@ public void setDefaultJvmOpts(Iterable<String> defaultJvmOpts) {
         this.defaultJvmOpts = defaultJvmOpts;
     }
 
+    public Boolean getEscapeMetaCharactersInDefaultJvmOpts() {
+      return escapeMetaCharactersInDefaultJvmOpts;
+    }
+
+    public void setEscapeMetaCharactersInDefaultJvmOpts(Boolean escapeMetaCharactersInDefaultJvmOpts) {
+      this.escapeMetaCharactersInDefaultJvmOpts = escapeMetaCharactersInDefaultJvmOpts;
+    }
+
     public Iterable<String> getClasspath() {
         return classpath;
     }

subprojects/plugins/src/test/groovy/org/gradle/api/internal/plugins/UnixStartScriptGeneratorTest.groovy

@@ -111,7 +111,7 @@ class UnixStartScriptGeneratorTest extends Specification {
         generator.generateScript(details, destination)
 
         then:
-        destination.toString().contains(/DEFAULT_JVM_OPTS='"-Dfoo=b\\ar baz" "-Xint/ + '\\$PATH' + /"'/)
+        destination.toString().contains(/DEFAULT_JVM_OPTS='"-Dfoo=b\\ar baz" "-Xint/ + '$PATH' + /"'/)
     }
 
     def "defaultJvmOpts is expanded properly in unix script -- empty list"() {