autoproj 2.13.0 → 2.15.2

data/bin/autoproj_install.in

@@ -1,20 +1,19 @@
 #! /usr/bin/ruby
 
-if RUBY_VERSION < "2.3.0"
-    STDERR.puts "autoproj requires Ruby >= 2.3.0"
+if RUBY_VERSION < "2.5.0"
+    STDERR.puts "autoproj requires Ruby >= 2.5.0"
     exit 1
-elsif ENV['AUTOPROJ_CURRENT_ROOT'] && (ENV['AUTOPROJ_CURRENT_ROOT'] != Dir.pwd)
+elsif ENV["AUTOPROJ_CURRENT_ROOT"] && (ENV["AUTOPROJ_CURRENT_ROOT"] != Dir.pwd)
     STDERR.puts "it seems that you've already loaded an env.sh script in this console, open a new console and try again"
     exit 1
 end
 
 require 'autoproj/ops/install'
-
-ENV.delete('BUNDLE_GEMFILE')
-ENV.delete('RUBYLIB')
+ENV.delete("BUNDLE_GEMFILE")
+ENV.delete("RUBYLIB")
 ops = Autoproj::Ops::Install.new(Dir.pwd)
 
-existing_config = File.join(Dir.pwd, '.autoproj', 'config.yml')
+existing_config = File.join(Dir.pwd, ".autoproj", "config.yml")
 if File.file?(existing_config)
     puts "Found existing configuration, using it as seed"
     puts "use --no-seed-config to avoid this behavior"

data/lib/autoproj/aruba_minitest.rb

@@ -1,4 +1,4 @@
-require 'aruba/api'
+require "aruba/api"
 
 module Autoproj
     # Minitest-usable Aruba wrapper
@@ -27,10 +27,10 @@ module Autoproj
 
         def generate_local_gemfile
             path = expand_path("Gemfile.local")
-            File.open(path, 'w') do |io|
+            File.open(path, "w") do |io|
                 io.write <<~GEMFILE
                 source "https://rubygems.org"
-                gem "autoproj", path: "#{File.expand_path("../../", __dir__)}"
+                gem "autoproj", path: "#{File.expand_path('../../', __dir__)}"
                 GEMFILE
             end
             path
@@ -39,9 +39,7 @@ module Autoproj
         def run_command_and_stop(*args, fail_on_error: true, **kwargs)
             cmd = run_command(*args, **kwargs)
             cmd.stop
-            if fail_on_error
-                assert_command_finished_successfully(cmd)
-            end
+            assert_command_finished_successfully(cmd) if fail_on_error
             cmd
         end
 
@@ -59,7 +57,7 @@ module Autoproj
 
         def method_missing(m, *args, &block)
             if @aruba_api.respond_to?(m)
-                return @aruba_api.send(m, *args, &block)
+                @aruba_api.send(m, *args, &block)
             else
                 super
             end
@@ -67,9 +65,7 @@ module Autoproj
 
         def assert_command_stops(cmd, fail_on_error: true)
             cmd.stop
-            if fail_on_error
-                assert_command_finished_successfully(cmd)
-            end
+            assert_command_finished_successfully(cmd) if fail_on_error
         end
 
         def assert_command_finished_successfully(cmd)
@@ -78,4 +74,3 @@ module Autoproj
         end
     end
 end
-

data/lib/autoproj/autobuild.rb

@@ -1,8 +1,9 @@
-require 'autoproj/autobuild_extensions/package'
-require 'autoproj/autobuild_extensions/archive_importer'
-require 'autoproj/autobuild_extensions/git'
-require 'autoproj/autobuild_extensions/svn'
-require 'autoproj/autobuild_extensions/dsl'
+require "autoproj/autobuild_extensions/package"
+require "autoproj/autobuild_extensions/python"
+require "autoproj/autobuild_extensions/archive_importer"
+require "autoproj/autobuild_extensions/git"
+require "autoproj/autobuild_extensions/svn"
+require "autoproj/autobuild_extensions/dsl"
 
 Autobuild::Package.class_eval do
     prepend Autoproj::AutobuildExtensions::Package
@@ -16,4 +17,6 @@ end
 Autobuild::SVN.class_eval do
     prepend Autoproj::AutobuildExtensions::SVN
 end
-
+Autobuild::Python.class_eval do
+    prepend Autoproj::AutobuildExtensions::Python
+end

data/lib/autoproj/autobuild_extensions/archive_importer.rb

@@ -9,36 +9,35 @@ module Autoproj
             #   manifest
             def pick_from_autoproj_root(package, installation_manifest)
                 # Get the cachefile w.r.t. the autoproj root
-                cachefile = Pathname.new(self.cachefile).
-                    relative_path_from(Pathname.new(ws.root_dir)).to_s
+                cachefile = Pathname.new(self.cachefile)
+                                    .relative_path_from(Pathname.new(ws.root_dir)).to_s
 
                 # The cachefile in the other autoproj installation
                 other_cachefile = File.join(installation_manifest.path, cachefile)
                 if File.file?(other_cachefile)
-                    self.relocate("file://" + other_cachefile)
+                    relocate("file://#{other_cachefile}")
                     true
                 end
             end
 
             def snapshot(package, target_dir = nil, options = Hash.new)
                 result = Hash[
-                    'mode' => mode,
-                    'no_subdirectory' => !has_subdirectory?,
-                    'archive_dir' => archive_dir || tardir]
+                    "mode" => mode,
+                    "no_subdirectory" => !has_subdirectory?,
+                    "archive_dir" => archive_dir || tardir]
 
                 if target_dir
-                    archive_dir = File.join(target_dir, 'archives')
+                    archive_dir = File.join(target_dir, "archives")
                     FileUtils.mkdir_p archive_dir
                     FileUtils.cp @cachefile, archive_dir
 
-                    result['url'] = "file://$AUTOPROJ_SOURCE_DIR/archives/#{File.basename(@cachefile)}"
+                    result["url"] = "file://$AUTOPROJ_SOURCE_DIR/archives/#{File.basename(@cachefile)}"
                 else
-                    result['url'] = @url.to_s
+                    result["url"] = @url.to_s
                 end
-                
+
                 result
             end
         end
     end
 end
-

data/lib/autoproj/autobuild_extensions/dsl.rb

@@ -1,7 +1,7 @@
-require 'find'
-require 'fileutils'
-require 'autobuild'
-require 'set'
+require "find"
+require "fileutils"
+require "autobuild"
+require "set"
 
 module Autoproj
     # @deprecated use Workspace.config.ruby_executable instead, or
@@ -20,6 +20,28 @@ module Autoproj
         end
     end
 
+    class << self
+        attr_writer :custom_package_handlers
+
+        def custom_package_handlers
+            @custom_package_handlers ||= []
+        end
+    end
+
+    def self.each_custom_package_handler(&block)
+        return enum_for(__method__) unless block_given?
+
+        custom_package_handlers.each do |handler|
+            block.call(handler)
+        end
+    end
+
+    # Registers a block that will be called to determine a package
+    # handler for the package in full_path.
+    def self.custom_package_handler(&block)
+        custom_package_handlers << block
+    end
+
     # @api private
     #
     # Helper method that extracts the package name from a Rake-style package
@@ -68,11 +90,11 @@ module Autoproj
     def self.define(package_type, spec, &block)
         Autoproj.warn_deprecated(
             __method__, "use Autoproj.workspace.define_package "\
-            "instead (and beware that the return value changed from "\
-            "Autobuild::Package to Autoproj::PackageDefinition)"
+                        "instead (and beware that the return value changed from "\
+                        "Autobuild::Package to Autoproj::PackageDefinition)"
         )
-        workspace.define_package(package_type, spec, block, *current_file).
-            autobuild
+        workspace.define_package(package_type, spec, block, *current_file)
+                 .autobuild
     end
 
     def self.loaded_autobuild_files
@@ -112,30 +134,35 @@ module Autoproj
 
     # Tries to find a handler automatically for 'full_path'
     def self.package_handler_for(full_path)
+        each_custom_package_handler do |handler|
+            pair = handler.call(full_path)
+            return pair if pair
+        end
         pyglob = File.join(File.basename(full_path), "*.py")
         if !Dir.enum_for(:glob, File.join(full_path, "*.orogen")).to_a.empty?
             ["orogen_package", full_path]
         elsif File.file?(File.join(full_path, "Makefile.am"))
             toplevel_dir = find_topmost_directory_containing(full_path) do |dir|
-                configure_ac = File.join(dir, 'configure.ac')
-                configure_in = File.join(dir, 'configure.in')
+                configure_ac = File.join(dir, "configure.ac")
+                configure_in = File.join(dir, "configure.in")
                 File.file?(configure_ac) || File.file?(configure_in)
             end
-            ['autotools_package', toplevel_dir] if toplevel_dir
+            ["autotools_package", toplevel_dir] if toplevel_dir
         elsif File.file?(File.join(full_path, "configure.ac")) ||
               File.file?(File.join(full_path, "configure.in"))
-            ['autotools_package', full_path]
+            ["autotools_package", full_path]
         elsif File.file?(File.join(full_path, "CMakeLists.txt"))
             toplevel_dir = find_topmost_directory_containing(full_path) do |dir|
-                cmakelists = File.join(dir, 'CMakeLists.txt')
+                cmakelists = File.join(dir, "CMakeLists.txt")
                 File.file?(cmakelists) &&
                     (File.read(cmakelists) =~ /PROJECT/i)
             end
             toplevel_dir ||= find_topmost_directory_containing(
-                full_path, 'CMakeLists.txt')
+                full_path, "CMakeLists.txt"
+            )
 
-            manifest_xml = File.join(toplevel_dir, 'manifest.xml')
-            package_xml = File.join(toplevel_dir, 'package.xml')
+            manifest_xml = File.join(toplevel_dir, "manifest.xml")
+            package_xml = File.join(toplevel_dir, "package.xml")
             if File.file?(package_xml) && !File.file?(manifest_xml)
                 return "catkin_package", toplevel_dir
             end
@@ -145,9 +172,9 @@ module Autoproj
                       find_topmost_directory_containing(full_path, "lib/*.rb")))
 
             ["ruby_package", dir]
-        elsif (dir = (find_topmost_directory_containing(full_path, 'setup.py') ||
+        elsif (dir = (find_topmost_directory_containing(full_path, "setup.py") ||
                       find_topmost_directory_containing(full_path, pyglob)))
-            ['python_package', dir]
+            ["python_package", dir]
         end
     end
 end
@@ -161,7 +188,7 @@ end
 # Adds a new setup block to an existing package
 def setup_package(package_name, workspace: Autoproj.workspace, &block)
     unless block
-        raise Autoproj::ConfigError.new, 'you must give a block to #setup_package'
+        raise Autoproj::ConfigError.new, "you must give a block to #setup_package"
     end
 
     package_definition = workspace.manifest.find_package_definition(package_name)
@@ -182,7 +209,7 @@ def package_common(package_type, spec, workspace: Autoproj.workspace, &block)
         current_file = workspace.current_file[1]
         old_file     = existing_package.file
         Autoproj.warn "#{package_name} from #{current_file} is overridden "\
-            "by the definition in #{old_file}"
+                      "by the definition in #{old_file}"
         return existing_package.autobuild
     end
 
@@ -197,9 +224,9 @@ end
 
 def python_package(name, workspace: Autoproj.workspace)
     package_common(:python, name, workspace: workspace) do |pkg|
-        pkg.internal_dependency 'python'
+        pkg.internal_dependency "python"
         pkg.post_import do
-            pkg.depends_on 'python-setuptools' if pkg.install_mode?
+            pkg.depends_on "python-setuptools" if pkg.install_mode?
         end
         yield(pkg) if block_given?
     end
@@ -207,9 +234,9 @@ end
 
 def common_make_default_test_task(pkg)
     unless pkg.test_utility.source_dir
-        test_dir = File.join(pkg.srcdir, 'test')
+        test_dir = File.join(pkg.srcdir, "test")
         if File.directory?(test_dir)
-            pkg.test_utility.source_dir = File.join(pkg.builddir, 'test', 'results')
+            pkg.test_utility.source_dir = File.join(pkg.builddir, "test", "results")
         end
     end
 
@@ -219,7 +246,7 @@ end
 def common_make_based_package_setup(pkg)
     unless pkg.has_doc? && pkg.doc_dir
         pkg.with_doc do
-            doc_html = File.join(pkg.builddir, 'doc', 'html')
+            doc_html = File.join(pkg.builddir, "doc", "html")
             pkg.doc_dir = doc_html if File.directory?(doc_html)
         end
     end
@@ -245,7 +272,7 @@ end
 # information.
 def cmake_package(name, workspace: Autoproj.workspace)
     package_common(:cmake, name, workspace: workspace) do |pkg|
-        pkg.depends_on 'cmake'
+        pkg.depends_on "cmake"
         common_make_based_package_setup(pkg)
         yield(pkg) if block_given?
     end
@@ -270,7 +297,7 @@ end
 # information.
 def autotools_package(name, workspace: Autoproj.workspace)
     package_common(:autotools, name, workspace: workspace) do |pkg|
-        pkg.depends_on 'autotools'
+        pkg.depends_on "autotools"
         common_make_based_package_setup(pkg)
         yield(pkg) if block_given?
     end
@@ -290,9 +317,9 @@ end
 
 def ruby_package_default_test_task(pkg)
     unless pkg.test_utility.source_dir
-        test_dir = File.join(pkg.srcdir, 'test')
+        test_dir = File.join(pkg.srcdir, "test")
         if File.directory?(test_dir)
-            pkg.test_utility.source_dir = File.join(pkg.srcdir, '.test-results')
+            pkg.test_utility.source_dir = File.join(pkg.srcdir, ".test-results")
             FileUtils.mkdir_p pkg.test_utility.source_dir
         end
     end
@@ -358,7 +385,8 @@ def only_on(*architectures)
     architectures = architectures.map do |name|
         if name.respond_to?(:to_str)
             [name]
-        else name
+        else
+            name
         end
     end
 
@@ -383,7 +411,8 @@ def not_on(*architectures)
     architectures = architectures.map do |name|
         if name.respond_to?(:to_str)
             [name]
-        else name
+        else
+            name
         end
     end
 
@@ -407,7 +436,8 @@ def not_on(*architectures)
 
     new_packages.each do |pkg_name|
         manifest.exclude_package(
-            pkg_name, "#{pkg_name} is disabled on this operating system")
+            pkg_name, "#{pkg_name} is disabled on this operating system"
+        )
     end
 end
 
@@ -497,8 +527,8 @@ def remove_from_default(*names)
 end
 
 def renamed_package(current_name, old_name, options)
-    explicit_selection = Autoproj.workspace.manifest.
-        explicitely_selected_in_layout?(old_name)
+    explicit_selection = Autoproj.workspace.manifest
+                                 .explicitely_selected_in_layout?(old_name)
     if options[:obsolete] && !explicit_selection
         import_package old_name
         Autoproj.workspace.manifest.exclude_package(

data/lib/autoproj/autobuild_extensions/git.rb

@@ -10,7 +10,8 @@ module Autoproj
             def pick_from_autoproj_root(package, installation_manifest)
                 other_pkg = installation_manifest[package.name]
                 return if !other_pkg || !File.directory?(other_pkg.srcdir)
-                self.relocate(other_pkg.srcdir)
+
+                relocate(other_pkg.srcdir)
                 true
             end
 
@@ -35,7 +36,7 @@ module Autoproj
 
             def normalize_branch_name(name)
                 if name =~ /^refs\/heads\//
-                    return name
+                    name
                 else
                     "refs/heads/#{name}"
                 end
@@ -47,45 +48,45 @@ module Autoproj
             # It tests only against the parameters returned by {#snapshot}
             def snapshot_overrides?(snapshot)
                 # We have to normalize the branch and tag names
-                if snapshot_local = (snapshot['local_branch'] || snapshot['branch'])
+                if (snapshot_local = snapshot["local_branch"] || snapshot["branch"])
                     snapshot_local = normalize_branch_name(snapshot_local)
-                    local_branch  = normalize_branch_name(self.local_branch)
+                    local_branch = normalize_branch_name(self.local_branch)
                     return true if snapshot_local != local_branch
                 end
-                if snapshot_remote = (snapshot['remote_branch'] || snapshot['branch'])
+                if (snapshot_remote = snapshot["remote_branch"] || snapshot["branch"])
                     snapshot_remote = normalize_branch_name(snapshot_remote)
                     remote_branch  = normalize_branch_name(self.remote_branch)
                     return true if snapshot_remote != remote_branch
                 end
-                if snapshot_id = snapshot['commit']
-                    return true if self.commit != snapshot_id
+                if (snapshot_id = snapshot["commit"])
+                    return true if commit != snapshot_id
                 end
                 false
             end
 
             # @api private
             def snapshot_against_remote(package, options = Hash.new)
-                info = Hash['tag' => nil, 'commit' => nil]
-                remote_revname = describe_commit_on_remote(package, 'HEAD', tags: options[:exact_state])
+                info = Hash["tag" => nil, "commit" => nil]
+                remote_revname = describe_commit_on_remote(package, "HEAD", tags: options[:exact_state])
 
                 case remote_revname
                 when /^refs\/heads\/(.*)/
                     remote_branch = $1
                     if local_branch == remote_branch
-                        info['branch'] = local_branch
+                        info["branch"] = local_branch
                     else
-                        info['local_branch'] = local_branch
-                        info['remote_branch'] = remote_branch
+                        info["local_branch"] = local_branch
+                        info["remote_branch"] = remote_branch
                     end
                 when /^refs\/tags\/(.*)/
-                    info['tag'] = $1
+                    info["tag"] = $1
                 else
-                    info['local_branch'] = local_branch
-                    info['remote_branch'] = remote_revname
+                    info["local_branch"] = local_branch
+                    info["remote_branch"] = remote_revname
                 end
 
-                if options[:exact_state] && !info['tag']
-                    info['commit'] = rev_parse(package, 'HEAD')
+                if options[:exact_state] && !info["tag"]
+                    info["commit"] = rev_parse(package, "HEAD")
                 end
                 info
             end
@@ -93,21 +94,21 @@ module Autoproj
             # @api private
             def snapshot_local(package, options = Hash.new)
                 info = Hash.new
-                if local_branch != remote_branch
-                    info['local_branch'] = local_branch
-                    info['remote_branch'] = remote_branch
+                if local_branch == remote_branch
+                    info["branch"] = branch
                 else
-                    info['branch'] = branch
+                    info["local_branch"] = local_branch
+                    info["remote_branch"] = remote_branch
                 end
 
                 if options[:exact_state]
-                    has_tag, described = describe_rev(package, 'HEAD')
+                    has_tag, described = describe_rev(package, "HEAD")
                     if has_tag
-                        info['tag'] = described
-                        info['commit'] = nil
+                        info["tag"] = described
+                        info["commit"] = nil
                     else
-                        info['tag'] = nil
-                        info['commit'] = described
+                        info["tag"] = nil
+                        info["commit"] = described
                     end
                 end
                 info

data/lib/autoproj/autobuild_extensions/package.rb

@@ -8,6 +8,7 @@ module Autoproj
             attr_reader :os_packages
 
             attr_writer :ws
+
             def ws
                 @ws ||= Autoproj.workspace
             end
@@ -46,9 +47,7 @@ module Autoproj
             # #add_tag
             def tags
                 result = @added_tags.dup
-                if description
-                    result |= description.tags.to_set
-                end
+                result |= description.tags.to_set if description
                 result
             end
 
@@ -68,7 +67,7 @@ module Autoproj
             # package
             def remove_obsolete_installed_orogen_package(name)
                 post_install do
-                    path = File.join(prefix, 'lib', 'pkgconfig')
+                    path = File.join(prefix, "lib", "pkgconfig")
                     Dir.glob(File.join(path, "#{name}-*.pc")) do |pcfile|
                         Autoproj.message "  removing obsolete file #{pcfile}", :bold
                         FileUtils.rm_f pcfile
@@ -100,13 +99,11 @@ module Autoproj
             end
 
             def autoproj_name # :nodoc:
-                srcdir.gsub(/^#{Regexp.quote(ws.root_dir)}\//, '')
+                srcdir.gsub(/^#{Regexp.quote(ws.root_dir)}\//, "")
             end
 
             def depends_on(name)
-                if name.respond_to?(:name) # probably a Package object
-                    name = name.name
-                end
+                name = name.name if name.respond_to?(:name) # probably a Package object
 
                 pkg_autobuild, pkg_os = partition_package(name)
                 pkg_autobuild.each do |pkg|
@@ -120,10 +117,13 @@ module Autoproj
                 all_dependencies(set)
                 set.dup.each do |dep_pkg_name|
                     next if original_set.include?(dep_pkg_name)
-                    if dep_pkg = ws.manifest.find_autobuild_package(dep_pkg_name)
+
+                    if (dep_pkg = ws.manifest.find_autobuild_package(dep_pkg_name))
                         set.merge(dep_pkg.os_packages)
                     else
-                        raise ArgumentError, "#{dep_pkg_name}, which is listed as a dependency of #{name}, is not the name of a known package"
+                        raise ArgumentError,
+                              "#{dep_pkg_name}, which is listed as a dependency "\
+                              "of #{name}, is not the name of a known package"
                     end
                 end
                 set.merge(os_packages)
@@ -160,30 +160,31 @@ module Autoproj
             end
 
             def partition_package(pkg_name)
-                pkg_autobuild, pkg_osdeps = [], []
+                pkg_autobuild = []
+                pkg_osdeps = []
                 ws.manifest.resolve_package_name(pkg_name, include_unavailable: true).each do |type, dep_name|
                     if type == :osdeps
                         pkg_osdeps << dep_name
                     elsif type == :package
                         pkg_autobuild << dep_name
-                    else raise Autoproj::InternalError, "expected package type to be either :osdeps or :package, got #{type.inspect}"
+                    else
+                        raise Autoproj::InternalError, "expected package type to be either :osdeps or :package, got #{type.inspect}"
                     end
                 end
-                return pkg_autobuild, pkg_osdeps
+                [pkg_autobuild, pkg_osdeps]
             end
 
             def partition_optional_dependencies
-                packages, osdeps = [], []
+                packages = []
+                osdeps = []
                 optional_dependencies.each do |name|
-                    begin
-                        pkg_autobuild, pkg_osdeps = partition_package(name)
-                        packages.concat(pkg_autobuild)
-                        osdeps.concat(pkg_osdeps)
-                    rescue Autoproj::PackageNotFound
-                        # Simply ignore non-existent optional dependencies
-                    end
+                    pkg_autobuild, pkg_osdeps = partition_package(name)
+                    packages.concat(pkg_autobuild)
+                    osdeps.concat(pkg_osdeps)
+                rescue Autoproj::PackageNotFound
+                    # Simply ignore non-existent optional dependencies
                 end
-                return packages, osdeps
+                [packages, osdeps]
             end
         end
     end

data/lib/autoproj/autobuild_extensions/python.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Autoproj
+    module AutobuildExtensions
+        # Extension for Autobuild::Python
+        module Python
+            def activate_python
+                Autoproj::Python.setup_python_configuration_options(ws: ws)
+                Autoproj::Python.assert_python_activated(ws: ws)
+            end
+
+            def update_environment
+                activate_python
+                super
+            end
+        end
+    end
+end

data/lib/autoproj/autobuild_extensions/svn.rb

@@ -3,9 +3,8 @@ module Autoproj
         module SVN
             def snapshot(package, target_dir = nil, options = Hash.new)
                 version = svn_revision(package)
-                Hash['revision' => version]
+                Hash["revision" => version]
             end
         end
     end
 end
-

data/lib/autoproj/base.rb

@@ -1,4 +1,4 @@
-require 'yaml'
+require "yaml"
 module Autoproj
     YAML_LOAD_ERROR =
         if defined? Psych::SyntaxError