Package jetbrains.buildServer.agent

Class BaseServerLoggerFacade

java.lang.Object

jetbrains.buildServer.agent.BaseServerLoggerFacade

All Implemented Interfaces:

BuildProgressLogger, FlowLogger, MessageTweakingSupport, JUnitLogger, SimpleBuildLogger

Direct Known Subclasses:

ServerLoggerFacade

public abstract class BaseServerLoggerFacade
extends Object
implements JUnitLogger, FlowLogger, MessageTweakingSupport

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	BaseServerLoggerFacade()
protected	BaseServerLoggerFacade(String flowId)
	BaseServerLoggerFacade(String flowId, String parentFlowId)

Method Summary

Modifier and Type	Method	Description
void	activityFinished(String activityName, String activityType)	Finishes block
void	activityStarted(String activityName, String activityType)	Starts new block in the build log.
void	activityStarted(String activityName, String activityDescription, String activityType)	Starts new block in the build log.
void	buildFailureDescription(String message)	Allows to fail build unconditionally.
void	buildStarted()
void	debug(String message)	Logs a debug message.
protected void	disposeChildLoggers()
void	disposeFlow()	Disposes this flow, i.e.
void	error(String message)	Logs error.
void	exception(Throwable th)	Logs exception.
abstract void	flush()	Flushes messages buffer.
String	getFlowId()	Returns flow id of this logger.
FlowLogger	getFlowLogger(String flowId)	Returns logger for specified flow id, or creates new logger if there were no loggers for this flow id yet.
String	getParentFlowId()
FlowLogger	getThreadLogger()	Returns flow logger for current thread.
BuildProgressLogger	getTweakedLogger(BuildMessageTweaker tweaker)
void	ignoreServiceMessages(Runnable runnable)	Run given block in a mode when service messages are not parsed and ignored, both on agent and server
void	internalError(String type, String message, Throwable throwable)	Reports internal error, i.e.
protected abstract void	log(BuildMessage1 message)
void	logBuildProblem(BuildProblemData buildProblem)	Logs build problem that causes build failure on server
void	logComparisonFailure(String testName, Throwable e, String expected, String actual)
void	logMessage(BuildMessage1 message)	Logs specified build message as is
void	logSuiteFinished(String name)
void	logSuiteFinished(String name, Date timestamp)
void	logSuiteStarted(String name)
void	logSuiteStarted(String name, Date timestamp)
void	logTestFailed(String testName, String message, String stackTrace)
void	logTestFailed(String testName, Throwable e)
void	logTestFinished(String name)
void	logTestFinished(String name, Date timestamp)
void	logTestIgnored(String name, String reason)
void	logTestStarted(String name)
void	logTestStarted(String name, Date timestamp)
void	logTestStdErr(String testName, String out)
void	logTestStdOut(String testName, String out)
void	message(String message)	Logs text message.
void	message(String message, Status status)	Logs text message.
void	progressFinished()	Finishes current progress block.
void	progressMessage(String message)	Same as message, but used from the 'Progress' ant task.
void	progressStarted(String message)	Starts new progress block.
void	startFlow()	Starts flow explicitly.
void	targetFinished(String targetName)	Finishes Ant-like target in the build log.
void	targetStarted(String targetName)	Starts Ant-like target in the build log.
void	warning(String message)	Logs warning.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BaseServerLoggerFacade

protected BaseServerLoggerFacade(String flowId)

BaseServerLoggerFacade

public BaseServerLoggerFacade(String flowId,
                              String parentFlowId)

BaseServerLoggerFacade

protected BaseServerLoggerFacade()

Method Detail

logTestStarted

public void logTestStarted(String name)

Specified by:

logTestStarted in interface JUnitLogger

logTestStarted

public void logTestStarted(String name,
                           Date timestamp)

Specified by:

logTestStarted in interface JUnitLogger

logTestFinished

public void logTestFinished(String name)

Specified by:

logTestFinished in interface JUnitLogger

logTestFinished

public void logTestFinished(String name,
                            Date timestamp)

Specified by:

logTestFinished in interface JUnitLogger

logTestIgnored

public void logTestIgnored(String name,
                           String reason)

Specified by:

logTestIgnored in interface JUnitLogger

logSuiteStarted

public void logSuiteStarted(String name)

Specified by:

logSuiteStarted in interface JUnitLogger

logSuiteStarted

public void logSuiteStarted(String name,
                            Date timestamp)

Specified by:

logSuiteStarted in interface JUnitLogger

logSuiteFinished

public void logSuiteFinished(String name)

Specified by:

logSuiteFinished in interface JUnitLogger

logSuiteFinished

public void logSuiteFinished(String name,
                             Date timestamp)

Specified by:

logSuiteFinished in interface JUnitLogger

logTestStdOut

public void logTestStdOut(String testName,
                          String out)

Specified by:

logTestStdOut in interface JUnitLogger

logTestStdErr

public void logTestStdErr(String testName,
                          String out)

Specified by:

logTestStdErr in interface JUnitLogger

logComparisonFailure

public void logComparisonFailure(String testName,
                                 Throwable e,
                                 String expected,
                                 String actual)

Specified by:

logComparisonFailure in interface JUnitLogger

logTestFailed

public void logTestFailed(String testName,
                          Throwable e)

Specified by:

logTestFailed in interface JUnitLogger

logTestFailed

public void logTestFailed(String testName,
                          String message,
                          String stackTrace)

Specified by:

logTestFailed in interface JUnitLogger

activityStarted

public void activityStarted(String activityName,
                            String activityDescription,
                            String activityType)

Description copied from interface: BuildProgressLogger

Starts new block in the build log.

Specified by:

activityStarted in interface BuildProgressLogger

Parameters:

activityName - name of the block

activityDescription - block description

activityType - for standard block type refer to BLOCK_TYPE_* constants jetbrains.buildServer.messages.DefaultMessagesInfo, in case of non-standard block type use prefix CUSTOM_

activityStarted

public void activityStarted(String activityName,
                            String activityType)

Description copied from interface: BuildProgressLogger

Starts new block in the build log.

Specified by:

activityStarted in interface BuildProgressLogger

Parameters:

activityName - name of the block

activityType - for standard block type refer to BLOCK_TYPE_* constants jetbrains.buildServer.messages.DefaultMessagesInfo, in case of non-standard block type use prefix CUSTOM_

activityFinished

public void activityFinished(String activityName,
                             String activityType)

Description copied from interface: BuildProgressLogger

Finishes block

Specified by:

activityFinished in interface BuildProgressLogger

Parameters:

activityName - name of the block

activityType - type of the block

targetStarted

public void targetStarted(String targetName)

Description copied from interface: BuildProgressLogger

Starts Ant-like target in the build log.

Specified by:

targetStarted in interface BuildProgressLogger

Parameters:

targetName - name of the target

targetFinished

public void targetFinished(String targetName)

Description copied from interface: BuildProgressLogger

Finishes Ant-like target in the build log.

Specified by:

targetFinished in interface BuildProgressLogger

Parameters:

targetName - name of the target

progressStarted

public void progressStarted(String message)

Description copied from interface: BuildProgressLogger

Starts new progress block.

Specified by:

progressStarted in interface BuildProgressLogger

Parameters:

message - progress message

progressFinished

public void progressFinished()

Description copied from interface: BuildProgressLogger

Finishes current progress block.

Specified by:

progressFinished in interface BuildProgressLogger

message

public void message(String message)

Description copied from interface: SimpleBuildLogger

Logs text message.

Specified by:

message in interface SimpleBuildLogger

Parameters:

message - text message

debug

public void debug(String message)

Description copied from interface: SimpleBuildLogger

Logs a debug message. Content of debug messages is logged as is, service messages are not detected.

Specified by:

debug in interface SimpleBuildLogger

Parameters:

message - text message

message

public void message(String message,
                    Status status)

Description copied from interface: SimpleBuildLogger

Logs text message.

Specified by:

message in interface SimpleBuildLogger

Parameters:

message - text message

progressMessage

public void progressMessage(String message)

Description copied from interface: SimpleBuildLogger

Same as message, but used from the 'Progress' ant task. A dedicated method allows to distinguish progress-tracking messages user explicitly specified in the ant script

Specified by:

progressMessage in interface SimpleBuildLogger

Parameters:

message - text message

error

public void error(String message)

Description copied from interface: SimpleBuildLogger

Logs error.

Specified by:

error in interface SimpleBuildLogger

Parameters:

message - error message

buildFailureDescription

public void buildFailureDescription(String message)

Description copied from interface: BuildProgressLogger

Allows to fail build unconditionally. Message should be short - used in build status text

Specified by:

buildFailureDescription in interface BuildProgressLogger

Parameters:

message - short message describing reason of the build failure (shown in red and used in status text)

warning

public void warning(String message)

Description copied from interface: SimpleBuildLogger

Logs warning.

Specified by:

warning in interface SimpleBuildLogger

Parameters:

message - warning

exception

public void exception(Throwable th)

Description copied from interface: SimpleBuildLogger

Logs exception.

Specified by:

exception in interface SimpleBuildLogger

Parameters:

th - exception.

internalError

public void internalError(String type,
                          String message,
                          Throwable throwable)

Description copied from interface: BuildProgressLogger

Reports internal error, i.e. error which should mark build as "failed to start".

Specified by:

internalError in interface BuildProgressLogger

Parameters:

type - the error type

message - the description

throwable - the corresponding exception (nullable)

flush

public abstract void flush()

Description copied from interface: BuildProgressLogger

Flushes messages buffer.

Specified by:

flush in interface BuildProgressLogger

Specified by:

flush in interface JUnitLogger

log

protected abstract void log(BuildMessage1 message)

logMessage

public void logMessage(BuildMessage1 message)

Description copied from interface: BuildProgressLogger

Logs specified build message as is

Specified by:

logMessage in interface BuildProgressLogger

Parameters:

message - build message to log

startFlow

public void startFlow()

Description copied from interface: FlowLogger

Starts flow explicitly. A special message must be sent to TeamCity for each new flow. Usually a flow is started when the first message is logged using this logger, but sometimes there is a need to start flow explicitly. For such cases use this method.

Specified by:

startFlow in interface FlowLogger

ignoreServiceMessages

public void ignoreServiceMessages(Runnable runnable)

Description copied from interface: BuildProgressLogger

Run given block in a mode when service messages are not parsed and ignored, both on agent and server

Specified by:

ignoreServiceMessages in interface BuildProgressLogger

getFlowLogger

public FlowLogger getFlowLogger(String flowId)

Description copied from interface: BuildProgressLogger

Returns logger for specified flow id, or creates new logger if there were no loggers for this flow id yet.

Specified by:

getFlowLogger in interface BuildProgressLogger

Parameters:

flowId - id of the messages flow

Returns:

see above

getThreadLogger

public FlowLogger getThreadLogger()

Description copied from interface: BuildProgressLogger

Returns flow logger for current thread. This is equivalent to calling BuildProgressLogger.getFlowLogger(String) with flow id generated based on current Thread object.

Specified by:

getThreadLogger in interface BuildProgressLogger

Returns:

see above.

getFlowId

public String getFlowId()

Description copied from interface: BuildProgressLogger

Returns flow id of this logger. Flow id is an id of the messages flow. If you need to log messages from separate independent threads, you should generate flow id for each thread and use logger with corresponding flow id. See also BuildProgressLogger.getThreadLogger().

Specified by:

getFlowId in interface BuildProgressLogger

Returns:

see above

disposeFlow

public void disposeFlow()

Description copied from interface: FlowLogger

Disposes this flow, i.e. sends a message to server that this flow won't be used anymore. If there were other flow loggers created by this logger, their flows will be disposed too.

Specified by:

disposeFlow in interface FlowLogger

getTweakedLogger

public BuildProgressLogger getTweakedLogger(BuildMessageTweaker tweaker)

Specified by:

getTweakedLogger in interface MessageTweakingSupport

buildStarted

public void buildStarted()

disposeChildLoggers

protected void disposeChildLoggers()

logBuildProblem

public void logBuildProblem(BuildProblemData buildProblem)

Description copied from interface: BuildProgressLogger

Logs build problem that causes build failure on server

Specified by:

logBuildProblem in interface BuildProgressLogger

Parameters:

buildProblem - build problem

getParentFlowId

public String getParentFlowId()