持续集成 Java手册

一、概念

Martin Fowler的文章：Continuous Integration 中文翻译：持续集成

二、工具

传统工具：JBuilder，VisualSourceSafe，Rational ClearCase

自动编译工具：Ant

回归测试工具：JUnit

代码检查工具：CheckStyle

持续集成工具：CruiseControl

三、步骤

• CruiseControl监控远程版本控制系统的变化

• 变化发生时CruiseControl调用编译工具进行编译（Ant等）

• 编译成功后调用JUnit进行回归测试

• 编译成功后调用CheckStyle进行代码检查

• 打包，部署，更新版本控制系统

• 完毕后将编译结果、测试结果、代码检查结果发送至开发人员、主管经理，并发布至网站，甚至报警器

所有这一切都是按照编制好的脚本自动进行的

四、实施示例

目前我们使用的是ClearCase，主控软件为CruiseControl，其脚本文件为cccc.xml

• 配置远程版本控制系统

<modificationset quietperiod="60">

<clearcase branch="main" viewpath="D:/cc_view/chelseafc/Nucleus2.0/Port" recursive="true" />

</modificationset>

• 配置编译工具

<schedule interval="60">

<ant antscript="C:/Java/JBuilder2005/thirdparty/ant/bin/ant.bat" buildfile="D:/cc_view/chelseafc/Nucleus2.0/Port/clearcase-build.xml" target="cleanbuild" multiple="1" />

</schedule>

• 配置测试用例（在ant的配置文件中）

<target name="test" depends="init" description="Run unit tests">

<delete dir="${junit.results}" />

<mkdir dir="${junit.results}" />

<junit fork="yes" haltonfailure="yes">

<classpath refid="project.class.path" />

<formatter type="plain" usefile="false" />

<formatter type="xml" />

<batchtest todir="${junit.results}">

<fileset dir="${build.dir}" includes="**/*TestCase.class" />

<fileset dir="${build.dir}" includes="**/*TestSuite.class" />

</batchtest>

</junit>

</target>

• 配置报告形式

<publishers>

<currentbuildstatuspublisher file="currentbuild.txt" />

<htmlemail mailhost="mail.chelseafc.com.cn" returnaddress="[e-mail]" subjectprefix="ContinuousIntegration:" buildresultsurl="http://chelsea:8044/cruisecontrol/buildresults" spamwhilebroken="true" xsldir="F:/software/Agile.Net/cruisecontrol-2.2/reporting/jsp/xsl" css="F:/software/Agile.Net/cruisecontrol-2.2/reporting/jsp/css/cruisecontrol.css" logdir="D:/Tomcat 4.1/webapps/cruisecontrol/samplelogs">

<always address="[e-mail]" />

<always address="[e-mail]" />

<map alias="chelsea" address="[e-mail]" />

</htmlemail>

</publishers>

• 其中CruiseControl暂时没有提供代码检查工具的支持，建议使用Ant来调用CheckStyle，示例如下（没有真正运行过）：

<target name="web.checkstyle">

<mkdir dir="${target.temp}/checkstyle" />

<mkdir dir="${target.web}/checkstyle" />

<taskdef resource="checkstyletask.properties">

<classpath>

<fileset dir="${support.tools}/checkstyle31" includes="**/*.jar"/>

</classpath>

</taskdef>

<copy file="${support.tools}/checkstyle31/custom.xml" overwrite="true" tofile="${target.temp}/checkstyle/custom.xml">

<filterset>

<filter token="source.java" value="${basedir}/${source.java}" />

<filter token="target.checkstyle" value="${basedir}/${target.temp}/checkstyle" />

</filterset>

</copy>

<checkstyle config="${target.temp}/checkstyle/custom.xml" failOnViolation="false">

<fileset dir="${source.java}/main" includes="**/*.java" />

<formatter type="plain" />

<formatter type="xml" toFile="${target.temp}/checkstyle/checkstyle_errors.xml" />

</checkstyle>

<style basedir="${target.temp}/checkstyle" destdir="${target.web}/checkstyle" includes="checkstyle_errors.xml" style="${support.tools}/checkstyle31/checkstyle-noframes.xsl" />

</target>

• 打包、部署（在ant的配置文件中）

<target name="jar">

<jar jarfile="${dist.dir}/nucleus_engine.jar">

<fileset dir="${build.dir}" />

</jar>

<jar jarfile="../../M1/Web/lib/service_gateway.jar">

<fileset dir="${build.dir}" />

</jar>

</target>

<target name="war">

<ant antfile="build-war.xml" />

</target>

• check out 版本控制工具中的配置项（在ant的配置文件中）

<target name="checkoutzipfile">

<cccheckout viewpath="../Release/nucleus2.0.zip" reserved="true" branch="main" />

</target>

• 压缩zip文件（在ant的配置文件中）

<target name="zip">

<zip destfile="../Release/nucleus2.0.zip" basedir="../Release/nucleus2.0" />

</target>

• check in 版本控制工具中的配置项（在ant的配置文件中）

<target name="checkinzipfile">

<cccheckin viewpath="../Release/nucleus2.0.zip" identical="true" />

</target>

五、几点提示

• CruiseControl会自动根据本地ClearCase的View监控远程VOB

• 其实除了监控远程版本控制系统外其它的任务都可以由Ant来完成，CC只负责监控变化并调用Ant即可

• CruiseControl2.2的<htmlemail>好像无法在jdk5.0下运行，如果需要集成jdk5.0的项目，则需要为Ant的<javac>指定source和target，而CruiseControl2.2依然用jdk1.4启动

• 可以为cruisecontrol.bat加入启动参数“-port 8055”，这样可以用JMX（http://localhost:8055）来控制cc

• 最好避免中文路径，否则就需要手工为几个Xml格式的文件，如cc的report Servlet的Web.xml等加入编码方式“<?xml version="1.0" encoding="UTF-8" ?> ”，或者将中文路径映射为虚拟硬盘：“subst Y: "D:/cc_view/chelsea/Platform/开发/Nucleus2.0/Source"”

• 中文log无法正常显示时，需要设置CruiseControl配置文件中<log>元素的“encoding”属性，如：

  <log dir="D:/Tomcat 4.1/webapps/cruisecontrol/samplelogs" encoding="utf-8">

  <merge dir="D:/cc_view/chelseafc/Nucleus2.0/Port/test-results" />

  </log>

• 编译失败后，在下次checkin之前，一般不需要重新编译，这时可设置<project >的“buildafterfailed”属性为false来避免重新编译

• <htmlemail>的几个属性好像没有缺省设置，虽然文档里说从2.1.7开始有缺省设置，包括xsldir，css，logdir

• 可使用JBuilder辅助生成ant文件

• 各种工具的安装、使用，在各自的文档里都非常详细，网上亦有无数资源

六、参考资料

• DailyBuild全攻略

• Draco.Net

• 持续集成.Net手册