// Copyright 2011 The Bazel Authors. All Rights Reserved.
//
// 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.google.devtools.build.buildjar.javac.plugins.errorprone;
import com.google.common.annotations.VisibleForTesting;
import com.google.common.collect.ImmutableList;
import com.google.devtools.build.buildjar.InvalidCommandLineException;
import com.google.devtools.build.buildjar.javac.plugins.BlazeJavaCompilerPlugin;
import com.google.errorprone.ErrorProneAnalyzer;
import com.google.errorprone.ErrorProneError;
import com.google.errorprone.ErrorProneOptions;
import com.google.errorprone.InvalidCommandLineOptionException;
import com.google.errorprone.scanner.BuiltInCheckerSuppliers;
import com.google.errorprone.scanner.ScannerSupplier;
import com.sun.source.util.TaskEvent;
import com.sun.source.util.TaskEvent.Kind;
import com.sun.tools.javac.comp.AttrContext;
import com.sun.tools.javac.comp.Env;
import com.sun.tools.javac.main.JavaCompiler;
import com.sun.tools.javac.util.Context;
import com.sun.tools.javac.util.JavacMessages;
import com.sun.tools.javac.util.Log;
import java.util.Arrays;
import java.util.List;
/**
* A plugin for BlazeJavaCompiler that performs Error Prone analysis. Error Prone is a static
* analysis framework that we use to perform some simple static checks on Java code.
*/
public final class ErrorPronePlugin extends BlazeJavaCompilerPlugin {
private final ScannerSupplier scannerSupplier;
private final boolean testOnly;
/**
* Constructs an {@link ErrorPronePlugin} instance with the set of checks that are enabled as
* errors in open-source Error Prone.
*/
public ErrorPronePlugin(boolean testOnly) {
this(testOnly, BuiltInCheckerSuppliers.errorChecks());
}
/**
* Constructs an {@link ErrorPronePlugin} with the set of checks that are enabled in {@code
* scannerSupplier}.
*/
public ErrorPronePlugin(boolean testOnly, ScannerSupplier scannerSupplier) {
this.testOnly = testOnly;
this.scannerSupplier = scannerSupplier;
}
private ErrorProneAnalyzer errorProneAnalyzer;
private ErrorProneOptions epOptions;
/** Registers our message bundle. */
public static void setupMessageBundle(Context context) {
JavacMessages.instance(context).add("com.google.errorprone.errors");
}
@Override
public List<String> processArgs(List<String> args) throws InvalidCommandLineException {
// allow javacopts that reference unknown error-prone checks
return processEpOptions(
ImmutableList.<String>builder().addAll(args).add("-XepIgnoreUnknownCheckNames").build());
}
private List<String> processEpOptions(List<String> args) throws InvalidCommandLineException {
try {
epOptions = ErrorProneOptions.processArgs(args);
} catch (InvalidCommandLineOptionException e) {
throw new InvalidCommandLineException(e.getMessage());
}
return Arrays.asList(epOptions.getRemainingArgs());
}
@Override
public void init(Context context, Log log, JavaCompiler compiler) {
super.init(context, log, compiler);
setupMessageBundle(context);
if (epOptions == null) {
epOptions = ErrorProneOptions.empty();
}
errorProneAnalyzer = new ErrorProneAnalyzer(scannerSupplier, epOptions, context);
}
/** Run Error Prone analysis after performing dataflow checks. */
@Override
public void postFlow(Env<AttrContext> env) {
try {
errorProneAnalyzer.finished(new TaskEvent(Kind.ANALYZE, env.toplevel, env.enclClass.sym));
} catch (ErrorProneError e) {
e.logFatalError(log);
// let the exception propagate to javac's main, where it will cause the compilation to
// terminate with Result.ABNORMAL
throw e;
}
}
@VisibleForTesting
public boolean testOnly() {
return testOnly;
}
}