autoproj 2.11.0 → 2.12.0

data/lib/autoproj/ops/install.rb

@@ -1,7 +1,10 @@
+# frozen_string_literal: true
+
 require 'pathname'
 require 'optparse'
 require 'fileutils'
 require 'yaml'
+require 'English'
 
 module Autoproj
     module Ops
@@ -13,6 +16,36 @@ module Ops
         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
@@ -220,6 +253,10 @@ def default_gemfile_contents(autoproj_version = ">= 2.0.0")
                  "gem \"utilrb\", \">= 3.0.1\""].join("\n")
             end
 
+            def add_seed_config(path)
+                @config.merge!(YAML.safe_load(File.read(path)))
+            end
+
             # Parse the provided command line options and returns the non-options
             def parse_options(args = ARGV)
                 options = OptionParser.new do |opt|
@@ -243,6 +280,10 @@ def parse_options(args = ARGV)
                     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
@@ -257,9 +298,14 @@ def parse_options(args = ARGV)
                         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 '\
@@ -289,22 +335,50 @@ def parse_options(args = ARGV)
                 @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
@@ -312,6 +386,9 @@ def install_bundler(gem_program, silent: false)
                     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')]
@@ -322,14 +399,14 @@ def install_bundler(gem_program, silent: false)
                         '--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 "\
@@ -338,7 +415,7 @@ def install_bundler(gem_program, silent: false)
                 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')
@@ -353,14 +430,19 @@ def install_autoproj(bundler)
                 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
@@ -369,7 +451,7 @@ def install_autoproj(bundler)
                     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)
@@ -425,11 +507,7 @@ def self.shim_bundler(script_lines, ruby_executable, autoproj_gemfile_path, gems
 #
 
 # 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')
@@ -441,12 +519,7 @@ def self.shim_bundler(script_lines, ruby_executable, autoproj_gemfile_path, gems
             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')
@@ -471,14 +544,7 @@ def self.shim_script(script_lines, ruby_executable, root_dir,
 #
 
 # 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' => '']
@@ -490,14 +556,7 @@ def self.shim_script_old(ruby_executable, root_dir, autoproj_gemfile_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'
@@ -591,8 +650,11 @@ def gem_bindir
                 #
                 # 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
@@ -600,11 +662,11 @@ def gem_bindir
                 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
@@ -612,13 +674,12 @@ def install
                 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'),
@@ -630,7 +691,7 @@ def install
                 save_gemfile
 
                 puts "Installing autoproj in #{gems_gem_home}"
-                install_autoproj(bundler)
+                install_autoproj(bundler, bundler_version: bundler_version)
             end
 
             def load_config

data/lib/autoproj/ops/phase_reporting.rb

@@ -0,0 +1,49 @@
+module Autoproj
+    module Ops
+        # Common logic to generate build/import/utility reports
+        class PhaseReporting
+            def initialize(name, path, metadata_get)
+                @name = name
+                @path = path
+                @metadata_get = metadata_get
+            end
+
+            def create_report(autobuild_packages)
+                info = autobuild_packages.each_with_object({}) do |p, map|
+                    map[p.name] = @metadata_get.call(p)
+                end
+
+                dump = JSON.dump(
+                    "#{@name}_report" => {
+                        'timestamp' => Time.now,
+                        'packages' => info
+                    }
+                )
+
+                FileUtils.mkdir_p File.dirname(@path)
+                File.open(@path, 'w') do |io|
+                    io.write dump
+                end
+            end
+
+            def initialize_incremental_report
+                FileUtils.mkdir_p File.dirname(@path)
+                @incremental_report = ""
+            end
+
+            def report_incremental(autobuild_package)
+                new_metadata = @metadata_get.call(autobuild_package)
+                prefix = @incremental_report.empty? ? "\n" : ",\n"
+                @incremental_report.concat(
+                    "#{prefix}\"#{autobuild_package.name}\": #{JSON.dump(new_metadata)}"
+                )
+                File.open(@path, 'w') do |io|
+                    io.write "{ \"#{@name}_report\": "\
+                             "{\"timestamp\": #{JSON.dump(Time.now)}, \"packages\": {"
+                    io.write(@incremental_report)
+                    io.write "}}}"
+                end
+            end
+        end
+    end
+end

data/lib/autoproj/ops/snapshot.rb

@@ -119,6 +119,7 @@ def error_or_warn(package, error)
 
         def snapshot_packages(packages, target_dir = nil, only_local: true, fingerprint: false)
             result = Array.new
+            fingerprint_memo = Hash.new
             packages.each do |package_name|
                 package  = manifest.find_package_definition(package_name)
                 if !package
@@ -141,7 +142,7 @@ def snapshot_packages(packages, target_dir = nil, only_local: true, fingerprint:
                     end
 
                 if fingerprint
-                    vcs_info['fingerprint'] = package.autobuild.fingerprint
+                    vcs_info['fingerprint'] = package.autobuild.fingerprint(memo: fingerprint_memo)
                 end
 
                 if vcs_info

data/lib/autoproj/os_package_installer.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'autoproj/package_managers/manager'
 require 'autoproj/package_managers/unknown_os_manager'
 require 'autoproj/package_managers/shell_script_manager'
@@ -37,7 +39,9 @@ class OSPackageInstaller
         attr_reader :installed_resolved_packages
 
         attr_writer :silent
-        def silent?; @silent end
+        def silent?
+            @silent
+        end
 
         class << self
             attr_accessor :force_osdeps
@@ -60,12 +64,12 @@ def initialize(ws, os_package_resolver, package_managers: PACKAGE_MANAGERS)
 
         # Returns the package manager object for the current OS
         def os_package_manager
-            if !@os_package_manager
+            unless @os_package_manager
                 name = os_package_resolver.os_package_manager
                 @os_package_manager = package_managers[name] ||
-                    PackageManagers::UnknownOSManager.new(ws)
+                                      PackageManagers::UnknownOSManager.new(ws)
             end
-            return @os_package_manager
+            @os_package_manager
         end
 
         # Returns the set of package managers
@@ -75,13 +79,17 @@ def each_manager(&block)
             package_managers.each_value(&block)
         end
 
+        def each_manager_with_name(&block)
+            package_managers.each(&block)
+        end
+
         HANDLE_ALL  = 'all'
         HANDLE_RUBY = 'ruby'
         HANDLE_OS   = 'os'
         HANDLE_NONE = 'none'
 
         def osdeps_mode_option_unsupported_os(config)
-            long_doc =<<-EOT
+            long_doc = <<-EOT
 The software packages that autoproj will have to build may require other
 prepackaged softwares (a.k.a. OS dependencies) to be installed (RubyGems
 packages, packages from your operating system/distribution, ...). Autoproj is
@@ -153,9 +161,9 @@ def osdeps_mode_option_supported_os(config)
             message = [ "Which prepackaged software (a.k.a. 'osdeps') should autoproj install automatically (all, none or a comma-separated list of: os gem pip) ?", long_doc.strip ]
 
             config.declare 'osdeps_mode', 'string',
-                default: 'all',
-                doc: message,
-                lowercase: true
+                           default: 'all',
+                           doc: message,
+                           lowercase: true
         end
 
         def define_osdeps_mode_option
@@ -171,14 +179,14 @@ def osdeps_mode_string_to_value(string)
             modes = []
             user_modes.each do |str|
                 case str
-                when 'all'  then modes.concat(['os', 'gem', 'pip'])
+                when 'all'  then modes.concat(%w[os gem pip])
                 when 'ruby' then modes << 'gem'
                 when 'gem'  then modes << 'gem'
                 when 'pip'  then modes << 'pip'
                 when 'os'   then modes << 'os'
                 when 'none' then
                 else
-                    if package_managers.has_key?(str)
+                    if package_managers.key?(str)
                         modes << str
                     else
                         raise ArgumentError, "#{str} is not a known package handler, known handlers are #{package_managers.keys.sort.join(", ")}"
@@ -442,5 +450,5 @@ def install_manager_packages(manager, package_list, install_only: false, run_pac
             end
         end
     end
-end 
+end