autoproj 2.11.0 → 2.14.0

data/bin/autoproj_bootstrap.in

@@ -13,12 +13,14 @@ require 'autoproj/ops/install'
 ENV.delete('BUNDLE_GEMFILE')
 ENV.delete('RUBYLIB')
 ops = Autoproj::Ops::Install.new(Dir.pwd)
+
+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"
+    ops.add_seed_config(existing_config)
+end
 bootstrap_options = ops.parse_options(ARGV)
 ops.stage1
-if !ops.skip_stage2?
-    ops.call_stage2
-end
-if !ops.run_autoproj 'bootstrap', *bootstrap_options
-    exit 1
-end
-
+ops.call_stage2 unless ops.skip_stage2?
+exit 1 unless ops.run_autoproj('bootstrap', *bootstrap_options)

data/bin/autoproj_install

@@ -8,10 +8,13 @@ elsif ENV['AUTOPROJ_CURRENT_ROOT'] && (ENV['AUTOPROJ_CURRENT_ROOT'] != Dir.pwd)
     exit 1
 end
 
+# frozen_string_literal: true
+
 require 'pathname'
 require 'optparse'
 require 'fileutils'
 require 'yaml'
+require 'English'
 
 module Autoproj
     module Ops
@@ -23,6 +26,36 @@ module Autoproj
         class Install
             class UnexpectedBinstub < RuntimeError; end
 
+            RUBYLIB_REINIT = <<~RUBY
+                if defined?(Bundler)
+                    if Bundler.respond_to?(:with_unbundled_env)
+                        Bundler.with_unbundled_env do
+                            exec(Hash['RUBYLIB' => nil], $0, *ARGV)
+                        end
+                    else
+                        Bundler.with_clean_env do
+                            exec(Hash['RUBYLIB' => nil], $0, *ARGV)
+                        end
+                    end
+                elsif ENV['RUBYLIB']
+                    exec(Hash['RUBYLIB' => nil], $0, *ARGV)
+                end
+            RUBY
+
+            WITHOUT_BUNDLER = <<~RUBY
+                if defined?(Bundler)
+                    if Bundler.respond_to?(:with_unbundled_env)
+                        Bundler.with_unbundled_env do
+                            exec($0, *ARGV)
+                        end
+                    else
+                        Bundler.with_clean_env do
+                            exec($0, *ARGV)
+                        end
+                    end
+                end
+            RUBY
+
             # The created workspace's root directory
             attr_reader :root_dir
             # Content of the Gemfile generated to install autoproj itself
@@ -230,6 +263,10 @@ module Autoproj
                  "gem \"utilrb\", \">= 3.0.1\""].join("\n")
             end
 
+            def add_seed_config(path)
+                @config.merge!(YAML.safe_load(File.read(path), [Symbol]))
+            end
+
             # Parse the provided command line options and returns the non-options
             def parse_options(args = ARGV)
                 options = OptionParser.new do |opt|
@@ -253,6 +290,10 @@ module Autoproj
                     opt.on '--public-gems', "install gems in the default gem location" do
                         self.install_gems_in_gem_user_dir
                     end
+                    opt.on '--bundler-version=VERSION_CONSTRAINT', String, 'use the provided '\
+                        'string as a version constraint for bundler' do |version|
+                        @config['bundler_version'] = version
+                    end
                     opt.on '--version=VERSION_CONSTRAINT', String, 'use the provided '\
                         'string as a version constraint for autoproj' do |version|
                         if @gemfile
@@ -267,9 +308,14 @@ module Autoproj
                         end
                         @gemfile = File.read(path)
                     end
+                    opt.on '--no-seed-config',
+                           'when reinstalling an existing autoproj workspace, do not '\
+                           'use the config in .autoproj/ as seed' do
+                        @config.clear
+                    end
                     opt.on '--seed-config=PATH', String, 'path to a seed file that '\
                         'should be used to initialize the configuration' do |path|
-                        @config.merge!(YAML.load(File.read(path)))
+                        add_seed_config(path)
                     end
                     opt.on '--prefer-os-independent-packages', 'prefer OS-independent '\
                         'packages (such as a RubyGem) over their OS-packaged equivalent '\
@@ -299,22 +345,50 @@ module Autoproj
                 @autoproj_options + args
             end
 
-            def find_bundler(gem_program)
-                setup_paths =
-                    IO.popen([env_for_child, Gem.ruby, gem_program, 'which','-a', 'bundler/setup']) do |io|
-                        io.read
-                    end
-                return unless $?.success?
+            def bundler_version
+                @config['bundler_version']
+            end
+
+            def find_bundler(gem_program, version: nil)
                 bundler_path = File.join(gems_gem_home, 'bin', 'bundle')
-                setup_paths.each_line do |setup_path|
-                    if File.exist?(bundler_path) && setup_path.start_with?(gems_gem_home)
-                        return bundler_path
+                return unless File.exist?(bundler_path)
+
+                setup_paths =
+                    if version
+                        find_versioned_bundler_setup(gem_program, version)
+                    else
+                        find_unversioned_bundler_setup(gem_program)
                     end
+
+                setup_paths.each do |setup_path|
+                    return bundler_path if setup_path.start_with?(gems_gem_home)
                 end
-                return
+                nil
+            end
+
+            def find_versioned_bundler_setup(gem_program, version)
+                contents = IO.popen(
+                    [env_for_child, Gem.ruby, gem_program,
+                     'contents', '-v', version, 'bundler'],
+                    &:readlines
+                )
+                return [] unless $CHILD_STATUS.success?
+
+                contents.grep(%r{bundler/setup.rb$})
+            end
+
+            def find_unversioned_bundler_setup(gem_program)
+                setup_paths = IO.popen(
+                    [env_for_child, Gem.ruby, gem_program,
+                     'which', '-a', 'bundler/setup'],
+                    &:readlines
+                )
+                return [] unless $CHILD_STATUS.success?
+
+                setup_paths
             end
 
-            def install_bundler(gem_program, silent: false)
+            def install_bundler(gem_program, version: nil, silent: false)
                 local = ['--local'] if local?
 
                 redirection = Hash.new
@@ -322,6 +396,9 @@ module Autoproj
                     redirection = Hash[out: :close]
                 end
 
+                version_args = []
+                version_args << '-v' << version if version
+
                 # Shut up the bundler warning about 'bin' not being in PATH
                 env = self.env
                 env['PATH'] += [File.join(gems_gem_home, 'bin')]
@@ -332,14 +409,14 @@ module Autoproj
                         '--clear-sources', '--source', gem_source,
                         '--no-user-install', '--install-dir', gems_gem_home,
                         *local, "--bindir=#{File.join(gems_gem_home, 'bin')}",
-                        'bundler', **redirection)
+                        'bundler', *version_args, **redirection)
 
                 if !result
                     STDERR.puts "FATAL: failed to install bundler in #{gems_gem_home}"
                     nil
                 end
 
-                if (bundler_path = find_bundler(gem_program))
+                if (bundler_path = find_bundler(gem_program, version: version))
                     bundler_path
                 else
                     STDERR.puts "gem install bundler returned successfully, but still "\
@@ -348,7 +425,7 @@ module Autoproj
                 end
             end
 
-            def install_autoproj(bundler)
+            def install_autoproj(bundler, bundler_version: self.bundler_version)
                 # Force bundler to update. If the user does not want this, let
                 # him specify a Gemfile with tighter version constraints
                 lockfile = File.join(dot_autoproj, 'Gemfile.lock')
@@ -363,14 +440,19 @@ module Autoproj
                 opts << "--path=#{gems_install_path}"
                 shims_path = File.join(dot_autoproj, 'bin')
 
-                result = system(clean_env,
-                    Gem.ruby, bundler, 'install',
-                        "--gemfile=#{autoproj_gemfile_path}",
-                        "--shebang=#{Gem.ruby}",
-                        "--binstubs=#{shims_path}",
-                        *opts, chdir: dot_autoproj)
+                version_arg = []
+                version_arg << "_#{bundler_version}_" if bundler_version
 
-                if !result
+                result = system(
+                    clean_env,
+                    Gem.ruby, bundler, *version_arg, 'install',
+                    "--gemfile=#{autoproj_gemfile_path}",
+                    "--shebang=#{Gem.ruby}",
+                    "--binstubs=#{shims_path}",
+                    *opts, chdir: dot_autoproj
+                )
+
+                unless result
                     STDERR.puts "FATAL: failed to install autoproj in #{dot_autoproj}"
                     exit 1
                 end
@@ -379,7 +461,7 @@ module Autoproj
                     root_dir, autoproj_gemfile_path, gems_gem_home)
             end
 
-            EXCLUDED_FROM_SHIMS = %w{rake thor}
+            EXCLUDED_FROM_SHIMS = %w[rake thor].freeze
 
             def self.rewrite_shims(shim_path, ruby_executable,
                 root_dir, autoproj_gemfile_path, gems_gem_home)
@@ -435,11 +517,7 @@ module Autoproj
 #
 
 # Autoproj generated preamble
-if defined?(Bundler)
-    Bundler.with_clean_env do
-        exec($0, *ARGV)
-    end
-end
+#{WITHOUT_BUNDLER}
 ENV['BUNDLE_GEMFILE'] ||= '#{autoproj_gemfile_path}'
 ENV['GEM_HOME'] = '#{gems_gem_home}'
 ENV.delete('GEM_PATH')
@@ -451,12 +529,7 @@ Gem.paths = Hash['GEM_HOME' => '#{gems_gem_home}', 'GEM_PATH' => '']
             def self.shim_bundler_old(ruby_executable, autoproj_gemfile_path, gems_gem_home)
 "#! #{ruby_executable}
 
-if defined?(Bundler)
-    Bundler.with_clean_env do
-        exec($0, *ARGV)
-    end
-end
-
+#{WITHOUT_BUNDLER}
 ENV['BUNDLE_GEMFILE'] ||= '#{autoproj_gemfile_path}'
 ENV['GEM_HOME'] = '#{gems_gem_home}'
 ENV.delete('GEM_PATH')
@@ -481,14 +554,7 @@ load Gem.bin_path('bundler', 'bundler')"
 #
 
 # Autoproj generated preamble, v1
-if defined?(Bundler)
-    Bundler.with_clean_env do
-        exec(Hash['RUBYLIB' => nil], $0, *ARGV)
-    end
-elsif ENV['RUBYLIB']
-    exec(Hash['RUBYLIB' => nil], $0, *ARGV)
-end
-
+#{RUBYLIB_REINIT}
 ENV['BUNDLE_GEMFILE'] = '#{autoproj_gemfile_path}'
 ENV['AUTOPROJ_CURRENT_ROOT'] = '#{root_dir}'
 Gem.paths = Hash['GEM_HOME' => '#{gems_gem_home}', 'GEM_PATH' => '']
@@ -500,14 +566,7 @@ Gem.paths = Hash['GEM_HOME' => '#{gems_gem_home}', 'GEM_PATH' => '']
                 gems_gem_home, load_line)
 "#! #{ruby_executable}
 
-if defined?(Bundler)
-    Bundler.with_clean_env do
-        exec(Hash['RUBYLIB' => nil], $0, *ARGV)
-    end
-elsif ENV['RUBYLIB']
-    exec(Hash['RUBYLIB' => nil], $0, *ARGV)
-end
-
+#{RUBYLIB_REINIT}
 ENV['BUNDLE_GEMFILE'] = '#{autoproj_gemfile_path}'
 ENV['AUTOPROJ_CURRENT_ROOT'] = '#{root_dir}'
 require 'rubygems'
@@ -601,8 +660,11 @@ require 'bundler/setup'
                 #
                 # So, we're calling 'gem' as a subcommand to discovery the
                 # actual bindir
-                bindir = IO.popen(env_for_child,
-                    [Gem.ruby, '-e', 'puts "#{Gem.user_dir}/bin"']).read
+                bindir = IO.popen(
+                    env_for_child,
+                    [Gem.ruby, '-e', 'puts "#{Gem.user_dir}/bin"'], # rubocop:disable Lint/InterpolationCheck
+                    &:read
+                )
                 if bindir
                     @gem_bindir = bindir.chomp
                 else
@@ -610,11 +672,11 @@ require 'bundler/setup'
                 end
             end
 
-            def install
+            def install(bundler_version: self.bundler_version)
                 if ENV['BUNDLER_GEMFILE']
                     raise "cannot run autoproj_install or autoproj_bootstrap while "\
-                        "under a 'bundler exec' subcommand or having loaded an env.sh. "\
-                        "Open a new console and try again"
+                          "under a 'bundler exec' subcommand or having loaded an "\
+                          "env.sh. Open a new console and try again"
                 end
 
                 gem_program  = self.class.guess_gem_program
@@ -622,13 +684,12 @@ require 'bundler/setup'
                 env['GEM_HOME'] = [gems_gem_home]
                 env['GEM_PATH'] = [gems_gem_home]
 
-                if bundler = find_bundler(gem_program)
+                if (bundler = find_bundler(gem_program, version: bundler_version))
                     puts "Detected bundler at #{bundler}"
                 else
                     puts "Installing bundler in #{gems_gem_home}"
-                    if !(bundler = install_bundler(gem_program))
-                        exit 1
-                    end
+                    bundler = install_bundler(gem_program, version: bundler_version)
+                    exit(1) unless bundler
                 end
                 self.class.rewrite_shims(
                     File.join(dot_autoproj, 'bin'),
@@ -640,7 +701,7 @@ require 'bundler/setup'
                 save_gemfile
 
                 puts "Installing autoproj in #{gems_gem_home}"
-                install_autoproj(bundler)
+                install_autoproj(bundler, bundler_version: bundler_version)
             end
 
             def load_config
@@ -742,8 +803,13 @@ end
 ENV.delete('BUNDLE_GEMFILE')
 ENV.delete('RUBYLIB')
 ops = Autoproj::Ops::Install.new(Dir.pwd)
+
+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"
+    ops.add_seed_config(existing_config)
+end
 ops.parse_options(ARGV)
 ops.stage1
-if !ops.skip_stage2?
-    ops.call_stage2
-end
+ops.call_stage2 unless ops.skip_stage2?

data/bin/autoproj_install.in

@@ -13,8 +13,13 @@ require 'autoproj/ops/install'
 ENV.delete('BUNDLE_GEMFILE')
 ENV.delete('RUBYLIB')
 ops = Autoproj::Ops::Install.new(Dir.pwd)
+
+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"
+    ops.add_seed_config(existing_config)
+end
 ops.parse_options(ARGV)
 ops.stage1
-if !ops.skip_stage2?
-    ops.call_stage2
-end
+ops.call_stage2 unless ops.skip_stage2?

data/lib/autoproj/autobuild_extensions/dsl.rb

@@ -35,24 +35,30 @@ module Autoproj
     # @deprecated use Autoproj.workspace.in_package_set or add a proper Loader
     #   object to your class
     def self.in_package_set(package_set, path, &block)
-        Autoproj.warn_deprecated __method__,
+        Autoproj.warn_deprecated(
+            __method__,
             "use Autoproj.workspace.in_package_set instead"
+        )
         Autoproj.workspace.in_package_set(package_set, path, &block)
     end
 
     # @deprecated use Autoproj.workspace.current_file or add a proper Loader
     #   object to your class
     def self.current_file
-        Autoproj.warn_deprecated __method__,
+        Autoproj.warn_deprecated(
+            __method__,
             "use AUtoproj.workspace.current_file instead"
+        )
         Autoproj.workspace.current_file
     end
 
     # @deprecated use Autoproj.workspace.current_package_set or add a proper
     #   Loader object to your class
     def self.current_package_set
-        Autoproj.warn_deprecated __method__,
+        Autoproj.warn_deprecated(
+            __method__,
             "use Autoproj.workspace.current_package_set instead"
+        )
         Autoproj.workspace.current_package_set
     end
 
@@ -60,22 +66,27 @@ module Autoproj
     #   Beware that the return value changed from Autobuild::Package to
     #   Autoproj::PackageDefinition
     def self.define(package_type, spec, &block)
-        Autoproj.warn_deprecated __method__, "use Autoproj.workspace.define_package "\
+        Autoproj.warn_deprecated(
+            __method__, "use Autoproj.workspace.define_package "\
             "instead (and beware that the return value changed from "\
             "Autobuild::Package to Autoproj::PackageDefinition)"
+        )
         workspace.define_package(package_type, spec, block, *current_file).
             autobuild
     end
 
     def self.loaded_autobuild_files
-        Autoproj.warn_deprecated __method__,
-            "use Autoproj.workspace.loaded_autobuild_files"
+        Autoproj.warn_deprecated(
+            __method__, "use Autoproj.workspace.loaded_autobuild_files"
+        )
         Autoproj.workspace.loaded_autobuild_files
     end
 
     def self.import_autobuild_file(package_set, path)
-        Autoproj.warn_deprecated __method__,
+        Autoproj.warn_deprecated(
+            __method__,
             "use Autoproj.workspace.import_autobuild_file"
+        )
         Autoproj.workspace.import_autobuild_file(package_set, path)
     end
 
@@ -149,11 +160,13 @@ end
 
 # Adds a new setup block to an existing package
 def setup_package(package_name, workspace: Autoproj.workspace, &block)
-    raise ConfigError.new, "you must give a block to #setup_package" unless block
+    unless block
+        raise Autoproj::ConfigError.new, 'you must give a block to #setup_package'
+    end
 
     package_definition = workspace.manifest.find_package_definition(package_name)
     if !package_definition
-        raise ConfigError.new, "#{package_name} is not a known package"
+        raise Autoproj::ConfigError.new, "#{package_name} is not a known package"
     elsif package_definition.autobuild.kind_of?(Autobuild::DummyPackage)
         # Nothing to do!
     else
@@ -408,9 +421,9 @@ def source_package(options, workspace: Autoproj.workspace)
 end
 
 # @deprecated use Autoproj.config.declare instead
-def configuration_option(*opts, &block)
+def configuration_option(*opts, **kw, &block)
     Autoproj.warn_deprecated __method__, "use Autoproj.config.declare instead"
-    Autoproj.config.declare(*opts, &block)
+    Autoproj.config.declare(*opts, **kw, &block)
 end
 
 # @deprecated use Autoproj.config.get instead
@@ -488,11 +501,13 @@ def renamed_package(current_name, old_name, options)
         explicitely_selected_in_layout?(old_name)
     if options[:obsolete] && !explicit_selection
         import_package old_name
-        Autoproj.workspace.manifest.exclude_package old_name,
+        Autoproj.workspace.manifest.exclude_package(
+            old_name,
             "#{old_name} has been renamed to #{current_name}, you still have "\
             "the option of using the old name by adding '- #{old_name}' explicitely "\
             "in the layout in autoproj/manifest, but be warned that the name will "\
             "stop being usable at all in the near future"
+        )
     else
         metapackage old_name, current_name
     end