Merge branch 'stable-6.10' into stable-7.0

* stable-6.10:
  DiffDriver: fix doc for rust built-in
  DiffDriver: fix formatting of javadoc
  Add numberOfObjectsSinceBitmap to RepoStatistics
  Support built-in diff drivers for hunk header function names
  Don't fail when trying to prune pack which is already gone
  Rename numberOfPackFilesAfterBitmap to numberOfPackFilesSinceBitmap

Change-Id: I7f18e96cc98c56ee7c5e6256fe9e83957e733aa8

3 files changed, 340 insertions, 173 deletions

diff --git a/org.eclipse.jgit.test/tst/org/eclipse/jgit/diff/DiffFormatterBuiltInDriverTest.java b/org.eclipse.jgit.test/tst/org/eclipse/jgit/diff/DiffFormatterBuiltInDriverTest.java
new file mode 100644
index 0000000000..1352871983
--- /dev/null
+++ b/org.eclipse.jgit.test/tst/org/eclipse/jgit/diff/DiffFormatterBuiltInDriverTest.java
@@ -0,0 +1,173 @@
+/*
+ * Copyright (c) 2024 Qualcomm Innovation Center, Inc.
+ * and other copyright owners as documented in the project's IP log.
+ *
+ * This program and the accompanying materials are made available under the
+ * terms of the Eclipse Distribution License v. 1.0 which is available at
+ * https://www.eclipse.org/org/documents/edl-v10.php.
+ *
+ * SPDX-License-Identifier: BSD-3-Clause
+ */
+
+package org.eclipse.jgit.diff;
+
+import static org.junit.Assert.assertEquals;
+
+import java.io.ByteArrayOutputStream;
+import java.io.IOException;
+import java.nio.charset.StandardCharsets;
+import java.nio.file.Files;
+import java.nio.file.Path;
+import java.util.Arrays;
+import java.util.stream.Collectors;
+import org.eclipse.jgit.api.Git;
+import org.eclipse.jgit.api.errors.GitAPIException;
+import org.eclipse.jgit.junit.JGitTestUtil;
+import org.eclipse.jgit.junit.RepositoryTestCase;
+import org.eclipse.jgit.revwalk.RevCommit;
+import org.eclipse.jgit.treewalk.CanonicalTreeParser;
+import org.junit.Test;
+
+public class DiffFormatterBuiltInDriverTest extends RepositoryTestCase {
+	@Test
+	public void testCppDriver() throws Exception {
+		String fileName = "greeting.c";
+		String body = Files.readString(
+				Path.of(JGitTestUtil.getTestResourceFile(fileName)
+						.getAbsolutePath()));
+		RevCommit c1;
+		RevCommit c2;
+		try (Git git = new Git(db)) {
+			createCommit(git, ".gitattributes", "*.c   diff=cpp");
+			c1 = createCommit(git, fileName, body);
+			c2 = createCommit(git, fileName,
+					body.replace("Good day", "Greetings")
+							.replace("baz", "qux"));
+		}
+		try (ByteArrayOutputStream os = new ByteArrayOutputStream();
+				DiffFormatter diffFormatter = new DiffFormatter(os)) {
+			String actual = getHunkHeaders(c1, c2, os, diffFormatter);
+			String expected =
+					"@@ -27,7 +27,7 @@ void getPersonalizedGreeting(char *result, const char *name, const char *timeOfD\n"
+							+ "@@ -37,7 +37,7 @@ int main() {";
+			assertEquals(expected, actual);
+		}
+	}
+
+	@Test
+	public void testDtsDriver() throws Exception {
+		String fileName = "sample.dtsi";
+		String body = Files.readString(
+				Path.of(JGitTestUtil.getTestResourceFile(fileName)
+						.getAbsolutePath()));
+		RevCommit c1;
+		RevCommit c2;
+		try (Git git = new Git(db)) {
+			createCommit(git, ".gitattributes", "*.dtsi   diff=dts");
+			c1 = createCommit(git, fileName, body);
+			c2 = createCommit(git, fileName,
+					body.replace("clock-frequency = <24000000>",
+							"clock-frequency = <48000000>"));
+		}
+		try (ByteArrayOutputStream os = new ByteArrayOutputStream();
+				DiffFormatter diffFormatter = new DiffFormatter(os)) {
+			String actual = getHunkHeaders(c1, c2, os, diffFormatter);
+			String expected = "@@ -20,6 +20,6 @@ uart0: uart@101f1000 {";
+			assertEquals(expected, actual);
+		}
+	}
+
+	@Test
+	public void testJavaDriver() throws Exception {
+		String resourceName = "greeting.javasource";
+		String body = Files.readString(
+				Path.of(JGitTestUtil.getTestResourceFile(resourceName)
+						.getAbsolutePath()));
+		RevCommit c1;
+		RevCommit c2;
+		try (Git git = new Git(db)) {
+			createCommit(git, ".gitattributes", "*.java   diff=java");
+			String fileName = "Greeting.java";
+			c1 = createCommit(git, fileName, body);
+			c2 = createCommit(git, fileName,
+					body.replace("Good day", "Greetings")
+							.replace("baz", "qux"));
+		}
+		try (ByteArrayOutputStream os = new ByteArrayOutputStream();
+				DiffFormatter diffFormatter = new DiffFormatter(os)) {
+			String actual = getHunkHeaders(c1, c2, os, diffFormatter);
+			String expected =
+					"@@ -22,7 +22,7 @@ public String getPersonalizedGreeting(String name, String timeOfDay) {\n"
+							+ "@@ -32,6 +32,6 @@ public static void main(String[] args) {";
+			assertEquals(expected, actual);
+		}
+	}
+
+	@Test
+	public void testPythonDriver() throws Exception {
+		String fileName = "greeting.py";
+		String body = Files.readString(
+				Path.of(JGitTestUtil.getTestResourceFile(fileName)
+						.getAbsolutePath()));
+		RevCommit c1;
+		RevCommit c2;
+		try (Git git = new Git(db)) {
+			createCommit(git, ".gitattributes", "*.py   diff=python");
+			c1 = createCommit(git, fileName, body);
+			c2 = createCommit(git, fileName,
+					body.replace("Good day", "Greetings"));
+		}
+		try (ByteArrayOutputStream os = new ByteArrayOutputStream();
+				DiffFormatter diffFormatter = new DiffFormatter(os)) {
+			String actual = getHunkHeaders(c1, c2, os, diffFormatter);
+			String expected = "@@ -16,7 +16,7 @@ def get_personalized_greeting(self, name, time_of_day):";
+			assertEquals(expected, actual);
+		}
+	}
+
+	@Test
+	public void testRustDriver() throws Exception {
+		String fileName = "greeting.rs";
+		String body = Files.readString(
+				Path.of(JGitTestUtil.getTestResourceFile(fileName)
+						.getAbsolutePath()));
+		RevCommit c1;
+		RevCommit c2;
+		try (Git git = new Git(db)) {
+			createCommit(git, ".gitattributes", "*.rs   diff=rust");
+			c1 = createCommit(git, fileName, body);
+			c2 = createCommit(git, fileName,
+					body.replace("Good day", "Greetings")
+							.replace("baz", "qux"));
+		}
+		try (ByteArrayOutputStream os = new ByteArrayOutputStream();
+				DiffFormatter diffFormatter = new DiffFormatter(os)) {
+			String actual = getHunkHeaders(c1, c2, os, diffFormatter);
+			String expected =
+					"@@ -14,7 +14,7 @@ fn get_personalized_greeting(&self, name: &str, time_of_day: &str) -> String {\n"
+							+ "@@ -23,5 +23,5 @@ fn main() {";
+			assertEquals(expected, actual);
+		}
+	}
+
+	private String getHunkHeaders(RevCommit c1, RevCommit c2,
+			ByteArrayOutputStream os, DiffFormatter diffFormatter)
+			throws IOException {
+		diffFormatter.setRepository(db);
+		diffFormatter.format(new CanonicalTreeParser(null, db.newObjectReader(),
+						c1.getTree()),
+				new CanonicalTreeParser(null, db.newObjectReader(),
+						c2.getTree()));
+		diffFormatter.flush();
+		return Arrays.stream(os.toString(StandardCharsets.UTF_8).split("\n"))
+				.filter(line -> line.startsWith("@@"))
+				.collect(Collectors.joining("\n"));
+	}
+
+	private RevCommit createCommit(Git git, String fileName, String body)
+			throws IOException, GitAPIException {
+		writeTrashFile(fileName, body);
+		git.add().addFilepattern(".").call();
+		return git.commit().setMessage("message").call();
+	}
+}
diff --git a/org.eclipse.jgit.test/tst/org/eclipse/jgit/internal/storage/file/GcNumberOfPackFilesAfterBitmapStatisticsTest.java b/org.eclipse.jgit.test/tst/org/eclipse/jgit/internal/storage/file/GcNumberOfPackFilesAfterBitmapStatisticsTest.java
deleted file mode 100644
index e5a391f2e3..0000000000
--- a/org.eclipse.jgit.test/tst/org/eclipse/jgit/internal/storage/file/GcNumberOfPackFilesAfterBitmapStatisticsTest.java
+++ /dev/null
@@ -1,173 +0,0 @@
-/*
- * Copyright (c) 2024 Jacek Centkowski <geminica.programs@gmail.com> and others.
- *
- * This program and the accompanying materials are made available under the
- * terms of the Eclipse Distribution License v. 1.0 which is available at
- * https://www.eclipse.org/org/documents/edl-v10.php.
- *
- * SPDX-License-Identifier: BSD-3-Clause
- */
-
-package org.eclipse.jgit.internal.storage.file;
-
-import static org.junit.Assert.assertEquals;
-
-import java.io.BufferedOutputStream;
-import java.io.FileOutputStream;
-import java.io.IOException;
-import java.io.OutputStream;
-import java.nio.file.Files;
-import java.util.HashSet;
-import java.util.Set;
-import java.util.stream.StreamSupport;
-
-import org.eclipse.jgit.internal.storage.file.PackIndex.MutableEntry;
-import org.eclipse.jgit.internal.storage.pack.PackExt;
-import org.eclipse.jgit.internal.storage.pack.PackWriter;
-import org.eclipse.jgit.junit.TestRepository;
-import org.eclipse.jgit.lib.NullProgressMonitor;
-import org.eclipse.jgit.lib.ObjectId;
-import org.eclipse.jgit.lib.PersonIdent;
-import org.eclipse.jgit.lib.Ref;
-import org.eclipse.jgit.revwalk.RevCommit;
-import org.eclipse.jgit.util.FileUtils;
-import org.junit.Test;
-
-public class GcNumberOfPackFilesAfterBitmapStatisticsTest extends GcTestCase {
-	@Test
-	public void testShouldReportZeroObjectsForInitializedRepo()
-			throws IOException {
-		assertEquals(0L, gc.getStatistics().numberOfPackFilesAfterBitmap);
-	}
-
-	@Test
-	public void testShouldReportAllPackFilesWhenNoGcWasPerformed()
-			throws Exception {
-		packAndPrune();
-		long result = gc.getStatistics().numberOfPackFilesAfterBitmap;
-
-		assertEquals(repo.getObjectDatabase().getPacks().size(), result);
-	}
-
-	@Test
-	public void testShouldReportNoObjectsDirectlyAfterGc() throws Exception {
-		// given
-		addCommit(null);
-		gc.gc().get();
-		assertEquals(1L, repositoryBitmapFiles());
-		assertEquals(0L, gc.getStatistics().numberOfPackFilesAfterBitmap);
-	}
-
-	@Test
-	public void testShouldReportNewObjectsAfterGcWhenRepositoryProgresses()
-			throws Exception {
-		// commit & gc
-		RevCommit parent = addCommit(null);
-		gc.gc().get();
-		assertEquals(1L, repositoryBitmapFiles());
-
-		// progress & pack
-		addCommit(parent);
-		packAndPrune();
-
-		assertEquals(1L, gc.getStatistics().numberOfPackFilesAfterBitmap);
-	}
-
-	@Test
-	public void testShouldReportNewObjectsFromTheLatestBitmapWhenRepositoryProgresses()
-			throws Exception {
-		// commit & gc
-		RevCommit parent = addCommit(null);
-		gc.gc().get();
-		assertEquals(1L, repositoryBitmapFiles());
-
-		// progress & gc
-		parent = addCommit(parent);
-		gc.gc().get();
-		assertEquals(2L, repositoryBitmapFiles());
-
-		// progress & pack
-		addCommit(parent);
-		packAndPrune();
-
-		assertEquals(1L, gc.getStatistics().numberOfPackFilesAfterBitmap);
-	}
-
-	private void packAndPrune() throws Exception {
-		try (SkipNonExistingFilesTestRepository testRepo = new SkipNonExistingFilesTestRepository(
-				repo)) {
-			testRepo.packAndPrune();
-		}
-	}
-
-	private RevCommit addCommit(RevCommit parent) throws Exception {
-		return tr.branch("master").commit()
-				.author(new PersonIdent("repo-metrics", "repo@metrics.com"))
-				.parent(parent).create();
-	}
-
-	private long repositoryBitmapFiles() throws IOException {
-		return StreamSupport
-				.stream(Files
-						.newDirectoryStream(repo.getObjectDatabase()
-								.getPackDirectory().toPath(), "pack-*.bitmap")
-						.spliterator(), false)
-				.count();
-	}
-
-	/**
-	 * The TestRepository has a {@link TestRepository#packAndPrune()} function
-	 * but it fails in the last step after GC was performed as it doesn't
-	 * SKIP_MISSING files. In order to circumvent it was copied and improved
-	 * here.
-	 */
-	private static class SkipNonExistingFilesTestRepository
-			extends TestRepository<FileRepository> {
-		private final FileRepository repo;
-
-		private SkipNonExistingFilesTestRepository(FileRepository db) throws IOException {
-			super(db);
-			repo = db;
-		}
-
-		@Override
-		public void packAndPrune() throws Exception {
-			ObjectDirectory odb = repo.getObjectDatabase();
-			NullProgressMonitor m = NullProgressMonitor.INSTANCE;
-
-			final PackFile pack, idx;
-			try (PackWriter pw = new PackWriter(repo)) {
-				Set<ObjectId> all = new HashSet<>();
-				for (Ref r : repo.getRefDatabase().getRefs())
-					all.add(r.getObjectId());
-				pw.preparePack(m, all, PackWriter.NONE);
-
-				pack = new PackFile(odb.getPackDirectory(), pw.computeName(),
-						PackExt.PACK);
-				try (OutputStream out = new BufferedOutputStream(
-						new FileOutputStream(pack))) {
-					pw.writePack(m, m, out);
-				}
-				pack.setReadOnly();
-
-				idx = pack.create(PackExt.INDEX);
-				try (OutputStream out = new BufferedOutputStream(
-						new FileOutputStream(idx))) {
-					pw.writeIndex(out);
-				}
-				idx.setReadOnly();
-			}
-
-			odb.openPack(pack);
-			updateServerInfo();
-
-			// alternative packAndPrune implementation that skips missing files
-			// after GC.
-			for (Pack p : odb.getPacks()) {
-				for (MutableEntry e : p)
-					FileUtils.delete(odb.fileFor(e.toObjectId()),
-							FileUtils.SKIP_MISSING);
-			}
-		}
-	}
-}
diff --git a/org.eclipse.jgit.test/tst/org/eclipse/jgit/internal/storage/file/GcSinceBitmapStatisticsTest.java b/org.eclipse.jgit.test/tst/org/eclipse/jgit/internal/storage/file/GcSinceBitmapStatisticsTest.java
new file mode 100644
index 0000000000..3cd766c4e9
--- /dev/null
+++ b/org.eclipse.jgit.test/tst/org/eclipse/jgit/internal/storage/file/GcSinceBitmapStatisticsTest.java
@@ -0,0 +1,167 @@
+/*
+ * Copyright (c) 2024 Jacek Centkowski <geminica.programs@gmail.com> and others.
+ *
+ * This program and the accompanying materials are made available under the
+ * terms of the Eclipse Distribution License v. 1.0 which is available at
+ * https://www.eclipse.org/org/documents/edl-v10.php.
+ *
+ * SPDX-License-Identifier: BSD-3-Clause
+ */
+
+package org.eclipse.jgit.internal.storage.file;
+
+import static org.junit.Assert.assertEquals;
+
+import java.io.IOException;
+import java.nio.file.Files;
+import java.util.Collection;
+import java.util.stream.StreamSupport;
+
+import org.eclipse.jgit.internal.storage.file.GC.RepoStatistics;
+import org.eclipse.jgit.lib.PersonIdent;
+import org.eclipse.jgit.revwalk.RevCommit;
+import org.junit.Test;
+
+public class GcSinceBitmapStatisticsTest extends GcTestCase {
+	@Test
+	public void testShouldReportZeroPacksAndObjectsForInitializedRepo()
+			throws IOException {
+		RepoStatistics s = gc.getStatistics();
+		assertEquals(0L, s.numberOfPackFilesSinceBitmap);
+		assertEquals(0L, s.numberOfObjectsSinceBitmap);
+	}
+
+	@Test
+	public void testShouldReportAllPackFilesWhenNoGcWasPerformed()
+			throws Exception {
+		tr.packAndPrune();
+		long result = gc.getStatistics().numberOfPackFilesSinceBitmap;
+
+		assertEquals(repo.getObjectDatabase().getPacks().size(), result);
+	}
+
+	@Test
+	public void testShouldReportAllObjectsWhenNoGcWasPerformed()
+			throws Exception {
+		tr.packAndPrune();
+
+		assertEquals(
+				getNumberOfObjectsInPacks(repo.getObjectDatabase().getPacks()),
+				gc.getStatistics().numberOfObjectsSinceBitmap);
+	}
+
+	@Test
+	public void testShouldReportNoPacksDirectlyAfterGc() throws Exception {
+		// given
+		addCommit(null);
+		gc.gc().get();
+		assertEquals(1L, repositoryBitmapFiles());
+		assertEquals(0L, gc.getStatistics().numberOfPackFilesSinceBitmap);
+	}
+
+	@Test
+	public void testShouldReportNoObjectsDirectlyAfterGc() throws Exception {
+		// given
+		addCommit(null);
+		assertEquals(2L, gc.getStatistics().numberOfObjectsSinceBitmap);
+
+		gc.gc().get();
+		assertEquals(0L, gc.getStatistics().numberOfObjectsSinceBitmap);
+	}
+
+	@Test
+	public void testShouldReportNewPacksSinceGcWhenRepositoryProgresses()
+			throws Exception {
+		// commit & gc
+		RevCommit parent = addCommit(null);
+		gc.gc().get();
+		assertEquals(1L, repositoryBitmapFiles());
+
+		// progress & pack
+		addCommit(parent);
+		tr.packAndPrune();
+
+		assertEquals(1L, gc.getStatistics().numberOfPackFilesSinceBitmap);
+	}
+
+	@Test
+	public void testShouldReportNewObjectsSinceGcWhenRepositoryProgresses()
+			throws Exception {
+		// commit & gc
+		RevCommit parent = addCommit(null);
+		gc.gc().get();
+		assertEquals(0L, gc.getStatistics().numberOfObjectsSinceBitmap);
+
+		// progress & pack
+		addCommit(parent);
+		assertEquals(1L, gc.getStatistics().numberOfObjectsSinceBitmap);
+
+		tr.packAndPrune();
+		assertEquals(3L, gc.getStatistics().numberOfObjectsSinceBitmap);
+	}
+
+	@Test
+	public void testShouldReportNewPacksFromTheLatestBitmapWhenRepositoryProgresses()
+			throws Exception {
+		// commit & gc
+		RevCommit parent = addCommit(null);
+		gc.gc().get();
+		assertEquals(1L, repositoryBitmapFiles());
+
+		// progress & gc
+		parent = addCommit(parent);
+		gc.gc().get();
+		assertEquals(2L, repositoryBitmapFiles());
+
+		// progress & pack
+		addCommit(parent);
+		tr.packAndPrune();
+
+		assertEquals(1L, gc.getStatistics().numberOfPackFilesSinceBitmap);
+	}
+
+	@Test
+	public void testShouldReportNewObjectsFromTheLatestBitmapWhenRepositoryProgresses()
+			throws Exception {
+		// commit & gc
+		RevCommit parent = addCommit(null);
+		gc.gc().get();
+
+		// progress & gc
+		parent = addCommit(parent);
+		gc.gc().get();
+		assertEquals(0L, gc.getStatistics().numberOfObjectsSinceBitmap);
+
+		// progress & pack
+		addCommit(parent);
+		assertEquals(1L, gc.getStatistics().numberOfObjectsSinceBitmap);
+
+		tr.packAndPrune();
+		assertEquals(4L, gc.getStatistics().numberOfObjectsSinceBitmap);
+	}
+
+	private RevCommit addCommit(RevCommit parent) throws Exception {
+		return tr.branch("master").commit()
+				.author(new PersonIdent("repo-metrics", "repo@metrics.com"))
+				.parent(parent).create();
+	}
+
+	private long repositoryBitmapFiles() throws IOException {
+		return StreamSupport
+				.stream(Files
+						.newDirectoryStream(repo.getObjectDatabase()
+								.getPackDirectory().toPath(), "pack-*.bitmap")
+						.spliterator(), false)
+				.count();
+	}
+
+	private long getNumberOfObjectsInPacks(Collection<Pack> packs) {
+		return packs.stream().mapToLong(pack -> {
+			try {
+				return pack.getObjectCount();
+			} catch (IOException e) {
+				throw new RuntimeException(e);
+			}
+		}).sum();
+	}
+}