Skip to content

Update MisleadingEscapedSpace to account for CRLF line endings. #5663

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
copybara-service merged 1 commit into from
Mar 26, 2026
+98 −106
Merged

Update MisleadingEscapedSpace to account for CRLF line endings. #5663

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions core/src/main/java/com/google/errorprone/bugpatterns/MisleadingEscapedSpace.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,7 @@ public Description matchLiteral(LiteralTree tree, VisitorState state) {
for (int i = 0; i < literal.length(); ++i) {
switch (literal.charAt(i)) {
case '\n':
case '\r':
seenEscape = false;
break;
case '\\':
Expand Down
203 changes: 97 additions & 106 deletions core/src/test/java/com/google/errorprone/bugpatterns/MisleadingEscapedSpaceTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,152 +17,143 @@
package com.google.errorprone.bugpatterns;

import com.google.errorprone.CompilationTestHelper;
import com.google.testing.junit.testparameterinjector.TestParameter;
import com.google.testing.junit.testparameterinjector.TestParameterInjector;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.junit.runners.JUnit4;

@RunWith(JUnit4.class)
@RunWith(TestParameterInjector.class)
public final class MisleadingEscapedSpaceTest {
private final CompilationTestHelper testHelper =
CompilationTestHelper.newInstance(MisleadingEscapedSpace.class, getClass());

private enum LineSeparator {
CRLF("\r\n"),
LF("\n");

final String separator;

LineSeparator(String separator) {
this.separator = separator;
}
}

@TestParameter private LineSeparator lineSeparator;

private void test(String text) {
testHelper.addSourceLines("Test.class", text.replace("\n", lineSeparator.separator)).doTest();
}

@Test
public void misleadingEscape() {
testHelper
.addSourceLines(
"Test.class",
"""
class Test {
// BUG: Diagnostic contains:
private static final String FOO = " \\s ";
}
""")
.doTest();
test(
"""
class Test {
// BUG: Diagnostic contains:
private static final String FOO = " \\s ";
}
""");
}

@Test
public void literalBackslashS() {
testHelper
.addSourceLines(
"Test.class",
"""
class Test {
private static final String FOO = " \\\\s ";
}
""")
.doTest();
test(
"""
class Test {
private static final String FOO = " \\\\s ";
}
""");
}

@Test
public void asSingleCharacter_misleading() {
testHelper
.addSourceLines(
"Test.class",
"""
class Test {
// BUG: Diagnostic contains:
private static final char x = '\\s';
}
""")
.doTest();
test(
"""
class Test {
// BUG: Diagnostic contains:
private static final char x = '\\s';
}
""");
}

@Test
public void withinTextBlock_notAtEndOfLine_misleading() {
testHelper
.addSourceLines(
"Test.class",
"""
class Test {
private static final String FOO =
// BUG: Diagnostic contains:
\"""
foo \\s bar
\""";
private static final String BAZ =
// BUG: Diagnostic contains:
\"""
foo \\s
bar \\s baz
\""";
}
""")
.doTest();
test(
"""
class Test {
private static final String FOO =
// BUG: Diagnostic contains:
\"""
foo \\s bar
\""";
private static final String BAZ =
// BUG: Diagnostic contains:
\"""
foo \\s
bar \\s baz
\""";
}
""");
}

@Test
public void atEndOfLine_notMisleading() {
testHelper
.addSourceLines(
"Test.class",
"""
class Test {
private static final String FOO =
\"""
foo \\s
bar \\s
\""";
}
""")
.doTest();
test(
"""
class Test {
private static final String FOO =
\"""
foo \\s
bar \\s
\""";
}
""");
}

@Test
public void multipleAtEndOfLine_notMisleading() {
testHelper
.addSourceLines(
"Test.class",
"""
class Test {
private static final String FOO =
\"""
foo \\s\\s\\s\\s
\""";
}
""")
.doTest();
test(
"""
class Test {
private static final String FOO =
\"""
foo \\s\\s\\s\\s
\""";
}
""");
}

@Test
public void withinCommentInBrokenUpString_noFinding() {
testHelper
.addSourceLines(
"Test.class",
"""
class Test {
private static final String FOO = "foo" + /* \\s */ " bar";
}
""")
.doTest();
test(
"""
class Test {
private static final String FOO = "foo" + /* \\s */ " bar";
}
""");
}

@Test
public void atEndOfString_noFinding() {
testHelper
.addSourceLines(
"Test.class",
"""
class Test {
private static final String FOO =
\"""
foo
bar\\s\""";
}
""")
.doTest();
test(
"""
class Test {
private static final String FOO =
\"""
foo
bar\\s\""";
}
""");
}

@Test
public void escapedSpaceAtEndOfString() {
testHelper
.addSourceLines(
"Test.class",
"""
class Test {
// BUG: Diagnostic contains:
private static final String FOO = "foo\\s";
}
""")
.doTest();
test(
"""
class Test {
// BUG: Diagnostic contains:
private static final String FOO = "foo\\s";
}
""");
}
}
Loading