/*
* Copyright 2014 Google Inc. 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.errorprone;
import static com.google.errorprone.BugPattern.Category.ONE_OFF;
import static com.google.errorprone.BugPattern.MaturityLevel.MATURE;
import static com.google.errorprone.BugPattern.SeverityLevel.ERROR;
import static org.hamcrest.Matchers.containsString;
import static org.hamcrest.core.Is.is;
import static org.junit.Assert.assertThat;
import com.google.errorprone.bugpatterns.BugChecker;
import com.google.errorprone.bugpatterns.BugChecker.ReturnTreeMatcher;
import com.google.errorprone.matchers.Description;
import com.sun.source.tree.ReturnTree;
import com.sun.tools.javac.main.Main.Result;
import org.junit.After;
import org.junit.Before;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.junit.runners.JUnit4;
import java.io.ByteArrayOutputStream;
import java.io.PrintStream;
import java.util.List;
import javax.tools.JavaFileObject;
/**
* @author eaftan@google.com (Eddie Aftandilian)
*/
@RunWith(JUnit4.class)
public class CommandLineFlagDisableTest {
@BugPattern(name = "DisableableChecker", altNames = "foo",
summary = "Disableable checker that flags all return statements as errors",
explanation = "Disableable checker that flags all return statements as errors",
disableable = true, category = ONE_OFF, severity = ERROR, maturity = MATURE)
private static class DisableableChecker extends BugChecker implements ReturnTreeMatcher {
@Override
public Description matchReturn(ReturnTree tree, VisitorState state) {
return describeMatch(tree, null);
}
}
@BugPattern(name = "NondisableableChecker",
summary = "NondisableableChecker checker that flags all return statements as errors",
explanation = "NondisableableChecker checker that flags all return statements as errors",
category = ONE_OFF, severity = ERROR, maturity = MATURE)
private static class NondisableableChecker extends BugChecker implements ReturnTreeMatcher {
@Override
public Description matchReturn(ReturnTree tree, VisitorState state) {
return describeMatch(tree, null);
}
}
private ErrorProneTestCompiler compiler;
private DiagnosticTestHelper diagnosticHelper;
private PrintStream oldStdout;
private PrintStream oldStderr;
private ByteArrayOutputStream testStdout = new ByteArrayOutputStream();
private ByteArrayOutputStream testStderr = new ByteArrayOutputStream();
@Before
public void setUp() {
// Redirect stdout and stderr so we can test usage and error messages.
oldStdout = System.out;
oldStderr = System.err;
System.setOut(new PrintStream(testStdout));
System.setErr(new PrintStream(testStderr));
diagnosticHelper = new DiagnosticTestHelper();
}
@After
public void tearDown() {
System.setOut(oldStdout);
System.setErr(oldStderr);
}
@Test
public void flagWorks() throws Exception {
compiler = new ErrorProneTestCompiler.Builder()
.listenToDiagnostics(diagnosticHelper.collector)
.report(new ErrorProneScanner(new DisableableChecker()))
.build();
List<JavaFileObject> sources =
compiler.fileManager().sources(getClass(), "CommandLineFlagTestFile.java");
Result exitCode = compiler.compile(sources);
assertThat(exitCode, is(Result.ERROR));
exitCode = compiler.compile(new String[]{"-Xepdisable:DisableableChecker"}, sources);
assertThat(exitCode, is(Result.OK));
}
@Test
public void cantDisableNondisableableCheck() throws Exception {
compiler = new ErrorProneTestCompiler.Builder()
.listenToDiagnostics(diagnosticHelper.collector)
.report(new ErrorProneScanner(new NondisableableChecker()))
.build();
List<JavaFileObject> sources =
compiler.fileManager().sources(getClass(), "CommandLineFlagTestFile.java");
Result exitCode = compiler.compile(
new String[]{"-Xepdisable:NondisableableChecker"}, sources);
assertThat(exitCode, is(Result.CMDERR));
assertThat(testStderr.toString(),
containsString("error-prone check NondisableableChecker may not be disabled"));
}
@Test
public void noEffectWhenDisableNonexistentCheck() throws Exception {
compiler = new ErrorProneTestCompiler.Builder()
.listenToDiagnostics(diagnosticHelper.collector)
.report(new ErrorProneScanner(new DisableableChecker()))
.build();
List<JavaFileObject> sources =
compiler.fileManager().sources(getClass(), "CommandLineFlagTestFile.java");
Result exitCode = compiler.compile(new String[]{"-Xepdisable:BogusChecker"}, sources);
assertThat(exitCode, is(Result.ERROR));
assertThat(testStderr.toString(), is(""));
}
@Test
public void cantDisableByAltname() throws Exception {
compiler = new ErrorProneTestCompiler.Builder()
.listenToDiagnostics(diagnosticHelper.collector)
.report(new ErrorProneScanner(new DisableableChecker()))
.build();
List<JavaFileObject> sources =
compiler.fileManager().sources(getClass(), "CommandLineFlagTestFile.java");
Result exitCode = compiler.compile(new String[]{"-Xepdisable:foo"}, sources);
assertThat(exitCode, is(Result.ERROR));
}
}