autoproj 2.9.0 → 2.10.0

data/lib/autoproj/package_selection.rb

@@ -50,6 +50,24 @@ def empty?
                 selection.empty?
             end
 
+            # Test if a package is in the ignore list
+            #
+            # @param [String] pkg_name Name of the package
+            # @return [Bool] true, if package is in the ignore list, false
+            # otherwise
+            def ignored?(pkg_name)
+                ignores.include?(pkg_name)
+            end
+
+            # Test if a package is in the exclusions list
+            #
+            # @param [String] pkg_name Name of the package
+            # @return [Bool] true, if package is in the exclusion list, false
+            # otherwise
+            def excluded?(pkg_name)
+                exclusions.include?(pkg_name)
+            end
+
             # Returns the source packages selected explicitely or through
             # dependencies
             #

data/lib/autoproj/reporter.rb

@@ -15,6 +15,14 @@ def self.silent(&block)
         Autobuild.silent(&block)
     end
 
+    def self.not_silent
+        silent = Autobuild.silent?
+        Autobuild.silent = false
+        yield
+    ensure
+        Autobuild.silent = silent
+    end
+
     def self.message(*args)
         Autobuild.message(*args)
     end
@@ -43,10 +51,12 @@ def self.report_interrupt(io = STDERR)
     class Reporter < Autobuild::Reporter
         def error(error)
             error_lines = error.to_s.split("\n")
-            Autoproj.message("Command failed", :bold, :red, STDERR)
-            Autoproj.message("#{error_lines.shift}", :bold, :red, STDERR)
-            error_lines.each do |line|
-                Autoproj.message line, STDERR
+            Autoproj.not_silent do
+                Autoproj.message("Command failed", :bold, :red, STDERR)
+                Autoproj.message(error_lines.shift.to_s, :bold, :red, STDERR)
+                error_lines.each do |line|
+                    Autoproj.message line, STDERR
+                end
             end
         end
 
@@ -56,6 +66,7 @@ def reset_timer
 
         def elapsed_time
             return unless @timer_start
+
             secs = Time.now - @timer_start
             return if secs < 1
 
@@ -63,6 +74,7 @@ def elapsed_time
                 if secs > 0
                     secs, n = secs.divmod(count)
                     next if (val = n.to_i) == 0
+
                     "#{val} #{val > 1 ? name + 's' : name}"
                 end
             end.compact.reverse.join(' ')
@@ -70,7 +82,8 @@ def elapsed_time
 
         def success
             elapsed_string = elapsed_time ? " (took #{elapsed_time})" : ''
-            Autoproj.message("Command finished successfully at #{Time.now}#{elapsed_string}", :bold, :green)
+            Autoproj.message("Command finished successfully at "\
+                             "#{Time.now}#{elapsed_string}", :bold, :green)
             if Autobuild.post_success_message
                 Autoproj.message Autobuild.post_success_message
             end
@@ -79,57 +92,58 @@ def success
 
     def self.report(root_dir: nil, silent: nil, debug: Autobuild.debug,
                     on_package_success: :report,
-                    on_package_failures: Autobuild::Reporting.default_report_on_package_failures)
+                    on_package_failures: Autobuild::Reporting
+                                         .default_report_on_package_failures)
         reporter = Autoproj::Reporter.new
         Autobuild::Reporting << reporter
         interrupted = nil
 
-        if !silent.nil?
+        unless silent.nil?
             on_package_success = silent ? :silent : :report
         end
-        silent_errors = [:report_silent, :exit_silent].include?(on_package_failures)
-
-        package_failures = Autobuild::Reporting.report(on_package_failures: :report_silent) do
-            begin
-                reporter.reset_timer
-                yield
-            rescue Interrupt => e
-                interrupted = e
+        silent_errors = %I[report_silent exit_silent].include?(on_package_failures)
+
+        package_failures =
+            Autobuild::Reporting.report(on_package_failures: :report_silent) do
+                begin
+                    reporter.reset_timer
+                    yield
+                rescue Interrupt => e
+                    interrupted = e
+                end
             end
-        end
 
 
         if package_failures.empty?
-            if interrupted
-                raise interrupted
-            elsif on_package_success == :report
-                Autobuild::Reporting.success
-            end
+            raise interrupted if interrupted
+
+            Autobuild::Reporting.success if on_package_success == :report
             return []
         else
-            Autobuild::Reporting.report_finish_on_error(
-                package_failures, on_package_failures: on_package_failures, interrupted_by: interrupted)
+            Autobuild::Reporting.report_finish_on_error(package_failures,
+                on_package_failures: on_package_failures,
+                interrupted_by: interrupted)
         end
-
     rescue CLI::CLIException, InvalidWorkspace, ConfigError => e
         if silent_errors
-            return [e]
+            [e]
         elsif on_package_failures == :raise
             raise e
         elsif on_package_failures == :report
-            Autoproj.error e.message
+            Autoproj.not_silent do
+                Autoproj.error e.message
+            end
             [e]
         elsif on_package_failures == :exit
-            Autoproj.error e.message
+            Autoproj.not_silent do
+                Autoproj.error e.message
+            end
             exit 1
         end
-
     rescue SystemExit
         raise
     ensure
-        if !silent_errors && interrupted
-            report_interrupt
-        end
+        report_interrupt if !silent_errors && interrupted
 
         Autobuild::Reporting.remove(reporter) if reporter
     end

data/lib/autoproj/test.rb

@@ -55,6 +55,14 @@ module SelfTest
         attr_reader :ws
 
         def setup
+            if ENV['AUTOPROJ_CURRENT_ROOT']
+                raise "cannot have a workspace's env.sh loaded while running the "\
+                      "Autoproj test suite"
+            end
+
+            if defined?(Autoproj::CLI::Main)
+                Autoproj::CLI::Main.default_report_on_package_failures = :raise
+            end
             FileUtils.rm_rf fixture_gem_home
             @gem_server_pid = nil
             @tmpdir = Array.new
@@ -75,11 +83,15 @@ def teardown
             Autobuild::Package.clear
             Autoproj.silent = false
 
-            if @gem_server_pid
-                stop_gem_server
-            end
+            stop_gem_server if @gem_server_pid
 
             FileUtils.rm_rf fixture_gem_home
+            if defined?(Autoproj::CLI::Main)
+                Autoproj::CLI::Main.default_report_on_package_failures = nil
+            end
+            if ENV.delete('AUTOPROJ_CURRENT_ROOT')
+                raise "AUTOPROJ_CURRENT_ROOT has been set by this test !!!!"
+            end
         end
 
         def create_bootstrap
@@ -102,9 +114,7 @@ def scripts_dir
 
         def find_gem_dir(gem_name)
             Bundler.definition.specs.each do |spec|
-                if spec.name == gem_name
-                    return spec
-                end
+                return spec if spec.name == gem_name
             end
             nil
         end
@@ -119,22 +129,21 @@ def autoproj_gemfile_to_local_checkout
         end
 
         def invoke_test_script(name, *arguments,
-                               dir: nil,
-                               gemfile_source: nil,
-                               use_autoproj_from_rubygems: (ENV['USE_AUTOPROJ_FROM_RUBYGEMS'] == '1'),
-                               seed_config: File.join(scripts_dir, 'seed-config.yml'),
-                               env: Hash.new, display_output: false, copy_from: nil,
-                               **system_options)
-            package_base_dir = File.expand_path(File.join('..', '..'), File.dirname(__FILE__))
+                dir: nil,
+                gemfile_source: nil,
+                use_autoproj_from_rubygems: (ENV['USE_AUTOPROJ_FROM_RUBYGEMS'] == '1'),
+                interactive: true,
+                seed_config: File.join(scripts_dir, 'seed-config.yml'),
+                env: Hash.new, display_output: false, copy_from: nil,
+                **system_options)
+            package_base_dir = File.expand_path(File.join('..', '..'), __dir__)
+
             script = File.expand_path(name, scripts_dir)
-            if !File.file?(script)
+            unless File.file?(script)
                 raise ArgumentError, "no test script #{name} in #{scripts_dir}"
             end
 
-            if seed_config
-                arguments << '--seed-config' << seed_config
-            end
-
+            arguments << '--seed-config' << seed_config if seed_config
             dir ||= make_tmpdir
 
             if gemfile_source || !use_autoproj_from_rubygems
@@ -145,6 +154,8 @@ def invoke_test_script(name, *arguments,
                 arguments << "--gemfile" << gemfile_path << "--gem-source" << "http://localhost:8808"
             end
 
+            arguments << "--no-interactive" unless interactive
+
             if copy_from
                 test_workspace = File.expand_path(copy_from, scripts_dir)
                 if File.directory?(test_workspace)
@@ -155,13 +166,13 @@ def invoke_test_script(name, *arguments,
             result = nil
             stdout, stderr = capture_subprocess_io do
                 default_env = Hash[
-                    'TEST_COMMAND_NAME' => self.to_s.gsub(/[^\w]/, '_'),
+                    'TEST_COMMAND_NAME' => to_s.gsub(/[^\w]/, '_'),
                     'PACKAGE_BASE_DIR' => package_base_dir,
                     'RUBY' => Gem.ruby
                 ]
                 result = Bundler.clean_system(
-                    default_env.merge(env),
-                    script, *arguments, in: :close, **Hash[chdir: dir].merge(system_options))
+                    default_env.merge(env), script, *arguments,
+                    in: :close, **Hash[chdir: dir].merge(system_options))
             end
 
             if !result
@@ -172,7 +183,7 @@ def invoke_test_script(name, *arguments,
                 puts stdout
                 puts stderr
             end
-            return dir, stdout, stderr
+            [dir, stdout, stderr]
         end
 
         def fixture_gem_home
@@ -181,20 +192,29 @@ def fixture_gem_home
 
         def prepare_fixture_gem_home
             FileUtils.rm_rf fixture_gem_home
-            bundled_gems_path = File.expand_path(File.join("..", ".."), find_gem_dir('utilrb').full_gem_path)
+            bundled_gems_path = File.expand_path(File.join("..", ".."),
+                find_gem_dir('utilrb').full_gem_path)
             FileUtils.cp_r bundled_gems_path, fixture_gem_home
 
             vendor = File.join(__dir__, '..', '..', 'vendor')
-            cached_bundler_gem = File.join(vendor, "bundler-#{Bundler::VERSION}.gem")
-            if !File.file?(cached_bundler_gem)
+            bundler_filename = "bundler-#{Bundler::VERSION}.gem"
+            cached_bundler_gem = File.join(vendor, bundler_filename)
+            unless File.file?(cached_bundler_gem)
                 FileUtils.mkdir_p vendor
-                if !system(Ops::Install.guess_gem_program, 'fetch', '-v', Bundler::VERSION, 'bundle', chdir: vendor)
+                Bundler.clean_system(
+                    Ops::Install.guess_gem_program, 'fetch', '-v',
+                    Bundler::VERSION, 'bundler', chdir: vendor)
+
+                unless File.file?(bundler_filename)
                     raise "cannot download the bundler gem"
                 end
             end
 
             capture_subprocess_io do
-                Bundler.clean_system(Hash['GEM_HOME' => fixture_gem_home, 'GEM_PATH' => nil], Ops::Install.guess_gem_program, 'install', '--no-document', cached_bundler_gem)
+                Bundler.clean_system(
+                    Hash['GEM_HOME' => fixture_gem_home, 'GEM_PATH' => nil],
+                    Ops::Install.guess_gem_program, 'install', '--no-document',
+                    cached_bundler_gem)
             end
         end
 
@@ -202,13 +222,18 @@ def start_gem_server(path = fixture_gem_home)
             require 'socket'
             require 'rubygems/server'
             if @gem_server_pid
-                raise ArgumentError, "#start_gem_server already called, call stop_gem_server before calling start_gem_server again"
+                raise ArgumentError, "#start_gem_server already called, "\
+                    "call stop_gem_server before calling start_gem_server again"
             end
-            @gem_server_pid = spawn(Hash['RUBYOPT' => nil], Gem.ruby, Ops::Install.guess_gem_program, 'server', '--quiet', '--dir', path, out: :close, err: :close)
-            while true
-                begin TCPSocket.new('127.0.0.1', 8808)
+            @gem_server_pid = spawn(
+                Hash['RUBYOPT' => nil],
+                Gem.ruby, Ops::Install.guess_gem_program, 'server',
+                '--quiet', '--dir', path, out: :close, err: :close)
+            loop do
+                begin
+                    TCPSocket.new('127.0.0.1', 8808)
                     break
-                rescue Errno::ECONNREFUSED
+                rescue Errno::ECONNREFUSED # rubocop:disable Lint/HandleExceptions
                 end
             end
         end
@@ -219,7 +244,7 @@ def stop_gem_server
             @gem_server_pid = nil
         end
 
-        def capture_deprecation_message(&block)
+        def capture_deprecation_message
             level = Autoproj.warn_deprecated_level
             Autoproj.warn_deprecated_level = -1
             capture_subprocess_io do
@@ -237,12 +262,12 @@ def find_bundled_gem_path(bundler, gem_name, gemfile)
                 chdir: File.dirname(gemfile))
             out_w.close
             output = out_r.read.chomp
-            assert result, "#{output}"
+            assert result, "bundler show #{gem_name} failed, output: '#{output}'"
             output
         end
 
         def workspace_env(varname)
-            _, stdout, _ = invoke_test_script 'display-env.sh', varname, dir: install_dir
+            _, stdout, = invoke_test_script 'display-env.sh', varname, dir: install_dir
             stdout.chomp
         end
 
@@ -260,7 +285,7 @@ def ws_define_package_manager(name, strict: false, call_while_empty: false)
                 define_method(:strict?) { strict }
                 define_method(:call_while_empty?) { call_while_empty }
             end
-            manager = flexmock(manager),
+            manager = flexmock(manager)
             ws_package_managers[name] = manager
         end
 
@@ -271,22 +296,26 @@ def ws_create_os_package_resolver
                 os_package_manager: 'os')
         end
 
-        def ws_create(dir = make_tmpdir)
+        def ws_create(dir = make_tmpdir, partial_config: false)
             require 'autoproj/ops/main_config_switcher'
-            FileUtils.cp_r Ops::MainConfigSwitcher::MAIN_CONFIGURATION_TEMPLATE, File.join(dir, 'autoproj')
+            FileUtils.cp_r Ops::MainConfigSwitcher::MAIN_CONFIGURATION_TEMPLATE,
+                File.join(dir, 'autoproj')
             FileUtils.mkdir_p File.join(dir, '.autoproj')
 
             ws_create_os_package_resolver
             @ws = Workspace.new(
                 dir, os_package_resolver: ws_os_package_resolver,
                      package_managers: ws_package_managers)
-            ws.config.set 'osdeps_mode', 'all'
-            ws.config.set 'apt_dpkg_update', true
+
+            unless partial_config
+                ws.config.set 'osdeps_mode', 'all'
+                ws.config.set 'apt_dpkg_update', true
+            end
             ws.config.set 'GITHUB', 'http,ssh', true
             ws.config.set 'GITORIOUS', 'http,ssh', true
             ws.config.set 'gems_install_path', File.join(dir, 'gems')
-            ws.config.save
             ws.prefix_dir = make_tmpdir
+            ws.config.save
             ws
         end
 
@@ -294,7 +323,8 @@ def ws_clear_layout
             ws.manifest.clear_layout
         end
 
-        def ws_define_package_set(name, vcs = VCSDefinition.from_raw(type: 'none'), **options)
+        def ws_define_package_set(name, vcs = VCSDefinition.from_raw(type: 'none'),
+                                  **options)
             package_set = PackageSet.new(ws, vcs, name: name, **options)
             ws.manifest.register_package_set(package_set)
             package_set
@@ -311,7 +341,8 @@ def ws_create_local_package_set(name, path, source_data: Hash.new, **options)
             package_set
         end
 
-        def ws_add_package_set_to_layout(name, vcs = VCSDefinition.from_raw(type: 'none'), **options)
+        def ws_add_package_set_to_layout(name, vcs = VCSDefinition.from_raw(type: 'none'),
+                                         **options)
             package_set = ws_define_package_set(name, vcs, **options)
             ws.manifest.add_package_set_to_layout(package_set)
             package_set
@@ -334,12 +365,12 @@ def ws_add_osdep_entries_to_layout(entries)
             end
         end
 
-        def ws_define_package(package_type, package_name, package_set: ws.manifest.main_package_set, create: true)
+        def ws_define_package(package_type, package_name,
+                              package_set: ws.manifest.main_package_set,
+                              create: true)
             package = Autobuild.send(package_type, package_name)
             package.srcdir = File.join(ws.root_dir, package_name.to_s)
-            if create
-                FileUtils.mkdir_p package.srcdir
-            end
+            FileUtils.mkdir_p package.srcdir if create
             autoproj_package = ws.register_package(package, nil, package_set)
             yield(package) if block_given?
             autoproj_package
@@ -353,8 +384,10 @@ def ws_define_package_overrides(package, package_set, vcs_spec)
             package_set.add_overrides_entry(package.name, vcs_spec)
         end
 
-        def ws_add_package_to_layout(package_type, package_name, package_set: ws.manifest.main_package_set, &block)
-            pkg = ws_define_package(package_type, package_name, package_set: package_set, &block)
+        def ws_add_package_to_layout(package_type, package_name,
+                                     package_set: ws.manifest.main_package_set, &block)
+            pkg = ws_define_package(package_type, package_name,
+                package_set: package_set, &block)
             ws.manifest.add_package_to_layout(pkg)
             pkg
         end
@@ -374,25 +407,31 @@ def ws_setup_package_dirs(package, create_srcdir: true)
             elsif File.directory?(srcdir)
                 FileUtils.rm_rf srcdir
             end
-            package.autobuild.builddir = builddir = File.join(ws.root_dir, 'build', package.name)
-            package.autobuild.prefix = prefix = File.join(ws.root_dir, 'prefix', package.name)
-            return srcdir, builddir, prefix
+            package.autobuild.builddir = builddir =
+                File.join(ws.root_dir, 'build', package.name)
+            package.autobuild.prefix = prefix =
+                File.join(ws.root_dir, 'prefix', package.name)
+            [srcdir, builddir, prefix]
         end
 
         def ws_create_git_package_set(name, source_data = Hash.new)
             dir = make_tmpdir
-            if !system('git', 'init', chdir: dir, out: :close)
+            unless system('git', 'init', chdir: dir, out: :close)
                 raise "failed to run git init"
             end
+
             File.open(File.join(dir, 'source.yml'), 'w') do |io|
                 YAML.dump(Hash['name' => name].merge(source_data), io)
             end
-            if !system('git', 'add', 'source.yml', chdir: dir, out: :close)
+            unless system('git', 'add', 'source.yml', chdir: dir, out: :close)
                 raise "failed to add the source.yml"
             end
-            if !system('git', 'commit', '-m', 'add source.yml', chdir: dir, out: :close)
+
+            unless system('git', 'commit', '-m', 'add source.yml',
+                          chdir: dir, out: :close)
                 raise "failed to commit the source.yml"
             end
+
             dir
         end
 
@@ -413,9 +452,21 @@ def ws_create_package_file(pkg, name, content)
             end
             path
         end
+
+        def gemfile_aruba
+            base_dir = File.expand_path('../../', __dir__)
+            gemfile_path = File.join(base_dir, 'tmp', 'Gemfile.local')
+            File.open(gemfile_path, 'w') do |io|
+                io.write <<~GEMFILE
+                source 'https://rubygems.org'
+                gem 'autoproj', path: '#{base_dir}'
+                GEMFILE
+            end
+            gemfile_path
+        end
     end
 end
 
-class Minitest::Test
+class Minitest::Test # rubocop:disable Style/ClassAndModuleChildren
     include Autoproj::SelfTest
 end