Support 'require /*runtime*/' directives for runtimeOnly dependencies

jjohannes · jjohannes · commit 2c88fe1c136d · 2022-11-01T10:34:54.000+01:00
diff --git a/src/main/java/org/gradlex/javamodule/dependencies/JavaModuleDependenciesPlugin.java b/src/main/java/org/gradlex/javamodule/dependencies/JavaModuleDependenciesPlugin.java
@@ -83,6 +83,7 @@ private void setupForJavaProject(Project project, JavaModuleDependenciesExtensio
             process(ModuleInfo.Directive.REQUIRES_STATIC, sourceSet.getCompileOnlyConfigurationName(), sourceSet, project, javaModuleDependencies);
             process(ModuleInfo.Directive.REQUIRES_TRANSITIVE, sourceSet.getApiConfigurationName(), sourceSet, project, javaModuleDependencies);
             process(ModuleInfo.Directive.REQUIRES_STATIC_TRANSITIVE, sourceSet.getCompileOnlyApiConfigurationName(), sourceSet, project, javaModuleDependencies);
+            process(ModuleInfo.Directive.REQUIRES_RUNTIME, sourceSet.getRuntimeOnlyConfigurationName(), sourceSet, project, javaModuleDependencies);
         });
         setupReportTasks(project, javaModuleDependencies);
         setupMigrationTasks(project, javaModuleDependencies);
@@ -136,6 +137,7 @@ private void setupMigrationTasks(Project project, JavaModuleDependenciesExtensio
                 t.getImplementationDependencies().convention(declaredDependencies(project, sourceSet.getImplementationConfigurationName()));
                 t.getCompileOnlyApiDependencies().convention(declaredDependencies(project, sourceSet.getCompileOnlyApiConfigurationName()));
                 t.getCompileOnlyDependencies().convention(declaredDependencies(project, sourceSet.getCompileOnlyConfigurationName()));
+                t.getRuntimeOnlyDependencies().convention(declaredDependencies(project, sourceSet.getRuntimeOnlyConfigurationName()));
 
                 t.getModuleInfoFile().convention(project.getLayout().file(project.provider(() ->
                         new File(sourceSet.getJava().getSrcDirs().iterator().next(), "module-info.java"))));
diff --git a/src/main/java/org/gradlex/javamodule/dependencies/internal/utils/ModuleInfo.java b/src/main/java/org/gradlex/javamodule/dependencies/internal/utils/ModuleInfo.java
@@ -30,18 +30,23 @@ public enum Directive {
         REQUIRES,
         REQUIRES_TRANSITIVE,
         REQUIRES_STATIC,
-        REQUIRES_STATIC_TRANSITIVE;
+        REQUIRES_STATIC_TRANSITIVE,
+        REQUIRES_RUNTIME;
 
         public String literal() {
-            return toString().toLowerCase().replace("_", " ");
+            return toString().toLowerCase().replace("_", " ")
+                    .replace("runtime", RUNTIME_KEYWORD);
         }
     }
 
+    public static final String RUNTIME_KEYWORD = "/*runtime*/";
+
     private String moduleName;
     private final List<String> requires = new ArrayList<>();
     private final List<String> requiresTransitive = new ArrayList<>();
     private final List<String> requiresStatic = new ArrayList<>();
     private final List<String> requiresStaticTransitive = new ArrayList<>();
+    private final List<String> requiresRuntime = new ArrayList<>();
 
     public ModuleInfo(String moduleInfoFileContent) {
         boolean insideComment = false;
@@ -63,6 +68,9 @@ public List<String> get(Directive directive) {
         if (directive == Directive.REQUIRES_STATIC_TRANSITIVE) {
             return requiresStaticTransitive;
         }
+        if (directive == Directive.REQUIRES_RUNTIME) {
+            return requiresRuntime;
+        }
         return Collections.emptyList();
     }
 
@@ -91,9 +99,10 @@ private boolean parse(String moduleLine, boolean insideComment) {
         }
 
         List<String> tokens = Arrays.asList(moduleLine
-                .replace(";","")
-                .replace("{","")
-                .replaceAll("/\\*.*?\\*/"," ")
+                .replace(";", "")
+                .replace("{", "")
+                .replace(RUNTIME_KEYWORD, "runtime")
+                .replaceAll("/\\*.*?\\*/", " ")
                 .trim().split("\\s+"));
         int singleLineCommentStartIndex = tokens.indexOf("//");
         if (singleLineCommentStartIndex >= 0) {
@@ -110,6 +119,8 @@ private boolean parse(String moduleLine, boolean insideComment) {
                 requiresTransitive.add(tokens.get(2));
             } else if (tokens.size() > 2 && tokens.contains("static")) {
                 requiresStatic.add(tokens.get(2));
+            } else if (tokens.size() > 2 && tokens.contains("runtime")) {
+                requiresRuntime.add(tokens.get(2));
             } else {
                 requires.add(tokens.get(1));
             }
diff --git a/src/main/java/org/gradlex/javamodule/dependencies/tasks/ModuleInfoGeneration.java b/src/main/java/org/gradlex/javamodule/dependencies/tasks/ModuleInfoGeneration.java
@@ -53,6 +53,9 @@ public abstract class ModuleInfoGeneration extends DefaultTask {
     @Input
     public abstract ListProperty<String> getCompileOnlyDependencies();
 
+    @Input
+    public abstract ListProperty<String> getRuntimeOnlyDependencies();
+
     @Input
     public abstract MapProperty<String, String> getModuleNameToGA();
 
@@ -86,6 +89,10 @@ public void generate() throws IOException {
             content.addAll(dependenciesToModuleDirectives(getCompileOnlyDependencies().get(), REQUIRES_STATIC));
             content.add("");
         }
+        if (!getRuntimeOnlyDependencies().get().isEmpty()) {
+            content.addAll(dependenciesToModuleDirectives(getRuntimeOnlyDependencies().get(), REQUIRES_RUNTIME));
+            content.add("");
+        }
         content.add("}");
 
         Files.write(moduleInfo.toPath(), content);
diff --git a/src/test/groovy/org/gradlex/javamodule/dependencies/test/ModuleInfoParseTest.groovy b/src/test/groovy/org/gradlex/javamodule/dependencies/test/ModuleInfoParseTest.groovy
@@ -4,6 +4,7 @@ import org.gradlex.javamodule.dependencies.internal.utils.ModuleInfo
 import spock.lang.Specification
 
 import static org.gradlex.javamodule.dependencies.internal.utils.ModuleInfo.Directive.REQUIRES
+import static org.gradlex.javamodule.dependencies.internal.utils.ModuleInfo.Directive.REQUIRES_RUNTIME
 import static org.gradlex.javamodule.dependencies.internal.utils.ModuleInfo.Directive.REQUIRES_TRANSITIVE
 import static org.gradlex.javamodule.dependencies.internal.utils.ModuleInfo.Directive.REQUIRES_STATIC
 import static org.gradlex.javamodule.dependencies.internal.utils.ModuleInfo.Directive.REQUIRES_STATIC_TRANSITIVE
@@ -25,6 +26,7 @@ class ModuleInfoParseTest extends Specification {
         moduleInfo.get(REQUIRES_TRANSITIVE) == ["foo.bar.la"]
         moduleInfo.get(REQUIRES_STATIC) == []
         moduleInfo.get(REQUIRES_STATIC_TRANSITIVE) == []
+        moduleInfo.get(REQUIRES_RUNTIME) == []
     }
 
     def "ignores single line comments late in line"() {
@@ -41,6 +43,7 @@ class ModuleInfoParseTest extends Specification {
         moduleInfo.get(REQUIRES_TRANSITIVE) == ["foo.bar.la"]
         moduleInfo.get(REQUIRES_STATIC) == []
         moduleInfo.get(REQUIRES_STATIC_TRANSITIVE) == []
+        moduleInfo.get(REQUIRES_RUNTIME) == []
     }
 
     def "ignores multi line comments"() {
@@ -59,6 +62,7 @@ class ModuleInfoParseTest extends Specification {
         moduleInfo.get(REQUIRES_TRANSITIVE) == []
         moduleInfo.get(REQUIRES_STATIC) == ["foo.bar.la"]
         moduleInfo.get(REQUIRES_STATIC_TRANSITIVE) == []
+        moduleInfo.get(REQUIRES_RUNTIME) == []
     }
 
     def "ignores multi line comments between keywords"() {
@@ -78,6 +82,23 @@ class ModuleInfoParseTest extends Specification {
         moduleInfo.get(REQUIRES_TRANSITIVE) == ["foo.bar.la"]
         moduleInfo.get(REQUIRES_STATIC) == ["foo.bar.lo"]
         moduleInfo.get(REQUIRES_STATIC_TRANSITIVE) == []
+        moduleInfo.get(REQUIRES_RUNTIME) == []
+    }
+
+    def "supports runtime dependencies through special keyword"() {
+        given:
+        def moduleInfo = new ModuleInfo('''
+            module some.thing {
+                requires /*runtime*/ foo.bar.lo;
+            }
+        ''')
+
+        expect:
+        moduleInfo.get(REQUIRES) == []
+        moduleInfo.get(REQUIRES_TRANSITIVE) == []
+        moduleInfo.get(REQUIRES_STATIC) == []
+        moduleInfo.get(REQUIRES_STATIC_TRANSITIVE) == []
+        moduleInfo.get(REQUIRES_RUNTIME) == ["foo.bar.lo"]
     }
 
 }
diff --git a/src/test/groovy/org/gradlex/javamodule/dependencies/test/RequiresRuntimeTest.groovy b/src/test/groovy/org/gradlex/javamodule/dependencies/test/RequiresRuntimeTest.groovy
@@ -0,0 +1,80 @@
+package org.gradlex.javamodule.dependencies.test
+
+import org.gradlex.javamodule.dependencies.test.fixture.GradleBuild
+import spock.lang.Specification
+
+class RequiresRuntimeTest extends Specification {
+
+    @Delegate
+    GradleBuild build = new GradleBuild()
+
+    def "can define runtime only dependencies in module-info"() {
+        given:
+        appBuildFile << '''
+            dependencies.constraints {
+                javaModuleDependencies {
+                    implementation(gav("org.slf4j", "2.0.3"))
+                    implementation(gav("org.slf4j.simple", "2.0.3"))
+                }
+            }
+        '''
+        appModuleInfoFile << '''
+            module org.gradlex.test.app {
+                requires org.slf4j;
+                requires /*runtime*/ org.slf4j.simple;
+            }
+        '''
+
+        when:
+        def rt = printRuntimeJars()
+
+        then:
+        rt.output.contains('[slf4j-simple-2.0.3.jar, slf4j-api-2.0.3.jar]')
+
+        when:
+        def cp = printCompileJars()
+
+        then:
+        cp.output.contains('[slf4j-api-2.0.3.jar]')
+    }
+
+    def "compiles with runtime only dependencies in module-info"() {
+        given:
+        appBuildFile << '''
+            dependencies.constraints {
+                javaModuleDependencies {
+                    implementation(gav("org.slf4j", "2.0.3"))
+                    implementation(gav("org.slf4j.simple", "2.0.3"))
+                }
+            }
+        '''
+        appModuleInfoFile << '''
+            module org.gradlex.test.app {
+                requires org.slf4j;
+                requires /*runtime*/ org.slf4j.simple;
+                
+                exports org.gradlex.test.app;
+            }
+        '''
+        file("app/src/main/java/org/gradlex/test/app/Main.java") << """
+            package org.gradlex.test.app;
+            
+            import org.slf4j.Logger;
+            import org.slf4j.LoggerFactory;
+            
+            public class Main {
+                private static final Logger LOGGER = LoggerFactory.getLogger(Main.class);
+                
+                public static void main(String[] args) {
+                    LOGGER.info("Running application...");
+                }
+            }
+        """
+
+        when:
+        def result = run()
+
+        then:
+        result.output.contains("[main] INFO org.gradlex.test.app.Main - Running application...")
+    }
+}
