com.rational.test.ft.vp
Interface IFtVerificationPoint

All Superinterfaces:

com.rational.test.runtime.vp.IVerificationPoint

public interface IFtVerificationPoint
extends com.rational.test.runtime.vp.IVerificationPoint

Serves as the verification-point operational interface. There are three basic types of verification points (VP):

• Static (Recorded) - Verification points created at record time that are ready to play back at the appropriate time during playback.

• Manual - Verification points in which the data supplied by the script developer. The verification-point interface only compares and logs the result with persistence as appropriate.

• Dynamic - Verification points that are created at playback the first time that the script is run. These verification points act like recorded scripts after the baseline for the verification point is established.

Consider the following limitations and issues when acting directly against a verification-point data object:

• The verification-point name must be a script-relative unique name for any single instance of a verification point. If you reuse a script name, false negative results typically occur because the incorrect data is tested.

• Verification-point data must be value-class based. A value class is a class that has a registered value manager. Value managers enable the verification-point data to be persisted and compared in a class-specific manner.

• During playback, run the script in an interactive mode in cases where dynamic verification points automatically raise a record-style UI. If you run a script from the IDE, the script is automatically run in interactive mode. However, if you run the script from the command line when you initially create the dynamic baseline data, specify the -rt.interactive true option.

  Since:

  RFT1.0

  Method Summary

  boolean	compare() Compares the baseline, that is, expected data to the actual data.
  boolean	compare(double delayBetweenRetries, double maximumTestTime) Compares the expected result with the actual result.
  boolean	compareAndLog() Compares the baseline, that is, expected data to the actual data and logs the result to the script log.
  boolean	compareAndLog(boolean compareTrueEqualsPass) Allows failing verification points to return and log a passing result.
  java.lang.Object	getActualData() Enables access to the actual, that is, currently active data associated with a verification point.
  java.lang.Object	getBaselineData() Enables access to the baseline data associated with a verification point.
  java.lang.Object	getExpectedData() Enables access to the expected data associated with a verification point.
  java.lang.String	getVPName() Returns the name of the verification point or null if the name is not known at the time of the call.
  boolean	performTest() Performs a verification-point test.
  boolean	performTest(boolean compareTrueEqualsPass) Allows failing verification points to return and log a passing result.
  boolean	performTest(double delayBetweenRetries, double maximumTestTime) Allows failing verification points to retry until a passing result can be returned or the retry timeout is reached.
  boolean	performTest(double delayBetweenRetries, double maximumTestTime, boolean compareTrueEqualsPass) Allows failing verification points to retry until a passing result can be returned or the retry timeout is reached.
  void	setData(int dataInstance, java.lang.Object data)

  Method Detail

  performTest

  boolean performTest()

  Performs a verification-point test. This test includes all required steps, from loading the baseline to logging the result, as follows:
  

  • The baseline data is loaded from disk and cached as the expected data, unless this is a manual test that supplies the expected value.

  • For non-manual tests, the actual data is then constructed.

  • The expected result is compared to the actual.

  • The actual data is persisted to the log location.

  • The expected data is persisted to the log location.

  • The result of the comparison is logged in the log.

  The net result of these steps is that expected and actual verification point data instances are persisted to the log directory. Also, an appropriate entry is made into the log file. If for any reason these actions cannot be performed, an appropriate exception is thrown. For example, if a baseline file cannot be read from or written to, an IO exception may be thrown.

  Returns:

  A true value is returned if the passing result is logged, otherwise false is returned.

  Since:

  RFT1.0

  See Also:

  performTest(boolean)

  performTest

  boolean performTest(boolean compareTrueEqualsPass)

  Allows failing verification points to return and log a passing result.

  Parameters:

  compareTrueEqualsPass - If true the expected and actual data must match to get a passing result. If false the expected and actual data must NOT match to get a passing result.

  Returns:

  A true value is returned if the passing result is logged, false is returned for a failing result.

  Since:

  RFT1.1

  See Also:

  performTest(), performTest(double,double), performTest(double,double,boolean)

  performTest

  boolean performTest(double delayBetweenRetries,                     double maximumTestTime)

  Allows failing verification points to retry until a passing result can be returned or the retry timeout is reached.

  Parameters:

  delayBetweenRetries - the delay in seconds after a failed result is recaptured and retested.

  maximumTestTime - the maximum time in seconds spent attempting to receive a passing result. Note that at least one attempt will be made to return a failed result, even if this value is a zero or negative value.

  Returns:

  A true value is returned if the passing result is logged, false is returned for a failing result.

  Since:

  RFT2.0

  See Also:

  performTest(), performTest(boolean), performTest(double,double,boolean)

  performTest

  boolean performTest(double delayBetweenRetries,                     double maximumTestTime,                     boolean compareTrueEqualsPass)

  Allows failing verification points to retry until a passing result can be returned or the retry timeout is reached. Note that if compareTrueEqualsPass is false, this method will spin for the supplied interval if the actual value compares to true with the expected value. This spins until a passing result can be returned.

  Parameters:

  delayBetweenRetries - the delay in seconds after a failed result is recaptured and retested

  maximumTestTime - the maximum time in seconds spent attempting to receive a passing result. Note that at least one attempt will be made to return a failed result, even if this value is a zero or negative value.

  compareTrueEqualsPass - If true, the expected and actual data must match to get a passing result. If false, the expected and actual data must NOT match to get a passing result.

  Returns:

  A true value is returned if the passing result is logged, false is returned for a failing result.

  Since:

  RFT2.0

  See Also:

  performTest(), performTest(boolean), performTest(double,double)

  compare

  boolean compare()

  Compares the baseline, that is, expected data to the actual data. Note that the actual data is captured if it is not available. The result reflects the value-class comparison of the data.

  Since:

  RFT1.0

  See Also:

  compare(double,double)

  compare

  boolean compare(double delayBetweenRetries,                 double maximumTestTime)

  Compares the expected result with the actual result. If the compare fails, the actual value will be automatically recaptured and recompared when appropriate. The actual data cannot be recaptured with a manual verification point, which makes the retry irrelevant.

  Parameters:

  delayBetweenRetries - the delay in seconds after a failed result is recaptured and retested

  maximumTestTime - the maximum time in seconds spent attempting to receive a passing result. Note that at least one attempt will be made to return a failed result, even if this value is a zero or negative value.

  Since:

  RFT2.0

  See Also:

  compare()

  compareAndLog

  boolean compareAndLog()

  Compares the baseline, that is, expected data to the actual data and logs the result to the script log. Note that the actual data is captured if it is not available. This action extends the compare() method so that it too automatically logs the result in the script log.

  Returns:

  A true value is returned if the passing result is logged, false is returned if a failing result is logged.

  Since:

  RFT1.0

  See Also:

  compareAndLog(boolean)

  compareAndLog

  boolean compareAndLog(boolean compareTrueEqualsPass)

  Allows failing verification points to return and log a passing result.

  Parameters:

  compareTrueEqualsPass - If true, the expected and actual data must match to get a passing result. If false, the expected and actual data must NOT match to get a passing result.

  Returns:

  A true value is returned if the passing result is logged, false is returned if a failing result is logged.

  Since:

  RFT1.1

  See Also:

  compareAndLog()

  getBaselineData

  java.lang.Object getBaselineData()

  Enables access to the baseline data associated with a verification point. If the verification point does not use a baseline, null is returned. A baseline may not be available if:

  • A manual VP that supplies the expected value does not ever have a baseline.

  • A manual VP that supplies only an actual value has not been executed before.

  • A dynamic verification point has not been executed before.

  Since:

  RFT1.0

  getExpectedData

  java.lang.Object getExpectedData()

  Enables access to the expected data associated with a verification point. The expected data is a copy of the baseline data at the time a verification point is executed. For a manual verification point that supplies the expected data, the explicitly-supplied data is returned. If there is no expected or baseline object, null is returned.

  Since:

  RFT1.0

  getActualData

  java.lang.Object getActualData()

  Enables access to the actual, that is, currently active data associated with a verification point. Regarding the recorded (not the manual) data, the actual data is captured if it is not available and if the baseline data exists.

  Since:

  RFT1.0

  See Also:

  getBaselineData(), getExpectedData()

  getVPName

  java.lang.String getVPName()

  Returns the name of the verification point or null if the name is not known at the time of the call.

  Since:

  RFT1.0

  setData

  void setData(int dataInstance,              java.lang.Object data)