buildr 1.2.10 → 1.3.0

data/spec/sandbox.rb

@@ -0,0 +1,116 @@
+# 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.
+
+
+# The local repository we use for testing is void of any artifacts, which will break given
+# that the code requires several artifacts. So we establish them first using the real local
+# repository and cache these across test cases.
+Buildr.application.instance_eval { @rakefile = File.expand_path('buildfile') }
+repositories.remote << 'http://repo1.maven.org/maven2'
+require 'buildr/java/groovyc'
+Java.load # Anything added to the classpath.
+artifacts(TestFramework.frameworks.map(&:dependencies).flatten).each { |a| file(a).invoke }
+
+ENV['HOME'] = File.expand_path('tmp/home')
+
+# We need to run all tests inside a _sandbox, tacking a snapshot of Buildr before the test,
+# and restoring everything to its previous state after the test. Damn state changes.
+module Sandbox
+
+  class << self
+    attr_reader :tasks, :rules
+
+    def included(spec)
+      spec.before(:each) { sandbox }
+      spec.after(:each) { reset }
+    end
+  end
+
+  @tasks = Buildr.application.tasks.collect do |original|
+    prerequisites = original.send(:prerequisites).map(&:to_s)
+    actions = original.instance_eval { @actions }.clone
+    lambda do
+      original.class.send(:define_task, original.name=>prerequisites).tap do |task|
+        task.comment = original.comment
+        actions.each { |action| task.enhance &action }
+      end
+    end
+  end
+  @rules = Buildr.application.instance_variable_get(:@rules)
+
+  def sandbox
+    # Create a temporary directory where we can create files, e.g,
+    # for projects, compilation. We need a place that does not depend
+    # on the current directory.
+    temp = File.join(File.dirname(__FILE__), '../tmp')
+    FileUtils.mkpath temp
+    Dir.chdir temp
+
+    @_sandbox = {}
+    Buildr.application = Buildr::Application.new
+    Sandbox.tasks.each { |block| block.call }
+    Buildr.application.instance_variable_set :@rules, Sandbox.rules.clone
+    Buildr.application.instance_eval { @rakefile = File.expand_path('buildfile') }
+
+    @_sandbox[:load_path] = $LOAD_PATH.clone
+    @_sandbox[:loaded_features] = $LOADED_FEATURES.clone
+    
+    # Later on we'll want to lose all the on_define created during the test.
+    @_sandbox[:on_define] = Project.class_eval { (@on_define || []).dup }
+    @_sandbox[:layout] = Layout.default.clone
+
+    # Create a local repository we can play with. However, our local repository will be void
+    # of some essential artifacts (e.g. JUnit artifacts required by build task), so we create
+    # these first (see above) and keep them across test cases.
+    @_sandbox[:artifacts] = Artifact.class_eval { @artifacts }.clone
+    Buildr.repositories.local = File.expand_path('repository')
+    ENV['HOME'] = File.expand_path('home')
+
+    @_sandbox[:env_keys] = ENV.keys
+    ['DEBUG', 'TEST', 'HTTP_PROXY', 'USER'].each { |k| ENV.delete(k) ; ENV.delete(k.downcase) }
+
+    # Remove testing local repository, and reset all repository settings.
+    Buildr.repositories.instance_eval do
+      @local = @remote = @release_to = nil
+    end
+    Buildr.options.proxy.http = nil
+
+    # Don't output crap to the console.
+    trace false
+    verbose false
+    #task('buildr:initialize').invoke
+  end
+
+  # Call this from teardown.
+  def reset
+    # Get rid of all the projects and the on_define blocks we used.
+    Project.clear
+    on_define = @_sandbox[:on_define]
+    Project.class_eval { @on_define = on_define }
+    Layout.default = @_sandbox[:layout].clone
+
+    $LOAD_PATH.replace @_sandbox[:load_path]
+    $LOADED_FEATURES.replace @_sandbox[:loaded_features]
+    FileUtils.rm_rf Dir.pwd
+
+    # Get rid of all artifacts.
+    @_sandbox[:artifacts].tap { |artifacts| Artifact.class_eval { @artifacts = artifacts } }
+
+    # Restore options.
+    Buildr.options.test = nil
+    (ENV.keys - @_sandbox[:env_keys]).each { |key| ENV.delete key }
+  end
+
+end

data/spec/scala_compilers_spec.rb

@@ -0,0 +1,239 @@
+# 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')
+
+
+describe 'scalac compiler' do
+  it 'should identify itself from source directories' do
+    write 'src/main/scala/com/example/Test.scala', 'package com.example; class Test { val i = 1 }' 
+    define('foo').compile.compiler.should eql(:scalac)
+  end
+
+  it 'should report the language as :scala' do
+    define('foo').compile.using(:scalac).language.should eql(:scala)
+  end
+
+  it 'should set the target directory to target/classes' do
+    define 'foo' do
+      lambda { compile.using(:scalac) }.should change { compile.target.to_s }.to(File.expand_path('target/classes'))
+    end
+  end
+
+  it 'should not override existing target directory' do
+    define 'foo' do
+      compile.into('classes')
+      lambda { compile.using(:scalac) }.should_not change { compile.target }
+    end
+  end
+
+  it 'should not change existing list of sources' do
+    define 'foo' do
+      compile.from('sources')
+      lambda { compile.using(:scalac) }.should_not change { compile.sources }
+    end
+  end
+
+  it 'should include as classpath dependency' do
+    write 'src/dependency/Dependency.scala', 'class Dependency {}'
+    define 'dependency', :version=>'1.0' do
+      compile.from('src/dependency').into('target/dependency')
+      package(:jar)
+    end
+    write 'src/test/DependencyTest.scala', 'class DependencyTest { var d: Dependency = _ }'
+    lambda { define('foo').compile.from('src/test').with(project('dependency')).invoke }.should run_task('foo:compile')
+    file('target/classes/DependencyTest.class').should exist
+  end
+
+  def define_test1_project
+    write 'src/main/scala/com/example/Test1.scala', 'package com.example; class Test1 { val i = 1 }'
+    define 'test1', :version=>'1.0' do
+      package(:jar)
+    end
+  end
+  
+  it 'should compile a simple .scala file into a .class file' do
+    define_test1_project
+    task('test1:compile').invoke
+    file('target/classes/com/example/Test1.class').should exist
+  end
+
+  it 'should package .class into a .jar file' do
+    define_test1_project
+    task('test1:package').invoke
+    file('target/test1-1.0.jar').should exist
+    Zip::ZipFile.open(project('test1').package(:jar).to_s) do |zip|
+      zip.file.exist?('com/example/Test1.class').should be_true
+    end
+  end
+
+end
+
+
+describe 'scalac compiler options' do
+  def compile_task
+    @compile_task ||= define('foo').compile.using(:scalac)
+  end
+
+  def scalac_args
+    compile_task.instance_eval { @compiler }.send(:scalac_args)
+  end
+
+  it 'should set warnings option to false by default' do
+    compile_task.options.warnings.should be_false
+  end
+
+  it 'should set wranings option to true when running with --verbose option' do
+    verbose true
+    compile_task.options.warnings.should be_true
+  end
+
+  it 'should use -nowarn argument when warnings is false' do
+    compile_task.using(:warnings=>false)
+    scalac_args.should include('-nowarn') 
+  end
+
+  it 'should not use -nowarn argument when warnings is true' do
+    compile_task.using(:warnings=>true)
+    scalac_args.should_not include('-nowarn') 
+  end
+
+  it 'should not use -verbose argument by default' do
+    scalac_args.should_not include('-verbose') 
+  end
+
+  it 'should use -verbose argument when running with --trace option' do
+    trace true
+    scalac_args.should include('-verbose') 
+  end
+
+  it 'should set debug option to true by default' do
+    compile_task.options.debug.should be_true
+  end
+
+  it 'should set debug option to false based on Buildr.options' do
+    Buildr.options.debug = false
+    compile_task.options.debug.should be_false
+  end
+
+  it 'should set debug option to false based on debug environment variable' do
+    ENV['debug'] = 'no'
+    compile_task.options.debug.should be_false
+  end
+
+  it 'should set debug option to false based on DEBUG environment variable' do
+    ENV['DEBUG'] = 'no'
+    compile_task.options.debug.should be_false
+  end
+
+  it 'should use -g argument when debug option is true' do
+    compile_task.using(:debug=>true)
+    scalac_args.should include('-g')
+  end
+
+  it 'should not use -g argument when debug option is false' do
+    compile_task.using(:debug=>false)
+    scalac_args.should_not include('-g')
+  end
+
+  it 'should set deprecation option to false by default' do
+    compile_task.options.deprecation.should be_false
+  end
+
+  it 'should use -deprecation argument when deprecation is true' do
+    compile_task.using(:deprecation=>true)
+    scalac_args.should include('-deprecation')
+  end
+
+  it 'should not use -deprecation argument when deprecation is false' do
+    compile_task.using(:deprecation=>false)
+    scalac_args.should_not include('-deprecation')
+  end
+
+  it 'should set optimise option to false by default' do
+    compile_task.options.optimise.should be_false
+  end
+
+  it 'should use -optimise argument when deprecation is true' do
+    compile_task.using(:optimise=>true)
+    scalac_args.should include('-optimise')
+  end
+
+  it 'should not use -optimise argument when deprecation is false' do
+    compile_task.using(:optimise=>false)
+    scalac_args.should_not include('-optimise')
+  end
+
+  it 'should not set source option by default' do
+    compile_task.options.source.should be_nil
+    scalac_args.should_not include('-source')
+  end
+
+  it 'should not set target option by default' do
+    compile_task.options.target.should be_nil
+    scalac_args.should_not include('-target')
+  end
+
+  it 'should use -source nn argument if source option set' do
+    compile_task.using(:source=>'1.5')
+    scalac_args.should include('-source', '1.5')
+  end
+
+  it 'should use -target:xxx argument if target option set' do
+    compile_task.using(:target=>'1.5')
+    scalac_args.should include('-target:jvm-1.5')
+  end
+
+  it 'should not set other option by default' do
+    compile_task.options.other.should be_nil
+  end
+
+  it 'should pass other argument if other option is string' do
+    compile_task.using(:other=>'-unchecked')
+    scalac_args.should include('-unchecked')
+  end
+
+  it 'should pass other argument if other option is array' do
+    compile_task.using(:other=>['-unchecked', '-Xprint-types'])
+    scalac_args.should include('-unchecked', '-Xprint-types')
+  end
+
+  it 'should complain about options it doesn\'t know' do
+    write 'source/Test.scala', 'class Test {}'
+    compile_task.using(:unknown=>'option')
+    lambda { compile_task.from('source').invoke }.should raise_error(ArgumentError, /no such option/i)
+  end
+
+  it 'should inherit options from parent' do
+    define 'foo' do
+      compile.using(:warnings=>true, :debug=>true, :deprecation=>true, :source=>'1.5', :target=>'1.4')
+      define 'bar' do
+        compile.using(:scalac)
+        compile.options.warnings.should be_true
+        compile.options.debug.should be_true
+        compile.options.deprecation.should be_true
+        compile.options.source.should eql('1.5')
+        compile.options.target.should eql('1.4')
+      end
+    end
+  end
+
+  after do
+    Buildr.options.debug = nil
+    ENV.delete "debug"
+    ENV.delete "DEBUG"
+  end
+end

data/spec/spec.opts

@@ -0,0 +1,6 @@
+--colour
+--format
+specdoc
+--loadby
+mtime
+--backtrace

data/spec/spec_helpers.rb

@@ -0,0 +1,283 @@
+# 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.
+
+
+# This file gets loaded twice when running 'spec spec/*' and not with pleasent results,
+# so ignore the second attempt to load it.
+unless self.class.const_defined?('SpecHelpers')
+
+  require 'rubygems'
+  $LOAD_PATH.unshift File.expand_path('../lib', File.dirname(__FILE__))
+  require 'buildr'
+
+  require File.expand_path('sandbox', File.dirname(__FILE__))
+
+  module SpecHelpers
+
+    include Checks::Matchers
+
+    module ::Kernel #:nodoc:
+      def warn(message)
+        $warning ||= []
+        $warning << message
+      end
+    end
+
+    class << Buildr.application
+      alias :deprecated_without_capture :deprecated
+      def deprecated(message)
+        verbose(true) { deprecated_without_capture message }
+      end
+    end
+
+    class WarningMatcher
+      def initialize(message)
+        @expect = message
+      end
+
+      def matches?(target)
+        $warning = []
+        target.call
+        return Regexp === @expect ? $warning.join('\n') =~ @expect : $warning.include?(@expect.to_s)
+      end
+
+      def failure_message
+        $warning ? "Expected warning #{@expect.source}, found #{$warning}" : "Expected warning #{@expect.source}, no warning issued"
+      end
+
+      def negative_failure_message
+        "Found unexpected #{$warning}"
+      end
+    end
+
+    # Tests if a warning was issued. You can use a string or regular expression.
+    #
+    # For example:
+    #   lambda { warn 'ze test' }.should warn_that(/ze test/)
+    def warn_that(message)
+      WarningMatcher.new message
+    end
+
+
+    class ::Rake::Task
+      alias :execute_without_a_record :execute
+      def execute(args)
+        $executed ||= []
+        $executed << name
+        execute_without_a_record args
+      end
+    end
+
+    class InvokeMatcher
+      def initialize(*tasks)
+        @expecting = tasks.map { |task| [task].flatten.map(&:to_s) }
+      end
+
+      def matches?(target)
+        $executed = []
+        target.call
+        return false unless all_ran?
+        return !@but_not.any_ran? if @but_not
+        return true
+      end
+
+      def failure_message
+        return @but_not.negative_failure_message if all_ran? && @but_not
+        "Expected the tasks #{expected} to run, but #{remaining} did not run, or not in the order we expected them to."
+      end
+
+      def negative_failure_message
+        if all_ran?
+          "Expected the tasks #{expected} to not run, but they all ran."
+        else
+          "Expected the tasks #{expected} to not run, and all but #{remaining} ran."
+        end 
+      end
+
+      def but_not(*tasks)
+        @but_not = InvokeMatcher.new(*tasks)
+        self
+      end
+
+    protected
+
+      def expected
+        @expecting.map { |tests| tests.join('=>') }.join(', ')
+      end
+
+      def remaining
+        @remaining.map { |tests| tests.join('=>') }.join(', ')
+      end
+
+      def all_ran?
+        @remaining ||= $executed.inject(@expecting) do |expecting, executed|
+          expecting.map { |tasks| tasks.first == executed ? tasks[1..-1] : tasks }.reject(&:empty?)
+        end
+        @remaining.empty?
+      end
+
+      def any_ran?
+        all_ran?
+        @remaining.size < @expecting.size
+      end
+
+    end
+
+    # Tests that all the tasks ran, in the order specified. Can also be used to test that some
+    # tasks and not others ran.
+    #
+    # Takes a list of arguments. Each argument can be a task name, matching only if that task ran.
+    # Each argument can be an array of task names, matching only if all these tasks ran in that order.
+    # So run_tasks('foo', 'bar') expects foo and bar to run in any order, but run_task(['foo', 'bar'])
+    # expects foo to run before bar.
+    #
+    # You can call but_not on the matchers to specify that certain tasks must not execute.
+    #
+    # For example:
+    #   # Either task
+    #   lambda { task('compile').invoke }.should run_tasks('compile', 'resources')
+    #   # In that order
+    #   lambda { task('build').invoke }.should run_tasks(['compile', 'test'])
+    #   # With exclusion
+    #   lambda { task('build').invoke }.should run_tasks('compile').but_not('install')
+    def run_tasks(*tasks)
+      InvokeMatcher.new *tasks
+    end
+
+    # Tests that a task ran. Similar to run_tasks, but accepts a single task name.
+    #
+    # For example:
+    #   lambda { task('build').invoke }.should run_task('test')
+    def run_task(task)
+      InvokeMatcher.new [task]
+    end
+
+    class UriPathMatcher
+      def initialize(re)
+        @expression = re
+      end
+
+      def matches?(uri)
+        @uri = uri
+        uri.path =~ @expression
+      end
+
+      def description
+        "URI with path matching #{@expression}"
+      end
+    end
+    
+    # Matches a parsed URI's path against the given regular expression
+    def uri(re)
+      UriPathMatcher.new(re)
+    end
+
+
+    class AbsolutePathMatcher
+      def initialize(path)
+        @expected = File.expand_path(path.to_s)
+      end
+
+      def matches?(path)
+        @provided = File.expand_path(path.to_s)
+        @provided == @expected
+      end
+
+      def failure_message
+        "Expected path #{@expected}, but found path #{@provided}"
+      end
+
+      def negative_failure_message
+        "Expected a path other than #{@expected}"
+      end
+    end
+
+    def point_to_path(path)
+      AbsolutePathMatcher.new(path)
+    end
+
+
+    def suppress_stdout
+      stdout = $stdout
+      $stdout = StringIO.new
+      begin
+        yield
+      ensure
+        $stdout = stdout
+      end
+    end
+
+    def dryrun
+      Buildr.application.options.dryrun = true
+      begin
+        suppress_stdout { yield }
+      ensure
+        Buildr.application.options.dryrun = false
+      end
+    end
+
+    # We run tests with tracing off. Then things break. And we need to figure out what went wrong.
+    # So just use trace() as you would use verbose() to find and squash the bug.
+    def trace(value = nil)
+      old_value = Buildr.application.options.trace
+      Buildr.application.options.trace = value unless value.nil?
+      if block_given?
+        begin
+          yield
+        ensure
+          Buildr.application.options.trace = old_value
+        end
+      end
+      Buildr.application.options.trace
+    end
+
+    # Change the Buildr original directory, faking invocation from a different directory.
+    def in_original_dir(dir)
+      begin
+        original_dir = Buildr.application.original_dir
+        Buildr.application.instance_eval { @original_dir = File.expand_path(dir) }
+        yield
+      ensure
+        Buildr.application.instance_eval { @original_dir = original_dir }
+      end 
+    end
+
+
+    # Buildr's define method creates a project definition but does not evaluate it
+    # (that happens once the buildfile is loaded), and we include Buildr's define in
+    # the test context so we can use it without prefixing with Buildr. This just patches
+    # define to evaluate the project definition before returning it.
+    def define(name, properties = nil, &block) #:yields:project
+      Project.define(name, properties, &block).tap { |project| project.invoke }
+    end
+
+  end
+
+
+  # Allow using matchers within the project definition.
+  class Buildr::Project
+    include ::Spec::Matchers, SpecHelpers
+  end
+
+
+  Spec::Runner.configure do |config|
+    # Make all Buildr methods accessible from test cases, and add various helper methods.
+    config.include Buildr, SpecHelpers
+
+    # Sanbdox Buildr for each test.
+    config.include Sandbox
+  end
+
+end