autoproj 2.10.1 → 2.13.0

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/inspection_tool.rb

@@ -8,9 +8,7 @@ class InspectionTool < Base
             def initialize_and_load(mainline: nil)
                 Autoproj.silent do
                     ws.setup
-                    if mainline == 'mainline' || mainline == 'true'
-                        mainline = true
-                    end
+                    mainline = true if %w[mainline true].include?(mainline)
                     ws.load_package_sets(mainline: mainline)
                     ws.config.save
                     ws.setup_all_package_directories
@@ -22,7 +20,7 @@ def initialize_and_load(mainline: nil)
             # @param [Array<String>] packages the list of package names
             # @param [Symbol] non_imported_packages whether packages that are
             #   not yet imported should be ignored (:ignore) or returned
-            #   (:return). 
+            #   (:return).
             # @option options recursive (true) whether the package resolution
             #   should return the package(s) and their dependencies
             #
@@ -32,7 +30,8 @@ def initialize_and_load(mainline: nil)
             #   the arguments were pointing within the configuration area
             def finalize_setup(packages = [], non_imported_packages: :ignore, recursive: true, auto_exclude: false)
                 Autoproj.silent do
-                    packages, config_selected = normalize_command_line_package_selection(packages)
+                    packages, config_selected =
+                        normalize_command_line_package_selection(packages)
                     # Call resolve_user_selection once to auto-add packages, so
                     # that they're available to e.g. overrides.rb
                     resolve_user_selection(packages)
@@ -41,7 +40,7 @@ def finalize_setup(packages = [], non_imported_packages: :ignore, recursive: tru
                         resolve_selection(packages, recursive: recursive, non_imported_packages: non_imported_packages, auto_exclude: auto_exclude)
                     ws.finalize_setup
                     ws.export_installation_manifest
-                    return source_packages, osdep_packages, resolved_selection, config_selected
+                    [source_packages, osdep_packages, resolved_selection, config_selected]
                 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
                 #
@@ -129,8 +134,9 @@ def run_autoproj_cli(filename, classname, report_options, *args, tool_failure_mo
                         end
                         cli = CLI.const_get(classname).new
                         begin
-                            run_args = cli.validate_options(args, options.merge(extra_options))
-                            cli.run(*run_args)
+                            *run_args, kw = cli.validate_options(args, options.merge(extra_options))
+                            kw = (kw || {}).transform_keys(&:to_sym)
+                            cli.run(*run_args, **kw)
                         ensure
                             cli.notify_env_sh_updated if cli.respond_to?(:notify_env_sh_updated)
                         end
@@ -183,15 +189,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'
@@ -232,6 +229,8 @@ def doc(*packages)
                 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"
             option :auto_exclude, type: :boolean,
                 desc: 'if true, packages that fail to import will be excluded from the build'
+            option :ask, type: :boolean, default: false,
+                desc: 'ask whether each package should or should not be updated'
             def update(*packages)
                 report_options = Hash[silent: false, on_package_failures: default_report_on_package_failures]
                 if options[:auto_exclude]
@@ -304,13 +303,34 @@ def build(*packages)
                 end
             end
 
-            desc 'cache CACHE_DIR', 'create or update a cache directory that can be given to AUTOBUILD_CACHE_DIR'
-            option :keep_going, aliases: :k,
-                desc: 'do not stop on errors'
-            option :checkout_only, aliases: :c, type: :boolean, default: false,
-                desc: "only checkout packages, do not update already-cached ones"
-            option :all, type: :boolean, default: true,
-                desc: "cache all defined packages (the default) or only the selected ones"
+            desc 'cache CACHE_DIR', 'create or update a cache directory that '\
+                                    'can be given to AUTOBUILD_CACHE_DIR'
+            option :keep_going,
+                   aliases: :k,
+                   desc: 'do not stop on errors'
+            option :checkout_only,
+                   aliases: :c, type: :boolean, default: false,
+                   desc: 'only checkout packages, do not update already-cached ones'
+            option :all,
+                   type: :boolean, default: true,
+                   desc: 'cache all defined packages (the default), '\
+                         ' or only the selected ones'
+            option :packages,
+                   type: :boolean, default: true,
+                   desc: 'update the package cache'
+            option :gems,
+                   type: :boolean, default: false,
+                   desc: 'update the gems cache'
+            option :gems_compile_force,
+                   type: :boolean, default: false,
+                   desc: 'with --gems-compile, recompile existing gems as well'
+            option :gems_compile,
+                   type: :array,
+                   desc: 'pre-compile the following gems. This requires gem-compiler '\
+                         'to be available in the workspace. Use GEM_NAME+ARTIFACT'\
+                         '[+ARTIFACT] to add files or directories to the precompiled '\
+                         'gems beyond what gem-compiler auto-adds (which is mostly '\
+                         'dynamic libraries)'
             def cache(*args)
                 run_autoproj_cli(:cache, :Cache, Hash[], *args)
             end
@@ -360,6 +380,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

data/lib/autoproj/cli/main_plugin.rb

@@ -30,6 +30,8 @@ def write_plugin_list(plugins)
                 type: 'string', default: '>= 0'
             option :git, desc: 'checkout a git repository instead of downloading the gem',
                 type: 'string'
+            option :branch, desc: 'choose the branch that should be checked out with --git',
+                type: 'string', default: 'master'
             option :path, desc: 'use the plugin that is already present on this path',
                 type: 'string'
             def install(name)
@@ -40,6 +42,7 @@ def install(name)
                     raise CLIInvalidArguments, "you can provide only one of --git or --path"
                 elsif options[:git]
                     gem_options[:git] = options[:git]
+                    gem_options[:branch] = options[:branch]
                 elsif options[:path]
                     gem_options[:path] = options[:path]
                 end

data/lib/autoproj/cli/main_test.rb

@@ -22,6 +22,21 @@ def report(report_options = Hash.new)
                 end
             end
 
+            desc 'default [on|off]', 'set whether tests are enabled or disabled by default, without touching existing settings'
+            def default(on_or_off)
+                require 'autoproj/cli/test'
+                report(silent: true) do
+                    cli = Test.new
+                    args = cli.validate_options([], options)
+                    enabled = case on_or_off
+                              when 'on' then true
+                              when 'off' then false
+                              else raise ArgumentError, "expected 'on' or 'off'"
+                              end
+                    cli.default(enabled)
+                end
+            end
+
             desc 'enable [PACKAGES]', 'enable tests 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)'

data/lib/autoproj/cli/show.rb

@@ -17,7 +17,8 @@ def run(user_selection, short: false, recursive: false, mainline: false, env: fa
                     source_packages, osdep_packages, * =
                         finalize_setup(user_selection, recursive: recursive, non_imported_packages: :return)
                 else
-                    source_packages, osdep_packages = Array.new, Array.new
+                    source_packages = []
+                    osdep_packages = []
                 end
 
                 all_matching_osdeps = osdep_packages.map { |pkg| [pkg, true] }
@@ -232,7 +233,7 @@ def display_common_information(pkg_name, default_packages, revdeps)
                     end
                 end
 
-                if !selections.empty?
+                unless selections.empty?
                     puts "  selected by way of"
                     selections.each do |root_pkg|
                         paths = find_selection_path(root_pkg, pkg_name)
@@ -248,9 +249,7 @@ def display_common_information(pkg_name, default_packages, revdeps)
             end
 
             def find_selection_path(from, to)
-                if from == to
-                    return [[from]]
-                end
+                return [[from]] if from == to
 
                 all_paths = Array.new
                 ws.manifest.resolve_package_name(from).each do |pkg_type, pkg_name|
@@ -262,19 +261,17 @@ def find_selection_path(from, to)
 
                     pkg = ws.manifest.find_autobuild_package(pkg_name)
                     pkg.dependencies.each do |dep_pkg_name|
-                        if result = find_selection_path(dep_pkg_name, to)
+                        if (result = find_selection_path(dep_pkg_name, to))
                             all_paths.concat(result.map { |p| path + p })
                         end
                     end
-                    if pkg.os_packages.include?(to)
-                        all_paths << (path + [to])
-                    end
+                    all_paths << (path + [to]) if pkg.os_packages.include?(to)
                 end
 
                 # Now filter common trailing subpaths
                 all_paths = all_paths.sort_by(&:size)
                 filtered_paths = Array.new
-                while !all_paths.empty?
+                until all_paths.empty?
                     path = all_paths.shift
                     filtered_paths << path
                     size = path.size
@@ -290,19 +287,15 @@ def vcs_to_array(vcs)
                     options = vcs.dup
                     type = options.delete('type')
                     url  = options.delete('url')
-                else 
+                else
                     options = vcs.options
                     type = vcs.type
                     url = vcs.url
                 end
 
                 fields = []
-                if type
-                    fields << ['type', type]
-                end
-                if url
-                    fields << ['url', url]
-                end
+                fields << ['type', type] if type
+                fields << ['url', url] if url
                 fields = fields.concat(options.to_a.sort_by { |k, _| k.to_s })
                 fields.map do |key, value|
                     if value.respond_to?(:to_str) && File.file?(value) && value =~ /^\//
@@ -315,9 +308,10 @@ def vcs_to_array(vcs)
             def compute_all_revdeps(pkg_revdeps, revdeps)
                 pkg_revdeps = pkg_revdeps.dup
                 all_revdeps = Array.new
-                while !pkg_revdeps.empty?
+                until pkg_revdeps.empty?
                     parent_name = pkg_revdeps.shift
                     next if all_revdeps.include?(parent_name)
+
                     all_revdeps << parent_name
                     pkg_revdeps.concat(revdeps[parent_name].to_a)
                 end

data/lib/autoproj/cli/status.rb

@@ -73,7 +73,7 @@ def snapshot_overrides_vcs?(importer, vcs, snapshot)
                 end
             end
 
-            def report_exception(package_status, msg, e)
+            def self.report_exception(package_status, msg, e)
                 package_status.msg << Autoproj.color("  #{msg} (#{e})", :red)
                 if Autobuild.debug
                     package_status.msg.concat(e.backtrace.map do |line|
@@ -82,8 +82,8 @@ def report_exception(package_status, msg, e)
                 end
             end
 
-            PackageStatus = Struct.new :msg, :sync, :uncommitted, :local, :remote
-            def status_of_package(package_description, only_local: false, snapshot: false)
+            PackageStatus = Struct.new :msg, :sync, :unexpected, :uncommitted, :local, :remote
+            def self.status_of_package(package_description, only_local: false, snapshot: false)
                 pkg = package_description.autobuild
                 importer = pkg.importer
                 package_status = PackageStatus.new(Array.new, false, false, false, false)
@@ -96,7 +96,7 @@ def status_of_package(package_description, only_local: false, snapshot: false)
                 else
                     begin status = importer.status(pkg, only_local: only_local)
                     rescue StandardError => e
-                        report_exception(package_status, "failed to fetch status information", e)
+                        self.report_exception(package_status, "failed to fetch status information", e)
                         return package_status
                     end
 
@@ -108,7 +108,7 @@ def status_of_package(package_description, only_local: false, snapshot: false)
                             rescue Autobuild::PackageException
                                 Hash.new
                             rescue StandardError => e
-                                report_exception(package_status, "failed to fetch snapshotting information", e)
+                                self.report_exception(package_status, "failed to fetch snapshotting information", e)
                                 return package_status
                             end
                         if snapshot_overrides_vcs?(importer, package_description.vcs, snapshot_version)
@@ -122,6 +122,7 @@ def status_of_package(package_description, only_local: false, snapshot: false)
                     end
 
                     status.unexpected_working_copy_state.each do |msg|
+                        package_status.unexpected = true
                         package_status.msg << Autoproj.color("  #{msg}", :red, :bold)
                     end
 
@@ -173,13 +174,15 @@ def each_package_status(packages, parallel: ws.config.parallel_import_level, sna
                 end
                 noninteractive = noninteractive.map do |pkg|
                     future = Concurrent::Future.execute(executor: executor) do
-                        status_of_package(pkg, snapshot: snapshot, only_local: only_local)
+                        Status.status_of_package(
+                            pkg, snapshot: snapshot, only_local: only_local
+                        )
                     end
                     [pkg, future]
                 end
 
                 (noninteractive + interactive).each do |pkg, future|
-                    if future 
+                    if future
                         if progress
                             wait_timeout = 1
                             while true
@@ -196,7 +199,10 @@ def each_package_status(packages, parallel: ws.config.parallel_import_level, sna
                         if !(status = future.value)
                             raise future.reason
                         end
-                    else status = status_of_package(pkg, snapshot: snapshot, only_local: only_local)
+                    else
+                        status = Status.status_of_package(
+                            pkg, snapshot: snapshot, only_local: only_local
+                        )
                     end
 
                     result.uncommitted ||= status.uncommitted
@@ -263,7 +269,7 @@ def display_status(packages, parallel: ws.config.parallel_import_level, snapshot
                         sync_packages = ""
                     end
 
-                    STDERR.print 
+                    STDERR.print
 
                     if status.msg.size == 1
                         Autoproj.message "#{pkg_name}: #{status.msg.first}"