Add a way to test for lints, and use that to bring back FenceStepTest.broken

Author: nedtwigg

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

@@ -58,6 +58,32 @@ public Map<FormatterStep, List<Lint>> getLints(Formatter formatter) {
 		return result;
 	}
 
+	public String asString(File file, Formatter formatter) {
+		if (!isHasLints()) {
+			return "(none)";
+		} else {
+			StringBuilder result = new StringBuilder();
+			for (int i = 0; i < lintsPerStep.size(); i++) {
+				List<Lint> lints = lintsPerStep.get(i);
+				if (lints != null) {
+					FormatterStep step = formatter.getSteps().get(i);
+					for (Lint lint : lints) {
+						result.append(file.getName()).append(":").append(lint.getLineStart());
+						if (lint.getLineEnd() != lint.getLineStart()) {
+							result.append("-").append(lint.getLineEnd());
+						}
+						result.append(" ");
+						result.append(step.getName()).append("(").append(lint.getCode()).append(") ");
+						result.append(lint.getMsg());
+						result.append("\n");
+					}
+				}
+			}
+			result.setLength(result.length() - 1);
+			return result.toString();
+		}
+	}
+
 	public static LintState of(Formatter formatter, File file) throws IOException {
 		return of(formatter, file, Files.readAllBytes(file.toPath()));
 	}

testlib/src/main/java/com/diffplug/spotless/StepHarness.java

@@ -24,6 +24,9 @@
 import org.assertj.core.api.AbstractStringAssert;
 import org.assertj.core.api.Assertions;
 
+import com.diffplug.selfie.Selfie;
+import com.diffplug.selfie.StringSelfie;
+
 /** An api for testing a {@code FormatterStep} that doesn't depend on the File path. DO NOT ADD FILE SUPPORT TO THIS, use {@link StepHarnessWithFile} if you need that. */
 public class StepHarness extends StepHarnessBase {
 	private StepHarness(Formatter formatter, RoundTrip roundTrip) {
@@ -111,4 +114,11 @@ public AbstractStringAssert<?> testExceptionMsg(String before) {
 			}
 		}
 	}
+
+	public StringSelfie expectLintsOf(String before) {
+		LintState state = LintState.of(formatter(), Formatter.NO_FILE_SENTINEL, before.getBytes(formatter().getEncoding()));
+		String assertAgainst = state.asString(Formatter.NO_FILE_SENTINEL, formatter());
+		String cleaned = assertAgainst.replace("NO_FILE_SENTINEL:", "");
+		return Selfie.expectSelfie(cleaned);
+	}
 }

testlib/src/test/java/com/diffplug/spotless/generic/FenceStepTest.java

@@ -18,14 +18,12 @@
 import java.io.File;
 import java.util.Arrays;
 
-import org.junit.jupiter.api.Disabled;
 import org.junit.jupiter.api.Test;
 
 import com.diffplug.common.base.StringPrinter;
 import com.diffplug.spotless.FormatterStep;
 import com.diffplug.spotless.ResourceHarness;
 import com.diffplug.spotless.StepHarness;
-import com.diffplug.spotless.tag.ForLintRefactor;
 
 class FenceStepTest extends ResourceHarness {
 	@Test
@@ -82,18 +80,16 @@ void multiple() {
 						"1 2 3"));
 	}
 
-	@Disabled
-	@ForLintRefactor
 	@Test
 	void broken() {
 		FormatterStep fence = FenceStep.named("fence").openClose("spotless:off", "spotless:on")
-				.preserveWithin(Arrays.asList(ToCaseStep.upper()));
+				.preserveWithin(Arrays.asList(ReplaceStep.create("replace", "spotless:on", "REMOVED")));
 		// this fails because uppercase turns spotless:off into SPOTLESS:OFF, etc
-		StepHarness.forStepNoRoundtrip(fence).testExceptionMsg(StringPrinter.buildStringFromLines("A B C",
+		StepHarness.forStep(fence).expectLintsOf(StringPrinter.buildStringFromLines("A B C",
 				"spotless:off",
 				"D E F",
 				"spotless:on",
-				"G H I")).isEqualTo("An intermediate step removed a match of spotless:off spotless:on");
+				"G H I")).toBe("1-6 fence(fenceRemoved) An intermediate step removed a match of spotless:off spotless:on");
 	}
 
 	@Test