Validation coordinates and module names

Resolves #46

Author: jjohannes

CHANGELOG.md

@@ -2,6 +2,7 @@
 
 ## Version 1.4
 * [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!)
 * [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!)

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

@@ -0,0 +1,19 @@
+package org.gradlex.javamodule.moduleinfo;
+
+class IdValidator {
+    static private final String COORDINATES_PATTERN = "^[a-zA-Z0-9._-]+:[a-zA-Z0-9._-]+$";
+    static private final String FILE_NAME_PATTERN = "^[a-zA-Z0-9._-]+\\.(jar|zip)$";
+    static private final String MODULE_NAME_PATTERN = "^[a-z][a-z0-9_]*(\\.[a-z0-9_]+)*$";
+
+    static void validateIdentifier(String identifier) {
+        if (!identifier.matches(COORDINATES_PATTERN) && !identifier.matches(FILE_NAME_PATTERN)) {
+            throw new RuntimeException("'" + identifier + "' are not valid coordinates (group:name) / is not a valid file name (name-1.0.jar)");
+        }
+    }
+
+    static void validateModuleName(String moduleName) {
+        if (!moduleName.matches(MODULE_NAME_PATTERN)) {
+            throw new RuntimeException("'" + moduleName + "' is not a valid Java Module name");
+        }
+    }
+}

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

@@ -23,17 +23,22 @@
 import java.util.ArrayList;
 import java.util.List;
 
+import static org.gradlex.javamodule.moduleinfo.IdValidator.validateIdentifier;
+import static org.gradlex.javamodule.moduleinfo.IdValidator.validateModuleName;
+
 /**
  * Details that real Modules and Automatic-Module-Names share.
  */
 @SuppressWarnings("unused")
-abstract public class ModuleSpec implements Serializable {
+public abstract class ModuleSpec implements Serializable {
 
     private final String identifier;
     private final String moduleName;
     private final List<String> mergedJars = new ArrayList<>();
 
-    ModuleSpec(String identifier, String moduleName) {
+    protected ModuleSpec(String identifier, String moduleName) {
+        validateIdentifier(identifier);
+        validateModuleName(moduleName);
         this.identifier = identifier;
         this.moduleName = moduleName;
     }

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

@@ -0,0 +1,73 @@
+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 << '''
+            plugins {
+                id("application")
+                id("org.gradlex.extra-java-module-info")
+            }
+        '''
+    }
+
+    def "fails for wrong coordinates"() {
+        given:
+        buildFile << """                  
+            extraJavaModuleInfo {
+                module("commons-logging:commons-logging:2.0", "apache.commons.logging") {
+                    exportAllPackages()
+                }
+            }
+        """
+
+        expect:
+        def out = fail()
+        out.output.contains("'commons-logging:commons-logging:2.0' are not valid coordinates (group:name) / is not a valid file name (name-1.0.jar)")
+    }
+
+    def "fails for wrong file name"() {
+        given:
+        buildFile << """                  
+            dependencies {
+                implementation(${libs.commonsCollections})
+            }
+            
+            extraJavaModuleInfo {
+                module("/dummy/some/my.jar", "apache.commons.logging")
+            }
+        """
+
+        expect:
+        def out = fail()
+        out.output.contains("'/dummy/some/my.jar' are not valid coordinates (group:name) / is not a valid file name (name-1.0.jar)")
+    }
+
+    def "fails for wrong module name"() {
+        given:
+        buildFile << """                  
+            dependencies {
+                implementation(${libs.commonsCollections})
+            }
+            
+            extraJavaModuleInfo {
+                module("commons-logging:commons-logging", "apache.commons:logging")
+            }
+        """
+
+        expect:
+        def out = fail()
+        out.output.contains("'apache.commons:logging' is not a valid Java Module name")
+    }
+
+}