扩展 Rational Functional Tester 以测试 PDF 文件

package testScripts;
import resources.testScripts.pdfboxExampleHelper;

public class pdfboxExample extends pdfboxExampleHelper
{
  public void testMain(Object[] args)
    {
      String expected = "pdfFiles\\Expected PDF.pdf";
      String actual = "pdfFiles\\Actual PDF.pdf";

      vpPdfText("PDF",expected,actual).performTest();
      vpPdfText("PDF Date Mask",expected,actual,
        MASK_DATE, MASK_DATE_NAME).performTest();
    }
}

import java.util.Calendar;
import java.util.LinkedList;
import name.fraser.neil.plaintext.diff_match_patch;
import name.fraser.neil.plaintext.diff_match_patch.Diff;
import org.pdfbox.pdmodel.PDDocument;
import org.pdfbox.util.PDFTextStripper;
import com.rational.test.ft.script.RationalTestScript;
import com.rational.test.ft.vp.IFtVerificationPoint;

private String vpName;
private String expectedFilename;
private String actualFilename;
private String expectedText;
private String actualText;
private String mask;
private String maskName;
         
public PdfTextVerificationPoint(String vpName,
    String expectedFilename,
    String actualFilename) {
  super();
  this.vpName = vpName;
  this.expectedFilename = expectedFilename;
  this.actualFilename = actualFilename;
this.mask = "";
  this.maskName = "";
  this.expectedText = "";
  this.actualText = "";

  //Get the text from the pdf files.
  extractText();
}

public PdfTextVerificationPoint(String vpName,
    String expectedFilename,
    String actualFilename,
    String mask,
    String maskName) {
  super();
  this.vpName = vpName;
  this.expectedFilename = expectedFilename;
  this.actualFilename = actualFilename;
  this.mask = mask;
  this.maskName = maskName;
  this.expectedText = "";
  this.actualText = "";
  
  //Get the text from the pdf files.
  extractText();
}

/*
  * Description: Extracts the text from the expected and actual pdf
  * files. If a mask is defined, all occurrences of the substring
  * the mask defines are replaced with the text maskName.
*/
private void extractText()
{
try
  {
    //Load the PDF files
    PDDocument expectedDoc = PDDocument.load(expectedFilename);
    PDDocument actualDoc = PDDocument.load(actualFilename);
        
    //Extract the text from the PDF file.
    PDFTextStripper stripper = new PDFTextStripper();
    expectedText = stripper.getText(expectedDoc);
    actualText = stripper.getText(actualDoc);
         
    //Use the mask, if it is defined. Replace all substrings,
    //which match the regular expression, mask with maskName
    if(mask != "")
    {
      expectedText = expectedText.replaceAll(mask, maskName);
      actualText = actualText.replaceAll(mask, maskName);
}

    //Close the PDF files.
    expectedDoc.close();
    actualDoc.close();
    }
  catch (Exception e)
  {
    RationalTestScript.logException(e);
    RationalTestScript.stop();
  }
}

public boolean performTest(boolean compareTrueEqualsPass) {

  /*
   * Get a linked list representing the difference between
   * the text. Each node represents text which is the
   * same (EQUAL), text which was added to the actual text
   * (INSERT), or text which was deleted from expected text
   * (DELETE).
   */
  diff_match_patch dmp = new diff_match_patch();
  LinkedList<Diff> diffList =
    dmp.diff_main(expectedText,actualText,true);
  dmp.diff_cleanupSemantic(diffList);
        
  //Perform the test and log the results.
  if(expectedText.equals(actualText) == compareTrueEqualsPass) {
    RationalTestScript.logTestResult(
      "Verification point [" + vpName + "] passed.",
      true,
      dmp.diff_prettyHtml(diffList));
    return true;
  }
  else
  {
    RationalTestScript.logTestResult(
      "Verification point [" + vpName + "] failed.",
      false,
      dmp.diff_prettyHtml(diffList));
    return false;
  }
}

public boolean compare(double delayBetweenRetries,
    double maximumTestTime) {
  //Get the end time for the test.
  long endTime = (long) (Calendar.getInstance().getTimeInMillis()
    + (maximumTestTime * 1000));

  //perform the test until time runs out or the test passes.
  boolean result = compare();
  long nextTime = (long) (Calendar.getInstance().getTimeInMillis()
    + (delayBetweenRetries * 1000));

  while((nextTime < endTime) && result == false)
  {
    RationalTestScript.sleep(delayBetweenRetries);
    extractText();
    result = compare();
    nextTime = (long) (Calendar.getInstance().getTimeInMillis()
      + (delayBetweenRetries * 1000));
  }
  return result;
}

public boolean performTest(double delayBetweenRetries,
    double maximumTestTime, boolean compareTrueEqualsPass) {
  //Get the end time for the test.
  long endTime = (long) (Calendar.getInstance().getTimeInMillis()
    + (maximumTestTime * 1000));

  //perform the test until time runs out or the test passes.
  boolean result = (compare() == compareTrueEqualsPass);
  long nextTime = (long) (Calendar.getInstance().getTimeInMillis()
    + (delayBetweenRetries * 1000));

  while((nextTime < endTime) && result == false)
  {
    RationalTestScript.sleep(delayBetweenRetries);
    extractText();
    result = (compare() == compareTrueEqualsPass);
    nextTime = (long) (Calendar.getInstance().getTimeInMillis()
      + (delayBetweenRetries * 1000));
  }
  return performTest(compareTrueEqualsPass);
}

public boolean compare() {
  return expectedText.equals(actualText);
}

public boolean compareAndLog() {
  return compareAndLog(true);
}

public boolean compareAndLog(boolean compareTrueEqualsPass) {

  if(expectedText.equals(actualText) == compareTrueEqualsPass) {
    RationalTestScript.logTestResult(
      "Verification point [" + vpName + "] passed.",
      true);
    return true;
  }
  else
  {
    RationalTestScript.logTestResult(
      "Verification point [" + vpName + "] failed.",
      false);
    return false;
  }
}

public Object getActualData() {
  return actualText;
}

public Object getBaselineData() {
  return null;
}

public Object getExpectedData() {
  return expectedText;
}

public String getVPName() {
  return vpName;
}

public boolean performTest() {
  return performTest(true);
}

public boolean performTest(double delayBetweenRetries,
    double maximumTestTime) {

  return performTest(delayBetweenRetries,maximumTestTime,
      true);
}

package util;

import com.rational.test.ft.script.RationalTestScript;
import com.rational.test.ft.vp.IFtVerificationPoint;

/**
 * Description : This Super class contains methods which may
 * be used to compare pdf files.
 *
 * @since November 26, 2008
 */
public abstract class PdfBoxHelperSuperClass extends RationalTestScript
{
  /*
   * This regular expression matches a date time stamp in
   * the format mm/dd/yyyy hh:mm PM (or AM). It may be used
   * to mask the date from the expected and actual text of a
   * pdfTextVp.
   *
   */
  public static final String MASK_DATE = "[0-9]{2}/[0-9]{2}/[0-9]{4}";
  public static final String MASK_DATE_NAME = "***MM/DD/YYYY***";

  /*
   * Description: This method returns a verification point
   * for the text of a pdf file. It replaces any text in the
   * expected and actual files, which match the regular
   * expression defined in the mask parameter with maskName.
   * One can use the mask to remove text from the vp, which
   * would cause the vp to fail incorrectly. A date would be
   * a good example of text which could be masked.
   *
   */
  protected IFtVerificationPoint vpPdfText(String vpName,
      String expected,
      String actual,
      String mask,
      String maskName)
  {
    return new PdfTextVerificationPoint(vpName,
      expected,actual,mask, maskName);
  }
  /*
   * Description: This method returns a verification point
   * for the text of a pdf file.
   */
  protected IFtVerificationPoint vpPdfText(String vpName,
      String expected,
      String actual)
  {
    return new PdfTextVerificationPoint(vpName,expected,actual);
  }
}