org.opendaylight.infrautils.testutils.LogRule Maven / Gradle / Ivy
/*
* Copyright (c) 2016 Red Hat, Inc. and others. All rights reserved.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License v1.0 which accompanies this distribution,
* and is available at http://www.eclipse.org/legal/epl-v10.html
*/
package org.opendaylight.infrautils.testutils;
import com.google.errorprone.annotations.Var;
import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
import org.junit.rules.TestRule;
import org.junit.runner.Description;
import org.junit.runners.model.Statement;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.slf4j.Marker;
import org.slf4j.MarkerFactory;
/**
* JUnit Rule which nicely separates {@literal @}Test/s in the log.
*
*
* Usage (NB the use of {@literal @}Rule instead of {@literal @}ClassRule):
*
*
* public {@literal @}Rule LogRule logRule = new LogRule();
*
* {@literal @}Test ...
*
*
* @author Michael Vorburger
*/
public class LogRule implements TestRule {
private static final String HEADER = "-".repeat(120);
private static final String MESSAGE = "{} ({}ms) @Test {}()";
private static final Marker MARKER = MarkerFactory.getMarker(LogRule.class.getName());
public static Marker getMarker() {
return MARKER;
}
@Override
// findbugs-slf4j does not understand that a static final String IS a Constant, so SLF4J_FORMAT_SHOULD_BE_CONST
// findbugs-slf4j cannot understand what we are doing here with a Logger variable instead of class field, so:
@SuppressFBWarnings({ "SLF4J_FORMAT_SHOULD_BE_CONST", "SLF4J_LOGGER_SHOULD_BE_PRIVATE" })
public Statement apply(Statement statement, Description description) {
Logger testLog = LoggerFactory.getLogger(description.getTestClass());
return new Statement() {
@Override
@SuppressWarnings("checkstyle:IllegalCatch")
@SuppressFBWarnings("SLF4J_FORMAT_SHOULD_BE_CONST")
public void evaluate() throws Throwable {
testLog.info(MARKER, HEADER);
testLog.info(MARKER, "BEGIN @Test {}()", description.getMethodName());
long startTimeInMS = System.currentTimeMillis();
@Var Throwable caughtThrowable = null;
try {
statement.evaluate();
} catch (Throwable throwable) {
caughtThrowable = throwable;
throw throwable;
} finally {
long durationInMS = System.currentTimeMillis() - startTimeInMS;
if (caughtThrowable == null) {
testLog.info(MARKER, MESSAGE, "ENDED", durationInMS, description.getMethodName());
} else {
testLog.error(MARKER, MESSAGE, "FAILED", durationInMS, description.getMethodName(),
caughtThrowable);
}
}
}
};
}
}