autobuild 1.0 → 1.0.1

data/Changes.txt

@@ -1,3 +1,10 @@
+== Version 1.0.1
+* The "test suites are there for something" release
+* Fixes bugs introduced in the last version
+* Added a real example in samples/openrobots.rb
+* Fixed documentation in various places
+* Fail more gracefully on circular dependencies
+
 == Version 1.0
 
 * Releasing 1.0. Autobuild is stable, and is in daily use at my work

data/Manifest.txt

@@ -22,7 +22,7 @@ lib/autobuild/pkgconfig.rb
 lib/autobuild/reporting.rb
 lib/autobuild/subcommand.rb
 lib/autobuild/timestamps.rb
-samples/demo.rb
+samples/openrobots.autobuild
 test/data/cvsroot.tar
 test/data/svnroot.tar
 test/data/tarimport.tar.gz

data/bin/autobuild

@@ -45,6 +45,10 @@ begin
 
         Reporting.success
     end
+rescue ThreadError
+    STDERR.puts "Rake failed with a ThreadError"
+    STDERR.puts "You may have a circular dependency in your packages"
 rescue Interrupt
+    STDERR.puts "interrupted"
 end
  

data/lib/autobuild.rb

@@ -3,6 +3,6 @@ require 'autobuild/reporting'
 require 'autobuild/package'
 
 module Autobuild
-    VERSION = "1.0" unless defined? Autobuild::VERSION
+    VERSION = "1.0.1" unless defined? Autobuild::VERSION
 end
 

data/lib/autobuild/import/tar.rb

@@ -1,3 +1,4 @@
+require 'autobuild/importer'
 require 'open-uri'
 
 module Autobuild
@@ -77,13 +78,13 @@ module Autobuild
 	# Sets the source URL and update +cachefile+ and +mode+ attributes accordingly.
         def url=(url)
             @url = URI.parse(url)
-            raise ConfigException, "invalid URL #{url}" unless VALID_URI_SCHEMES.include?(url.scheme)
+            raise ConfigException, "invalid URL #{@url}" unless VALID_URI_SCHEMES.include?(@url.scheme)
 
             @mode = TarImporter.url_to_mode(url)
-            if url.scheme == 'file'
-                @cachefile = url
+            if @url.scheme == 'file'
+                @cachefile = @url.path
             else
-                @cachefile = File.join(cachedir, File.basename(url.path))
+                @cachefile = File.join(cachedir, File.basename(@url.path))
             end
         end
 
@@ -95,10 +96,14 @@ module Autobuild
 	attr_reader :mode
 	# The directory in which remote files are cached
         def cachedir; @options[:cachedir] end
+	# The directory contained in the tar file
+	def tardir; @options[:tardir] end
 
 	# Creates a new importer which downloads +url+ in +cachedir+ and unpacks it. The following options
 	# are allowed:
 	# [:cachedir] the cache directory. Defaults to "#{Autobuild.prefix}/cache"
+	# [:tardir]   the directory contained in the tar file. If set, the importer will rename that directory
+	#             to make it match Package#srcdir
         def initialize(url, options)
             @options = options.dup
             @options[:cachedir] ||= "#{Autobuild.prefix}/cache"
@@ -117,8 +122,11 @@ module Autobuild
             base_dir = File.dirname(package.srcdir)
             FileUtils.mkdir_p base_dir
             cmd = [ 'tar', "x#{TAR_OPTION[mode]}f", cachefile, '-C', base_dir ]
-            
+
             Subprocess.run(package.name, :import, *cmd)
+	    if tardir
+		File.mv File.join(base_dir, tardir), package.srcdir
+	    end
 
         rescue OpenURI::HTTPError
             raise Autobuild::Exception.new(package.name, :import)
@@ -130,7 +138,7 @@ module Autobuild
 
     # Creates an importer which downloads a tarball from +source+ and unpacks
     # it. The allowed values in +options+ are described in TarImporter.new.
-    def self.tar(source, options)
+    def self.tar(source, options = {})
 	TarImporter.new(source, options)
     end
 end

data/lib/autobuild/package.rb

@@ -4,148 +4,146 @@ require 'autobuild/subcommand'
 
 module Autobuild
     TARGETS = %w{import prepare build}
-end
-
-# Basic block for the autobuilder
-#
-# The build is done in three phases:
-#   - import
-#   - prepare
-#   - build & install
-class Autobuild::Package
-    @@packages = {}
-    @@provides = {}
-
-    # the package name
-    attr_reader     :name
-    # set the source directory. If a relative path is given,
-    # it is relative to Autobuild.srcdir. Defaults to #name
-    attr_writer     :srcdir
-    # set the installation directory. If a relative path is given,
-    # it is relative to Autobuild.prefix. Defaults to ''
-    attr_writer :prefix
     
-    # Sets importer object for this package. Defined for backwards compatibility.
-    # Use the #importer attribute instead
-    def import=(value)
-	@importer = value
-    end
-    # Sets an importer object for this package
-    attr_accessor :importer
+    # Basic block for the autobuilder
+    #
+    # The build is done in three phases:
+    #   - import
+    #   - prepare
+    #   - build & install
+    class Package
+	@@packages = {}
+	@@provides = {}
+
+	# the package name
+	attr_reader     :name
+	# set the source directory. If a relative path is given,
+	# it is relative to Autobuild.srcdir. Defaults to #name
+	attr_writer     :srcdir
+	# set the installation directory. If a relative path is given,
+	# it is relative to Autobuild.prefix. Defaults to ''
+	attr_writer :prefix
+	
+	# Sets importer object for this package. Defined for backwards compatibility.
+	# Use the #importer attribute instead
+	def import=(value)
+	    @importer = value
+	end
+	# Sets an importer object for this package
+	attr_accessor :importer
+
+	# The list of packages this one depends upon
+	attr_reader :dependencies
+
+	# Absolute path to the source directory. See #srcdir=
+	def srcdir; File.expand_path(@srcdir || name, Autobuild.srcdir) end
+	# Absolute path to the installation directory. See #prefix=
+	def prefix; File.expand_path(@prefix || '', Autobuild.prefix) end
+
+	# The file which marks when the last sucessful install
+	# has finished. The path is absolute
+	#
+	# A package is sucessfully built when it is installed
+	def installstamp; "#{Autobuild.logdir}/#{name}-#{STAMPFILE}" end
+
+	def initialize(spec)
+	    @dependencies   = Array.new
+	    @provides       = Array.new
+
+	    if Hash === spec
+		name, depends = spec.to_a.first
+	    else
+		name, depends = spec, nil
+	    end
 
-    # The list of packages this one depends upon
-    attr_reader :dependencies
+	    name = name.to_s
+	    @name = name
+	    raise ConfigException, "package #{name} is already defined" if Autobuild::Package[name]
+	    @@packages[name] = self
+
+	    # Call the config block (if any)
+	    yield(self) if block_given?
+	    
+	    # Declare the installation stampfile
+	    file installstamp do
+		Dir.chdir(srcdir) do
+		    Autobuild.apply_post_install(@post_install)
+		end
+	    end
+	    task "#{name}-build" => installstamp
+	    task :build => "#{name}-build"
 
-    # Absolute path to the source directory. See #srcdir=
-    def srcdir; File.expand_path(@srcdir || name, Autobuild.srcdir) end
-    # Absolute path to the installation directory. See #prefix=
-    def prefix; File.expand_path(@prefix || '', Autobuild.prefix) end
+	    # Add dependencies declared in spec
+	    depends_on *depends if depends
 
-    # The file which marks when the last sucessful install
-    # has finished. The path is absolute
-    #
-    # A package is sucessfully built when it is installed
-    def installstamp; "#{Autobuild.logdir}/#{name}-#{STAMPFILE}" end
-
-    def initialize(spec)
-        @dependencies   = Array.new
-        @provides       = Array.new
-
-        if Hash === spec
-            name, depends = spec.to_a.first
-        else
-            name, depends = spec, nil
-        end
-
-        name = name.to_s
-        @name = name
-        raise ConfigException, "package #{name} is already defined" if Package[name]
-        @@packages[name] = self
-
-        # Call the config block (if any)
-        yield(self) if block_given?
-        
-        # Declare the installation stampfile
-        file installstamp do
-	    Dir.chdir(srcdir) do
-		Autobuild.apply_post_install(@post_install)
+	    # Define the import task
+	    task "#{name}-import" do import end
+	    task :import => "#{name}-import"
+
+	    # Define the prepare task
+	    task "#{name}-prepare" do prepare end
+	    task :prepare => "#{name}-prepare"
+
+	    task(name) do
+		Rake::Task["#{name}-import"].invoke
+		Rake::Task["#{name}-prepare"].invoke
+		Rake::Task["#{name}-build"].invoke
 	    end
+	    task :default => name
 	end
-        task "#{name}-build" => installstamp
-        task :build => "#{name}-build"
-
-        # Add dependencies declared in spec
-        depends_on *depends if depends
-
-        # Define the import task
-        task "#{name}-import" do import end
-        task :import => "#{name}-import"
-
-        # Define the prepare task
-        task "#{name}-prepare" do prepare end
-        task :prepare => "#{name}-prepare"
-
-        task(name) do
-            Rake::Task["#{name}-import"].invoke
-            Rake::Task["#{name}-prepare"].invoke
-            Rake::Task["#{name}-build"].invoke
-        end
-        task :default => name
-    end
 
-    def import; @importer.import(self) if @importer end
-    def prepare; end
+	def import; @importer.import(self) if @importer end
+	def prepare; end
 
-    def post_install(*args, &block)
-	if args.empty?
-	    @post_install = block
-	elsif !block
-	    @post_install = args
-	else
-	    raise ArgumentError, "cannot set both arguments and block"
+	def post_install(*args, &block)
+	    if args.empty?
+		@post_install = block
+	    elsif !block
+		@post_install = args
+	    else
+		raise ArgumentError, "cannot set both arguments and block"
+	    end
 	end
-    end
 
-    # This package depends on +packages+
-    def depends_on(*packages)
-        packages.each do |p|
-            p = p.to_s
-            next if p == name
-            unless Package[p]
-                raise ConfigException.new(name), "package #{p} not defined"
-            end
-            file installstamp => Package[p].installstamp
-	    task "#{name}-import"  => "#{p}-import"
-	    task "#{name}-prepare" => "#{p}-prepare"
-            @dependencies << p
-        end
-    end
+	# This package depends on +packages+
+	def depends_on(*packages)
+	    packages.each do |p|
+		p = p.to_s
+		next if p == name
+		unless Package[p]
+		    raise ConfigException.new(name), "package #{p} not defined"
+		end
+		file installstamp => Package[p].installstamp
+		task "#{name}-import"  => "#{p}-import"
+		task "#{name}-prepare" => "#{p}-prepare"
+		@dependencies << p
+	    end
+	end
 
-    # Declare that this package provides +packages+
-    def provides(*packages)
-        packages.each do |p|
-            p = p.to_s
-            @@provides[p] = self 
-            task p => name
-            @provides << p
-        end
-    end
+	# Declare that this package provides +packages+
+	def provides(*packages)
+	    packages.each do |p|
+		p = p.to_s
+		@@provides[p] = self 
+		task p => name
+		@provides << p
+	    end
+	end
 
-    # Iterates on all available packages
-    # if with_provides is true, includes the list
-    # of package aliases
-    def self.each(with_provides = false, &p)
-        @@packages.each(&p) 
-        @@provides.each(&p) if with_provides
-    end
+	# Iterates on all available packages
+	# if with_provides is true, includes the list
+	# of package aliases
+	def self.each(with_provides = false, &p)
+	    @@packages.each(&p) 
+	    @@provides.each(&p) if with_provides
+	end
 
-    # Gets a package from its name
-    def self.[](name)
-        @@packages[name.to_s] || @@provides[name.to_s]
+	# Gets a package from its name
+	def self.[](name)
+	    @@packages[name.to_s] || @@provides[name.to_s]
+	end
     end
-end
 
-module Autobuild
     def self.package_set(spec)
 	spec.each do |name, packages|
 	    Autobuild::TARGETS.each do |target|

data/lib/autobuild/packages/autotools.rb

@@ -14,18 +14,12 @@ module Autobuild
     # ==== Handles autotools-based packages
     #
     # == Used programs (see <tt>Autobuild.programs</tt>)
-    # * aclocal
-    # * autoheader
-    # * autoconf
-    # * automake
+    # Autotools will use the 'aclocal', 'autoheader', 'autoconf' and 'automake'
+    # programs defined on Autobuild.programs. autoheader is disabled by default,
+    # aclocal, autoconf and automake use are autodetected.
+    #
+    # To override this default behaviour on a per-package basis, use Autotools#use
     #
-    # == Available options
-    # * aclocal     (default: true if autoconf is enabled, false otherwise) run aclocal
-    # * autoconf    (default: true)
-    # * autoheader  (default: false) run autoheader
-    # * automake    (default: autodetect) run automake. Will run automake if there is a 
-    #               +Makefile.am+ in the source directory
-    # 
     class Autotools < Package
         attr_accessor   :using
         attr_accessor   :configureflags
@@ -61,6 +55,29 @@ module Autobuild
             Autobuild.update_environment(prefix)
         end
 
+	# Overrides the default behaviour w.r.t. autotools script generation
+	#
+	# Use it like that:
+	# * to force a generation step (skipping autodetection), do
+	#     pkg.use <program> => true
+	#   For instance, for aclocal
+	#     pkg.use :aclocal => true
+	#
+	# * to force a generation step, overriding the program defined on Autobuild
+	#     pkg.use <program> => true
+	#   For instance, for autoconf
+	#     pkg.use :autoconf => 'my_autoconf_program'
+	#
+	# * to disable a generation step, do
+	#     pkg.use <program> => false
+	#   For instance, for automake
+	#     pkg.use :automake => false
+	#
+	# * to restore autodetection, do
+	#     pkg.use <program> => nil
+	#   For instance, for automake
+	#     pkg.use :automake => nil
+	#
         def use(*programs)
             programs = *programs
             if !programs.kind_of?(Hash)

data/samples/openrobots.autobuild

@@ -0,0 +1,78 @@
+# This sample file installs a set of autotools packages from
+# the OpenRobots suite of tools (http://softs.laas.fr/openrobots)
+#
+# The user (you) is asked about the installation directory (prefix). Then, the various packages
+# are installed the following way:
+# * sources are in prefix/src
+# * installed packages are in prefix/bin, prefix/lib, prefix/include, ...
+#
+# This version uses the Tar importer to get the latest release
+require 'autobuild'
+require 'autobuild/packages/autotools'
+require 'autobuild/import/tar'
+
+Thread.abort_on_exception = true
+STDOUT.sync = true
+
+# Ask the user (you) where you want everything installed
+default_prefix = "#{ENV['HOME']}/openrobots"
+print "Where to intall openrobots ? [#{default_prefix}]"
+answer = STDIN.readline
+answer = default_prefix if answer == "\n"
+
+# Set the root directory for sources import and package installation
+Autobuild.srcdir = File.join(answer, "src")
+Autobuild.prefix = answer
+
+# Define a fake 'openrobots' package type which describes the common package
+# configuration for packages from openrobots
+#
+# spec is either a name (the package name) or a name => dependencies hash
+OPENROBOTS_DOWNLOAD_BASEURL = "http://softs.laas.fr/openrobots/php/download.php/"
+def openrobots(version, spec)
+    Autobuild.autotools(spec) do |pkg|
+	# Install the sources in #{Autobuild.srcdir}/package_name
+	pkg.srcdir   = pkg.name
+
+	# Build packages into #{package source dir}/build
+	pkg.builddir = "build"
+
+	# The importer object will download the file and decompress it into the
+	# specified source directory
+	#
+	# The tarballs contain a name-version directory. The :tardir option
+	# makes the tar importer rename that directory into 'name'
+	pkg.importer = Autobuild.tar(OPENROBOTS_DOWNLOAD_BASEURL + "#{pkg.name}-#{version}.tar.gz", 
+				     :tardir => "#{pkg.name}-#{version}")
+				     
+	# Do not autogenerate configure scripts, use the ones in the tarball instead
+	pkg.use :aclocal => false
+	pkg.use :autoconf => false
+	pkg.use :automake => false
+
+	# All openrobots package depend on mkdep
+	if pkg.name != "mkdep"
+	    pkg.depends_on 'mkdep'
+	end
+    end
+end
+
+# You can override the version of aclocal/autoconf/automake used if needed
+# Autotools.aclocal  = "aclocal-1.9"
+# Autotools.automake = "automake-1.9"
+    
+# Declare the packages themselves
+openrobots "2.6", :mkdep
+openrobots "2.2", :pocolibs
+
+# Genom depends on pocolibs, declare that
+openrobots "1.99.902", :genom => :pocolibs
+
+# GDHE needs a X display to install. Check that the DISPLAY environment
+# variable is set
+if ENV['DISPLAY']
+    openrobots "3.7", :gdhe
+else
+    STDERR.puts "GDHE installation requires a X display. Disabled"
+end
+

metadata

@@ -3,7 +3,7 @@ rubygems_version: 0.9.4
 specification_version: 1
 name: autobuild
 version: !ruby/object:Gem::Version 
-  version: "1.0"
+  version: 1.0.1
 date: 2007-06-22 00:00:00 +02:00
 summary: Rake-based utility to build and install multiple packages with dependencies
 require_paths: 
@@ -53,7 +53,7 @@ files:
 - lib/autobuild/reporting.rb
 - lib/autobuild/subcommand.rb
 - lib/autobuild/timestamps.rb
-- samples/demo.rb
+- samples/openrobots.autobuild
 - test/data/cvsroot.tar
 - test/data/svnroot.tar
 - test/data/tarimport.tar.gz

data/samples/demo.rb

@@ -1,25 +0,0 @@
-require 'autobuild'
-
-# Remove the need for the Autobuild. prefix in
-# front of everything
-include Autobuild
-
-# Define a common configuration routine
-openrobots_config = lambda { |pkg|
-    pkg.import = cvs(openrobots, pkg.name)
-    pkg.depends_on :mkdep
-}
-
-Autotools.aclocal  = "aclocal-1.9"
-Autotools.automake = "automake-1.9"
-    
-autotools(:mkdep, &openrobots_config)
-autotools(:gdhe, &openrobots_config)
-autotools(:pocolibs, &openrobots_config)
-autotools :genom do |pkg|
-    openrobots_config[pkg]
-    pkg.autoheader = true     # Force usage of autoheader
-    pkg.automake = 'automake' # use the default automake instead
-			      # of Autotools.automake
-end
-