com.tplan.robot.scripting.commands

Class ScriptLogger

java.lang.Object

com.tplan.robot.scripting.commands.ScriptLogger

All Implemented Interfaces:

OutputObject

public class ScriptLogger
extends Object
implements OutputObject

Script execution stack trace & log/error recorder

T-Plan Robot Enterprise, (C) 2009-2022 T-Plan Limited. All rights reserved.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ScriptLogger.CustomLogManager Custom LogManager supporting calls during the process shutdown.
static class	ScriptLogger.ExitType Indicates why a script terminated, for example reaching of the code end, call of the Exit command, stopping by the user or an app/process crash.

Field Summary

Fields

Modifier and Type	Field and Description
static MessageFormat	FORMAT
static String	LOG_FILE_NAME
static String	PROPERTY_CHANGE_LOG_CLOSED
static String	PROPERTY_CHANGE_LOG_CLOSING
static String	PROPERTY_CHANGE_NEW_LOG
static String	TIME_STAMP_FORMAT
static String	VAR_SEVERE_COUNT
static String	VAR_WARNING_COUNT

Fields inherited from interface com.tplan.robot.scripting.commands.OutputObject

TYPE_ERROR, TYPE_LOG, TYPE_SCREENSHOT, TYPE_STATUS, TYPE_UNKNOWN, TYPE_WARNING

Constructor Summary

Constructors

Constructor and Description
ScriptLogger(ScriptingContext ctx)

Method Summary

Modifier and Type	Method and Description
void	addHtmlLogListener(PropertyChangeListener l)
boolean	canLog(Level level)
void	close()
String	getCode() Get code of the output object.
ScriptLocation	getCurrentPosition()
ScriptLocation	getCurrentPosition(Stack<ScriptLocation> position)
Date	getDate() Get date and time of when the output object was created.
String	getDescription() Get the output object description.
ScriptLocation	getExitPoint()
ScriptLocation[]	getExitStack()
ScriptLogger.ExitType	getExitType()
String	getLastLog() Get the last log entry.
Stack<ScriptLocation>	getStackCopy() Get a copy of the current stack.
StringBuilder	getStackTrace()
StringBuilder	getStackTrace(boolean useHead, boolean useHTML)
StringBuilder	getStackTrace(Stack<ScriptLocation> position, boolean useHead, boolean useHTML)
ScriptLocation	getStartPoint()
static List<Level>	getSupportedLogLevels()
int	getType() Get the output object type.
boolean	isClosed()
void	leavingFile(ScriptingContext ctx, Object scriptFile) Method to indicate that a file based test script has been completed and all top stack items related to that file should be popped.
void	log(Level level, String message)
void	logConfig(String message)
void	logFine(String message)
void	logFiner(String message)
void	logFinest(String message)
void	logInfo(String message)
void	logRaw(Level level, String message)
void	logRaw(Level level, String message, Long time)
void	logRawHTML(String html)
void	logSevere(String message)
void	logSevere(String message, boolean closeLog) Log a severe error and optionally close the log stream if the error causes the script to terminate.
void	logWarning(String message)
void	popCurrentPosition(ScriptingContext ctx)
void	printStackTrace()
void	pushCurrentPosition(ScriptingContext ctx)
void	recordExitStack()
void	removeHtmlLogListener(PropertyChangeListener l)
void	setBulkUpdate(boolean bulk)
void	setCurrentPosition(ScriptingContext ctx, Object scriptFile, int lineIndex, String line)
void	setExitType(ScriptLogger.ExitType type, String details)
Map<String,Object>	toMap() Return a map of valid properties of this output object.
String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

PROPERTY_CHANGE_NEW_LOG

public static String PROPERTY_CHANGE_NEW_LOG

PROPERTY_CHANGE_LOG_CLOSING

public static String PROPERTY_CHANGE_LOG_CLOSING

PROPERTY_CHANGE_LOG_CLOSED

public static String PROPERTY_CHANGE_LOG_CLOSED

LOG_FILE_NAME

public static String LOG_FILE_NAME

TIME_STAMP_FORMAT

public static final String TIME_STAMP_FORMAT

See Also:

Constant Field Values

FORMAT

public static final MessageFormat FORMAT

VAR_WARNING_COUNT

public static final String VAR_WARNING_COUNT

See Also:

Constant Field Values

VAR_SEVERE_COUNT

public static final String VAR_SEVERE_COUNT

See Also:

Constant Field Values

Constructor Detail

ScriptLogger

public ScriptLogger(ScriptingContext ctx)

Method Detail

getSupportedLogLevels

public static List<Level> getSupportedLogLevels()

getLastLog

public String getLastLog()

Get the last log entry.

Returns:

the last log entry.

addHtmlLogListener

public void addHtmlLogListener(PropertyChangeListener l)

removeHtmlLogListener

public void removeHtmlLogListener(PropertyChangeListener l)

getType

public int getType()

Description copied from interface: OutputObject

Get the output object type. If you implement your own output object, do not use numbers between 1 and 100 which are reserved for internal T-Plan Robot objects.

Specified by:

getType in interface OutputObject

Returns:

output object type.

getCode

public String getCode()

Description copied from interface: OutputObject

Get code of the output object. It is typically used as a tag in the output XML.

Specified by:

getCode in interface OutputObject

Returns:

output object code.

getDescription

public String getDescription()

Description copied from interface: OutputObject

Get the output object description.

Specified by:

getDescription in interface OutputObject

Returns:

output object description.

getDate

public Date getDate()

Description copied from interface: OutputObject

Get date and time of when the output object was created.

Specified by:

getDate in interface OutputObject

Returns:

output object date.

toMap

public Map<String,Object> toMap()

Description copied from interface: OutputObject

Return a map of valid properties of this output object. This is used for generic output without knowing the actual type of the output object and its properties.

Specified by:

toMap in interface OutputObject

Returns:

map of the object properties.

toString

public String toString()

Overrides:

toString in class Object

getCurrentPosition

public ScriptLocation getCurrentPosition()

getCurrentPosition

public ScriptLocation getCurrentPosition(Stack<ScriptLocation> position)

setCurrentPosition

public void setCurrentPosition(ScriptingContext ctx,
                               Object scriptFile,
                               int lineIndex,
                               String line)

leavingFile

public void leavingFile(ScriptingContext ctx,
                        Object scriptFile)

Method to indicate that a file based test script has been completed and all top stack items related to that file should be popped.

Parameters:

ctx - the execution context.

scriptFile - the script file.

Since:

4.4.8

pushCurrentPosition

public void pushCurrentPosition(ScriptingContext ctx)

popCurrentPosition

public void popCurrentPosition(ScriptingContext ctx)

setExitType

public void setExitType(ScriptLogger.ExitType type,
                        String details)

getExitType

public ScriptLogger.ExitType getExitType()

canLog

public boolean canLog(Level level)

setBulkUpdate

public void setBulkUpdate(boolean bulk)

logRaw

public void logRaw(Level level,
                   String message)

logRaw

public void logRaw(Level level,
                   String message,
                   Long time)

logRawHTML

public void logRawHTML(String html)

log

public void log(Level level,
                String message)

logSevere

public void logSevere(String message,
                      boolean closeLog)

Log a severe error and optionally close the log stream if the error causes the script to terminate.

Parameters:

message - the error message.

closeLog - if the value is true the log stream is closed and the error message gets logged as a final log. This avoids duplication of the error log when a sequence of logSevere(java.lang.String) and close().

logWarning

public void logWarning(String message)

logSevere

public void logSevere(String message)

logFine

public void logFine(String message)

logFiner

public void logFiner(String message)

logFinest

public void logFinest(String message)

logConfig

public void logConfig(String message)

logInfo

public void logInfo(String message)

getStackTrace

public StringBuilder getStackTrace()

getStackTrace

public StringBuilder getStackTrace(boolean useHead,
                                   boolean useHTML)

getStackTrace

public StringBuilder getStackTrace(Stack<ScriptLocation> position,
                                   boolean useHead,
                                   boolean useHTML)

printStackTrace

public void printStackTrace()

getExitPoint

public ScriptLocation getExitPoint()

getStartPoint

public ScriptLocation getStartPoint()

getExitStack

public ScriptLocation[] getExitStack()

isClosed

public boolean isClosed()

recordExitStack

public void recordExitStack()

close

public void close()

getStackCopy

public Stack<ScriptLocation> getStackCopy()

Get a copy of the current stack.

Returns:

stack copy.

Since:

4.0.3