Skip to content

Commit

Permalink
[MJAR-260] Fail on invalid automatic module name
Browse files Browse the repository at this point in the history
  • Loading branch information
sormuras committed Nov 16, 2018
1 parent 58a570a commit 16c0d21
Show file tree
Hide file tree
Showing 9 changed files with 362 additions and 0 deletions.
18 changes: 18 additions & 0 deletions 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
46 changes: 46 additions & 0 deletions 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>
@@ -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!" );
}
}
52 changes: 52 additions & 0 deletions 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;
46 changes: 46 additions & 0 deletions 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>
@@ -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!" );
}
}
52 changes: 52 additions & 0 deletions 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;
20 changes: 20 additions & 0 deletions src/main/java/org/apache/maven/plugins/jar/AbstractJarMojo.java
Expand Up @@ -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.
Expand Down Expand Up @@ -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 )
Expand Down Expand Up @@ -313,4 +328,9 @@ private String[] getExcludes()
}
return DEFAULT_EXCLUDES;
}

static boolean isValidModuleName( String name )
{
return SourceVersion.isName( name );
}
}
@@ -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( "ℤ€ℕ" ) );
}

}

0 comments on commit 16c0d21

Please sign in to comment.