[#1587] Unify code-gen CLI

backend/cmd/stork-code-gen/main.go

@@ -5,95 +5,51 @@ import (
 	"os"
 
 	"github.com/jessevdk/go-flags"
-	"github.com/urfave/cli/v2"
-	"isc.org/stork"
+	"github.com/sirupsen/logrus"
+	"isc.org/stork/cli"
 	"isc.org/stork/codegen"
 )
 
-// The struct that must be embedded in all structures defining the command
-// settings. It allows to recognize which command was specified in the CLI.
-// It is related to how the go-flags library handles the subcommands.
-//
-// It may be also used to specify arguments of the command that accepts no
-// arguments.
-type cliCommand struct {
-	// It is true if the register command was specified. Otherwise, it is false.
-	commandSpecified bool
-}
-
-// Checks if the struct implement the library interface.
-var _ flags.Commander = (*cliCommand)(nil)
-
-// Implements the tools/golang/gopath/pkg/mod/github.com/jessevdk/[email protected]/command.go Commander interface.
-// It is an only way to recognize which command was specified.
-func (s *cliCommand) Execute(_ []string) error {
-	s.commandSpecified = true
-	return nil
-}
-
-// The CLI flags not related to any specific command.
-type generalCommand struct {
-	cliCommand
-	// If true, the version of Stork  is printed. It takes precedence
-	// over all other commands and arguments.
-	Version bool `short:"v" long:"version" description:"Show software version"`
-}
-
 type stdOptionDefinitionsCommand struct {
-	cliCommand
+	cli.CLICommand
 	Input    string `short:"i" long:"input" description:"Path to the input file holding option definitions' specification." required:"true"`
 	Output   string `short:"o" long:"output" description:"Path to the output file or 'stdout' to print the generated code in the terminal." required:"true"`
 	Template string `short:"t" long:"template" description:"Path to the template file used to generate the output file. The generated code is embedded in the template file."`
 }
 
 // Generates the code defining standard option definitions to stdout or
 // to a file.
-func generateStdOptionDefs(c *cli.Context) error {
+func generateStdOptionDefs(settings *stdOptionDefinitionsCommand) error {
 	// Print the output to the stdout or to a file.
-	if c.String("output") == "stdout" {
-		return codegen.GenerateToStdout(c.String("input"), c.String("template"))
+	if settings.Output == "stdout" {
+		return codegen.GenerateToStdout(settings.Input, settings.Template)
 	}
-	return codegen.GenerateToFile(c.String("input"), c.String("template"), c.String("output"))
+	return codegen.GenerateToFile(settings.Input, settings.Template, settings.Output)
 }
 
 // Man function exposing command line parameters.
 func main() {
-	app := &cli.App{
-		Name:     "Stork Code Gen",
-		Usage:    "Code generator used in Stork development",
-		Version:  stork.Version,
-		HelpName: "stork-code-gen",
-		Flags:    []cli.Flag{},
-		Commands: []*cli.Command{
-			{
-				Name:      "std-option-defs",
-				Usage:     "Generate standard option definitions from JSON spec.",
-				UsageText: "stork-code-gen std-option-defs",
-				Flags: []cli.Flag{
-					&cli.StringFlag{
-						Name:     "input",
-						Usage:    "Path to the input file holding option definitions' specification.",
-						Required: true,
-						Aliases:  []string{"i"},
-					},
-					&cli.StringFlag{
-						Name:     "output",
-						Usage:    "Path to the output file or 'stdout' to print the generated code in the terminal.",
-						Required: true,
-						Aliases:  []string{"o"},
-					},
-					&cli.StringFlag{
-						Name:    "template",
-						Usage:   "Path to the template file used to generate the output file. The generated code is embedded in the template file.",
-						Aliases: []string{"t"},
-					},
-				},
-				Action: generateStdOptionDefs,
-			},
+	nothing := struct{}{}
+	parser := flags.NewParser(&nothing, flags.Default)
+	parser.Name = "Stork Code Gen"
+	parser.ShortDescription = "Code generator used in Stork development"
+	parser.Usage = "stork-code-gen [command] [options]"
+
+	app := cli.NewApp(parser)
+	stdOptionDefinitionsSettings := &stdOptionDefinitionsCommand{}
+	app.RegisterCommand(
+		"std-option-defs",
+		"Generate standard option definitions from JSON spec.",
+		stdOptionDefinitionsSettings,
+		func() {
+			err := generateStdOptionDefs(stdOptionDefinitionsSettings)
+			if err != nil {
+				logrus.WithError(err).Fatal("Failed to generate standard option definitions.")
+			}
 		},
-	}
+	)
 
-	err := app.Run(os.Args)
+	err := app.Run(os.Args[1:])
 	if err != nil {
 		fmt.Println(err)
 		os.Exit(1)

backend/cmd/stork-code-gen/main_test.go

@@ -27,8 +27,8 @@ func TestMainHelp(t *testing.T) {
 func TestStdOptionDefsHelp(t *testing.T) {
 	defer testutil.CreateOsArgsRestorePoint()()
 	os.Args = make([]string, 3)
-	os.Args[1] = "help"
-	os.Args[2] = "std-option-defs"
+	os.Args[1] = "std-option-defs"
+	os.Args[2] = "--help"
 
 	stdoutBytes, _, err := testutil.CaptureOutput(main)
 	require.NoError(t, err)