Practical Introduction to Apache Buildr

Buildr is a modern build system for Java-based applications including support for Scala, Groovy and a growing number of JVM languages and tools. Buildr combines the expressiveness of the Ruby scripting language with a familiar dependency-based task execution model and project-level structure similar to Apache Maven. This session will introduce Buildr and demonstrate practical solutions to common build problems.

1. Apache Buildr Build like you code Øredev 2011 @ Malmö, Sweden
2. About Me
3. Alex Boisvert twitter: @boia01
4. French Canadian Live in USA
6. Java Scala Ruby Groovy Javascript ...
7. Buildr Committer [ PMC Chair ]
8. Use Buildr on daily basis
9. Contributions scala support plugins & extensibility eclipse integration many other improvements and bug fixes
10. Practical Introduction to Apache Buildr
11. Build system that doesn't suck.
12. Where it all started
13. Apache Ode Large Java Enterprise Middleware
14. 15+ modules 9 databases 120+ dependencies 3 distributions tooling heavy ...
15. Maven2 5,433 lines of XML spread over 52 files (!)
16. “@&#! There's Got To Be A Better Way”
17. What We Really Wanted
18. No XML. Please!
19. Flexible Easy to customize & extend
20. DRY Code Basic abstraction and structuring mechanisms
21. In other words, a real scripting language.
22. Result? <drum_roll/>
23. Before 52 files 5,433 lines of XML. After Single file. 486 lines of Ruby.
24. Bonus! Twice as fast.
25. How did we do it?
26. Ruby awesome scripting language
27. Rake Ruby tasks, files, dependencies awesome scripting language
28. Buildr Rake Ruby projects, lifecycle, artifacts, plugins tasks, files, dependencies awesome scripting language
29. why ruby?
30. Scripting easy file manipulation native regexp, lightweight syntax exec() friendly etc.
31. Metaprogramm' great host for embedded domain-specific language
32. JVM Friendly ;) JRuby & Ruby-Java Bridge
33. Rake The Ruby Make
34. Rake The Ruby Make “Ant”
35. Your Application [ modules ]
36. [ graph of dependencies ]
37. # This is Rake code task "compile A" do # code to compile A end task "compile B" do # code to compile B end task "compile C" => ["compile A", "compile B"] do # code to compile C end task "package A,B,C" => ["compile A", "...", "compile C"] do # code to package A, B and C end task :default => “package A, B, C”
38. $ rake (in /home/buildr/example) compiling A ... compiling B ... compiling C ... packaging A,B,C ...
39. # This is Buildr code define "My application" do define "A" do package :jar end define "B" do package :jar end define "C" do compile.with projects("A", "B") package :jar end package(:war).using :libs => projects("A", "B", "C") end
40. # This is Buildr code define "My application" do define "A" do package :jar end define "B" do package :jar end define "C" do compile.with projects("A", "B") package :jar end package(:war).using :libs => projects("A", "B", "C") end Parent projects implicitly depend on children
41. my-application/ ├── A │ └── src │ ├── main │ │ ├── java │ │ └── resources │ └── test │ └── java ├── B │ └── src │ ├── main │ │ └── scala │ └── test │ └── scala ├── C │ └── src │ └── main │ └── groovy └── src └── main ├── java └── webapp Standard directory structure
42. $ buildr package (in /home/boisvert/tmp/buildr-example, development) Building buildr-example Compiling buildr-example:a into /home/boisvert/tmp/buildr- example/a/target/classes Compiling buildr-example:b into /home/boisvert/tmp/buildr- example/b/target/classes Packaging buildr-example-a-1.0.0.jar Packaging buildr-example-b-1.0.0.jar Compiling buildr-example:c into /home/boisvert/tmp/buildr- example/c/target/classes Packaging buildr-example Packaging buildr-example-c-1.0.0.jar Packaging buildr-example-1.0.0.war Running integration tests... Completed in 0.779s
43. All about tasks.
44. Standard tasks [ partial list ]
45. # Actual Rake code class FileTask < Task def needed? !File.exist?(name) || out_of_date? end private def out_of_date? @prerequisites.any? { |n| p.timestamp > timestamp} end end
46. artifacts and repositories
47. Local files (duh!) Maven2 (built-in) Ivy (plugin) Aether (plugin) or roll your own. Dependency resolution
48. # Buildfile repositories.remote << "http://www.ibiblio.org/maven2/" LOG4J = "log4j:log4j:jar:1.2.15" define 'my-library' do manifest['Copyright'] = 'Acme Inc (C) 2008' compile.options.target = '1.5' compile.with LOG4J package :jar end
49. # Buildfile repositories.remote << "http://www.ibiblio.org/maven2/" LOG4J = "log4j:log4j:jar:1.2.15" define 'my-library' do manifest['Copyright'] = 'Acme Inc (C) 2008' compile.options.target = '1.5' compile.with LOG4J package :jar end all your repos are belong to us!
50. # Buildfile repositories.remote << "http://www.ibiblio.org/maven2/" LOG4J = "log4j:log4j:jar:1.2.15" define 'my-library' do manifest['Copyright'] = 'Acme Inc (C) 2008' compile.options.target = '1.5' compile.with LOG4J package :jar end artifacts are tasks, too.
51. # Buildfile repositories.remote << "http://www.ibiblio.org/maven2/" LOG4J = "log4j:log4j:jar:1.2.15" define 'my-library' do manifest['Copyright'] = 'Acme Inc (C) 2008' compile.options.target = '1.5' compile.with LOG4J package :jar end tasks are wired implicitly
52. Languages we got 'em
53. Example: Scala plugin require 'buildr/scala' # brings in: # # - automatic detection # (src/main/scala, src/test/scala, src/spec/scala) # # - incremental compilation # # - mixed java + scala compilation # # - scaladoc generation # # - scalatest, specs and scalacheck testing # # - continuous compilation
54. # if you have Ruby installed % gem install buildr or, # JRuby all-in-one package % unzip buildr-all-in-one.zip
55. Demo Time! Java + Scala + Groovy Mixed Project
56. Ant Example: XMLBeans <taskdef name="xmlbean" classname="org.apache.xmlbeans.impl.tool.XMLBean" classpath="path/to/xbean.jar" /> <xmlbean classgendir="${build.dir}" classpath="${class.path}" failonerror="true"> <fileset basedir="src" excludes="**/*.xsd"/> <fileset basedir="schemas" includes="**/*.*"/> </xmlbean>
57. Ant Example: XMLBeans def xmlbeans(files) do Buildr.ant "xmlbeans" do |ant| ant.taskdef \ :name => "xmlbeans", :classname => "org.apache.xmlbeans.impl.tool.XMLBean", :classpath => 'org.apache.xmlbeans:xmlbeans:jar:2.3.0' ant.xmlbeans \ :classpath => project.compile.dependencies, :srcgendir => project._('target/generated') :failonerror => "true" do files.flatten.each do |file| ant.fileset File.directory?(file) ? { :dir => file } : { :file => file } end end end
58. # Convert .pom to ivy.xml module POM_to_IVY extend self ANT = Buildr.ant('convertpom') do |ant| ant.taskdef :name => "convertpom", :classname => "org.apache.ivy.ant.IvyConvertPom" end end def convert(pom_file, ivy_file) ANT.convertpom :pomFile => pom_file, :ivyFile => ivy_file end end
59. define :webapp do # regenerate app.js when any .coffee file changes file('target/js/app.js') => Dir['src/main/coffee/*.coffee']) do sh "dependence src/main/coffee/ -t coffee -o target/js" end resources.enhance ['target/js/app.js'] end
60. # Generate SQL DDL schemas for all databases %w{ derby mysql oracle sqlserver postgres }.each do |db| db_xml = _("src/main/descriptors/persistence.#{db}.xml") partial_sql = file("target/partial.#{db}.sql"=>db_xml) do OpenJPA.mapping_tool \ :properties => db_xml, :action => "build", :sql => db.to_s, :classpath => projects("store", "dao") end # Add Apache license header header = _("src/main/scripts/license-header.sql") sql = concat(_("target/#{db}.sql") => [header, partial_sql]) build sql end
61. # Compile using all Eclipse BIRT libraries BIRT_WAR = artifact(“org.eclipse.birt:birt:war:1.4.1”) unzip_birt = unzip _("target/birt") => BIRT_WAR unzip_birt.enhance do compile.with Dir[_("target/birt/WEB-INF/lib") + "/*.jar"] end compile.enhance [unzip_birt]
62. Calling Java classes Java.classpath << [ "org.antlr:antlr:jar:3.0", "antlr:antlr:jar:2.7.7", "org.antlr:stringtemplate:jar:3.0" ] Java.org.antlr.Tool.new("-i #{input} -o #{output}").process
63. Testing Your Build # rspec code check package(:war).entry('META-INF/MANIFEST'), 'should have license' do it.should contain(/Copyright (C) 2011/) end check file('target/classes/killerapp/Code.class'), 'should exist' do it.should exist end
64. Example: Extension module GitVersion include Buildr::Extension @version = `git log -1 --pretty=format:%H` after_define do |project| project.packages.each do |jar| f = file project._("target/git-version.txt") do |f| Buildr.write f.to_s, @version end jar.enhance [f] jar.include f, :as => "META-INF/git-version.txt" end end end
65. # apply to a single project define 'my-project' do extend GitVersion end # apply to all projects class Buildr::Project include GitVersion end
66. More Stuff. layouts, profiles, code coverage, notifications more plugins, more languages + more awesome.
67. Only one thing to remember.
68. Build like you code.
69. join us! http://buildr.apache.org
70. [ Backup Slides ]
71. Caveats installation transitive dependencies pom generation ruby language more plugins no commercial support small community
72. Even more stuff! Eclipse task Download javadocs, sources Shell / REPL ActionScript, Flex, Clojure, ...