Add a LintSuppressionTest

Author: nedtwigg

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

@@ -49,21 +49,15 @@ public void setShortCode(String shortCode) {
 		this.shortCode = Objects.requireNonNull(shortCode);
 	}
 
-	public boolean suppresses(String relativePath, FormatterStep step, Lint lint) {
-		return !allows(relativePath, step, lint);
-	}
-
-	private boolean allows(String relativePath, FormatterStep step, Lint lint) {
-		if (!file.equals(ALL) && !file.equals(relativePath)) {
-			return false;
-		}
-		if (!this.step.equals(ALL) && !this.step.equals(step.getName())) {
-			return false;
-		}
-		if (!this.shortCode.equals(ALL) && !this.shortCode.equals(lint.getRuleId())) {
-			return false;
+	public boolean suppresses(String relativePath, FormatterStep formatterStep, Lint lint) {
+		if (file.equals(ALL) || file.equals(relativePath)) {
+			if (step.equals(ALL) || formatterStep.getName().equals(this.step)) {
+				if (shortCode.equals(ALL) || lint.getRuleId().equals(this.shortCode)) {
+					return true;
+				}
+			}
 		}
-		return true;
+		return false;
 	}
 
 	public void ensureDoesNotSuppressAll() {

lib/src/test/java/com/diffplug/spotless/LintSuppressionTest.java

@@ -0,0 +1,84 @@
+/*
+ * 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 static org.assertj.core.api.Assertions.assertThat;
+
+import java.nio.charset.StandardCharsets;
+import java.util.ArrayList;
+import java.util.List;
+import java.util.function.Consumer;
+
+import org.assertj.core.api.AbstractBooleanAssert;
+import org.junit.jupiter.api.Test;
+
+import com.diffplug.spotless.generic.EndWithNewlineStep;
+
+public class LintSuppressionTest {
+	private LintState dummyLintState() {
+		var lints = new ArrayList<Lint>();
+		lints.add(Lint.atLine(2, "66", "Order 66"));
+		var perStep = new ArrayList<List<Lint>>();
+		perStep.add(lints);
+		return new LintState(DirtyState.clean(), perStep);
+	}
+
+	private Formatter formatter() {
+		return Formatter.builder()
+				.lineEndingsPolicy(LineEnding.UNIX.createPolicy())
+				.encoding(StandardCharsets.UTF_8)
+				.steps(List.of(EndWithNewlineStep.create()))
+				.build();
+	}
+
+	@Test
+	public void testMatchSingle() {
+		var noSuppressions = dummyLintState();
+		noSuppressions.removeSuppressedLints(formatter(), "file", List.of());
+		assertThat(noSuppressions.isHasLints()).isTrue();
+		removesLint(s -> s.setStep("blah")).isFalse();
+		removesLint(s -> s.setStep("endWithNewline")).isTrue();
+		removesLint(s -> s.setFile("blah")).isFalse();
+		removesLint(s -> s.setFile("testFile")).isTrue();
+		removesLint(s -> s.setShortCode("blah")).isFalse();
+		removesLint(s -> s.setShortCode("66")).isTrue();
+	}
+
+	@Test
+	public void testMatchDouble() {
+		removesLint(s -> {
+			s.setStep("endWithNewline");
+			s.setShortCode("blah");
+		}).isFalse();
+		removesLint(s -> {
+			s.setStep("blah");
+			s.setShortCode("66");
+		}).isFalse();
+		removesLint(s -> {
+			s.setStep("endWithNewline");
+			s.setShortCode("66");
+		}).isTrue();
+	}
+
+	private AbstractBooleanAssert<?> removesLint(Consumer<LintSuppression> suppression) {
+		var s = new LintSuppression();
+		suppression.accept(s);
+
+		var ls = dummyLintState();
+		ls.removeSuppressedLints(formatter(), "testFile", List.of(s));
+		return assertThat(!ls.isHasLints());
+	}
+}