////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2017 the original author or authors.
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
//
// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
////////////////////////////////////////////////////////////////////////////////
package com.puppycrawl.tools.checkstyle;
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertFalse;
import static org.junit.Assert.assertTrue;
import java.io.BufferedReader;
import java.io.ByteArrayInputStream;
import java.io.ByteArrayOutputStream;
import java.io.IOException;
import java.io.InputStreamReader;
import java.io.PrintWriter;
import java.nio.charset.StandardCharsets;
import java.util.ArrayList;
import java.util.List;
import java.util.regex.Pattern;
import org.junit.Test;
import com.puppycrawl.tools.checkstyle.api.AuditEvent;
import com.puppycrawl.tools.checkstyle.api.LocalizedMessage;
import com.puppycrawl.tools.checkstyle.api.SeverityLevel;
import com.puppycrawl.tools.checkstyle.utils.CommonUtils;
/**
* Enter a description of class XMLLoggerTest.java.
* @author Rick Giles
*/
// -@cs[AbbreviationAsWordInName] Test should be named as its main class.
public class XMLLoggerTest {
private final ByteArrayOutputStream outStream = new ByteArrayOutputStream();
@Test
public void testEncode()
throws IOException {
new XMLLogger(outStream, false);
final String[][] encodings = {
{"<", "<"},
{">", ">"},
{"'", "'"},
{"\"", """},
{"&", "&"},
{"<", "<"},
{"abc;", "abc;"},
{"�", "�"}, //reference
{"�", "�"}, //not reference
{"�", "�"}, //not reference
};
for (String[] encoding : encodings) {
final String encoded = XMLLogger.encode(encoding[0]);
assertEquals("\"" + encoding[0] + "\"", encoding[1], encoded);
}
outStream.close();
}
@Test
public void testIsReference()
throws IOException {
new XMLLogger(outStream, false);
final String[] references = {
"�",
"�",
};
for (String reference : references) {
assertTrue("reference: " + reference,
XMLLogger.isReference(reference));
}
final String[] noReferences = {
"&",
"&;",
"&#;",
"&#a;",
"�",
"&#x;",
"&#xg;",
"ref",
};
for (String noReference : noReferences) {
assertFalse("no reference: " + noReference,
XMLLogger.isReference(noReference));
}
outStream.close();
}
@Test
public void testCloseStream()
throws IOException {
final XMLLogger logger = new XMLLogger(outStream, true);
logger.auditStarted(null);
logger.auditFinished(null);
final String[] expectedLines = CommonUtils.EMPTY_STRING_ARRAY;
verifyLines(expectedLines);
}
@Test
public void testNoCloseStream()
throws IOException {
final XMLLogger logger = new XMLLogger(outStream, false);
logger.auditStarted(null);
logger.auditFinished(null);
outStream.close();
final String[] expectedLines = CommonUtils.EMPTY_STRING_ARRAY;
verifyLines(expectedLines);
}
@Test
public void testFileStarted()
throws IOException {
final XMLLogger logger = new XMLLogger(outStream, true);
logger.auditStarted(null);
final AuditEvent ev = new AuditEvent(this, "Test.java");
logger.fileStarted(ev);
logger.auditFinished(null);
final String[] expectedLines = {"<file name=\"Test.java\">"};
verifyLines(expectedLines);
}
@Test
public void testFileFinished()
throws IOException {
final XMLLogger logger = new XMLLogger(outStream, true);
logger.auditStarted(null);
final AuditEvent ev = new AuditEvent(this, "Test.java");
logger.fileFinished(ev);
logger.auditFinished(null);
final String[] expectedLines = {"</file>"};
verifyLines(expectedLines);
}
@Test
public void testAddError() throws IOException {
final XMLLogger logger = new XMLLogger(outStream, true);
logger.auditStarted(null);
final LocalizedMessage message =
new LocalizedMessage(1, 1,
"messages.properties", "key", null, SeverityLevel.ERROR, null,
getClass(), null);
final AuditEvent ev = new AuditEvent(this, "Test.java", message);
logger.addError(ev);
logger.auditFinished(null);
final String[] expectedLines = {
"<error line=\"1\" column=\"1\" severity=\"error\" message=\"key\""
+ " source=\"com.puppycrawl.tools.checkstyle.XMLLoggerTest\"/>",
};
verifyLines(expectedLines);
}
@Test
public void testAddErrorOnZeroColumns() throws IOException {
final XMLLogger logger = new XMLLogger(outStream, true);
logger.auditStarted(null);
final LocalizedMessage message =
new LocalizedMessage(1, 0,
"messages.properties", "key", null, SeverityLevel.ERROR, null,
getClass(), null);
final AuditEvent ev = new AuditEvent(this, "Test.java", message);
logger.addError(ev);
logger.auditFinished(null);
final String[] expectedLines = {
"<error line=\"1\" severity=\"error\" message=\"key\""
+ " source=\"com.puppycrawl.tools.checkstyle.XMLLoggerTest\"/>",
};
verifyLines(expectedLines);
}
@Test
public void testAddIgnored() throws IOException {
final XMLLogger logger = new XMLLogger(outStream, true);
logger.auditStarted(null);
final LocalizedMessage message =
new LocalizedMessage(1, 1,
"messages.properties", "key", null, SeverityLevel.IGNORE, null,
getClass(), null);
final AuditEvent ev = new AuditEvent(this, "Test.java", message);
logger.addError(ev);
logger.auditFinished(null);
final String[] expectedLines = CommonUtils.EMPTY_STRING_ARRAY;
verifyLines(expectedLines);
}
@Test
public void testAddException()
throws IOException {
final XMLLogger logger = new XMLLogger(outStream, true);
logger.auditStarted(null);
final LocalizedMessage message =
new LocalizedMessage(1, 1,
"messages.properties", null, null, null, getClass(), null);
final AuditEvent ev = new AuditEvent(this, "Test.java", message);
logger.addException(ev, new TestException("msg", new RuntimeException("msg")));
logger.auditFinished(null);
final String[] expectedLines = {
"<exception>",
"<![CDATA[",
"stackTrace]]>",
"</exception>",
"",
};
verifyLines(expectedLines);
}
private String[] getOutStreamLines()
throws IOException {
final byte[] bytes = outStream.toByteArray();
final ByteArrayInputStream inStream =
new ByteArrayInputStream(bytes);
final List<String> lineList = new ArrayList<>();
try (BufferedReader reader = new BufferedReader(
new InputStreamReader(inStream, StandardCharsets.UTF_8))) {
while (true) {
final String line = reader.readLine();
if (line == null) {
break;
}
lineList.add(line);
}
}
return lineList.toArray(new String[lineList.size()]);
}
/**
* Verify output lines from auditStart to auditEnd.
* Take into consideration checkstyle element (first and last lines).
* @param expectedLines expected error report lines
*/
private void verifyLines(String... expectedLines)
throws IOException {
final String[] lines = getOutStreamLines();
assertEquals("length.", expectedLines.length + 3, lines.length);
assertEquals("first line.",
"<?xml version=\"1.0\" encoding=\"UTF-8\"?>",
lines[0]);
final Pattern checkstyleOpenTag = Pattern.compile("^<checkstyle version=\".*\">$");
assertTrue("second line.", checkstyleOpenTag.matcher(lines[1]).matches());
for (int i = 0; i < expectedLines.length; i++) {
assertEquals("line " + i + ".", expectedLines[i], lines[i + 2]);
}
assertEquals("last line.", "</checkstyle>", lines[lines.length - 1]);
}
private static class TestException extends RuntimeException {
private static final long serialVersionUID = 1L;
TestException(String msg, Throwable cause) {
super(msg, cause);
}
@Override
public void printStackTrace(PrintWriter printWriter) {
printWriter.print("stackTrace");
}
}
}