Hudson 插件编纂
Hudson是一个开源的持续集成工具,由于其强大的扩展性(插件)而著名,允许用户定制build的各个step,steps如下:
- SCM checkout - Based on SCM type, source code is checked out
- Pre-build - Invoked to indicate that the build is starting
- Build wrapper - Prepare an environment for the build.
- Builder runs - Actual building like calling Ant, Make, etc. happen.
- Recording - Record the output from the build, such as test results.
- Notification - Send out notifications, based on the results determined so far
<pluginGroups> …… <pluginGroup>org.jvnet.hudson.tools</pluginGroup> …… </pluginGroups>加入这一行信息可以在我们使用Hudson的maven插件时使用缩略名(比如.使用hpi:create代替org.jvnet.hudson.tools:maven-hpi-plugin:1.23:create)
mvn hpi:createhpi: 是Hudson Plug-in Interface的缩写,这是Hudson自己开发的用来进行插件开发的maven插件,就像大家经常用的mvn eclipse:eclipse中的前面一个eclipse
public static DescriptorImpl descriptor() { return Hudson.getInstance().getDescriptorByType(HelloWorldBuilder.DescriptorImpl.class); }以上代码中的HelloWorldBuilder为当前类名
mvn package在target目录下生成了一个*.hpi和一个*.jar文件,见过hudson插件的都知道,hpi后缀为hudson插件文件。现在我们就可以将hpi文件添加到hudson中作为插件,不过不急,我们用命令自动运行
mvn hpi:run这个命令会启动jetty,并且将hudson作为一个web应用启动,启动hudson前安装当前的插件到hudson中
mvn hpi:run -Djetty.port=8090修改启动端口为8090
2、插件中主要代码介绍
2.1 继承相应的扩展点extension Point
hpi中有个概念叫extension Point。就是说你要扩展哪方面。
由于mvn hpi:create默认扩展自扩展Builder这个扩展点,所以HelloWorldBuilder继承了Builder这个类。
其他扩展点会继承其他类,如post build action需要继承Notifier
2.2 实现perform方法
方法perform()是个很重要的方法,当插件运行的的时候这个方法会被调用。相应的业务逻辑也可以在这里实现。
2.3 继承Descriptor
新建DescriptorImpl类继承了BuildStepDescriptor<Builder>,BuildStepDescriptor继承自Descriptor。在Hudson 的官方说明文档里说Descriptor包含了一个配置实例的元数据。
打个比方,我们在工程配置那里对插件进行了配置,这样就相当于创建了一个插件的实例,这时候就需要一个类来存储插件的配置数据,这个类就是Descriptor。
其中的getDisplayName()表示在配置中插件展现的名字,如同上面1.5查看结果中我们看到的配置中build下拉框的Say hello world
3、debug调试
用mvn -Dhudson.maven.debugPort=5001 hpi:run启动jetty
或者修改maven启动参数
-Xdebug -Xrunjdwp:transport=dt_socket,server=y,address=5001
具体见:http://wiki.hudson-ci.org/display/HUDSON/Debugging+native+Maven+jobs
更多参考如下:
http://wiki.hudson-ci.org/display/HUDSON/Extend+Hudson
http://wiki.eclipse.org/Hudson-ci/writing-first-hudson-plugin
http://wiki.hudson-ci.org/display/HUDSON/Plugin+tutorial
http://qa.taobao.com/?p=4925
http://drizzlewalk.blog.51cto.com/2203401/499586
mvn hpi:run -Djetty.port=8090 这个命令是改启动端口的
简单的插件好写,但对于不同的扩展点要实现的函数略有不同,这些文档还不好找,有点麻烦,我们这边有不少扩展点其他人已经写好了的插件,到时候你需要可以找我