vic-buildr 1.3.1 → 1.3.3

data/lib/buildr/java/bdd.rb

@@ -0,0 +1,447 @@
+# 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/tests'
+require 'buildr/java/test_result'
+
+module Buildr
+
+  # Mixin for test frameworks using src/spec/{lang}
+  class TestFramework::JavaBDD < TestFramework::Java #:nodoc:
+
+    class << self
+      attr_reader :lang, :bdd_dir
+    end
+    attr_accessor :lang, :bdd_dir
+
+    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| res.from dir if File.exist?(dir) }
+      end
+      super
+    end
+    
+  end
+
+  module TestFramework::JRubyBased
+    extend self
+
+    VERSION = '1.1.4'
+
+    class << self
+      def version
+        Buildr.settings.build['jruby'] || VERSION
+      end
+
+      def jruby_artifact
+        "org.jruby:jruby-complete:jar:#{version}"
+      end
+      
+      def dependencies
+        [jruby_artifact]
+      end
+
+      def included(mod)
+        mod.extend ClassMethods
+        super
+      end
+    end
+
+    module ClassMethods
+      def dependencies
+        deps = super
+        unless RUBY_PLATFORM[/java/] && TestFramework::JRubyBased.jruby_installed?
+          deps |= TestFramework::JRubyBased.dependencies
+        end
+        deps
+      end
+    end
+
+    def run(tests, dependencies)
+      maybe_install_jruby
+      dependencies |= [task.compile.target.to_s]
+      
+      spec_dir = task.project.path_to(:source, :spec, :ruby)
+      report_dir = task.report_to.to_s
+      FileUtils.rm_rf report_dir
+      FileUtils.mkdir_p report_dir
+      ENV['CI_REPORTS'] = report_dir
+
+      runner = runner_config
+      runner.content = runner_content(binding)
+      
+      Buildr.write(runner.file, runner.content)
+      FileUtils.rm_f runner.result
+      
+      if RUBY_PLATFORM[/java/] && !options.fork
+        runtime = new_runtime
+        runtime.getObject.java.lang.System.getProperties().putAll(options[:properties] || {})
+        runtime.getLoadService.require runner.file
+      else
+        cmd_options = task.options.only(:properties, :java_args)
+        cmd_options.update(:classpath => dependencies, :project => task.project)
+        jruby runner.file, tests, cmd_options
+      end
+      
+      result = YAML.load(File.read(runner.result))
+      if Exception === result
+        raise [result.message, result.backtrace].flatten.join("\n")
+      end
+      result.succeeded
+    end
+
+    def jruby_home
+      @jruby_home ||= RUBY_PLATFORM =~ /java/ ? Config::CONFIG['prefix'] : 
+        ( ENV['JRUBY_HOME'] || File.expand_path('~/.jruby') )
+    end
+
+    def jruby_installed?
+      !Dir.glob(File.join(jruby_home, 'lib', 'jruby*.jar')).empty?
+    end
+    
+  protected
+    def maybe_install_jruby
+      unless jruby_installed?
+        jruby_artifact = Buildr.artifact(TestFramework::JRubyBased.jruby_artifact)
+        msg = "JRUBY_HOME is not correctly set or points to an invalid JRuby installation: #{jruby_home}"
+        say msg
+        say ''
+        say "You need to install JRuby version #{jruby_artifact.version} using your system package manager."
+        say 'Or you can just execute the following command: '
+        say ''
+        say "   java -jar #{jruby_artifact} -S extract '#{jruby_home}'"
+        say ''
+        if agree('Do you want me to execute it for you? [y/N]', false)
+          jruby_artifact.invoke
+          Java::Commands.java('-jar', jruby_artifact.to_s, '-S', 'extract', jruby_home)
+        end
+        
+        fail msg unless jruby_installed?
+      end
+    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)
+      cmd_options[:classpath] ||= []
+      Dir.glob(File.join(jruby_home, 'lib', '*.jar')) { |jar| cmd_options[:classpath] << jar }
+      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
+      Java::Commands.java(*java_args)
+    end
+
+    def new_runtime(cfg = {})
+      config = Java.org.jruby.RubyInstanceConfig.new
+      cfg.each_pair do |name, value|
+        config.send("#{name}=", value)
+      end
+      yield config if block_given?
+      Java.org.jruby.Ruby.newInstance config
+    end
+    
+    def jruby_gem
+      %{
+       require 'jruby'
+       def JRuby.gem(name, version = '>0', *args)
+          require 'rbconfig'
+          jruby_home = Config::CONFIG['prefix']
+          expected_version = '#{TestFramework::JRubyBased.version}'
+          unless JRUBY_VERSION >= expected_version
+            fail "Expected JRuby version \#{expected_version} installed at \#{jruby_home} but got \#{JRUBY_VERSION}"
+          end
+          require 'rubygems'
+          begin
+            Kernel.gem name, version
+          rescue LoadError, Gem::LoadError => e
+            require 'rubygems/gem_runner'
+            Gem.manage_gems
+            args = ['install', name, '--version', version] + args
+            Gem::GemRunner.new.run(args)
+            Kernel.gem name, version
+          end
+       end
+      }
+    end
+
+    def runner_config(runner = OpenStruct.new)
+      [:requires, :gems, :output, :format].each do |key|
+        runner.send("#{key}=", options[key])
+      end
+      runner.html_report ||= File.join(task.report_to.to_s, 'report.html')
+      runner.result ||= task.project.path_to(:target, :spec, 'result.yaml')
+      runner.file ||= task.project.path_to(:target, :spec, 'runner.rb')
+      runner.requires ||= []
+      runner.requires.unshift File.join(File.dirname(__FILE__), 'test_result')
+      runner.gems ||= {}
+      runner.rspec ||= ['--format', 'progress', '--format', "html:#{runner.html_report}"]
+      runner.format.each { |format| runner.rspec << '--format' << format } if runner.format
+      runner.rspec.push '--format', "Buildr::TestFramework::TestResult::YamlFormatter:#{runner.result}"
+      runner
+    end    
+    
+  end
+
+  # <a href="http://rspec.info">RSpec</a> is the defacto BDD framework for ruby.
+  # To test your project with RSpec use:
+  #   test.using :rspec
+  #
+  #
+  # Support the following options:
+  # * :gems       -- A hash of gems to install before running the tests.
+  #                  The keys of this hash are the gem name, the value must be the required version.
+  # * :requires   -- A list of ruby files to require before running the specs
+  #                  Mainly used if an rspec format needs to require some file.
+  # * :format     -- A list of valid Rspec --format option values. (defaults to 'progress')
+  # * :output     -- File path to output dump. @false@ to supress output
+  # * :fork       -- Create a new JavaVM to run the tests on
+  # * :properties -- Hash of properties passed to the test suite.
+  # * :java_args  -- Arguments passed to the JVM.
+  class RSpec < TestFramework::JavaBDD
+    @lang = :ruby
+    @bdd_dir = :spec
+
+    include TestFramework::JRubyBased
+  
+    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 runner_config
+      runner = super
+      runner.gems.update 'rspec' => '>0'
+      runner.requires.unshift 'spec'
+      runner
+    end
+
+    def runner_content(binding)
+      runner_erb = %q{
+        <%= jruby_gem %>
+        <%= dependencies.inspect %>.each { |dep| $CLASSPATH << dep }
+        <%= runner.gems.inspect %>.each { |ary| JRuby.gem(*ary.flatten) }
+        <%= runner.requires.inspect %>.each { |rb| Kernel.require rb }
+        <% if runner.output == false %>
+          output = StringIO.new
+        <% elsif runner.output.kind_of?(String) %>
+          output = File.open(<%= result.output.inspect %>, 'w')
+        <% else %>
+          output = STDOUT
+        <% end %>
+        parser = ::Spec::Runner::OptionParser.new(output, output)
+        argv = <%= runner.rspec.inspect %> || []
+        argv.push *<%= tests.inspect %>
+        parser.order!(argv)
+        $rspec_options = parser.options
+        Buildr::TestFramework::TestResult::Error.guard('<%= runner.file %>') do
+          ::Spec::Runner::CommandLine.run($rspec_options)
+        end
+      }
+      Filter::Mapper.new(:erb, binding).result(runner_erb)
+    end
+
+  end
+
+  # <a href="http://jtestr.codehaus.org/">JtestR</a> is a framework for BDD and TDD using JRuby and ruby tools.
+  # To test your project with JtestR use:
+  #   test.using :jtestr
+  #
+  #
+  # Support the following options:
+  # * :config     -- path to JtestR config file. defaults to @spec/ruby/jtestr_config.rb@
+  # * :gems       -- A hash of gems to install before running the tests.
+  #                  The keys of this hash are the gem name, the value must be the required version.
+  # * :requires   -- A list of ruby files to require before running the specs
+  #                  Mainly used if an rspec format needs to require some file.
+  # * :format     -- A list of valid Rspec --format option values. (defaults to 'progress')
+  # * :output     -- File path to output dump. @false@ to supress output
+  # * :fork       -- Create a new JavaVM to run the tests on
+  # * :properties -- Hash of properties passed to the test suite.
+  # * :java_args  -- Arguments passed to the JVM.
+  class JtestR < TestFramework::JavaBDD
+    @lang = :ruby
+    @bdd_dir = :spec    
+
+    include TestFramework::JRubyBased
+
+    VERSION = '0.3.1'
+    
+    # pattern for rspec stories
+    STORY_PATTERN    = /_(steps|story)\.rb$/
+    # pattern for test_unit files
+    TESTUNIT_PATTERN = /(_test|Test)\.rb$|(tc|ts)[^\\\/]+\.rb$/
+    # pattern for test files using http://expectations.rubyforge.org/
+    EXPECT_PATTERN   = /_expect\.rb$/
+
+    TESTS_PATTERN = [STORY_PATTERN, TESTUNIT_PATTERN, EXPECT_PATTERN] + RSpec::TESTS_PATTERN
+
+    class << self
+
+      def version
+        Buildr.settings.build['jtestr'] || VERSION
+      end
+
+      def dependencies
+        @dependencies ||= Array(super) + ["org.jtestr:jtestr:jar:#{version}"] +
+          JUnit.dependencies + TestNG.dependencies
+      end
+    
+      def applies_to?(project) #:nodoc:
+        File.exist?(project.path_to(:source, bdd_dir, lang, 'jtestr_config.rb')) ||
+          Dir[project.path_to(:source, bdd_dir, lang, '**/*.rb')].any? { |f| TESTS_PATTERN.any? { |r| r === f } } ||
+          JUnit.applies_to?(project) || TestNG.applies_to?(project)
+      end
+
+    private
+      def const_missing(const)
+        return super unless const == :REQUIRES # TODO: remove in 1.5
+        Buildr.application.deprecated 'Please use JtestR.dependencies/.version instead of JtestR::REQUIRES/VERSION'
+        dependencies
+      end
+
+    end
+
+    def initialize(task, options) #:nodoc:
+      super
+      [:test, :spec].each do |usage|
+        java_tests = task.project.path_to(:source, usage, :java)
+        task.compile.from java_tests if File.directory?(java_tests)
+        resources = task.project.path_to(:source, usage, :resources)
+        task.resources.from resources if File.directory?(resources)
+      end
+    end
+
+    def user_config
+      options[:config] || task.project.path_to(:source, bdd_dir, lang, 'jtestr_config.rb')
+    end
+
+    def tests(dependencies) #:nodoc:
+      dependencies |= [task.compile.target.to_s]
+      types = { :story => STORY_PATTERN, :rspec => RSpec::TESTS_PATTERN,
+                :testunit => TESTUNIT_PATTERN, :expect => EXPECT_PATTERN }
+      tests = types.keys.inject({}) { |h, k| h[k] = []; h }
+      tests[:junit] = JUnit.new(task, {}).tests(dependencies)
+      tests[:testng] = TestNG.new(task, {}).tests(dependencies)
+      Dir[task.project.path_to(:source, bdd_dir, lang, '**/*.rb')].each do |rb|
+        type = types.find { |k, v| Array(v).any? { |r| r === rb } }
+        tests[type.first] << rb if type
+      end
+      @jtestr_tests = tests
+      tests.values.flatten
+    end
+
+    def runner_config
+      runner = super
+      runner.gems.update 'rspec' => '>0'
+      runner.requires.unshift 'spec', 'jtestr'
+      runner
+    end
+
+    def runner_content(binding)
+      runner_erb = File.join(File.dirname(__FILE__), 'jtestr_runner.rb.erb')
+      Filter::Mapper.new(:erb, binding).result(File.read(runner_erb), runner_erb)
+    end
+    
+  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::JavaBDD
+    @lang = :java
+    @bdd_dir = :spec
+
+    VERSION = '1.0.1'
+    TESTS_PATTERN = [ /Behaviou?r$/ ] #:nodoc:
+    
+    class << self
+      def version
+        Buildr.settings.build['jbehave'] || VERSION
+      end
+
+      def dependencies
+        @dependencies ||= ["org.jbehave:jbehave:jar:#{version}", 'cglib:cglib-full:jar:2.0.2'] +
+          JMock.dependencies + JUnit.dependencies
+      end
+
+      def applies_to?(project) #:nodoc:
+        %w{
+          **/*Behaviour.java **/*Behavior.java
+        }.any? { |glob| !Dir[project.path_to(:source, bdd_dir, lang, glob)].empty? }
+      end
+
+    private
+      def const_missing(const)
+        return super unless const == :REQUIRES # TODO: remove in 1.5
+        Buildr.application.deprecated 'Please use JBehave.dependencies/.version instead of JBehave::REQUIRES/VERSION'
+        dependencies
+      end
+    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
+
+end
+
+Buildr::TestFramework << Buildr::RSpec
+Buildr::TestFramework << Buildr::JtestR
+Buildr::TestFramework << Buildr::JBehave

data/lib/buildr/java/commands.rb

@@ -47,7 +47,7 @@ module Java
         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
+          info "Running #{name}"
           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
           cmd_args = cmd_args.map(&:inspect).join(' ') if Util.win_os?
@@ -83,13 +83,12 @@ module Java
         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)
+        Java.tools_jar { |tools| classpath << 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
+          info 'Running apt'
+          trace (['apt'] + cmd_args).join(' ')
           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'
@@ -124,8 +123,8 @@ module Java
         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
+          info "Compiling #{files.size} source files in #{name}"
+          trace (['javac'] + cmd_args).join(' ')
           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'
@@ -174,8 +173,8 @@ module Java
         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
+          info "Generating Javadoc for #{name}"
+          trace (['javadoc'] + cmd_args).join(' ')
           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'