Package org.testng.log4testng
Class Logger
java.lang.Object
org.testng.log4testng.Logger
TestNG support logging via a custom logging framework similar to Log4j. To control logging, add a resource named
"log4testng.properties" to your classpath. The logging levels are TRACE, DEBUG, INFO, WARN, ERROR
and FATAL. The Logging framework has the following characteristics:
- All logging is done using System.out (for levels < ERROR) or System.err. There is no way to specify Appenders.
- There is no way to control logging programmatically.
- The log4testng.properties resource is searched in the classpath on the first call to the logging API. If it is not present, logging defaults to the WARN level.
# log4testng will log its own behavior (generally used for debugging this package only).
log4testng.debug=true
# Specifies the root Loggers logging level. Will log DEBUG level and above
log4testng.rootLogger=DEBUG
# The org.testng.reporters.EmailableReporter Logger will log TRACE level and above
log4testng.logger.org.testng.reporters.EmailableReporter=TRACE
# All Logger in packages below org.testng will log WARN level and above
log4testng.logger.org.testng=WARN
In your source files you will typically instantiate and use loggers this ways:
import org.testng.log4testng.Logger;
class ThisClass {
private static final Logger LOGGER = Logger.getLogger(ThisClass.class);
...
LOGGER.debug("entering myMethod()");
...
LOGGER.warn("unknown file: " + filename);
...
LOGGER.error("Unexpected error", exception);
-
Method Summary
Modifier and TypeMethodDescriptionvoid
Log a message object with the DEBUG level.void
Log a message object with the DEBUG level including the stack trace of the Throwable t passed as parameter.void
Log a message object with the ERROR level.void
Log a message object with the DEBUG level including the stack trace of the Throwable t passed as parameter.void
Log a message object with the FATAL level.void
Log a message object with the FATAL level including the stack trace of the Throwable t passed as parameter.static Logger
Retrieve a logger named according to the value of the pClass.getName() parameter.void
Log a message object with the INFO level.void
Log a message object with the WARN level including the stack trace of the Throwable t passed as parameter.boolean
Check whether this logger is enabled for the DEBUG Level.boolean
Check whether this logger is enabled for the INFO Level.boolean
Check whether this logger is enabled for the TRACE Level.static void
Run all tests.void
Log a message object with the TRACE level.void
Log a message object with the TRACE level including the stack trace of the Throwable t passed as parameter.void
Log a message object with the WARN level.void
Log a message object with the ERROR level including the stack trace of the Throwable t passed as parameter.
-
Method Details
-
getLogger
Retrieve a logger named according to the value of the pClass.getName() parameter. If the named logger already exists, then the existing instance will be returned. Otherwise, a new instance is created. By default, loggers do not have a set level but inherit it from their nearest ancestor with a set level.- Parameters:
pClass
- The class' logger to retrieve.- Returns:
- a logger named according to the value of the pClass.getName().
-
isTraceEnabled
public boolean isTraceEnabled()Check whether this logger is enabled for the TRACE Level.- Returns:
- true if this logger is enabled for level TRACE, false otherwise.
-
trace
Log a message object with the TRACE level. This method first checks if this logger is TRACE enabled. If this logger is TRACE enabled, then it converts the message object (passed as parameter) to a string by invoking toString(). WARNING Note that passing a Throwable to this method will print the name of the Throwable but no stack trace. To print a stack trace use the trace(Object, Throwable) form instead.- Parameters:
message
- the message object to log.
-
trace
Log a message object with the TRACE level including the stack trace of the Throwable t passed as parameter. See Logger.trace(Object) form for more detailed information.- Parameters:
message
- the message object to log.t
- the exception to log, including its stack trace.
-
isDebugEnabled
public boolean isDebugEnabled()Check whether this logger is enabled for the DEBUG Level.- Returns:
- true if this logger is enabled for level DEBUG, false otherwise.
-
debug
Log a message object with the DEBUG level. See Logger.trace(Object) form for more detailed information.- Parameters:
message
- the message object to log.
-
debug
Log a message object with the DEBUG level including the stack trace of the Throwable t passed as parameter. See Logger.trace(Object, Throwable) form for more detailed information.- Parameters:
message
- the message object to log.t
- the exception to log, including its stack trace.
-
isInfoEnabled
public boolean isInfoEnabled()Check whether this logger is enabled for the INFO Level.- Returns:
- true if this logger is enabled for level INFO, false otherwise.
-
info
Log a message object with the INFO level. See Logger.trace(Object) form for more detailed information.- Parameters:
message
- the message object to log.
-
info
Log a message object with the WARN level including the stack trace of the Throwable t passed as parameter. See Logger.trace(Object, Throwable) form for more detailed information.- Parameters:
message
- the message object to log.t
- the exception to log, including its stack trace.
-
warn
Log a message object with the WARN level. See Logger.trace(Object) form for more detailed information.- Parameters:
message
- the message object to log.
-
warn
Log a message object with the ERROR level including the stack trace of the Throwable t passed as parameter. See Logger.trace(Object, Throwable) form for more detailed information.- Parameters:
message
- the message object to log.t
- the exception to log, including its stack trace.
-
error
Log a message object with the ERROR level. See Logger.trace(Object) form for more detailed information.- Parameters:
message
- the message object to log.
-
error
Log a message object with the DEBUG level including the stack trace of the Throwable t passed as parameter. See Logger.trace(Object, Throwable) form for more detailed information.- Parameters:
message
- the message object to log.t
- the exception to log, including its stack trace.
-
fatal
Log a message object with the FATAL level. See Logger.trace(Object) form for more detailed information.- Parameters:
message
- the message object to log.
-
fatal
Log a message object with the FATAL level including the stack trace of the Throwable t passed as parameter. See Logger.trace(Object, Throwable) form for more detailed information.- Parameters:
message
- the message object to log.t
- the exception to log, including its stack trace.
-
main
Run all tests. (very crusty ...)- Parameters:
pArgs
- not used
-