assaf-buildr 1.3.3

data/rakelib/setup.rake

@@ -0,0 +1,86 @@
+# 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 'rubygems/source_info_cache'
+require 'stringio' # for Gem::RemoteFetcher
+require 'jruby' if RUBY_PLATFORM[/java/]
+
+# True if running on the Windows operating sytem.  Different from Gem.win_platform?
+# which returns true if running on the Windows platform of MRI, false when using JRuby.
+def windows?
+  Config::CONFIG['host_os'] =~ /windows|cygwin|bccwin|cygwin|djgpp|mingw|mswin|wince/i
+end
+
+def set_java_home
+  if !ENV['JAVA_HOME'] && RUBY_PLATFORM[/java/]
+    ENV['JAVA_HOME'] = java.lang.System.getProperty('java.home')
+  end
+  fail "Please set JAVA_HOME first #{'(no need to run as sudo)' if ENV['USER'] == 'root'}" unless ENV['JAVA_HOME']
+end
+
+def set_gem_home
+  ENV['GEM_HOME'] ||= Gem.path.find { |f| File.writable?(f) }
+end
+
+def sudo_needed?
+  !( windows? || ENV['GEM_HOME'] )
+end
+
+# Finds and returns path to executable.  Consults PATH environment variable.
+# Returns nil if executable not found.
+def which(name)
+  if windows?
+    path = ENV['PATH'].split(File::PATH_SEPARATOR).map { |path| path.gsub('\\', '/') }.map { |path| "#{path}/#{name}.{exe,bat,com}" }
+  else
+    path = ENV['PATH'].split(File::PATH_SEPARATOR).map { |path| "#{path}/#{name}" }
+  end
+  FileList[path].existing.first
+end
+
+# Execute a GemRunner command
+def gem_run(*args)
+  rb_bin = File.join(Config::CONFIG['bindir'], Config::CONFIG['ruby_install_name'])
+  args.unshift rb_bin, '-S', 'gem'
+  args.unshift 'sudo', 'env', 'JAVA_HOME=' + ENV['JAVA_HOME'] if sudo_needed?
+  sh *args.map{ |a| a.inspect }.join(' ')
+end
+
+def install_gem(name, ver_requirement = ['> 0'])
+  dep = Gem::Dependency.new(name, ver_requirement)
+  @load_cache = true
+  if Gem::SourceIndex.from_installed_gems.search(dep).empty?
+    spec = Gem::SourceInfoCache.search(dep, true, @load_cache).last
+    fail "#{dep} not found in local or remote repository!" unless spec
+    puts "Installing #{spec.full_name} ..."
+    args = ['install']
+    args.push '--install-dir', ENV['GEM_HOME'] if ENV['GEM_HOME']
+    args.push spec.name, '-v', spec.version.to_s
+    gem_run *args
+    @load_cache = false # Just update the Gem cache once
+  end
+end
+
+# Setup environment for running this Rakefile (RSpec, Docter, etc).
+desc "If you're building from sources, run this task first to setup the necessary dependencies."
+missing = spec.dependencies.select { |dep| Gem::SourceIndex.from_installed_gems.search(dep).empty? }
+task 'setup' do
+  set_java_home
+  set_gem_home
+  missing.each do |dep|
+    install_gem dep.name, dep.version_requirements
+  end
+end
+puts "Missing Gems #{missing.join(', ')}, please run rake setup first!" unless missing.empty?

data/rakelib/stage.rake

@@ -0,0 +1,48 @@
+# 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.
+
+
+# Staged files are copied to this directory first, and from there uploaded to the staging server.
+directory 'staged'
+
+task 'clobber' do
+  rm_rf 'staged'
+end
+
+namespace 'stage' do
+  # stage:check verifies that we're able to stage a release: check for a changelog,
+  # local changes, run all the test cases, etc.  You can add more actions, e.g.
+  # checking license files, spell checking documentation.
+  task 'check'=>['setup', 'clobber']
+
+  # stage:prepare prepares all the files necessary for making a successful release:
+  # binary and source packages, documentation, Web site, change file, checksums, etc.
+  # This task depends on stage:check, and also performs its own verification of the
+  # produced artifacts.  Staged files are placed in the staged directory.
+  task 'prepare'=>'staged'
+
+  # stage:upload moves the stage directory to the staging server.
+  task 'upload' do |task, args|
+    puts "Uploading staged directory to #{args.staging} ..."
+    sh 'rsync', '--progress', '--recursive', 'staged/', args.staging
+    puts 'Done'
+  end
+  
+  # Put anything that happens post staging here, e.g. release vote email template.
+  task 'wrapup'
+end
+
+desc 'Stage files for the release, upload them to staging server'
+task 'stage'=>['stage:check', 'stage:prepare', 'stage:upload', 'stage:wrapup']

data/spec/addon/cobertura_spec.rb

@@ -0,0 +1,77 @@
+# 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 File.join(File.dirname(__FILE__), 'test_coverage_spec')
+Sandbox.require_addon 'buildr/cobertura'
+
+Buildr::Cobertura::requires
+
+
+describe Buildr::Cobertura do
+  before do
+    # Reloading the addon because the sandbox removes all its actions
+    load File.expand_path('../addon/buildr/cobertura.rb')
+    @tool_module = Buildr::Cobertura 
+  end
+  
+  it_should_behave_like 'test coverage tool'
+  
+  describe 'project-specific' do
+    
+    describe 'data file' do
+      it 'should have a default value' do
+        define('foo').cobertura.data_file.should point_to_path('reports/cobertura.ser')
+      end
+      
+      it 'should be overridable' do
+        define('foo') { cobertura.data_file = path_to('target/data.cobertura') }
+        project('foo').cobertura.data_file.should point_to_path('target/data.cobertura')
+      end
+      
+      it 'should be created during instrumentation' do
+        write 'src/main/java/Foo.java', 'public class Foo {}'
+        define('foo')
+        task('foo:cobertura:instrument').invoke
+        file(project('foo').cobertura.data_file).should exist
+      end
+    end
+      
+    describe 'instrumentation' do
+      before do
+        ['Foo', 'Bar'].each { |cls| write File.join('src/main/java', "#{cls}.java"), "public class #{cls} {}" }
+      end
+      
+      it 'should instrument only included classes' do
+        define('foo') { cobertura.include 'Foo' }
+        task("foo:cobertura:instrument").invoke
+        Dir.chdir('target/instrumented/classes') { Dir.glob('*').sort.should == ['Foo.class'] }
+      end
+      
+      it 'should not instrument excluded classes' do
+        define('foo') { cobertura.exclude 'Foo' }
+        task("foo:cobertura:instrument").invoke
+        Dir.chdir('target/instrumented/classes') { Dir.glob('*').sort.should == ['Bar.class'] }
+      end
+      
+      it 'should instrument classes that are included but not excluded' do
+        write 'src/main/java/Baz.java', 'public class Baz {}'
+        define('foo') { cobertura.include('Ba').exclude('ar') }
+        task("foo:cobertura:instrument").invoke
+        Dir.chdir('target/instrumented/classes') { Dir.glob('*').sort.should == ['Baz.class'] }
+      end
+    end
+  end
+end

data/spec/addon/emma_spec.rb

@@ -0,0 +1,120 @@
+# 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 File.join(File.dirname(__FILE__), 'test_coverage_spec')
+Sandbox.require_addon 'buildr/emma'
+
+
+Buildr::Emma::requires
+
+
+describe Buildr::Emma do
+  before do
+    # Reloading the addon because the sandbox removes all its actions
+    load File.expand_path('../addon/buildr/emma.rb')
+    @tool_module = Buildr::Emma
+  end
+
+  it_should_behave_like 'test coverage tool'
+  
+  describe 'project-specific' do
+    describe 'metadata file' do
+      it 'should have a default value' do
+        define('foo').emma.metadata_file.should point_to_path('reports/emma/coverage.em')
+      end
+      
+      it 'should be overridable' do
+        define('foo') { emma.metadata_file = path_to('target/metadata.emma') }
+        project('foo').emma.metadata_file.should point_to_path('target/metadata.emma')
+      end
+      
+      it 'should be created during instrumentation' do
+        write 'src/main/java/Foo.java', 'public class Foo {}'
+        define('foo')
+        task('foo:emma:instrument').invoke
+        file(project('foo').emma.metadata_file).should exist
+      end
+    end
+    
+    describe 'coverage file' do
+      it 'should have a default value' do
+        define('foo').emma.coverage_file.should point_to_path('reports/emma/coverage.ec')
+      end
+      
+      it 'should be overridable' do
+        define('foo') { emma.coverage_file = path_to('target/coverage.emma') }
+        project('foo').emma.coverage_file.should point_to_path('target/coverage.emma')
+      end
+      
+      it 'should be created during test' do
+        write 'src/main/java/Foo.java', 'public class Foo {}'
+        write_test :for=>'Foo', :in=>'src/test/java'
+        define('foo')
+        task('foo:test').invoke
+        file(project('foo').emma.coverage_file).should exist
+      end
+    end
+
+    describe 'instrumentation' do
+      before do
+        ['Foo', 'Bar'].each { |cls| write File.join('src/main/java', "#{cls}.java"), "public class #{cls} {}" }
+      end
+
+      it 'should instrument only included classes' do
+        define('foo') { emma.include 'Foo' }
+        task("foo:emma:instrument").invoke
+        Dir.chdir('target/instrumented/classes') { Dir.glob('*').sort.should == ['Foo.class'] }
+      end
+
+      it 'should not instrument excluded classes' do
+        define('foo') { emma.exclude 'Foo' }
+        task("foo:emma:instrument").invoke
+        Dir.chdir('target/instrumented/classes') { Dir.glob('*').sort.should == ['Bar.class'] }
+      end
+      
+      it 'should instrument classes that are included but not excluded' do
+        write 'src/main/java/Baz.java', 'public class Baz {}'
+        define('foo') { emma.include('Ba*').exclude('*ar') }
+        task("foo:emma:instrument").invoke
+        Dir.chdir('target/instrumented/classes') { Dir.glob('*').sort.should == ['Baz.class'] }
+      end
+    end
+    
+    describe 'reports' do
+      before do
+        write 'src/main/java/Foo.java', 'public class Foo {}'
+        write_test :for=>'Foo', :in=>'src/test/java'
+      end
+      
+      describe 'in html' do
+        it 'should inform the user if no coverage data' do
+          rm 'src/test/java/FooTest.java'
+          define('foo')
+          lambda { task('foo:emma:html').invoke }.
+            should show_info(/No test coverage report for foo. Missing: #{project('foo').emma.coverage_file}/)
+        end
+      end
+      
+      describe 'in xml' do
+        it 'should have an xml file' do
+          define('foo')
+          task('foo:emma:xml').invoke
+          file(File.join(project('foo').emma.report_dir, 'coverage.xml')).should exist
+        end
+      end      
+    end
+  end
+end

data/spec/addon/test_coverage_spec.rb

@@ -0,0 +1,255 @@
+# 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 File.join(File.dirname(__FILE__), '../spec_helpers')
+
+
+module TestCoverageHelper
+  def write_test options
+    write File.join(options[:in], "#{options[:for]}Test.java"),
+      "public class #{options[:for]}Test extends junit.framework.TestCase { public void test#{options[:for]}() { new #{options[:for]}(); } }"
+  end
+
+  # Rspec matcher using file glob patterns.
+  class FileNamePatternMatcher
+    def initialize(pattern)
+      @expected_pattern = pattern
+      @pattern_matcher = lambda { |filename| File.fnmatch? pattern, filename }
+    end
+    
+    def matches?(directory)
+      @actual_filenames = Dir[File.join(directory,'*')]
+      @actual_filenames.any? &@pattern_matcher
+    end
+    
+    def failure_message
+      "Expected to find at least one element matching '#{@expected_pattern}' among #{@actual_filenames.inspect}, but found none"
+    end
+    
+    def negative_failure_message
+      "Expected to find no element matching '#{@expected_pattern}' among #{@actual_filenames.inspect}, but found matching element(s) #{@actual_filenames.select(&@pattern_matcher).inspect}"
+    end
+  end
+  
+  # Test if a directory contains at least one file matching a given glob pattern.
+  #
+  # For example, to check that a directory contains at least one HTML file:
+  #   '/path/to/some/directory'.should have_files_matching('*.html')
+  def have_files_matching pattern
+    FileNamePatternMatcher.new pattern
+  end
+end
+
+describe 'test coverage tool', :shared=>true do
+  include TestCoverageHelper
+
+  def toolname
+    @tool_module.name.split('::').last.downcase
+  end
+
+  def test_coverage_config
+    project('foo').send(toolname)
+  end
+  
+  describe 'project-specific' do
+
+    before do
+      write 'src/main/java/Foo.java', 'public class Foo {}'
+      write_test :for=>'Foo', :in=>'src/test/java'
+    end
+
+    describe 'clean' do
+      before { define('foo') }
+      
+      it 'should remove the instrumented directory' do
+        mkdir_p test_coverage_config.instrumented_dir.to_s
+        task('foo:clean').invoke
+        file(test_coverage_config.instrumented_dir).should_not exist
+      end
+      
+      it 'should remove the reporting directory' do
+        mkdir_p test_coverage_config.report_dir
+        task('foo:clean').invoke
+        file(test_coverage_config.report_dir).should_not exist
+      end
+    end
+    
+    describe 'instrumented directory' do
+      it 'should have a default value' do
+        define('foo')
+        test_coverage_config.instrumented_dir.should point_to_path('target/instrumented/classes')
+      end
+
+      it 'should be overridable' do
+        toolname = toolname()
+        define('foo') { send(toolname).instrumented_dir = path_to('target/coverage/classes') }
+        test_coverage_config.instrumented_dir.should point_to_path('target/coverage/classes')
+      end
+      
+      it 'should be created during instrumentation' do
+        define('foo')
+        task("foo:#{toolname}:instrument").invoke
+        file(test_coverage_config.instrumented_dir).should exist
+      end
+    end
+
+    describe 'instrumentation' do
+      def instrumented_dir
+        file(test_coverage_config.instrumented_dir)
+      end
+
+      it 'should happen after compile' do
+        define('foo')
+        lambda { task("foo:#{toolname}:instrument").invoke }.should run_task('foo:compile')
+      end
+
+      it 'should put classes from compile.target in the instrumented directory' do
+        define('foo')
+        task("foo:#{toolname}:instrument").invoke
+        Dir.entries(instrumented_dir.to_s).should == Dir.entries(project('foo').compile.target.to_s)
+      end
+
+      it 'should touch instrumented directory if anything instrumented' do
+        a_long_time_ago = Time.now - 10
+        define('foo')
+        mkpath instrumented_dir.to_s
+        File.utime(a_long_time_ago, a_long_time_ago, instrumented_dir.to_s)
+        task("foo:#{toolname}:instrument").invoke
+        instrumented_dir.timestamp.should be_close(Time.now, 2)
+      end
+
+      it 'should not touch instrumented directory if nothing instrumented' do
+        a_long_time_ago = Time.now - 10
+        define('foo').compile.invoke
+        mkpath instrumented_dir.to_s
+        [project('foo').compile.target, instrumented_dir].map(&:to_s).each { |dir| File.utime(a_long_time_ago, a_long_time_ago, dir) }
+        task("foo:#{toolname}:instrument").invoke
+        instrumented_dir.timestamp.should be_close(a_long_time_ago, 2)
+      end
+    end
+
+    describe 'testing classpath' do
+      it 'should give priority to instrumented classes over non-instrumented ones' do
+        define('foo')
+        depends = project('foo').test.dependencies
+        depends.index(test_coverage_config.instrumented_dir).should < depends.index(project('foo').compile.target)
+      end
+
+      it 'should have the test coverage tools artifacts' do
+        define('foo')
+        @tool_module.requires.each { |artifact| project('foo').test.dependencies.should include(artifact) }
+      end
+    end
+
+    describe 'html report' do
+      it 'should have html files' do
+        define('foo')
+        task("foo:#{toolname}:html").invoke
+        test_coverage_config.report_to(:html).should have_files_matching('*.html')
+      end
+      
+      it 'should contain full source code, including comments' do
+        write 'src/main/java/Foo.java',
+          'public class Foo { /* This comment is a TOKEN to check that test coverage reports include the source code */ }'
+        define('foo')
+        task("foo:#{toolname}:html").invoke
+        htlm_report_contents = Dir[File.join(test_coverage_config.report_dir, '**/*.html')].map{|path|File.open(path).read}.join
+        htlm_report_contents.should =~ /TOKEN/
+      end
+    end
+  end
+
+  describe 'cross-project' do
+    describe 'reporting' do
+      before do
+        write 'src/main/java/Foo.java', 'public class Foo {}'
+        write 'bar/src/main/java/Bar.java', 'public class Bar {}'
+        write_test :for=>'Bar', :in=>'bar/src/test/java'
+        define('foo') { define('bar') }
+      end
+
+      it 'should have a default target' do
+        @tool_module.report_to.should point_to_path(File.join('reports', toolname))
+      end
+
+      describe 'in html' do
+        it 'should be a defined task' do
+          Rake::Task.task_defined?("#{toolname}:html").should be(true)
+        end
+
+        it 'should happen after project instrumentation and testing' do
+          lambda { task("#{toolname}:html").invoke }.should run_tasks(["foo:#{toolname}:instrument", 'foo:bar:test'])
+        end
+
+        it 'should have html files' do
+          task("#{toolname}:html").invoke
+          @tool_module.report_to(:html).should have_files_matching('*.html')
+        end
+        
+        it 'should contain full source code, including comments' do
+          write 'bar/src/main/java/Bar.java',
+            'public class Bar { /* This comment is a TOKEN to check that test coverage reports include the source code */ }'
+          task("#{toolname}:html").invoke
+          htlm_report_contents = Dir[File.join(@tool_module.report_to(:html), '**/*.html')].map{|path|File.open(path).read}.join
+          htlm_report_contents.should =~ /TOKEN/
+        end
+        
+        it 'should handle gracefully a project with no source' do
+          define 'baz', :base_dir=>'baz'
+          task("#{toolname}:html").invoke
+          lambda { task("#{toolname}:html").invoke }.should_not raise_error
+        end
+      end
+    end
+    
+    describe 'clean' do
+      it 'should remove the report directory' do
+        define('foo')
+        mkdir_p @tool_module.report_to
+        task("#{toolname}:clean").invoke
+        file(@tool_module.report_to).should_not exist
+      end
+      
+      it 'should be called when calling global clean' do
+        define('foo')
+        lambda { task('clean').invoke }.should run_task("#{toolname}:clean")
+      end
+    end
+  end
+  
+  describe 'project with no source' do
+    it 'should not define an html report task' do
+      define 'foo'
+      Rake::Task.task_defined?("foo:#{toolname}:html").should be(false)
+    end
+    
+    it 'should not raise an error when instrumenting' do
+      define('foo')
+      lambda { task("foo:#{toolname}:instrument").invoke }.should_not raise_error
+    end
+    
+    it 'should not add the instrumented directory to the testing classpath' do
+      define 'foo'
+      depends = project('foo').test.dependencies
+      depends.should_not include(test_coverage_config.instrumented_dir)
+    end
+    
+    it 'should not add the test coverage tools artifacts to the testing classpath' do
+      define('foo')
+      @tool_module.requires.each { |artifact| project('foo').test.dependencies.should_not include(artifact) }
+    end
+  end
+end