Merge pull request #308 from Ladicek/type-var-ref-reproducibility

make type variable reference serialization reproducible
smallrye · Apr 13, 2023 · 5c651d7 · 5c651d7
2 parents cdfb090 + 2f755e7
commit 5c651d7
Show file tree

Hide file tree

Showing 10 changed files with 92 additions and 20 deletions.
diff --git a/core/src/main/java/org/jboss/jandex/TypeVariableReference.java b/core/src/main/java/org/jboss/jandex/TypeVariableReference.java
@@ -146,15 +146,15 @@ public int hashCode() {
         return hash;
     }
 
-    // unlike all other subclasses of `Type`, this class is mutable,
-    // so identity equality and hash code are the only option
+    // unlike all other subclasses of `Type`, this class is mutable, so identity is the only option
     @Override
     boolean internEquals(Object o) {
         return this == o;
     }
 
     @Override
     int internHashCode() {
-        return System.identityHashCode(this);
+        // must produce predictable hash code (for reproducibility) consistent with `internEquals`
+        return name.hashCode();
     }
 }
diff --git a/core/src/test/java/org/jboss/jandex/test/BytecodeVersionTest.java b/core/src/test/java/org/jboss/jandex/test/BytecodeVersionTest.java
@@ -6,7 +6,6 @@
 import java.io.DataInputStream;
 import java.io.IOException;
 import java.io.InputStream;
-import java.util.Arrays;
 
 import org.junit.jupiter.api.Test;
 
@@ -30,11 +29,9 @@ public void verifyJava8() throws IOException {
     }
 
     private void verifyMagic(DataInputStream stream) throws IOException {
-        byte[] buf = new byte[4];
-
-        stream.readFully(buf);
-        if (buf[0] != (byte) 0xCA || buf[1] != (byte) 0xFE || buf[2] != (byte) 0xBA || buf[3] != (byte) 0xBE) {
-            fail("Invalid magic value: " + Arrays.toString(buf));
+        int magic = stream.readInt();
+        if (magic != 0xCA_FE_BA_BE) {
+            fail("Invalid magic value: " + Integer.toHexString(magic));
         }
     }
 

diff --git a/maven-plugin/src/it/reproducible/invoker.properties b/maven-plugin/src/it/reproducible/invoker.properties
@@ -17,4 +17,4 @@
 
 invoker.goals = clean test
 
-invoker.goals.2 = test -DindexName=jandex-2.idx
+invoker.goals.2 = clean test -DindexName=jandex-2.idx
diff --git a/maven-plugin/src/it/reproducible/pom.xml b/maven-plugin/src/it/reproducible/pom.xml
@@ -29,11 +29,13 @@
               <goal>jandex</goal>
             </goals>
             <configuration>
+              <!-- so that the 2nd execution of `mvn clean test` doesn't delete the previous index file -->
+              <indexDir>${project.basedir}</indexDir>
               <indexName>${indexName}</indexName>
             </configuration>
           </execution>
         </executions>
       </plugin>
     </plugins>
   </build>
-</project>
+</project>
diff --git a/...rc/it/reproducible/src/main/java/org/jboss/jandex/maven/reproducible/BasicAnnotation.java b/...rc/it/reproducible/src/main/java/org/jboss/jandex/maven/reproducible/BasicAnnotation.java
@@ -24,6 +24,8 @@
 import java.lang.annotation.RetentionPolicy;
 import java.lang.annotation.Target;
 import java.lang.reflect.Modifier;
+import java.util.List;
+import java.util.Map;
 
 public class BasicAnnotation {
     @Retention(RetentionPolicy.RUNTIME)
@@ -134,4 +136,21 @@ public void f() {
             ApiClass.superApi();
         }
     }
+
+    public static class GenericClass<T extends Number> {
+        public T get(Map<? super Integer, Map<? extends Number, ?>> wildcards) {
+            return null;
+        }
+
+        public <X extends T> void set(List<X> x) {
+        }
+    }
+
+    public abstract static class TypeVarRefUsage<B extends TypeVarRefUsage<B>> {
+        public void doSomething() {
+        }
+
+        public void useSelfType(B b) {
+        }
+    }
 }
diff --git a/...c/it/reproducible/src/main/java/org/jboss/jandex/maven/reproducible/BasicAnnotation2.java b/...c/it/reproducible/src/main/java/org/jboss/jandex/maven/reproducible/BasicAnnotation2.java
@@ -24,6 +24,8 @@
 import java.lang.annotation.RetentionPolicy;
 import java.lang.annotation.Target;
 import java.lang.reflect.Modifier;
+import java.util.List;
+import java.util.Map;
 
 public class BasicAnnotation2 {
     @Retention(RetentionPolicy.RUNTIME)
@@ -134,4 +136,21 @@ public void f() {
             ApiClass.superApi();
         }
     }
+
+    public static class GenericClass<T extends Number> {
+        public T get(Map<? super Integer, Map<? extends Number, ?>> wildcards) {
+            return null;
+        }
+
+        public <X extends T> void set(List<X> x) {
+        }
+    }
+
+    public abstract static class TypeVarRefUsage<B extends TypeVarRefUsage<B>> {
+        public void doSomething() {
+        }
+
+        public void useSelfType(B b) {
+        }
+    }
 }
diff --git a/.../it/reproducible/src/main/java/org/jboss/jandex/maven/reproducible/sub/SubAnnotation.java b/.../it/reproducible/src/main/java/org/jboss/jandex/maven/reproducible/sub/SubAnnotation.java
@@ -24,6 +24,8 @@
 import java.lang.annotation.RetentionPolicy;
 import java.lang.annotation.Target;
 import java.lang.reflect.Modifier;
+import java.util.List;
+import java.util.Map;
 
 public class SubAnnotation {
     @Retention(RetentionPolicy.RUNTIME)
@@ -134,4 +136,21 @@ public void f() {
             ApiClass.superApi();
         }
     }
+
+    public static class GenericClass<T extends Number> {
+        public T get(Map<? super Integer, Map<? extends Number, ?>> wildcards) {
+            return null;
+        }
+
+        public <X extends T> void set(List<X> x) {
+        }
+    }
+
+    public abstract static class TypeVarRefUsage<B extends TypeVarRefUsage<B>> {
+        public void doSomething() {
+        }
+
+        public void useSelfType(B b) {
+        }
+    }
 }
diff --git a/...it/reproducible/src/main/java/org/jboss/jandex/maven/reproducible/sub/SubAnnotation2.java b/...it/reproducible/src/main/java/org/jboss/jandex/maven/reproducible/sub/SubAnnotation2.java
@@ -24,6 +24,8 @@
 import java.lang.annotation.RetentionPolicy;
 import java.lang.annotation.Target;
 import java.lang.reflect.Modifier;
+import java.util.List;
+import java.util.Map;
 
 public class SubAnnotation2 {
     @Retention(RetentionPolicy.RUNTIME)
@@ -134,4 +136,21 @@ public void f() {
             ApiClass.superApi();
         }
     }
+
+    public static class GenericClass<T extends Number> {
+        public T get(Map<? super Integer, Map<? extends Number, ?>> wildcards) {
+            return null;
+        }
+
+        public <X extends T> void set(List<X> x) {
+        }
+    }
+
+    public abstract static class TypeVarRefUsage<B extends TypeVarRefUsage<B>> {
+        public void doSomething() {
+        }
+
+        public void useSelfType(B b) {
+        }
+    }
 }
diff --git a/maven-plugin/src/it/reproducible/verify.groovy b/maven-plugin/src/it/reproducible/verify.groovy
@@ -1,8 +1,8 @@
-def jandexFile = new File(basedir, 'target/classes/META-INF/jandex.idx')
-def jandexFile2 = new File(basedir, 'target/classes/META-INF/jandex-2.idx')
+def jandexFile = new File(basedir, 'jandex.idx')
+def jandexFile2 = new File(basedir, 'jandex-2.idx')
 
 assert jandexFile.exists() : "File does not exist: ${jandexFile}"
-assert jandexFile2.exists() : "File does not exist: ${jandexFile}"
+assert jandexFile2.exists() : "File does not exist: ${jandexFile2}"
 
 byte[] idx = jandexFile.bytes
 byte[] idx2 = jandexFile2.bytes

diff --git a/maven-plugin/src/test/java/org/jboss/jandex/maven/BytecodeVersionTest.java b/maven-plugin/src/test/java/org/jboss/jandex/maven/BytecodeVersionTest.java
@@ -6,7 +6,6 @@
 import java.io.DataInputStream;
 import java.io.IOException;
 import java.io.InputStream;
-import java.util.Arrays;
 
 import org.junit.jupiter.api.Test;
 
@@ -30,11 +29,9 @@ public void verifyJava8() throws IOException {
     }
 
     private void verifyMagic(DataInputStream stream) throws IOException {
-        byte[] buf = new byte[4];
-
-        stream.readFully(buf);
-        if (buf[0] != (byte) 0xCA || buf[1] != (byte) 0xFE || buf[2] != (byte) 0xBA || buf[3] != (byte) 0xBE) {
-            fail("Invalid magic value: " + Arrays.toString(buf));
+        int magic = stream.readInt();
+        if (magic != 0xCA_FE_BA_BE) {
+            fail("Invalid magic value: " + Integer.toHexString(magic));
         }
     }
Original file line number	Diff line number	Diff line change
Expand Up		@@ -17,4 +17,4 @@

		invoker.goals = clean test

		invoker.goals.2 = test -DindexName=jandex-2.idx
		invoker.goals.2 = clean test -DindexName=jandex-2.idx