You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by ol...@apache.org on 2022/02/22 06:48:08 UTC
[maven-compiler-plugin] branch master updated: [MCOMPILER-485] Fixes internal string format in generated package-info.class (#95)
This is an automated email from the ASF dual-hosted git repository.
olamy pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/maven-compiler-plugin.git
The following commit(s) were added to refs/heads/master by this push:
new fa80028 [MCOMPILER-485] Fixes internal string format in generated package-info.class (#95)
fa80028 is described below
commit fa80028166ffde859b1a1e20547701a9bed34d54
Author: Daniel Widdis <wi...@gmail.com>
AuthorDate: Tue Feb 22 00:48:04 2022 -0600
[MCOMPILER-485] Fixes internal string format in generated package-info.class (#95)
* [MCOMPILER-485] Add failing integration test for class file contents
The internal package string in the class file should contain a forward
slash
* [MCOMPILER-485] Always use forward slash for internal package name
Per JLS 4.2.1 if the file separator character is not a forward slash,
replace it
* [MCOMPILER-485] Call ClassWriter#visit before ClassWriter#visitSource
Javadocs for org.objectweb.asm.ClassVisitor specify "The methods of this
class must be called in the following order: visit [ visitSource ] ..."
---
src/it/MCOMPILER-485/invoker.properties | 19 ++++++++++
src/it/MCOMPILER-485/pom.xml | 44 ++++++++++++++++++++++
.../src/main/java/dummy/HelloWorld.java | 28 ++++++++++++++
.../src/main/java/dummy/package-info.java | 23 +++++++++++
src/it/MCOMPILER-485/verify.groovy | 24 ++++++++++++
.../plugin/compiler/AbstractCompilerMojo.java | 10 +++--
6 files changed, 145 insertions(+), 3 deletions(-)
diff --git a/src/it/MCOMPILER-485/invoker.properties b/src/it/MCOMPILER-485/invoker.properties
new file mode 100644
index 0000000..8595721
--- /dev/null
+++ b/src/it/MCOMPILER-485/invoker.properties
@@ -0,0 +1,19 @@
+# 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.goals = clean compile
+invoker.buildResult = success
diff --git a/src/it/MCOMPILER-485/pom.xml b/src/it/MCOMPILER-485/pom.xml
new file mode 100644
index 0000000..bc6f4f2
--- /dev/null
+++ b/src/it/MCOMPILER-485/pom.xml
@@ -0,0 +1,44 @@
+<!--
+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/xsd/maven-4.0.0.xsd">
+
+ <modelVersion>4.0.0</modelVersion>
+
+ <groupId>blah</groupId>
+ <artifactId>blah</artifactId>
+ <version>1.0</version>
+ <packaging>jar</packaging>
+
+ <properties>
+ <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
+ </properties>
+ <build>
+ <plugins>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-compiler-plugin</artifactId>
+ <version>@pom.version@</version>
+ </plugin>
+ </plugins>
+ </build>
+</project>
diff --git a/src/it/MCOMPILER-485/src/main/java/dummy/HelloWorld.java b/src/it/MCOMPILER-485/src/main/java/dummy/HelloWorld.java
new file mode 100644
index 0000000..cda1006
--- /dev/null
+++ b/src/it/MCOMPILER-485/src/main/java/dummy/HelloWorld.java
@@ -0,0 +1,28 @@
+package dummy;
+
+/*
+ * 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.
+ */
+
+
+public class HelloWorld
+{
+ public static void main(String[] argv) {
+ System.out.println("Hello World");
+ }
+}
diff --git a/src/it/MCOMPILER-485/src/main/java/dummy/package-info.java b/src/it/MCOMPILER-485/src/main/java/dummy/package-info.java
new file mode 100644
index 0000000..ed72542
--- /dev/null
+++ b/src/it/MCOMPILER-485/src/main/java/dummy/package-info.java
@@ -0,0 +1,23 @@
+/*
+ * 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.
+ */
+
+/**
+ * This is the package javadoc
+ */
+package dummy;
\ No newline at end of file
diff --git a/src/it/MCOMPILER-485/verify.groovy b/src/it/MCOMPILER-485/verify.groovy
new file mode 100644
index 0000000..2384fec
--- /dev/null
+++ b/src/it/MCOMPILER-485/verify.groovy
@@ -0,0 +1,24 @@
+
+/*
+ * 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.
+ */
+def packageInfoClassFile = new File( basedir, 'target/classes/dummy/package-info.class' )
+def packageInfoBytes = packageInfoClassFile.bytes
+def packageInfoHex = packageInfoBytes.encodeHex().toString()
+// "dummy/package-info" hex encoded
+assert packageInfoHex.contains( '64756d6d792f7061636b6167652d696e666f' )
diff --git a/src/main/java/org/apache/maven/plugin/compiler/AbstractCompilerMojo.java b/src/main/java/org/apache/maven/plugin/compiler/AbstractCompilerMojo.java
index a027e55..915d39f 100644
--- a/src/main/java/org/apache/maven/plugin/compiler/AbstractCompilerMojo.java
+++ b/src/main/java/org/apache/maven/plugin/compiler/AbstractCompilerMojo.java
@@ -1363,12 +1363,16 @@ public abstract class AbstractCompilerMojo
private byte[] generatePackage( CompilerConfiguration compilerConfiguration, String javaFile )
{
int version = getOpcode( compilerConfiguration );
+ String internalPackageName = javaFile.substring( 0, javaFile.length() - ".java".length() );
+ if ( File.separatorChar != '/' )
+ {
+ internalPackageName = internalPackageName.replace( File.separatorChar, '/' );
+ }
ClassWriter cw = new ClassWriter( 0 );
- cw.visitSource( "package-info.java", null );
cw.visit( version,
Opcodes.ACC_SYNTHETIC | Opcodes.ACC_ABSTRACT | Opcodes.ACC_INTERFACE,
- javaFile.substring( 0, javaFile.length() - ".java".length() ),
- null, "java/lang/Object", null );
+ internalPackageName, null, "java/lang/Object", null );
+ cw.visitSource( "package-info.java", null );
return cw.toByteArray();
}