Allow opening individual packages in module descriptors

Resolves #30

Author: jjohannes

CHANGELOG.md

@@ -4,6 +4,7 @@
 * [New] Minimal Gradle version is now 6.8 for integration with recently added features like the Dependency Version Catalog
 * [New] [#46](https://github.com/gradlex-org/extra-java-module-info/issues/46) - Validation coordinates and module names
 * [New] [#41](https://github.com/gradlex-org/extra-java-module-info/issues/41) - Support version catalog accessors to express dependency coordinates (Thanks [Giuseppe Barbieri](https://github.com/elect86) for suggesting!)
+* [New] [#30](https://github.com/gradlex-org/extra-java-module-info/issues/30) - Add 'opens(...)' to module DSL (Thanks [Wexalian](https://github.com/Wexalian) for suggesting!)
 * [Fixed] [#47](https://github.com/gradlex-org/extra-java-module-info/issues/47) - requireAllDefinedDependencies() gives error when dependency only appears on runtime path (Thanks [Sola](https://github.com/unlimitedsola) for reporting!)
 * [Fixed] [#45](https://github.com/gradlex-org/extra-java-module-info/issues/45) - Sub-folders in 'META-INF/services' are not ignored (Thanks [Jonas Beyer](https://github.com/j-beyer) for reporting!)
 * [Fixed] [#44](https://github.com/gradlex-org/extra-java-module-info/issues/44) - Name resolution for jars with '-' character failing if Jars are taken from local .m2 repository (Thanks [Aidan Do](https://github.com/REslim30) for reporting!)

README.md

@@ -67,10 +67,13 @@ extraJavaModuleInfo {
         exports("org.apache.commons.beanutils")
         // exportAllPackages()
         
-        requires("org.apache.commons.logging")
+        requiresTransitive("org.apache.commons.logging")
         requires("java.sql")
         requires("java.desktop")
         
+        // closeModule()
+        // opens("org.apache.commons.beanutils")
+        
         // requiresTransitive(...)
         // requiresStatic(...)
         

src/main/java/org/gradlex/javamodule/moduleinfo/ExtraJavaModuleInfoPluginExtension.java

@@ -18,11 +18,13 @@
 
 import org.gradle.api.Action;
 import org.gradle.api.artifacts.MinimalExternalModuleDependency;
+import org.gradle.api.model.ObjectFactory;
 import org.gradle.api.provider.MapProperty;
 import org.gradle.api.provider.Property;
 import org.gradle.api.provider.Provider;
 
 import javax.annotation.Nullable;
+import javax.inject.Inject;
 
 /**
  * A data class to collect all the module information we want to add.
@@ -32,8 +34,11 @@
 @SuppressWarnings("unused")
 public abstract class ExtraJavaModuleInfoPluginExtension {
 
-    abstract public MapProperty<String, ModuleSpec> getModuleSpecs();
-    abstract public Property<Boolean> getFailOnMissingModuleInfo();
+    @Inject
+    protected abstract ObjectFactory getObjects();
+
+    public abstract MapProperty<String, ModuleSpec> getModuleSpecs();
+    public abstract Property<Boolean> getFailOnMissingModuleInfo();
 
     /**
      * Add full module information for a given Jar file.
@@ -108,7 +113,7 @@ public void module(Provider<MinimalExternalModuleDependency> alias, String modul
      * @param conf configure exported packages, dependencies and Jar merging, see {@link ModuleInfo}
      */
     public void module(String identifier, String moduleName, @Nullable String moduleVersion, @Nullable Action<? super ModuleInfo> conf) {
-        ModuleInfo moduleInfo = new ModuleInfo(identifier, moduleName, moduleVersion);
+        ModuleInfo moduleInfo = new ModuleInfo(identifier, moduleName, moduleVersion, getObjects());
         if (conf != null) {
             conf.execute(moduleInfo);
         }

src/main/java/org/gradlex/javamodule/moduleinfo/ExtraJavaModuleInfoTransform.java

@@ -73,7 +73,7 @@
  */
 @CacheableRule
 @NonNullApi
-abstract public class ExtraJavaModuleInfoTransform implements TransformAction<ExtraJavaModuleInfoTransform.Parameter> {
+public abstract class ExtraJavaModuleInfoTransform implements TransformAction<ExtraJavaModuleInfoTransform.Parameter> {
 
     private static final Pattern MODULE_INFO_CLASS_MRJAR_PATH = Pattern.compile("META-INF/versions/\\d+/module-info.class");
     private static final Pattern JAR_SIGNATURE_PATH = Pattern.compile("^META-INF/[^/]+\\.(SF|RSA|DSA|sf|rsa|dsa)$");
@@ -288,8 +288,9 @@ private List<String> extractImplementations(byte[] content) {
     private byte[] addModuleInfo(ModuleInfo moduleInfo, Map<String, List<String>> providers, @Nullable String version, Set<String> autoExportedPackages) {
         ClassWriter classWriter = new ClassWriter(0);
         classWriter.visit(Opcodes.V9, Opcodes.ACC_MODULE, "module-info", null, null, null);
+        int openModule = moduleInfo.openModule ? Opcodes.ACC_OPEN : 0;
         String moduleVersion = moduleInfo.getModuleVersion() == null ? version : moduleInfo.getModuleVersion();
-        ModuleVisitor moduleVisitor = classWriter.visitModule(moduleInfo.getModuleName(), Opcodes.ACC_OPEN, moduleVersion);
+        ModuleVisitor moduleVisitor = classWriter.visitModule(moduleInfo.getModuleName(), openModule, moduleVersion);
 
         for (String packageName : autoExportedPackages) {
             moduleVisitor.visitExport(packageName, 0);
@@ -298,6 +299,10 @@ private byte[] addModuleInfo(ModuleInfo moduleInfo, Map<String, List<String>> pr
             moduleVisitor.visitExport(packageName.replace('.', '/'), 0);
         }
 
+        for (String packageName : moduleInfo.opens) {
+            moduleVisitor.visitOpen(packageName.replace('.', '/'), 0);
+        }
+
         moduleVisitor.visitRequire("java.base", 0, null);
 
         if (moduleInfo.requireAllDefinedDependencies) {

src/main/java/org/gradlex/javamodule/moduleinfo/IdValidator.java

@@ -1,3 +1,19 @@
+/*
+ * Copyright 2022 the GradleX team.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
 package org.gradlex.javamodule.moduleinfo;
 
 class IdValidator {

src/main/java/org/gradlex/javamodule/moduleinfo/ModuleInfo.java

@@ -16,6 +16,8 @@
 
 package org.gradlex.javamodule.moduleinfo;
 
+import org.gradle.api.model.ObjectFactory;
+
 import java.util.LinkedHashSet;
 import java.util.Set;
 
@@ -27,7 +29,9 @@ public class ModuleInfo extends ModuleSpec {
 
     private final String moduleVersion;
 
+    boolean openModule = true;
     final Set<String> exports = new LinkedHashSet<>();
+    final Set<String> opens = new LinkedHashSet<>();
     final Set<String> requires = new LinkedHashSet<>();
     final Set<String> requiresTransitive = new LinkedHashSet<>();
     final Set<String> requiresStatic = new LinkedHashSet<>();
@@ -37,11 +41,28 @@ public class ModuleInfo extends ModuleSpec {
     boolean exportAllPackages;
     boolean requireAllDefinedDependencies;
 
-    ModuleInfo(String identifier, String moduleName, String moduleVersion) {
+    ModuleInfo(String identifier, String moduleName, String moduleVersion, ObjectFactory objectFactory) {
         super(identifier, moduleName);
         this.moduleVersion = moduleVersion;
     }
 
+    /**
+     * Should this be a 'module' instead of an 'open module'?
+     */
+    public void closeModule() {
+        openModule = false;
+    }
+
+    /**
+     * Calling this method at least once automatically makes this a "closed" module: 'module' instead of 'open module'.
+     *
+     * @param opens corresponds to the directive in a 'module-info.java' file
+     */
+    public void opens(String opens) {
+        closeModule();
+        addOrThrow(this.opens, opens);
+    }
+
     /**
      * @param exports corresponds to the directive in a 'module-info.java' file
      */

src/test/groovy/org/gradlex/javamodule/moduleinfo/test/IdValidationFunctionalTest.groovy

@@ -1,16 +1,13 @@
 package org.gradlex.javamodule.moduleinfo.test
 
 import org.gradlex.javamodule.moduleinfo.test.fixture.GradleBuild
-import org.gradlex.javamodule.moduleinfo.test.fixture.LegacyLibraries
 import spock.lang.Specification
 
 class IdValidationFunctionalTest extends Specification {
 
     @Delegate
     GradleBuild build = new GradleBuild()
 
-    LegacyLibraries libs = new LegacyLibraries(false)
-
     def setup() {
         settingsFile << 'rootProject.name = "test-project"'
         buildFile << '''
@@ -39,10 +36,6 @@ class IdValidationFunctionalTest extends Specification {
     def "fails for wrong file name"() {
         given:
         buildFile << """                  
-            dependencies {
-                implementation(${libs.commonsCollections})
-            }
-            
             extraJavaModuleInfo {
                 module("/dummy/some/my.jar", "apache.commons.logging")
             }
@@ -55,11 +48,7 @@ class IdValidationFunctionalTest extends Specification {
 
     def "fails for wrong module name"() {
         given:
-        buildFile << """                  
-            dependencies {
-                implementation(${libs.commonsCollections})
-            }
-            
+        buildFile << """            
             extraJavaModuleInfo {
                 module("commons-logging:commons-logging", "apache.commons:logging")
             }

src/test/groovy/org/gradlex/javamodule/moduleinfo/test/OpensFunctionalTest.groovy

@@ -0,0 +1,94 @@
+package org.gradlex.javamodule.moduleinfo.test
+
+import org.gradlex.javamodule.moduleinfo.test.fixture.GradleBuild
+import org.gradlex.javamodule.moduleinfo.test.fixture.LegacyLibraries
+import spock.lang.Specification
+
+class OpensFunctionalTest extends Specification {
+
+    @Delegate
+    GradleBuild build = new GradleBuild()
+
+    LegacyLibraries libs = new LegacyLibraries(false)
+
+    def setup() {
+        settingsFile << 'rootProject.name = "test-project"'
+        buildFile << '''
+            plugins {
+                id("application")
+                id("org.gradlex.extra-java-module-info")
+            }
+            application {
+                mainModule.set("org.gradle.sample.app")
+                mainClass.set("org.gradle.sample.app.Main")
+            }
+        '''
+        file("src/main/java/module-info.java") << """
+            module org.gradle.sample.app {
+                requires apache.commons.collections;
+            }
+        """
+        file("src/main/java/org/gradle/sample/app/Main.java") << """
+            package org.gradle.sample.app;
+            
+            public class Main {
+                public static void main(String[] args) throws ClassNotFoundException {
+                    Class.forName("org.apache.commons.collections.buffer.BlockingBuffer").getDeclaredMethods()[0].setAccessible(true);
+                    Class.forName("org.apache.commons.collections.bag.HashBag").getDeclaredMethods()[0].setAccessible(true);
+                }
+            }
+        """
+    }
+
+    def "a module is open by default"() {
+        given:
+        buildFile << """     
+            dependencies {
+                implementation("commons-collections:commons-collections:3.2.2")
+            }             
+            extraJavaModuleInfo {
+                module(${libs.commonsCollections}, "apache.commons.collections")
+            }
+        """
+
+        expect:
+        run()
+    }
+
+    def "a module can be closed"() {
+        given:
+        buildFile << """     
+            dependencies {
+                implementation("commons-collections:commons-collections:3.2.2")
+            }             
+            extraJavaModuleInfo {
+                module(${libs.commonsCollections}, "apache.commons.collections") {
+                    closeModule()
+                }
+            }
+        """
+
+        expect:
+        def out = failRun()
+        out.output.contains('module apache.commons.collections does not "exports org.apache.commons.collections.buffer" to module org.gradle.sample.app')
+    }
+
+    def "a module is closed once it has an open package"() {
+        given:
+
+        buildFile << """     
+            dependencies {
+                implementation("commons-collections:commons-collections:3.2.2")
+            }             
+            extraJavaModuleInfo {
+                module(${libs.commonsCollections}, "apache.commons.collections") {
+                    opens("org.apache.commons.collections.buffer")
+                }
+            }
+        """
+
+        expect:
+        def out = failRun()
+        out.output.contains('module apache.commons.collections does not "opens org.apache.commons.collections.bag" to module org.gradle.sample.app')
+    }
+}

src/test/groovy/org/gradlex/javamodule/moduleinfo/test/fixture/GradleBuild.groovy

@@ -34,6 +34,10 @@ class GradleBuild {
         runner('run').build()
     }
 
+    BuildResult failRun() {
+        runner('run').buildAndFail()
+    }
+
     BuildResult test() {
         runner('test').build()
     }