Apache Buildr in action @devoxx France 2012

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.

Creative Commons License v2.0 with attribution ©Alex Boisvert

Transcript

1. 1 by Alexis Midon @alexizany Build like you code with Apache Buildr
2. 2 { Why, How, Demo of } a Build System that { does not suck, gets out of the way, lets you write code }
3. About Me
4. Alexis Midon @alexiszany midon@apache.org
5. www.c3-e.com
6. Sail & Live in San Francisco, CA 'Since 2007'
7. Java Javascript Ruby Scala ...
8. Use Buildr on daily basis and still lovin'it!
9. Practical Introduction to Apache Buildr
10. Where & Why it all started
11. Apache Ode Large Java Enterprise Middleware
12. 15+ modules 9 databases 120+ dependencies 3 distributions tooling heavy ...
13. Maven2 5,433 lines of XML spread over 52 files (!)
14. “@&#! There's Got To Be A Better Way”
15. What was Really Wanted
16. No XML. Please!
17. Flexible Easy to customize & extend
18. DRY Code Basic abstraction and structuring mechanisms
19. In other words, a real scripting language.
20. Result? drum_roll.... roulement_de_tambour...
21. Before 52 files 5,433 lines of XML.
22. Before 52 files 5,433 lines of XML. After Single file. 486 lines of Ruby.
23. Bonus! Twice as fast.
24. How Did they do it?
25. Ruby awesome scripting language
26. why ruby?
27. Scripting easy file manipulation native regexp, lightweight syntax exec() friendly etc.
28. Metaprogramm' great host for embedded domain-specific language
29. JVM Friendly ;) JRuby & Ruby-Java Bridge
30. Rake Ruby tasks, files, dependencies awesome scripting language
31. Rake The Ruby Make
32. Rake The Ruby Make “Ant”
33. Your Application [ modules ]
34. [ graph of dependencies ]
35. # 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”
36. $ rake (in /home/buildr/example) compiling A ... compiling B ... compiling C ... packaging A,B,C ...
37. Buildr Rake Ruby projects, lifecycle, artifacts, plugins tasks, files, dependencies awesome scripting language
38. # 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
39. Parent projects implicitly depend on children # 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. 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 (can be customized)
41. $ buildr package (in /home/alexis/example, development) Building buildr-example Compiling buildr-example:a into /home/alexis/example/a/target/classes Compiling buildr-example:b into /home/alexis/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/alexis/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
42. All about tasks.
43. Standard tasks [ partial list ]
44. # Actual Rake code class FileTask < Task def needed? !File.exist?(name) || out_of_date? end private def out_of_date? @prerequisites.any? { |n| n.timestamp > timestamp} end end
45. artifacts and repositories
46. Local files (no kidding!!!) Maven2 (built-in) Ivy (plugin) Aether (plugin) or roll your own. Dependency resolution
47. # Buildfile repositories.remote << "http://www.ibiblio.org/maven2/" LOG4J = "log4j:log4j:jar:1.2.15" define 'my-library' do compile.with LOG4J package :jar end
48. # Buildfile repositories.remote << "http://www.ibiblio.org/maven2/" LOG4J = "log4j:log4j:jar:1.2.15" define 'my-library' do compile.with LOG4J package :jar end all your repos are belong to us !!
49. # Buildfile repositories.remote << "http://www.ibiblio.org/maven2/" LOG4J = "log4j:log4j:jar:1.2.15" define 'my-library' do compile.with LOG4J package :jar end artifacts are Tasks, too 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 compile.with LOG4J package :jar end artifacts are Tasks, too all your repos are belong to us !! tasks are wired implicitly
51. Languages we got 'em
52. 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
53. # if you have Ruby installed $ gem install buildr or, # JRuby all-in-one package $ unzip buildr-all-in-one.zip Low Barrier to entry
54. Demo Time! Java + Scala + Groovy Mixed Project
55. More Stuff. layouts, profiles, code coverage, notifications more plugins, more languages + more awesome.
56. Only one thing to remember.
57. Build like you code.
58. join us! http://buildr.apache.org @buildr Slides and Code available at github.com/alexism Alex Boisvert @boia01
59. 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>
60. 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
61. # 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
62. 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
63. # 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
64. # 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]
65. 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
66. 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
67. 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
68. # apply to a single project define 'my-project' do extend GitVersion end # apply to all projects class Buildr::Project include GitVersion end