autobuild 1.20.0 → 1.23.0

data/lib/autobuild/parallel.rb

@@ -4,15 +4,10 @@ module Autobuild
     # Since autobuild does not use task arguments, we don't support them for
     # simplicity
     class RakeTaskParallelism
-        attr_reader :available_workers
-        attr_reader :finished_workers
-        attr_reader :workers
-
-        attr_reader :job_server
+        attr_reader :available_workers, :finished_workers, :workers, :job_server
 
         class JobServer
-            attr_reader :rio
-            attr_reader :wio
+            attr_reader :rio, :wio
 
             def initialize(level)
                 @rio, @wio = IO.pipe
@@ -76,14 +71,10 @@ module Autobuild
         end
 
         class ProcessingState
-            attr_reader :reverse_dependencies
-            attr_reader :processed
-            attr_reader :started_packages
-            attr_reader :active_tasks
-            attr_reader :queue
-            attr_reader :priorities
-
-            def initialize(reverse_dependencies, completion_callback: proc { })
+            attr_reader :reverse_dependencies, :processed, :started_packages,
+                        :active_tasks, :queue, :priorities
+
+            def initialize(reverse_dependencies, completion_callback: proc {})
                 @reverse_dependencies = reverse_dependencies
                 @completion_callback = completion_callback
                 @processed = Set.new
@@ -97,7 +88,8 @@ module Autobuild
                 if task.respond_to?(:package)
                     started_packages[task.package] ||= -started_packages.size
                     queue[task] = started_packages[task.package]
-                else queue[task] = base_priority
+                else
+                    queue[task] = base_priority
                 end
             end
 
@@ -156,7 +148,7 @@ module Autobuild
 
         # Invokes the provided tasks. Unlike the rake code, this is a toplevel
         # algorithm that does not use recursion
-        def invoke_parallel(required_tasks, completion_callback: proc { })
+        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|

data/lib/autobuild/pkgconfig.rb

@@ -5,6 +5,7 @@ class PkgConfig
 
         def initialize(name)
             @name = name
+            super()
         end
 
         def to_s

data/lib/autobuild/progress_display.rb

@@ -1,3 +1,6 @@
+require "concurrent/atomic/atomic_boolean"
+require "concurrent/array"
+
 module Autobuild
     # Management of the progress display
     class ProgressDisplay
@@ -5,7 +8,7 @@ module Autobuild
             @io = io
             @cursor = TTY::Cursor
             @last_formatted_progress = []
-            @progress_messages = []
+            @progress_messages = Concurrent::Array.new
 
             @silent = false
             @color = color
@@ -14,6 +17,15 @@ module Autobuild
             @next_progress_display = Time.at(0)
             @progress_mode = :single_line
             @progress_period = 0.1
+
+            @message_queue = Queue.new
+            @forced_progress_display = Concurrent::AtomicBoolean.new(false)
+        end
+
+        def synchronize(&block)
+            result = @display_lock.synchronize(&block)
+            refresh_display
+            result
         end
 
         # Set the minimum time between two progress messages
@@ -33,7 +45,7 @@ module Autobuild
         # Valid progress modes
         #
         # @see progress_mode=
-        PROGRESS_MODES = %I[single_line newline off]
+        PROGRESS_MODES = %I[single_line newline off].freeze
 
         # Sets how progress messages will be displayed
         #
@@ -45,7 +57,7 @@ module Autobuild
             unless PROGRESS_MODES.include?(mode)
                 raise ArgumentError,
                       "#{mode} is not a valid mode, expected one of "\
-                      "#{PROGRESS_MODES.join(", ")}"
+                      "#{PROGRESS_MODES.join(', ')}"
             end
             @progress_mode = mode
         end
@@ -60,9 +72,7 @@ module Autobuild
             @silent
         end
 
-        def silent=(flag)
-            @silent = flag
-        end
+        attr_writer :silent
 
         def silent
             silent = @silent
@@ -86,17 +96,9 @@ module Autobuild
             return if silent? && !force
 
             io = args.pop if args.last.respond_to?(:to_io)
+            @message_queue << [message, args, io]
 
-            @display_lock.synchronize do
-                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
-            end
+            refresh_display
         end
 
         def progress_start(key, *args, done_message: nil)
@@ -105,13 +107,13 @@ module Autobuild
             formatted_message = @color.call(*args)
             @progress_messages << [key, formatted_message]
             if progress_enabled?
-                @display_lock.synchronize do
-                    display_progress(consider_period: false)
-                end
+                @forced_progress_display.make_true
             else
                 message "  #{formatted_message}"
             end
 
+            refresh_display
+
             if block_given?
                 begin
                     result = yield
@@ -125,46 +127,67 @@ module Autobuild
         end
 
         def progress(key, *args)
-            @display_lock.synchronize do
-                found = false
-                @progress_messages.map! do |msg_key, msg|
-                    if msg_key == key
-                        found = true
-                        [msg_key, @color.call(*args)]
-                    else
-                        [msg_key, msg]
-                    end
+            found = false
+            @progress_messages.map! do |msg_key, msg|
+                if msg_key == key
+                    found = true
+                    [msg_key, @color.call(*args)]
+                else
+                    [msg_key, msg]
                 end
-                @progress_messages << [key, @color.call(*args)] unless found
-                display_progress
             end
+            @progress_messages << [key, @color.call(*args)] unless found
+
+            refresh_display
         end
 
         def progress_done(key, display_last = true, message: nil)
-            changed = @display_lock.synchronize do
-                current_size = @progress_messages.size
-                @progress_messages.delete_if do |msg_key, msg|
-                    if msg_key == key
-                        message = msg if display_last && !message
-                        true
-                    end
+            current_size = @progress_messages.size
+            @progress_messages.delete_if do |msg_key, msg|
+                if msg_key == key
+                    message = msg if display_last && !message
+                    true
                 end
-                current_size != @progress_messages.size
             end
+            changed = current_size != @progress_messages.size
 
             if changed
                 if message
                     message("  #{message}")
-                    # Note: message calls display_progress already
+                    # NOTE: message updates the display already
                 else
-                    @display_lock.synchronize do
-                        display_progress
-                    end
+                    refresh_display
                 end
                 true
             end
         end
 
+        def refresh_display
+            return unless @display_lock.try_lock
+
+            begin
+                refresh_display_under_lock
+            ensure
+                @display_lock.unlock
+            end
+        end
+
+        def refresh_display_under_lock
+            # Display queued messages
+            until @message_queue.empty?
+                message, args, io = @message_queue.pop
+                io.print @cursor.clear_screen_down if @progress_mode == :single_line
+                io.puts @color.call(message, *args)
+
+                io.flush if @io != io
+            end
+
+            # And re-display the progress
+            display_progress(consider_period: @forced_progress_display.false?)
+            @forced_progress_display.make_false
+            @io.flush
+        end
+
         def display_progress(consider_period: true)
             return unless progress_enabled?
             return if consider_period && (@next_progress_display > Time.now)
@@ -223,7 +246,8 @@ module Autobuild
                             groups.last[1] = (current_group.first..group_end_index)
                             groups << [prefix, [idx, other_idx]]
                             grouping = true
-                        else break
+                        else
+                            break
                         end
                     end
                 end

data/lib/autobuild/rake_task_extension.rb

@@ -1,5 +1,10 @@
 module Autobuild
     module RakeTaskExtension
+        def initialize(*, **)
+            super
+            @disabled = false
+        end
+
         def already_invoked?
             @already_invoked
         end
@@ -19,6 +24,7 @@ module Autobuild
         end
     end
 end
+
 class Rake::Task # rubocop:disable Style/ClassAndModuleChildren
     include Autobuild::RakeTaskExtension
 end

data/lib/autobuild/reporting.rb

@@ -47,6 +47,10 @@ module Autobuild
         @display.progress_enabled?
     end
 
+    def self.progress_display_synchronize(&block)
+        @display.synchronize(&block)
+    end
+
     # @deprecated use {progress_display_mode=} instead
     def self.progress_display_enabled=(value)
         @display.progress_enabled = value
@@ -101,8 +105,8 @@ module Autobuild
                 interrupted = e
             rescue Autobuild::Exception => e
                 return report_finish_on_error([e],
-                    on_package_failures: on_package_failures,
-                    interrupted_by: interrupted)
+                                              on_package_failures: on_package_failures,
+                                              interrupted_by: interrupted)
             end
 
             # If ignore_erorrs is true, check if some packages have failed
@@ -114,8 +118,8 @@ module Autobuild
             end
 
             report_finish_on_error(errors,
-                on_package_failures: on_package_failures,
-                interrupted_by: interrupted)
+                                   on_package_failures: on_package_failures,
+                                   interrupted_by: interrupted)
         end
 
         # @api private
@@ -126,7 +130,8 @@ module Autobuild
         # :exit if debug is false, or :raise if it is true
         def self.default_report_on_package_failures
             if Autobuild.debug then :raise
-            else :exit
+            else
+                :exit
             end
         end
 
@@ -159,14 +164,15 @@ module Autobuild
                 raise interrupted_by if interrupted_by
 
                 e = if errors.size == 1 then errors.first
-                    else CompositeException.new(errors)
+                    else
+                        CompositeException.new(errors)
                     end
                 raise e
             elsif %i[report_silent report].include?(on_package_failures)
                 if interrupted_by
                     raise interrupted_by
                 else
-                    return errors
+                    errors
                 end
             elsif %i[exit exit_silent].include?(on_package_failures)
                 exit 1
@@ -240,8 +246,8 @@ module Autobuild
             scaled_size = (size / scale)
             if scaled_size > 1
                 return format("%3.1<scaled>f%<scale_name>s",
-                    scaled: scaled_size,
-                    scale_name: name)
+                              scaled: scaled_size,
+                              scale_name: name)
             end
         end
     end

data/lib/autobuild/subcommand.rb

@@ -161,6 +161,7 @@ module Autobuild::Subprocess # rubocop:disable Style/ClassAndModuleChildren
         def initialize(status, do_retry)
             @status = status
             @retry = do_retry
+            super()
         end
     end
 
@@ -222,12 +223,14 @@ module Autobuild::Subprocess # rubocop:disable Style/ClassAndModuleChildren
 
         if command.last.kind_of?(Hash)
             options = command.pop
-            options = Kernel.validate_options options,
+            options = Kernel.validate_options(
+                options,
                 input: nil, working_directory: nil, retry: false,
                 input_streams: [],
                 env: ENV.to_hash,
                 env_inherit: true,
                 encoding: 'BINARY'
+            )
 
             input_streams << File.open(options[:input]) if options[:input]
             input_streams.concat(options[:input_streams]) if options[:input_streams]
@@ -248,15 +251,16 @@ module Autobuild::Subprocess # rubocop:disable Style/ClassAndModuleChildren
         end
         logdir = if target.respond_to?(:logdir)
                      target.logdir
-                 else Autobuild.logdir
+                 else
+                     Autobuild.logdir
                  end
 
         if target.respond_to?(:working_directory)
             options[:working_directory] ||= target.working_directory
         end
 
-        logname = File.join(logdir, "#{target_name.gsub(/[:]/, '_')}-"\
-            "#{phase.to_s.gsub(/[:]/, '_')}.log")
+        logname = File.join(logdir, "#{target_name.gsub(/:/, '_')}-"\
+            "#{phase.to_s.gsub(/:/, '_')}.log")
         unless File.directory?(File.dirname(logname))
             FileUtils.mkdir_p File.dirname(logname)
         end
@@ -268,7 +272,8 @@ module Autobuild::Subprocess # rubocop:disable Style/ClassAndModuleChildren
 
         open_flag = if Autobuild.keep_oldlogs then 'a'
                     elsif Autobuild.registered_logfile?(logname) then 'a'
-                    else 'w'
+                    else
+                        'w'
                     end
         open_flag << ":BINARY"
 
@@ -312,8 +317,9 @@ module Autobuild::Subprocess # rubocop:disable Style/ClassAndModuleChildren
             if Autobuild.windows?
                 Dir.chdir(options[:working_directory]) do
                     unless system(*command)
-                        raise Failed.new($CHILD_STATUS.exitstatus, nil),
-                            "'#{command.join(' ')}' returned status #{status.exitstatus}"
+                        exit_code = $CHILD_STATUS.exitstatus
+                        raise Failed.new(exit_code, nil),
+                              "'#{command.join(' ')}' returned status #{exit_code}"
                     end
                 end
                 return # rubocop:disable Lint/NonLocalExitFromIterator
@@ -322,7 +328,6 @@ module Autobuild::Subprocess # rubocop:disable Style/ClassAndModuleChildren
             cwrite.fcntl(Fcntl::F_SETFD, Fcntl::FD_CLOEXEC)
 
             pid = fork do
-                begin
                     logfile.puts "in directory #{options[:working_directory] || Dir.pwd}"
 
                     cwrite.sync = true
@@ -340,20 +345,19 @@ module Autobuild::Subprocess # rubocop:disable Style/ClassAndModuleChildren
                     end
 
                     exec(env, *command,
-                        chdir: options[:working_directory] || Dir.pwd,
-                        close_others: false)
-                rescue Errno::ENOENT
+                         chdir: options[:working_directory] || Dir.pwd,
+                         close_others: false)
+            rescue Errno::ENOENT
                     cwrite.write([CONTROL_COMMAND_NOT_FOUND].pack('I'))
                     exit(100)
-                rescue Interrupt
+            rescue Interrupt
                     cwrite.write([CONTROL_INTERRUPT].pack('I'))
                     exit(100)
-                rescue ::Exception => e
+            rescue ::Exception => e
                     STDERR.puts e
                     STDERR.puts e.backtrace.join("\n  ")
                     cwrite.write([CONTROL_UNEXPECTED].pack('I'))
                     exit(100)
-                end
             end
 
             readbuffer = StringIO.new
@@ -372,7 +376,7 @@ module Autobuild::Subprocess # rubocop:disable Style/ClassAndModuleChildren
                     end
                 rescue Errno::ENOENT => e
                     raise Failed.new(nil, false),
-                        "cannot open input files: #{e.message}", retry: false
+                          "cannot open input files: #{e.message}", retry: false
                 end
                 pwrite.close
             end
@@ -382,15 +386,14 @@ module Autobuild::Subprocess # rubocop:disable Style/ClassAndModuleChildren
             value = cread.read(4)
             if value
                 # An error occured
-                value = value.unpack('I').first
-                if value == CONTROL_COMMAND_NOT_FOUND
-                    raise Failed.new(nil, false),
-                        "command '#{command.first}' not found"
-                elsif value == CONTROL_INTERRUPT
+                value = value.unpack1('I')
+                case value
+                when CONTROL_COMMAND_NOT_FOUND
+                    raise Failed.new(nil, false), "command '#{command.first}' not found"
+                when CONTROL_INTERRUPT
                     raise Interrupt, "command '#{command.first}': interrupted by user"
                 else
-                    raise Failed.new(nil, false),
-                        "something unexpected happened"
+                    raise Failed.new(nil, false), "something unexpected happened"
                 end
             end
 
@@ -439,10 +442,10 @@ module Autobuild::Subprocess # rubocop:disable Style/ClassAndModuleChildren
 
             if status.termsig
                 raise Failed.new(status.exitstatus, nil),
-                    "'#{command.join(' ')}' terminated by signal #{status.termsig}"
+                      "'#{command.join(' ')}' terminated by signal #{status.termsig}"
             else
                 raise Failed.new(status.exitstatus, nil),
-                    "'#{command.join(' ')}' returned status #{status.exitstatus}"
+                      "'#{command.join(' ')}' returned status #{status.exitstatus}"
             end
         end
 
@@ -458,9 +461,10 @@ module Autobuild::Subprocess # rubocop:disable Style/ClassAndModuleChildren
         subcommand_output
     rescue Failed => e
         error = Autobuild::SubcommandFailed.new(target, command.join(" "),
-            logname, e.status, subcommand_output)
+                                                logname, e.status, subcommand_output)
         error.retry = if e.retry?.nil? then options[:retry]
-                      else e.retry?
+                      else
+                          e.retry?
                       end
         error.phase = phase
         raise error, e.message

data/lib/autobuild/test_utility.rb

@@ -24,7 +24,8 @@ module Autobuild
         def coverage_enabled?
             if @coverage_enabled.nil?
                 TestUtility.coverage_enabled?
-            else @coverage_enabled
+            else
+                @coverage_enabled
             end
         end
 
@@ -53,7 +54,8 @@ module Autobuild
             if @coverage_source_dir
                 relative = if package.respond_to?(:builddir)
                                package.builddir
-                           else package.srcdir
+                           else
+                               package.srcdir
                            end
                 File.expand_path(@coverage_source_dir, relative)
             end
@@ -73,7 +75,8 @@ module Autobuild
         def coverage_target_dir
             if @coverage_target_dir
                 File.expand_path(@coverage_target_dir, package.prefix)
-            else File.join(target_dir, 'coverage')
+            elsif (target_dir = self.target_dir)
+                File.join(target_dir, 'coverage')
             end
         end
 

data/lib/autobuild/timestamps.rb

@@ -58,8 +58,7 @@ module Autobuild
     class SourceTreeTask < Rake::Task
         attr_accessor :exclude
 
-        attr_reader :newest_file
-        attr_reader :newest_time
+        attr_reader :newest_file, :newest_time
 
         def initialize(*args, &block)
             @exclude = Autobuild.ignored_files.dup
@@ -71,10 +70,11 @@ module Autobuild
 
             @newest_file, @newest_time =
                 Autobuild.tree_timestamp(name,
-                    %r{(?:^|/)(?:CVS|_darcs|\.svn)$}, *@exclude)
+                                         %r{(?:^|/)(?:CVS|_darcs|\.svn)$}, *@exclude)
             @newest_time
         end
     end
+
     def self.source_tree(path, &block)
         task = SourceTreeTask.define_task(path)
         block&.call(task)

data/lib/autobuild/utility.rb

@@ -30,6 +30,7 @@ module Autobuild
             @target_dir = nil
             @install_on_error = install_on_error
 
+            @no_results = false
             @invoked = false
             @success = false
             @installed = false
@@ -58,6 +59,23 @@ module Autobuild
         #   not install anything
         attr_writer :target_dir
 
+        # Controls whether this utility generates results or not
+        #
+        # By default, Autobuild assumes that utilities generate report or
+        # artifact files, that are saved in {#target_dir}. Set this flag to
+        # true to disable this behavior, in which case the only report will
+        # be the console output during run
+        #
+        # @see no_results?
+        attr_writer :no_results
+
+        # Whether this utility generates results or not
+        #
+        # @see no_results=
+        def no_results?
+            @no_results
+        end
+
         # Absolute path to where the utility product files have to be installed.
         # Returns nil if {target_dir} is not set.
         #
@@ -66,7 +84,7 @@ module Autobuild
             if @target_dir
                 utility_prefix = Autobuild.send("#{name}_prefix") || name
                 File.expand_path(@target_dir,
-                    File.expand_path(utility_prefix, package.prefix))
+                                 File.expand_path(utility_prefix, package.prefix))
             else
                 File.join(package.logdir, "#{name}-results", package.name)
             end
@@ -108,13 +126,13 @@ module Autobuild
                 yield if block_given?
                 @success = true
             rescue StandardError => e
-                install if install_on_error? && !@installed && target_dir
+                install if install_on_error? && !@installed && !no_results?
                 raise
             end
 
             # Allow the user to install manually in the task
             # block
-            install if !@installed && target_dir
+            install if !@installed && !no_results?
         rescue StandardError => e
             @success = false
 
@@ -138,7 +156,7 @@ module Autobuild
         #
         # @return [Boolean]
         def available?
-            @available && (source_dir && @task)
+            @available && @task && (no_results? || source_dir)
         end
 
         # True if this utility should be executed

data/lib/autobuild/version.rb

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

data/lib/autobuild.rb

@@ -17,11 +17,9 @@ require 'etc'
 require 'find'
 require 'pathname'
 require 'shellwords'
-require 'find'
 require 'rake/tasklib'
 require 'fileutils'
 require 'optparse'
-require 'rake'
 require 'singleton'
 require 'pastel'
 require 'tty-prompt'
@@ -43,7 +41,6 @@ require 'autobuild/config'
 require 'autobuild/importer'
 require 'autobuild/import/cvs'
 require 'autobuild/import/darcs'
-require 'autobuild/importer'
 require 'autobuild/import/git'
 require 'autobuild/import/hg'
 require 'autobuild/import/svn'