内容


使用 Ant 自动生成项目构建版本

创建、导出、部署和测试构建版本

Comments

引言

对于多版本项目,要提供新版本来跟上新功能或缺陷报告增加的速度,并同时仍然保持可接受的质量水平,可能是一项不小的挑战。构建自动化可确保准确性和消除人为错误的可能性,从而部分地解决此问题。自动化还可让成员将精力集中在需要人类智慧的问题上,而不用分心进行自动化后通常能更快更有效地运行的任务,从而提高了团队效率。

在本文中,我们将了解如何实现构建过程的自动化,以获得较高的效率和质量。本文中的示例将利用 Rational 软件交付平台(IBM Rational Software Delivery, SDP)中的内置 Ant 支持(构建自动化过程作为 Ant 构建文件实现)以及运行时(如 WebSphere Application Server)中的支持。本文最后将给出一些可以用于进一步简化此流程的可选功能。

项目规划注意事项

尽管在构造* 阶段之前并不会开始执行,但任务自动化应该在细化* 阶段就进行规划,以便在交付代码进行测试之后即能供实现团队使用。在进行了分析和设计后,组件的远景以及应该如何对其进行构建、测试和部署就应该清楚了。在此远景的启发下,应该以允许重复的方式开始完成任务自动化工作。

为了便于进行重复,可能需要在开始前进行一些任务准备工作(如准备测试数据),并在完成后进行清理。对软件配置管理(软件存储库)、设计或目标部署环境的更改也应该反映在任务自动化中。在工作预估和项目规划期间,应该考虑实现和维护此自动化的开销。可以进行测试,以观察任务自动化对具有多个迭代的项目的影响,确定何时每个迭代的构建、单元测试和部署的时间大幅度减少。

自动化环境

本文中的自动化过程适合于基于 Rational SDP 的工具,如:

对于部署平台,可以将其用于使用 WebSphere Application Server 作为基础的 WebSphere 应用服务器系列,如 WebSphere Application ServerWebSphere Application Server Network DeploymentWebSphere Process Server

示例过程可以应用于其他 Rational 和 WebSphere 产品。为了简单起见,我们将所使用的工具称为集成开发环境(Integrated Development Environment,IDE)。

准备环境

此过程可以在各种环境配置上运行。图 1 显示了一个示例环境。

图 1. 自动化环境
自动化环境

此环境包含一个或多个开发工作站,供开发人员编写代码之用。更改保存到存储库中。此处我们假设使用 Rational ClearCase 存储库,为每个开发工作站提供了一个快照视图。

开发工作站应该安装了基于 Rational SDP 的工具。开发工作站应该具有配置为使用软件存储库的工作区。文章“使用 Rational Software Architect 和 ClearCase Remote Client”提供了关于如何使用 Rational ClearCase 进行此类配置的更多信息。还可以使用其他存储库;有关将 Ant 与并发版本系统 (Concurrent Versions System, CVS) 一起使用的更多信息,请参见参考资料

任何开发工作站都可以作为构建工作站使用。最好将用于进行构建的工作站分离开,以避免开发人员间出现使用竞争。构建工作站应该与任何其他开发计算机具有相同的配置,而且能够访问以下服务器:

  • 部署服务器(用于部署构建版本)
  • SMTP 服务器(用于通知测试团队)
  • FTP 服务器(用于上载构建版本进行备份或其他用途)

可以在 Windows® 或 Linux® 上实现典型的开发或构建工作站。对于目标部署服务器,WebSphere 产品提供了更为广泛的受支持平台。

Ant 构建文件

所有自动化步骤都将包括在一个 Ant 构建文件中,以便进行维护。如果您尚不熟悉 Rational 工具,请按照以下所述进行操作:

  1. 从 File 菜单选择 New > Project > Java > Java Project
  2. 在 Project name 字段中输入 ar-autotaskcode.zip,并单击 Finish
  3. 右键单击 AutomationScripts 项目并从上下文菜单中选择New > Other。从 New 对话框中选择 XML > XML 并单击 Next
  4. 从 Create XML file 对话框中选择 Create XML file from scratch,然后单击 Next
  5. 输入 build.xml 作为文件名。单击 Finish。(这就是我们在此要涉及的所有步骤。)
  6. 列出 Ant 构建文件,如清单 1 中所示。

    清单 1. Ant 构建文件的初始布局
    <?xml version="1.0" encoding="UTF-8"?>
    <project name="Automation Project" default="init" basedir=".">
    <!-- Read project properties from a properties file. -->
    <property file="build.properties" />
    <!-- A stub for the default target -->
     <target name="init" description="Initialize automation environment">
     <!-- Set the standard DSTAMP, TSTAMP, and TODAY properties. -->
     <tstamp />
     <!-- Set a variable to host environment variables. -->
     <property environment="env" />
     <!-- Print the current WORKSPACE value. -->
     <echo message="Workspace:
     ${env.WORKSPACE}" />
     <!-- Delete old export directory. -->
     <delete dir="${destination.dir}" />
     <!-- Create the target export directory for the build. -->
     <mkdir dir="${destination.dir}" />
     </target>
    </project>

    可以现在下载完整的 Ant 构建文件 ar-autotaskcode.zip。

  7. 在包含 Ant 构建项目的同一个目录中创建属性文件来存储其属性。ar-autotaskcode.zip 中也提供了完整的属性文件。

  8. 选择 Window > Show View > Other > Ant > Ant,以显示 Ant 视图。将您的 build.xml 拖放到 Ant 视图中。通过使用 Ant 视图,可以浏览和运行 Ant 构建文件的不同任务。在 Ant 视图中右键单击 Ant 项目 Automation Project,在出现的上下文菜单中选择 Open With Ant Editor,也可以对构建文件进行编辑。

现在 Ant 构建文件已经准备好开始添加表示自动化过程的新 Ant 目标了。

实现构建过程自动化

图 2 显示了构建自动化程序的摘要。

图 2. 自动化过程
自动化过程
自动化过程

此部分将对这个过程的每个步骤进行详细描述。

  1. 从存储库获得最新的代码

    第一步是从 ClearCase 存储库获得最新的代码,如清单 2 中所示。

    清单 2. 从 ClearCase 存储库更新工作区
    <target name="updateview" depends="init" description="Update ClearCase snapshot view">
    						
    <!-- update snapshot view -->
    
    <ccupdate viewpath="${workspace.dir}" graphical="false" overwrite="true" 
    currenttime="true" /> </target>

    由于工作区配置为指向 ClearCase 视图,更新视图实际上将更新工作区内容。

  2. 运行代码检查

    可以实现代码检查自动化。尽管不能消除手动代码检查需求,但建议的最佳实践是,采用自动化检查来确定开发团队在代码质量标准方面所处的位置。Rational SDP 提供了内置的代码检查支持。(有关如何从 Ant 进行调用的更多信息,请参见 Code review headless mode reference。)

    另外还可以使用多种工具来执行自动化代码检查,如 PMD 和 CheckStyle。清单 3 中的示例说明了如何将 PMD 作为 Ant 任务调用并生成 HTML 格式的结果。要运行此任务,需要将 pmd-3.8.jar、jakarta-oro-2.0.8.jar 和 jaxen-1.1-beta-10.jar 放置在 lib.dir 属性所指定的目录。

    清单 3. 使用 PMD 进行自动化代码检查
    <target name="reviewcode" description="Review code using PMD">
      <taskdef name="pmd" classname="net.sourceforge.pmd.ant.PMDTask" 
      classpath="${lib.dir}/pmd-3.8.jar" />
        <pmd shortFilenames="true">
    	<!-- Determine the ruleset to be used -->
    	<ruleset>rulesets/favorites.xml</ruleset>
    	<ruleset>basic</ruleset>
    	<!-- Generate and HTML report into the designated directory -->
    	<formatter type="html" 
    toFile="${report.dir}/pmd_automated_code_review_report.html" />
    	<!-- Files to be configured for review -->
    	<fileset dir="${workspace.dir}/">
    	<!-- Include all .java files except those under directories that are 
    	   automatically generated -->
    	<include name="**/*.java" />
    	<!-- A sample exlusion directory that has generated java source code -->
    	<exclude name="**/generated/**/*.java" />
    	</fileset>
    	</pmd>
    </target>

    执行了此步骤后,将在 report.dir 属性指定的目录下找到 HTML 格式的 pmd_automated_code_review_report.html。(有关自动化代码检查的更多信息,请参见参考资料部分。)

  3. 构建代码

    现在我们使用 IDE 中提供的内置功能来构建要包括在构建版本中的不同项目。

    对于要在 IDE 中运行的 SDP 提供的 Ant 任务,Ant 构建文件需要在与工作区相同的 Java™ Runtime Environment (JRE) 中运行。否则,如果从命令行运行,runAnt 批处理文件将进行所需的初始化工作,以将这些任务的定义包括进来。这将在运行过程时的选项部分进行讨论。清单 4 中的代码使用 IDE 内置的“projectBuild”Ant 任务构建存在于工作区中的项目之一。

    清单 4. 构建单个项目
    <target name="buildproject" description="Build a project">
    	
    <!-- Build the project with some options -->
    
    <projectBuild projectName="${project.name}" BuildType="full" failonerror="false" 
       DebugCompilation="false" />
    
    <!-- Print build errors -->
    
    <echo message="projectBuild: projectName=${project.name}
    
    project Error Count=${ProjectErrorCount}
    
    project Error Messages=${ProjectErrorMessages}" />
    
    </target>

    执行时可能出现的错误会输出到控制台,但构建不会终止。要更改此行为,可以将 failonerror 属性设置为 true

    可以通过将 project.name 属性设置为要构建的项目的名称而为不同的项目使用相同的目标,如清单 5 中所示。

    清单 5. 构建一组项目
    <target name="buildall">
     <!-- Invoke the "buildproject" target for a project from the workspace -->
      	<antcall target="buildproject">
    	<!-- Pass the name of the project to be built -->
    	<param name="project.name" value="MyFirstProject" />
    	</antcall>
    	<!-- Invoke the "buildproject" target to build another project -->
    	<antcall target="buildproject">
    	<!-- The project name is different -->
    	<param name="project.name" value="MySecondProject" />
    	</antcall>
    	</target>
  4. 记录构建版本号

    有时候会忽略此步骤。为所发布的每个构建版本使用一个版本号的方法对跟踪缺陷和新添加的功能非常有用。Ant 提供了一个简单 buildnumber 任务,可实现此目的。清单 6 显示了根据需要记录更多有关版本信息的另一种方法。

    清单 6. 记录构建信息
    <target name="baseline" description="Record build information">
    <!-- The name of the file that holds the build information. If no such file exists, a new 
       one gets created. -->
    <propertyfile file="${destination.dir}/build.info">
    <!-- Initial build number is 0001. Then, any subsequent build increments
    this number by one each time. --> <entry default="0001" key="build.number" operation="+" pattern="0000" type="int" /> <!-- Records the current time to the same file. --> <entry default="now" key="build.time" pattern="yyyy.MM.dd-HH.mm" type="date" /> </propertyfile> </target>

    "baseline" 目标创建名为 build.info 的文件,其中包含版本号和构建时间。如果该文件已存在,则会使用新版本号和构建时间对其进行更新。您可能需要在此文件中添加更多信息,如运行构建操作的用户的名称或创建构建版本的计算机的名称。还可以按照提取 "init" 目标中 WORKSPACE 环境变量的相同方法从环境提取此信息,如 Ant 构建文件中所述。

  5. 运行预部署单元测试

    此步骤调用 JUnit 测试用例,这些用例不需要运行时资源(如数据源等)。我们假定您已经获得了运行此步骤所需的此类测试用例。清单 7 说明了如何在工作区调用所有 JUnite 测试用例,并假设全部都以单词“Test”作为结尾。当然,如果命名约定不同,则可以对此进行相应的更改。

    清单 7. 调用 JUnit 测试用例
    <target name="predeptests" description="Invoke pre-deployment JUnit test cases">
     <!-- Run JUnit and print a summary when done. -->
      <junit printsummary="yes" haltonfailure="no">
      <classpath>
      <!--
      Set the class path to include all needed classes that are used by the JUnit test cases.
      -->
      </classpath>
      <!-- Generate reports in an XML format -->
      <formatter type="xml" />
      <!-- Run a batch of JUnit test cases and generate reports to the report directory. -->
      <batchtest fork="yes" todir="${report.dir}">
      <fileset dir="${workspace.dir}/">
      <!-- Include all .java files that end with "Test" -->
      <include name="**/*Test.java" />
      </fileset>
      </batchtest>
      </junit>
      </target>

    JUnit Ant 任务需要 junit.jar。可以将其放在 "init" 目标中提到的 Ant 构建项目的属性文件的 lib.dir 属性指定的目录下。可以使用 JUnitReport Ant 任务将 JUnit 任务生成的报告转换为其他格式。在我们的示例中,报告将在 report.dir 属性指定的目录中生成。

  6. 导出可部署单元

    在此步骤中,我们要对可部署单元进行打包,以准备好在下一步中进行部署。清单 8 显示了如何导出企业应用程序。

    清单 8. 导出企业应用程序
    <target name="exportear" description="Export an Enterprise Application">
     <!-- Export EAR file-->
     <earExport earprojectname="${project.name}" 
    earexportfile="${destination.dir}/${project.name}.ear" exportsource="false" IncludeProjectMetaFiles="false"
    overwrite="true" /> </target>

    与步骤 3(构建代码)期间处理一组项目的方式类似,我们可以在导出企业应用程序时采用相同的方式。清单 9 中的代码说明了如何进行此工作。

    清单 9. 导出企业应用程序
    <target name="exportall" depends="buildall" 
    description="Export a set of Enterprise Applications"> <!-- Export an Enterprise Application --> <antcall target="exportear"> <!-- Pass the name of the project to be exported --> <param name="project.name" value="MyFirstEAR" /> </antcall> <!-- Export another Enterprise Application --> <antcall target="exportear"> <!-- The name of the other Enterprise Application --> <param name="project.name" value="MySecondEAR" /> </antcall> </target>

    对于其他项目类型,可以使用 warExportejbExportjar 任务(分别用于导出 Web 模块、EnterpriseJavaBeans (EJB) 模块和 Java 库)。这些都是 SDP 提供的 Ant 任务。

  7. 部署到目标服务器

    在此步骤中,我们将部署上一步导出的单元。对于我们的自动化过程,我们将使用包装 wsadmin 的内置 Ant 任务。清单 10 显示了 wsListAppswsUninstallAppwsInstallApp Ant 任务,这些任务分别提供用于列出已安装应用程序、卸载企业应用程序和安装企业应用程序的管理功能。请记得在运行此步骤前启动目标应用服务器。

    关于 wsadmin 和 Ant
    WebSphere Application Server Ant 支持基于其命令行管理工具 wsadmin。作为本文示例的替代方法,可以使用 Exec Ant 任务调用 wsadmin 并按照调用任何其他库执行文件的方式传递程序参数。WebSphere Application Server 还提供了包装 wsadmin 的 Ant 任务 WsAdmin。还有其他包装特定操作的 WsAdmin 任务的 Ant 任务,如应用程序安装方面的 InstallApplicationStartApplication。我们的示例中使用了后一个选项。

    清单 10. 管理企业应用程序
    <target name="listapps" description="List installed Enterprise Applications">
    <!-- Define the wsListApps task that lists installed Enterprise Applications. -->
    <taskdef name="wsListApps" classname="com.ibm.websphere.ant.tasks.ListApplications">
    <!-- Include all JAR files under WebSphere Application Server lib directory. -->
    <classpath>
    <fileset dir="${was.home}/lib/" includes="*.jar" />
    </classpath>
    </taskdef>
    <!-- List all installed Enterprise Application the profile specified. -->
    <wsListApps profilename="${was.profilename}" wasHome="${was.home}/" conntype="SOAP"
       host="${was.hostname}" port="${was.hostport}" user="${was.username}" 
        password="${was.userpassword}" />
    </target>
    <target name="uninstallapp" depends="listapps" 
    description="Uninstall an Enterprise Application"> <!-- Define the wsUninstallApp task that uninstalls an Enterprise Application. --> <taskdef name="wsUninstallApp"
    classname="com.ibm.websphere.ant.tasks.UninstallApplication"> <!-- Include all JAR files under WebSphere Application Server lib directory. --> <classpath> <fileset dir="${was.home}/lib/" includes="*.jar" /> </classpath> </taskdef> <!-- Uninstall an Enterprise Application under the profile specified. --> <wsUninstallApp profilename="${was.profilename}" wasHome="${was.home}/" application="${project.name}" conntype="SOAP" host="${was.hostname}"
    port="${was.hostport}" user="${was.username}" password="${was.userpassword}"
    failonerror="false" /> <!-- Invoke listapps target to list installed applications. --> <antcall target="listapps" /> </target> <target name="installapp" depends="uninstallapp"> <!-- Define the wsInstallApp task that installs an Enterprise Application. --> <taskdef name="wsInstallApp" classname="com.ibm.websphere.ant.tasks.InstallApplication"> <!-- Include all JAR files under WebSphere Application Server lib directory. --> <classpath> <fileset dir="${was.home}/lib/" includes="*.jar" /> </classpath> </taskdef> <!-- Install an Enterprise Application under the profile specified. --> <wsInstallApp profilename="${was.profilename}" wasHome="${was.home}/"
    ear="${destination.dir} /${project.name}.ear" conntype="SOAP"
    host="${was.hostname}" port="${was.hostport}" user="${was.username}"
    password="${was.userpassword}" failonerror="false" /> <!-- Invoke listapps target to list installed applications. --> <antcall target="listapps" /> </target>

    根据需要部署的应用程序的数量不同,可以使用 project.name 参数的不同值多次调用 installapp 目标。installapp 目标将调用 uninstallapp 目标来确保企业应用程序已经卸载(如果已安装)。两个目标多次调用 listapps,以在卸载和安装前后列出应用程序。清单 11 说明了如何进行此工作。

    清单 11. 安装多个企业应用程序
    <target name="installallapps" description="Install all Enterprise Applications">
    <!-- Invoke installapp target to install an Enterprise Application. -->
    <antcall target="installapp">
    <!-- Pass the name of the Enterprise Application to be installed. -->
    <param name="project.name" value="MyAppEAR" />
    </antcall>
    <!-- Another invocation to the installapp target can be done
    for further installations. --> </target>
  8. 运行部署后单元测试

    此步骤与运行部署前单元测试类似,不过 JUnit 测试用例的本质不同。部署后测试用例预期使用已经部署在运行时上且正在正常工作的代码。这些测试用例可以利用服务器端的资源和测试组件,如 Cactus。就构建自动化过程而言,此步骤只是调用一组 JUnit 测试用例。

  9. 上载构建版本

    设置了所有构建版本后,自动化过程会将库部署单元和生成的报告上载到 FTP 服务器上。此步骤对于备份和保持整个构建版本的标识都非常有用。清单 12 中所示的目标说明了如何使用 FTP 来上载构建文件。

    清单 12. 将构建文件上载到 FTP 服务器
    <target name="uploadbuild" description="Upload build to an FTP server">
    <!-- Upload everything under the destination.dir to the FTP server. -->
    <ftp server="${ftp.hostname}" remotedir="/" userid="${ftp.username}" 
       password="${ftp.userpassword}" separator="\" verbose="yes" binary="yes">
    <fileset dir="${destination.dir}">
    <include name="**/*.*" />
    </fileset>
    </ftp>
    </target>
  10. 通知测试团队

    最后,该过程将向测试人员发送电子邮件(如清单 13中所示),告知其开始测试。以下示例假定不会在 SMTP 服务器上进行身份验证。

    清单 13. 向测试团队发送电子邮件
    <target name="notifyteam" description="Notify testing team of the new build">
    <!-- Read build information from the build.info file. -->
    <property file="${destination.dir}/build.info" />
    <!-- Send a mail to the testing team. -->
    <mail mailhost="${smtp.hostname}" mailport="${smtp.hostport}"
    subject="Test build #${build.number}" from="${smtp.from}" tolist="${smtp.tolist}"> <message>The build #${build.number} is now available for testing.</message> </mail> </target>

    如果您的 SMTP 服务器要求进行身份验证,将需要下载 JavaMail .jar 文件。

运行过程时的选项

本部分将简单描述运行构建过程时一些可用的选项。

条件流

上面所述的自动化过程并不施加任何控制任务流的条件。如果需要此类控制,可以使用允许某些任务中在出现错误时失败的属性。例如,wsInstallApp 任务具有用于此目的的 failonerror 属性。

使用条件是控制流的另一种方式。有关 Ant 中的条件的更多信息,请参见 Conditions task。Ant 还提供了依赖关系来在目标之间建立联系,以确保执行目标序列得以执行。

从 IDE 运行

从 IDE 运行 Ant 构建文件非常简单。如图 3 中所示,可以从 Ant 视图中选择出现在树视图下的 Ant 目标之一上的 Run Ant 选项。

图 3. 从上下文菜单选择 Run Ant
从上下文菜单选择 Run Ant

在 Modify attributes and launch 对话框中,从 JRE 选项卡选择 Run in the same JRE as the workspace,如图 4 中所示。单击 ApplyRun

图 4. 修改所使用的 JRE
修改所使用的 JRE
修改所使用的 JRE

执行之后,输出将打印到 Console 视图,如图 5 中所示。

图 5. 执行输出
执行输出
执行输出

从命令行运行

<IDE installation directory>\rwd\eclipse\plugins\com.ibm.etools.j2ee.ant_6.0.1.XXX 下提供了有关自定义 Ant 来使用 Rational SDP 资源从命令行运行的信息。该目录下提供了一个批处理文件 runAnt,可允许运行您的 Ant 构建文件。此批处理文件需要设置 WORKSPACE 环境变量。此变量指向包含自动化资源的工作区。可以从命令行设置此变量,或者添加代码行来指向 runAnt 批处理文件,如清单 14 中所示。

清单 14. 从命令行运行目标
set WORKSPACE=C:\workspaces\MyWorkSpace
runAnt.bat -buildfile <path to the Ant build file>\build.xml init

可以不使用前一示例中的 init 目标,而以类似的方式调用 Ant 构建文件中的其他目标。

计划运行

由于此构建过程已自动化,开发团队可能会决定每天都要执行此过程,具体取决于其需要提供构建版本进行测试的频率。此执行可以为部分执行(运行 Ant 目标的子集),也可以完全执行。在这两种情况下,可以对过程进行计划,以按所需的频率运行。有关如何在 Windows 平台上进行任务计划的更多信息,请参见“使用 WebSphere Studio 和 Ant 执行无人值守的日常构建——第 2 部分”。

总结

学习本文后,希望您已经通过使用实现软件开发团队的重复构建任务的自动化的过程提高了效率和质量。所使用的构建自动化过程仅仅是 Rational and WebSphere 系列软件产品提供的自动化功能的一个子集。您将需要对此过程进行调整,以与工作环境、所使用的工具和运行时、团队的知识以及所开发的解决方案类型匹配。

致谢

作者要感谢 Nouran Abdel-Hamid、Rosaline Makar、Amr Ali 和 Ahmed Mamdouh:正是得益于您们的工作,才最终得到了这个自动化解决方案。


下载资源


相关主题


评论

添加或订阅评论,请先登录注册

static.content.url=http://www.ibm.com/developerworks/js/artrating/
SITE_ID=10
Zone=Rational, Java technology, XML
ArticleID=255492
ArticleTitle=使用 Ant 自动生成项目构建版本
publish-date=09132007