Patch Gumtree to add MappingStore.assertConsistency

ibbem · ibbem · commit a198a8900b82 · 2025-09-08T18:56:55.000+02:00
The CompositeMatchers.XyMatcher algorithm adds incompatible matchings
for nodes which already have a matching. As this is the fastest matcher,
it's useful to test it further. Thus, incompatible matchings are ignored
and a debug message is printed.

For example, given a matching between A and B
| src -&gt; dst | dst -&gt; src |
|------------|------------|
| A -&gt; B     | B -&gt; A     |

When the incompatible matching between B and C is added, the result is:
| src -&gt; dst | dst -&gt; src |
|------------|------------|
| A -&gt; B     |            |
| C -&gt; B     | B -&gt; C     |

Thus the matching between B and C is ignored if XyMatcher tries to add
it.
diff --git a/lib/gumtree-client-3.1.0-SNAPSHOT.jar b/lib/gumtree-client-3.1.0-SNAPSHOT.jar
diff --git a/lib/gumtree-core-3.1.0-SNAPSHOT.jar b/lib/gumtree-core-3.1.0-SNAPSHOT.jar
diff --git a/local-maven-repo/com/github/gumtreediff/client/3.1.0-SNAPSHOT/client-3.1.0-20230321.174509-1.jar b/local-maven-repo/com/github/gumtreediff/client/3.1.0-SNAPSHOT/client-3.1.0-20230321.174509-1.jar
diff --git a/local-maven-repo/com/github/gumtreediff/client/3.1.0-SNAPSHOT/client-3.1.0-20230321.174509-1.jar.md5 b/local-maven-repo/com/github/gumtreediff/client/3.1.0-SNAPSHOT/client-3.1.0-20230321.174509-1.jar.md5
@@ -0,0 +1 @@
+1a35e5613da6eac9bbf2eefcc5de5559
diff --git a/local-maven-repo/com/github/gumtreediff/client/3.1.0-SNAPSHOT/client-3.1.0-20230321.174509-1.jar.sha1 b/local-maven-repo/com/github/gumtreediff/client/3.1.0-SNAPSHOT/client-3.1.0-20230321.174509-1.jar.sha1
@@ -0,0 +1 @@
+4b809dba134db1e6dd604046cb8b29d1d4234c6e
diff --git a/local-maven-repo/com/github/gumtreediff/client/3.1.0-SNAPSHOT/client-3.1.0-20230321.174509-1.pom b/local-maven-repo/com/github/gumtreediff/client/3.1.0-SNAPSHOT/client-3.1.0-20230321.174509-1.pom
@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd" xmlns="http://maven.apache.org/POM/4.0.0"
+    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
+  <modelVersion>4.0.0</modelVersion>
+  <groupId>com.github.gumtreediff</groupId>
+  <artifactId>client</artifactId>
+  <version>3.1.0-SNAPSHOT</version>
+</project>
diff --git a/local-maven-repo/com/github/gumtreediff/client/3.1.0-SNAPSHOT/client-3.1.0-20230321.174509-1.pom.md5 b/local-maven-repo/com/github/gumtreediff/client/3.1.0-SNAPSHOT/client-3.1.0-20230321.174509-1.pom.md5
@@ -0,0 +1 @@
+6e527f17def9837cec885c57e350ec4a
diff --git a/local-maven-repo/com/github/gumtreediff/client/3.1.0-SNAPSHOT/client-3.1.0-20230321.174509-1.pom.sha1 b/local-maven-repo/com/github/gumtreediff/client/3.1.0-SNAPSHOT/client-3.1.0-20230321.174509-1.pom.sha1
@@ -0,0 +1 @@
+6b88766be14dc630adf2803860ef0b2825cac141
diff --git a/local-maven-repo/com/github/gumtreediff/client/3.1.0-SNAPSHOT/maven-metadata.xml b/local-maven-repo/com/github/gumtreediff/client/3.1.0-SNAPSHOT/maven-metadata.xml
@@ -0,0 +1,25 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<metadata modelVersion="1.1.0">
+  <groupId>com.github.gumtreediff</groupId>
+  <artifactId>client</artifactId>
+  <versioning>
+    <lastUpdated>20230321174509</lastUpdated>
+    <snapshot>
+      <timestamp>20230321.174509</timestamp>
+      <buildNumber>1</buildNumber>
+    </snapshot>
+    <snapshotVersions>
+      <snapshotVersion>
+        <extension>jar</extension>
+        <value>3.1.0-20230321.174509-1</value>
+        <updated>20230321174509</updated>
+      </snapshotVersion>
+      <snapshotVersion>
+        <extension>pom</extension>
+        <value>3.1.0-20230321.174509-1</value>
+        <updated>20230321174509</updated>
+      </snapshotVersion>
+    </snapshotVersions>
+  </versioning>
+  <version>3.1.0-SNAPSHOT</version>
+</metadata>
diff --git a/local-maven-repo/com/github/gumtreediff/client/3.1.0-SNAPSHOT/maven-metadata.xml.md5 b/local-maven-repo/com/github/gumtreediff/client/3.1.0-SNAPSHOT/maven-metadata.xml.md5
@@ -0,0 +1 @@
+bafdfc934e042edbe35a88c8c07862a1
diff --git a/local-maven-repo/com/github/gumtreediff/client/3.1.0-SNAPSHOT/maven-metadata.xml.sha1 b/local-maven-repo/com/github/gumtreediff/client/3.1.0-SNAPSHOT/maven-metadata.xml.sha1
@@ -0,0 +1 @@
+b5faa7a713f085e4911b25db913217f3bfb49791
diff --git a/local-maven-repo/com/github/gumtreediff/client/maven-metadata.xml b/local-maven-repo/com/github/gumtreediff/client/maven-metadata.xml
@@ -0,0 +1,11 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<metadata>
+  <groupId>com.github.gumtreediff</groupId>
+  <artifactId>client</artifactId>
+  <versioning>
+    <versions>
+      <version>3.1.0-SNAPSHOT</version>
+    </versions>
+    <lastUpdated>20230321174509</lastUpdated>
+  </versioning>
+</metadata>
diff --git a/local-maven-repo/com/github/gumtreediff/client/maven-metadata.xml.md5 b/local-maven-repo/com/github/gumtreediff/client/maven-metadata.xml.md5
@@ -0,0 +1 @@
+d1d1d31247d64a3c71e7ac3a1d942620
diff --git a/local-maven-repo/com/github/gumtreediff/client/maven-metadata.xml.sha1 b/local-maven-repo/com/github/gumtreediff/client/maven-metadata.xml.sha1
@@ -0,0 +1 @@
+509b6b77f425a04300dabf183190d217a0c44ee3
diff --git a/local-maven-repo/com/github/gumtreediff/core/3.1.0-SNAPSHOT/core-3.1.0-20230321.174522-1.jar b/local-maven-repo/com/github/gumtreediff/core/3.1.0-SNAPSHOT/core-3.1.0-20230321.174522-1.jar
diff --git a/local-maven-repo/com/github/gumtreediff/core/3.1.0-SNAPSHOT/core-3.1.0-20230321.174522-1.jar.md5 b/local-maven-repo/com/github/gumtreediff/core/3.1.0-SNAPSHOT/core-3.1.0-20230321.174522-1.jar.md5
@@ -0,0 +1 @@
+2c81fb27041404635be543fb40ecb653
diff --git a/local-maven-repo/com/github/gumtreediff/core/3.1.0-SNAPSHOT/core-3.1.0-20230321.174522-1.jar.sha1 b/local-maven-repo/com/github/gumtreediff/core/3.1.0-SNAPSHOT/core-3.1.0-20230321.174522-1.jar.sha1
@@ -0,0 +1 @@
+dc75530d27c4ec99ec2593671f58c79cc2f29215
diff --git a/local-maven-repo/com/github/gumtreediff/core/3.1.0-SNAPSHOT/core-3.1.0-20230321.174522-1.pom b/local-maven-repo/com/github/gumtreediff/core/3.1.0-SNAPSHOT/core-3.1.0-20230321.174522-1.pom
@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd" xmlns="http://maven.apache.org/POM/4.0.0"
+    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
+  <modelVersion>4.0.0</modelVersion>
+  <groupId>com.github.gumtreediff</groupId>
+  <artifactId>core</artifactId>
+  <version>3.1.0-SNAPSHOT</version>
+</project>
diff --git a/local-maven-repo/com/github/gumtreediff/core/3.1.0-SNAPSHOT/core-3.1.0-20230321.174522-1.pom.md5 b/local-maven-repo/com/github/gumtreediff/core/3.1.0-SNAPSHOT/core-3.1.0-20230321.174522-1.pom.md5
@@ -0,0 +1 @@
+b92284eba26b3c5336efd71e92c05e61
diff --git a/local-maven-repo/com/github/gumtreediff/core/3.1.0-SNAPSHOT/core-3.1.0-20230321.174522-1.pom.sha1 b/local-maven-repo/com/github/gumtreediff/core/3.1.0-SNAPSHOT/core-3.1.0-20230321.174522-1.pom.sha1
@@ -0,0 +1 @@
+1b7801268a9b8cc60c49b80b42e49b3c3bba1d36
diff --git a/local-maven-repo/com/github/gumtreediff/core/3.1.0-SNAPSHOT/maven-metadata.xml b/local-maven-repo/com/github/gumtreediff/core/3.1.0-SNAPSHOT/maven-metadata.xml
@@ -0,0 +1,25 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<metadata modelVersion="1.1.0">
+  <groupId>com.github.gumtreediff</groupId>
+  <artifactId>core</artifactId>
+  <versioning>
+    <lastUpdated>20230321174522</lastUpdated>
+    <snapshot>
+      <timestamp>20230321.174522</timestamp>
+      <buildNumber>1</buildNumber>
+    </snapshot>
+    <snapshotVersions>
+      <snapshotVersion>
+        <extension>jar</extension>
+        <value>3.1.0-20230321.174522-1</value>
+        <updated>20230321174522</updated>
+      </snapshotVersion>
+      <snapshotVersion>
+        <extension>pom</extension>
+        <value>3.1.0-20230321.174522-1</value>
+        <updated>20230321174522</updated>
+      </snapshotVersion>
+    </snapshotVersions>
+  </versioning>
+  <version>3.1.0-SNAPSHOT</version>
+</metadata>
diff --git a/local-maven-repo/com/github/gumtreediff/core/3.1.0-SNAPSHOT/maven-metadata.xml.md5 b/local-maven-repo/com/github/gumtreediff/core/3.1.0-SNAPSHOT/maven-metadata.xml.md5
@@ -0,0 +1 @@
+7012baa5e3b23da5602fd67739cee85c
diff --git a/local-maven-repo/com/github/gumtreediff/core/3.1.0-SNAPSHOT/maven-metadata.xml.sha1 b/local-maven-repo/com/github/gumtreediff/core/3.1.0-SNAPSHOT/maven-metadata.xml.sha1
@@ -0,0 +1 @@
+7937bd0711dde91b1eead890a5db055e0c8822ec
diff --git a/local-maven-repo/com/github/gumtreediff/core/maven-metadata.xml b/local-maven-repo/com/github/gumtreediff/core/maven-metadata.xml
@@ -0,0 +1,11 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<metadata>
+  <groupId>com.github.gumtreediff</groupId>
+  <artifactId>core</artifactId>
+  <versioning>
+    <versions>
+      <version>3.1.0-SNAPSHOT</version>
+    </versions>
+    <lastUpdated>20230321174522</lastUpdated>
+  </versioning>
+</metadata>
diff --git a/local-maven-repo/com/github/gumtreediff/core/maven-metadata.xml.md5 b/local-maven-repo/com/github/gumtreediff/core/maven-metadata.xml.md5
@@ -0,0 +1 @@
+9733818dcf473b86a0e472ab84affb46
diff --git a/local-maven-repo/com/github/gumtreediff/core/maven-metadata.xml.sha1 b/local-maven-repo/com/github/gumtreediff/core/maven-metadata.xml.sha1
@@ -0,0 +1 @@
+3060c20a9d9590ad67b831adea22e05b9a8876f2
diff --git a/pom.xml b/pom.xml
@@ -138,7 +138,25 @@
         <dependency>
             <groupId>com.github.gumtreediff</groupId>
             <artifactId>core</artifactId>
-            <version>3.0.0</version>
+            <version>3.1.0-SNAPSHOT</version>
+        </dependency>
+        <dependency>
+            <groupId>com.github.gumtreediff</groupId>
+            <artifactId>client</artifactId>
+            <version>3.1.0-SNAPSHOT</version>
+            <scope>test</scope>
+        </dependency>
+        <dependency>
+            <!-- For Gumtree -->
+            <groupId>it.unimi.dsi</groupId>
+            <artifactId>fastutil</artifactId>
+            <version>8.3.1</version>
+        </dependency>
+        <dependency>
+            <!-- For Gumtree -->
+            <groupId>com.github.mpkorstanje</groupId>
+            <artifactId>simmetrics-core</artifactId>
+            <version>3.2.3</version>
         </dependency>
         <dependency>
             <!-- For Gumtree -->
diff --git a/scripts/deploy_libs.sh b/scripts/deploy_libs.sh
@@ -8,3 +8,7 @@ mvn deploy:deploy-file -DgroupId=org.variantsync -DartifactId=functjonal -Dversi
 
 # sat4j
 mvn deploy:deploy-file -DgroupId=org.sat4j -DartifactId=core -Dversion=2.3.5 -Durl=file:./local-maven-repo/ -DrepositoryId=local-maven-repo -DupdateReleaseInfo=true -Dfile=./lib/org.sat4j.core.jar
+
+# gumtree
+mvn deploy:deploy-file -DgroupId=com.github.gumtreediff -DartifactId=core -Dversion=3.1.0-SNAPSHOT -Durl=file:./local-maven-repo/ -DrepositoryId=local-maven-repo -DupdateReleaseInfo=true -Dfile=./lib/gumtree-core-3.1.0-SNAPSHOT.jar
+mvn deploy:deploy-file -DgroupId=com.github.gumtreediff -DartifactId=client -Dversion=3.1.0-SNAPSHOT -Durl=file:./local-maven-repo/ -DrepositoryId=local-maven-repo -DupdateReleaseInfo=true -Dfile=./lib/gumtree-client-3.1.0-SNAPSHOT.jar
diff --git a/src/main/java/org/variantsync/diffdetective/experiments/thesis_bm/ConstructionValidation.java b/src/main/java/org/variantsync/diffdetective/experiments/thesis_bm/ConstructionValidation.java
@@ -186,7 +186,7 @@ public static void main(String[] args) throws IOException {
                     List.of(
                         new FilterAnalysis(VariationDiffFilter.notEmpty()),
                         new ConstructionValidation(
-                            // new CompositeMatchers.XyMatcher(),
+                            // new CompositeMatchers.XyMatcher(), // Buggy
                             new CompositeMatchers.ClassicGumtree(),
                             // new CompositeMatchers.SimpleGumtree(),
                             // new CompositeMatchers.HybridGumtree(),
@@ -476,6 +476,7 @@ public MappingStore match(Tree src, Tree dst, MappingStore mappings) {
                 Clock matchingClock = new Clock();
                 MappingStore result = matcher.match(src, dst, mappings);
                 statistics.matchingDuration += matchingClock.getPassedMilliseconds();
+                mappings.assertConsistency();
                 return result;
             }
         };
diff --git a/src/main/java/org/variantsync/diffdetective/variation/diff/construction/GumTreeDiff.java b/src/main/java/org/variantsync/diffdetective/variation/diff/construction/GumTreeDiff.java
@@ -97,20 +97,12 @@ public static <B extends VariationNode<B, L>, L extends Label> DiffNode<L> diffU
         }
 
         // We assume that the root nodes are matched.
+        matching.assertConsistency();
         if (!matching.has(src, dst)) {
             System.out.println("-----------------------------------------------------------");
             System.out.println("-----------------------------------------------------------");
             System.out.println("-----------------------------------------------------------");
             System.out.println("-----------------------------------------------------------");
-            System.out.println("-----------------------------------------------------------");
-            System.out.println("-----------------------------------------------------------");
-            System.out.println("-----------------------------------------------------------");
-            System.out.println("-----------------------------------------------------------");
-            System.out.println("-----------------------------------------------------------");
-            System.out.println("-----------------------------------------------------------");
-            System.out.println("-----------------------------------------------------------");
-            System.out.println("-----------------------------------------------------------");
-            System.out.println("-----------------------------------------------------------");
 
             if (matching.isSrcMapped(src)) {
                 matching.removeMapping(src, matching.getDstForSrc(src));
@@ -126,9 +118,11 @@ public static <B extends VariationNode<B, L>, L extends Label> DiffNode<L> diffU
         for (var mapping : matching) {
             System.out.println(mapping.first + " <-> " + mapping.second);
         }
+        matching.assertConsistency();
 
         removeUnmapped(matching, src);
         for (var child : dst.getChildren()) {
+            System.out.format("addUnmapped(%s, %s, %s)\n", matching, src.getDiffNode(), Cast.unchecked(child));
             addUnmapped(matching, src.getDiffNode(), Cast.unchecked(child));
         }
 
@@ -153,6 +147,7 @@ private static <L extends Label> void removeUnmapped(MappingStore mappings, Vari
         for (var node : root.preOrder()) {
             Tree dst = mappings.getDstForSrc(node);
             if (dst == null || !dst.getLabel().equals(node.getLabel())) {
+                System.out.format("removeUnmapped %s %s\n", node, dst);
                 var diffNode = Cast.<Tree, VariationDiffAdapter<L>>unchecked(node).getDiffNode();
                 diffNode.diffType = REM;
                 diffNode.drop(AFTER);
diff --git a/src/test/java/TreeDiffingTest.java b/src/test/java/TreeDiffingTest.java
@@ -1,3 +1,4 @@
+import com.github.gumtreediff.client.Run;
 import com.github.gumtreediff.matchers.Matcher;
 import com.github.gumtreediff.matchers.Matchers;
 import org.apache.commons.io.IOUtils;
@@ -76,6 +77,7 @@ private static Stream<TestCase> testCases() throws IOException {
 
     @Test
     public void test() throws IOException, DiffParseException {
+        Run.initMatchers();
         testCase(new TestCase("09", "change-distiller-theta", Matchers.getInstance().getMatcher("change-distiller-theta")));
     }
 

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+4b809dba134db1e6dd604046cb8b29d1d4234c6e`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+6b88766be14dc630adf2803860ef0b2825cac141`