Docjar: A Java Source and Docuemnt Enginecom.*    java.*    javax.*    org.*    all    new    plug-in

Quick Search    Search Deep

org.apache.batik.test
Class TestReportValidator  view TestReportValidator download TestReportValidator.java

java.lang.Object
  extended byorg.apache.batik.test.AbstractTest
      extended byorg.apache.batik.test.TestReportValidator
All Implemented Interfaces:
Test

public class TestReportValidator
extends AbstractTest

This Test implementation can be used to validate the operation of a specific test. A typical use is to create known error conditions and check that the input Test reports these errors properly.

This test checks that a given test status (passed or not) and a given error code is returned by a Test. A TestReportValidator is built with the Test to run, the expected status (passed or failed) and the expected error code. The TestReportValidator will pass if the expected values are produced by the TestReport created by the associated Test. Otherwise, it will fail with one of two error codes:
+ if the status is not the one expected, then the ERROR_UNEXPECTED_TEST_STATUS code is used.. The report description will have two entries: ENTRY_KEY_EXPECTED_STATUS and ENTRY_KEY_RECEIVED_STATUS, both of which are Strings. + if the status is the one expected, but if the error code differs from the expected one, then the ERROR_UNEXPECTED_ERROR_CODE code is used. The report description will have two entries: ENTRY_KEY_EXPECTED_ERROR_CODE and ENTRY_KEY_RECEIVED_ERROR_CODE.

Version:
$Id: TestReportValidator.java,v 1.4 2004/08/18 07:16:58 vhardy Exp $

Field Summary
static java.lang.String ENTRY_KEY_EXPECTED_ERROR_CODE
          The error description entry when the test fails
static java.lang.String ENTRY_KEY_EXPECTED_STATUS
          The entry describing the expected status when the test status is unexpected.
static java.lang.String ENTRY_KEY_RECEIVED_ERROR_CODE
          Entry describing the received error code which is different from the expected one.
static java.lang.String ENTRY_KEY_RECEIVED_STATUS
          Entry describing the received status which is different from the expected one.
(package private) static java.lang.String ERROR_UNEXPECTED_ERROR_CODE
          Error code used when the test error code is different from the expected error code.
(package private) static java.lang.String ERROR_UNEXPECTED_TEST_STATUS
          Error code used when the test status is is different from the expected status.
private  java.lang.String expectedErrorCode
          Error code expected from the TestReport
private  boolean expectedStatus
          Status expected from the TestReport
private  Test test
          Test that this validator checks
 
Fields inherited from class org.apache.batik.test.AbstractTest
id, name, parent
 
Constructor Summary
protected TestReportValidator()
          Protected constructor, for use by derived classes
  TestReportValidator(Test test, boolean expectedStatus, java.lang.String expectedErrorCode)
          Constructor
 
Method Summary
 TestReport runImpl()
          Subclasses should implement this method with the content of the test case.
protected  void setConfig(Test test, boolean expectedStatus, java.lang.String expectedErrorCode)
          Lets derived classes set the configuration parameters for this test.
 
Methods inherited from class org.apache.batik.test.AbstractTest
assertEquals, assertEquals, assertNull, assertTrue, error, getId, getName, getParent, getQualifiedId, reportError, reportException, reportSuccess, run, runImplBasic, setId, setName, setParent
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

test

private Test test
Test that this validator checks


expectedStatus

private boolean expectedStatus
Status expected from the TestReport


expectedErrorCode

private java.lang.String expectedErrorCode
Error code expected from the TestReport


ERROR_UNEXPECTED_TEST_STATUS

static final java.lang.String ERROR_UNEXPECTED_TEST_STATUS
Error code used when the test status is is different from the expected status.

See Also:
Constant Field Values

ERROR_UNEXPECTED_ERROR_CODE

static final java.lang.String ERROR_UNEXPECTED_ERROR_CODE
Error code used when the test error code is different from the expected error code.

See Also:
Constant Field Values

ENTRY_KEY_EXPECTED_ERROR_CODE

public static final java.lang.String ENTRY_KEY_EXPECTED_ERROR_CODE
The error description entry when the test fails

See Also:
Constant Field Values

ENTRY_KEY_RECEIVED_ERROR_CODE

public static final java.lang.String ENTRY_KEY_RECEIVED_ERROR_CODE
Entry describing the received error code which is different from the expected one.

See Also:
Constant Field Values

ENTRY_KEY_EXPECTED_STATUS

public static final java.lang.String ENTRY_KEY_EXPECTED_STATUS
The entry describing the expected status when the test status is unexpected.

See Also:
Constant Field Values

ENTRY_KEY_RECEIVED_STATUS

public static final java.lang.String ENTRY_KEY_RECEIVED_STATUS
Entry describing the received status which is different from the expected one.

See Also:
Constant Field Values
Constructor Detail

TestReportValidator

public TestReportValidator(Test test,
                           boolean expectedStatus,
                           java.lang.String expectedErrorCode)
Constructor


TestReportValidator

protected TestReportValidator()
Protected constructor, for use by derived classes

Method Detail

setConfig

protected void setConfig(Test test,
                         boolean expectedStatus,
                         java.lang.String expectedErrorCode)
Lets derived classes set the configuration parameters for this test.


runImpl

public TestReport runImpl()
                   throws java.lang.Exception
Description copied from class: AbstractTest
Subclasses should implement this method with the content of the test case. Typically, implementations will choose to catch and process all exceptions and error conditions they are looking for in the code they exercise but will let exceptions due to their own processing propagate.

Overrides:
runImpl in class AbstractTest