编写一个Cruisecontrol的扩展插件

最新推荐文章于 2025-12-17 18:42:06 发布

原创最新推荐文章于 2025-12-17 18:42:06 发布 · 903 阅读

1 ·

CC 4.0 BY-SA版权

文章标签：

#扩展 #hudson #string #jar #maven #工具

本文介绍如何为持续集成工具Cruisecontrol开发一个RTX消息通知插件，该插件可在构建完成后向团队成员发送即时消息通知。文章详细展示了插件的实现过程，包括工程结构、关键代码段以及配置步骤。

老牌的持续集成工具Cruisecontrol已经很少更新了，后起之秀Hudson相比之下却是非常的活跃。CC和Hudson对插件的支持都很好，本想在Hudson上编写一个RTX消息插件，被maven绕晕了，就先在CC里面实现一个罢。

RTX是一种企业办公用的即时通讯工具，界面简洁清爽，而且可以和企业组织结构相结合，我个人还是比较喜欢的。面对面的沟通永远是最高效的，如果在半径20米范围内，还用rtx聊，那就过之不及。请站起来，走过去。扯远了，言归正传。

RTXPublisher这个插件的目的非常简单，在构建完成后通过RTX通知团队相关人员。让我们直接开始动手吧：
1）CC的插件是以Jar包的形式放在lib目录下。为了生成cc_rtx_plugin.jar. 我们先创建一个工程cc_rtx_plugin，目录结构非常之简单。
cc_rtx_plugin
   |--src
         |--com
                |--david
                       |--RTXPublisher.java
   |--lib
         |--cruisecontrol.jar   (会使用到其中的net.sourceforge.cruisecontrol.Publisher, net.sourceforge.cruisecontrol.util.XMLLogHelper)

2) RTXPublisher的关键代码：
public class RTXPublisher implements Publisher {
  //几个配置项：failureOnly是否仅在构建失败时调用，receivers消息接收者,
  //buildresultsurl构建结果链接，和htmlemail插件的同名属性一样
    private boolean failureOnly = false;
    private String receivers;
    private String buildresultsurl;
    //重载validate,检验输入参数
    public void validate() throws CruiseControlException {
        if (null == receivers)
            throw new CruiseControlException("Receivers missing");
    }
    //重载publish
    public void publish(Element cruisecontrolLog) throws CruiseControlException {
        XMLLogHelper logHelper = new XMLLogHelper(cruisecontrolLog);
        String buildResult = "构建成功";
        if (logHelper.isBuildSuccessful()) {
            if (failureOnly)    //仅在失败时提醒
                return;
        } else {
            buildResult = "构建失败";
        }
        final String buildId = logHelper.getLabel();
        Date buildTime = DateUtil.parseFormattedTime(logHelper.getBuildTimestamp(), "buildTime");
        Format format = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
        String formatBuildTime = format.format(buildTime);
        String title = "[" + logHelper.getProjectName() + "]" + buildId + buildResult;
        String msgInfo = "构建时间：" + formatBuildTime
                    + "/n代码更新：" + logHelper.getModifications().size()
                    + "/n点击[查看详细构建结果|" + buildresultsurl + "]";
        sendRTX(title, msgInfo);// rtx notify
    }
}
具体发RTX消息的实现不是重点，这里不赘述.

3) 把生成的jar包放到cc_home/lib目录下，注意如果你使用到其他的jar包，也要一并放过去。现在开始配置config.xml来使用cc_rtx_plugin.jar
<cruisecontrol>
   
   <plugin name="rtxpublisher" classname="com.david.RTXPublisher" />

....
    <project name="connectfour">
        <publishers>
            <rtxpublisher receivers="david" failureOnly="false"
              buildresultsurl="http://localhost:8080/cruisecontrol/buildresults/${project.name}"
            />
        </publishers>
    </project>
</cruisecontrol>

4)重新启动cruisecontrol构建一把试试看吧。