feat: setup testing env for cli

Author: simschla

cli/build.gradle

@@ -1,6 +1,5 @@
 plugins {
 	id 'org.graalvm.buildtools.native'
-	id 'application'
 	id 'com.gradleup.shadow'
 }
 apply from: rootProject.file('gradle/changelog.gradle')
@@ -37,6 +36,11 @@ dependencies {
 	annotationProcessor "info.picocli:picocli-codegen:${VER_PICOCLI}"
 }
 
+apply from: rootProject.file('gradle/special-tests.gradle')
+tasks.withType(Test).configureEach {
+	testLogging.showStandardStreams = true
+}
+
 compileJava {
 	// options for picocli codegen
 	// https://github.com/remkop/picocli/tree/main/picocli-codegen#222-other-options

cli/src/main/java/com/diffplug/spotless/cli/SpotlessCLI.java

@@ -15,6 +15,7 @@
  */
 package com.diffplug.spotless.cli;
 
+import java.io.File;
 import java.nio.charset.Charset;
 import java.nio.file.Path;
 import java.util.List;
@@ -26,6 +27,7 @@
 import com.diffplug.spotless.LineEnding;
 import com.diffplug.spotless.LintState;
 import com.diffplug.spotless.ThrowingEx;
+import com.diffplug.spotless.cli.core.FileResolver;
 import com.diffplug.spotless.cli.core.SpotlessActionContext;
 import com.diffplug.spotless.cli.core.TargetFileTypeInferer;
 import com.diffplug.spotless.cli.core.TargetResolver;
@@ -52,6 +54,9 @@ public class SpotlessCLI implements SpotlessAction, SpotlessCommand, SpotlessAct
 	@CommandLine.Option(names = {"--mode", "-m"}, defaultValue = "APPLY", description = "The mode to run spotless in." + OptionConstants.VALID_VALUES_SUFFIX + OptionConstants.DEFAULT_VALUE_SUFFIX, scope = CommandLine.ScopeType.INHERIT)
 	SpotlessMode spotlessMode;
 
+	@CommandLine.Option(names = {"--basedir"}, hidden = true, description = "The base directory to run spotless in. Intended for testing purposes only.")
+	Path baseDir;
+
 	@CommandLine.Option(names = {"--target", "-t"}, required = true, arity = "1..*", description = "The target files to format.", scope = CommandLine.ScopeType.INHERIT)
 	public List<String> targets;
 
@@ -63,7 +68,7 @@ public class SpotlessCLI implements SpotlessAction, SpotlessCommand, SpotlessAct
 
 	@Override
 	public Integer executeSpotlessAction(@Nonnull List<FormatterStep> formatterSteps) {
-		TargetResolver targetResolver = new TargetResolver(targets);
+		TargetResolver targetResolver = targetResolver();
 
 		try (Formatter formatter = Formatter.builder()
 				.lineEndingsPolicy(lineEnding.createPolicy())
@@ -89,20 +94,22 @@ private ResultType handleResult(Formatter formatter, Result result) {
 			System.err.println("File did not converge: " + result.target.toFile().getName()); // TODO: where to print the output to?
 			return ResultType.DID_NOT_CONVERGE;
 		}
-		this.spotlessMode.handleResult(formatter, result);
-		return ResultType.DIRTY;
-
+		return this.spotlessMode.handleResult(formatter, result);
 	}
 
 	private TargetResolver targetResolver() {
-		return new TargetResolver(targets);
+		return new TargetResolver(baseDir == null ? Path.of(File.separator) : baseDir, targets);
+	}
+
+	private Path baseDir() {
+		return baseDir == null ? Path.of(File.separator) : baseDir;
 	}
 
 	@Override
 	public SpotlessActionContext spotlessActionContext() {
 		TargetResolver targetResolver = targetResolver();
 		TargetFileTypeInferer targetFileTypeInferer = new TargetFileTypeInferer(targetResolver);
-		return new SpotlessActionContext(targetFileTypeInferer.inferTargetFileType());
+		return new SpotlessActionContext(targetFileTypeInferer.inferTargetFileType(), new FileResolver(baseDir()));
 	}
 
 	public static void main(String... args) {
@@ -113,22 +120,31 @@ public static void main(String... args) {
 			args = new String[]{"--mode=CHECK", "--target", "src/poc/java/**/*.java", "--encoding=UTF-8", "license-header", "--header", "abc", "license-header", "--header-file", "TestHeader.txt"};
 			//			args = new String[]{"--version"};
 		}
-		int exitCode = new CommandLine(new SpotlessCLI())
-				.setExecutionStrategy(new SpotlessExecutionStrategy())
-				.setCaseInsensitiveEnumValuesAllowed(true)
+		int exitCode = createCommandLine(createInstance())
 				.execute(args);
 		System.exit(exitCode);
 	}
 
+	static SpotlessCLI createInstance() {
+		return new SpotlessCLI();
+	}
+
+	static CommandLine createCommandLine(SpotlessCLI spotlessCLI) {
+		return new CommandLine(spotlessCLI)
+				.setExecutionStrategy(new SpotlessExecutionStrategy())
+				.setCaseInsensitiveEnumValuesAllowed(true);
+	}
+
 	private enum SpotlessMode {
 		CHECK {
 			@Override
-			void handleResult(Formatter formatter, Result result) {
+			ResultType handleResult(Formatter formatter, Result result) {
 				if (result.lintState.isHasLints()) {
 					result.lintState.asStringOneLine(result.target.toFile(), formatter);
 				} else {
 					System.out.println(String.format("%s is violating formatting rules.", result.target));
 				}
+				return ResultType.DIRTY;
 			}
 
 			@Override
@@ -147,8 +163,14 @@ Integer translateResultTypeToExitCode(ResultType resultType) {
 		},
 		APPLY {
 			@Override
-			void handleResult(Formatter formatter, Result result) {
+			ResultType handleResult(Formatter formatter, Result result) {
+				if (result.lintState.isHasLints()) {
+					// something went wrong, we should not apply the changes
+					System.err.println("File has lints: " + result.target.toFile().getName());
+					return ResultType.DIRTY;
+				}
 				ThrowingEx.run(() -> result.lintState.getDirtyState().writeCanonicalTo(result.target.toFile()));
+				return ResultType.CLEAN;
 			}
 
 			@Override
@@ -166,7 +188,7 @@ Integer translateResultTypeToExitCode(ResultType resultType) {
 			}
 		};
 
-		abstract void handleResult(Formatter formatter, Result result);
+		abstract ResultType handleResult(Formatter formatter, Result result);
 
 		abstract Integer translateResultTypeToExitCode(ResultType resultType);
 

cli/src/main/java/com/diffplug/spotless/cli/core/FileResolver.java

@@ -0,0 +1,45 @@
+/*
+ * 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.cli.core;
+
+import java.io.File;
+import java.nio.file.Path;
+import java.util.Objects;
+
+import javax.annotation.Nonnull;
+
+public class FileResolver {
+	private final Path baseDir;
+
+	public FileResolver(@Nonnull Path baseDir) {
+		this.baseDir = Objects.requireNonNull(baseDir);
+	}
+
+	Path baseDir() {
+		return baseDir;
+	}
+
+	public File resolveFile(File file) {
+		return resolvePath(file.toPath()).toFile();
+	}
+
+	public Path resolvePath(Path path) {
+		if (path.isAbsolute()) {
+			return path;
+		}
+		return baseDir.resolve(path);
+	}
+}

cli/src/main/java/com/diffplug/spotless/cli/core/SpotlessActionContext.java

@@ -15,20 +15,32 @@
  */
 package com.diffplug.spotless.cli.core;
 
+import java.io.File;
+import java.nio.file.Path;
 import java.util.Objects;
 
 import javax.annotation.Nonnull;
 
 public class SpotlessActionContext {
 
 	private final TargetFileTypeInferer.TargetFileType targetFileType;
+	private final FileResolver fileResolver;
 
-	public SpotlessActionContext(@Nonnull TargetFileTypeInferer.TargetFileType targetFileType) {
+	public SpotlessActionContext(@Nonnull TargetFileTypeInferer.TargetFileType targetFileType, @Nonnull FileResolver fileResolver) {
 		this.targetFileType = Objects.requireNonNull(targetFileType);
+		this.fileResolver = fileResolver;
 	}
 
 	@Nonnull
 	public TargetFileTypeInferer.TargetFileType targetFileType() {
 		return targetFileType;
 	}
+
+	public File resolveFile(File file) {
+		return fileResolver.resolveFile(file);
+	}
+
+	public Path resolvePath(Path path) {
+		return fileResolver.resolvePath(path);
+	}
 }

cli/src/main/java/com/diffplug/spotless/cli/core/TargetResolver.java

@@ -29,17 +29,23 @@
 import java.util.ArrayList;
 import java.util.EnumSet;
 import java.util.List;
+import java.util.Objects;
 import java.util.stream.Collectors;
 import java.util.stream.Stream;
 
+import javax.annotation.Nonnull;
+
 import com.diffplug.spotless.ThrowingEx;
 
 public class TargetResolver {
 
 	private final List<String> targets;
 
-	public TargetResolver(List<String> targets) {
-		this.targets = targets;
+	private final FileResolver fileResolver;
+
+	public TargetResolver(@Nonnull Path baseDir, @Nonnull List<String> targets) {
+		this.fileResolver = new FileResolver(baseDir);
+		this.targets = Objects.requireNonNull(targets);
 	}
 
 	public Stream<Path> resolveTargets() {
@@ -54,7 +60,15 @@ private Stream<Path> resolveTarget(String target) {
 		if (isGlob) {
 			return resolveGlob(target);
 		}
-		return resolveDir(Path.of(target));
+		Path targetPath = fileResolver.resolvePath(Path.of(target));
+		if (Files.isReadable(targetPath)) {
+			return Stream.of(targetPath);
+		}
+		if (Files.isDirectory(targetPath)) {
+			return resolveDir(targetPath);
+		}
+		// TODO log warn?
+		return Stream.empty();
 	}
 
 	private Stream<Path> resolveDir(Path startDir) {
@@ -81,7 +95,7 @@ private Stream<Path> resolveGlob(String glob) {
 				.takeWhile(not(TargetResolver::isGlobPathPart))
 				.collect(Collectors.toList());
 
-		startDir = Path.of(glob.startsWith(File.separator) ? File.separator : "", startDirParts.toArray(String[]::new));
+		startDir = Path.of(glob.startsWith(File.separator) ? File.separator : fileResolver.baseDir().toString(), startDirParts.toArray(String[]::new));
 		globPart = Stream.of(parts)
 				.skip(startDirParts.size())
 				.collect(Collectors.joining(File.separator));

cli/src/main/java/com/diffplug/spotless/cli/steps/generic/LicenseHeader.java

@@ -52,17 +52,17 @@ static class LicenseHeaderSourceOption {
 	@Nonnull
 	@Override
 	public List<FormatterStep> prepareFormatterSteps(SpotlessActionContext context) {
-		FormatterStep licenseHeaderStep = LicenseHeaderStep.headerDelimiter(headerSource(), delimiter(context.targetFileType()))
+		FormatterStep licenseHeaderStep = LicenseHeaderStep.headerDelimiter(headerSource(context), delimiter(context.targetFileType()))
 				// TODO add more config options
 				.build();
 		return List.of(licenseHeaderStep);
 	}
 
-	private ThrowingEx.Supplier<String> headerSource() {
+	private ThrowingEx.Supplier<String> headerSource(SpotlessActionContext context) {
 		if (licenseHeaderSourceOption.header != null) {
 			return () -> licenseHeaderSourceOption.header;
 		} else {
-			return () -> ThrowingEx.get(() -> Files.readString(licenseHeaderSourceOption.headerFile.toPath()));
+			return () -> ThrowingEx.get(() -> Files.readString(context.resolveFile(licenseHeaderSourceOption.headerFile).toPath()));
 		}
 	}
 

cli/src/test/java/com/diffplug/spotless/cli/CLIIntegrationHarness.java

@@ -0,0 +1,49 @@
+/*
+ * 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.cli;
+
+import java.io.IOException;
+
+import org.junit.jupiter.api.BeforeEach;
+
+import com.diffplug.spotless.ResourceHarness;
+
+public abstract class CLIIntegrationHarness extends ResourceHarness {
+
+	/**
+	 * Each test gets its own temp folder, and we create a gradle
+	 * build there and run it.
+	 * <p>
+	 * Because those test folders don't have a .gitattributes file,
+	 * git (on windows) will default to \r\n. So now if you read a
+	 * test file from the spotless test resources, and compare it
+	 * to a build result, the line endings won't match.
+	 * <p>
+	 * By sticking this .gitattributes file into the test directory,
+	 * we ensure that the default Spotless line endings policy of
+	 * GIT_ATTRIBUTES will use \n, so that tests match the test
+	 * resources on win and linux.
+	 */
+	@BeforeEach
+	void gitAttributes() throws IOException {
+		setFile(".gitattributes").toContent("* text eol=lf");
+	}
+
+	protected SpotlessCLIRunner cliRunner() {
+		return SpotlessCLIRunner.create()
+				.withWorkingDir(rootFolder());
+	}
+}

cli/src/test/java/com/diffplug/spotless/cli/SpotlessCLIHelpAndVersionTest.java

@@ -0,0 +1,36 @@
+/*
+ * 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.cli;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+import org.junit.jupiter.api.Test;
+
+public class SpotlessCLIHelpAndVersionTest extends CLIIntegrationHarness {
+
+	@Test
+	void testHelp() {
+		SpotlessCLIRunner.Result result = cliRunner().withOption("--help").run();
+		assertThat(result.stdOut()).contains("Usage: spotless");
+	}
+
+	@Test
+	void testVersion() {
+		SpotlessCLIRunner.Result result = cliRunner().withOption("--version").run();
+		assertThat(result.stdOut()).contains("Spotless CLI version");
+	}
+
+}