Minor improvements (#140)

- add more command examples and format with color
- resolve build date as mod time of binary by default

Signed-off-by: Ondrej Fabry <[email protected]>

Author: ondrej-fabry

Diff for: .gitignore

@@ -12,6 +12,7 @@
 # cmd
 cmd/binapi-generator/binapi-generator
 cmd/vpp-proxy/vpp-proxy
+cmd/govpp/govpp
 
 # examples
 examples/api-trace/api-trace

Diff for: cmd/govpp/cmd.go

@@ -23,65 +23,59 @@ import (
 )
 
 const logo = `
-<fg=lightCyan> _________     ___    _________________  </>
-<fg=lightCyan> __  ____/_______ |  / /__  __ \__  __ \ </>
-<fg=lightCyan> _  / __ _  __ \_ | / /__  /_/ /_  /_/ / </> <fg=blue;op=bold>%s</>
-<fg=lightCyan> / /_/ / / /_/ /_ |/ / _  ____/_  ____/  </> <lightBlue>%s</>
-<fg=lightCyan> \____/  \____/_____/  /_/     /_/       </> <blue>%s</>
+<fg=lightCyan;bg=black;op=bold>   ______         _    _  _____   _____   </>  <fg=lightWhite;op=bold>%s</>
+<fg=lightCyan;bg=black;op=bold>  |  ____  _____   \  /  |_____] |_____]  </>  <fg=lightBlue>%s</>
+<fg=lightCyan;bg=black;op=bold>  |_____| [_____]   \/   |       |        </>  <fg=blue>%s</>
+<fg=lightCyan;bg=black;op=bold>                                          </> 
 `
 
-func Execute() {
-	cli, err := NewCli()
-	if err != nil {
-		logrus.Fatalf("CLI init error: %v", err)
-	}
-	root := newRootCmd(cli)
-
-	if err := root.Execute(); err != nil {
-		logrus.Fatalf("ERROR: %v", err)
-	}
-}
-
 func newRootCmd(cli Cli) *cobra.Command {
 	var (
 		glob GlobalOptions
 	)
+
 	cmd := &cobra.Command{
-		Use:               "govpp [OPTIONS] COMMAND",
-		Short:             "GoVPP CLI",
-		Long:              color.Sprintf(logo, version.Short(), version.BuiltBy(), version.BuildTime()),
-		Version:           version.String(),
-		SilenceUsage:      true,
-		SilenceErrors:     true,
-		TraverseChildren:  true,
-		CompletionOptions: cobra.CompletionOptions{HiddenDefaultCmd: true},
+		Use:     "govpp [OPTIONS] COMMAND",
+		Short:   "GoVPP CLI tool",
+		Long:    color.Sprintf(logo, version.Short(), version.BuiltBy(), version.BuildTime()),
+		Version: version.String(),
 		PersistentPreRunE: func(cmd *cobra.Command, args []string) error {
 			InitOptions(cli, &glob)
 			logrus.Tracef("global options: %+v", glob)
-
 			logrus.Tracef("args: %+v", args)
-
 			return nil
 		},
+		SilenceUsage:     true,
+		SilenceErrors:    true,
+		TraverseChildren: true,
+		CompletionOptions: cobra.CompletionOptions{
+			HiddenDefaultCmd: true,
+		},
 	}
 
+	// Setup options
 	cmd.Flags().SortFlags = false
 	cmd.PersistentFlags().SortFlags = false
 
 	// Global options
 	glob.InstallFlags(cmd.PersistentFlags())
 
+	// Version option
+	cmd.InitDefaultVersionFlag()
+	cmd.Flags().Lookup("version").Shorthand = ""
+	// Help option
+	cmd.InitDefaultHelpFlag()
+	cmd.Flags().Lookup("help").Hidden = true
+
+	// Commands
 	cmd.AddCommand(
 		newGenerateCmd(cli),
 		newVppapiCmd(cli),
 		newHttpCmd(cli),
 		newCliCommand(cli),
 	)
 
-	cmd.InitDefaultVersionFlag()
-	cmd.InitDefaultHelpFlag()
-	cmd.Flags().Lookup("help").Hidden = true
-
+	// Help command
 	cmd.InitDefaultHelpCmd()
 	for _, c := range cmd.Commands() {
 		if c.Name() == "help" {

Diff for: cmd/govpp/cmd_cli.go

@@ -22,6 +22,7 @@ import (
 	"os"
 	"strings"
 
+	"github.com/gookit/color"
 	"github.com/sirupsen/logrus"
 	"github.com/spf13/cobra"
 
@@ -36,16 +37,16 @@ import (
 //  - try several ways to connect to VPP if not specified
 
 const exampleCliCommand = `
-  # Execute 'show version' command
+  <note># Execute 'show version' command</>
   govpp cli show version
 
-  # Enter REPL mode to send commands interactively
+  <note># Enter REPL mode to send commands interactively</>
   govpp cli
 
-  # Read CLI command(s) from stdin
+  <note># Read CLI command(s) from stdin</>
   echo "show errors" | govpp cli
 
-  # Execute commands and write output to file
+  <note># Execute commands and write output to file</>
   govpp cli -o cli.log show version
 `
 
@@ -70,7 +71,7 @@ func newCliCommand(Cli) *cobra.Command {
 		Aliases:               []string{"c"},
 		Short:                 "Send CLI via VPP API",
 		Long:                  "Send VPP CLI command(s) via VPP API",
-		Example:               exampleCliCommand,
+		Example:               color.Sprint(exampleCliCommand),
 		DisableFlagsInUseLine: true,
 		RunE: func(cmd *cobra.Command, args []string) error {
 			opts.Stdin = cmd.InOrStdin()

Diff for: cmd/govpp/cmd_vppapi.go

@@ -26,25 +26,25 @@ import (
 )
 
 const exampleVppapi = `
-  <gray># Specify input source of VPP API</>
+  <note># Specify input source of VPP API</>
   govpp vppapi COMMAND [INPUT]
   govpp vppapi COMMAND ./vpp
   govpp vppapi COMMAND /usr/share/vpp/api
   govpp vppapi COMMAND vppapi.tar.gz 
   govpp vppapi COMMAND http://github.com/FDio/vpp.git
 
-  <gray># List VPP API contents</>
+  <note># List VPP API contents</>
   govpp vppapi ls [INPUT]
   govpp vppapi ls --show-contents
 
-  <gray># Export VPP API files</>
+  <note># Export VPP API files</>
   govpp vppapi export [INPUT] --output vppapi
   govpp vppapi export [INPUT] --output vppapi.tar.gz
 
-  <gray># Lint VPP API definitions</>
+  <note># Lint VPP API definitions</>
   govpp vppapi lint [INPUT]
 
-  <gray># Compare VPP API schemas</>
+  <note># Compare VPP API schemas</>
   govpp vppapi diff [INPUT] --against http://github.com/FDio/vpp.git
 `
 

Diff for: cmd/govpp/cmd_vppapi_diff.go

@@ -29,6 +29,11 @@ import (
 //  - table format for differences
 //  - option to exit with non-zero status on breaking changes
 
+const exampleVppApiDiffCommand = `
+  <note># Compare VPP API schemas</>
+  govpp vppapi diff . --against https://github.com/FDio/vpp
+`
+
 type VppApiDiffCmdOptions struct {
 	*VppApiCmdOptions
 
@@ -46,6 +51,7 @@ func newVppApiDiffCmd(cli Cli, vppapiOpts *VppApiCmdOptions) *cobra.Command {
 		Aliases: []string{"cmp", "compare"},
 		Short:   "Compare VPP API schemas",
 		Long:    "Compares two VPP API schemas and lists the differences.",
+		Example: color.Sprint(exampleVppApiDiffCommand),
 		Args:    cobra.MaximumNArgs(1),
 		RunE: func(cmd *cobra.Command, args []string) error {
 			if len(args) > 0 {

Diff for: cmd/govpp/main.go

@@ -14,6 +14,22 @@
 
 package main
 
+import (
+	"github.com/sirupsen/logrus"
+)
+
 func main() {
 	Execute()
 }
+
+func Execute() {
+	cli, err := NewCli()
+	if err != nil {
+		logrus.Fatalf("CLI init error: %v", err)
+	}
+	root := newRootCmd(cli)
+
+	if err := root.Execute(); err != nil {
+		logrus.Fatalf("ERROR: %v", err)
+	}
+}

Diff for: internal/version/version.go

@@ -17,6 +17,7 @@ package version
 
 import (
 	"fmt"
+	"os"
 	"runtime"
 	"strconv"
 	"time"
@@ -56,11 +57,29 @@ var (
 func init() {
 	buildstampInt64, _ := strconv.ParseInt(buildStamp, 10, 64)
 	if buildstampInt64 == 0 {
-		buildstampInt64 = time.Now().Unix()
+		modTime, _ := binaryModTime()
+		buildstampInt64 = modTime.Unix()
 	}
 	buildDate = time.Unix(buildstampInt64, 0)
 }
 
+func binaryModTime() (time.Time, error) {
+	// Get the path of the currently running binary
+	binaryPath, err := os.Executable()
+	if err != nil {
+		return time.Time{}, fmt.Errorf("unable to get current binary path: %w", err)
+	}
+
+	// Get the file info for the binary
+	fileInfo, err := os.Stat(binaryPath)
+	if err != nil {
+		return time.Time{}, fmt.Errorf("unable to get file info for binary: %w", err)
+	}
+
+	// Return the modification time
+	return fileInfo.ModTime(), nil
+}
+
 func Version() string {
 	return version
 }