autobuild 1.8.3 → 1.9.0.b1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 71fc9a4d13e16cb68906457a8d9afd08f8c3700c
-  data.tar.gz: 4d940353cece1bc2681254bafb90cd48e0dbba46
+  metadata.gz: 89ad5685bb460bc80765d7677953c83335bad861
+  data.tar.gz: 74b187763b5789e40f6f0dd7aae2d58cfca004cf
 SHA512:
-  metadata.gz: fcc2b5bc4bc96b0b27288e3478744dc91191a3e498a125bc71fd317142f7adbea64b60b826bc82bda595bf182d622091f6aa6df4630d97ea132267d1841c713e
-  data.tar.gz: 993285ac044926d5867c956942fc778c7d05823eaca884eeeda22d6c867ba668947b672f252ae2f0afdccef8009dcbb22c7bc4eb5c955c8c6f324d42c1537d3e
+  metadata.gz: b3cf9d6af419fa355ec32fdde8c0c83ce8f41beb287eb9717a32f94b107fe7cbb9adc58e8bbce8bacbfb5b023ea087728b3af4b9889ad2d8e3bdd7337075d22b
+  data.tar.gz: f0445a03f3aff872a12e5b739388d37b5afcb87dddaf43ec5b658cc7aa9b580147c4d4c08101f0ed59f7b7b3e45e757cf2dfba71735fa843c2fa1c14eebb7eac

data/Manifest.txt

@@ -28,22 +28,31 @@ lib/autobuild/packages/import.rb
 lib/autobuild/packages/orogen.rb
 lib/autobuild/packages/pkgconfig.rb
 lib/autobuild/packages/ruby.rb
-lib/autobuild/utility.rb
 lib/autobuild/parallel.rb
 lib/autobuild/pkgconfig.rb
+lib/autobuild/rake_task_extension.rb
 lib/autobuild/reporting.rb
 lib/autobuild/subcommand.rb
-lib/autobuild/tools.rb
+lib/autobuild/test.rb
 lib/autobuild/timestamps.rb
+lib/autobuild/tools.rb
+lib/autobuild/utility.rb
 lib/autobuild/version.rb
-lib/autobuild/rake_task_extension.rb
 samples/openrobots.autobuild
 test/data/cvsroot.tar
+test/data/gitrepo-with-extra-commit-and-tag.tar
+test/data/gitrepo.tar
+test/data/gitrepo/test
+test/data/gitrepo/test2
+test/data/gitrepo/test3
 test/data/svnroot.tar
 test/data/tarimport.tar.gz
-test/test_import_cvs.rb
-test/test_import_svn.rb
-test/test_import_tar.rb
+test/import/test_cvs.rb
+test/import/test_git.rb
+test/import/test_svn.rb
+test/import/test_tar.rb
+test/suite.rb
+test/test_config.rb
+test/test_environment.rb
 test/test_reporting.rb
 test/test_subcommand.rb
-test/tools.rb

data/Rakefile

@@ -17,6 +17,8 @@ Utilrb::Rake.hoe do
             ['rake', '>= 0.9.0'] <<
             ['utilrb', '>= 1.6.0'] <<
             ['highline', '>= 0']
+
+        self.test_globs = ['test/suite.rb']
     end
     Rake.clear_tasks(/publish_docs/, /default/)
 end

data/lib/autobuild/config.rb

@@ -44,8 +44,19 @@ module Autobuild
         # @see {register_utility_class}
         attr_reader :utilities
 
-        def register_utility_class(name, klass)
-            utilities[name] = klass
+        # Yields all known utility classes
+        #
+        # @yieldparam [String] utility name
+        # @yieldparam [Class] utility class
+        # @yieldparam [Hash] utility options
+        # @return [void]
+        def each_utility
+            return enum_for(__method__) if !block_given?
+            utilities.each { |name, (utl, options)| yield(name, utl, options) }
+        end
+
+        def register_utility_class(name, klass, options = Hash.new)
+            utilities[name] = [klass, options]
             singleton_class.class_eval do
                 attr_accessor "only_#{name}"
                 attr_accessor "do_#{name}"
@@ -59,8 +70,12 @@ module Autobuild
         end
 
         def create_utility(utility_name, package)
-            if klass = utilities[utility_name]
-                package.utilities[utility_name] = klass.new(utility_name, package)
+            klass, options = utilities[utility_name]
+            if klass
+                utility = klass.new(utility_name, package)
+                package.utilities[utility_name] = utility
+                utility.enabled = !options[:disabled_by_default]
+                utility
             else raise ArgumentError, "there is no utility called #{utility_name}, available utilities are #{utilities.keys.sort.join(", ")}"
             end
         end
@@ -76,8 +91,8 @@ module Autobuild
         end
     end
     @utilities = Hash.new
-    register_utility_class 'doc', Utility
-    register_utility_class 'test', Utility
+    register_utility_class 'doc', Utility, disabled_by_default: false
+    register_utility_class 'test', Utility, disabled_by_default: true
 
     @console = HighLine.new
 

data/lib/autobuild/configurable.rb

@@ -74,7 +74,7 @@ module Autobuild
         def prepare_for_rebuild
             super
 
-            if File.exists?(builddir) && builddir != srcdir
+            if File.exist?(builddir) && builddir != srcdir
                 FileUtils.rm_rf builddir
             end
         end
@@ -117,7 +117,7 @@ module Autobuild
 
         # Configure the builddir directory before starting make
         def configure
-            if File.exists?(builddir) && !File.directory?(builddir)
+            if File.exist?(builddir) && !File.directory?(builddir)
                 raise ConfigException.new(self, 'configure'), "#{builddir} already exists but is not a directory"
             end
             FileUtils.mkdir_p builddir if !File.directory?(builddir)

data/lib/autobuild/environment.rb

@@ -68,14 +68,6 @@ module Autobuild
         #
         #   export VARNAME=new_value:new_value
         attr_reader :inherited_environment
-
-        # List of files that should be sourced in the generated environment
-        # variable setting shell scripts
-        attr_reader :env_source_before
-
-        # List of files that should be sourced in the generated environment
-        # variable setting shell scripts
-        attr_reader :env_source_after
     end
 
     # Resets the value of +name+ to its original value. If it is inherited from
@@ -86,8 +78,8 @@ module Autobuild
             inherited_environment.delete(name)
             env_init_from_env(name)
         else
-            environment.keys.each do |name|
-                env_reset(name)
+            environment.keys.each do |env_key|
+                env_reset(env_key)
             end
         end
     end
@@ -105,15 +97,15 @@ module Autobuild
             inherited_environment[name] = nil
             env_update_var(name)
         else
-            environment.keys.each do |name|
-                env_clear(name)
+            environment.keys.each do |env_key|
+                env_clear(env_key)
             end
         end
     end
 
     # Set a new environment variable
     def self.env_set(name, *values)
-        env_reset(name)
+        environment.delete(name)
         env_add(name, *values)
     end
 
@@ -160,10 +152,26 @@ module Autobuild
     #
     # @see env_inherit? env_inherit=
     def self.env_inherit(*names)
-        @env_inherited_variables |= names
-        names.each do |env_name|
-            env_init_from_env(env_name)
+        flag =
+            if !names.last.respond_to?(:to_str)
+                names.pop
+            else true
+            end
+        
+        if flag
+            @env_inherited_variables |= names
+            names.each do |env_name|
+                env_init_from_env(env_name)
+            end
+        else
+            names.each do |n|
+                if @env_inherited_variables.include?(n)
+                    @env_inherited_variables.delete(n)
+                    env_init_from_env(n)
+                end
+            end
         end
+
         @env_inherit
     end
 
@@ -266,7 +274,7 @@ module Autobuild
     end
 
     def self.env_add_path(name, *paths)
-        oldpath = environment[name] || Array.new
+        oldpath = (environment[name] ||= Array.new)
         paths.reverse.each do |path|
             next if oldpath.include?(path)
 
@@ -286,9 +294,8 @@ module Autobuild
     end
 
     def self.env_push_path(name, *values)
-        if current = environment[name]
+        if current = environment.delete(name)
             current = current.dup
-            env_clear(name)
             env_add_path(name, *values)
             env_add_path(name, *current)
         else
@@ -302,16 +309,34 @@ module Autobuild
         env_source_after(file)
     end
 
-    # Require that generated environment variable scripts source the given shell
-    # script
-    def self.env_source_before(file)
-        @env_source_before << file
+    # @overload env_source_before
+    #   List of scripts that should be sourced at the top of env.sh
+    #
+    #   @return [Array<String>] a list of paths that should be sourced at the
+    #     beginning of the shell script generated by {export_env_sh}
+    #
+    # @overload env_source_before(path)
+    #   @param [String] path a path that should be added to env_source_before
+    #
+    def self.env_source_before(file = nil)
+        if file
+            @env_source_before << file
+        end
     end
 
-    # Require that generated environment variable scripts source the given shell
-    # script
-    def self.env_source_after(file)
-        @env_source_after << file
+    # @overload env_source_after
+    #   List of scripts that should be sourced at the end of env.sh
+    #
+    #   @return [Array<String>] a list of paths that should be sourced at the
+    #     end of the shell script generated by {export_env_sh}
+    #
+    # @overload env_source_after(path)
+    #   @param [String] path a path that should be added to env_source_after
+    #
+    def self.env_source_after(file = nil)
+        if file
+            @env_source_after << file
+        end
     end
 
     # Generates a shell script that sets the environment variable listed in

data/lib/autobuild/exceptions.rb

@@ -5,12 +5,16 @@ module Autobuild
         def mail?;  false end
         ## If the error is fatal
         def fatal?; true end
+        ## If the error can be retried
+        def retry?; @retry end
         attr_accessor :target, :phase
 
         ## Creates a new exception which occured while doing *phase* 
         # in *target*
-        def initialize(target = nil, phase = nil)
+        def initialize(target = nil, phase = nil, options = Hash.new)
+            options = Kernel.validate_options options, retry: true
             @target, @phase = target, phase
+            @retry = options[:retry]
         end
 
         alias :exception_message :to_s 
@@ -36,10 +40,27 @@ module Autobuild
     end
 
     ## There is an error/inconsistency in the configuration
-    class ConfigException  < Exception; end
+    class ConfigException  < Exception
+        def initialize(target = nil, phase = nil, options = Hash.new)
+            options, other_options = Kernel.filter_options options,
+                retry: false
+            super(target, phase, options.merge(other_options))
+        end
+    end
     ## An error occured in a package
     class PackageException < Exception
         def mail?; true end
+
+        def initialize(target = nil, phase = nil, options = Hash.new)
+            options, other_options = Kernel.filter_options options,
+                retry: false
+            super(target, phase, options.merge(other_options))
+        end
+    end
+
+    # Exception thrown by importers when calling update with the reset flag but
+    # some conditiions make the reset impossible
+    class ImporterCannotReset < PackageException
     end
 
     ## The subcommand is not found
@@ -47,48 +68,53 @@ module Autobuild
     ## An error occured while running a subcommand
     class SubcommandFailed < Exception
         def mail?; true end
-        attr_reader :command, :logfile, :status
+        attr_writer :retry
+        attr_reader :command, :logfile, :status, :output
         def initialize(*args)
             if args.size == 1
                 sc = args[0]
-                target, command, logfile, status = 
-                    sc.target, sc.command, sc.logfile, sc.status
+                target, command, logfile, status, output = 
+                    sc.target, sc.command, sc.logfile, sc.status, sc.output
                 @orig_message = sc.exception_message
-            elsif args.size == 4
-                target, command, logfile, status = *args
+            elsif args.size == 4 || args.size == 5
+                target, command, logfile, status, output = *args
             else
-                raise ArgumentError, "wrong number of arguments, should be 1 or 4"
+                raise ArgumentError, "wrong number of arguments, should be 1 or 4..5"
             end
 
             super(target)
             @command = command
             @logfile = logfile
             @status  = status
+            @output = output || Array.new
         end
 
-        ERROR_LINES = 10
-
         def to_s
-            prefix = super
+            msg = super
             if @orig_message
-                prefix << "\n     #{@orig_message}"
+                msg << "\n     #{@orig_message}"
             end
-            prefix << "\n    see #{logfile} for details"
+            msg << "\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}"
+            if status 
+                if File.file?(logfile)
+                    lines = File.readlines(logfile)
+                    logsize = Autobuild.displayed_error_line_count
+                    if logsize != Float::INFINITY && lines.size > logsize
+                        lines = lines[-logsize, logsize]
+                    end
+                    msg << "\n    last #{lines.size} lines are:\n\n"
+                    lines.each do |l|
+                        msg << "    #{l}"
+                    end
+                else
+                    msg << "\n    the log file does not seem to be present on disk anymore"
                 end
             end
-            prefix
+            msg
         end
     end
 end

data/lib/autobuild/import/archive.rb

@@ -72,14 +72,25 @@ module Autobuild
         @cachedir = nil
 
 	# Returns the unpack mode from the file name
-        def self.filename_to_mode(filename)
+        #
+        # @return [Integer,nil] either one of the pack constants (Zip, Plain,
+        #   ...) or nil if it cannot be inferred
+        # @see filename_to_mode
+        def self.find_mode_from_filename(filename)
             case filename
-                when /\.zip$/; Zip
-                when /\.tar$/; Plain
-                when /\.tar\.gz$|\.tgz$/;  Gzip
-                when /\.bz2$/; Bzip
-                else
-                    raise "unknown file type '#{filename}'"
+            when /\.zip$/; Zip
+            when /\.tar$/; Plain
+            when /\.tar\.gz$|\.tgz$/;  Gzip
+            when /\.bz2$/; Bzip
+            end
+        end
+
+	# Returns the unpack mode from the file name
+        def self.filename_to_mode(filename)
+            if mode = find_mode_from_filename(filename)
+                mode
+            else
+                raise "cannot infer the archive type from '#{filename}', use the mode: option"
             end
         end
 
@@ -183,7 +194,7 @@ module Autobuild
                         if retries = self.retries
                             additional_options << "--tries" << retries
                         end
-                        Subprocess.run(package, :import, Autobuild.tool('wget'), '-q', '-P', cachedir, *additional_options, @url, '-O', "#{cachefile}.partial")
+                        package.run(:import, Autobuild.tool('wget'), '-q', '-P', cachedir, *additional_options, @url, '-O', "#{cachefile}.partial", retry: true)
                     end
                 rescue Exception
                     FileUtils.rm_f "#{cachefile}.partial"
@@ -233,6 +244,16 @@ module Autobuild
         # It defaults to the global ArchiveImporter.retries
         attr_accessor :retries
 
+        # The filename that should be used locally (for remote files)
+        #
+        # This is usually inferred by using the URL's basename, but some
+        # download URLs do not allow this (for instance bitbucket tarballs)
+        #
+        # Change it by calling {relocate}
+        #
+        # @retun [String]
+        attr_reader :filename
+
         # The timeout (in seconds) used during downloading.
         #
         # With wget, it is the timeout used for DNS resolution, connection and
@@ -279,9 +300,9 @@ module Autobuild
             @repository_id = options[:repository_id] || parsed_url
             @source_id = options[:source_id] || parsed_url
 
-            filename = options[:filename] || File.basename(url).gsub(/\?.*/, '')
+            @filename = options[:filename] || @filename || File.basename(url).gsub(/\?.*/, '')
 
-            @mode = options[:mode] || ArchiveImporter.filename_to_mode(filename)
+            @mode = options[:mode] || ArchiveImporter.find_mode_from_filename(filename) || @mode
             if @url.scheme == 'file'
                 @cachefile = @url.path
             else
@@ -289,9 +310,9 @@ module Autobuild
             end
         end
 
-        def update(package,only_local = false) # :nodoc:
-            if only_local
-                Autobuild.warn "The importer #{self.class} does not support local updates, skipping #{self}"
+        def update(package, options = Hash.new) # :nodoc:
+            if options[:only_local]
+                package.warn "%s: the archive importer does not support local updates, skipping"
                 return
             end
             needs_update = update_cache(package)
@@ -368,7 +389,7 @@ module Autobuild
 
                 FileUtils.mkdir_p base_dir
                 cmd = [ '-o', cachefile, '-d', main_dir ]
-                Subprocess.run(package, :import, Autobuild.tool('unzip'), *cmd)
+                package.run(:import, Autobuild.tool('unzip'), *cmd)
                 
                 archive_dir = (self.archive_dir || File.basename(package.name))
                 if archive_dir != File.basename(package.srcdir)
@@ -387,13 +408,13 @@ module Autobuild
                 if(WINDOWS)
                     extract_tar_on_windows(cachefile,package.srcdir)
                 else
-                    Subprocess.run(package, :import, Autobuild.tool('tar'), *cmd)
+                    package.run(:import, Autobuild.tool('tar'), *cmd)
                 end
             end
             write_checkout_digest_stamp(package)
 
         rescue OpenURI::HTTPError
-            raise Autobuild::Exception.new(package.name, :import)
+            raise Autobuild::PackageException.new(package.name, :import)
         rescue SubcommandFailed
             FileUtils.rm_f cachefile
             raise