git-bundle-server: add 'list' command

Add a new 'git-bundle-server' command to list the routes that are currently
configured and their remote Git URLs. Update manpage and 'README.md' with
description and usage information.

Due to how routes are currently stored in the bundle server, only "active"
routes are listed (that is, routes that have not been stopped with
'git-bundle-server stop'). This is intended to be only a temporary issue,
with future updates to how routes are stored allowing better tracking of
"stopped" routes.

Signed-off-by: Victoria Dye <[email protected]>

Author: vdye

README.md

@@ -133,6 +133,9 @@ being managed by the bundle server.
 * `git-bundle-server delete <route>`: Remove the configuration for the given
   `<route>` and delete its repository data.
 
+* `git-bundle-server list [<options>]`: List each route and associated
+  information (e.g. Git remote URL) in the bundle server.
+
 ### Web server management
 
 Independent of the management of the individual repositories hosted by the

cmd/git-bundle-server/list.go

@@ -0,0 +1,65 @@
+package main
+
+import (
+	"context"
+	"fmt"
+	"strings"
+
+	"github.com/github/git-bundle-server/cmd/utils"
+	"github.com/github/git-bundle-server/internal/argparse"
+	"github.com/github/git-bundle-server/internal/core"
+	"github.com/github/git-bundle-server/internal/git"
+	"github.com/github/git-bundle-server/internal/log"
+)
+
+type listCmd struct {
+	logger    log.TraceLogger
+	container *utils.DependencyContainer
+}
+
+func NewListCommand(logger log.TraceLogger, container *utils.DependencyContainer) argparse.Subcommand {
+	return &listCmd{
+		logger:    logger,
+		container: container,
+	}
+}
+
+func (listCmd) Name() string {
+	return "list"
+}
+
+func (listCmd) Description() string {
+	return `
+List the routes registered to the bundle server.`
+}
+
+func (l *listCmd) Run(ctx context.Context, args []string) error {
+	parser := argparse.NewArgParser(l.logger, "git-bundle-server list [--name-only]")
+	nameOnly := parser.Bool("name-only", false, "print only the names of configured routes")
+	parser.Parse(ctx, args)
+
+	repoProvider := utils.GetDependency[core.RepositoryProvider](ctx, l.container)
+	gitHelper := utils.GetDependency[git.GitHelper](ctx, l.container)
+
+	repos, err := repoProvider.GetRepositories(ctx)
+	if err != nil {
+		return l.logger.Error(ctx, err)
+	}
+
+	for _, repo := range repos {
+		info := []string{repo.Route}
+		if !*nameOnly {
+			remote, err := gitHelper.GetRemoteUrl(ctx, repo.RepoDir)
+			if err != nil {
+				return l.logger.Error(ctx, err)
+			}
+			info = append(info, remote)
+		}
+
+		// Join with space & tab to ensure each element of the info array is
+		// separated by at least two spaces (for better readability).
+		fmt.Println(strings.Join(info, " \t"))
+	}
+
+	return nil
+}

cmd/git-bundle-server/main.go

@@ -19,6 +19,7 @@ func all(logger log.TraceLogger) []argparse.Subcommand {
 		NewStopCommand(logger, container),
 		NewUpdateCommand(logger, container),
 		NewUpdateAllCommand(logger, container),
+		NewListCommand(logger, container),
 		NewWebServerCommand(logger, container),
 	}
 }

docs/man/git-bundle-server.adoc

@@ -84,6 +84,14 @@ fetching during scheduled bundle updates.
 *delete* _route_::
   Remove a repository configuration and delete its data on disk.
 
+*list* [*--name-only*]::
+  List the routes registered to the bundle server. Each line in the output
+  represents a unique route and includes (in order) the route name and the Git
+  remote URL associated with that route.
+
+  *--name-only*:::
+    Print only the route name on each line.
+
 *web-server* *start* [*-f*|*--force*] [_server-options_]::
   Start a background process web server hosting bundle metadata and content. The
   web server daemon runs under the calling user's domain, and will continue