{ "componentChunkName": "component---src-templates-blog-post-tsx", "path": "/blog/2011-01-06-wrapping-each-hudson-distribution-in-its-own-rubygem/", "result": {"data":{"blogPost":{"title":"Wrapping each Hudson distribution in its own RubyGem","slug":"/blog/2011-01-06-wrapping-each-hudson-distribution-in-its-own-rubygem/","authorNodes":[{"name":"Charles Lowell","slug":"/people/charles-lowell/"}],"markdown":{"html":"
\n

Update: As of version 1.396, this is applicable to the Jenkins project.\n1.395 will be the last version of the hudson-war gem

\n
\n

As you may or may not know, we here at The FrontSide have been working since\nlate last year to create a proper ruby environment for extending hudson. This\nis no mean feat because it implies not only the ability to use nothing but ruby\ncode to implement hudson plugins, but just as importantly, the ability to use\nnothing but ruby tools to develop them. That means no javac, no\njar files, no war files, and for the love of all that is holy: absolutely,\npositively, no maven. In short, the only folks you'll need to know to get in\nthe door with Hudson are your pals Ruby, Rake and Bundler.

\n

Of course, all those jars and wars and perhaps some class generation will be\nthere behind the scenes. After all, we'll still need to compile java stubs that\ndepend on core Hudson classes. We'll still need to package your plugin along\nwith its ruby code and dependencies in a jar file, and we'll still need to take\ncare of all the blah, blah, MANIFEST, blah, META-INF, WEB-INF, blah, blah, blah...

\n

The War

\n

If we're going to do the compilation against Hudson core from within ruby and\nRake instead of maven, then we're going to need a reliable way to get at the\ncore hudson classes so that we can use them in our compilation classpath. Not\nonly that, but as part of the development process, you're going to want to test\nyour plugins against a fully functioning hudson server. Luckily, both of these\nare contained in the full hudson distribution that you download as a single\nwar file. Wouldn't it be nice if you had a simple way to get at a specific\nversion of one of those wars and then get at all those java goodies contained\ntherein?

\n

The Gem

\n

To my thinking, this sounds like a job for: RubyGems! That's why we're introducing\nthe new hudson-war gem, which does nothing except wrap a single hudson\ndistribution so that it can be managed coherently just like any other ruby\ncomponent. Want the latest warfile?

\n
gem install hudson-war
\n

Or perhaps you need hudson 1.386? That's fine, hudson-war versions are the same\nas the hudson distributions they wrap.

\n
gem install hudson-war --version 1.386
\n

It's not just a war file either. In keeping with the best traditions of OOP\ndata comes bundled with behavior. The gem comes with a ruby API and a CLI baked\nin to help us do all the nifty things we might want to do with a war file.\nFor starters, you might want to know where it is.

\n
legolas:~ cowboyd$ hudson.war location\n/Users/cowboyd/.rvm/gems/ruby-1.8.7-p174/gems/hudson-war-1.386/lib/hudson/hudson.war
\n

If you want to unpack it to a particular location then

\n
legolas:~ cowboyd$ hudson.war unpack tmp\njar xvf /Users/cowboyd/.rvm/gems/ruby-1.8.7-p174/gems/hudson-war-1.386/lib/hudson/hudson.war -C tmp/
\n

You can run a test server with it

\n
legolas:~ cowboyd$ hudson.war server --daemon\nForking into background to run as a daemon.\nUse --logfile to redirect output to a file\nlegolas:~ cowboyd$ hudson.war server --kill
\n

Beyond the basics, let's say you want to do something interesting like compile\nsome java code against the hudson core. You're gonna need a classpath, and you\ncan get it with:

\n
legolas:~ cowboyd$ hudson.war classpath\n/Users/cowboyd/.hudson/wars/1.386/WEB-INF/lib/hudson-core-1.386.jar
\n

You can even compile java code with it directly. Here we compile a trivial\nclass that has a dependency on hudson.

\n
legolas:~ cowboyd$ cat > ImportsHudson.java\nimport hudson.model.Hudson;\npublic class ImportsHudson {\n  public static void main(String args[]) {\n    System.out.printf(\"The Hudson Model object's class is %s\\n\", Hudson.class.getName());\n  }\n}\nlegolas:~ cowboyd$ hudson.war javac ImportsHudson.java\nlegolas:~ cowboyd$ java -cp .:`hudson.war classpath` ImportsHudson\nThe Hudson Model object's class is hudson.model.Hudson
\n

It's like RVM for hudson. Wrangling java has never been so fun!

\n

The War Gemmer

\n

Befitting a continuous integration project, the Hudson team releases a new\nversion at least every two weeks, and sometimes even sooner. It can be a bitch\nto keep up with, so I've set up a\nwargemmer hudson task to\nperiodically poll the update center to see if there is a new release. If there\nis, it'll gem it right up and push it to rubygems. No fuss no muss.

\n

Let the war begin!

","frontmatter":{"date":"January 06, 2011","description":null,"tags":["ruby","hudson","java","jenkins"],"img":null}}}},"pageContext":{"id":"909d1cce-a530-54e5-987c-028813e0f18b"}}, "staticQueryHashes": ["1241260443"]}