Merge branch 'main' into serializable-refactor

nedtwigg · web-flow · commit 93eb0996ac8c · 2024-01-23T15:09:54.000-08:00
diff --git a/CHANGES.md b/CHANGES.md
@@ -14,6 +14,8 @@ We adhere to the [keepachangelog](https://keepachangelog.com/en/1.0.0/) format (
 * `FileSignature.Promised` and `JarState.Promised` to facilitate round-trip serialization for the Gradle configuration cache. ([#1945](https://github.com/diffplug/spotless/pull/1945)) 
 ### Removed
 * **BREAKING** Remove `JarState.getMavenCoordinate(String prefix)`. ([#1945](https://github.com/diffplug/spotless/pull/1945))
+### Fixed
+* Ignore system git config when running tests ([#1990](https://github.com/diffplug/spotless/issues/1990))
 
 ## [2.45.0] - 2024-01-23
 ### Added
diff --git a/gradle/special-tests.gradle b/gradle/special-tests.gradle
@@ -2,12 +2,12 @@ apply plugin: 'com.adarshr.test-logger'
 
 // See com.diffplug.spotless.tag package for available JUnit 5 @Tag annotations
 def special = [
-	'Black',
-	'Buf',
-	'Clang',
+	'black',
+	'buf',
+	'clang',
 	'gofmt',
-	'Npm',
-	'Shfmt'
+	'npm',
+	'shfmt'
 ]
 
 boolean isCiServer = System.getenv().containsKey("CI")
@@ -31,7 +31,7 @@ tasks.named('test').configure {
 	}
 }
 special.forEach { tag ->
-	tasks.register("test${tag}", Test) {
+	tasks.register("test${tag.capitalize()}", Test) {
 		useJUnitPlatform { includeTags tag }
 	}
 }
diff --git a/lib-extra/src/test/java/com/diffplug/spotless/extra/GitAttributesTest.java b/lib-extra/src/test/java/com/diffplug/spotless/extra/GitAttributesTest.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2016-2023 DiffPlug
+ * Copyright 2016-2024 DiffPlug
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -27,9 +27,11 @@
 import org.junit.jupiter.api.Test;
 
 import com.diffplug.common.base.StringPrinter;
+import com.diffplug.spotless.ClearGitConfig;
 import com.diffplug.spotless.LineEnding;
 import com.diffplug.spotless.ResourceHarness;
 
+@ClearGitConfig
 class GitAttributesTest extends ResourceHarness {
 	private List<File> testFiles(String prefix) {
 		List<File> result = new ArrayList<>();
diff --git a/lib-extra/src/test/java/com/diffplug/spotless/extra/GitRachetMergeBaseTest.java b/lib-extra/src/test/java/com/diffplug/spotless/extra/GitRachetMergeBaseTest.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2020-2021 DiffPlug
+ * Copyright 2020-2024 DiffPlug
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -27,8 +27,10 @@
 import org.eclipse.jgit.lib.RefDatabase;
 import org.junit.jupiter.api.Test;
 
+import com.diffplug.spotless.ClearGitConfig;
 import com.diffplug.spotless.ResourceHarness;
 
+@ClearGitConfig
 class GitRachetMergeBaseTest extends ResourceHarness {
 	@Test
 	void test() throws IllegalStateException, GitAPIException, IOException {
diff --git a/lib-extra/src/test/java/com/diffplug/spotless/extra/GitWorkaroundsTest.java b/lib-extra/src/test/java/com/diffplug/spotless/extra/GitWorkaroundsTest.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2022 DiffPlug
+ * Copyright 2022-2024 DiffPlug
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -27,9 +27,11 @@
 import org.junit.jupiter.api.Nested;
 import org.junit.jupiter.api.Test;
 
+import com.diffplug.spotless.ClearGitConfig;
 import com.diffplug.spotless.ResourceHarness;
 import com.diffplug.spotless.extra.GitWorkarounds.RepositorySpecificResolver;
 
+@ClearGitConfig
 class GitWorkaroundsTest extends ResourceHarness {
 	@Test
 	void inline() throws IOException, GitAPIException {
diff --git a/plugin-gradle/CHANGES.md b/plugin-gradle/CHANGES.md
@@ -3,6 +3,8 @@
 We adhere to the [keepachangelog](https://keepachangelog.com/en/1.0.0/) format (starting after version `3.27.0`).
 
 ## [Unreleased]
+### Fixed
+* Ignore system git config when running tests ([#1990](https://github.com/diffplug/spotless/issues/1990))
 
 ## [6.25.0] - 2024-01-23
 ### Added
diff --git a/plugin-gradle/src/test/java/com/diffplug/gradle/spotless/GitRatchetGradleTest.java b/plugin-gradle/src/test/java/com/diffplug/gradle/spotless/GitRatchetGradleTest.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2016-2023 DiffPlug
+ * Copyright 2016-2024 DiffPlug
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -36,6 +36,9 @@
 import org.junit.jupiter.params.ParameterizedTest;
 import org.junit.jupiter.params.provider.ValueSource;
 
+import com.diffplug.spotless.ClearGitConfig;
+
+@ClearGitConfig
 class GitRatchetGradleTest extends GradleIntegrationHarness {
 	private static final String TEST_PATH = "src/markdown/test.md";
 
@@ -268,10 +271,9 @@ public BuildResultAssertion outcome(String taskPath, TaskOutcome expected) {
 	private RevCommit addAndCommit(Git git) throws NoFilepatternException, GitAPIException {
 		PersonIdent emptyPerson = new PersonIdent("jane doe", "jane@doe.com", new Date(0), TimeZone.getTimeZone("UTC"));
 		git.add().addFilepattern(".").call();
-		RevCommit commit = git.commit().setMessage("baseline")
+		return git.commit().setMessage("baseline")
 				.setCommitter(emptyPerson)
 				.setAuthor(emptyPerson)
 				.call();
-		return commit;
 	}
 }
diff --git a/plugin-gradle/src/test/java/com/diffplug/gradle/spotless/LicenseHeaderTest.java b/plugin-gradle/src/test/java/com/diffplug/gradle/spotless/LicenseHeaderTest.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2016-2021 DiffPlug
+ * Copyright 2016-2024 DiffPlug
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -21,6 +21,9 @@
 import org.eclipse.jgit.api.Git;
 import org.junit.jupiter.api.Test;
 
+import com.diffplug.spotless.ClearGitConfig;
+
+@ClearGitConfig
 class LicenseHeaderTest extends GradleIntegrationHarness {
 	private static final String NOW = String.valueOf(YearMonth.now().getYear());
 
diff --git a/plugin-maven/CHANGES.md b/plugin-maven/CHANGES.md
@@ -3,6 +3,8 @@
 We adhere to the [keepachangelog](https://keepachangelog.com/en/1.0.0/) format (starting after version `1.27.0`).
 
 ## [Unreleased]
+### Fixed
+* Ignore system git config when running tests ([#1990](https://github.com/diffplug/spotless/issues/1990))
 
 ## [2.43.0] - 2024-01-23
 ### Added
diff --git a/plugin-maven/src/test/java/com/diffplug/spotless/maven/GitRatchetMavenTest.java b/plugin-maven/src/test/java/com/diffplug/spotless/maven/GitRatchetMavenTest.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2020-2021 DiffPlug
+ * Copyright 2020-2024 DiffPlug
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -25,7 +25,9 @@
 import org.junit.jupiter.api.Test;
 
 import com.diffplug.common.base.StringPrinter;
+import com.diffplug.spotless.ClearGitConfig;
 
+@ClearGitConfig
 class GitRatchetMavenTest extends MavenIntegrationHarness {
 	private static final String TEST_PATH = "src/markdown/test.md";
 
diff --git a/plugin-maven/src/test/java/com/diffplug/spotless/maven/generic/LicenseHeaderRatchetTest.java b/plugin-maven/src/test/java/com/diffplug/spotless/maven/generic/LicenseHeaderRatchetTest.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2020-2021 DiffPlug
+ * Copyright 2020-2024 DiffPlug
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -21,8 +21,10 @@
 import org.eclipse.jgit.api.Git;
 import org.junit.jupiter.api.Test;
 
+import com.diffplug.spotless.ClearGitConfig;
 import com.diffplug.spotless.maven.MavenIntegrationHarness;
 
+@ClearGitConfig
 class LicenseHeaderRatchetTest extends MavenIntegrationHarness {
 	private static final String NOW = String.valueOf(YearMonth.now().getYear());
 
diff --git a/testlib/build.gradle b/testlib/build.gradle
@@ -17,6 +17,7 @@ dependencies {
 
 	implementation "com.diffplug.durian:durian-io:${VER_DURIAN}"
 	implementation "com.diffplug.durian:durian-collect:${VER_DURIAN}"
+	implementation "org.eclipse.jgit:org.eclipse.jgit:${VER_JGIT}"
 	implementation gradleTestKit()
 }
 
diff --git a/testlib/src/main/java/com/diffplug/spotless/ClearGitConfig.java b/testlib/src/main/java/com/diffplug/spotless/ClearGitConfig.java
@@ -0,0 +1,60 @@
+/*
+ * Copyright 2024 DiffPlug
+ *
+ * Licensed 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.
+ */
+package com.diffplug.spotless;
+
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+import java.util.List;
+
+import org.eclipse.jgit.lib.StoredConfig;
+import org.eclipse.jgit.util.SystemReader;
+import org.junit.jupiter.api.extension.AfterEachCallback;
+import org.junit.jupiter.api.extension.BeforeEachCallback;
+import org.junit.jupiter.api.extension.ExtendWith;
+import org.junit.jupiter.api.extension.ExtensionContext;
+import org.junit.jupiter.api.parallel.ResourceAccessMode;
+import org.junit.jupiter.api.parallel.ResourceLock;
+
+@Retention(RetentionPolicy.RUNTIME)
+@Target({ElementType.TYPE, ElementType.METHOD})
+@ExtendWith(ClearGitConfig.GitConfigExtension.class)
+@ResourceLock(value = "GIT", mode = ResourceAccessMode.READ_WRITE)
+public @interface ClearGitConfig {
+
+	class GitConfigExtension implements BeforeEachCallback, AfterEachCallback {
+
+		@Override
+		public void beforeEach(ExtensionContext extensionContext) throws Exception {
+			for (var config : getConfigs()) {
+				config.clear();
+			}
+		}
+
+		@Override
+		public void afterEach(ExtensionContext extensionContext) throws Exception {
+			for (var config : getConfigs()) {
+				config.load();
+			}
+		}
+
+		private static List<StoredConfig> getConfigs() throws Exception {
+			var reader = SystemReader.getInstance();
+			return List.of(reader.getUserConfig(), reader.getSystemConfig());
+		}
+	}
+}
diff --git a/testlib/src/main/java/com/diffplug/spotless/tag/BlackTest.java b/testlib/src/main/java/com/diffplug/spotless/tag/BlackTest.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2021 DiffPlug
+ * Copyright 2021-2024 DiffPlug
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -26,5 +26,5 @@
 
 @Target({TYPE, METHOD})
 @Retention(RUNTIME)
-@Tag("Black")
+@Tag("black")
 public @interface BlackTest {}
diff --git a/testlib/src/main/java/com/diffplug/spotless/tag/BufTest.java b/testlib/src/main/java/com/diffplug/spotless/tag/BufTest.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2022-2023 DiffPlug
+ * Copyright 2022-2024 DiffPlug
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -26,5 +26,5 @@
 
 @Target({TYPE, METHOD})
 @Retention(RUNTIME)
-@Tag("Buf")
+@Tag("buf")
 public @interface BufTest {}
diff --git a/testlib/src/main/java/com/diffplug/spotless/tag/ClangTest.java b/testlib/src/main/java/com/diffplug/spotless/tag/ClangTest.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2021 DiffPlug
+ * Copyright 2021-2024 DiffPlug
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -26,5 +26,5 @@
 
 @Target({TYPE, METHOD})
 @Retention(RUNTIME)
-@Tag("Clang")
+@Tag("clang")
 public @interface ClangTest {}
diff --git a/testlib/src/main/java/com/diffplug/spotless/tag/NpmTest.java b/testlib/src/main/java/com/diffplug/spotless/tag/NpmTest.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2021 DiffPlug
+ * Copyright 2021-2024 DiffPlug
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -26,5 +26,5 @@
 
 @Target({TYPE, METHOD})
 @Retention(RUNTIME)
-@Tag("Npm")
+@Tag("npm")
 public @interface NpmTest {}
diff --git a/testlib/src/main/java/com/diffplug/spotless/tag/ShfmtTest.java b/testlib/src/main/java/com/diffplug/spotless/tag/ShfmtTest.java
@@ -26,5 +26,5 @@
 
 @Target({TYPE, METHOD})
 @Retention(RUNTIME)
-@Tag("Shfmt")
+@Tag("shfmt")
 public @interface ShfmtTest {}

Original file line number	Diff line number	Diff line change
`@@ -2,12 +2,12 @@ apply plugin: 'com.adarshr.test-logger'`
`2`	`2`
`3`	`3`	`// See com.diffplug.spotless.tag package for available JUnit 5 @Tag annotations`
`4`	`4`	`def special = [`
`5`		`- 'Black',`
`6`		`- 'Buf',`
`7`		`- 'Clang',`
	`5`	`+ 'black',`
	`6`	`+ 'buf',`
	`7`	`+ 'clang',`
`8`	`8`	`'gofmt',`
`9`		`- 'Npm',`
`10`		`- 'Shfmt'`
	`9`	`+ 'npm',`
	`10`	`+ 'shfmt'`
`11`	`11`	`]`
`12`	`12`
`13`	`13`	`boolean isCiServer = System.getenv().containsKey("CI")`
`@@ -31,7 +31,7 @@ tasks.named('test').configure {`
`31`	`31`	`}`
`32`	`32`	`}`
`33`	`33`	`special.forEach { tag ->`
`34`		`- tasks.register("test${tag}", Test) {`
	`34`	`+ tasks.register("test${tag.capitalize()}", Test) {`
`35`	`35`	`useJUnitPlatform { includeTags tag }`
`36`	`36`	`}`
`37`	`37`	`}`