This is an automated email from the ASF dual-hosted git repository.
sor pushed a commit to branch MJAR-260-Automatic-Module-Name
in repository https://gitbox.apache.org/repos/asf/maven-jar-plugin.git
commit 6cd74ebb0e057d663a546308a9397a9393a2c3cd
Author: Christian Stein <sormu...@gmail.com>
AuthorDate: Fri Nov 16 13:12:56 2018 +0100
[MJAR-260] Fail on invalid automatic module name
Addresses https://issues.apache.org/jira/browse/MJAR-260
---
.../invoker.properties | 18 ++++++++
.../MJAR-260-invalid-automatic-module-name/pom.xml | 46 +++++++++++++++++++
.../src/main/java/myproject/HelloWorld.java | 36 +++++++++++++++
.../verify.bsh | 52 ++++++++++++++++++++++
.../MJAR-260-valid-automatic-module-name/pom.xml | 46 +++++++++++++++++++
.../src/main/java/myproject/HelloWorld.java | 36 +++++++++++++++
.../verify.bsh | 52 ++++++++++++++++++++++
.../apache/maven/plugins/jar/AbstractJarMojo.java | 20 +++++++++
.../maven/plugins/jar/AbstractJarMojoTest.java | 51 +++++++++++++++++++++
9 files changed, 357 insertions(+)
diff --git a/src/it/MJAR-260-invalid-automatic-module-name/invoker.properties
b/src/it/MJAR-260-invalid-automatic-module-name/invoker.properties
new file mode 100644
index 0000000..4789d91
--- /dev/null
+++ b/src/it/MJAR-260-invalid-automatic-module-name/invoker.properties
@@ -0,0 +1,18 @@
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements. See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership. The ASF licenses this file
+# to you 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.
+
+invoker.buildResult=failure
diff --git a/src/it/MJAR-260-invalid-automatic-module-name/pom.xml
b/src/it/MJAR-260-invalid-automatic-module-name/pom.xml
new file mode 100644
index 0000000..4046808
--- /dev/null
+++ b/src/it/MJAR-260-invalid-automatic-module-name/pom.xml
@@ -0,0 +1,46 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you 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.
+-->
+<project xmlns="http://maven.apache.org/POM/4.0.0";
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance";
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0
http://maven.apache.org/maven-v4_0_0.xsd";>
+ <modelVersion>4.0.0</modelVersion>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>mjar260-invalid-automatic-module-name</artifactId>
+ <name>MJAR-260-invalid-automatic-module-name</name>
+ <packaging>jar</packaging>
+ <version>1.0-SNAPSHOT</version>
+ <organization>
+ <name>jar plugin it</name>
+ </organization>
+ <build>
+ <plugins>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-jar-plugin</artifactId>
+ <version>@project.version@</version>
+ <configuration>
+ <archive>
+ <manifestEntries>
+
<Automatic-Module-Name>in-valid.name.with.new.keyword</Automatic-Module-Name>
+ </manifestEntries>
+ </archive>
+ </configuration>
+ </plugin>
+ </plugins>
+ </build>
+</project>
diff --git
a/src/it/MJAR-260-invalid-automatic-module-name/src/main/java/myproject/HelloWorld.java
b/src/it/MJAR-260-invalid-automatic-module-name/src/main/java/myproject/HelloWorld.java
new file mode 100644
index 0000000..fd0ad83
--- /dev/null
+++
b/src/it/MJAR-260-invalid-automatic-module-name/src/main/java/myproject/HelloWorld.java
@@ -0,0 +1,36 @@
+package myproject;
+
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you 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.
+ */
+
+/**
+ * The classic Hello World App.
+ */
+public class HelloWorld {
+
+ /**
+ * Main method.
+ *
+ * @param args Not used
+ */
+ public static void main( String[] args )
+ {
+ System.out.println( "Hi!" );
+ }
+}
\ No newline at end of file
diff --git a/src/it/MJAR-260-invalid-automatic-module-name/verify.bsh
b/src/it/MJAR-260-invalid-automatic-module-name/verify.bsh
new file mode 100644
index 0000000..7bdbe55
--- /dev/null
+++ b/src/it/MJAR-260-invalid-automatic-module-name/verify.bsh
@@ -0,0 +1,52 @@
+
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you 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.
+ */
+
+import java.io.*;
+import java.util.*;
+import java.util.jar.*;
+import org.codehaus.plexus.util.*;
+
+boolean result = true;
+
+try
+{
+ File target = new File( basedir, "target" );
+ if ( !target.exists() || !target.isDirectory() )
+ {
+ System.err.println( "target file is missing or not a directory." );
+ return false;
+ }
+
+ File artifact = new File( target,
"mjar260-invalid-automatic-module-name-1.0-SNAPSHOT.jar" );
+ if ( !artifact.exists() || artifact.isDirectory() )
+ {
+ System.err.println( "artifact file is missing or a directory." );
+ return false;
+ }
+
+
+}
+catch( Throwable e )
+{
+ e.printStackTrace();
+ result = false;
+}
+
+return result;
diff --git a/src/it/MJAR-260-valid-automatic-module-name/pom.xml
b/src/it/MJAR-260-valid-automatic-module-name/pom.xml
new file mode 100644
index 0000000..ede7f61
--- /dev/null
+++ b/src/it/MJAR-260-valid-automatic-module-name/pom.xml
@@ -0,0 +1,46 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you 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.
+-->
+<project xmlns="http://maven.apache.org/POM/4.0.0";
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance";
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0
http://maven.apache.org/maven-v4_0_0.xsd";>
+ <modelVersion>4.0.0</modelVersion>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>mjar260-valid-automatic-module-name</artifactId>
+ <name>MJAR-260-valid-automatic-module-name</name>
+ <packaging>jar</packaging>
+ <version>1.0-SNAPSHOT</version>
+ <organization>
+ <name>jar plugin it</name>
+ </organization>
+ <build>
+ <plugins>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-jar-plugin</artifactId>
+ <version>@project.version@</version>
+ <configuration>
+ <archive>
+ <manifestEntries>
+
<Automatic-Module-Name>valid.automatic.module.name</Automatic-Module-Name>
+ </manifestEntries>
+ </archive>
+ </configuration>
+ </plugin>
+ </plugins>
+ </build>
+</project>
diff --git
a/src/it/MJAR-260-valid-automatic-module-name/src/main/java/myproject/HelloWorld.java
b/src/it/MJAR-260-valid-automatic-module-name/src/main/java/myproject/HelloWorld.java
new file mode 100644
index 0000000..fd0ad83
--- /dev/null
+++
b/src/it/MJAR-260-valid-automatic-module-name/src/main/java/myproject/HelloWorld.java
@@ -0,0 +1,36 @@
+package myproject;
+
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you 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.
+ */
+
+/**
+ * The classic Hello World App.
+ */
+public class HelloWorld {
+
+ /**
+ * Main method.
+ *
+ * @param args Not used
+ */
+ public static void main( String[] args )
+ {
+ System.out.println( "Hi!" );
+ }
+}
\ No newline at end of file
diff --git a/src/it/MJAR-260-valid-automatic-module-name/verify.bsh
b/src/it/MJAR-260-valid-automatic-module-name/verify.bsh
new file mode 100644
index 0000000..86db5ed
--- /dev/null
+++ b/src/it/MJAR-260-valid-automatic-module-name/verify.bsh
@@ -0,0 +1,52 @@
+
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you 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.
+ */
+
+import java.io.*;
+import java.util.*;
+import java.util.jar.*;
+import org.codehaus.plexus.util.*;
+
+boolean result = true;
+
+try
+{
+ File target = new File( basedir, "target" );
+ if ( !target.exists() || !target.isDirectory() )
+ {
+ System.err.println( "target file is missing or not a directory." );
+ return false;
+ }
+
+ File artifact = new File( target,
"mjar260-valid-automatic-module-name-1.0-SNAPSHOT.jar" );
+ if ( !artifact.exists() || artifact.isDirectory() )
+ {
+ System.err.println( "artifact file is missing or a directory." );
+ return false;
+ }
+
+
+}
+catch( Throwable e )
+{
+ e.printStackTrace();
+ result = false;
+}
+
+return result;
diff --git a/src/main/java/org/apache/maven/plugins/jar/AbstractJarMojo.java
b/src/main/java/org/apache/maven/plugins/jar/AbstractJarMojo.java
index a70591e..60eeec0 100644
--- a/src/main/java/org/apache/maven/plugins/jar/AbstractJarMojo.java
+++ b/src/main/java/org/apache/maven/plugins/jar/AbstractJarMojo.java
@@ -31,7 +31,10 @@ import org.apache.maven.project.MavenProjectHelper;
import org.codehaus.plexus.archiver.Archiver;
import org.codehaus.plexus.archiver.jar.JarArchiver;
+import javax.lang.model.SourceVersion;
import java.io.File;
+import java.util.jar.Attributes;
+import java.util.jar.JarFile;
/**
* Base class for creating a jar from project classes.
@@ -223,6 +226,18 @@ public abstract class AbstractJarMojo
archiver.createArchive( session, project, archive );
+ JarFile javaUtilJarFile = new JarFile( jarFile );
+ Attributes mainAttributes =
javaUtilJarFile.getManifest().getMainAttributes();
+ String automaticModuleName = mainAttributes.getValue(
"Automatic-Module-Name" );
+ if ( automaticModuleName != null )
+ {
+ if ( !isValidModuleName( automaticModuleName ) )
+ {
+ throw new MojoExecutionException( "Invalid automatic
module name: '"
+ + automaticModuleName + "'" );
+ }
+ }
+
return jarFile;
}
catch ( Exception e )
@@ -313,4 +328,9 @@ public abstract class AbstractJarMojo
}
return DEFAULT_EXCLUDES;
}
+
+ static boolean isValidModuleName( String name )
+ {
+ return SourceVersion.isName( name );
+ }
}
diff --git
a/src/test/java/org/apache/maven/plugins/jar/AbstractJarMojoTest.java
b/src/test/java/org/apache/maven/plugins/jar/AbstractJarMojoTest.java
new file mode 100644
index 0000000..10a48ca
--- /dev/null
+++ b/src/test/java/org/apache/maven/plugins/jar/AbstractJarMojoTest.java
@@ -0,0 +1,51 @@
+package org.apache.maven.plugins.jar;
+
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you 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.
+ */
+
+import org.junit.Test;
+
+import static org.junit.Assert.assertFalse;
+import static org.junit.Assert.assertTrue;
+
+/**
+ * Test for {@link AbstractJarMojo}
+ */
+public class AbstractJarMojoTest
+{
+ @Test
+ public void testInvalidModuleNames()
+ {
+ assertFalse( AbstractJarMojo.isValidModuleName( "" ) );
+ assertFalse( AbstractJarMojo.isValidModuleName( "." ) );
+ assertFalse( AbstractJarMojo.isValidModuleName( "_" ) );
+ assertFalse( AbstractJarMojo.isValidModuleName( "dash-is-invalid" ) );
+ assertFalse( AbstractJarMojo.isValidModuleName( "new.class" ) );
+
+ }
+
+ @Test
+ public void testValidModuleNames()
+ {
+ assertTrue( AbstractJarMojo.isValidModuleName( "a" ) );
+ assertTrue( AbstractJarMojo.isValidModuleName( "a.b" ) );
+ assertTrue( AbstractJarMojo.isValidModuleName( "a_b" ) );
+ }
+
+}
