autobuild 1.2.15 → 1.3.0

data/Changes.txt

@@ -1,3 +1,17 @@
+== Version 1.3.0
+* major update of the user interaction. Autobuild is now much less verbose, and
+  (hopefully) displays more useful error messages in most cases.
+* make the library easier to use to build other tools (i.e. not so much
+  autobuild-centered anymore)
+* add the :branch and :tag targets to the git importer. The git importer should
+  now be used as:
+    Autobuild.git(URL, :branch => branch_name)
+  OR
+    Autobuild.git(URL, :tag => tag_name_or_commit_id)
+  
+  This puts it in line with the other importers which have a
+  Autobuild.importer_type(URL, option_hash) form.
+
 == Version 1.2.15
 * fix branch switching in the git importer: the build will not fail anymore if
   autobuild has to switch to an already existing branch

data/Rakefile

@@ -1,17 +1,17 @@
 require 'hoe'
 require 'lib/autobuild'
 
-Hoe.new('autobuild', Autobuild::VERSION) do |p|
-    p.author = "Sylvain Joyeux"
-    p.email = "sylvain.joyeux@m4x.org"
+Hoe.spec 'autobuild' do
+    developer "Sylvain Joyeux", "sylvain.joyeux@m4x.org"
 
-    p.summary = 'Rake-based utility to build and install multiple packages with dependencies'
-    p.description = p.paragraphs_of('README.txt', 2..5).join("\n\n")
-    p.url         = p.paragraphs_of('README.txt', 1).first.split(/\n/)[1..-1].map { |s| s.gsub('* ', '') }
-    p.changes     = p.paragraphs_of('Changes.txt', 0).join("\n\n")
+    self.summary = 'Rake-based utility to build and install multiple packages with dependencies'
+    self.description = self.paragraphs_of('README.txt', 2..5).join("\n\n")
+    self.url         = self.paragraphs_of('README.txt', 1).first.split(/\n/)[1..-1].map { |s| s.gsub('* ', '') }
+    self.changes     = self.paragraphs_of('Changes.txt', 0).join("\n\n")
 
-    p.extra_deps << ['rake', '>= 0.7.0']
-    p.extra_deps << 'rmail'
-    p.extra_deps << 'daemons'
+    self.extra_deps <<
+        ['rake', '>= 0.7.0'] <<
+        ['rmail', '>= 1.0'] <<
+        ['daemons', '>= 0.0']
 end
 

data/bin/autobuild

@@ -15,6 +15,10 @@ DEFAULT_HTTP_PORT = 2000
 conffile, *packages = Autobuild.commandline(ARGV)
 Autobuild.packages = packages
 
+Autobuild.env_set 'PATH', *(ENV['PATH'].split(":"))
+Autobuild.env_set 'RUBYLIB', *(ENV['PATH'].split(":"))
+Autobuild.env_set 'PKG_CONFIG_PATH', *(ENV['PATH'].split(":"))
+
 # make conffile an absolute path since daemonize mode makes
 # / the current directory
 conffile = File.expand_path(conffile, Dir.pwd)
@@ -28,34 +32,10 @@ begin
     Reporting.report do
         load conffile
 
-	if Autobuild.mail[:to]
-            if !Autobuild::HAS_RMAIL
-                STDERR.puts "RMail is not available. Mail notification is disabled"
-            else
-                Reporting << MailReporter.new(Autobuild.mail)
-            end
-	end
-
-        if Autobuild.only_doc
-            targets  = ['doc']
-        else
-            targets  = ['import']
-            targets += ['prepare', 'build'] if Autobuild.do_build
-            targets << 'doc' if Autobuild.do_doc
-        end
-        targets.each do |phase|
-	    packages = Autobuild.packages
-	    packages = Autobuild.default_packages if packages.empty?
-
-            if packages.empty?
-                Rake::Task[phase].invoke
-            else
-                packages.each do |pkg|
-                    Rake::Task["#{pkg}-#{phase}"].invoke
-                end
-            end
-        end
+        packages = Autobuild.packages
+        packages = Autobuild.default_packages if packages.empty?
 
+        Autobuild.apply(packages)
         Reporting.success
     end
 rescue ThreadError

data/lib/autobuild.rb

@@ -1,8 +1,25 @@
-require 'autobuild/config'
-require 'autobuild/reporting'
-require 'autobuild/package'
-
 module Autobuild
-    VERSION = "1.2.15" unless defined? Autobuild::VERSION
+    VERSION = "1.3.0" unless defined? Autobuild::VERSION
 end
 
+require 'autobuild/config'
+require 'autobuild/configurable'
+require 'autobuild/environment'
+require 'autobuild/exceptions'
+require 'autobuild/import/cvs'
+require 'autobuild/import/darcs'
+require 'autobuild/importer'
+require 'autobuild/import/git'
+require 'autobuild/import/svn'
+require 'autobuild/import/tar'
+require 'autobuild/packages/autotools'
+require 'autobuild/packages/cmake'
+require 'autobuild/packages/genom'
+require 'autobuild/packages/import'
+require 'autobuild/packages/orogen'
+require 'autobuild/packages/pkgconfig'
+require 'autobuild/pkgconfig'
+require 'autobuild/reporting'
+require 'autobuild/subcommand'
+require 'autobuild/timestamps'
+

data/lib/autobuild/config.rb

@@ -201,5 +201,37 @@ module Autobuild
             args[0..-1]
         end
     end
+
+    def self.apply(packages, buildname = "autobuild")
+        if Autobuild.mail[:to]
+            if !Autobuild::HAS_RMAIL
+                STDERR.puts "RMail is not available. Mail notification is disabled"
+            else
+                Reporting << MailReporter.new(Autobuild.mail)
+            end
+        end
+
+        if Autobuild.only_doc
+            phases  = ['doc']
+        else
+            phases  = ['import']
+            phases += ['prepare', 'build'] if Autobuild.do_build
+            phases << 'doc' if Autobuild.do_doc
+        end
+        phases.each do |phase|
+            # We create a dummy task listing what needs to be done, and then we
+            # call it
+            targets = if packages.empty?
+                          phase
+                      else
+                          packages.map { |pkg| "#{pkg}-#{phase}" }
+                      end
+
+            task "#{buildname}-#{phase}" => targets
+        end
+        phases.each do |phase|
+            Rake::Task["#{buildname}-#{phase}"].invoke
+        end
+    end
 end
 

data/lib/autobuild/configurable.rb

@@ -63,13 +63,15 @@ module Autobuild
         end
 
         def prepare
+            super
+
             file configurestamp do
                 ensure_dependencies_installed
                 configure
             end
             task "#{name}-prepare" => configurestamp
 
-            source_tree srcdir do |pkg|
+            Autobuild.source_tree srcdir do |pkg|
 		pkg.exclude << Regexp.new("^#{Regexp.quote(builddir)}")
 	    end
 
@@ -87,7 +89,7 @@ module Autobuild
 
         # Configure the builddir directory before starting make
         def configure
-            touch_stamp(configurestamp)
+            Autobuild.touch_stamp(configurestamp)
         end
 
         # Do the build in builddir
@@ -96,7 +98,7 @@ module Autobuild
 
         # Install the result in prefix
         def install
-            touch_stamp(installstamp)
+            Autobuild.touch_stamp(installstamp)
         end
     end
 end

data/lib/autobuild/environment.rb

@@ -1,37 +1,68 @@
 module Autobuild
-    ## Adds an element to a path-like variable
+    @environment = Hash.new
+    class << self
+        attr_reader :environment
+    end
+
+    # Set a new environment variable
+    def self.env_set(name, *values)
+        environment.delete(name)
+        env_add(name, *values)
+    end
+    # Adds a new value to an environment variable
+    def self.env_add(name, *values)
+        set = environment[name]
+        if !set
+            set = Array.new
+        elsif !set.respond_to?(:to_ary)
+            set = [set]
+        end
+
+        values.concat(set)
+        @environment[name] = values
+        ENV[name] = values.join(":")
+    end
+
+    def self.env_add_path(name, path, *paths)
+        if File.directory?(path)
+            oldpath = environment[name]
+            if !oldpath || !oldpath.include?(path)
+                env_add(name, path)
+                if name == 'RUBYLIB'
+                    $LOAD_PATH.unshift path
+                end
+            end
+        end
+        if !paths.empty?
+            env_add_path(name, *paths)
+        end
+    end
+
+    # DEPRECATED: use env_add_path instead
     def self.pathvar(path, varname)
         if File.directory?(path)
             if block_given?
                 return unless yield(path)
             end
-
-            oldpath = ENV[varname]
-            if oldpath.nil? || oldpath.empty?
-                ENV[varname] = path
-            elsif ENV[varname] !~ /(^|:)#{Regexp.quote(path)}($|:)/
-                ENV[varname] = "#{path}:#{oldpath}"
-            end
+            env_add_path(varname, path)
         end
     end
 
-    ## Updates the environment when a new prefix has been added
-    # TODO: modularize that
+    # Updates the environment when a new prefix has been added
     def self.update_environment(newprefix)
-        pathvar("#{newprefix}/bin", 'PATH')
-        pathvar("#{newprefix}/lib/pkgconfig", 'PKG_CONFIG_PATH')
-        pathvar("#{newprefix}/lib/ruby/1.8", 'RUBYLIB')
-        pathvar("#{newprefix}/lib", 'RUBYLIB') do |path|
-            if File.directory?("#{path}/ruby")
-                false
-            else
-                !Dir["#{path}/**/*.rb"].empty?
-            end
+        env_add_path('PATH', "#{newprefix}/bin")
+        env_add_path('PKG_CONFIG_PATH', "#{newprefix}/lib/pkgconfig")
+
+        # Validate the new rubylib path
+        new_rubylib = "#{newprefix}/lib"
+        if !File.directory?(File.join(new_rubylib, "ruby")) && !Dir["#{new_rubylib}/**/*.rb"].empty?
+            env_add_path('RUBYLIB', new_rubylib)
         end
 
         require 'rbconfig'
         ruby_arch = File.basename(Config::CONFIG['archdir'])
-        pathvar("#{newprefix}/lib/ruby/1.8/#{ruby_arch}", 'RUBYLIB')
+        env_add_path("RUBYLIB", "#{newprefix}/lib/ruby/1.8")
+        env_add_path("RUBYLIB", "#{newprefix}/lib/ruby/1.8/#{ruby_arch}")
     end
 end
 

data/lib/autobuild/exceptions.rb

@@ -16,7 +16,7 @@ module Autobuild
         alias :exception_message :to_s 
         def to_s
             if target && phase
-                "#{target}: failed in #{phase} phase\n   #{super}"
+                "#{target}: failed in #{phase} phase\n    #{super}"
             elsif target
                 "#{target}: #{super}"
             else
@@ -56,10 +56,29 @@ module Autobuild
             @status  = status
         end
 
+        ERROR_LINES = 10
+
         def to_s
-            prefix = "#{super}\n    command '#{command}' failed"
-            prefix << ": " + @orig_message if @orig_message
-            prefix << "\n    see #{File.basename(logfile)} for details\n"
+            prefix = super
+            if @orig_message
+                prefix << "\n     #{@orig_message}"
+            end
+            prefix << "\n    see #{logfile} for details"
+
+            # If we do not have a status, it means an error occured in the
+            # launching process. More importantly, it means we already have a
+            # proper explanation for it. Don't display the logfile at all.
+            if status
+                lines = File.readlines(logfile)
+                if lines.size > ERROR_LINES
+                    lines = lines[-ERROR_LINES, ERROR_LINES]
+                end
+                prefix << "\n    last #{lines.size} lines are:\n\n"
+                lines.each do |l|
+                    prefix << "    #{l}"
+                end
+            end
+            prefix
         end
     end
 end

data/lib/autobuild/import/cvs.rb

@@ -62,10 +62,10 @@ module Autobuild
             cvsroot = @root
                
             FileUtils.mkdir_p(head) if !File.directory?(head)
-            Dir.chdir(head) {
+            Dir.chdir(head) do
                 options = [ @program, '-d', cvsroot, 'co', '-d', tail ] + @options_co + [ modulename ]
                 Subprocess.run(package.name, :import, *options)
-            }
+	    end
         end
     end
 

data/lib/autobuild/import/git.rb

@@ -1,6 +1,7 @@
 require 'fileutils'
 require 'autobuild/subcommand'
 require 'autobuild/importer'
+require 'utilrb/kernel/options'
 
 module Autobuild
     class Git < Importer
@@ -13,12 +14,47 @@ module Autobuild
 	#   Autobuild.programs['git'] = 'my_git_tool'
         def initialize(repository, branch = nil, options = {})
             @repository = repository.to_str
-            @branch     = branch || 'master'
-            super(options)
+
+            if branch.respond_to?(:to_hash)
+                options = branch.to_hash
+                branch = nil
+            end
+
+            if branch
+                STDERR.puts "WARN: the git importer now expects you to provide the branch as a named option"
+                STDERR.puts "WARN: this form is deprecated:"
+                STDERR.puts "WARN:    Autobuild.git 'git://github.com/doudou/autobuild.git', 'master'"
+                STDERR.puts "WARN: and should be replaced by"
+                STDERR.puts "WARN:    Autobuild.git 'git://github.com/doudou/autobuild.git', :branch => 'master'"
+            end
+
+            gitopts, common = Kernel.filter_options options, :branch => nil, :tag => nil, :commit => nil
+            if gitopts[:branch] && branch
+                raise ConfigException, "git branch specified with both the option hash and the explicit parameter"
+            end
+            branch = gitopts[:branch] || branch || 'master'
+            tag    = gitopts[:tag]
+            commit = gitopts[:commit]
+
+            if (branch && commit) || (branch && commit) || (tag && commit)
+                raise ConfigException, "you can specify only a branch, tag or commit but not two or three at the same time"
+            end
+            @branch = branch
+            @commit = tag || commit
+            super(common)
         end
 
         attr_accessor :repository
+
+        # The branch this importer is tracking
+        #
+        # If set, tag has to be nil.
         attr_accessor :branch
+        # The commit we are pointing to. It can be either a commit ID or a tag
+        # name. 
+        #
+        # If set, branch has to be nil.
+        attr_reader :commit
 
         # True if it is allowed to merge remote updates automatically. If false
         # (the default), the import will fail if the updates do not resolve as
@@ -28,22 +64,122 @@ module Autobuild
         # Set the merge flag. See #merge?
         def merge=(flag); @merge = flag end
 
+        # Raises ConfigException if the current directory is not a git
+        # repository
+        def validates_git_repository
+            if !File.directory?('.git')
+                raise ConfigException, "#{package.srcdir} is not a git repository"
+            end
+        end
+
+        # Fetches updates from the remote repository. Returns the remote commit
+        # ID on success, nil on failure. Expects the current directory to be the
+        # package's source directory.
+        def fetch_remote(package)
+            Dir.chdir(package.srcdir) do
+                validates_git_repository
+
+                Subprocess.run(package.name, :import, Autobuild.tool('git'), 'fetch', repository, branch)
+                if File.readable?( File.join('.git', 'FETCH_HEAD') )
+                    fetch_commit = File.readlines( File.join('.git', 'FETCH_HEAD') ).
+                        delete_if { |l| l =~ /not-for-merge/ }
+                    if !fetch_commit.empty?
+                        fetch_commit.first.split(/\s+/).first
+                    end
+                end
+            end
+        end
+
+        # Returns a Importer::Status object that represents the status of this
+        # package w.r.t. the root repository
+        def status(package)
+            Dir.chdir(package.srcdir) do
+                remote_commit = fetch_remote(package)
+                if !remote_commit
+                    return
+                end
+
+                status = merge_status(remote_commit)
+                `git diff --quiet`
+                if $?.exitstatus != 0
+                    status.uncommitted_code = true
+                end
+                status
+            end
+        end
+
+        # Checks if the current branch is the target branch. Expects that the
+        # current directory is the package's directory
+        def on_target_branch?
+            current_branch = `git symbolic-ref HEAD`.chomp
+            current_branch == "refs/heads/#{branch}"
+        end
+
+        class Status < Importer::Status
+            attr_reader :fetch_commit
+            attr_reader :head_commit
+            attr_reader :common_commit
+
+            def initialize(status, remote_commit, local_commit, common_commit)
+                super()
+                @status        = status
+                @fetch_commit  = fetch_commit
+                @head_commit   = head_commit
+                @common_commit = common_commit
+
+                if remote_commit != common_commit
+                    @remote_commits = log(common_commit, remote_commit)
+                end
+                if local_commit != common_commit
+                    @local_commits = log(common_commit, local_commit)
+                end
+            end
+
+            def needs_update?
+                status == Status::NEEDS_MERGE || status == Status::SIMPLE_UPDATE
+            end
+
+            def log(from, to)
+                `git log --pretty=format:"%h %cr %cn %s" #{from}..#{to}`.chomp.split("\n")
+            end
+        end
+
+        def merge_status(fetch_commit)
+            common_commit = `git merge-base HEAD #{fetch_commit}`.chomp
+            head_commit   = `git rev-parse #{branch}`.chomp
+
+            status = if common_commit != fetch_commit
+                         if common_commit == head_commit
+                             Status::SIMPLE_UPDATE
+                         else
+                             Status::NEEDS_MERGE
+                         end
+                     else
+                         if common_commit == head_commit
+                             Status::UP_TO_DATE
+                         else
+                             Status::ADVANCED
+                         end
+                     end
+
+            Status.new(status, fetch_commit, head_commit, common_commit)
+        end
+
         def update(package)
             Dir.chdir(package.srcdir) do
-                if !File.directory?('.git')
-                    raise ConfigException, "#{package.srcdir} is not a git repository"
+                validates_git_repository
+                fetch_commit = fetch_remote(package)
+                if !fetch_commit
+                    return
                 end
 
-                # Fetch the remote reference
-                Subprocess.run(package.name, :import, Autobuild.tool('git'), 'fetch', repository, branch)
-                if !File.readable?( File.join('.git', 'FETCH_HEAD') )
+                # If we are tracking a commit/tag, just check it out and return
+                if commit
+                    Subprocess.run(package.name, :import, Autobuild.tool('git'), 'checkout', commit)
                     return
                 end
 
-                # Check that we are on the right branch, and if not simply
-                # create it from FETCH_HEAD
-                current_branch = `git symbolic-ref HEAD`.chomp
-                if current_branch != "refs/heads/#{branch}"
+                if !on_target_branch?
                     # Check if the target branch already exists. If it is the
                     # case, check it out. Otherwise, create it.
                     if File.file?(File.join(".git", "refs", "heads", branch))
@@ -53,21 +189,12 @@ module Autobuild
                     end
                 end
 
-                # Now that we are on the right branch, update it
-                fetch_commit = File.readlines( File.join('.git', 'FETCH_HEAD') ).
-                    delete_if { |l| l =~ /not-for-merge/ }
-                return if fetch_commit.empty?
-                fetch_commit = fetch_commit.first.split(/\s+/).first
-
-                common_commit = `git merge-base HEAD #{fetch_commit}`.chomp
-                head_commit   = `git rev-parse #{branch}`.chomp
-
-                if common_commit != fetch_commit
-                    if merge? || common_commit == head_commit
-                        Subprocess.run(package.name, :import, Autobuild.tool('git'), 'merge', fetch_commit)
-                    else
-                        raise "importing the current version would lead to a non fast-forward"
+                status = merge_status(fetch_commit)
+                if status.needs_update?
+                    if !merge? && status.status == Status::NEEDS_MERGE
+                        raise PackageException, "importing the current version would require a merge"
                     end
+                    Subprocess.run(package.name, :import, Autobuild.tool('git'), 'merge', fetch_commit)
                 end
             end
         end
@@ -83,13 +210,20 @@ module Autobuild
                 repository, package.srcdir)
 
             Dir.chdir(package.srcdir) do
+                # If we are tracking a commit/tag, just check it out
+                if commit
+                    Subprocess.run(package.name, :import, Autobuild.tool('git'),
+                        'checkout', commit)
+                    return
+                end
+
                 current_branch = `git symbolic-ref HEAD`.chomp
                 if current_branch == "refs/heads/#{branch}"
                     Subprocess.run(package.name, :import, Autobuild.tool('git'),
-                        'reset', '--hard', "autobuild/#{branch}")
+                    'reset', '--hard', "autobuild/#{branch}")
                 else
                     Subprocess.run(package.name, :import, Autobuild.tool('git'),
-                        'checkout', '-b', branch, "autobuild/#{branch}")
+                    'checkout', '-b', branch, "autobuild/#{branch}")
                 end
             end
         end
@@ -97,7 +231,7 @@ module Autobuild
 
     # Creates a git importer which gets the source for the given repository and branch
     # URL +source+. The allowed values in +options+ are described in SVN.new.
-    def self.git(repository, branch, options = {})
+    def self.git(repository, branch = nil, options = {})
         Git.new(repository, branch, options)
     end
 end