Skip to content

Commit e71db1f

Browse files
cushonError Prone Team
cushon
authored and
Error Prone Team
committed
Check that --should-stop=ifError=FLOW is set when EP is set up using the -Xplugin integration
See #4595 (comment) PiperOrigin-RevId: 690786174
1 parent d67bc15 commit e71db1f

File tree

5 files changed

+72
-12
lines changed

5 files changed

+72
-12
lines changed

‎check_api/src/main/java/com/google/errorprone/BaseErrorProneJavaCompiler.java

+12-4
Original file line numberDiff line numberDiff line change
@@ -84,6 +84,7 @@ static void addTaskListener(
8484
JavacTask javacTask, ScannerSupplier scannerSupplier, ErrorProneOptions errorProneOptions) {
8585
Context context = ((BasicJavacTask) javacTask).getContext();
8686
checkCompilePolicy(Options.instance(context).get("compilePolicy"));
87+
checkShouldStopIfErrorPolicy(Options.instance(context).get("should-stop.ifError"));
8788
setupMessageBundle(context);
8889
RefactoringCollection[] refactoringCollection = {null};
8990
javacTask.addTaskListener(
@@ -196,21 +197,28 @@ private static ImmutableList<String> setCompilePolicyToByFile(ImmutableList<Stri
196197
return ImmutableList.<String>builder().addAll(args).add("-XDcompilePolicy=simple").build();
197198
}
198199

199-
private static void checkShouldStopIfErrorPolicy(String arg) {
200-
String value = arg.substring(arg.lastIndexOf('=') + 1);
200+
private static void checkShouldStopIfErrorPolicy(String value) {
201+
if (value == null) {
202+
throw new InvalidCommandLineOptionException(
203+
"The default --should-stop=ifError policy (INIT) is not supported by Error Prone,"
204+
+ " pass --should-stop=ifError=FLOW instead");
205+
}
201206
CompileState state = CompileState.valueOf(value);
202207
if (CompileState.FLOW.isAfter(state)) {
203208
throw new InvalidCommandLineOptionException(
204209
String.format(
205-
"%s is not supported by Error Prone, pass --should-stop=ifError=FLOW instead", arg));
210+
"--should-stop=ifError=%s is not supported by Error Prone, pass"
211+
+ " --should-stop=ifError=FLOW instead",
212+
value));
206213
}
207214
}
208215

209216
private static ImmutableList<String> setShouldStopIfErrorPolicyToFlow(
210217
ImmutableList<String> args) {
211218
for (String arg : args) {
212219
if (arg.startsWith("--should-stop=ifError") || arg.startsWith("-XDshould-stop.ifError")) {
213-
checkShouldStopIfErrorPolicy(arg);
220+
String value = arg.substring(arg.lastIndexOf('=') + 1);
221+
checkShouldStopIfErrorPolicy(value);
214222
return args; // don't do anything if a valid policy is already set
215223
}
216224
}

‎core/src/test/java/com/google/errorprone/ErrorProneCompilerIntegrationTest.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -758,6 +758,6 @@ public void stopPolicy_init_xD() {
758758
InvalidCommandLineOptionException.class,
759759
() ->
760760
compiler.compile(new String[] {"-XDshould-stop.ifError=INIT"}, ImmutableList.of()));
761-
assertThat(e).hasMessageThat().contains("-XDshould-stop.ifError=INIT is not supported");
761+
assertThat(e).hasMessageThat().contains("--should-stop=ifError=INIT is not supported");
762762
}
763763
}

‎core/src/test/java/com/google/errorprone/ErrorProneJavacPluginTest.java

+55-5
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,8 @@ public void hello() throws IOException {
100100
null,
101101
fileManager,
102102
diagnosticCollector,
103-
ImmutableList.of("-Xplugin:ErrorProne", "-XDcompilePolicy=byfile"),
103+
ImmutableList.of(
104+
"-Xplugin:ErrorProne", "-XDcompilePolicy=byfile", "--should-stop=ifError=FLOW"),
104105
ImmutableList.of(),
105106
fileManager.getJavaFileObjects(source));
106107
assertThat(task.call()).isFalse();
@@ -144,7 +145,8 @@ public void applyFixes() throws IOException {
144145
ImmutableList.of(
145146
"-Xplugin:ErrorProne"
146147
+ " -XepPatchChecks:MissingOverride -XepPatchLocation:IN_PLACE",
147-
"-XDcompilePolicy=byfile"),
148+
"-XDcompilePolicy=byfile",
149+
"--should-stop=ifError=FLOW"),
148150
ImmutableList.of(),
149151
fileManager.getJavaFileObjects(fileA, fileB));
150152
assertWithMessage(Joiner.on('\n').join(diagnosticCollector.getDiagnostics()))
@@ -203,7 +205,8 @@ public void applyToPatchFile() throws IOException {
203205
"-Xplugin:ErrorProne"
204206
+ " -XepPatchChecks:MissingOverride -XepPatchLocation:"
205207
+ patchDir,
206-
"-XDcompilePolicy=byfile"),
208+
"-XDcompilePolicy=byfile",
209+
"--should-stop=ifError=FLOW"),
207210
ImmutableList.of(),
208211
fileManager.getJavaFileObjects(fileA, fileB));
209212
assertWithMessage(Joiner.on('\n').join(diagnosticCollector.getDiagnostics()))
@@ -254,7 +257,8 @@ public void explicitBadPolicyGiven() throws IOException {
254257
new PrintWriter(sw, true),
255258
fileManager,
256259
diagnosticCollector,
257-
ImmutableList.of("-XDcompilePolicy=bytodo", "-Xplugin:ErrorProne"),
260+
ImmutableList.of(
261+
"-XDcompilePolicy=bytodo", "--should-stop=ifError=FLOW", "-Xplugin:ErrorProne"),
258262
ImmutableList.of(),
259263
fileManager.getJavaFileObjects(source));
260264
RuntimeException expected = assertThrows(RuntimeException.class, () -> task.call());
@@ -375,7 +379,8 @@ public void compilesWithFix() throws IOException {
375379
diagnosticCollector,
376380
ImmutableList.of(
377381
"-Xplugin:ErrorProne -XepDisableAllChecks -Xep:TestCompilesWithFix:ERROR",
378-
"-XDcompilePolicy=byfile"),
382+
"-XDcompilePolicy=byfile",
383+
"--should-stop=ifError=FLOW"),
379384
ImmutableList.of(),
380385
fileManager.getJavaFileObjects(source));
381386
assertThat(task.call()).isFalse();
@@ -385,4 +390,49 @@ public void compilesWithFix() throws IOException {
385390
.collect(onlyElement());
386391
assertThat(diagnostic.getMessage(ENGLISH)).contains("[TestCompilesWithFix]");
387392
}
393+
394+
@Test
395+
public void noShouldStopIfErrorPolicy() throws IOException {
396+
FileSystem fileSystem = Jimfs.newFileSystem(Configuration.unix());
397+
Path source = fileSystem.getPath("Test.java");
398+
Files.writeString(source, "class Test {}");
399+
JavacFileManager fileManager = new JavacFileManager(new Context(), false, UTF_8);
400+
DiagnosticCollector<JavaFileObject> diagnosticCollector = new DiagnosticCollector<>();
401+
StringWriter sw = new StringWriter();
402+
JavacTask task =
403+
JavacTool.create()
404+
.getTask(
405+
new PrintWriter(sw, true),
406+
fileManager,
407+
diagnosticCollector,
408+
ImmutableList.of("-Xplugin:ErrorProne", "-XDcompilePolicy=byfile"),
409+
ImmutableList.of(),
410+
fileManager.getJavaFileObjects(source));
411+
RuntimeException expected = assertThrows(RuntimeException.class, task::call);
412+
assertThat(expected)
413+
.hasMessageThat()
414+
.contains("The default --should-stop=ifError policy (INIT) is not supported");
415+
}
416+
417+
@Test
418+
public void shouldStopIfErrorPolicyInit() throws IOException {
419+
FileSystem fileSystem = Jimfs.newFileSystem(Configuration.unix());
420+
Path source = fileSystem.getPath("Test.java");
421+
Files.writeString(source, "class Test {}");
422+
JavacFileManager fileManager = new JavacFileManager(new Context(), false, UTF_8);
423+
DiagnosticCollector<JavaFileObject> diagnosticCollector = new DiagnosticCollector<>();
424+
StringWriter sw = new StringWriter();
425+
JavacTask task =
426+
JavacTool.create()
427+
.getTask(
428+
new PrintWriter(sw, true),
429+
fileManager,
430+
diagnosticCollector,
431+
ImmutableList.of(
432+
"-Xplugin:ErrorProne", "-XDcompilePolicy=byfile", "--should-stop=ifError=INIT"),
433+
ImmutableList.of(),
434+
fileManager.getJavaFileObjects(source));
435+
RuntimeException expected = assertThrows(RuntimeException.class, task::call);
436+
assertThat(expected).hasMessageThat().contains("--should-stop=ifError=INIT is not supported");
437+
}
388438
}

‎core/src/test/java/com/google/errorprone/VisitorStateTest.java

+2-1
Original file line numberDiff line numberDiff line change
@@ -180,7 +180,8 @@ public void memoizeCannotAccessTreePath() throws IOException {
180180
ImmutableList.of(
181181
"-Xplugin:ErrorProne -XepDisableAllChecks"
182182
+ " -Xep:CheckThatTriesToMemoizeBasedOnTreePath:ERROR",
183-
"-XDcompilePolicy=byfile"),
183+
"-XDcompilePolicy=byfile",
184+
"--should-stop=ifError=FLOW"),
184185
ImmutableList.of(),
185186
fileManager.getJavaFileObjects(source));
186187
assertThat(task.call()).isFalse();

‎core/src/test/java/com/google/errorprone/bugpatterns/UnicodeInCodeTest.java

+2-1
Original file line numberDiff line numberDiff line change
@@ -162,7 +162,8 @@ public void asciiSub() {
162162
null,
163163
fileManager,
164164
diagnosticCollector,
165-
ImmutableList.of("-Xplugin:ErrorProne", "-XDcompilePolicy=simple"),
165+
ImmutableList.of(
166+
"-Xplugin:ErrorProne", "-XDcompilePolicy=simple", "--should-stop=ifError=FLOW"),
166167
ImmutableList.of(),
167168
ImmutableList.of(
168169
new SimpleJavaFileObject(

0 commit comments

Comments
 (0)