ErrorShouldRethrowTest now tests the new lint messages.

Author: nedtwigg

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

@@ -21,14 +21,15 @@
 import java.util.Iterator;
 import java.util.LinkedHashMap;
 import java.util.List;
+import java.util.Objects;
 
 import javax.annotation.Nullable;
 
 public class LintState {
 	private final DirtyState dirtyState;
-	private final @Nullable List<List<Lint>> lintsPerStep;
+	private @Nullable List<List<Lint>> lintsPerStep;
 
-	private LintState(DirtyState dirtyState, @Nullable List<List<Lint>> lintsPerStep) {
+	LintState(DirtyState dirtyState, @Nullable List<List<Lint>> lintsPerStep) {
 		this.dirtyState = dirtyState;
 		this.lintsPerStep = lintsPerStep;
 	}
@@ -67,6 +68,9 @@ public void removeSuppressedLints(Formatter formatter, String relativePath, List
 		if (lintsPerStep == null) {
 			return;
 		}
+		if (formatter.getSteps().size() != lintsPerStep.size()) {
+			throw new IllegalStateException("LintState was created with a different formatter!");
+		}
 		for (int i = 0; i < lintsPerStep.size(); i++) {
 			FormatterStep step = formatter.getSteps().get(i);
 			List<Lint> lints = lintsPerStep.get(i);
@@ -83,6 +87,10 @@ public void removeSuppressedLints(Formatter formatter, String relativePath, List
 				}
 				if (lints.isEmpty()) {
 					lintsPerStep.set(i, null);
+					if (lintsPerStep.stream().allMatch(Objects::isNull)) {
+						lintsPerStep = null;
+						return;
+					}
 				}
 			}
 		}

plugin-gradle/src/test/java/com/diffplug/gradle/spotless/ErrorShouldRethrowTest.java

@@ -20,14 +20,11 @@
 import java.util.Arrays;
 import java.util.List;
 
-import org.assertj.core.api.Assertions;
 import org.gradle.testkit.runner.BuildResult;
-import org.gradle.testkit.runner.TaskOutcome;
 import org.junit.jupiter.api.Test;
 
-import com.diffplug.common.base.CharMatcher;
-import com.diffplug.common.base.Splitter;
-import com.diffplug.spotless.LineEnding;
+import com.diffplug.selfie.Selfie;
+import com.diffplug.selfie.StringSelfie;
 
 /** Tests the desired behavior from https://github.com/diffplug/spotless/issues/46. */
 class ErrorShouldRethrowTest extends GradleIntegrationHarness {
@@ -41,7 +38,7 @@ private void writeBuild(String... toInsert) throws IOException {
 		lines.add("    format 'misc', {");
 		lines.add("        lineEndings 'UNIX'");
 		lines.add("        target file('README.md')");
-		lines.add("        custom 'no swearing', {");
+		lines.add("        custom 'noSwearingStep', {");
 		lines.add("             if (it.toLowerCase(Locale.ROOT).contains('fubar')) {");
 		lines.add("                 throw com.diffplug.spotless.Lint.atUndefinedLine('swearing', 'No swearing!').shortcut();");
 		lines.add("             }");
@@ -56,7 +53,7 @@ void passesIfNoException() throws Exception {
 				"    } // format",
 				"}     // spotless");
 		setFile("README.md").toContent("This code is fun.");
-		runWithSuccess("> Task :spotlessMisc");
+		expectSuccess();
 	}
 
 	@Test
@@ -65,11 +62,15 @@ void anyExceptionShouldFail() throws Exception {
 				"    } // format",
 				"}     // spotless");
 		setFile("README.md").toContent("This code is fubar.");
-		runWithFailure(
-				"> Task :spotlessMisc FAILED\n" +
-						"Step 'no swearing' found problem in 'README.md':\n" +
-						"LINE_UNDEFINED: (swearing) No swearing!\n" +
-						"java.lang.Throwable: LINE_UNDEFINED: (swearing) No swearing!");
+		expectFailureAndConsoleToBe().toBe("> Task :spotlessMisc",
+				"> Task :spotlessMiscCheck FAILED",
+				"",
+				"FAILURE: Build failed with an exception.",
+				"",
+				"* What went wrong:",
+				"Execution failed for task ':spotlessMiscCheck'.",
+				"> There were 1 lint error(s), they must be fixed or suppressed.",
+				"  README.md:LINE_UNDEFINED noSwearingStep(swearing) No swearing!");
 	}
 
 	@Test
@@ -79,17 +80,17 @@ void unlessEnforceCheckIsFalse() throws Exception {
 				"    enforceCheck false",
 				"}     // spotless");
 		setFile("README.md").toContent("This code is fubar.");
-		runWithSuccess("> Task :processResources NO-SOURCE");
+		expectSuccess();
 	}
 
+	@Test
 	void unlessExemptedByStep() throws Exception {
 		writeBuild(
 				"        ignoreErrorForStep 'no swearing'",
 				"    } // format",
 				"}     // spotless");
 		setFile("README.md").toContent("This code is fubar.");
-		runWithSuccess("> Task :spotlessMisc\n" +
-				"Unable to apply step 'no swearing' to 'README.md'");
+		expectSuccess();
 	}
 
 	@Test
@@ -99,8 +100,7 @@ void unlessExemptedByPath() throws Exception {
 				"    } // format",
 				"}     // spotless");
 		setFile("README.md").toContent("This code is fubar.");
-		runWithSuccess("> Task :spotlessMisc\n" +
-				"Unable to apply step 'no swearing' to 'README.md'");
+		expectSuccess();
 	}
 
 	@Test
@@ -111,33 +111,28 @@ void failsIfNeitherStepNorFileExempted() throws Exception {
 				"    } // format",
 				"}     // spotless");
 		setFile("README.md").toContent("This code is fubar.");
-		runWithFailure("> Task :spotlessMisc FAILED\n" +
-				"Step 'no swearing' found problem in 'README.md':\n" +
-				"LINE_UNDEFINED: (swearing) No swearing!\n" +
-				"java.lang.Throwable: LINE_UNDEFINED: (swearing) No swearing!");
+		expectFailureAndConsoleToBe().toBe("> Task :spotlessMisc",
+				"> Task :spotlessMiscCheck FAILED",
+				"",
+				"FAILURE: Build failed with an exception.",
+				"",
+				"* What went wrong:",
+				"Execution failed for task ':spotlessMiscCheck'.",
+				"> There were 1 lint error(s), they must be fixed or suppressed.",
+				"  README.md:LINE_UNDEFINED noSwearingStep(swearing) No swearing!");
 	}
 
-	private void runWithSuccess(String expectedToStartWith) throws Exception {
-		BuildResult result = gradleRunner().withArguments("check").build();
-		assertResultAndMessages(result, TaskOutcome.SUCCESS, expectedToStartWith);
+	private void expectSuccess() throws Exception {
+		gradleRunner().withArguments("check", "--stacktrace").build();
 	}
 
-	private void runWithFailure(String expectedToStartWith) throws Exception {
+	private StringSelfie expectFailureAndConsoleToBe() throws Exception {
 		BuildResult result = gradleRunner().withArguments("check").buildAndFail();
-		assertResultAndMessages(result, TaskOutcome.FAILED, expectedToStartWith);
-	}
-
-	private void assertResultAndMessages(BuildResult result, TaskOutcome outcome, String expectedToStartWith) {
 		String output = result.getOutput();
 		int register = output.indexOf(":spotlessInternalRegisterDependencies");
 		int firstNewlineAfterThat = output.indexOf('\n', register + 1);
-		String useThisToMatch = output.substring(firstNewlineAfterThat);
-
-		int numNewlines = CharMatcher.is('\n').countIn(expectedToStartWith);
-		List<String> actualLines = Splitter.on('\n').splitToList(LineEnding.toUnix(useThisToMatch.trim()));
-		String actualStart = String.join("\n", actualLines.subList(0, numNewlines + 1));
-		Assertions.assertThat(actualStart).isEqualTo(expectedToStartWith);
-		Assertions.assertThat(outcomes(result, outcome).size() + outcomes(result, TaskOutcome.UP_TO_DATE).size() + outcomes(result, TaskOutcome.NO_SOURCE).size())
-				.isEqualTo(outcomes(result).size());
+		int firstTry = output.indexOf("\n* Try:");
+		String useThisToMatch = output.substring(firstNewlineAfterThat, firstTry).trim();
+		return Selfie.expectSelfie(useThisToMatch);
 	}
 }