git pre push hook windows fix

Author: lazer-dev

lib/src/main/java/com/diffplug/spotless/GitPrePushHookInstaller.java

@@ -192,12 +192,12 @@ private void uninstall(File gitHookFile) throws Exception {
 	 * @param commandApply  The command to apply corrections.
 	 * @return A string template representing the Spotless Git pre-push hook content.
 	 */
-	protected String preHookTemplate(String executor, String commandCheck, String commandApply) {
+	protected String preHookTemplate(Executor executor, String commandCheck, String commandApply) {
 		var spotlessHook = "";
 
 		spotlessHook += "\n";
 		spotlessHook += "\n" + HOOK_HEADER;
-		spotlessHook += "\nSPOTLESS_EXECUTOR=" + executor;
+		spotlessHook += "\nSPOTLESS_EXECUTOR=" + executorPath(executor);
 		spotlessHook += "\nif ! $SPOTLESS_EXECUTOR " + commandCheck + " ; then";
 		spotlessHook += "\n    echo 1>&2 \"spotless found problems, running " + commandApply + "; commit the result and re-push\"";
 		spotlessHook += "\n    $SPOTLESS_EXECUTOR " + commandApply;
@@ -209,6 +209,58 @@ protected String preHookTemplate(String executor, String commandCheck, String co
 		return spotlessHook;
 	}
 
+	/**
+	 * Determines the path to the build tool executor (Maven or Gradle).
+	 * This method first checks for the existence of a wrapper script in the project root.
+	 * If the wrapper exists, returns a relative path to it, otherwise returns the global command.
+	 *
+	 * @param executor The build tool executor (GRADLE or MAVEN)
+	 * @return The path to the executor - either the wrapper script path (e.g., "./gradlew")
+	 *         or the global command (e.g., "gradle")
+	 */
+	private String executorPath(Executor executor) {
+		final var wrapper = executorWrapperFile(executor);
+		if (wrapper.exists()) {
+			return "./" + wrapper.getName();
+		}
+
+		logger.info("Local %s wrapper (%s) not found, falling back to global command '%s'",
+			executor.name().toLowerCase(), executor.wrapper, executor.global);
+
+		return executor.global;
+	}
+
+	/**
+	 * Resolves the wrapper script file for the specified build tool executor.
+	 * On Windows systems, checks for both .bat and .cmd extensions.
+	 * On non-Windows systems, uses the wrapper name without extension.
+	 *
+	 * @param executor The build tool executor (GRADLE or MAVEN)
+	 * @return The File object representing the wrapper script
+	 */
+	private File executorWrapperFile(Executor executor) {
+		if (isWindows()) {
+			final var bat = root.toPath().resolve(executor.wrapper + ".bat").toFile();
+			if (bat.exists()) {
+				return bat;
+			}
+
+			return root.toPath().resolve(executor.wrapper + ".cmd").toFile();
+		}
+
+		return root.toPath().resolve(executor.wrapper).toFile();
+	}
+
+	/**
+	 * Checks if the current operating system is Windows.
+	 * This is determined by checking if the "os.name" system property contains "win".
+	 *
+	 * @return true if the current OS is Windows, false otherwise
+	 */
+	private boolean isWindows() {
+		return System.getProperty("os.name").toLowerCase().startsWith("win");
+	}
+
 	/**
 	 * Checks if Git is installed by validating the existence of `.git/config` in the repository root.
 	 *
@@ -243,6 +295,19 @@ private void writeFile(File file, String content, boolean append) throws IOExcep
 		}
 	}
 
+	public enum Executor {
+		GRADLE("gradlew", "gradle"),
+		MAVEN("mvnw", "mvn"), ;
+
+		public final String wrapper;
+		public final String global;
+
+		Executor(String wrapper, String global) {
+			this.wrapper = wrapper;
+			this.global = global;
+		}
+	}
+
 	public interface GitPreHookLogger {
 		void info(String format, Object... arguments);
 

lib/src/main/java/com/diffplug/spotless/GitPrePushHookInstallerGradle.java

@@ -15,6 +15,8 @@
  */
 package com.diffplug.spotless;
 
+import static com.diffplug.spotless.GitPrePushHookInstaller.Executor.GRADLE;
+
 import java.io.File;
 
 /**
@@ -23,30 +25,15 @@
  */
 public class GitPrePushHookInstallerGradle extends GitPrePushHookInstaller {
 
-	/**
-	 * The Gradle wrapper file (`gradlew`) located in the root directory of the project.
-	 */
-	private final File gradlew;
-
 	public GitPrePushHookInstallerGradle(GitPreHookLogger logger, File root) {
 		super(logger, root);
-		this.gradlew = root.toPath().resolve("gradlew").toFile();
 	}
 
 	/**
 	 * {@inheritDoc}
 	 */
 	@Override
 	protected String preHookContent() {
-		return preHookTemplate(executorPath(), "spotlessCheck", "spotlessApply");
-	}
-
-	private String executorPath() {
-		if (gradlew.exists()) {
-			return gradlew.getAbsolutePath();
-		}
-
-		logger.info("Gradle wrapper is not installed, using global gradle");
-		return "gradle";
+		return preHookTemplate(GRADLE, "spotlessCheck", "spotlessApply");
 	}
 }

lib/src/main/java/com/diffplug/spotless/GitPrePushHookInstallerMaven.java

@@ -15,6 +15,8 @@
  */
 package com.diffplug.spotless;
 
+import static com.diffplug.spotless.GitPrePushHookInstaller.Executor.MAVEN;
+
 import java.io.File;
 
 /**
@@ -23,27 +25,15 @@
  */
 public class GitPrePushHookInstallerMaven extends GitPrePushHookInstaller {
 
-	private final File mvnw;
-
 	public GitPrePushHookInstallerMaven(GitPreHookLogger logger, File root) {
 		super(logger, root);
-		this.mvnw = root.toPath().resolve("mvnw").toFile();
 	}
 
 	/**
 	 * {@inheritDoc}
 	 */
 	@Override
 	protected String preHookContent() {
-		return preHookTemplate(executorPath(), "spotless:check", "spotless:apply");
-	}
-
-	private String executorPath() {
-		if (mvnw.exists()) {
-			return mvnw.getAbsolutePath();
-		}
-
-		logger.info("Maven wrapper is not installed, using global maven");
-		return "mvn";
+		return preHookTemplate(MAVEN, "spotless:check", "spotless:apply");
 	}
 }

testlib/src/test/java/com/diffplug/spotless/GitPrePushHookInstallerTest.java

@@ -15,16 +15,22 @@
  */
 package com.diffplug.spotless;
 
+import static com.diffplug.spotless.GitPrePushHookInstaller.Executor.GRADLE;
+import static com.diffplug.spotless.GitPrePushHookInstaller.Executor.MAVEN;
 import static org.assertj.core.api.Assertions.assertThat;
 
 import java.util.ArrayList;
 import java.util.List;
 
+import org.junit.jupiter.api.AfterEach;
+import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Test;
 
 import com.diffplug.spotless.GitPrePushHookInstaller.GitPreHookLogger;
 
 class GitPrePushHookInstallerTest extends ResourceHarness {
+	private final static String OS = System.getProperty("os.name");
+
 	private final List<String> logs = new ArrayList<>();
 	private final GitPreHookLogger logger = new GitPreHookLogger() {
 		@Override
@@ -43,6 +49,16 @@ public void error(String format, Object... arguments) {
 		}
 	};
 
+	@BeforeEach
+	public void beforeEach() {
+		System.setProperty("os.name", "linux");
+	}
+
+	@AfterEach
+	public void afterEach() {
+		System.setProperty("os.name", OS);
+	}
+
 	@Test
 	public void should_not_create_pre_hook_file_when_git_is_not_installed() throws Exception {
 		// given
@@ -71,7 +87,7 @@ public void should_use_global_gradle_when_gradlew_is_not_installed() throws Exce
 		assertThat(logs).hasSize(4);
 		assertThat(logs).element(0).isEqualTo("Installing git pre-push hook");
 		assertThat(logs).element(1).isEqualTo("Git pre-push hook not found, creating it");
-		assertThat(logs).element(2).isEqualTo("Gradle wrapper is not installed, using global gradle");
+		assertThat(logs).element(2).isEqualTo("Local gradle wrapper (gradlew) not found, falling back to global command 'gradle'");
 		assertThat(logs).element(3).isEqualTo("Git pre-push hook installed successfully to the file " + newFile(".git/hooks/pre-push").getAbsolutePath());
 
 		final var content = gradleHookContent("git_pre_hook/pre-push.created-tpl", ExecutorType.GLOBAL);
@@ -217,23 +233,117 @@ public void should_use_global_maven_when_maven_wrapper_is_not_installed() throws
 		assertThat(logs).hasSize(4);
 		assertThat(logs).element(0).isEqualTo("Installing git pre-push hook");
 		assertThat(logs).element(1).isEqualTo("Git pre-push hook not found, creating it");
-		assertThat(logs).element(2).isEqualTo("Maven wrapper is not installed, using global maven");
+		assertThat(logs).element(2).isEqualTo("Local maven wrapper (mvnw) not found, falling back to global command 'mvn'");
 		assertThat(logs).element(3).isEqualTo("Git pre-push hook installed successfully to the file " + newFile(".git/hooks/pre-push").getAbsolutePath());
 
 		final var content = mavenHookContent("git_pre_hook/pre-push.created-tpl", ExecutorType.GLOBAL);
 		assertFile(".git/hooks/pre-push").hasContent(content);
 	}
 
+	@Test
+	public void should_use_maven_bat_wrapper_when_exists_for_windows() {
+		// given
+		System.setProperty("os.name", "Windows 10");
+		setFile("mvnw.bat").toContent("");
+		setFile("mvnw.cmd").toContent("");
+
+		final var gradle = new GitPrePushHookInstallerMaven(logger, rootFolder());
+
+		// when
+		final var hook = gradle.preHookTemplate(MAVEN, "spotless:check", "spotless:apply");
+
+		// then
+		assertThat(hook).contains("SPOTLESS_EXECUTOR=./mvnw.bat");
+	}
+
+	@Test
+	public void should_use_maven_cmd_wrapper_when_exists_for_windows() {
+		// given
+		System.setProperty("os.name", "Windows 10");
+		setFile("mvnw.cmd").toContent("");
+
+		final var gradle = new GitPrePushHookInstallerMaven(logger, rootFolder());
+
+		// when
+		final var hook = gradle.preHookTemplate(MAVEN, "spotless:check", "spotless:apply");
+
+		// then
+		assertThat(hook).contains("SPOTLESS_EXECUTOR=./mvnw.cmd");
+	}
+
+	@Test
+	public void should_use_maven_global_when_bat_and_cmd_files_not_exists_for_windows() {
+		// given
+		System.setProperty("os.name", "Windows 10");
+		setFile("mvnw").toContent("");
+
+		final var gradle = new GitPrePushHookInstallerMaven(logger, rootFolder());
+
+		// when
+		final var hook = gradle.preHookTemplate(MAVEN, "spotless:check", "spotless:apply");
+
+		// then
+		assertThat(hook).contains("SPOTLESS_EXECUTOR=mvn");
+	}
+
+	@Test
+	public void should_use_gradle_bat_wrapper_when_exists_for_windows() {
+		// given
+		System.setProperty("os.name", "Windows 10");
+		setFile("gradlew.bat").toContent("");
+		setFile("gradlew.cmd").toContent("");
+		setFile("gradlew").toContent("");
+
+		final var gradle = new GitPrePushHookInstallerMaven(logger, rootFolder());
+
+		// when
+		final var hook = gradle.preHookTemplate(GRADLE, "spotlessCheck", "spotlessApply");
+
+		// then
+		assertThat(hook).contains("SPOTLESS_EXECUTOR=./gradlew.bat");
+	}
+
+	@Test
+	public void should_use_gradle_cmd_wrapper_when_exists_for_windows() {
+		// given
+		System.setProperty("os.name", "Windows 10");
+		setFile("gradlew.cmd").toContent("");
+		setFile("gradlew").toContent("");
+
+		final var gradle = new GitPrePushHookInstallerMaven(logger, rootFolder());
+
+		// when
+		final var hook = gradle.preHookTemplate(GRADLE, "spotlessCheck", "spotlessApply");
+
+		// then
+		assertThat(hook).contains("SPOTLESS_EXECUTOR=./gradlew.cmd");
+	}
+
+	@Test
+	public void should_use_gradle_global_when_bat_and_cmd_files_not_exists_for_windows() {
+		// given
+		System.setProperty("os.name", "Windows 10");
+		setFile("gradlew").toContent("");
+
+		final var gradle = new GitPrePushHookInstallerMaven(logger, rootFolder());
+
+		// when
+		final var hook = gradle.preHookTemplate(GRADLE, "spotlessCheck", "spotlessApply");
+
+		// then
+		assertThat(hook).contains("SPOTLESS_EXECUTOR=gradle");
+	}
+
 	private String gradleHookContent(String resourcePath, ExecutorType executorType) {
 		return getTestResource(resourcePath)
-				.replace("${executor}", executorType == ExecutorType.WRAPPER ? newFile("gradlew").getAbsolutePath() : "gradle")
+				.replace("${executor}", executorType == ExecutorType.WRAPPER ? "./" + newFile("gradlew").getName() : "gradle")
 				.replace("${checkCommand}", "spotlessCheck")
 				.replace("${applyCommand}", "spotlessApply");
 	}
 
 	private String mavenHookContent(String resourcePath, ExecutorType executorType) {
 		return getTestResource(resourcePath)
-				.replace("${executor}", executorType == ExecutorType.WRAPPER ? newFile("mvnw").getAbsolutePath() : "mvn")
+				.replace("${executor}", executorType == ExecutorType.WRAPPER ? "./" + newFile("mvnw").getName() : "mvn")
 				.replace("${checkCommand}", "spotless:check")
 				.replace("${applyCommand}", "spotless:apply");
 	}