org.apache.anteater.test.log
Class XMLLogger

java.lang.Object
  |
  +--org.apache.tools.ant.ProjectComponent
        |
        +--org.apache.tools.ant.types.DataType
              |
              +--org.apache.anteater.test.BaseDataType
                    |
                    +--org.apache.anteater.test.log.BaseLogger
                          |
                          +--org.apache.anteater.test.log.XMLLogger

All Implemented Interfaces:

Groupable, Logger

public class XMLLogger

extends BaseLogger

implements Logger

Logger that writes XML log files compatible (slightly extending) with those from the <junit> task's XML formatter.

Version:

$Revision: 1.21 $ $Date: 2003/03/10 14:33:01 $

Author:

Jeff Turner

Nested Class Summary

Nested classes inherited from class org.apache.anteater.test.log.BaseLogger

BaseLogger.TestLog

Field Summary

protected String

DEFAULT_LOGDIR Directory relative to ${basedir} which will be the default location for log files, unless the 'todir' property is set.

Fields inherited from class org.apache.anteater.test.log.BaseLogger

_destDir, _dt, _errors, _extension, _failures, _filenameFormat, _overwrite, _t0, _tasks, _testLog, _useFile

Fields inherited from class org.apache.anteater.test.BaseDataType

debug, debugWasSet

Fields inherited from class org.apache.tools.ant.types.DataType

checked, description, ref

Fields inherited from class org.apache.tools.ant.ProjectComponent

project

Constructor Summary

XMLLogger()

Method Summary

void	actionTaskError(String msg, Exception e) Indicates that an error occurred before any of the tests were attempted.
void	endActionTask(ActionTask task) Indicates that an ActionTask has ended.
void	endTest(MatcherTest test) Indicates that a test against the retrieved response has completed.
protected String	getFilenameFormat(ActionTask task) Get the format for log files.
protected boolean	getOverwrite(ActionTask task) Decide whether we're meant to be clobbering old log files
protected String	getProperty(ActionTask task, String key) Return a non-null value for a property.
void	startActionTask(ActionTask task) Indicates that an ActionTask (aka HTTP operation) has started.
void	startTest(MatcherTest test) Indicates the start of a test against the retrieved Response.
void	testError(String msg, Exception e) ActionTasks may fail unexpectedly, and these are classed as Errors and should be reported here.
void	testFailure(String msg, Exception e) If the ActionTask fails to validate the service, then a failure should be recorded via this method.
void	testLog(String msg) ActionTasks may log anything they think relevant to the user here.

Methods inherited from class org.apache.anteater.test.log.BaseLogger

setExtension, setFilenameFormat, setOverwrite, setTodir, setUseFile

Methods inherited from class org.apache.anteater.test.BaseDataType

debug, getDataTypeName, getDebug, getGroup, getRef, print, println, setDebug, setGroup, setGroup, setRefid

Methods inherited from class org.apache.tools.ant.types.DataType

circularReference, dieOnCircularReference, getCheckedRef, getDescription, isReference, noChildrenAllowed, setDescription, tooManyAttributes

Methods inherited from class org.apache.tools.ant.ProjectComponent

getProject, log, log, setProject

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.anteater.test.log.Logger

setExtension, setFilenameFormat, setOverwrite, setTodir, setUseFile

Methods inherited from interface org.apache.anteater.test.Groupable

setGroup, setGroup

Field Detail

DEFAULT_LOGDIR

protected String DEFAULT_LOGDIR

Directory relative to ${basedir} which will be the default location for log files, unless the 'todir' property is set.

Constructor Detail

XMLLogger

public XMLLogger()

Method Detail

startActionTask

public void startActionTask(ActionTask task)

Description copied from interface: Logger

Indicates that an ActionTask (aka HTTP operation) has started. At this point the underlying implementation should start a timer. We can also conceptually start writing a new testsuite file, and fill in a blank header:

Specified by:

startActionTask in interface Logger

Overrides:

startActionTask in class BaseLogger

actionTaskError

public void actionTaskError(String msg,
                            Exception e)

Description copied from interface: Logger

Indicates that an error occurred before any of the tests were attempted. Eg, if the HTTP request times out, or the DNS lookup fails.

If this event occurs, no further tests are expected to be logged.

Specified by:

actionTaskError in interface Logger

startTest

public void startTest(MatcherTest test)

Description copied from interface: Logger

Indicates the start of a test against the retrieved Response. An internal test timer should start. Can start writing: The 'tests' field of the actiontask will be incremented

Specified by:

startTest in interface Logger

Overrides:

startTest in class BaseLogger

testLog

public void testLog(String msg)

Description copied from interface: Logger

ActionTasks may log anything they think relevant to the user here.

Specified by:

testLog in interface Logger

Overrides:

testLog in class BaseLogger

testError

public void testError(String msg,
                      Exception e)

Description copied from interface: Logger

ActionTasks may fail unexpectedly, and these are classed as Errors and should be reported here. This will add an child to the current . The 'errors' field of the actiontask will be incremented.

Specified by:

testError in interface Logger

Overrides:

testError in class BaseLogger

testFailure

public void testFailure(String msg,
                        Exception e)

Description copied from interface: Logger

If the ActionTask fails to validate the service, then a failure should be recorded via this method. This will add a child to the current . The 'failures' field of the actiontask will be incremented.

Specified by:

testFailure in interface Logger

Overrides:

testFailure in class BaseLogger

endTest

public void endTest(MatcherTest test)

Description copied from interface: Logger

Indicates that a test against the retrieved response has completed. An internal test timer should end. If the request succeeded, an entry like: is written. If the request failed or generated an error, the @testError or

Specified by:

endTest in interface Logger

Overrides:

endTest in class BaseLogger

endActionTask

public void endActionTask(ActionTask task)

Description copied from interface: Logger

Indicates that an ActionTask has ended. The actiontask timer should be stopped Here we can also write the assembled actiontask to a file.

Specified by:

endActionTask in interface Logger

Overrides:

endActionTask in class BaseLogger

getOverwrite

protected boolean getOverwrite(ActionTask task)

Decide whether we're meant to be clobbering old log files

getFilenameFormat

protected String getFilenameFormat(ActionTask task)

Get the format for log files.

getProperty

protected String getProperty(ActionTask task,
                             String key)

Return a non-null value for a property.