Ant 和 JUnit 让您与 XP 梦想更近一步
Erik Hatcher (erik@hatcher.net)
eBlox 高级设计师
2001 年 8 月
逐步递增测试和持续编译是极端编程方法基础的两种。 把两者合并成为一个单独的、自动进行的过程 — 加上自动生成电子邮件报告 — 您就将在向 XP 梦想前进的道路上迈出坚实的步子。请跟随 Erik Hatcher,他向您展示了他是如何修改流行的 Ant 1.3 和 JUnit 测试框架,以达到让编译和测试过程完全的、用户化的自动化。
极端编程(XP)主要原则的其中之一是程序员必须执行定期的单元测试,还必须不断的将变化集成到类似产品的环境中去。此外,XP 建议尽可能让这个过程自动化。究竟,假如开发者像生产代码一样热切的创建测试案例,过程会相对的轻松些。
假如单元测试做的好的话,您应该会对每一段代码(非凡是由个别类标明的)都能正常运行而满足。执行持续的或者不稳定的编译让您明白当代码集成到生产环境时它是如何生效的。在开发周期中集成单元测试和定期自动的编译,向您和您的客户保证了代码发布时是可靠的。
在本文中,我将为自动的编译和测试过程采取实用的方法。使用 Ant 1.3 和 JUnit 测试框架,将像您展示如何自动化一个过程,这个过程捕捉每个测试套件运行的相关信息、生成有吸引力的报告并用电子邮件发送这个报告。虽然这些性能有许多隐含在 Ant 中,但我还是修改了许多核心任务来更好地满足要求。这些修改是本文的中心,它们将全部结合到 Ant 的下一个发行版中。可以在本文附带的源文件中找到所有补丁(请参阅参考文件)。您可能需要在阅读时回顾一下代码。此外,假如不熟悉 Ant 1.3,可能需要在继续这篇文章时学习官方的 Ant 文档(请参阅参考资料)。
为什么使用 Ant 和 JUnit?
Ant 1.3 是编译工具中的实际标准。由于用 Java 语言编写,Ant 是开放源代码的,可以在多种平台上运行,并为编译过程带来了很大的灵活性。JUnit 测试框架也是开放源代码的,它被广泛使用,并与 Ant 的编译过程集成(想学更多关于 Ant 和 JUnit 的知识,请参阅参考资料)。
Ant 1.3 加上可选的 <junit> 以及 <junitreport> 任务,不经修改就可以启动基本编译和测试的自动过程。这一过程如下:
运行 JUnit 测试实用程序
捕捉测试结果
创建吸引人的 Html 总结报告
一旦捕捉结果,就可以使用 XML 格式化器将每个测试套件运行的故障和错误数,连同软件包和类名还有测试套件的执行时间一起引入。对于每个测试套件,都有以下信息被捕捉:
测试案例的名称
执行的持续时间
故障或错误的类型(假如适用)
任何故障或错误的具体信息
这个构想中少了些什么
虽然功能上很完美,但上面描述的自动化既不理想也不完整。通过修改 JUnit 任务中的几个,我们可以创建按如下步骤运行的自动过程。
执行 JUnit 测试
将结果记录到 XML 文件或其它格式的文件
将结果转化为基于 XSL 格式的测试报告
将这个报告转化为 HTML 格式
用电子邮件发送报告
请给我更多数据
除了将 Ant 和 JUnit 扩展到能自动进行编译和测试的过程的程度外,我还添加了测试期间捕捉的标准数据。即,我需要知道使用的是什么操作系统、测试的日期/时间、支持测试运行的 JVM 版本以及 classpath。
为捕捉这个信息,我对 Ant 的 JUnit 相关类中的四个类:JUnitTask、JUnitTest、JUnitTestRunner 以及 XMLJUnitResultFormatter 做了简单修改。您会在附带的源文件中发现这些变化。
作为附带的优点,当扩展捕捉的数据时,最终捕捉的不仅是在测试套件运行时特定状态的信息,而且还包括了整个 Ant 的操作属性集。其中包含系统属性和内部 Ant 属性(例如用户定义的属性)。
让数据报告自动化
对 Ant 的 <junit> 任务进行扩展,使之能提供额外状态的信息之后,下一步就是启用自动化的数据报告。
使用 Ant 的最大优势之一是它的可扩展性。 对于使用带有 XML 格式化器(<formatter type="xml"/>)的 <junit> 任务运行的每个测试类,都创建了一个 XML 文件。<junitreport> 任务提供了一种很好的将所有收集的数据聚集到一起的方法。使用 XSLT,它会将测试数据转化为一种可以被轻松理解的 HTML 格式报告。
<junitreport> 可被轻松扩展,答应用户自定义的 XSLT 文件用作报告生成。XSLT 文件内建于 Ant 的 optional.jar 文件中。我将它和它必备的伴侣 toolkit.xsl 一起解压缩到本地目录,然后修改 overview_summary.xsl 文件以便将 Ant 属性引入报告。 而在 build.xml 中,我指定了“noframes”报告。在“测试套件”的相应部分中,添加到 overview_summary.xsl 中的代码断如清单 1 所示。
清单 1. overview_summary.xsl 代码段用以显示新添入的属性
<table>
<xsl:for-each select="./Properties/Property">
<xsl:sort select="@name"/>
<tr>
<td><xsl:value-of select="@name"/></td>
<td><xsl:value-of select="@value"/></td>
</tr>
</xsl:for-each>
</table>
一旦修改了这些文件,您就可以运行编译。负责运行 JUnit 测试和创建 HTML 报告的 build.xml 代码段如清单 2 所示。
清单 2. build.xml 中用以运行 JUnit 测试和创建 HTMl 报告的部分
<target name="junit" depends="compiletests"
description="Execute Unit Tests">
<junit>
<formatter type="xml" />
<batchtest>
<fileset dir="${build}">
<include name="test/**/*Test.class" />
</fileset>
</batchtest>
</junit>
<junitreport>
<fileset dir=".">
<include name="TEST-*.xml"/>
</fileset>
<report format="noframes" styledir="etc/xsl"/>
</junitreport>
</target>
关于这个编译代码段,您应该注重的主要事情是 <junitreport> 中 <report> 元素的 styledir 属性;它指定了用户自定义的 XSLT 文件所在的目录。为捕捉日期/时间戳,您需要在 build.xml 某处的 <junit> 任务前引入 <tstamp> 任务。
让电子邮件任务自动化