autobuild 1.10.0.rc13 → 1.10.0.rc14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 62f1f8b5be427ce16c5f90acaa29148f6aec1898
-  data.tar.gz: 3b3e04ed491d7640d8cd66c65623ac50de886a1d
+  metadata.gz: 9e04850122480c75777d04748145ca9415f084cc
+  data.tar.gz: 8d0247d6239a8d2847c36dee651484b5de6f4698
 SHA512:
-  metadata.gz: acc2cabb0c47592702162a230f039e3b2c7138d51ba8a5baa43e62bcb5c0ec8acdc6027a71a3dbad324d839a728bb0606f334556278b7a2c66bb16fc073a58a0
-  data.tar.gz: ef56847f897e5f2ba1df4635d731aef7e0590a87a0ece26fa667bd74d4ccd4315215672306a3e414cbb49a75ef3a2ebcf42f0209a4c759b8cc89cafda27a307c
+  metadata.gz: 3824e574d80cf76b09eff053bd5aa870d10975dfdcc6c9f4e5c5da5869bd4a83d845c828357d3202cf7cf5da141c7ea6182f62cba61931f6bb19c845ebcdf1c4
+  data.tar.gz: 4b22b978f8205df7ad38e08e9f7923abd02ef9bcea670a29b71518a36c9a0b301fdbfbff36990653a9f4826d4a25a7a8311775c3ae77608ddf0206b53ef4cf5a

data/lib/autobuild/config.rb

@@ -49,8 +49,8 @@ def each_utility
             utilities.each { |name, (utl, options)| yield(name, utl, options) }
         end
 
-        def register_utility_class(name, klass, options = Hash.new)
-            utilities[name] = [klass, options]
+        def register_utility_class(name, klass, disabled_by_default: false, **options)
+            utilities[name] = [klass, Hash[disabled_by_default: disabled_by_default], options]
             singleton_class.class_eval do
                 attr_accessor "only_#{name}"
                 attr_accessor "do_#{name}"
@@ -64,11 +64,11 @@ def register_utility_class(name, klass, options = Hash.new)
         end
 
         def create_utility(utility_name, package)
-            klass, options = utilities[utility_name]
+            klass, creation_options, options = utilities[utility_name]
             if klass
-                utility = klass.new(utility_name, package)
+                utility = klass.new(utility_name, package, **options)
                 package.utilities[utility_name] = utility
-                utility.enabled = !options[:disabled_by_default]
+                utility.enabled = !creation_options[:disabled_by_default]
                 utility
             else raise ArgumentError, "there is no utility called #{utility_name}, available utilities are #{utilities.keys.sort.join(", ")}"
             end
@@ -83,12 +83,17 @@ def full_build?
     end
     @utilities = Hash.new
     register_utility_class 'doc', Utility, disabled_by_default: false
-    register_utility_class 'test', Utility, disabled_by_default: true
+    register_utility_class 'test', Utility, disabled_by_default: true, install_on_error: true
 
     @colorizer = Pastel.new
     class << self
         def color=(flag)
-            @colorizer = Pastel.new(enabled: flag)
+            @colorizer =
+                if flag.nil?
+                    Pastel.new
+                else
+                    Pastel.new(enabled: flag)
+                end
         end
 
         def color?

data/lib/autobuild/import/git-lfs.rb

@@ -0,0 +1,10 @@
+module Autobuild
+    Git.add_post_hook do |importer, package|
+        if File.join(package.srcdir, '.git', 'lfs')
+
+            package.run 'import', Autobuild.tool(:git), 'lfs', 'pull', importer.remote_name,
+                working_directory: package.srcdir
+        end
+    end
+end
+

data/lib/autobuild/importer.rb

@@ -150,6 +150,7 @@ def initialize(options)
         @repository_id = options[:repository_id] || "#{self.class.name}:#{object_id}"
         @interactive = options[:interactive]
         @source_id = options[:source_id] || @repository_id
+        @post_hooks = Array.new
     end
 
     # Returns a string that identifies the remote repository uniquely
@@ -236,6 +237,57 @@ def update_retry_count(original_error, retry_count)
         end
     end
 
+    # A list of hooks that are called after a successful checkout or update
+    #
+    # They are added either at the instance level with {#add_post_hook} or
+    # globally for all importers of a given type with {Importer.add_post_hook}
+    attr_reader :post_hooks
+
+    # Define a post-import hook for all instances of this class
+    #
+    # @yieldparam [Importer] importer the importer that finished
+    # @yieldparam [Package] package the package we're acting on
+    # @see Importer#add_post_hook
+    def self.add_post_hook(&hook)
+        @post_hooks ||= Array.new
+        @post_hooks << hook
+    end
+
+    # Enumerate the post-import hooks defined for all instances of this class
+    def self.each_post_hook(&hook)
+        (@post_hooks || Array.new).each(&hook)
+    end
+
+    # @api private
+    #
+    # Call the post-import hooks added with {#add_post_hook}
+    def execute_post_hooks(package)
+        self.class.each_post_hook do |hook|
+            hook.call(self, package)
+        end
+        each_post_hook.each do |block|
+            block.call(self, package)
+        end
+    end
+
+    # Add a block that should be called when the import has successfully
+    # finished
+    #
+    # @yieldparam [Importer] importer the importer that finished
+    # @yieldparam [Package] package the package we're acting on
+    # @see Importer.add_post_hook
+    def add_post_hook(&hook)
+        post_hooks << hook
+    end
+
+    # Enumerate the post-import hooks for this importer
+    def each_post_hook(&hook)
+        return enum_for(__method__) if !block_given?
+
+        self.class.each_post_hook(&hook)
+        post_hooks.each(&hook)
+    end
+
     def perform_update(package,only_local=false)
         cur_patches    = currently_applied_patches(package)
         needed_patches = self.patches
@@ -243,13 +295,19 @@ def perform_update(package,only_local=false)
             patch(package, [])
         end
 
+        last_error = nil
         retry_count = 0
         package.progress_start "updating %s"
         begin
             update(package,only_local)
+            execute_post_hooks(package)
         rescue Interrupt
-            raise
+            if last_error
+                raise last_error
+            else raise
+            end
         rescue ::Exception => original_error
+            last_error = original_error
             # If the package is patched, it might be that the update
             # failed because we needed to unpatch first. Try it out
             #
@@ -288,13 +346,18 @@ def perform_update(package,only_local=false)
     end
 
     def perform_checkout(package, options = Hash.new)
+        last_error = nil
         package.progress_start "checking out %s", :done_message => 'checked out %s' do
             retry_count = 0
             begin
                 checkout(package, options)
+                execute_post_hooks(package)
             rescue Interrupt
-                raise
+                if last_error then raise last_error
+                else raise
+                end
             rescue ::Exception => original_error
+                last_error = original_error
                 retry_count = update_retry_count(original_error, retry_count)
                 if !retry_count
                     raise

data/lib/autobuild/package.rb

@@ -289,18 +289,28 @@ def resolve_dependency_env(env, set, ops)
             ops
         end
 
+        # This package's environment
+        def full_env(root = Autobuild.env)
+            set = Hash.new
+            env = root.dup
+            ops = Array.new
+            ops = resolve_dependency_env(env, set, ops)
+            apply_env(env, set, ops)
+            env
+        end
+
+        # Find a file in a path-like environment variable
+        def find_in_path(file, envvar = 'PATH')
+            full_env.find_in_path(file, envvar)
+        end
+
         # Resolves this package's environment into Hash form
         #
         # @param [Environment] root the base environment object to update
         # @return [Hash<String,String>] the full environment
         # @see Autobuild::Environment#resolved_env
         def resolved_env(root = Autobuild.env)
-            set = Hash.new
-            env = root.dup
-            ops = Array.new
-            ops = resolve_dependency_env(env, set, ops)
-            apply_env(env, set, ops)
-            env.resolved_env
+            full_env.resolved_env
         end
 
         # Called before a forced build. It should remove all the timestamp and

data/lib/autobuild/packages/orogen.rb

@@ -75,43 +75,8 @@ class << self
 
         attr_reader :orogen_options
 
-        # Path to the orogen tool
-        def self.orogen_bin(full_path = false)
-            if @orogen_bin
-                @orogen_bin
-            else
-                program_name = Autobuild.tool('orogen')
-                if orogen_path = ENV['PATH'].split(':').find { |p| File.file?(File.join(p, program_name)) }
-                    @orogen_bin = File.join(orogen_path, program_name)
-                elsif !full_path
-                    program_name
-                end
-            end
-        end
-
-        # Path to the root of the orogen package
-        def self.orogen_root
-            if @orogen_root
-                @orogen_root
-            elsif orogen_bin = self.orogen_bin(true)
-                @orogen_root = File.expand_path('../lib', File.dirname(orogen_bin))
-            end
-        end
-
-        # The version of orogen, given as a string
-        #
-        # It is used to enable/disable some configuration features based on the
-        # orogen version string
-        def self.orogen_version
-            if !@orogen_version && root = orogen_root
-                version_file = File.join(root, 'orogen', 'version.rb')
-                version_line = File.readlines(version_file).grep(/VERSION\s*=\s*"/).first
-                if version_line =~ /.*=\s+"(.+)"$/
-                    @orogen_version = $1
-                end
-            end
-            @orogen_version
-        end
+        # The path to the orogen tool as resolved from {Package#full_env}
+        attr_reader :orogen_tool_path
 
         # Overrides the global Orocos.orocos_target for this particular package
         attr_writer :orocos_target
@@ -168,6 +133,8 @@ def orogen_file
         def initialize(*args, &config)
             super
 
+            @orogen_tool_path = nil
+            @orogen_version = nil
             @orocos_target = nil
             @orogen_options = []
         end
@@ -183,69 +150,44 @@ def update_environment
             env_add_path 'TYPELIB_RUBY_PLUGIN_PATH', typelib_plugin
         end
 
-        def prepare
-            # Check if someone provides the pkgconfig/orocos-rtt-TARGET package,
-            # and if so add it into our dependency list
-            if rtt = Autobuild::Package["pkgconfig/orocos-rtt-#{orocos_target}"]
-                if Autobuild.verbose
-                    message "orogen: found #{rtt.name} which provides the RTT"
+        # The version of orogen, given as a string
+        #
+        # It is used to enable/disable some configuration features based on the
+        # orogen version string
+        def orogen_version
+            if !@orogen_version && (root = orogen_root)
+                version_file = File.join(root, 'lib', 'orogen', 'version.rb')
+                version_line = File.readlines(version_file).grep(/VERSION\s*=\s*"/).first
+                if version_line =~ /.*=\s+"(.+)"$/
+                    @orogen_version = $1
                 end
-                depends_on rtt.name
-            end
-
-            # Find out where orogen is, and make sure the configurestamp depend
-            # on it. Ignore if orogen is too old to have a --base-dir option
-            if orogen_root = self.class.orogen_root
-                orogen_tree = source_tree(orogen_root)
             end
+            @orogen_version
+        end
 
-            # Check if there is an orogen package registered. If it is the case,
-            # simply depend on it. Otherwise, look out for orogen --base-dir
-            if Autobuild::Package['orogen']
-                depends_on "orogen"
-            elsif orogen_tree
-                file genstamp => orogen_tree
+        def orogen_root
+            if orogen_tool_path
+                root = File.expand_path(File.join('..', '..'), orogen_tool_path)
+                if File.directory?(File.join(root, 'lib', 'orogen'))
+                    root
+                end
             end
+        end
 
+        def prepare
             file configurestamp => genstamp
+            stamps = dependencies.map { |pkg| Autobuild::Package[pkg].installstamp }
 
-            # Cache the orogen file name
-            @orogen_file ||= self.orogen_file
-
-            file genstamp => source_tree(srcdir) do
-                needs_regen = true
-                if File.file?(genstamp)
-                    genstamp_mtime = File.stat(genstamp).mtime
-                    dependency_updated = dependencies.any? do |dep|
-                        !File.file?(Package[dep].installstamp) ||
-                            File.stat(Package[dep].installstamp).mtime > genstamp_mtime
-                    end
-                    needs_regen = dependency_updated || !generation_uptodate?
-                end
-
-                if needs_regen
-                    isolate_errors { regen }
-                end
+            file genstamp => [*stamps, source_tree(srcdir)] do
+                isolate_errors { regen }
             end
 
             with_doc
 
             super
-
-            dependencies.each do |p|
-                file genstamp => Package[p].installstamp
-            end
         end
-        def genstamp; File.join(srcdir, '.orogen', 'orogen-stamp') end
 
-        def guess_ruby_name
-            if Autobuild.programs['ruby']
-                Autobuild.tool('ruby')
-            else
-                ruby_bin = RbConfig::CONFIG['RUBY_INSTALL_NAME']
-                Autobuild.programs['ruby'] = ruby_bin
-            end
-        end
+        def genstamp; File.join(srcdir, '.orogen', 'orogen-stamp') end
 
         def add_cmd_to_cmdline(cmd, cmdline)
             if cmd =~ /^([\w-]+)/
@@ -276,14 +218,22 @@ def regen
                 end
             end
 
-            if (version = Orogen.orogen_version)
-                if version >= "1.0"
-                    cmdline << "--parallel-build=#{parallel_build_level}"
-                end
-                if version >= "1.1"
-                    cmdline << "--type-export-policy=#{Orogen.default_type_export_policy}"
-                    cmdline << "--transports=#{Orogen.transports.sort.uniq.join(",")}"
-                end
+            @orogen_tool_path = find_in_path 'orogen'
+            if !orogen_tool_path
+                raise ArgumentError, "cannot find 'orogen' in #{resolved_env['PATH']}"
+            end
+
+            version = orogen_version
+            if !version
+                raise ArgumentError, "cannot determine the orogen version"
+            end
+
+            if (version >= "1.0")
+                cmdline << "--parallel-build=#{parallel_build_level}"
+            end
+            if (version >= "1.1")
+                cmdline << "--type-export-policy=#{Orogen.default_type_export_policy}"
+                cmdline << "--transports=#{Orogen.transports.sort.uniq.join(",")}"
             end
 
             # Now, add raw options
@@ -317,13 +267,10 @@ def regen
             # target says
             needs_regen ||= !generation_uptodate?
 
-            # Finally, verify that orogen itself did not change
-            needs_regen ||= (Rake::Task[Orogen.orogen_root].timestamp > Rake::Task[genstamp].timestamp)
-
             if needs_regen
                 progress_start "generating oroGen %s", :done_message => 'generated oroGen %s' do
                     in_dir(srcdir) do
-                        run 'orogen', guess_ruby_name, '-S', self.class.orogen_bin, *cmdline
+                        run 'orogen', Autobuild.tool('ruby'), '-S', orogen_tool_path, *cmdline
                         File.open(genstamp, 'w') do |io|
                             io.print cmdline.join("\n")
                         end

data/lib/autobuild/packages/ruby.rb

@@ -9,6 +9,8 @@ class Ruby < ImporterPackage
         # The Rake task that is used to run tests. Defaults to "test".
         # Set to nil to disable tests for this package
         attr_accessor :rake_test_task
+        # Options that should be passed to the rake task
+        attr_accessor :rake_test_options
         # The Rake task that is used to run cleanup. Defaults to "clean".
         # Set to nil to disable tests for this package
         attr_accessor :rake_clean_task
@@ -18,6 +20,7 @@ def initialize(*args)
             self.rake_doc_task   = "redocs"
             self.rake_clean_task   = "clean"
             self.rake_test_task  = "test"
+            self.rake_test_options = []
 
             super
             exclude << /\.so$/
@@ -41,8 +44,8 @@ def with_tests
             test_utility.task do
                 progress_start "running tests for %s", :done_message => 'tests passed for %s' do
                     run 'test',
-                        Autobuild.tool_in_path('ruby'), '-S', Autobuild.tool('rake'), rake_test_task,
-                        :working_directory => srcdir
+                        Autobuild.tool_in_path('ruby'), '-S', Autobuild.tool('rake'), rake_test_task, *rake_test_options,
+                        working_directory: srcdir
                 end
             end
         end

data/lib/autobuild/subcommand.rb

@@ -402,8 +402,16 @@ def self.run(target, phase, *command)
         end
 
         if !status.exitstatus || status.exitstatus > 0
-            raise Failed.new(status.exitstatus, nil),
-                "'#{command.join(' ')}' returned status #{status.exitstatus}"
+            if status.termsig == 2 # SIGINT == 2
+                raise Interrupt, "subcommand #{command.join(' ')} interrupted"
+            end
+            if status.termsig
+                raise Failed.new(status.exitstatus, nil),
+                    "'#{command.join(' ')}' terminated by signal #{status.termsig}"
+            else
+                raise Failed.new(status.exitstatus, nil),
+                    "'#{command.join(' ')}' returned status #{status.exitstatus}"
+            end
         end
 
         duration = Time.now - start_time

data/lib/autobuild/tools.rb

@@ -21,19 +21,17 @@ def tool(name)
             programs[name.to_sym] || programs[name.to_s] || name.to_s
         end
 
-        def find_in_path(file)
-            path = ENV['PATH'].split(File::PATH_SEPARATOR).
-                find { |dir| File.exist?(File.join(dir, file)) }
-            if path
-                return File.join(path, file)
-            end
+        # Find a file in a given path-like variable
+        def find_in_path(file, envvar = 'PATH')
+            env.find_in_path(file, envvar)
         end
 
         # Resolves the absolute path to a given tool
         def tool_in_path(name)
             path, path_name, path_env = programs_in_path[name]
             current = tool(name)
-            if path_env != ENV['PATH'] || path_name != current
+            env_PATH = env.resolved_env['PATH']
+            if (path_env != env_PATH) || (path_name != current)
                 # Delete the current entry given that it is invalid
                 programs_in_path.delete(name)
                 if current[0, 1] == "/"
@@ -53,7 +51,7 @@ def tool_in_path(name)
                 elsif !File.executable?(path)
                     raise ArgumentError, "tool #{name} is set to #{current}, but this resolves to #{path} which is not executable"
                 end
-                programs_in_path[name] = [path, current, ENV['PATH']]
+                programs_in_path[name] = [path, current, env_PATH]
             end
 
             return path

data/lib/autobuild/utility.rb

@@ -11,7 +11,15 @@ class Utility
         #   nil, will use the package's source directory
         attr_accessor :source_ref_dir
 
-        def initialize(name, package)
+        # Whether #install should be called even if the task failed
+        #
+        # The default is false. Set it to true for instance if the utility
+        # results are a report of the success/errors (e.g. test run results)
+        def install_on_error?
+            @install_on_error
+        end
+
+        def initialize(name, package, install_on_error: false)
             @name = name
             @task = nil
             @package = package
@@ -20,6 +28,7 @@ def initialize(name, package)
             @source_ref_dir = nil
             @source_dir = nil
             @target_dir = nil
+            @install_on_error = !!install_on_error
         end
 
         # Directory in which the utility will generate some files The
@@ -54,6 +63,8 @@ def source_dir
         def target_dir
             if @target_dir
                 File.expand_path(@target_dir, File.expand_path(Autobuild.send("#{name}_prefix") || name,  package.prefix))
+            else
+                File.join(package.logdir, "#{name}-results", package.name)
             end
         end
 
@@ -95,6 +106,10 @@ def call_task_block
         rescue Interrupt
             raise
         rescue ::Exception => e
+            if install_on_error? && !@installed && target_dir
+                install
+            end
+
             if Autobuild.send("pass_#{name}_errors")
                 raise
             else
@@ -146,6 +161,7 @@ def install
             FileUtils.rm_rf   target_dir
             FileUtils.mkdir_p File.dirname(target_dir)
             FileUtils.cp_r    source_dir, target_dir
+            Autoproj.message "  copied #{name} results for #{package.name} to #{target_dir}"
 
             @installed = true
         end

data/lib/autobuild/version.rb

@@ -1,5 +1,5 @@
 module Autobuild
-    VERSION = "1.10.0.rc13" unless defined? Autobuild::VERSION
+    VERSION = "1.10.0.rc14" unless defined? Autobuild::VERSION
 end
 
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: autobuild
 version: !ruby/object:Gem::Version
-  version: 1.10.0.rc13
+  version: 1.10.0.rc14
 platform: ruby
 authors:
 - Sylvain Joyeux
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-11 00:00:00.000000000 Z
+date: 2016-08-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -174,6 +174,7 @@ files:
 - lib/autobuild/import/archive.rb
 - lib/autobuild/import/cvs.rb
 - lib/autobuild/import/darcs.rb
+- lib/autobuild/import/git-lfs.rb
 - lib/autobuild/import/git.rb
 - lib/autobuild/import/hg.rb
 - lib/autobuild/import/svn.rb
@@ -227,3 +228,4 @@ signing_key:
 specification_version: 4
 summary: Library to handle build systems and import mechanisms
 test_files: []
+has_rdoc: