autoproj 2.10.2 → 2.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9816c7630ddb1758579428da56d50fcfd6e655ff69d9daddbe860c4f8d8c9501
-  data.tar.gz: ec2228ff0857f8a4d78fc7ee512a6ec50c2b02dec8bc15af725a43b8a97ddf31
+  metadata.gz: 27b34232b7064fe41e6ffbf64a366c8177bd07176890ae94d4d2fb38cb6a9007
+  data.tar.gz: 6f10cee97b778a086dbe009dd19a7af9c3e416b9a18b18f1e7a8ae090a7dbda1
 SHA512:
-  metadata.gz: 362c3cc73ce68418dc18fa0f018523de0a0b0ea27f6f72fc56d7cf8c820dae1d1eacdf759bae614ad5bf547973a44f6e7cadbe1863df1d75fc2673cec124c855
-  data.tar.gz: 877354416b6ab05061f99c630ea535aeb6cbabd529682a0b85d051567687a58430e49b4b4c2c61f857edcc193d6220c202972f0deadd2ba59d0bd42ada907ff6
+  metadata.gz: b01c93d7197d16bebd63aa83deba8c761950a848526b5ce23f06e90f0b7904ea07924b71ef3d428148779cc6ea83b577033e0b069e6b3c396f21feec2f249f3e
+  data.tar.gz: 99e5701cb311313f771d413c20eb6b37f9da8975636caf17c480cdfe695fe3d50f293f3c19260e17253540be3c5bda04e844391750df108321c4e2db9d6b1671

data/.rubocop.yml

@@ -45,7 +45,7 @@ Layout/AlignParameters:
 Layout/DotPosition:
     Enabled: false
 
-Layout/FirstParameterIndentation:
+Layout/IndentFirstArgument:
     Enabled: false
 
 Layout/IndentAssignment:

data/autoproj.gemspec

@@ -25,7 +25,7 @@ Gem::Specification.new do |s|
     s.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
 
     s.add_runtime_dependency "bundler"
-    s.add_runtime_dependency "autobuild", ">= 1.14.0"
+    s.add_runtime_dependency "autobuild", ">= 1.19.0"
     s.add_runtime_dependency "backports", '~> 3.0'
     s.add_runtime_dependency "utilrb", '~> 3.0.0', ">= 3.0.0"
     s.add_runtime_dependency "thor", '~> 0.20.0'
@@ -40,5 +40,6 @@ Gem::Specification.new do |s|
     s.add_development_dependency "simplecov"
     s.add_development_dependency "aruba"
     s.add_development_dependency "tty-cursor"
+    s.add_development_dependency "timecop"
 end
 

data/bin/autoproj_bootstrap

@@ -242,54 +242,54 @@ module Autoproj
                     opt.on '--debug', 'Run in debug mode' do
                         @autoproj_options << '--debug'
                     end
-                    opt.on '--gem-source=URL', String, "use this source for RubyGems "\
-                        "instead of rubygems.org" do |url|
+                    opt.on '--gem-source=URL', String, 'use this source for RubyGems '\
+                        'instead of rubygems.org' do |url|
                         @gem_source = url
                     end
-                    opt.on '--gems-path=PATH', "install gems under this path instead "\
-                        "of ~/.autoproj/gems" do |path|
+                    opt.on '--gems-path=PATH', 'install gems under this path instead '\
+                        'of ~/.autoproj/gems' do |path|
                         self.gems_install_path     = path
                     end
                     opt.on '--public-gems', "install gems in the default gem location" do
                         self.install_gems_in_gem_user_dir
                     end
-                    opt.on '--version=VERSION_CONSTRAINT', String, 'use the provided "\
-                        "string as a version constraint for autoproj' do |version|
+                    opt.on '--version=VERSION_CONSTRAINT', String, 'use the provided '\
+                        'string as a version constraint for autoproj' do |version|
                         if @gemfile
                             raise "cannot give both --version and --gemfile"
                         end
                         @gemfile = default_gemfile_contents(version)
                     end
-                    opt.on '--gemfile=PATH', String, 'use the given Gemfile to install "\
-                        "autoproj instead of the default' do |path|
+                    opt.on '--gemfile=PATH', String, 'use the given Gemfile to install '\
+                        'autoproj instead of the default' do |path|
                         if @gemfile
                             raise "cannot give both --version and --gemfile"
                         end
                         @gemfile = File.read(path)
                     end
-                    opt.on '--seed-config=PATH', String, 'path to a seed file that "\
-                        "should be used to initialize the configuration' do |path|
+                    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)))
                     end
-                    opt.on '--prefer-os-independent-packages', 'prefer OS-independent "\
-                        "packages (such as a RubyGem) over their OS-packaged equivalent "\
-                        "(e.g. the thor gem vs. the ruby-thor debian package)' do
+                    opt.on '--prefer-os-independent-packages', 'prefer OS-independent '\
+                        'packages (such as a RubyGem) over their OS-packaged equivalent '\
+                        '(e.g. the thor gem vs. the ruby-thor debian package)' do
                         @prefer_indep_over_os_packages = true
                     end
-                    opt.on '--[no-]color', 'do not use colored output (enabled by "\
-                        "default if the terminal supports it)' do |color|
+                    opt.on '--[no-]color', 'do not use colored output (enabled by '\
+                        'default if the terminal supports it)' do |color|
                         if color then @autoproj_options << "--color"
                         else @autoproj_options << '--no-color'
                         end
                     end
-                    opt.on '--[no-]progress', 'do not use progress output (enabled by "\
-                        "default if the terminal supports it)' do |progress|
+                    opt.on '--[no-]progress', 'do not use progress output (enabled by '\
+                        'default if the terminal supports it)' do |progress|
                         if progress then @autoproj_options << "--progress"
                         else @autoproj_options << '--no-progress'
                         end
                     end
-                    opt.on '--[no-]interactive', 'if non-interactive, use default "\
-                           "answer for questions' do |flag|
+                    opt.on '--[no-]interactive', 'if non-interactive, use default '\
+                           'answer for questions' do |flag|
                         if flag then @autoproj_options << "--interactive"
                         else @autoproj_options << "--no-interactive"
                         end

data/bin/autoproj_install

@@ -242,54 +242,54 @@ module Autoproj
                     opt.on '--debug', 'Run in debug mode' do
                         @autoproj_options << '--debug'
                     end
-                    opt.on '--gem-source=URL', String, "use this source for RubyGems "\
-                        "instead of rubygems.org" do |url|
+                    opt.on '--gem-source=URL', String, 'use this source for RubyGems '\
+                        'instead of rubygems.org' do |url|
                         @gem_source = url
                     end
-                    opt.on '--gems-path=PATH', "install gems under this path instead "\
-                        "of ~/.autoproj/gems" do |path|
+                    opt.on '--gems-path=PATH', 'install gems under this path instead '\
+                        'of ~/.autoproj/gems' do |path|
                         self.gems_install_path     = path
                     end
                     opt.on '--public-gems', "install gems in the default gem location" do
                         self.install_gems_in_gem_user_dir
                     end
-                    opt.on '--version=VERSION_CONSTRAINT', String, 'use the provided "\
-                        "string as a version constraint for autoproj' do |version|
+                    opt.on '--version=VERSION_CONSTRAINT', String, 'use the provided '\
+                        'string as a version constraint for autoproj' do |version|
                         if @gemfile
                             raise "cannot give both --version and --gemfile"
                         end
                         @gemfile = default_gemfile_contents(version)
                     end
-                    opt.on '--gemfile=PATH', String, 'use the given Gemfile to install "\
-                        "autoproj instead of the default' do |path|
+                    opt.on '--gemfile=PATH', String, 'use the given Gemfile to install '\
+                        'autoproj instead of the default' do |path|
                         if @gemfile
                             raise "cannot give both --version and --gemfile"
                         end
                         @gemfile = File.read(path)
                     end
-                    opt.on '--seed-config=PATH', String, 'path to a seed file that "\
-                        "should be used to initialize the configuration' do |path|
+                    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)))
                     end
-                    opt.on '--prefer-os-independent-packages', 'prefer OS-independent "\
-                        "packages (such as a RubyGem) over their OS-packaged equivalent "\
-                        "(e.g. the thor gem vs. the ruby-thor debian package)' do
+                    opt.on '--prefer-os-independent-packages', 'prefer OS-independent '\
+                        'packages (such as a RubyGem) over their OS-packaged equivalent '\
+                        '(e.g. the thor gem vs. the ruby-thor debian package)' do
                         @prefer_indep_over_os_packages = true
                     end
-                    opt.on '--[no-]color', 'do not use colored output (enabled by "\
-                        "default if the terminal supports it)' do |color|
+                    opt.on '--[no-]color', 'do not use colored output (enabled by '\
+                        'default if the terminal supports it)' do |color|
                         if color then @autoproj_options << "--color"
                         else @autoproj_options << '--no-color'
                         end
                     end
-                    opt.on '--[no-]progress', 'do not use progress output (enabled by "\
-                        "default if the terminal supports it)' do |progress|
+                    opt.on '--[no-]progress', 'do not use progress output (enabled by '\
+                        'default if the terminal supports it)' do |progress|
                         if progress then @autoproj_options << "--progress"
                         else @autoproj_options << '--no-progress'
                         end
                     end
-                    opt.on '--[no-]interactive', 'if non-interactive, use default "\
-                           "answer for questions' do |flag|
+                    opt.on '--[no-]interactive', 'if non-interactive, use default '\
+                           'answer for questions' do |flag|
                         if flag then @autoproj_options << "--interactive"
                         else @autoproj_options << "--no-interactive"
                         end

data/lib/autoproj/aruba_minitest.rb

@@ -25,6 +25,17 @@ def teardown
             super
         end
 
+        def generate_local_gemfile
+            path = expand_path("Gemfile.local")
+            File.open(path, 'w') do |io|
+                io.write <<~GEMFILE
+                source "https://rubygems.org"
+                gem "autoproj", path: "#{File.expand_path("../../", __dir__)}"
+                GEMFILE
+            end
+            path
+        end
+
         def run_command_and_stop(*args, fail_on_error: true, **kwargs)
             cmd = run_command(*args, **kwargs)
             cmd.stop
@@ -38,6 +49,10 @@ def run_command(*args, **kwargs)
             @aruba_api.run_command(*args, **kwargs)
         end
 
+        def cd(*args) # also defined by Rake
+            @aruba_api.cd(*args)
+        end
+
         def chmod(*args) # also defined by Rake
             @aruba_api.chmod(*args)
         end

data/lib/autoproj/autobuild_extensions/dsl.rb

@@ -185,10 +185,24 @@ def import_package(name, workspace: Autoproj.workspace, &block)
 def python_package(name, workspace: Autoproj.workspace)
     package_common(:python, name, workspace: workspace) do |pkg|
         pkg.internal_dependency 'python'
+        pkg.post_import do
+            pkg.depends_on 'python-setuptools' if pkg.install_mode?
+        end
         yield(pkg) if block_given?
     end
 end
 
+def common_make_default_test_task(pkg)
+    unless pkg.test_utility.source_dir
+        test_dir = File.join(pkg.srcdir, 'test')
+        if File.directory?(test_dir)
+            pkg.test_utility.source_dir = File.join(pkg.builddir, 'test', 'results')
+        end
+    end
+
+    pkg.with_tests if pkg.test_utility.source_dir
+end
+
 def common_make_based_package_setup(pkg)
     unless pkg.has_doc? && pkg.doc_dir
         pkg.with_doc do
@@ -198,14 +212,11 @@ def common_make_based_package_setup(pkg)
     end
 
     unless pkg.test_utility.has_task?
-        unless pkg.test_utility.source_dir
-            test_dir = File.join(pkg.srcdir, 'test')
-            if File.directory?(test_dir)
-                pkg.test_utility.source_dir = File.join(pkg.builddir, 'test', 'results')
-            end
+        pkg.post_import do
+            common_make_default_test_task(pkg)
         end
-
-        pkg.with_tests if pkg.test_utility.source_dir
+        # BACKWARD COMPATIBILITY ONLY. REMOVE FOR AUTOPROJ 3.0
+        common_make_default_test_task(pkg)
     end
 end
 
@@ -264,6 +275,18 @@ def env_add(name, value)
     Autoproj.env.add(name, value)
 end
 
+def ruby_package_default_test_task(pkg)
+    unless pkg.test_utility.source_dir
+        test_dir = File.join(pkg.srcdir, 'test')
+        if File.directory?(test_dir)
+            pkg.test_utility.source_dir = File.join(pkg.srcdir, '.test-results')
+            FileUtils.mkdir_p pkg.test_utility.source_dir
+        end
+    end
+
+    pkg.with_tests if pkg.test_utility.source_dir
+end
+
 # Defines a Ruby package
 #
 # Example:
@@ -284,15 +307,11 @@ def ruby_package(name, workspace: Autoproj.workspace)
         pkg.with_doc if !pkg.has_doc? && pkg.rake_doc_task
 
         unless pkg.test_utility.has_task?
-            unless pkg.test_utility.source_dir
-                test_dir = File.join(pkg.srcdir, 'test')
-                if File.directory?(test_dir)
-                    pkg.test_utility.source_dir = File.join(pkg.srcdir, '.test-results')
-                    FileUtils.mkdir_p pkg.test_utility.source_dir
-                end
+            pkg.post_import do
+                ruby_package_default_test_task(pkg)
             end
-
-            pkg.with_tests if pkg.test_utility.source_dir
+            # BACKWARD COMPATIBILITY ONLY. REMOVE FOR AUTOPROJ 3.0
+            ruby_package_default_test_task(pkg)
         end
 
         yield(pkg) if block_given?

data/lib/autoproj/base.rb

@@ -6,12 +6,11 @@ module Autoproj
         else
             ArgumentError
         end
-            
+
     # Yields, and if the given block raises a ConfigError with no file assigned,
     # add that file to both the object and the exception message
     def self.in_file(file, exception_t = ConfigError)
         yield
-
     rescue exception_t => e
         if exception_t != ConfigError
             raise ConfigError.new(file), "in #{file}: #{e.message}", e.backtrace
@@ -28,21 +27,33 @@ class << self
         attr_reader :post_import_blocks
     end
 
+    # Enumerate the post-import blocks registered for the given package
+    #
+    # @param [PackageDefinition] pkg
+    # @see post_import
     def self.each_post_import_block(pkg, &block)
+        # We use Autobuild packages as keys
+        pkg = pkg.autobuild if pkg.respond_to?(:autobuild)
+
         @post_import_blocks[nil].each(&block)
-        if @post_import_blocks.has_key?(pkg)
-            @post_import_blocks[pkg].each(&block)
-        end
+        @post_import_blocks[pkg]&.each(&block)
     end
 
+    # Register a block that should be called after a set of package(s) have
+    # been imported
+    #
+    # @overload post_import(&block) register the block for all packages
+    # @overload post_import(*packages, &block)
+    #   @param [Array<Autobuild::Package,PackageDefinition>] packages
     def self.post_import(*packages, &block)
         if packages.empty?
             @post_import_blocks[nil] << block
         else
             packages.each do |pkg|
+                # We use Autobuild packages as keys
+                pkg = pkg.autobuild if pkg.respond_to?(:autobuild)
                 @post_import_blocks[pkg] << block
             end
         end
     end
 end
-

data/lib/autoproj/cli/build.rb

@@ -29,6 +29,7 @@ def run(selected_packages, **options)
                     super(selected_packages,
                           ignore_errors: options[:keep_going],
                           checkout_only: true,
+                          report: false,
                           **options)
 
                 parallel = build_options[:parallel] || ws.config.parallel_build_level

data/lib/autoproj/cli/doc.rb

@@ -1,24 +1,10 @@
-require 'autoproj/cli/inspection_tool'
+require 'autoproj/cli/utility'
 
 module Autoproj
     module CLI
-        class Doc < InspectionTool
-            def validate_options(packages, options)
-                packages, options = super
-                if options[:no_deps_shortcut]
-                    options[:deps] = false
-                end
-                return packages, options
-            end
-
-            def run(user_selection, deps: true)
-                initialize_and_load
-                packages, _ =
-                    finalize_setup(user_selection, recursive: deps)
-                packages.each do |pkg|
-                    ws.manifest.find_autobuild_package(pkg).disable_phases('import', 'prepare', 'install')
-                end
-                Autobuild.apply(packages, "autoproj-doc", ['doc'])
+        class Doc < Utility
+            def initialize(ws = Workspace.default, name: 'doc')
+                super
             end
         end
     end

data/lib/autoproj/cli/main.rb

@@ -1,5 +1,6 @@
 require 'thor'
 require 'tty/color'
+require 'autoproj/cli/main_doc'
 require 'autoproj/cli/main_test'
 require 'autoproj/cli/main_plugin'
 require 'autoproj/cli/main_global'
@@ -37,6 +38,10 @@ class Main < Thor
             stop_on_unknown_option! :exec
             check_unknown_options!  except: :exec
 
+            def self.exit_on_failure?
+                true
+            end
+
             class << self
                 # @api private
                 #
@@ -183,15 +188,6 @@ def status(*packages)
                 run_autoproj_cli(:status, :Status, Hash[], *packages)
             end
 
-            desc 'doc [PACKAGES]', 'generate API documentation for packages that support it'
-            option :deps, type: :boolean, default: true,
-                desc: 'control whether documentation should be generated only for the packages given on the command line, or also for their dependencies. -n is a shortcut for --no-deps'
-            option :no_deps_shortcut, hide: true, aliases: '-n', type: :boolean,
-                desc: 'provide -n for --no-deps'
-            def doc(*packages)
-                run_autoproj_cli(:doc, :Doc, Hash[], *packages)
-            end
-
             desc 'update [PACKAGES]', 'update packages'
             option :aup, default: false, hide: true, type: :boolean,
                 desc: 'behave like aup'
@@ -360,6 +356,9 @@ def reconfigure
             desc 'test', 'interface for running tests'
             subcommand 'test', MainTest
 
+            desc 'doc', 'interface for generating documentation'
+            subcommand 'doc', MainDoc
+
             desc 'show [PACKAGES]', 'show informations about package(s)'
             option :mainline, type: :string,
                 desc: "compare to the given baseline. if 'true', the comparison will ignore any override, otherwise it will take into account overrides only up to the given package set"

data/lib/autoproj/cli/main_doc.rb

@@ -0,0 +1,86 @@
+module Autoproj
+    module CLI
+        class MainDoc < Thor
+            namespace 'doc'
+
+            default_command 'exec'
+
+            no_commands do
+                def report(report_options = Hash.new)
+                    options = self.options.merge(parent_options)
+                    extra_options = Hash.new
+                    if Autobuild::Subprocess.transparent_mode = options[:tool]
+                        Autobuild.silent = true
+                        Autobuild.color = false
+                        report_options[:silent] = true
+                        report_options[:on_package_failures] = :exit_silent
+                        extra_options[:silent] = true
+                    end
+                    Autoproj.report(**Hash[debug: options[:debug]].merge(report_options)) do
+                        yield(extra_options)
+                    end
+                end
+            end
+
+            desc 'enable [PACKAGES]', 'enable docs for the given packages (or for all packages if none are given)'
+            option :deps, type: :boolean, default: false,
+                desc: 'controls whether the dependencies of the packages given on the command line should be enabled as well (the default is not)'
+            def enable(*packages)
+                require 'autoproj/cli/doc'
+                report(silent: true) do
+                    cli = Doc.new
+                    args = cli.validate_options(packages, options)
+                    cli.enable(*args)
+                end
+            end
+
+            desc 'disable [PACKAGES]', 'disable docs for the given packages (or for all packages if none are given)'
+            option :deps, type: :boolean, default: false,
+                desc: 'controls whether the dependencies of the packages given on the command line should be disabled as well (the default is not)'
+            def disable(*packages)
+                require 'autoproj/cli/doc'
+                report(silent: true) do
+                    cli = Doc.new
+                    args = cli.validate_options(packages, options)
+                    cli.disable(*args)
+                end
+            end
+
+            desc 'list [PACKAGES]', 'show doc enable/disable status for the given packages (or all packages if none are given)'
+            option :deps, type: :boolean, default: true,
+                desc: 'controls whether the dependencies of the packages given on the command line should be disabled as well (the default is not)'
+            def list(*packages)
+                require 'autoproj/cli/doc'
+                report(silent: true) do
+                    cli = Doc.new
+                    args = cli.validate_options(packages, options)
+                    cli.list(*args)
+                end
+            end
+
+            desc 'exec [PACKAGES]', 'generate documentation for the given packages, or all if no packages are given on the command line'
+            option :deps, type: :boolean, default: false,
+                desc: 'controls whether to generate documentation of the dependencies of the packages given on the command line (the default is not)'
+            option :no_deps_shortcut, hide: true, aliases: '-n', type: :boolean,
+                desc: 'provide -n for --no-deps'
+            option :parallel, aliases: :p, type: :numeric,
+                desc: 'maximum number of parallel jobs'
+            option :tool, type: :boolean, default: false,
+                desc: "run in tool mode, which do not redirect the subcommand's outputs"
+            option :color, type: :boolean, default: TTY::Color.color?,
+                desc: 'enables or disables colored display (enabled by default if the terminal supports it)'
+            option :progress, type: :boolean, default: TTY::Color.color?,
+                desc: 'enables or disables progress display (enabled by default if the terminal supports it)'
+            def exec(*packages)
+                require 'autoproj/cli/doc'
+                options = self.options.merge(parent_options)
+                report do |extra_options|
+                    cli = Doc.new
+                    options.delete(:tool)
+                    args = cli.validate_options(packages, options.merge(extra_options))
+                    cli.run(*args)
+                end
+            end
+        end
+    end
+end