buildr 1.3.5-x86-mswin32

data/spec/core/build_spec.rb

@@ -0,0 +1,677 @@
+# 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 'local task', :shared=>true do
+  it "should execute task for project in current directory" do
+    define 'foobar'
+    lambda { @task.invoke }.should run_task("foobar:#{@task.name}")
+  end
+
+  it "should not execute task for projects in other directory" do
+    define 'foobar', :base_dir=>'elsewhere'
+    lambda { task('build').invoke }.should_not run_task('foobar:build')
+  end
+end
+
+
+describe 'build task' do
+  it_should_behave_like 'local task'
+  before(:each) { @task = task('build') }
+end
+
+describe 'clean task' do
+  it_should_behave_like 'local task'
+  before(:each) { @task = task('clean') }
+end
+
+describe 'package task' do
+  it_should_behave_like 'local task'
+  before(:each) { @task = task('package') }
+
+  it 'should execute build task as prerequisite' do
+    lambda { @task.invoke }.should run_task('build')
+  end
+end
+
+describe 'install task' do
+  it_should_behave_like 'local task'
+  before(:each) { @task = task('install') }
+
+  it 'should execute package task as prerequisite' do
+    lambda { @task.invoke }.should run_task('package')
+  end
+end
+
+describe 'uninstall task' do
+  it_should_behave_like 'local task'
+  before(:each) { @task = task('uninstall') }
+end
+
+describe 'upload task' do
+  it_should_behave_like 'local task'
+  before(:each) { @task = task('upload') }
+
+  it 'should execute package task as prerequisite' do
+    lambda { @task.invoke }.should run_task('package')
+  end
+end
+
+
+describe Project, '#build' do
+  it 'should return the project\'s build task' do
+    define('foo').build.should eql(task('foo:build'))
+  end
+
+  it 'should enhance the project\'s build task' do
+    task 'prereq'
+    task 'action'
+    define 'foo' do
+      build 'prereq' do
+        task('action').invoke
+      end
+    end
+    lambda { project('foo').build.invoke }.should run_tasks('prereq', 'action')
+  end
+
+  it 'should execute build task for sub-project' do
+    define 'foo' do
+      define 'bar'
+    end
+    lambda { task('foo:build').invoke }.should run_task('foo:bar:build')
+  end
+
+  it 'should not execute build task of other projects' do
+    define 'foo'
+    define 'bar'
+    lambda { task('foo:build').invoke }.should_not run_task('bar:build')
+  end
+end
+
+
+describe Project, '#clean' do
+  it 'should return the project\'s clean task' do
+    define('foo').clean.should eql(task('foo:clean'))
+  end
+
+  it 'should enhance the project\'s clean task' do
+    task 'prereq'
+    task 'action'
+    define 'foo' do
+      clean 'prereq' do
+        task('action').invoke
+      end
+    end
+    lambda { project('foo').clean.invoke }.should run_tasks('prereq', 'action')
+  end
+
+  it 'should remove target directory' do
+    define 'foo' do
+      self.layout[:target] = 'targeted'
+    end
+    mkpath 'targeted'
+    lambda { project('foo').clean.invoke }.should change { File.exist?('targeted') }.from(true).to(false)
+  end
+
+  it 'should remove reports directory' do
+    define 'foo' do
+      self.layout[:reports] = 'reported'
+    end
+    mkpath 'reported'
+    lambda { project('foo').clean.invoke }.should change { File.exist?('reported') }.from(true).to(false)
+  end
+
+  it 'should execute clean task for sub-project' do
+    define 'foo' do
+      define 'bar'
+    end
+    lambda { task('foo:clean').invoke }.should run_task('foo:bar:clean')
+  end
+
+  it 'should not execute clean task of other projects' do
+    define 'foo'
+    define 'bar'
+    lambda { task('foo:clean').invoke }.should_not run_task('bar:clean')
+  end
+end
+
+
+describe Project, '#target' do
+  before :each do
+    @project = define('foo', :layout=>Layout.new)
+  end
+
+  it 'should default to target' do
+    @project.target.should eql('target')
+  end
+
+  it 'should set layout :target' do
+    @project.target = 'bar'
+    @project.layout.expand(:target).should point_to_path('bar')
+  end
+
+  it 'should come from layout :target' do
+    @project.layout[:target] = 'baz'
+    @project.target.should eql('baz')
+  end
+  
+  it 'should be removed in version 1.5 since it was deprecated in version 1.3' do
+    Buildr::VERSION.should < '1.5'
+  end
+end
+
+
+describe Project, '#reports' do
+  before :each do
+    @project = define('foo', :layout=>Layout.new)
+  end
+
+  it 'should default to reports' do
+    @project.reports.should eql('reports')
+  end
+
+  it 'should set layout :reports' do
+    @project.reports = 'bar'
+    @project.layout.expand(:reports).should point_to_path('bar')
+  end
+
+  it 'should come from layout :reports' do
+    @project.layout[:reports] = 'baz'
+    @project.reports.should eql('baz')
+  end
+  
+  it 'should be removed in version 1.5 since it was deprecated in version 1.3' do
+    Buildr::VERSION.should < '1.5'
+  end
+end
+
+
+describe Git do
+  describe '#uncommitted_files' do
+    it 'should return an empty array on a clean repository' do
+      Git.should_receive(:`).with('git status').and_return <<-EOF
+# On branch master
+nothing to commit (working directory clean)
+      EOF
+      Git.uncommitted_files.should be_empty
+    end
+
+    it 'should reject a dirty repository, Git 1.4.2 or former' do
+      Git.should_receive(:`).with('git status').and_return <<-EOF
+# On branch master
+#
+# Changed but not updated:
+#   (use "git add <file>..." to update what will be committed)
+#   (use "git checkout -- <file>..." to discard changes in working directory)
+#
+#       modified:   lib/buildr.rb
+#       modified:   spec/buildr_spec.rb
+# 
+# Untracked files:
+#   (use "git add <file>..." to include in what will be committed)
+#
+#       error.log
+      EOF
+      Git.uncommitted_files.should include('lib/buildr.rb', 'error.log')
+    end
+
+    it 'should reject a dirty repository, Git 1.4.3 or higher' do
+      Git.should_receive(:`).with('git status').and_return <<-EOF
+# On branch master 
+# Changed but not updated:
+#   (use "git add <file>..." to update what will be committed)
+#
+#\tmodified:   lib/buildr.rb
+#\tmodified:   spec/buildr_spec.rb
+#
+# Untracked files:
+#   (use "git add <file>..." to include in what will be committed)
+#
+#\terror.log
+no changes added to commit (use "git add" and/or "git commit -a")
+      EOF
+      Git.uncommitted_files.should include('lib/buildr.rb', 'error.log')
+    end
+  end
+
+  describe '#remote' do
+    it 'should return the name of the corresponding remote' do
+      Git.should_receive(:git).with('config', '--get', 'branch.master.remote').and_return "origin\n"
+      Git.should_receive(:git).with('remote').and_return "upstream\norigin\n"
+      Git.send(:remote, 'master').should == 'origin'
+    end
+
+    it 'should return nil if no remote for the given branch' do
+      Git.should_receive(:git).with('config', '--get', 'branch.master.remote').and_return "\n"
+      Git.should_not_receive(:git).with('remote')
+      Git.send(:remote, 'master').should be_nil
+    end
+  end
+
+  describe '#current_branch' do
+    it 'should return the current branch' do
+      Git.should_receive(:git).with('branch').and_return("  master\n* a-clever-idea\n  ze-great-idea")
+      Git.send(:current_branch).should == 'a-clever-idea'
+    end
+  end
+
+end # of Git
+
+
+describe Svn do
+  describe '#tag' do
+    it 'should remove any existing tag with the same name' do
+      Svn.stub!(:repo_url).and_return('http://my.repo.org/foo/trunk')
+      Svn.stub!(:copy)
+      Svn.should_receive(:remove).with('http://my.repo.org/foo/tags/1.0.0', 'Removing old copy')
+
+      Svn.tag '1.0.0'
+    end
+
+    it 'should do an svn copy with the release version' do
+      Svn.stub!(:repo_url).and_return('http://my.repo.org/foo/trunk')
+      Svn.stub!(:remove)
+      Svn.should_receive(:copy).with(Dir.pwd, 'http://my.repo.org/foo/tags/1.0.0', 'Release 1.0.0')
+
+      Svn.tag '1.0.0'
+    end
+  end
+
+  # Reference: http://svnbook.red-bean.com/en/1.4/svn.reposadmin.planning.html#svn.reposadmin.projects.chooselayout
+  describe '#tag_url' do
+    it 'should accept to tag foo/trunk' do
+      Svn.tag_url('http://my.repo.org/foo/trunk', '1.0.0').should == 'http://my.repo.org/foo/tags/1.0.0'
+    end
+
+    it 'should accept to tag foo/branches/1.0' do
+      Svn.tag_url('http://my.repo.org/foo/branches/1.0', '1.0.1').should == 'http://my.repo.org/foo/tags/1.0.1'
+    end
+
+    it 'should accept to tag trunk/foo' do
+      Svn.tag_url('http://my.repo.org/trunk/foo', '1.0.0').should == 'http://my.repo.org/tags/foo/1.0.0'
+    end
+
+    it 'should accept to tag branches/foo/1.0' do
+      Svn.tag_url('http://my.repo.org/branches/foo/1.0', '1.0.0').should == 'http://my.repo.org/tags/foo/1.0.0'
+    end
+
+    describe '#repo_url' do
+      it 'should extract the SVN URL from svn info' do
+        Svn.should_receive(:svn).and_return <<-XML
+<?xml version="1.0"?>
+<info>
+<entry
+   kind="dir"
+   path="."
+   revision="724987">
+<url>http://my.repo.org/foo/trunk</url>
+<repository>
+<root>http://my.repo.org</root>
+<uuid>13f79535-47bb-0310-9956-ffa450edef68</uuid>
+</repository>
+<wc-info>
+<schedule>normal</schedule>
+<depth>infinity</depth>
+</wc-info>
+<commit
+   revision="724955">
+<author>boisvert</author>
+<date>2008-12-10T01:53:51.240936Z</date>
+</commit>
+</entry>
+</info>
+        XML
+        Svn.repo_url.should == 'http://my.repo.org/foo/trunk'
+      end
+    end
+
+  end
+
+end # of Buildr::Svn
+
+
+describe Release do
+  describe 'find' do
+    it 'should return GitRelease if project uses Git' do
+      write '.git/config'
+      Release.find.should be_instance_of(GitRelease)
+    end
+
+    it 'should return SvnRelease if project uses SVN' do
+      write '.svn/xml'
+      Release.find.should be_instance_of(SvnRelease)
+    end
+
+    it 'should return nil if no known release process' do
+      Dir.chdir(Dir.tmpdir) do
+        Release.find.should be_nil
+      end
+    end
+
+    after :each do
+      Release.instance_exec { @release = nil }
+    end
+  end
+end
+
+
+describe 'a release process', :shared=>true do
+
+  describe '#make' do
+    before do
+      write 'buildfile', "VERSION_NUMBER = '1.0.0-SNAPSHOT'"
+      # Prevent a real call to a spawned buildr process.
+      @release.stub!(:buildr)
+      @release.stub!(:check)
+      @release.should_receive(:ruby).with('-S', 'buildr', "_#{Buildr::VERSION}_", '--buildfile', File.expand_path('buildfile.next'),
+                                          '--environment', 'development', 'clean', 'upload', 'DEBUG=no')
+    end
+    
+    it 'should tag a release with the release version' do
+      @release.stub!(:update_version_to_next)
+      @release.should_receive(:tag_release).with('1.0.0')
+      @release.make
+    end
+
+    it 'should not alter the buildfile before tagging' do
+      @release.stub!(:update_version_to_next)
+      @release.should_receive(:tag_release).with('1.0.0')
+      @release.make
+      file('buildfile').should contain('VERSION_NUMBER = "1.0.0"')
+    end
+
+    it 'should update the buildfile with the next version number' do
+      @release.stub!(:tag_release)
+      @release.make
+      file('buildfile').should contain('VERSION_NUMBER = "1.0.1-SNAPSHOT"')
+    end
+
+    it 'should keep leading zeros in the next version number' do
+      write 'buildfile', "VERSION_NUMBER = '1.0.001-SNAPSHOT'"
+      @release.stub!(:tag_release)
+      @release.make
+      file('buildfile').should contain('VERSION_NUMBER = "1.0.002-SNAPSHOT"')
+    end
+
+    it 'should commit the updated buildfile' do
+      @release.stub!(:tag_release)
+      @release.make
+      file('buildfile').should contain('VERSION_NUMBER = "1.0.1-SNAPSHOT"')
+    end    
+  end
+
+  describe '#resolve_tag' do
+    before do
+      @release.stub!(:extract_version).and_return('1.0.0')
+    end
+
+    it 'should return tag specified by tag_name' do
+      @release.tag_name  = 'first'
+      @release.send(:resolve_tag).should == 'first'
+    end
+    
+    it 'should use tag returned by tag_name if tag_name is a proc' do
+      @release.tag_name  = lambda { |version| "buildr-#{version}" }
+      @release.send(:resolve_tag).should == 'buildr-1.0.0'
+    end
+    after { @release.tag_name = nil }
+  end
+
+  describe '#tag_release' do
+    it 'should inform the user' do
+      @release.stub!(:extract_version).and_return('1.0.0')
+      lambda { @release.tag_release('1.0.0') }.should show_info('Tagging release 1.0.0')
+    end
+  end
+
+  describe '#extract_version' do
+    it 'should extract VERSION_NUMBER with single quotes' do
+      write 'buildfile', "VERSION_NUMBER = '1.0.0-SNAPSHOT'"
+      @release.extract_version.should == '1.0.0-SNAPSHOT'
+    end
+
+    it 'should extract VERSION_NUMBER with double quotes' do
+      write 'buildfile', %{VERSION_NUMBER = "1.0.1-SNAPSHOT"}
+      @release.extract_version.should == '1.0.1-SNAPSHOT'
+    end
+
+    it 'should extract VERSION_NUMBER without any spaces' do
+      write 'buildfile', "VERSION_NUMBER='1.0.2-SNAPSHOT'"
+      @release.extract_version.should == '1.0.2-SNAPSHOT'
+    end
+
+    it 'should extract THIS_VERSION as an alternative to VERSION_NUMBER' do
+      write 'buildfile', "THIS_VERSION = '1.0.3-SNAPSHOT'"
+      @release.extract_version.should == '1.0.3-SNAPSHOT'
+    end
+
+    it 'should complain if no current version number' do
+      write 'buildfile', 'define foo'
+      lambda { @release.extract_version }.should raise_error('Looking for THIS_VERSION = "..." in your Buildfile, none found')
+    end
+  end
+
+  describe '#with_release_candidate_version' do
+    before do
+      Buildr.application.stub!(:buildfile).and_return(file('buildfile'))
+      write 'buildfile', "THIS_VERSION = '1.1.0-SNAPSHOT'"
+    end
+
+    it 'should yield the name of the release candidate buildfile' do
+      @release.send :with_release_candidate_version do |new_filename|
+        File.read(new_filename).should == %{THIS_VERSION = "1.1.0"}
+      end
+    end
+
+    it 'should yield a name different from the original buildfile' do
+      @release.send :with_release_candidate_version do |new_filename|
+        new_filename.should_not point_to_path('buildfile')
+      end
+    end
+  end
+
+  describe '#update_version_to_next' do
+    before do
+      write 'buildfile', 'THIS_VERSION = "1.0.0"'
+    end
+
+    it 'should update the buildfile with a new version number' do
+      @release.send :update_version_to_next
+      file('buildfile').should contain('THIS_VERSION = "1.0.1-SNAPSHOT"')
+    end
+
+    it 'should commit the new buildfile on the trunk' do
+      @release.should_receive(:message).and_return('Changed version number to 1.0.1-SNAPSHOT')
+      @release.update_version_to_next
+    end
+
+    it 'should use the commit message specified by commit_message' do
+      @release.commit_message  = 'Here is my custom message'
+      @release.should_receive(:message).and_return('Here is my custom message')
+      @release.update_version_to_next
+    end
+    
+    it 'should use the commit message returned by commit_message if commit_message is a proc' do
+      @release.commit_message  = lambda { |new_version| 
+        new_version.should == '1.0.1-SNAPSHOT'
+        "increment version number to #{new_version}"
+      }
+      @release.should_receive(:message).and_return('increment version number to 1.0.1-SNAPSHOT')
+      @release.update_version_to_next
+    end
+
+    it 'should inform the user of the new version' do
+      lambda { @release.update_version_to_next }.should show_info('Current version is now 1.0.1-SNAPSHOT')
+    end
+  end
+
+end
+
+
+describe GitRelease do
+  it_should_behave_like 'a release process'
+
+  before do
+    @release = GitRelease.new
+    Git.stub!(:git)
+    Git.stub!(:current_branch).and_return('master')
+  end
+
+  describe '#applies_to?' do
+    it 'should reject a non-git repo' do
+      Dir.chdir(Dir.tmpdir) do
+        GitRelease.applies_to?.should be_false
+      end
+    end
+
+    it 'should accept a git repo' do
+      FileUtils.mkdir '.git'
+      FileUtils.touch File.join('.git', 'config')
+      GitRelease.applies_to?.should be_true 
+    end
+  end
+
+  describe '#release_check' do
+    before do
+      @release = GitRelease.new
+    end
+
+    it 'should accept a clean repository' do
+      Git.should_receive(:`).with('git status').and_return <<-EOF
+# On branch master
+nothing to commit (working directory clean)
+      EOF
+      Git.should_receive(:remote).and_return('master')
+      lambda { @release.check }.should_not raise_error
+    end
+
+    it 'should reject a dirty repository' do
+      Git.should_receive(:`).with('git status').and_return <<-EOF
+# On branch master
+# Untracked files:
+#   (use "git add <file>..." to include in what will be committed)
+#
+#       foo.temp
+EOF
+      lambda { @release.check }.should raise_error(RuntimeError, /uncommitted files/i)
+    end
+
+    it 'should reject a repository not tracking remote branch' do
+      Git.should_receive(:uncommitted_files).and_return([])
+      Git.should_receive(:remote).and_return(nil)
+      lambda{ @release.check }.should raise_error(RuntimeError,
+        "You are releasing from a local branch that does not track a remote!")
+    end
+  end
+
+  describe '#tag_release' do
+    before do
+      @release = GitRelease.new
+      @release.stub!(:extract_version).and_return('1.0.1')
+      @release.stub!(:resolve_tag).and_return('TEST_TAG')
+      Git.stub!(:git).with('tag', '-a', 'TEST_TAG', '-m', '[buildr] Cutting release TEST_TAG')
+      Git.stub!(:git).with('push', 'origin', 'tag', 'TEST_TAG')
+      Git.stub!(:commit)
+      Git.stub!(:push)
+      Git.stub!(:remote).and_return('origin')
+    end
+
+    it 'should delete any existing tag with the same name' do
+      Git.should_receive(:git).with('tag', '-d', 'TEST_TAG')
+      Git.should_receive(:git).with('push', 'origin', ':refs/tags/TEST_TAG')
+      @release.tag_release 'TEST_TAG'
+    end
+
+    it 'should commit the buildfile before tagging' do
+      Git.should_receive(:commit).with(File.basename(Buildr.application.buildfile.to_s), "Changed version number to 1.0.1")
+      @release.tag_release 'TEST_TAG'
+    end
+
+    it 'should push the tag if a remote is tracked' do
+      Git.should_receive(:git).with('tag', '-d', 'TEST_TAG')
+      Git.should_receive(:git).with('push', 'origin', ':refs/tags/TEST_TAG')
+      Git.should_receive(:git).with('tag', '-a', 'TEST_TAG', '-m', '[buildr] Cutting release TEST_TAG')
+      Git.should_receive(:git).with('push', 'origin', 'tag',  'TEST_TAG')
+      @release.tag_release 'TEST_TAG'
+    end
+
+    it 'should NOT push the tag if no remote is tracked' do
+      Git.stub!(:remote).and_return(nil)
+      Git.should_not_receive(:git).with('push', 'origin', 'tag',  'TEST_TAG')
+      @release.tag_release 'TEST_TAG'
+    end
+  end
+end
+
+
+describe SvnRelease do
+  it_should_behave_like 'a release process'
+
+  before do
+    @release = SvnRelease.new
+    Svn.stub!(:svn)
+    Svn.stub!(:repo_url).and_return('http://my.repo.org/foo/trunk')
+    Svn.stub!(:tag)
+  end
+
+  describe '#applies_to?' do
+    it 'should reject a non-git repo' do
+      SvnRelease.applies_to?.should be_false
+    end
+
+    it 'should accept a git repo' do
+      FileUtils.touch '.svn'
+      SvnRelease.applies_to?.should be_true 
+    end
+  end
+
+  describe '#check' do
+    before do
+      Svn.stub!(:uncommitted_files).and_return([])
+      @release = SvnRelease.new
+    end
+
+    it 'should accept to release from the trunk' do
+      Svn.stub!(:repo_url).and_return('http://my.repo.org/foo/trunk')
+      lambda { @release.check }.should_not raise_error
+    end
+
+    it 'should accept to release from a branch' do
+      Svn.stub!(:repo_url).and_return('http://my.repo.org/foo/branches/1.0')
+      lambda { @release.check }.should_not raise_error
+    end
+
+    it 'should reject releasing from a tag' do
+      Svn.stub!(:repo_url).and_return('http://my.repo.org/foo/tags/1.0.0')
+      lambda { @release.check }.should raise_error(RuntimeError, "SVN URL must contain 'trunk' or 'branches/...'")
+    end
+
+    it 'should reject a non standard repository layout' do
+      Svn.stub!(:repo_url).and_return('http://my.repo.org/foo/bar')
+      lambda { @release.check }.should raise_error(RuntimeError, "SVN URL must contain 'trunk' or 'branches/...'")
+    end
+
+    it 'should reject an uncommitted file' do
+      Svn.stub!(:repo_url).and_return('http://my.repo.org/foo/trunk')
+      Svn.stub!(:uncommitted_files).and_return(['foo.rb'])
+      lambda { @release.check }.should raise_error(RuntimeError,
+        "Uncommitted files violate the First Principle Of Release!\n" +
+        "foo.rb")
+    end
+  end
+end