從 Ant Script 啟用程式碼涵蓋面

若要驗證您建置的程式碼是否符合您指定的程式碼涵蓋面接受準則，可以從 Ant Script 啟用程式碼涵蓋面。為此，您需要：

• 配置 Ant Script 來啟用程式碼涵蓋面
• 執行 Ant Script
• 產生程式碼涵蓋面統計
• 產生程式碼涵蓋面報告
• 停用程式碼涵蓋面

您也可以在工作台中檢視程式碼涵蓋面結果。

配置 Ant Script 來啟用程式碼涵蓋面

若要配置 Ant Script 來啟用程式碼涵蓋面，請將下列內容新增至 CLASSPATH 環境變數：
<install_dir>/plugins/com.ibm.rational.llc.engine_1.0.0.<version_number>
並在建置檔中定義一項新作業。例如：

<taskdef name="instrument" classname="com.ibm.rational.llc.engine.instrumentation.anttask.InstrumentationTask" classpath="${install_dir}/plugins/com.ibm.rational.llc.engine_1.0.0.<version_number>"/>

設備測試作業的格式為：

<instrument buildPath="" baseLineFile="" saveBackups="" outputDir=""/>

其中：

buildPath：

指定將收集其程式碼涵蓋面資料的檔案。建置路徑可參照類別檔名稱、jar 檔名稱或目錄名稱。它的定義方式可以像 Ant 中使用的任何其他路徑參照一樣。

baseLineFile：

指定儲存基準線檔案的路徑。基準線檔案是經過設備測試的程式碼與其比較，並針對其產生程式碼涵蓋面統計的檔案。它也用來作為報告產生 ant 作業的輸入。

saveBackups：

指定是否要將原始類別和 jar 檔重新命名為 *.bak。將 saveBackups 設定為 true 會產生備份檔；將 saveBackups 設定為 false 會導致改寫（並因此而流失）原始檔案。
附註：saveBackups 是選用的，其預設值為 false。

outputDir：

指定經過設備測試的檔案的儲存位置。依預設，經過設備測試的檔案的儲存位置會與正在設備測試中的檔案位置相同。

範例 1

在下列範例中，收集了 bin/ 中所有檔案的程式碼涵蓋面資料，基準線檔案儲存在 blfile.coveragedata 中，未產生這些檔案的備份，而經過設備測試的檔案則儲存在 coverageData_files 中。

<instrument saveBackups="false" baseLineFile="blfile.coveragedata" buildPath="bin/" outputDir="coverageData_files"/>

範例 2

在下列範例中，收集了 bin 中所有檔案的程式碼涵蓋面資料（參照名稱為 build.Dir），基準線檔案儲存在 blfile.coveragedata 中，並產生了這其中每個檔案的備份。

<path id="build.Dir"> <pathelement location="bin"/> </path>
<instrument saveBackups="true" baseLineFile="blfile.coveragedata" buildPathRef="build.Dir" />

範例 3

在下列範例中，收集了 bin/ 中所有檔案的程式碼涵蓋面資料，基準線檔案儲存在 blfile.coveragedata 中，並產生了這其中每個檔案的備份。

<instrument saveBackups="true" baseLineFile="blfile.coveragedata"> <buildPath> <pathelement location="bin"/> </buildPath> </instrument>

範例 4

在下列範例中，啟用了 bin/ 中目錄名稱包含 com 的所有子目錄的程式碼涵蓋面資料，但排除了名稱包含 Test 的子目錄中的檔案。產生了正在進行程式碼涵蓋面分析的每個檔案的備份，而基準線檔案則儲存在 blfile.coveragedata 中。

<instrument saveBackups="true" baseLineFile="blfile.coveragedata"> <buildPath> <fileset dir="bin"> <exclude name="**/*Test*"/> <include name="**/*com*/*"> </fileset> </buildPath> </instrument>

範例 5

在下列範例中，啟用了 bin/ 及 bin2/ 中所有檔案（bin 的子目錄中名稱包含 Test 的檔案除外）的程式碼涵蓋面資料。產生了正在進行程式碼涵蓋面分析的每個檔案的備份，而基準線檔案則儲存在 blfile.coveragedata 中。

<instrument saveBackups="true" baseLineFile="blfile.coveragedata"> <buildPath> <fileset dir="bin"> <exclude name="**/*Test*"/> </fileset> </buildPath> <buildPath> <pathelement location="bin2"/> </buildPath> </instrument>

執行 Ant Script

配置了 Ant Script 以啟用程式碼涵蓋面之後，您可以從指令行或工作台執行 Ant Script。

從指令行執行

若要從指令行執行 Ant Script：

1. 將 JAVA_HOME 環境變數設定為安裝了 JDK 的目錄。
2. 確保 CLASSPATH 環境變數包含 probekit.jar 檔的完整路徑和檔名。probekit.jar 檔位於 org.eclipse.hyades.probekit 子資料夾中，具有產品安裝之外掛程式資料夾的較高版本號碼及最新時間戳記。
3. 確保 CLASSPATH 環境變數包含 JAVA_HOME（到 Java 安裝位置的路徑，如此 JAVA_HOME/bin/java 是有效的）。
4. 確保 PATH 環境變數包含到 org.eclipse.hyades.probekit 子資料夾的完整路徑（適用於您使用的平台）。例如：
   • 在 Windows 上：
     <install_dir>\plugins\org.eclipse.hyades.probekit_<version>\os\win32\x86
   • 在 Linux 上：
     <install_dir>/plugins/org.eclipse.hyades.probekit_<version>/os/linux/x86
5. 將 LLC_PLUGIN 設定為到外掛程式資料夾的路徑：
   set LLC_PLUGIN=<install_dir>\plugins

範例

ant -lib=<install_dir>\plugins\org.eclipse.hyades.probekit_<version>\probekit.jar myTarget

從工作台執行

若要從工作台執行 Ant Script：

• 選取您的建置檔
• 按一下滑鼠右鍵選取執行身分 > Ant 建置...
• 選取「類別路徑」標籤
• 選取「使用者項目」
• 按一下新增外部 JAR...
• 將 <install_dir>\plugins\org.eclipse.hyades.probekit_<version>\probekit.jar 從具有較高版本號碼及最新時間戳記的 org.eclipse.hyades.probekit 外掛程式子資料夾新增至 CLASSPATH
• 選取「目標」標籤
• 勾選想要的目標
• 選取「環境」標籤
• 按一下新建... 按鈕
• 在「新建環境變數」對話框的「名稱」欄位中鍵入 LLC_Plugin，並在「值」欄位中鍵入 LLC_PLUGIN 路徑（例如，<install_dir>\plugins）
• 按一下確定
• 按一下新建... 按鈕
• 在「新建環境變數」對話框的「名稱」欄位中鍵入 PATH，並在「值」欄位中鍵入：<install_dir>\plugins\org.eclipse.hyades.probekit_<version>\os\win32\x86
• 按一下確定
• 按一下執行

產生程式碼涵蓋面統計

確保您的類別路徑包含下列內容：
<install_dir>\plugins\com.ibm.rational.llc.engine_1.0.0.<version_number>

若要從指令行產生程式碼涵蓋面統計，請從程式碼的上層目錄執行：

java -Dcoverage.out.file=C:\coverage_report\coverage_data.coveragedata com.ibm.rational.llc.example

附註：您可能需要設定您的 Java 來符合產品安裝的 Java。

產生程式碼涵蓋面報告

若要使用 Ant 產生報告：
下載 BIRT Runtime Report Engine 並解壓縮其內容。 設定下列環境變數：

• CLASSPATH － 指向 org.eclipse.equinox.common_<version_number>.jar
• LLC_COMMON_PLUGIN － 指向 com.ibm.rational.llc.common_1.0.0.<version_number>
• LLC_REPORT_PLUGIN － 指向 com.ibm.rational.llc.report.birt_1.0.0.<version_number>
• BIRT_HOME － 從 BIRT 執行時期指向 ReportEngine 目錄

程式碼涵蓋面報告作業的格式為：

<code-coverage-report outputDir="" coverageDataFile="" baseLineFiles=""> <filters> <filter type="" value=""/> </filters> <configurations> <configuration name="" value=""/> </configurations> </code-coverage-report>

其中：

outputDir：

指定報告結果的儲存位置。

coverageDataFile：

指定要對其產生報告的一個以上涵蓋面資料檔。它的定義方式可以像 Ant 中使用的任何其他路徑參照一樣。

baseLineFiles：

指定作為設備測試作業的一部分而產生的一個以上基準線檔案。它的定義方式可以像 Ant 中使用的任何其他路徑參照一樣。

filters：

選用：用於過濾報告結果。

filter：

type：要套用至報告的過濾器類型。

value：要套用至報告的過濾器值。

可用的過濾器：

• 行涵蓋面臨界值：設定行涵蓋面報告的臨界值，以顯示低於指定百分比值的資料。type=line_coverage_threshold, value=threshold value

Configurations：

選用：用於指定各種計算配置。

Configuation：

name：配置名稱。

value：配置的值。

可用的配置：

• 併入預設建構子：配置在計算程式碼涵蓋面時要排除還是包含預設建構子。依預設，會包含預設建構子。如果類別沒有定義任何建構子，則編譯器會產生預設的無引數建構子。但實際原始檔中並不會出現這個建構子。在程式執行期間，若此類別未實例化，則不會執行此隱藏的預設建構子，因此涵蓋面不會如預期那樣等於 100%。以下配置可以變更此行為：name=excludeDefaultConstructor, value=true or false

範例 1

在下列範例中，使用 coverage-data/blfile.coveragedata 作為基準線檔案，對 coverage-data/coverage.coveragedata 收集了產生的報告，報告儲存在 coverage-reports 中，並套用了臨界值為 80% 的 line_coverage_threshold 過濾器。計算程式碼涵蓋面時會排除預設建構子。

<code-coverage-report outputDir="coverage-reports/" coverageDataFile="coverage-data/coverage.coveragedata" baseLineFiles="coverage-data/blfile.coveragedata"> <filters> <filter type="line_coverage_threshold" value="80"/> </filters> <configurations> <configuration name="excludeDefaultConstructor" value="true"/> </configurations> </code-coverage-report>

範例 2

在下列範例中，使用 blfile1.coveragedata 和 blfile2.coveragedata 作為基準線檔案，對兩個涵蓋面檔案 coverage1.coveragedata 和 coverage2.coveragedata 收集了產生的報告，報告則儲存在 coverage-reports 中。依預設，在計算程式碼涵蓋面時會包含預設建構子。

<code-coverage-report outputDir="coverage-reports/" coverageDataFile="coverage-data/coverage1.coveragedata;coverage-data/coverage2.coveragedata" baseLineFiles="coverage-data/blfile1.coveragedata;coverage-data/blfile2.coveragedata"> </code-coverage-report>

在工作台中檢視程式碼涵蓋面結果

若要在工作台中檢視 Ant Script 程式碼涵蓋面結果：

• 匯入涵蓋面資料結果檔案：
• 選取檔案 > 匯入...
• 選取程式碼涵蓋面 > 程式碼涵蓋面資料檔
• 按下一步按鈕
• 選取「檔案系統」匯入類型
• 按下一步按鈕
• 輸入要匯入的涵蓋面資料檔（在上例中為 coverage_data.coveragedata）的位置、它將匯入到的資料夾名稱以及與涵蓋面資料檔相關聯的專案
• 按一下完成按鈕。如果尚未針對程式碼涵蓋面啟用專案，則系統會提示您重建專案。
• 產生程式碼涵蓋面報告：
• 選取執行 > 程式碼涵蓋面 > 產生報告...
• 選取名稱直欄下的一個以上 Java 啟動
• 選擇 Eclipse 型或 HTML 型報告
• 按一下執行

附註：您也可以改為選取一個以上涵蓋面資料檔、按一下滑鼠右鍵，然後選取程式碼涵蓋面 > 產生報告...。指定報告的關聯專案以及資料夾位置，然後按一下完成。

停用程式碼涵蓋面

若要使用 ant 作業停用經過設備測試的類別，請重新編譯專案，或將 .class 檔案取代為 .class.bak 檔案（若 saveBackups 已啟用）。

© Copyright IBM Corporation 2007, 2008. All Rights Reserved.