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 @@ + + + + 4.0.0 + org.apache.maven.plugins + mjar260-invalid-automatic-module-name + MJAR-260-invalid-automatic-module-name + jar + 1.0-SNAPSHOT + + jar plugin it + + + + + org.apache.maven.plugins + maven-jar-plugin + @project.version@ + + + + in-valid.name.with.new.keyword + + + + + + + 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 @@ + + + + 4.0.0 + org.apache.maven.plugins + mjar260-valid-automatic-module-name + MJAR-260-valid-automatic-module-name + jar + 1.0-SNAPSHOT + + jar plugin it + + + + + org.apache.maven.plugins + maven-jar-plugin + @project.version@ + + + + valid.automatic.module.name + + + + + + + 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.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 File createArchive() 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 @@ private String[] getExcludes() } 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..42a96df --- /dev/null +++ b/src/test/java/org/apache/maven/plugins/jar/AbstractJarMojoTest.java @@ -0,0 +1,56 @@ +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( "dash-is-invalid" ) ); + assertFalse( AbstractJarMojo.isValidModuleName( "plus+is+invalid" ) ); + assertFalse( AbstractJarMojo.isValidModuleName( "colon:is:invalid" ) ); + assertFalse( AbstractJarMojo.isValidModuleName( "new.class" ) ); + assertFalse( AbstractJarMojo.isValidModuleName( "123.at.start.is.invalid" ) ); + assertFalse( AbstractJarMojo.isValidModuleName( "digit.at.123start.is.invalid" ) ); + } + + @Test + public void testValidModuleNames() + { + assertTrue( AbstractJarMojo.isValidModuleName( "a" ) ); + assertTrue( AbstractJarMojo.isValidModuleName( "a.b" ) ); + assertTrue( AbstractJarMojo.isValidModuleName( "a_b" ) ); + assertTrue( AbstractJarMojo.isValidModuleName( "trailing0.digits123.are456.ok789" ) ); + assertTrue( AbstractJarMojo.isValidModuleName( "UTF8.chars.are.okay.äëïöüẍ" ) ); + assertTrue( AbstractJarMojo.isValidModuleName( "ℤ€ℕ" ) ); + } + +}