vic-buildr 1.3.1 → 1.3.3

data/rakelib/apache.rake

@@ -14,31 +14,42 @@
 # the License.
 
 
-require 'md5'
-require 'sha1'
+require 'digest/md5'
+require 'digest/sha1'
 
 
 # Tasks specific to Apache projects (license, release, etc).
 namespace 'apache' do
 
+  desc 'Upload snapshot packages over to people.apache.org'
+  task 'snapshot'=>['spec', 'package'] do
+    rm_rf 'snapshot' # Always start with empty directory
+    puts "Copying existing gems from Apache"
+    sh 'rsync', '--progress', '--recursive', 'people.apache.org:public_html/buildr/snapshot', './'
+    puts "Copying new gems over"
+    cp FileList['pkg/{*.gem,*.tgz,*.zip}'], 'snapshot/gems'
+    puts "Generating gem index ..."
+    sh 'gem', 'generate_index', '--directory', 'snapshot'
+    puts "Copying gem and index back to Apache" 
+    sh 'rsync', '--progress', '--recursive', 'snapshot', 'people.apache.org:public_html/buildr/'
+  end
+
+
   desc 'Check that source files contain the Apache license'
   task 'license' do |task|
     print 'Checking that files contain the Apache license ... '
     required = task.prerequisites.select { |fn| File.file?(fn) }
     missing = required.reject { |fn| 
-      comments = File.read(fn).scan(/(\/\*(.*?)\*\/)|^#\s+(.*?)$|<!--(.*?)-->/m).
+      comments = File.read(fn).scan(/(\/\*(.*?)\*\/)|^#\s+(.*?)$|^-#\s+(.*?)$|<!--(.*?)-->/m).
         map { |match| match.compact }.flatten.join("\n")
       comments =~ /Licensed to the Apache Software Foundation/ && comments =~ /http:\/\/www.apache.org\/licenses\/LICENSE-2.0/
     }
     fail "#{missing.join(', ')} missing Apache License, please add it before making a release!" unless missing.empty?
     puts 'OK'
   end
-  task('license').prerequisites.exclude('.class', '.png', '.jar', '.tif', '.textile', '.haml',
-    'README', 'LICENSE', 'CHANGELOG', 'DISCLAIMER', 'NOTICE', 'KEYS', 'spec/spec.opts')
-
-  task 'check' do
-    ENV['GPG_USER'] or fail 'Please set GPG_USER (--local-user) environment variable so we know which key to use.'
-  end
+  
+  # Staging checks specific for Apache.
+  task 'check'=>'license'
 
 
   file 'staged/distro'=>'package' do
@@ -49,15 +60,16 @@ namespace 'apache' do
     end
   end
 
-  task 'sign'=>['KEYS', 'staged/distro'] do
-    gpg_user = ENV['GPG_USER'] or fail 'Please set GPG_USER (--local-user) environment variable so we know which key to use.'
+  task 'sign'=>['etc/KEYS', 'staged/distro'] do |task, args|
+    gpg_user = args.gpg_user or fail "Please run with gpg_user=<argument for gpg --local-user>"
+    puts "Signing packages in staged/distro as user #{gpg_user}"
     FileList['staged/distro/*.{gem,zip,tgz}'].each do |pkg|
       bytes = File.open(pkg, 'rb') { |file| file.read }
       File.open(pkg + '.md5', 'w') { |file| file.write MD5.hexdigest(bytes) << ' ' << File.basename(pkg) }
       File.open(pkg + '.sha1', 'w') { |file| file.write SHA1.hexdigest(bytes) << ' ' << File.basename(pkg) }
       sh 'gpg', '--local-user', gpg_user, '--armor', '--output', pkg + '.asc', '--detach-sig', pkg, :verbose=>true
     end
-    cp 'KEYS', 'staged/distro'
+    cp 'etc/KEYS', 'staged/distro'
   end
 
   # Publish prerequisites to distro server.
@@ -96,34 +108,6 @@ p>. ("Release signing keys":#{url}/KEYS)
     puts 'Done'
   end
 
-=begin
-  task 'distro-links'=>['staged/site', 'apache:sign'] do |task, args|
-    rows = FileList['staged/distro/*.{gem,tgz,zip}'].map { |pkg|
-      name, md5 = File.basename(pkg), File.read("#{pkg}.md5").split.first
-      <<-HTML
-      <tr>
-        <td><a href="#{url}/#{name}">#{name}</a></td>
-        <td><a href="#{url}/#{name}.md5">#{md5}</a></td>
-        <td><a href="#{url}/#{name}.asc">Sig</a></td>
-      </tr>
-      HTML
-    }
-    html = <<-HTML
-    <h3>#{spec.name} #{spec.version}#{args.incubating && "-incubating"} (#{Time.now.strftime('%Y-%m-%d')})</h3>
-    <table>
-      <thead><th>Package</th><th>MD5 Checksum</th><th>PGP</th></thead>
-    #{rows.join("\n")}
-    </table>
-    <p style="text-align:right"> (<a href="#{url}/KEYS">Release signing keys</a>)</p>
-    HTML
-    file_name = 'staged/site/download.html'
-    modified = File.read(file_name).sub(/<h2.*binaries.*source.*<\/h2>.*/i) { |header| "#{header}\n#{html}\n" }
-    File.open file_name, 'w' do |file|
-      file.write modified
-    end
-  end
-=end
-
   file 'staged/site'=>['distro-links', 'staged', 'site'] do
     rm_rf 'staged/site'
     cp_r 'site', 'staged'
@@ -141,11 +125,17 @@ p>. ("Release signing keys":#{url}/KEYS)
 end
 
 
-task 'stage:check'=>['apache:license', 'apache:check']
+task 'stage:check'=>['apache:check']
 task 'stage:prepare'=>['staged/distro', 'staged/site'] do |task|
   # Since this requires input (passphrase), do it at the very end.
   task.enhance do
     task('apache:sign').invoke
   end
 end
+task 'stage' do
+  task('apache:snapshot').invoke
+end
 task 'release:publish'=>['apache:publish:distro', 'apache:publish:site']
+task 'clobber' do
+  rm_rf 'snapshot'
+end

data/rakelib/doc.rake

@@ -51,7 +51,7 @@ begin
   collection = Docter.collection(spec.name).using('doc/site.toc.yaml').include('doc/pages', 'LICENSE', 'CHANGELOG')
   # TODO:  Add coverage reports when we get them to run.
   template   = Docter.template('doc/site.haml').
-    include('doc/css', 'doc/images', 'doc/scripts', 'reports/specs.html', 'rdoc', 'print/buildr.pdf')
+    include('doc/css', 'doc/images', 'doc/scripts', 'reports/coverage', 'reports/specs.html', 'rdoc', 'print/buildr.pdf')
 
   desc 'Run Docter server on port 3000'
   Docter::Rake.serve 'docter', collection, template, :port=>3000
@@ -60,7 +60,7 @@ begin
   Docter::Rake.generate 'site', collection, template
 
   Docter::Rake.generate 'print',
-    Docter.collection(spec.name).using('doc/print.toc.yaml').include('doc/pages', 'LICENSE'),
+    Docter.collection(spec.name).using('doc/print.toc.yaml').include('doc/pages'),
     Docter.template('doc/print.haml').include('doc/css', 'doc/images'), :one_page
 
   file('print/buildr.pdf'=>'print') do |task|

data/rakelib/package.rake

@@ -29,7 +29,7 @@ desc 'Install the package locally'
 task 'install'=>['setup', "#{package.package_dir}/#{package.gem_file}"] do |task|
   print "Installing #{spec.name} ... "
   args = [Config::CONFIG['ruby_install_name'], '-S', 'gem', 'install', "#{package.package_dir}/#{package.gem_file}"]
-  args.unshift('sudo') unless windows?
+  args.unshift('sudo') if sudo_needed?
   sh *args
   puts 'Done'
 end
@@ -38,7 +38,36 @@ desc 'Uninstall previously installed packaged'
 task 'uninstall' do |task|
   print "Uninstalling #{spec.name} ... "
   args = [Config::CONFIG['ruby_install_name'], '-S', 'gem', 'uninstall', spec.name, '--version', spec.version.to_s]
-  args.unshift('sudo') unless windows?
+  args.unshift('sudo') if sudo_needed?
   sh *args
   puts 'Done'
 end
+
+
+desc 'Look for new dependencies, check transitive dependencies'
+task 'dependency' do
+  puts "Checking that all dependencies are up to date ..."
+  # Find if anything has a more recent dependency.  These are not errors, just reports.
+  for dep in spec.dependencies
+    current = Gem::SourceInfoCache.search(dep, true, true).last
+    latest = Gem::SourceInfoCache.search(Gem::Dependency.new(dep.name, '>0'), true, true).last
+    puts "A new version of #{dep.name} is available, #{latest.version} replaces #{current.version}" if latest.version > current.version
+  end
+
+  # Returns orderd list of transitive dependencies for the given dependency.
+  transitive = lambda { |depend|
+    dep_spec = Gem::SourceIndex.from_installed_gems.search(depend).last
+    dep_spec.dependencies.map { |trans| transitive[trans].push(trans) }.flatten.uniq }
+  # For each dependency, make sure *all* its transitive dependencies are listed
+  # as a Buildr dependency, and order is preserved.
+  spec.dependencies.each_with_index do |dep, index|
+    puts "checking #{dep.name}"
+    for trans in transitive[dep]
+      matching = spec.dependencies.find { |existing| trans =~ existing }
+      fail "#{trans} required by #{dep} and missing from spec" unless matching
+      fail "#{trans} must come before #{dep} in dependency list" unless spec.dependencies.index(matching) < index
+    end
+  end
+end
+
+task 'stage:check'=>'dependency'

data/rakelib/rspec.rake

@@ -19,36 +19,39 @@ begin
 
   directory 'reports'
   task 'clobber' do
-    rm 'failing' rescue nil
+    rm_f 'failed'
     rm_rf 'reports'
   end
 
   desc 'Run all specs'
   Spec::Rake::SpecTask.new('spec'=>'reports') do |task|
-    task.spec_files = FileList['spec/**/*_spec.rb']
-    task.spec_opts << '--options' << 'spec/spec.opts' << '--format' << 'failing_examples:failing' <<
-      '--format' << 'html:reports/specs.html' << '--backtrace'
+    task.spec_files = Dir['spec/**/*_spec.rb']
+    task.spec_opts = %w{--format specdoc --format failing_examples:failed --format html:reports/specs.html --loadby mtime --backtrace}    
+    task.spec_opts << '--colour' if $stdout.isatty
   end
   file 'reports/specs.html'=>'spec'
 
-  desc 'Run all failing examples from previous run'
-  Spec::Rake::SpecTask.new('failing') do |task|
-    task.spec_files = FileList['spec/**/*_spec.rb']
-    task.spec_opts << '--options' << 'spec/spec.opts' << '--format' << 'failing_examples:failing' << '--example' << 'failing'
+  desc 'Run all failed examples from previous run'
+  Spec::Rake::SpecTask.new('failed') do |task|
+    task.spec_files = Dir['spec/**/*_spec.rb']
+    task.spec_opts = %w{--format specdoc --format failing_examples:failed --example failed --backtrace}    
+    task.spec_opts << '--colour' if $stdout.isatty
   end
 
+  # TODO: Horribly broken!  Fix some other time.
+  desc 'Run RSpec and generate Spec and coverage reports (slow)'
+  Spec::Rake::SpecTask.new('coverage'=>'reports') do |task|
+    task.spec_files = Dir['spec/**/*_spec.rb']
+    task.spec_opts = %W{--format progress --format failing_examples:failed --format html:reports/specs.html --backtrace}    
+    task.spec_opts << '--colour' if $stdout.isatty
+    task.rcov = true
+    task.rcov_dir = 'reports/coverage'
+    task.rcov_opts << '--exclude / --include-file ^lib --text-summary'
+  end
+  file 'reports/coverage'=>'coverage'
+
   # Useful for testing with JRuby when using Ruby and vice versa.
   namespace 'spec' do
-=begin
-    # TODO: Horribly broken!  Fix some other time.
-    desc 'Run RSpec and generate Spec and coverage reports (slow)'
-    Spec::Rake::SpecTask.new('rcov') do |task|
-      task.spec_files = FileList['spec/**/*spec.rb']
-      task.rcov = true
-      task.rcov_opts = '--exclude', 'spec,bin'
-      task.rcov_dir = 'coverage'
-    end
-=end
 
     desc 'Run all specs specifically with Ruby'
     task 'ruby' do
@@ -77,5 +80,4 @@ end
 
 
 task 'stage:prepare'=>'spec'
-task 'stage:prepare'=>RUBY_PLATFORM =~ /java/ ? 'spec:ruby' : 'spec:jruby'
-# TODO:  Add Rcov when we get it working again.
+task 'stage:prepare'=>RUBY_PLATFORM =~ /java/ ? 'spec:ruby' : 'spec:jruby' # Test the *other* platform

data/rakelib/rubyforge.rake

@@ -41,6 +41,7 @@ namespace 'rubyforge' do
     files = FileList['published/rubyforge/*.{gem,tgz,zip}'].exclude(changes).existing
     print "Uploading #{spec.version} to RubyForge ... "
     rubyforge = RubyForge.new
+    rubyforge.configure
     rubyforge.login 
     rubyforge.userconfig.merge!('release_changes'=>changes,  'preformatted' => true) if changes
     rubyforge.add_release spec.rubyforge_project.downcase, spec.name.downcase, spec.version.to_s, *files

data/rakelib/setup.rake

@@ -12,17 +12,32 @@
 # WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the
 # License for the specific language governing permissions and limitations under
 # the License.
-# 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.
 
 
 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.
@@ -35,25 +50,35 @@ def which(name)
   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)
-  rb_bin = File.join(Config::CONFIG['bindir'], Config::CONFIG['ruby_install_name'])
+  @load_cache = true
   if Gem::SourceIndex.from_installed_gems.search(dep).empty?
-    spec = Gem::SourceInfoCache.search(dep, true, true).last
+    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 = [rb_bin, '-S', 'gem', 'install', spec.name, '-v', spec.version.to_s]
-    args.unshift('sudo', 'env', 'JAVA_HOME=' + ENV['JAVA_HOME']) unless windows?
-    args = args.map{|a| a.inspect}.join(' ') if windows?
-    sh *args
+    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 one to setup the necessary dependencies."
+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

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