Update the version command to return more details (#71)

Signed-off-by: oluwole fadeyi <[email protected]>

.goreleaser.yaml

@@ -10,7 +10,7 @@ builds:
     flags:
       - -trimpath
     ldflags:
-      - -s -w -X "pkg/version.version={{.Version}}" -X "pkg/version.commit={{.Commit}}" -X "pkg/version.date={{.Date}}"
+      - '-s -w -X "github.com/tfadeyi/{{ .ProjectName }}/pkg/version.Platform=linux/unknown" -X "github.com/tfadeyi/{{ .ProjectName }}/pkg/version.Version={{ .Version }}" -X "github.com/tfadeyi/{{ .ProjectName }}/pkg/version.Commit={{ .Commit }}" -X "github.com/tfadeyi/{{ .ProjectName }}/pkg/version.Date={{ .Date }}"'
     binary: "{{ .ProjectName }}"
     goos:
       - linux
@@ -25,27 +25,13 @@ builds:
     flags:
       - -trimpath
     ldflags:
-      - -s -w -X "pkg/version.version={{.Version}}" -X "pkg/version.commit={{.Commit}}" -X "pkg/version.date={{.Date}}"
+      - '-s -w -X "github.com/tfadeyi/{{ .ProjectName }}/pkg/version.Platform=darwin/unknown" -X "github.com/tfadeyi/{{ .ProjectName }}/pkg/version.Version={{ .Version }}" -X "github.com/tfadeyi/{{ .ProjectName }}/pkg/version.Commit={{ .Commit }}" -X "github.com/tfadeyi/{{ .ProjectName }}/pkg/version.Date={{ .Date }}"'
     binary: "{{ .ProjectName }}"
     goos:
       - darwin
     goarch:
       - amd64
       - arm64
-  - id: "windows"
-    env:
-      - CGO_ENABLED=0
-    mod_timestamp: "{{ .CommitTimestamp }}"
-    flags:
-      - -trimpath
-    ldflags:
-      - -s -w -X "pkg/version.version={{.Version}}" -X "pkg/version.commit={{.Commit}}" -X "pkg/version.date={{.Date}}"
-    binary: "{{ .ProjectName }}"
-    goos:
-      - windows
-    goarch:
-      - amd64
-      - arm64
 archives:
   - id: linux
     format: tar.gz
@@ -59,12 +45,6 @@ archives:
     wrap_in_directory: true
     builds:
       - "darwin"
-  - id: windows
-    format: tar.gz
-    name_template: "{{ .ProjectName }}-{{ .Os }}-{{ .Arch }}"
-    wrap_in_directory: true
-    builds:
-      - "windows"
 
 kos:
   - working_dir: .

cmd/options/version/options.go

@@ -0,0 +1,45 @@
+package version
+
+import (
+	"github.com/spf13/cobra"
+	"github.com/spf13/pflag"
+)
+
+type (
+	// Options is the list of options/flag available to the application,
+	// plus the clients needed by the application to function.
+	Options struct {
+		Verbose bool
+	}
+)
+
+// New creates a new instance of the application's options
+func New() *Options {
+	return new(Options)
+}
+
+// Prepare assigns the applications flag/options to the cobra cli
+func (o *Options) Prepare(cmd *cobra.Command) *Options {
+	o.addAppFlags(cmd.Flags())
+	return o
+}
+
+// Validate validates the flag values given to the application
+func (o *Options) Validate() error {
+	return nil
+}
+
+// Complete initialises the components needed for the application to function given the options,
+func (o *Options) Complete() error {
+	return nil
+}
+
+func (o *Options) addAppFlags(fs *pflag.FlagSet) {
+	fs.BoolVarP(
+		&o.Verbose,
+		"version",
+		"v",
+		false,
+		"Verbose build information",
+	)
+}

cmd/version.go

@@ -2,20 +2,39 @@ package cmd
 
 import (
 	"github.com/spf13/cobra"
+	versionoptions "github.com/tfadeyi/auth0-simple-exporter/cmd/options/version"
 	"github.com/tfadeyi/auth0-simple-exporter/pkg/logging"
 	"github.com/tfadeyi/auth0-simple-exporter/pkg/version"
 )
 
-var versionCmd = &cobra.Command{
-	Use:   "version",
-	Short: "Returns the binary build information.",
-	Run: func(cmd *cobra.Command, args []string) {
-		ctx := cmd.Context()
-		log := logging.LoggerFromContext(ctx)
-		log.Info(version.BuildInfo())
-	},
+func versionCmd() *cobra.Command {
+	opts := versionoptions.New()
+	cmd := &cobra.Command{
+		Use:           "version",
+		Short:         "Returns the binary build information.",
+		SilenceErrors: true,
+		SilenceUsage:  true,
+		PreRunE: func(cmd *cobra.Command, args []string) error {
+			err := opts.Validate()
+			if err != nil {
+				return err
+			}
+			err = opts.Complete()
+			return err
+		},
+		Run: func(cmd *cobra.Command, args []string) {
+			ctx := cmd.Context()
+			log := logging.LoggerFromContext(ctx)
+			if opts.Verbose {
+				log.Info(version.BuildInfo())
+			}
+			log.Info(version.Info())
+		},
+	}
+	opts = opts.Prepare(cmd)
+	return cmd
 }
 
 func init() {
-	rootCmd.AddCommand(versionCmd)
+	rootCmd.AddCommand(versionCmd())
 }

pkg/version/version.go

@@ -4,11 +4,23 @@ import "fmt"
 
 // Values injected at build-time
 var (
-	version string = "dev"
-	commit  string = "unknown"
-	date    string = "unknown"
+	Platform string = "unknown"
+	Version  string = "dev"
+	Commit   string = "unknown"
+	Date     string = "unknown"
 )
 
+// BuildInfo returns the binary build information
 func BuildInfo() string {
-	return fmt.Sprintf("%s, commit %s, built at %s", version, commit, date)
+	return fmt.Sprintf(`
+Host machine: %s
+
+  Version:    %s
+  Commit:     %s
+  Built at:   %s`, Platform, Version, Commit, Date)
+}
+
+// Info returns simple version information of the binary
+func Info() string {
+	return Version
 }