From b33133497fac512bf2fc3ce9cae75639eca2030c Mon Sep 17 00:00:00 2001
From: Matthias Sohn <matthias.sohn@sap.com>
Date: Wed, 12 Jan 2022 23:45:34 +0100
Subject: [PATCH] [bazel] Skip ConfigTest#testCommitTemplatePathInHomeDirecory

Move this test to another class and skip it when running tests with
bazel since the bazel test runner does not allow to create files in the
home directory.

FS#userHome retrieves the home directory on the first call and caches it
for subsequent calls to avoid overhead in case path translation is
required (currently on cygwin). This prevents that the test can mock the
home directory using MockSystemReader like SshTestHarness does.

Change-Id: I6a22f37f4a19eb4b4935509eae508a23e56db7aa
---
 org.eclipse.jgit.test/BUILD                   |  1 +
 .../jgit/lib/CommitTemplateConfigTest.java    | 60 +++++++++++++++++++
 .../tst/org/eclipse/jgit/lib/ConfigTest.java  | 27 +--------
 3 files changed, 62 insertions(+), 26 deletions(-)
 create mode 100644 org.eclipse.jgit.test/tst/org/eclipse/jgit/lib/CommitTemplateConfigTest.java

diff --git a/org.eclipse.jgit.test/BUILD b/org.eclipse.jgit.test/BUILD
index c9b5d3726..9e787fee7 100644
--- a/org.eclipse.jgit.test/BUILD
+++ b/org.eclipse.jgit.test/BUILD
@@ -42,6 +42,7 @@ DATA = [
 EXCLUDED = [
     PKG + "api/SecurityManagerTest.java",
     PKG + "api/SecurityManagerMissingPermissionsTest.java",
+    PKG + "lib/CommitTemplateConfigTest.java",
 ]
 
 tests(tests = glob(
diff --git a/org.eclipse.jgit.test/tst/org/eclipse/jgit/lib/CommitTemplateConfigTest.java b/org.eclipse.jgit.test/tst/org/eclipse/jgit/lib/CommitTemplateConfigTest.java
new file mode 100644
index 000000000..6dbe30af2
--- /dev/null
+++ b/org.eclipse.jgit.test/tst/org/eclipse/jgit/lib/CommitTemplateConfigTest.java
@@ -0,0 +1,60 @@
+/*
+ * Copyright (C) 2021 SAP SE 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.lib;
+
+import static org.junit.Assert.assertEquals;
+
+import java.io.File;
+import java.io.IOException;
+
+import org.eclipse.jgit.errors.ConfigInvalidException;
+import org.eclipse.jgit.junit.JGitTestUtil;
+import org.eclipse.jgit.storage.file.FileRepositoryBuilder;
+import org.junit.Rule;
+import org.junit.Test;
+import org.junit.rules.TemporaryFolder;
+
+/*
+ * This test was moved from ConfigTest to allow skipping it when running the
+ * test using bazel which doesn't allow tests to create files in the home
+ * directory
+ */
+public class CommitTemplateConfigTest {
+
+	@Rule
+	public TemporaryFolder tmp = new TemporaryFolder();
+
+	@Test
+	public void testCommitTemplatePathInHomeDirecory()
+			throws ConfigInvalidException, IOException {
+		Config config = new Config(null);
+		File tempFile = tmp.newFile("testCommitTemplate-");
+		File workTree = tmp.newFolder("dummy-worktree");
+		Repository repo = FileRepositoryBuilder.create(workTree);
+		String templateContent = "content of the template";
+		JGitTestUtil.write(tempFile, templateContent);
+		// proper evaluation of the ~/ directory
+		String homeDir = System.getProperty("user.home");
+		File tempFileInHomeDirectory = File.createTempFile("fileInHomeFolder",
+				".tmp", new File(homeDir));
+		tempFileInHomeDirectory.deleteOnExit();
+		JGitTestUtil.write(tempFileInHomeDirectory, templateContent);
+		String expectedTemplatePath = tempFileInHomeDirectory.getPath()
+				.replace(homeDir, "~");
+		config = ConfigTest
+				.parse("[commit]\n\ttemplate = " + expectedTemplatePath + "\n");
+		String templatePath = config.get(CommitConfig.KEY)
+				.getCommitTemplatePath();
+		assertEquals(expectedTemplatePath, templatePath);
+		assertEquals(templateContent,
+				config.get(CommitConfig.KEY).getCommitTemplateContent(repo));
+	}
+}
diff --git a/org.eclipse.jgit.test/tst/org/eclipse/jgit/lib/ConfigTest.java b/org.eclipse.jgit.test/tst/org/eclipse/jgit/lib/ConfigTest.java
index 9ee54d5b6..9b82c2afd 100644
--- a/org.eclipse.jgit.test/tst/org/eclipse/jgit/lib/ConfigTest.java
+++ b/org.eclipse.jgit.test/tst/org/eclipse/jgit/lib/ConfigTest.java
@@ -1177,7 +1177,7 @@ private static void assertReadLong(long exp, String act)
 		assertEquals(exp, c.getLong("s", null, "a", 0L));
 	}
 
-	private static Config parse(String content)
+	static Config parse(String content)
 			throws ConfigInvalidException {
 		return parse(content, null);
 	}
@@ -1546,31 +1546,6 @@ public void testCommitTemplateEncoding()
 				"utf-8", commitEncoding);
 	}
 
-	@Test
-	public void testCommitTemplatePathInHomeDirecory()
-			throws ConfigInvalidException, IOException {
-		Config config = new Config(null);
-		File tempFile = tmp.newFile("testCommitTemplate-");
-		File workTree = tmp.newFolder("dummy-worktree");
-		Repository repo = FileRepositoryBuilder.create(workTree);
-		String templateContent = "content of the template";
-		JGitTestUtil.write(tempFile, templateContent);
-		// proper evaluation of the ~/ directory
-		String homeDir = System.getProperty("user.home");
-		File tempFileInHomeDirectory = File.createTempFile("fileInHomeFolder",
-				".tmp", new File(homeDir));
-		tempFileInHomeDirectory.deleteOnExit();
-		JGitTestUtil.write(tempFileInHomeDirectory, templateContent);
-		String expectedTemplatePath = tempFileInHomeDirectory.getPath()
-				.replace(homeDir, "~");
-		config = parse("[commit]\n\ttemplate = " + expectedTemplatePath + "\n");
-		String templatePath = config.get(CommitConfig.KEY)
-				.getCommitTemplatePath();
-		assertEquals(expectedTemplatePath, templatePath);
-		assertEquals(templateContent,
-				config.get(CommitConfig.KEY).getCommitTemplateContent(repo));
-	}
-
 	@Test(expected = ConfigInvalidException.class)
 	public void testCommitTemplateWithInvalidEncoding()
 			throws ConfigInvalidException, IOException {