autobuild 1.19.0 → 1.20.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2db3dc0a2d21505b88966e48b4019800e42f39e4a44cbd113a874a4aefad8dc8
-  data.tar.gz: 3f19bf595f8c258899f1cfd3636257e9c58bd0ca02680a1e205d12d645cb9354
+  metadata.gz: 3b347c81cc5ac09e4f967df3dd5f53bca82fb3ba2a1a4a2e76b1b2d20ba19869
+  data.tar.gz: 6eaa54db5306f069ce5e9809b708df1bb4c5def84dc1553c953a3e38319cbf26
 SHA512:
-  metadata.gz: ac1af6ad08365cda04b28c52e8283fdaf2b4f56ae0b320961fb8600c7126e242c7e83569d8ac8f6722b441efc5f10d18b90a576a76efee1dc53c9c442327562f
-  data.tar.gz: e716f6c428ea5c6384465697abd8124a9e6aa739ab78025129beec71dd4ec14630e81804f0109a6707575713e69d86fbcd2d16fea4031cff1953ae6ff702fcf9
+  metadata.gz: ccefa69f82809031debaeee77adde985c2de4d88c738e9b439cf7e839bc511f2f4c757486625f88a91541d97c16566217a544831c35924ea76cae98920d9f59d
+  data.tar.gz: 9f4b9b5c38e9072104dc052c630ca7a49a915331526cdbc624d2ef725eef44987b97b97667ebcafead9afb145fcbb3cee5a921f699aed101ec99efd611c28352

data/autobuild.gemspec

@@ -33,4 +33,5 @@ Gem::Specification.new do |s|
     s.add_development_dependency "flexmock", '~> 2.0', ">= 2.0.0"
     s.add_development_dependency "minitest", "~> 5.0", ">= 5.0"
     s.add_development_dependency "simplecov"
+    s.add_development_dependency "timecop"
 end

data/lib/autobuild/config.rb

@@ -352,7 +352,20 @@ def self.apply(packages, buildname = "autobuild", phases = [], options = Hash.ne
             invoker = Autobuild::RakeTaskParallelism.new(options[:parallel])
             Autobuild.parallel_task_manager = invoker
             phases.each do |phase|
-                invoker.invoke_parallel([Rake::Task["#{buildname}-#{phase}"]])
+                package_tasks = packages.each_with_object({}) do |pkg_name, h|
+                    h["#{pkg_name}-#{phase}"] = true
+                end
+                callback =
+                    if block_given?
+                        proc do |task|
+                            yield(task.package, phase) if package_tasks[task.name]
+                        end
+                    else
+                        proc { }
+                    end
+
+                invoker.invoke_parallel([Rake::Task["#{buildname}-#{phase}"]],
+                                        completion_callback: callback)
             end
         ensure
             Autobuild.parallel_task_manager = nil

data/lib/autobuild/configurable.rb

@@ -109,6 +109,7 @@ def prepare
 
             stamps = dependencies.map { |pkg| Autobuild::Package[pkg].installstamp }
             file configurestamp => stamps do
+                @install_invoked = true
                 isolate_errors do
                     ensure_dependencies_installed
                     configure
@@ -118,6 +119,7 @@ def prepare
             task "#{name}-prepare" => configurestamp
 
             file buildstamp => [srcdir, configurestamp] do
+                @install_invoked = true
                 isolate_errors do
                     ensure_dependencies_installed
                     build
@@ -132,7 +134,7 @@ def prepare
         def configure
             if File.exist?(builddir) && !File.directory?(builddir)
                 raise ConfigException.new(self, 'configure'),
-                    "#{builddir} already exists but is not a directory"
+                      "#{builddir} already exists but is not a directory"
             end
 
             FileUtils.mkdir_p builddir unless File.directory?(builddir)

data/lib/autobuild/import/git.rb

@@ -1199,7 +1199,8 @@ def checkout(package, _options = Hash.new)
                     repository, package.importdir, retry: true)
 
             update_remotes_configuration(package)
-            update(package, only_local: !remote_branch.start_with?("refs/"), reset: true)
+            update(package, only_local: !remote_branch.start_with?("refs/"),
+                            reset: :force)
             run_git(package, "submodule", "update", '--init') if with_submodules?
         end
 

data/lib/autobuild/importer.rb

@@ -107,7 +107,11 @@ def self.cache_dirs(type)
         # @return [Array<String>,nil]
         # @see .cache_dirs
         def self.default_cache_dirs
-            [@default_cache_dirs] if @default_cache_dirs ||= ENV['AUTOBUILD_CACHE_DIR']
+            if @default_cache_dirs
+                @default_cache_dirs
+            elsif (from_env = ENV['AUTOBUILD_CACHE_DIR'])
+                @default_cache_dirs = [from_env]
+            end
         end
 
         # Sets the cache directory for a given importer type

data/lib/autobuild/package.rb

@@ -663,6 +663,10 @@ def post_install(*args, &block)
             end
         end
 
+        def self_fingerprint
+            importer.fingerprint(self)
+        end
+
         # Returns a unique hash representing a state of the package and
         # its dependencies, if any dependency can't calculate its own
         # fingerprint the result will be nil
@@ -670,9 +674,13 @@ def post_install(*args, &block)
         def fingerprint(recursive: true, memo: {})
             return memo[name] if memo.key?(name)
 
-            self_fingerprint = importer.fingerprint(self)
+            self_fingerprint = self.self_fingerprint
             return unless self_fingerprint
-            return self_fingerprint if !recursive || dependencies.empty?
+            if dependencies.empty?
+                return (memo[name] = self_fingerprint)
+            elsif !recursive
+                return self_fingerprint
+            end
 
             dependency_fingerprints = dependencies.sort.map do |pkg_name|
                 pkg = Autobuild::Package[pkg_name]

data/lib/autobuild/packages/cmake.rb

@@ -542,5 +542,11 @@ def delete_obsolete_files
                 message "%s: removed #{counter} obsolete files from prefix (cmake)"
             end
         end
+
+        def self_fingerprint
+            return unless (base = super)
+            all_defines = self.class.defines.merge(self.defines).sort_by(&:first)
+            Digest::SHA1.hexdigest(base + all_defines.join(""))
+        end
     end
 end

data/lib/autobuild/parallel.rb

@@ -83,8 +83,9 @@ class ProcessingState
             attr_reader :queue
             attr_reader :priorities
 
-            def initialize(reverse_dependencies)
+            def initialize(reverse_dependencies, completion_callback: proc { })
                 @reverse_dependencies = reverse_dependencies
+                @completion_callback = completion_callback
                 @processed = Set.new
                 @active_tasks = Set.new
                 @priorities = Hash.new
@@ -143,6 +144,8 @@ def process_finished_task(task)
                         push(candidate, priorities[task])
                     end
                 end
+
+                @completion_callback.call(task)
             end
 
             def trivial_task?(task)
@@ -153,7 +156,7 @@ def trivial_task?(task)
 
         # Invokes the provided tasks. Unlike the rake code, this is a toplevel
         # algorithm that does not use recursion
-        def invoke_parallel(required_tasks)
+        def invoke_parallel(required_tasks, completion_callback: proc { })
             tasks = Set.new
             reverse_dependencies = Hash.new { |h, k| h[k] = Set.new }
             required_tasks.each do |t|
@@ -162,7 +165,8 @@ def invoke_parallel(required_tasks)
             # The queue is the set of tasks for which all prerequisites have
             # been successfully executed (or where not needed). I.e. it is the
             # set of tasks that can be queued for execution.
-            state = ProcessingState.new(reverse_dependencies)
+            state = ProcessingState.new(reverse_dependencies,
+                                        completion_callback: completion_callback)
             tasks.each do |t|
                 state.push(t) if state.ready?(t)
             end

data/lib/autobuild/progress_display.rb

@@ -9,16 +9,61 @@ def initialize(io, color: ::Autobuild.method(:color))
 
             @silent = false
             @color = color
-            @progress_enabled = true
             @display_lock = Mutex.new
+
+            @next_progress_display = Time.at(0)
+            @progress_mode = :single_line
+            @progress_period = 0.1
+        end
+
+        # Set the minimum time between two progress messages
+        #
+        # @see period
+        def progress_period=(period)
+            @progress_period = Float(period)
         end
 
-        attr_writer :silent
+        # Minimum time between two progress displays
+        #
+        # This does not affect normal messages
+        #
+        # @return [Float]
+        attr_reader :progress_period
+
+        # Valid progress modes
+        #
+        # @see progress_mode=
+        PROGRESS_MODES = %I[single_line newline off]
+
+        # Sets how progress messages will be displayed
+        #
+        # @param [String] the new mode. Can be either 'single_line', where a
+        #   progress message replaces the last one, 'newline' which displays
+        #   each on a new line or 'off' to disable progress messages altogether
+        def progress_mode=(mode)
+            mode = mode.to_sym
+            unless PROGRESS_MODES.include?(mode)
+                raise ArgumentError,
+                      "#{mode} is not a valid mode, expected one of "\
+                      "#{PROGRESS_MODES.join(", ")}"
+            end
+            @progress_mode = mode
+        end
+
+        # Return the current display mode
+        #
+        # @return [Symbol]
+        # @see mode=
+        attr_reader :progress_mode
 
         def silent?
             @silent
         end
 
+        def silent=(flag)
+            @silent = flag
+        end
+
         def silent
             silent = @silent
             @silent = true
@@ -27,10 +72,14 @@ def silent
             @silent = silent
         end
 
-        attr_writer :progress_enabled
+        # @deprecated use progress_mode= instead
+        def progress_enabled=(flag)
+            self.progress_mode = flag ? :single_line : :off
+        end
 
+        # Whether progress messages will be displayed at all
         def progress_enabled?
-            !@silent && @progress_enabled
+            !@silent && (@progress_mode != :off)
         end
 
         def message(message, *args, io: @io, force: false)
@@ -39,8 +88,11 @@ def message(message, *args, io: @io, force: false)
             io = args.pop if args.last.respond_to?(:to_io)
 
             @display_lock.synchronize do
-                io.print "#{@cursor.column(1)}#{@cursor.clear_screen_down}"\
-                    "#{@color.call(message, *args)}\n"
+                if @progress_mode == :single_line
+                    io.print @cursor.clear_screen_down
+                end
+                io.puts @color.call(message, *args)
+
                 io.flush if @io != io
                 display_progress
                 @io.flush
@@ -54,7 +106,7 @@ def progress_start(key, *args, done_message: nil)
             @progress_messages << [key, formatted_message]
             if progress_enabled?
                 @display_lock.synchronize do
-                    display_progress
+                    display_progress(consider_period: false)
                 end
             else
                 message "  #{formatted_message}"
@@ -113,32 +165,38 @@ def progress_done(key, display_last = true, message: nil)
             end
         end
 
-        def display_progress
+        def display_progress(consider_period: true)
             return unless progress_enabled?
+            return if consider_period && (@next_progress_display > Time.now)
 
-            formatted = format_grouped_messages(@progress_messages.map(&:last),
-                indent: "  ")
-            @io.print @cursor.clear_screen_down
-            @io.print formatted.join("\n")
-            if formatted.size > 1
-                @io.print "#{@cursor.up(formatted.size - 1)}#{@cursor.column(0)}"
+            formatted = format_grouped_messages(
+                @progress_messages.map(&:last),
+                indent: "  "
+            )
+            if @progress_mode == :newline
+                @io.print formatted.join("\n")
+                @io.print "\n"
             else
+                @io.print @cursor.clear_screen_down
+                @io.print formatted.join("\n")
+                @io.print @cursor.up(formatted.size - 1) if formatted.size > 1
                 @io.print @cursor.column(0)
             end
             @io.flush
+            @next_progress_display = Time.now + @progress_period
         end
 
         def find_common_prefix(msg, other_msg)
-            msg = msg.split(" ")
-            other_msg = other_msg.split(" ")
+            msg = msg.split(' ')
+            other_msg = other_msg.split(' ')
             msg.each_with_index do |token, idx|
                 if other_msg[idx] != token
                     prefix = msg[0..(idx - 1)].join(" ")
-                    prefix << " " unless prefix.empty?
+                    prefix << ' ' unless prefix.empty?
                     return prefix
                 end
             end
-            msg.join(" ")
+            msg.join(' ')
         end
 
         def group_messages(messages)

data/lib/autobuild/reporting.rb

@@ -47,10 +47,19 @@ def self.progress_display_enabled?
         @display.progress_enabled?
     end
 
+    # @deprecated use {progress_display_mode=} instead
     def self.progress_display_enabled=(value)
         @display.progress_enabled = value
     end
 
+    def self.progress_display_mode=(value)
+        @display.progress_mode = value
+    end
+
+    def self.progress_display_period=(value)
+        @display.progress_period = value
+    end
+
     def self.message(*args, **options)
         @display.message(*args, **options)
     end

data/lib/autobuild/utility.rb

@@ -104,16 +104,18 @@ def task(&block)
         def call_task_block
             @invoked = true
 
-            yield if block_given?
-            @success = true
+            begin
+                yield if block_given?
+                @success = true
+            rescue StandardError => e
+                install if install_on_error? && !@installed && target_dir
+                raise
+            end
 
             # Allow the user to install manually in the task
             # block
             install if !@installed && target_dir
-        rescue Interrupt
-            raise
-        rescue ::Exception => e
-            install if install_on_error? && !@installed && target_dir
+        rescue StandardError => e
             @success = false
 
             if Autobuild.send("pass_#{name}_errors")

data/lib/autobuild/version.rb

@@ -1,3 +1,3 @@
 module Autobuild
-    VERSION = "1.19.0".freeze unless defined? Autobuild::VERSION
+    VERSION = "1.20.0".freeze unless defined? Autobuild::VERSION
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: autobuild
 version: !ruby/object:Gem::Version
-  version: 1.19.0
+  version: 1.20.0
 platform: ruby
 authors:
 - Sylvain Joyeux
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-10-03 00:00:00.000000000 Z
+date: 2020-02-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pastel
@@ -180,6 +180,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Collection of classes to handle build systems (CMake, autotools, ...)
   and import mechanisms (tarballs, CVS, SVN, git, ...). It also offers a Rake integration
   to import and build such software packages. It is the backbone of the autoproj (http://rock-robotics.org/autoproj)