單元測試

一般建議使用 AbstractITextTestkit 或 AbstractITextTest 為父類別，實作單元測試，因為有一些附加的測試特性可以選用。

AbstractITextTestkit

基礎的測試類別，主要功能有二：提供 PDFDocumentManager 以及依據測試 METHOD 名稱產出輸出檔案物件。 建構子可傳入ITextTestConfig以定義測試設定(也可使用預設無參數設定)。

public class GSS0010Test extends AbstractITextTestkit {

    final GSS0010 gss0010 = new GSS0010();

    public GSS0010Test() {
        super(prepareConfig());
    }

    private static ITextTestConfig prepareConfig() {
        final ITextTestConfig config = new ITextTestConfig();
        config.setFixedBaseDir(".");
        config.setPath(UdeSystemPropertyItem.GLOBAL_RESOURCE_PATH, "${BASEDIR}");
        config.iTextConfigPath = "classpath:itext-config-test.properties";
        config.outputRoot = new File(FileUtils.getTempDirectory(), "__Report_Output");
        config.keepOutputFile = true;
        config.showMarginBorder = true;
        return config;
    }

    /** 產出檔名為：GSS0010Test/[GSS0010Test]PDF.pdf     */
    @Test
    public void testPDF() {
        this.gss0010.generatePDF(getDocumentManager(), createFileByTestName(DocumentFormat.PDF));
    }

    /** 產出檔名為：GSS0010Test/[GSS0010Test]Excel.xlsx  */
    @Test
    public void testExcel() {
        this.gss0010.generateExcel(createFileByTestName(DocumentFormat.EXCEL));
    }

}

以下是 ITextTestConfig 的可設定內容：

• iTextConfigPath: iText設定檔路徑，預設為 classpath:itext-config-default.properties。
• outputRoot : 指定輸出PDF的根目錄。預設為系統TEMP路徑下的__Report_SAMPLE子目錄。
• keepOutputFile : 執行完成後，是否保留檔案，預設為TRUE。但在 CI 環境中，應以環境變數 keepOutputFile 設定為 FALSE。
• showMarginBorder : 輸出的範例PDF，是否額外輸出邊界虛線，預設為TRUE。此項設定可以有效幫助開發人員調整版面設定。如果要產出給客戶做需求確認時，可以視需求設為FALSE。
• UDE 套件設定
  • setFixedBaseDir(String) : 在單一測試中，抽換所使用的系統瑻境變數 BASEDIR 值。
  • setPath(UdeSystemPropertyItem, String) : 在單一測試中，指定系統瑻境路徑變數值。

AbstractITextTest

TODO : 細部說明待補