Test canDisableRelocateStringConstants

Author: Goooler

src/functionalTest/kotlin/com/github/jengelman/gradle/plugins/shadow/RelocationTest.kt

@@ -8,9 +8,11 @@ import assertk.assertions.isInstanceOf
 import assertk.assertions.isNotEmpty
 import assertk.fail
 import com.github.jengelman.gradle.plugins.shadow.ShadowJavaPlugin.Companion.SHADOW_JAR_TASK_NAME
+import com.github.jengelman.gradle.plugins.shadow.internal.mainClassAttributeKey
 import com.github.jengelman.gradle.plugins.shadow.tasks.ShadowCopyAction.Companion.CONSTANT_TIME_FOR_ZIP_ENTRIES
 import com.github.jengelman.gradle.plugins.shadow.util.Issue
 import com.github.jengelman.gradle.plugins.shadow.util.containsOnly
+import com.github.jengelman.gradle.plugins.shadow.util.runProcess
 import java.net.URLClassLoader
 import kotlin.io.path.appendText
 import kotlin.io.path.writeText
@@ -581,6 +583,51 @@ class RelocationTest : BasePluginTest() {
     }
   }
 
+  @ParameterizedTest
+  @ValueSource(booleans = [false, true])
+  fun canDisableRelocateStringConstants(skipStringLiteral: Boolean) {
+    writeClass {
+      """
+        package my;
+        public class Main {
+          public static final String junit = "junit.framework.Test";
+          public static void main(String[] args) {
+            System.out.println(getValue() + junit);
+          }
+          // Use this method to force the compiler to not inline the string literal.
+          private static String getValue() { return "the value is "; }
+        }
+      """.trimIndent()
+    }
+    projectScriptPath.appendText(
+      """
+        $shadowJar {
+          manifest {
+            attributes '$mainClassAttributeKey': 'my.Main'
+          }
+          relocate('junit', 'foo.junit') {
+            skipStringLiteral = $skipStringLiteral
+          }
+        }
+      """.trimIndent(),
+    )
+
+    run(shadowJarTask) {
+      it.withDebug(true)
+    }
+
+    val pathString = outputShadowJar.use { it.toString() }
+    val result = runProcess("java", "-jar", pathString)
+
+    assertThat(result).contains(
+      if (skipStringLiteral) {
+        "the value is junit.framework.Test"
+      } else {
+        "the value is foo.junit.framework.Test"
+      },
+    )
+  }
+
   private companion object {
     @JvmStatic
     fun prefixProvider() = listOf(

src/main/kotlin/com/github/jengelman/gradle/plugins/shadow/internal/RelocatorRemapper.kt

@@ -42,7 +42,7 @@ internal class RelocatorRemapper(
     }
 
     for (relocator in relocators) {
-      if (mapLiterals && relocator.isSkipStringLiteral) {
+      if (mapLiterals && relocator.skipStringLiteral) {
         return name
       } else if (relocator.canRelocateClass(newName)) {
         return prefix + relocator.relocateClass(newName) + suffix

src/main/kotlin/com/github/jengelman/gradle/plugins/shadow/relocation/Relocator.kt

@@ -21,7 +21,7 @@ public interface Relocator {
   public fun applyToSourceContent(sourceContent: String): String
 
   @get:Internal
-  public val isSkipStringLiteral: Boolean
+  public val skipStringLiteral: Boolean
 
   public companion object {
     public val ROLE: String = Relocator::class.java.name

src/main/kotlin/com/github/jengelman/gradle/plugins/shadow/relocation/SimpleRelocator.kt

@@ -19,7 +19,7 @@ public open class SimpleRelocator @JvmOverloads constructor(
   includes: List<String>? = null,
   excludes: List<String>? = null,
   private val rawString: Boolean = false,
-  @Input override var isSkipStringLiteral: Boolean = true,
+  @get:Input override var skipStringLiteral: Boolean = false,
 ) : Relocator {
   private val pattern: String
   private val pathPattern: String
@@ -138,7 +138,7 @@ public open class SimpleRelocator @JvmOverloads constructor(
     if (this === other) return true
     if (other !is SimpleRelocator) return false
     return rawString == other.rawString &&
-      isSkipStringLiteral == other.isSkipStringLiteral &&
+      skipStringLiteral == other.skipStringLiteral &&
       pattern == other.pattern &&
       pathPattern == other.pathPattern &&
       shadedPattern == other.shadedPattern &&
@@ -151,7 +151,7 @@ public open class SimpleRelocator @JvmOverloads constructor(
 
   override fun hashCode(): Int {
     var result = rawString.hashCode()
-    result = 31 * result + isSkipStringLiteral.hashCode()
+    result = 31 * result + skipStringLiteral.hashCode()
     result = 31 * result + pattern.hashCode()
     result = 31 * result + pathPattern.hashCode()
     result = 31 * result + shadedPattern.hashCode()