buildr 1.2.10 → 1.3.0

data/lib/buildr/java.rb

@@ -0,0 +1,26 @@
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements.  See the NOTICE file distributed with this
+# work for additional information regarding copyright ownership.  The ASF
+# licenses this file to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the
+# License for the specific language governing permissions and limitations under
+# the License.
+
+
+ENV['JAVA_HOME'] = '/System/Library/Frameworks/JavaVM.framework/Home' if Config::CONFIG['host_os'] =~ /darwin/i
+require PLATFORM == 'java' ? 'buildr/java/jruby' : 'buildr/java/rjb'
+
+
+require 'buildr/java/compilers'
+require 'buildr/java/test_frameworks'
+require 'buildr/java/bdd_frameworks'
+require 'buildr/java/packaging'
+require 'buildr/java/commands'
+require 'buildr/java/deprecated'

data/lib/buildr/java/ant.rb

@@ -0,0 +1,71 @@
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements.  See the NOTICE file distributed with this
+# work for additional information regarding copyright ownership.  The ASF
+# licenses this file to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the
+# License for the specific language governing permissions and limitations under
+# the License.
+
+
+require 'antwrap'
+require 'buildr/core/project'
+require 'buildr/core/help'
+
+
+module Buildr
+  module Ant
+
+    # Which version of Ant we're using by default.
+    VERSION = '1.7.0' unless const_defined?('VERSION')
+
+    # Libraries used by Ant.
+    REQUIRES = [ "org.apache.ant:ant:jar:#{VERSION}", "org.apache.ant:ant-launcher:jar:#{VERSION}", 'xerces:xercesImpl:jar:2.6.2' ]
+    Java.classpath << REQUIRES
+
+    # :call-seq:
+    #   ant(name) { |AntProject| ... } => AntProject
+    #
+    # Creates a new AntProject with the specified name, yield to the block for defining various
+    # Ant tasks, and executes each task as it's defined.
+    #
+    # For example:
+    #   ant("hibernatedoclet') do |doclet|
+    #     doclet.taskdef :name=>'hibernatedoclet',
+    #       :classname=>'xdoclet.modules.hibernate.HibernateDocletTask', :classpath=>DOCLET
+    #     doclet.hibernatedoclet :destdir=>dest_dir, :force=>'true' do
+    #       hibernate :version=>'3.0'
+    #       fileset :dir=>source, :includes=>'**/*.java'
+    #     end
+    #   end
+    def ant(name, &block)
+      options = { :name=>name, :basedir=>Dir.pwd, :declarative=>true }
+      options.merge!(:logger=> Logger.new(STDOUT), :loglevel=> Logger::DEBUG) if Buildr.application.options.trace
+      Java.load
+      Antwrap::AntProject.new(options).tap do |project|
+        # Set Ant logging level to debug (--trace), info (default) or error only (--quiet).
+        project.project.getBuildListeners().get(0).
+          setMessageOutputLevel((Buildr.application.options.trace && 4) || (verbose && 2) || 0)
+        yield project if block_given?
+      end
+    end
+
+  end
+
+  include Ant
+  class Project
+    include Ant
+  end
+
+  Buildr.help do
+    Java.load
+    "\nUsing Java #{ENV_JAVA['java.version']}, Ant #{Ant::VERSION}."
+  end
+
+end

data/lib/buildr/java/bdd_frameworks.rb

@@ -0,0 +1,267 @@
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements.  See the NOTICE file distributed with this
+# work for additional information regarding copyright ownership.  The ASF
+# licenses this file to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the
+# License for the specific language governing permissions and limitations under
+# the License.
+
+
+require 'buildr/java/test_frameworks'
+
+
+module Buildr
+
+  # Mixin for test frameworks using src/spec/{lang}
+  module TestFramework::JavaBDD #:nodoc:
+    
+    class << self
+      def included(mod)
+        mod.module_eval do
+          include TestFramework::JavaTest
+          include ClassMethods
+        end
+        mod.extend ClassMethods
+        mod.bdd_dir = :spec
+        mod.lang = :java
+        super
+      end
+    end
+
+    module ClassMethods
+      attr_accessor :lang, :bdd_dir
+    end
+
+    def initialize(task, options)
+      self.bdd_dir = self.class.bdd_dir
+      project = task.project
+      project.task('test:compile').tap do |comp| 
+        comp.send :associate_with, project, bdd_dir
+        self.lang = comp.language || self.class.lang
+      end
+      project.task('test:resources').tap do |res|
+        res.send :associate_with, project, bdd_dir
+        res.filter.clear
+        project.path_to(:source, bdd_dir, :resources).tap { |dir| resources.from dir if File.exist?(dir) }
+      end
+      super
+    end
+  end
+  
+  class RSpec < TestFramework::Base
+    include TestFramework::JavaBDD
+    self.lang = :ruby
+
+    REQUIRES = ['org.jruby:jruby-complete:jar:1.1']
+    TESTS_PATTERN = [ /_spec.rb$/ ]
+    OPTIONS = [:properties, :java_args]
+
+    def self.applies_to?(project) #:nodoc:
+      !Dir[project.path_to(:source, bdd_dir, lang, '**/*_spec.rb')].empty?
+    end
+
+    def tests(dependencies) #:nodoc:
+      Dir[task.project.path_to(:source, bdd_dir, lang, '**/*_spec.rb')].
+        select do |name| 
+        selector = ENV['SPEC']
+        selector.nil? || Regexp.new(selector) === name
+      end
+    end
+
+    def run(tests, dependencies) #:nodoc:
+      cmd_options = task.options.only(:properties, :java_args)
+      cmd_options.update :classpath => dependencies, :project => task.project
+      # TODO:  Setting up JRuby is something to do before running Buildr.
+      #install_gems(cmd_options)
+
+      report_dir = task.report_to.to_s
+      FileUtils.rm_rf report_dir
+      ENV['CI_REPORTS'] = report_dir
+
+      jruby("-Ilib", "-S", "spec",
+      #"--require", gem_path(task.project, "ci_reporter", "lib/ci/reporter/rake/rspec_loader"),
+      "--require", "ci/reporter/rake/rspec_loader",
+      "--format", "CI::Reporter::RSpecDoc", tests,
+      cmd_options.merge({:name => "RSpec"}))
+      tests
+    end
+
+    private
+    def jruby_home(project)
+      @jruby_home ||= RUBY_PLATFORM =~ /java/ ? Config::CONFIG['prefix'] : File.expand_path(".jruby", ENV['HOME'])
+    end
+
+    def gem_path(project, gem_name, *additional)
+      dir = Dir["#{jruby_home(project)}/lib/ruby/gems/1.8/gems/#{gem_name}*"].to_a.first
+      dir = File.join(dir, *additional) unless additional.empty?
+      dir
+    end
+
+    def required_gems(options)
+      ["ci_reporter", options[:required_gems]].flatten.compact
+    end
+
+    def jruby(*args)
+      java_args = ["org.jruby.Main", *args]
+      java_args << {} unless Hash === args.last
+      cmd_options = java_args.last
+      project = cmd_options.delete(:project)
+      if RUBY_PLATFORM =~ /java/
+        # when run from within JRuby, use jars in launched-JRuby's classpath rather than the
+        # stated dependency
+        cmd_options[:classpath].delete_if {|e| File.basename(e) =~ /^jruby-complete-.*\.jar$/ }
+        cmd_options[:classpath].unshift *(java.lang.System.getProperty("java.class.path").split(File::PATH_SEPARATOR))
+      end
+      cmd_options[:java_args] ||= []
+      cmd_options[:java_args] << "-Xmx512m" unless cmd_options[:java_args].detect {|a| a =~ /^-Xmx/}
+      cmd_options[:properties] ||= {}
+      cmd_options[:properties]["jruby.home"] = jruby_home(project)
+      Java::Commands.java(*java_args)
+    end
+
+    #def install_gems(options)
+    #  unless required_gems(options).all? {|g| gem_path(options[:project], g)}
+    #    args = ["-S", "maybe_install_gems", *required_gems(options)]
+    #    args << {:name => "JRuby Setup"}.merge(options)
+    #    jruby(*args)
+    #  end
+    #end
+    
+  end
+
+  class JtestR < TestFramework::Base
+    include TestFramework::JavaBDD
+    self.lang = :ruby
+  end
+  
+  # JBehave is a Java BDD framework. To use in your project:
+  #   test.using :jbehave
+  # 
+  # This framework will search in your project for:
+  #   src/spec/java/**/*Behaviour.java
+  # 
+  # JMock libraries are included on runtime.
+  #
+  # Support the following options:
+  # * :properties -- Hash of properties to the test suite
+  # * :java_args -- Arguments passed to the JVM
+  class JBehave < TestFramework::Base
+    include TestFramework::JavaBDD
+
+    VERSION = "1.0.1" unless const_defined?('VERSION')
+    REQUIRES = ["org.jbehave:jbehave:jar:#{VERSION}",
+                "jmock:jmock-cglib:jar:#{JMock::VERSION}",
+                "cglib:cglib-full:jar:2.0.2",
+               ] + JUnit::REQUIRES
+    TESTS_PATTERN = [ /Behaviou?r$/ ]
+
+    def self.applies_to?(project) #:nodoc:
+      %w{
+        **/*Behaviour.java **/*Behavior.java
+      }.any? { |glob| !Dir[project.path_to(:source, bdd_dir, lang, glob)].empty? }
+    end
+
+    def tests(dependencies) #:nodoc:
+      filter_classes(dependencies, :class_names => TESTS_PATTERN,
+                     :interfaces => %w{ org.jbehave.core.behaviour.Behaviours })
+    end
+    
+    def run(tests, dependencies) #:nodoc:
+      cmd_args = ['org.jbehave.core.BehaviourRunner']
+      cmd_options = { :properties=>options[:properties], :java_args=>options[:java_args], :classpath=>dependencies }
+      tests.inject([]) do |passed, test|
+        begin
+          Java::Commands.java cmd_args, test, cmd_options
+          passed << test
+        rescue
+          passed
+        end
+      end
+    end
+    
+  end
+
+  # EasyB is a Groovy based BDD framework.
+  # To use in your project:
+  #
+  #   test.using :easyb
+  # 
+  # This framework will search in your project for:
+  #   src/spec/groovy/**/*Story.groovy
+  #   src/spec/groovy/**/*Behavior.groovy
+  #
+  # Support the following options:
+  # * :format -- Report format :txt or :xml, default is :txt
+  # * :properties -- Hash of properties passed to the test suite.
+  # * :java_args -- Arguments passed to the JVM.
+  class EasyB < TestFramework::Base
+    include TestFramework::JavaBDD
+    self.lang = :groovy
+
+    VERSION = "0.7" unless const_defined?(:VERSION)
+    REQUIRES = ["org.easyb:easyb:jar:#{VERSION}",
+                'org.codehaus.groovy:groovy:jar:1.5.3',
+                'asm:asm:jar:2.2.3',
+                'commons-cli:commons-cli:jar:1.0',
+                'antlr:antlr:jar:2.7.7']
+    TESTS_PATTERN = [ /(Story|Behavior).groovy$/ ]
+    OPTIONS = [:format, :properties, :java_args]
+
+    def self.applies_to?(project) #:nodoc:
+      %w{
+        **/*Behaviour.groovy **/*Behavior.groovy **/*Story.groovy
+      }.any? { |glob| !Dir[project.path_to(:source, bdd_dir, lang, glob)].empty? }
+    end
+   
+    def tests(dependencies) #:nodoc:
+      Dir[task.project.path_to(:source, bdd_dir, lang, "**/*.groovy")].
+        select { |name| TESTS_PATTERN.any? { |pat| pat === name } }
+    end
+
+    def run(tests, dependencies) #:nodoc:
+      options = { :format => :txt }.merge(self.options).only(*OPTIONS)
+      
+      if :txt == options[:format]
+        easyb_format, ext = 'txtstory', '.txt'
+      elsif :xml == options[:format]
+        easyb_format, ext = 'xmlbehavior', '.xml'
+      else
+        raise "Invalid format #{options[:format]} expected one of :txt :xml"
+      end
+      
+      cmd_args = [ 'org.disco.easyb.SpecificationRunner' ]
+      cmd_options = { :properties => options[:properties],
+                      :java_args => options[:java_args],
+                      :classpath => dependencies }
+
+      tests.inject([]) do |passed, test|
+        name = test.sub(/.*?groovy[\/\\]/, '').pathmap('%X')
+        report = File.join(task.report_to.to_s, name + ext)
+        mkpath report.pathmap('%d'), :verbose => false
+        begin
+          Java::Commands.java cmd_args,
+             "-#{easyb_format}", report,
+             test, cmd_options.merge(:name => name)
+        rescue => e
+          passed
+        else
+          passed << test
+        end
+      end
+    end
+    
+  end # EasyB
+
+end
+
+Buildr::TestFramework << Buildr::RSpec
+Buildr::TestFramework << Buildr::JtestR
+Buildr::TestFramework << Buildr::JBehave
+Buildr::TestFramework << Buildr::EasyB

data/lib/buildr/java/commands.rb

@@ -0,0 +1,210 @@
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements.  See the NOTICE file distributed with this
+# work for additional information regarding copyright ownership.  The ASF
+# licenses this file to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the
+# License for the specific language governing permissions and limitations under
+# the License.
+
+
+# Base module for all things Java.
+module Java
+
+  # JDK commands: java, javac, javadoc, etc.
+  module Commands
+
+    class << self
+
+      # :call-seq:
+      #   java(class, *args, options?)
+      #
+      # Runs Java with the specified arguments.
+      #
+      # The last argument may be a Hash with additional options:
+      # * :classpath -- One or more file names, tasks or artifact specifications.
+      #   These are all expanded into artifacts, and all tasks are invoked.
+      # * :java_args -- Any additional arguments to pass (e.g. -hotspot, -xms)
+      # * :properties -- Hash of system properties (e.g. 'path'=>base_dir).
+      # * :name -- Shows this name, otherwise shows the first argument (the class name).
+      # * :verbose -- If true, prints the command and all its argument.
+      def java(*args, &block)
+        options = Hash === args.last ? args.pop : {}
+        options[:verbose] ||= Buildr.application.options.trace || false
+        rake_check_options options, :classpath, :java_args, :properties, :name, :verbose
+
+        name = options[:name] || "java #{args.first}"
+        cmd_args = [path_to_bin('java')]
+        classpath = classpath_from(options)
+        cmd_args << '-classpath' << classpath.join(File::PATH_SEPARATOR) unless classpath.empty?
+        options[:properties].each { |k, v| cmd_args << "-D#{k}=#{v}" } if options[:properties]
+        cmd_args += (options[:java_args] || (ENV['JAVA_OPTS'] || ENV['JAVA_OPTIONS']).to_s.split).flatten
+        cmd_args += args.flatten.compact
+        unless Buildr.application.options.dryrun
+          puts "Running #{name}" if verbose
+          block = lambda { |ok, res| fail "Failed to execute #{name}, see errors above" unless ok } unless block
+          puts cmd_args.join(' ') if Buildr.application.options.trace
+          system(*cmd_args).tap do |ok|
+            block.call ok, $?
+          end
+        end
+      end
+  
+      # :call-seq:
+      #   apt(*files, options)
+      #
+      # Runs Apt with the specified arguments.
+      #
+      # The last argument may be a Hash with additional options:
+      # * :compile -- If true, compile source files to class files.
+      # * :source -- Specifies source compatibility with a given JVM release.
+      # * :output -- Directory where to place the generated source files, or the
+      #   generated class files when compiling.
+      # * :classpath -- One or more file names, tasks or artifact specifications.
+      #   These are all expanded into artifacts, and all tasks are invoked.
+      def apt(*args)
+        options = Hash === args.last ? args.pop : {}
+        rake_check_options options, :compile, :source, :output, :classpath
+
+        files = args.flatten.map(&:to_s).
+          collect { |arg| File.directory?(arg) ? FileList["#{arg}/**/*.java"] : arg }.flatten
+        cmd_args = [ Buildr.application.options.trace ? '-verbose' : '-nowarn' ]
+        if options[:compile]
+          cmd_args << '-d' << options[:output].to_s
+        else
+          cmd_args << '-nocompile' << '-s' << options[:output].to_s
+        end
+        cmd_args << '-source' << options[:source] if options[:source]
+        classpath = classpath_from(options)
+        tools = File.expand_path('lib/tools.jar', ENV['JAVA_HOME']) if ENV['JAVA_HOME']
+        classpath << tools if tools && File.exist?(tools)
+        cmd_args << '-classpath' << classpath.join(File::PATH_SEPARATOR) unless classpath.empty?
+        cmd_args += files
+        unless Buildr.application.options.dryrun
+          puts 'Running apt' if verbose
+          puts (['apt'] + cmd_args).join(' ') if Buildr.application.options.trace
+          Java.load
+          Java.com.sun.tools.apt.Main.process(cmd_args.to_java(Java.java.lang.String)) == 0 or
+            fail 'Failed to process annotations, see errors above'
+        end
+      end
+
+      # :call-seq:
+      #   javac(*files, options)
+      #
+      # Runs Javac with the specified arguments.
+      #
+      # The last argument may be a Hash with additional options:
+      # * :output -- Target directory for all compiled class files.
+      # * :classpath -- One or more file names, tasks or artifact specifications.
+      #   These are all expanded into artifacts, and all tasks are invoked.
+      # * :sourcepath -- Additional source paths to use.
+      # * :javac_args -- Any additional arguments to pass (e.g. -extdirs, -encoding)
+      # * :name -- Shows this name, otherwise shows the working directory.
+      def javac(*args)
+        options = Hash === args.last ? args.pop : {}
+        rake_check_options options, :classpath, :sourcepath, :output, :javac_args, :name
+
+        files = args.flatten.each { |f| f.invoke if f.respond_to?(:invoke) }.map(&:to_s).
+          collect { |arg| File.directory?(arg) ? FileList["#{arg}/**/*.java"] : arg }.flatten
+        name = options[:name] || Dir.pwd
+
+        cmd_args = []
+        classpath = classpath_from(options)
+        cmd_args << '-classpath' << classpath.join(File::PATH_SEPARATOR) unless classpath.empty?
+        cmd_args << '-sourcepath' << options[:sourcepath].join(File::PATH_SEPARATOR) if options[:sourcepath]
+        cmd_args << '-d' << options[:output].to_s if options[:output]
+        cmd_args += options[:javac_args].flatten if options[:javac_args]
+        cmd_args += files
+        unless Buildr.application.options.dryrun
+          puts "Compiling #{files.size} source files in #{name}" if verbose
+          puts (['javac'] + cmd_args).join(' ') if Buildr.application.options.trace
+          Java.load
+          Java.com.sun.tools.javac.Main.compile(cmd_args.to_java(Java.java.lang.String)) == 0 or 
+            fail 'Failed to compile, see errors above'
+        end
+      end
+
+      # :call-seq:
+      #   javadoc(*files, options)
+      #
+      # Runs Javadocs with the specified files and options.
+      #
+      # This method accepts the following special options:
+      # * :output -- The output directory
+      # * :classpath -- Array of classpath dependencies.
+      # * :sourcepath -- Array of sourcepaths (paths or tasks).
+      # * :name -- Shows this name, otherwise shows the working directory.
+      #
+      # All other options are passed to Javadoc as following:
+      # * true -- As is, for example, :author=>true becomes -author
+      # * false -- Prefixed, for example, :index=>false becomes -noindex
+      # * string -- Option with value, for example, :windowtitle=>'My project' becomes -windowtitle "My project"
+      # * array -- Option with set of values separated by spaces.
+      def javadoc(*args)
+        options = Hash === args.last ? args.pop : {}
+
+        cmd_args = [ '-d', options[:output], Buildr.application.options.trace ? '-verbose' : '-quiet' ]
+        options.reject { |key, value| [:output, :name, :sourcepath, :classpath].include?(key) }.
+          each { |key, value| value.invoke if value.respond_to?(:invoke) }.
+          each do |key, value|
+            case value
+            when true, nil
+              cmd_args << "-#{key}"
+            when false
+              cmd_args << "-no#{key}"
+            when Hash
+              value.each { |k,v| cmd_args << "-#{key}" << k.to_s << v.to_s }
+            else
+              cmd_args += Array(value).map { |item| ["-#{key}", item.to_s] }.flatten
+            end
+          end
+        [:sourcepath, :classpath].each do |option|
+          options[option].to_a.flatten.tap do |paths|
+            cmd_args << "-#{option}" << paths.flatten.map(&:to_s).join(File::PATH_SEPARATOR) unless paths.empty?
+          end
+        end
+        cmd_args += args.flatten.uniq
+        name = options[:name] || Dir.pwd
+        unless Buildr.application.options.dryrun
+          puts "Generating Javadoc for #{name}" if verbose
+          puts (['javadoc'] + cmd_args).join(' ') if Buildr.application.options.trace
+          Java.load
+          Java.com.sun.tools.javadoc.Main.execute(cmd_args.to_java(Java.java.lang.String)) == 0 or
+            fail 'Failed to generate Javadocs, see errors above'
+        end
+      end
+
+    protected
+
+      # :call-seq:
+      #   path_to_bin(cmd?) => path
+      #
+      # Returns the path to the specified Java command (with no argument to java itself).
+      def path_to_bin(name = nil)
+        home = ENV['JAVA_HOME'] or fail 'Are we forgetting something? JAVA_HOME not set.'
+        File.expand_path(File.join(home, 'bin', name.to_s))
+      end
+
+      # :call-seq:
+      #    classpath_from(options) => files
+      #
+      # Extracts the classpath from the options, expands it by calling artifacts, invokes
+      # each of the artifacts and returns an array of paths.
+      def classpath_from(options)
+        Buildr.artifacts(options[:classpath] || []).map(&:to_s).
+          map { |t| task(t).invoke; File.expand_path(t) }
+      end
+
+    end
+
+  end
+
+end
+