73b4ba3e0c
adds the primary `debug` command to the cli as a hidden command option. Also includes the scaffold for a `metadata-files` command that could be used to print out the metadata files in the backup. --- #### Does this PR need a docs update or release note? - [x] ⛔ No #### Type of change - [x] 🌻 Feature #### Test Plan - [x] ⚡ Unit test
106 lines
2.7 KiB
Go
106 lines
2.7 KiB
Go
package debug
|
|
|
|
import (
|
|
"context"
|
|
|
|
"github.com/spf13/cobra"
|
|
|
|
"github.com/alcionai/corso/src/cli/flags"
|
|
. "github.com/alcionai/corso/src/cli/print"
|
|
"github.com/alcionai/corso/src/cli/utils"
|
|
"github.com/alcionai/corso/src/pkg/selectors"
|
|
)
|
|
|
|
var subCommandFuncs = []func() *cobra.Command{
|
|
metadataFilesCmd,
|
|
}
|
|
|
|
var debugCommands = []func(cmd *cobra.Command) *cobra.Command{
|
|
addOneDriveCommands,
|
|
addSharePointCommands,
|
|
addGroupsCommands,
|
|
addExchangeCommands,
|
|
}
|
|
|
|
// AddCommands attaches all `corso debug * *` commands to the parent.
|
|
func AddCommands(cmd *cobra.Command) {
|
|
debugC, _ := utils.AddCommand(cmd, debugCmd(), utils.MarkDebugCommand())
|
|
|
|
for _, sc := range subCommandFuncs {
|
|
subCommand := sc()
|
|
utils.AddCommand(debugC, subCommand, utils.MarkDebugCommand())
|
|
|
|
for _, addTo := range debugCommands {
|
|
addTo(subCommand)
|
|
flags.AddAllProviderFlags(subCommand)
|
|
flags.AddAllStorageFlags(subCommand)
|
|
}
|
|
}
|
|
}
|
|
|
|
// ---------------------------------------------------------------------------
|
|
// Commands
|
|
// ---------------------------------------------------------------------------
|
|
|
|
const debugCommand = "debug"
|
|
|
|
// The debug category of commands.
|
|
// `corso debug [<subcommand>] [<flag>...]`
|
|
func debugCmd() *cobra.Command {
|
|
return &cobra.Command{
|
|
Use: debugCommand,
|
|
Short: "debugging & troubleshooting utilities",
|
|
Long: `debug the data stored in corso.`,
|
|
RunE: handledebugCmd,
|
|
Args: cobra.NoArgs,
|
|
}
|
|
}
|
|
|
|
// Handler for flat calls to `corso debug`.
|
|
// Produces the same output as `corso debug --help`.
|
|
func handledebugCmd(cmd *cobra.Command, args []string) error {
|
|
return cmd.Help()
|
|
}
|
|
|
|
// The debug metadataFiles subcommand.
|
|
// `corso debug metadata-files <service> [<flag>...]`
|
|
var metadataFilesCommand = "metadata-files"
|
|
|
|
func metadataFilesCmd() *cobra.Command {
|
|
return &cobra.Command{
|
|
Use: metadataFilesCommand,
|
|
Short: "display all the metadata file contents stored by the service",
|
|
RunE: handleMetadataFilesCmd,
|
|
Args: cobra.NoArgs,
|
|
}
|
|
}
|
|
|
|
// Handler for calls to `corso debug metadata-files`.
|
|
// Produces the same output as `corso debug metadata-files --help`.
|
|
func handleMetadataFilesCmd(cmd *cobra.Command, args []string) error {
|
|
return cmd.Help()
|
|
}
|
|
|
|
// ---------------------------------------------------------------------------
|
|
// runners
|
|
// ---------------------------------------------------------------------------
|
|
|
|
func runMetadataFiles(
|
|
ctx context.Context,
|
|
cmd *cobra.Command,
|
|
args []string,
|
|
sel selectors.Selector,
|
|
debugID, serviceName string,
|
|
) error {
|
|
r, _, err := utils.GetAccountAndConnect(ctx, cmd, sel.PathService())
|
|
if err != nil {
|
|
return Only(ctx, err)
|
|
}
|
|
|
|
defer utils.CloseRepo(ctx, r)
|
|
|
|
// TODO: read and print out all metadata files in the debug
|
|
|
|
return nil
|
|
}
|