From 79fb4fde85d877e9fdeac589844cf43133911d2d Mon Sep 17 00:00:00 2001 From: Will Winder Date: Fri, 5 May 2023 11:22:26 -0400 Subject: [PATCH] cli: make main command easier to call. (#71) --- cmd/conduit/main.go | 145 +---------------- {cmd/conduit => pkg/cli}/banner.txt | 0 pkg/cli/cli.go | 151 ++++++++++++++++++ .../main_test.go => pkg/cli/cli_test.go | 6 +- .../initialize/conduit.test.init.default.yml | 0 .../internal/initialize/conduit.yml.example | 0 .../cli}/internal/initialize/init.go | 0 .../cli}/internal/initialize/init_test.go | 0 .../conduit => pkg/cli}/internal/list/list.go | 0 9 files changed, 158 insertions(+), 144 deletions(-) rename {cmd/conduit => pkg/cli}/banner.txt (100%) create mode 100644 pkg/cli/cli.go rename cmd/conduit/main_test.go => pkg/cli/cli_test.go (97%) rename {cmd/conduit => pkg/cli}/internal/initialize/conduit.test.init.default.yml (100%) rename {cmd/conduit => pkg/cli}/internal/initialize/conduit.yml.example (100%) rename {cmd/conduit => pkg/cli}/internal/initialize/init.go (100%) rename {cmd/conduit => pkg/cli}/internal/initialize/init_test.go (100%) rename {cmd/conduit => pkg/cli}/internal/list/list.go (100%) diff --git a/cmd/conduit/main.go b/cmd/conduit/main.go index 00398b2a..e03e08a0 100644 --- a/cmd/conduit/main.go +++ b/cmd/conduit/main.go @@ -1,158 +1,21 @@ package main import ( - "context" - _ "embed" "fmt" "os" - "strings" - log "github.com/sirupsen/logrus" - "github.com/spf13/cobra" "github.com/spf13/cobra/doc" - "github.com/algorand/conduit/cmd/conduit/internal/initialize" - "github.com/algorand/conduit/cmd/conduit/internal/list" - "github.com/algorand/conduit/conduit/data" - "github.com/algorand/conduit/conduit/loggers" - "github.com/algorand/conduit/conduit/pipeline" + "github.com/algorand/conduit/pkg/cli" + _ "github.com/algorand/conduit/conduit/plugins/exporters/all" _ "github.com/algorand/conduit/conduit/plugins/importers/all" _ "github.com/algorand/conduit/conduit/plugins/processors/all" - "github.com/algorand/conduit/version" -) - -var ( - logger *log.Logger - conduitCmd = makeConduitCmd() - //go:embed banner.txt - banner string -) - -const ( - conduitEnvVar = "CONDUIT_DATA_DIR" ) -// init() function for main package -func init() { - conduitCmd.AddCommand(initialize.InitCommand) - conduitCmd.AddCommand(list.Command) -} - -// runConduitCmdWithConfig run the main logic with a supplied conduit config -func runConduitCmdWithConfig(args *data.Args) error { - defer pipeline.HandlePanic(logger) - - if args.ConduitDataDir == "" { - args.ConduitDataDir = os.Getenv(conduitEnvVar) - } - - if args.ConduitDataDir == "" { - return fmt.Errorf("the data directory is required and must be provided with a command line option or the '%s' environment variable", conduitEnvVar) - } - - pCfg, err := data.MakePipelineConfig(args) - if err != nil { - return err - } - - // Initialize logger - level, err := log.ParseLevel(pCfg.LogLevel) - if err != nil { - var levels []string - for _, l := range log.AllLevels { - levels = append(levels, l.String()) - } - return fmt.Errorf("invalid configuration: '%s' is not a valid log level, valid levels: %s", pCfg.LogLevel, strings.Join(levels, ", ")) - } - - logger, err = loggers.MakeThreadSafeLogger(level, pCfg.LogFile) - if err != nil { - return fmt.Errorf("failed to create logger: %w", err) - } - - logger.Infof("Starting Conduit %s", version.LongVersion()) - logger.Infof("Using data directory: %s", args.ConduitDataDir) - logger.Info("Conduit configuration is valid") - - if !pCfg.HideBanner { - fmt.Print(banner) - } - - if pCfg.LogFile != "" { - fmt.Printf("Writing logs to file: %s\n", pCfg.LogFile) - } else { - fmt.Println("Writing logs to console.") - } - - ctx := context.Background() - pipeline, err := pipeline.MakePipeline(ctx, pCfg, logger) - if err != nil { - err = fmt.Errorf("pipeline creation error: %w", err) - - // Suppress log, it is about to be printed to stderr. - if pCfg.LogFile != "" { - logger.Error(err) - } - return err - } - - err = pipeline.Init() - if err != nil { - // Suppress log, it is about to be printed to stderr. - if pCfg.LogFile != "" { - logger.Error(err) - } - return fmt.Errorf("pipeline init error: %w", err) - } - pipeline.Start() - defer pipeline.Stop() - pipeline.Wait() - return pipeline.Error() -} - -// makeConduitCmd creates the main cobra command, initializes flags -func makeConduitCmd() *cobra.Command { - cfg := &data.Args{} - var vFlag bool - cmd := &cobra.Command{ - Use: "conduit", - Short: "Run the Conduit framework.", - Long: `Conduit is a framework for ingesting blocks from the Algorand blockchain -into external applications. It is designed as a modular plugin system that -allows users to configure their own data pipelines. - -You must provide a data directory containing a file named conduit.yml. The -file configures pipeline and all enabled plugins. - -See other subcommands for further built in utilities and information. - -Detailed documentation is online: https://github.com/algorand/conduit`, - Args: cobra.NoArgs, - Run: func(cmd *cobra.Command, args []string) { - err := runConduitCmdWithConfig(cfg) - if err != nil { - fmt.Fprintf(os.Stderr, "\nExiting with error:\n%s.\n", err) - os.Exit(1) - } - }, - PersistentPreRun: func(cmd *cobra.Command, args []string) { - if vFlag { - fmt.Printf("%s\n", version.LongVersion()) - os.Exit(0) - } - }, - } - cmd.Flags().StringVarP(&cfg.ConduitDataDir, "data-dir", "d", "", "Set the Conduit data directory. If not set the CONDUIT_DATA_DIR environment variable is used.") - cmd.Flags().Uint64VarP(&cfg.NextRoundOverride, "next-round-override", "r", 0, "Set the starting round. Overrides next-round in metadata.json. Some exporters do not support overriding the starting round.") - cmd.Flags().BoolVarP(&vFlag, "version", "v", false, "Print the Conduit version.") - // No need for shell completions. - cmd.CompletionOptions.DisableDefaultCmd = true - - return cmd -} - func main() { + conduitCmd := cli.MakeConduitCmdWithUtilities() + // Hidden command to generate docs in a given directory // conduit generate-docs [path] if len(os.Args) == 3 && os.Args[1] == "generate-docs" { diff --git a/cmd/conduit/banner.txt b/pkg/cli/banner.txt similarity index 100% rename from cmd/conduit/banner.txt rename to pkg/cli/banner.txt diff --git a/pkg/cli/cli.go b/pkg/cli/cli.go new file mode 100644 index 00000000..f2973446 --- /dev/null +++ b/pkg/cli/cli.go @@ -0,0 +1,151 @@ +package cli + +import ( + "context" + _ "embed" + "fmt" + "os" + "strings" + + log "github.com/sirupsen/logrus" + "github.com/spf13/cobra" + + "github.com/algorand/conduit/conduit/data" + "github.com/algorand/conduit/conduit/loggers" + "github.com/algorand/conduit/conduit/pipeline" + "github.com/algorand/conduit/pkg/cli/internal/initialize" + "github.com/algorand/conduit/pkg/cli/internal/list" + "github.com/algorand/conduit/version" +) + +var ( + logger *log.Logger + conduitCmd = MakeConduitCmd() + + //go:embed banner.txt + Banner string +) + +const ( + conduitEnvVar = "CONDUIT_DATA_DIR" +) + +// runConduitCmdWithConfig run the main logic with a supplied conduit config +func runConduitCmdWithConfig(args *data.Args) error { + defer pipeline.HandlePanic(logger) + + if args.ConduitDataDir == "" { + args.ConduitDataDir = os.Getenv(conduitEnvVar) + } + + if args.ConduitDataDir == "" { + return fmt.Errorf("the data directory is required and must be provided with a command line option or the '%s' environment variable", conduitEnvVar) + } + + pCfg, err := data.MakePipelineConfig(args) + if err != nil { + return err + } + + // Initialize logger + level, err := log.ParseLevel(pCfg.LogLevel) + if err != nil { + var levels []string + for _, l := range log.AllLevels { + levels = append(levels, l.String()) + } + return fmt.Errorf("invalid configuration: '%s' is not a valid log level, valid levels: %s", pCfg.LogLevel, strings.Join(levels, ", ")) + } + + logger, err = loggers.MakeThreadSafeLogger(level, pCfg.LogFile) + if err != nil { + return fmt.Errorf("failed to create logger: %w", err) + } + + logger.Infof("Starting Conduit %s", version.LongVersion()) + logger.Infof("Using data directory: %s", args.ConduitDataDir) + logger.Info("Conduit configuration is valid") + + if !pCfg.HideBanner { + fmt.Print(Banner) + } + + if pCfg.LogFile != "" { + fmt.Printf("Writing logs to file: %s\n", pCfg.LogFile) + } else { + fmt.Println("Writing logs to console.") + } + + ctx := context.Background() + pipeline, err := pipeline.MakePipeline(ctx, pCfg, logger) + if err != nil { + err = fmt.Errorf("pipeline creation error: %w", err) + + // Suppress log, it is about to be printed to stderr. + if pCfg.LogFile != "" { + logger.Error(err) + } + return err + } + + err = pipeline.Init() + if err != nil { + // Suppress log, it is about to be printed to stderr. + if pCfg.LogFile != "" { + logger.Error(err) + } + return fmt.Errorf("pipeline init error: %w", err) + } + pipeline.Start() + defer pipeline.Stop() + pipeline.Wait() + return pipeline.Error() +} + +func MakeConduitCmdWithUtilities() *cobra.Command { + cmd := MakeConduitCmd() + cmd.AddCommand(initialize.InitCommand) + cmd.AddCommand(list.Command) + return cmd +} + +// MakeConduitCmd creates the main cobra command, initializes flags +func MakeConduitCmd() *cobra.Command { + cfg := &data.Args{} + var vFlag bool + cmd := &cobra.Command{ + Use: "conduit", + Short: "Run the Conduit framework.", + Long: `Conduit is a framework for ingesting blocks from the Algorand blockchain +into external applications. It is designed as a modular plugin system that +allows users to configure their own data pipelines. + +You must provide a data directory containing a file named conduit.yml. The +file configures pipeline and all enabled plugins. + +See other subcommands for further built in utilities and information. + +Detailed documentation is online: https://github.com/algorand/conduit`, + Args: cobra.NoArgs, + Run: func(cmd *cobra.Command, args []string) { + err := runConduitCmdWithConfig(cfg) + if err != nil { + fmt.Fprintf(os.Stderr, "\nExiting with error:\n%s.\n", err) + os.Exit(1) + } + }, + PersistentPreRun: func(cmd *cobra.Command, args []string) { + if vFlag { + fmt.Printf("%s\n", version.LongVersion()) + os.Exit(0) + } + }, + } + cmd.Flags().StringVarP(&cfg.ConduitDataDir, "data-dir", "d", "", "Set the Conduit data directory. If not set the CONDUIT_DATA_DIR environment variable is used.") + cmd.Flags().Uint64VarP(&cfg.NextRoundOverride, "next-round-override", "r", 0, "Set the starting round. Overrides next-round in metadata.json. Some exporters do not support overriding the starting round.") + cmd.Flags().BoolVarP(&vFlag, "version", "v", false, "Print the Conduit version.") + // No need for shell completions. + cmd.CompletionOptions.DisableDefaultCmd = true + + return cmd +} diff --git a/cmd/conduit/main_test.go b/pkg/cli/cli_test.go similarity index 97% rename from cmd/conduit/main_test.go rename to pkg/cli/cli_test.go index ad876f65..a46f12e9 100644 --- a/cmd/conduit/main_test.go +++ b/pkg/cli/cli_test.go @@ -1,4 +1,4 @@ -package main +package cli import ( _ "embed" @@ -52,9 +52,9 @@ func TestBanner(t *testing.T) { require.NoError(t, err) if hideBanner { - assert.NotContains(t, string(data), banner) + assert.NotContains(t, string(data), Banner) } else { - assert.Contains(t, string(data), banner) + assert.Contains(t, string(data), Banner) } } diff --git a/cmd/conduit/internal/initialize/conduit.test.init.default.yml b/pkg/cli/internal/initialize/conduit.test.init.default.yml similarity index 100% rename from cmd/conduit/internal/initialize/conduit.test.init.default.yml rename to pkg/cli/internal/initialize/conduit.test.init.default.yml diff --git a/cmd/conduit/internal/initialize/conduit.yml.example b/pkg/cli/internal/initialize/conduit.yml.example similarity index 100% rename from cmd/conduit/internal/initialize/conduit.yml.example rename to pkg/cli/internal/initialize/conduit.yml.example diff --git a/cmd/conduit/internal/initialize/init.go b/pkg/cli/internal/initialize/init.go similarity index 100% rename from cmd/conduit/internal/initialize/init.go rename to pkg/cli/internal/initialize/init.go diff --git a/cmd/conduit/internal/initialize/init_test.go b/pkg/cli/internal/initialize/init_test.go similarity index 100% rename from cmd/conduit/internal/initialize/init_test.go rename to pkg/cli/internal/initialize/init_test.go diff --git a/cmd/conduit/internal/list/list.go b/pkg/cli/internal/list/list.go similarity index 100% rename from cmd/conduit/internal/list/list.go rename to pkg/cli/internal/list/list.go