autobuild 1.20.0 → 1.23.0

data/lib/autobuild/importer.rb

@@ -203,7 +203,8 @@ module Autobuild
 
             patches_fingerprint_string = patches_fingerprint(package)
             if patches_fingerprint_string
-                Digest::SHA1.hexdigest(vcs_fingerprint_string + patches_fingerprint_string)
+                Digest::SHA1.hexdigest(vcs_fingerprint_string +
+                                       patches_fingerprint_string)
             elsif patches.empty?
                 vcs_fingerprint_string
             end
@@ -211,16 +212,19 @@ module Autobuild
 
         # basic fingerprint of the package and its dependencies
         def vcs_fingerprint(package)
-            #each importer type should implement its own 
-            Autoproj.warn "Fingerprint in #{package.name} has not been implemented for this type of packages, results should be discarded"
-            return nil
+            # each importer type should implement its own
+            Autoproj.warn "Fingerprint in #{package.name} has not been implemented "\
+                          "for this type of packages, results should be discarded"
+            nil
         end
 
         # fingerprint for patches associated to this package
         def patches_fingerprint(package)
             cur_patches = currently_applied_patches(package)
-            cur_patches.map(&:shift) #leave only level and source information
-            Digest::SHA1.hexdigest(cur_patches.sort.flatten.join("")) if !patches.empty? && cur_patches
+            cur_patches.map(&:shift) # leave only level and source information
+            if !patches.empty? && cur_patches
+              Digest::SHA1.hexdigest(cur_patches.sort.flatten.join(""))
+            end
         end
 
         # Sets the number of times update / checkout should be retried before giving
@@ -314,12 +318,10 @@ module Autobuild
         end
 
         # Enumerate the post-import hooks for this importer
-        def each_post_hook(error: false)
+        def each_post_hook(error: false, &block)
             return enum_for(__method__, error: false) unless block_given?
 
-            self.class.each_post_hook(error: error) do |callback|
-                yield(callback)
-            end
+            self.class.each_post_hook(error: error, &block)
 
             post_hooks.each do |hook|
                 yield(hook.callback) if hook.always || !error
@@ -355,11 +357,12 @@ module Autobuild
                 message = Autobuild.color('interrupted', :red)
                 if last_error
                     raise last_error
-                else raise
+                else
+                    raise
                 end
-            rescue ::Exception => original_error
+            rescue ::Exception => e
                 message = Autobuild.color('update failed', :red)
-                last_error = original_error
+                last_error = e
                 # If the package is patched, it might be that the update
                 # failed because we needed to unpatch first. Try it out
                 #
@@ -378,11 +381,11 @@ module Autobuild
                     rescue Interrupt
                         raise
                     rescue ::Exception
-                        raise original_error
+                        raise e
                     end
                 end
 
-                retry_count = update_retry_count(original_error, retry_count)
+                retry_count = update_retry_count(e, retry_count)
                 raise unless retry_count
 
                 package.message "update failed in #{package.importdir}, "\
@@ -399,20 +402,21 @@ module Autobuild
             fallback(e, package, :import, package)
         end
 
-        def perform_checkout(package, options = Hash.new)
+        def perform_checkout(package, **options)
             last_error = nil
             package.progress_start "checking out %s", :done_message => 'checked out %s' do
                 retry_count = 0
                 begin
-                    checkout(package, options)
+                    checkout(package, **options)
                     execute_post_hooks(package)
                 rescue Interrupt
                     if last_error then raise last_error
-                    else raise
+                    else
+                        raise
                     end
-                rescue ::Exception => original_error
-                    last_error = original_error
-                    retry_count = update_retry_count(original_error, retry_count)
+                rescue ::Exception => e
+                    last_error = e
+                    retry_count = update_retry_count(e, retry_count)
                     raise unless retry_count
 
                     package.message "checkout of %s failed, "\
@@ -456,31 +460,26 @@ module Autobuild
         #   ID is given will, in this mode, reset the repository to the requested ID
         #   (if that does not involve losing commits). Otherwise, it will only
         #   ensure that the requested commit ID is present in the current HEAD.
-        def import(package, options = Hash.new)
+        def import( # rubocop:disable Metrics/ParameterLists
+            package, *old_boolean,
+            ignore_errors: false, checkout_only: false, allow_interactive: true, **options
+        )
             # Backward compatibility
-            unless options.kind_of?(Hash)
-                options = options
+            unless old_boolean.empty?
+                old_boolean = old_boolean.first
                 Autoproj.warn "calling #import with a boolean as second argument "\
                     "is deprecated, switch to the named argument interface instead"
-                Autoproj.warn "   e.g. call import(package, only_local: #{options})"
+                Autoproj.warn "   e.g. call import(package, only_local: #{old_boolean})"
                 Autoproj.warn "   #{caller(1..1).first}"
-                options = Hash[only_local: options]
+                options[:only_local] = old_boolean
             end
 
-            options = Kernel.validate_options options,
-                only_local: false,
-                reset: false,
-                checkout_only: false,
-                ignore_errors: false,
-                allow_interactive: true
-            ignore_errors = options.delete(:ignore_errors)
-
             importdir = package.importdir
             if File.directory?(importdir)
                 package.isolate_errors(mark_as_failed: false,
                                        ignore_errors: ignore_errors) do
-                    if !options[:checkout_only] && package.update?
-                        perform_update(package, options)
+                    if !checkout_only && package.update?
+                        perform_update(package, checkout_only: false, **options)
                     elsif Autobuild.verbose
                         package.message "%s: not updating"
                     end
@@ -488,12 +487,11 @@ module Autobuild
 
             elsif File.exist?(importdir)
                 raise ConfigException.new(package, 'import'),
-                    "#{importdir} exists but is not a directory"
+                      "#{importdir} exists but is not a directory"
             else
                 package.isolate_errors(mark_as_failed: true,
                                        ignore_errors: ignore_errors) do
-                    perform_checkout(package,
-                        allow_interactive: options[:allow_interactive])
+                    perform_checkout(package, allow_interactive: allow_interactive)
                     true
                 end
             end

data/lib/autobuild/mail_reporter.rb

@@ -22,8 +22,11 @@ if Autobuild::HAS_RMAIL
             end
 
             attr_reader :from_email, :to_email, :smtp_hostname, :smtp_port,
-                :subject, :only_errors
+                        :subject, :only_errors
+
             def initialize(config)
+                super()
+
                 @from_email = (config[:from] || default_mail)
                 @to_email   = (config[:to]   || default_mail)
                 @subject =
@@ -78,7 +81,7 @@ if Autobuild::HAS_RMAIL
                         to_email.each do |email|
                             mail.header.to = email
                             smtp.send_mail(RMail::Serialize.write('', mail),
-                                from_email, email)
+                                           from_email, email)
                         end
                     end
 

data/lib/autobuild/package.rb

@@ -64,7 +64,7 @@ module Autobuild
         # Some statistics about the commands that have been run
         attr_reader :statistics
 
-        EnvOp = Struct.new :type, :name, :values
+        EnvOp = Struct.new :type, :name, :values # rubocop:disable Lint/StructNewOverride
 
         # List of environment values added by this package with {#env_add},
         # {#env_add_path} or {#env_set}
@@ -119,7 +119,8 @@ module Autobuild
         def update?
             if @update.nil?
                 Autobuild.do_update
-            else @update
+            else
+                @update
             end
         end
 
@@ -150,6 +151,7 @@ module Autobuild
             @imported = false
             @prepared = false
             @built = false
+            @disabled = nil
 
             if Hash === spec
                 name, depends = spec.to_a.first
@@ -286,6 +288,11 @@ module Autobuild
             add_env_op EnvOp.new(:add_prefix, prefix, [includes])
         end
 
+        # Add a file to be sourced at the end of the generated env file
+        def env_source_after(file, shell: "sh")
+            add_env_op EnvOp.new(:source_after, file, shell: shell)
+        end
+
         # Hook called by autoproj to set up the default environment for this
         # package
         #
@@ -326,7 +333,11 @@ module Autobuild
                         set[env_op.name] = [self, env_op.values]
                     end
                 end
-                env.send(env_op.type, env_op.name, *env_op.values)
+                if env_op.type == :source_after
+                    env.send(env_op.type, env_op.name, **env_op.values)
+                else
+                    env.send(env_op.type, env_op.name, *env_op.values)
+                end
                 ops << env_op
             end
             ops
@@ -402,8 +413,8 @@ module Autobuild
         def isolate_errors(options = Hash.new)
             options = Hash[mark_as_failed: true] unless options.kind_of?(Hash)
             options = validate_options options,
-                mark_as_failed: true,
-                ignore_errors: Autobuild.ignore_errors
+                                       mark_as_failed: true,
+                                       ignore_errors: Autobuild.ignore_errors
 
             # Don't do anything if we already have failed
             if failed?
@@ -448,12 +459,12 @@ module Autobuild
         # be done there as well.
         #
         # (see Importer#import)
-        def import(options = Hash.new)
-            options = Hash[only_local: options] unless options.respond_to?(:to_hash)
+        def import(*old_boolean, **options)
+            options = { only_local: old_boolean.first } unless old_boolean.empty?
 
             @import_invoked = true
             if @importer
-                result = @importer.import(self, options)
+                result = @importer.import(self, **options)
             elsif update?
                 message "%s: no importer defined, doing nothing"
             end
@@ -491,16 +502,17 @@ module Autobuild
                     suffix << token.gsub(/%s/, name)
                 elsif suffix.empty?
                     prefix << token
-                else suffix << token
+                else
+                    suffix << token
                 end
             end
             if suffix.empty?
-                return msg
+                msg
             elsif prefix_style.empty?
-                return (prefix + suffix).join(" ")
+                (prefix + suffix).join(" ")
             else
                 colorized_prefix = Autobuild.color(prefix.join(" "), *prefix_style)
-                return [colorized_prefix, *suffix].join(" ")
+                [colorized_prefix, *suffix].join(" ")
             end
         end
 
@@ -527,7 +539,7 @@ module Autobuild
             args[0] = process_formatting_string(args[0], :bold)
             done_message = process_formatting_string(done_message) if done_message
             Autobuild.progress_start(self, *args,
-                done_message: done_message, **raw_options, &block)
+                                     done_message: done_message, **raw_options, &block)
         end
 
         def progress(*args)
@@ -686,10 +698,11 @@ module Autobuild
                 pkg = Autobuild::Package[pkg_name]
                 unless (fingerprint = memo[pkg.name])
                     fingerprint = pkg.fingerprint(recursive: true, memo: memo)
-                    return unless fingerprint
+                    break unless fingerprint
                 end
                 fingerprint
             end
+            return unless dependency_fingerprints
 
             memo[name] = Digest::SHA1.hexdigest(
                 self_fingerprint + dependency_fingerprints.join(""))
@@ -837,7 +850,7 @@ module Autobuild
         end
 
         # Make sure that this package will be ignored in the build
-        def disable(phases = Autobuild.all_phases)
+        def disable(_phases = Autobuild.all_phases)
             @disabled = true
         end
 

data/lib/autobuild/packages/autotools.rb

@@ -25,13 +25,8 @@ module Autobuild
     # To override this default behaviour on a per-package basis, use Autotools#use
     #
     class Autotools < Configurable
-        attr_accessor   :using
-        attr_accessor   :configureflags
-        attr_accessor   :aclocal_flags
-        attr_accessor   :autoheader_flags
-        attr_accessor   :autoconf_flags
-        attr_accessor   :automake_flags
-        attr_accessor   :bear_flags
+        attr_accessor :using, :configureflags, :aclocal_flags, :autoheader_flags,
+                      :autoconf_flags, :automake_flags, :bear_flags
 
         @builddir = 'build'
         @@enable_bear_globally = false
@@ -151,7 +146,7 @@ module Autobuild
             FileUtils.rm_f configurestamp
         end
 
-        def import(options = Hash.new)
+        def import(**options)
             # We force a regen after the first checkout. The issue is that
             # autotools is less robust than it should, and very often it is
             # better to generate the build system for the system on which we
@@ -211,7 +206,8 @@ module Autobuild
                         varname, = o.split("=").first
                         if (current_flag = testflags.find { |fl| fl =~ /^#{varname}=/ })
                             current_flag != o
-                        else false
+                        else
+                            false
                         end
                     end
                 end
@@ -278,7 +274,7 @@ module Autobuild
                 file conffile => "#{conffile}#{confext}"
             elsif using[:autoconf]
                 raise PackageException.new(self, 'prepare'),
-                    "neither configure.ac nor configure.in present in #{srcdir}"
+                      "neither configure.ac nor configure.in present in #{srcdir}"
             end
 
             file conffile do

data/lib/autobuild/packages/cmake.rb

@@ -25,6 +25,7 @@ module Autobuild
             end
 
             attr_writer :full_reconfigures
+
             def full_reconfigures?
                 @full_reconfigures
             end
@@ -36,8 +37,7 @@ module Autobuild
             # It can be overriden on a per-package basis with CMake.generator=
             attr_accessor :generator
 
-            attr_reader :prefix_path
-            attr_reader :module_path
+            attr_reader :prefix_path, :module_path
 
             # Whether files that are not within CMake's install manifest but are
             # present in the prefix should be deleted. Note that the contents of
@@ -63,6 +63,7 @@ module Autobuild
 
         # a key => value association of defines for CMake
         attr_reader :defines
+
         # The list of all -D options that should be passed on to CMake
         def all_defines
             additional_defines = Hash[
@@ -81,6 +82,7 @@ module Autobuild
         # Sets a generator explicitely for this component. See #generator and
         # CMake.generator
         attr_writer :generator
+
         # The CMake generator to use. You must choose one that generates
         # Makefiles. If not set for this package explicitely, it is using the
         # global value CMake.generator.
@@ -267,7 +269,7 @@ module Autobuild
             run('doc', Autobuild.tool(:doxygen), doxyfile)
         end
 
-        def common_utility_handling(utility, target, start_msg, done_msg)
+        def common_utility_handling(utility, target, *args, start_msg, done_msg)
             utility.source_ref_dir = builddir
             utility.task do
                 progress_start start_msg, :done_message => done_msg do
@@ -277,7 +279,7 @@ module Autobuild
                         run(utility.name,
                             Autobuild.tool(:make),
                             "-j#{parallel_build_level}",
-                            target,
+                            target, *args,
                             working_directory: builddir)
                     end
                     yield if block_given?
@@ -295,7 +297,7 @@ module Autobuild
 
         def with_tests(target = 'test', &block)
             common_utility_handling(
-                test_utility, target,
+                test_utility, target, "ARGS=-V",
                 "running tests for %s",
                 "successfully ran tests for %s", &block)
         end
@@ -320,7 +322,7 @@ module Autobuild
             end
         end
 
-        def import(options = Hash.new)
+        def import(**options)
             super
 
             Dir.glob(File.join(srcdir, "*.pc.in")) do |file|
@@ -410,7 +412,7 @@ module Autobuild
                 in_dir(builddir) do
                     unless File.file?(File.join(srcdir, 'CMakeLists.txt'))
                         raise ConfigException.new(self, 'configure'),
-                            "#{srcdir} contains no CMakeLists.txt file"
+                              "#{srcdir} contains no CMakeLists.txt file"
                     end
 
                     command = ["cmake"]
@@ -438,7 +440,8 @@ module Autobuild
         def show_make_messages?
             if !@show_make_messages.nil?
                 @show_make_messages
-            else CMake.show_make_messages?
+            else
+                CMake.show_make_messages?
             end
         end
 
@@ -545,7 +548,8 @@ module Autobuild
 
         def self_fingerprint
             return unless (base = super)
-            all_defines = self.class.defines.merge(self.defines).sort_by(&:first)
+
+            all_defines = self.class.defines.merge(defines).sort_by(&:first)
             Digest::SHA1.hexdigest(base + all_defines.join(""))
         end
     end

data/lib/autobuild/packages/dummy.rb

@@ -8,10 +8,6 @@ module Autobuild
             "#{srcdir}/#{STAMPFILE}"
         end
 
-        def initialize(*args)
-            super
-        end
-
         def import(options = Hash.new); end
 
         def prepare

data/lib/autobuild/packages/gnumake.rb

@@ -95,7 +95,7 @@ module Autobuild
     def self.make_subcommand(pkg, phase, *options, &block)
         invoke_make_parallel(pkg, Autobuild.tool(:make)) do |*make_parallel_options|
             pkg.run(phase, Autobuild.tool(:make),
-                *make_parallel_options, *options, &block)
+                    *make_parallel_options, *options, &block)
         end
     end
 end

data/lib/autobuild/packages/orogen.rb

@@ -97,19 +97,19 @@ module Autobuild
             end
         end
 
-        attr_writer :corba
+        attr_writer :corba, :orogen_file
+
         def corba
             @corba || (@corba.nil? && Orogen.corba)
         end
 
         # Overrides the global Orocos.extended_states for this particular package
         attr_writer :extended_states
+
         def extended_states
             @extended_states || (@extended_states.nil? && Orogen.extended_states)
         end
 
-        attr_writer :orogen_file
-
         # Path to the orogen file used for this package
         #
         # If not set, the class will look for a .orogen file in the package
@@ -128,7 +128,7 @@ module Autobuild
                     return File.basename(path)
                 end
                 raise ArgumentError,
-                    "cannot find an oroGen specification file in #{srcdir}"
+                      "cannot find an oroGen specification file in #{srcdir}"
             end
         end
 
@@ -235,6 +235,13 @@ module Autobuild
                 cmdline << "--type-export-policy=#{Orogen.default_type_export_policy}"
                 cmdline << "--transports=#{Orogen.transports.sort.uniq.join(',')}"
             end
+            if version >= "1.2"
+                cmdline << "--parallel-codegen=#{parallel_build_level}"
+                if (job_server = Autobuild.parallel_task_manager&.job_server)
+                    fds = "#{job_server.rio.fileno},#{job_server.wio.fileno}"
+                    cmdline << "--jobserver-auth=#{fds}"
+                end
+            end
 
             # Now, add raw options
             #

data/lib/autobuild/packages/pkgconfig.rb

@@ -2,8 +2,7 @@ require 'autobuild/pkgconfig'
 
 module Autobuild
     class InstalledPkgConfig < Package
-        attr_reader :pkgconfig
-        attr_reader :prefix
+        attr_reader :pkgconfig, :prefix
 
         def initialize(name)
             @pkgconfig = PkgConfig.new(name)
@@ -23,6 +22,7 @@ module Autobuild
             pcfile
         end
     end
+
     def self.installed_pkgconfig(name, &block)
         InstalledPkgConfig.new(name, &block)
     end

data/lib/autobuild/packages/python.rb

@@ -9,8 +9,7 @@ module Autobuild
 
     # Handler class to build python-based packages
     class Python < Configurable
-        attr_accessor   :buildflags
-        attr_accessor   :installflags
+        attr_accessor :buildflags, :installflags
 
         def configurestamp
             "#{builddir}/configure-autobuild-stamp"
@@ -28,12 +27,14 @@ module Autobuild
 
         def prepare_for_forced_build
             super
-            FileUtils.rm_f configurestamp
             @forced = true
         end
 
         def generate_build_command
-            command = ['python', 'setup.py', 'build']
+            command = %w[python setup.py]
+            command << "egg_info"
+            command << "--egg-base=#{builddir}"
+            command << "build"
             command << "--build-base=#{builddir}"
             command += buildflags.flatten
             command
@@ -43,25 +44,35 @@ module Autobuild
             command = generate_build_command
             command << 'install'
             command << "--prefix=#{prefix}"
+            command << "--record=#{builddir}/install.log"
+            command << "--single-version-externally-managed"
             command += installflags.flatten
             command
         end
 
-        def python_path
+        def self.user_site(prefix)
+            return File.join(prefix, @user_site) if @user_site
+
             begin
-                _, output, _, ret = Open3.popen3({ 'PYTHONUSERBASE' => prefix },
-                                                 'python -m site --user-site')
+                env = Autobuild.env.resolved_env.merge({ 'PYTHONUSERBASE' => "/" })
+                _, output, _, ret = Open3.popen3(env, 'python -m site --user-site')
             rescue Exception => e
                 raise "Unable to set PYTHONPATH: #{e.message}"
             end
 
             if ret.value.success?
-                output.read.chomp
+                @user_site = Pathname.new(output.read.chomp)
+                                     .relative_path_from(Pathname.new("/"))
+                File.join(prefix, @user_site)
             else
                 raise 'Unable to set PYTHONPATH: user site directory disabled?'
             end
         end
 
+        def python_path
+            self.class.user_site(prefix)
+        end
+
         # Do the build in builddir
         def build
             return unless install_mode?

data/lib/autobuild/packages/ruby.rb

@@ -40,7 +40,7 @@ module Autobuild
                                done_message: 'generated documentation for %s' do
                     run 'doc',
                         Autobuild.tool_in_path('ruby'), '-S',
-                            Autobuild.tool('rake'), rake_doc_task,
+                        Autobuild.tool('rake'), rake_doc_task,
                         working_directory: srcdir
                 end
             end
@@ -52,7 +52,7 @@ module Autobuild
                                done_message: 'tests passed for %s' do
                     run 'test',
                         Autobuild.tool_in_path('ruby'), '-S',
-                            Autobuild.tool('rake'), rake_test_task, *rake_test_options,
+                        Autobuild.tool('rake'), rake_test_task, *rake_test_options,
                         working_directory: srcdir
                 end
             end
@@ -62,7 +62,7 @@ module Autobuild
             if setup_task && File.file?(File.join(srcdir, 'Rakefile'))
                 run 'post-install',
                     Autobuild.tool_in_path('ruby'), '-S',
-                        Autobuild.tool('rake'), setup_task,
+                    Autobuild.tool('rake'), setup_task,
                     working_directory: srcdir
             end
         end
@@ -80,7 +80,7 @@ module Autobuild
             %w[ext tmp].each do |extdir|
                 if File.directory?(extdir)
                     Find.find(extdir) do |file|
-                        next if file !~ /\<Makefile\>|\<CMakeCache.txt\>$/
+                        next if file !~ /<Makefile>|<CMakeCache.txt>$/
 
                         FileUtils.rm_rf file
                     end
@@ -94,7 +94,7 @@ module Autobuild
                 begin
                     run 'clean',
                         Autobuild.tool_in_path('ruby'), '-S',
-                            Autobuild.tool('rake'), rake_clean_task,
+                        Autobuild.tool('rake'), rake_clean_task,
                         working_directory: srcdir
                 rescue Autobuild::SubcommandFailed => e
                     warn "%s: clean failed. If this package does not need a clean target,"