package org.opendaylight.yangtools.checkstyle;
+import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertTrue;
-import java.io.ByteArrayOutputStream;
-import java.io.File;
-
-import org.junit.After;
-import org.junit.Before;
-import org.junit.Test;
-import org.xml.sax.InputSource;
-
+import com.google.common.base.Charsets;
import com.google.common.collect.Lists;
+import com.google.common.io.Files;
import com.puppycrawl.tools.checkstyle.Checker;
import com.puppycrawl.tools.checkstyle.ConfigurationLoader;
import com.puppycrawl.tools.checkstyle.DefaultLogger;
import com.puppycrawl.tools.checkstyle.api.AuditListener;
import com.puppycrawl.tools.checkstyle.api.CheckstyleException;
import com.puppycrawl.tools.checkstyle.api.Configuration;
+import java.io.ByteArrayOutputStream;
+import java.io.File;
+import java.util.List;
+import org.junit.After;
+import org.junit.Before;
+import org.junit.Test;
+import org.xml.sax.InputSource;
public class CheckstyleTest {
@Before
public void setup() throws CheckstyleException {
baos = new ByteArrayOutputStream();
- AuditListener listener = new DefaultLogger(baos, false);
+ final AuditListener listener = new DefaultLogger(baos, false);
- InputSource inputSource = new InputSource(CheckstyleTest.class.getClassLoader().getResourceAsStream(
+ final InputSource inputSource = new InputSource(CheckstyleTest.class.getClassLoader().getResourceAsStream(
"checkstyle-logging.xml"));
- Configuration configuration = ConfigurationLoader.loadConfiguration(inputSource,
+ final Configuration configuration = ConfigurationLoader.loadConfiguration(inputSource,
new PropertiesExpander(System.getProperties()), false);
checker = new Checker();
@Test
public void testLoggerChecks() throws Exception {
- verify(CheckLoggingTestClass.class, "15: Logger must be declared as private static final.", "15: Logger name should be LOG.",
- "17: Logger might be declared only once.", "16: Logger must be slf4j.", "22: Line contains printStacktrace",
- "23: Line contains console output", "24: Line contains console output",
- "15: LoggerFactory.getLogger Class argument is incorrect.", "20: Log message contains string concatenation.",
- "26: Log message placeholders count is incorrect.", "32: Log message placeholders count is incorrect");
+ verify(CheckLoggingTestClass.class, true,
+ "16: Logger must be declared as private static final",
+ "16: Logger name should be LOG",
+ "16: LoggerFactory.getLogger Class argument is incorrect",
+ "18: Logger might be declared only once",
+ "17: Logger must be slf4j",
+ "27: Log message placeholders count is incorrect",
+ "36: Log message placeholders count is incorrect",
+ "45: Log message contains string concatenation");
}
@Test
- public void testCodingChecks() {
- verify(CheckCodingStyleTestClass.class, "9: Line has Windows line delimiter.", "14: Wrong order for", "24:1: Line contains a tab character.",
- "22: Line has trailing spaces.", "22: ctor def child at indentation level 16 not at correct indentation, 8", "17:8: Unused import",
- "23: Line has trailing spaces.");
+ public void testLogMessageExtractorCheck() throws Exception {
+ File logMessageReport = LogMessageExtractorCheck.DEFAULT_REPORT_FILE;
+ logMessageReport.delete();
+ verify(CheckLoggingTestClass.class, false);
+ List<String> reportLines = Files.readLines(logMessageReport, Charsets.UTF_8);
+ assertEquals(6, reportLines.size());
+ assertEquals("src/test/java/org/opendaylight/yangtools/checkstyle/CheckLoggingTestClass.java:27:\"foo {} {}\"", reportLines.get(0));
+ // TODO assertEquals("src/test/java/org/opendaylight/yangtools/checkstyle/CheckLoggingTestClass.java:28:\"foo {} bar {}\"", reportLines.get(1));
}
- private void verify(final Class<?> testClass, final String... expectedMessages) {
+ private void verify(final Class<?> testClass, final boolean checkCount, final String... expectedMessages) throws CheckstyleException {
final String filePath = System.getProperty("user.dir") + File.separator + "src" + File.separator + "test" + File.separator + "java" + File.separator + testClass.getName().replaceAll("\\.", "/") + ".java";
final File testFile = new File(filePath);
checker.process(Lists.newArrayList(testFile));
final String output = baos.toString();
+ System.out.println();
+ if (checkCount) {
+ final int count = output.split("\n").length - 2;
+ assertEquals(expectedMessages.length, count);
+ }
for(final String message : expectedMessages) {
- assertTrue("Expected message not found: " + message, output.contains(message));
+ assertTrue("Expected message not found: " + message + "; output: " + output, output.contains(message));
}
}
}