Merge branch 'ashmckenzie/add-version-support-to-all' into 'main'

Ensure all binaries respond to -version

See merge request https://gitlab.com/gitlab-org/gitlab-shell/-/merge_requests/800



Merged-by: Igor Drozdov <idrozdov@gitlab.com>
Approved-by: Igor Drozdov <idrozdov@gitlab.com>
Approved-by: Jaime Martinez <jmartinez@gitlab.com>
Reviewed-by: Ash McKenzie <amckenzie@gitlab.com>
Reviewed-by: Jaime Martinez <jmartinez@gitlab.com>
Co-authored-by: Ash McKenzie <amckenzie@gitlab.com>

cmd/check/main.go

@@ -12,7 +12,16 @@ import (
 	"gitlab.com/gitlab-org/gitlab-shell/v14/internal/logger"
 )
 
+var (
+	// Version is the current version of gitlab-shell
+	Version = "(unknown version)" // Set at build time in the Makefile
+	// BuildTime signifies the time the binary was build
+	BuildTime = "19700101.000000" // Set at build time in the Makefile
+)
+
 func main() {
+	command.CheckForVersionFlag(os.Args, Version, BuildTime)
+
 	readWriter := &readwriter.ReadWriter{
 		Out:    os.Stdout,
 		In:     os.Stdin,

cmd/gitlab-shell-authorized-keys-check/main.go

@@ -13,7 +13,16 @@ import (
 	"gitlab.com/gitlab-org/gitlab-shell/v14/internal/logger"
 )
 
+var (
+	// Version is the current version of gitlab-shell
+	Version = "(unknown version)" // Set at build time in the Makefile
+	// BuildTime signifies the time the binary was build
+	BuildTime = "19700101.000000" // Set at build time in the Makefile
+)
+
 func main() {
+	command.CheckForVersionFlag(os.Args, Version, BuildTime)
+
 	readWriter := &readwriter.ReadWriter{
 		Out:    os.Stdout,
 		In:     os.Stdin,

cmd/gitlab-shell-authorized-principals-check/main.go

@@ -13,7 +13,16 @@ import (
 	"gitlab.com/gitlab-org/gitlab-shell/v14/internal/logger"
 )
 
+var (
+	// Version is the current version of gitlab-shell
+	Version = "(unknown version)" // Set at build time in the Makefile
+	// BuildTime signifies the time the binary was build
+	BuildTime = "19700101.000000" // Set at build time in the Makefile
+)
+
 func main() {
+	command.CheckForVersionFlag(os.Args, Version, BuildTime)
+
 	readWriter := &readwriter.ReadWriter{
 		Out:    os.Stdout,
 		In:     os.Stdin,

cmd/gitlab-shell/main.go

@@ -29,12 +29,7 @@ var (
 )
 
 func main() {
-	// We can't use the flag library because gitlab-shell receives other arguments
-	// that confuse the parser.
-	if len(os.Args) == 2 && os.Args[1] == "-version" {
-		fmt.Printf("gitlab-shell %s-%s\n", Version, BuildTime)
-		os.Exit(0)
-	}
+	command.CheckForVersionFlag(os.Args, Version, BuildTime)
 
 	readWriter := &readwriter.ReadWriter{
 		Out:    os.Stdout,

cmd/gitlab-sshd/main.go

@@ -20,10 +20,10 @@ import (
 var (
 	configDir = flag.String("config-dir", "", "The directory the config is in")
 
-	// BuildTime signifies the time the binary was build.
-	BuildTime = "2021-02-16T09:28:07+01:00" // Set at build time in the Makefile
-	// Version is the current version of GitLab Shell sshd.
+	// Version is the current version of gitlab-shell
 	Version = "(unknown version)" // Set at build time in the Makefile
+	// BuildTime signifies the time the binary was build
+	BuildTime = "19700101.000000" // Set at build time in the Makefile
 )
 
 func overrideConfigFromEnvironment(cfg *config.Config) {
@@ -39,11 +39,13 @@ func overrideConfigFromEnvironment(cfg *config.Config) {
 	if gitlabLogFormat := os.Getenv("GITLAB_LOG_FORMAT"); gitlabLogFormat != "" {
 		cfg.LogFormat = gitlabLogFormat
 	}
-	return
 }
 
 func main() {
+	command.CheckForVersionFlag(os.Args, Version, BuildTime)
+
 	flag.Parse()
+
 	cfg := new(config.Config)
 	if *configDir != "" {
 		var err error
@@ -52,6 +54,7 @@ func main() {
 			log.WithError(err).Fatal("failed to load configuration from specified directory")
 		}
 	}
+
 	overrideConfigFromEnvironment(cfg)
 	if err := cfg.IsSane(); err != nil {
 		if *configDir == "" {

internal/command/command.go

@@ -2,6 +2,9 @@ package command
 
 import (
 	"context"
+	"fmt"
+	"os"
+	"path"
 	"strings"
 
 	"gitlab.com/gitlab-org/gitlab-shell/v14/internal/config"
@@ -19,6 +22,17 @@ type LogMetadata struct {
 	RootNamespace string `json:"root_namespace,omitempty"`
 }
 
+func CheckForVersionFlag(osArgs []string, version, buildTime string) {
+	// We can't use the flag library because gitlab-shell receives other arguments
+	// that confuse the parser.
+	//
+	// See: https://gitlab.com/gitlab-org/gitlab-shell/-/merge_requests/800#note_1459474735
+	if len(osArgs) == 2 && osArgs[1] == "-version" {
+		fmt.Printf("%s %s-%s\n", path.Base(osArgs[0]), version, buildTime)
+		os.Exit(0)
+	}
+}
+
 // Setup() initializes tracing from the configuration file and generates a
 // background context from which all other contexts in the process should derive
 // from, as it has a service name and initial correlation ID set.

internal/command/command_test.go

@@ -2,6 +2,7 @@ package command
 
 import (
 	"os"
+	"os/exec"
 	"testing"
 
 	"github.com/stretchr/testify/require"
@@ -74,7 +75,6 @@ func addAdditionalEnv(envMap map[string]string) func() {
 		for _, k := range unsetValues {
 			os.Unsetenv(k)
 		}
-
 	}
 }
 
@@ -114,3 +114,17 @@ func TestNewLogMetadata(t *testing.T) {
 		})
 	}
 }
+
+func TestCheckForVersionFlag(t *testing.T) {
+	if os.Getenv("GITLAB_SHELL_TEST_CHECK_FOR_VERSION_FLAG") == "1" {
+		CheckForVersionFlag([]string{"test", "-version"}, "1.2.3", "456")
+		return
+	}
+
+	cmd := exec.Command(os.Args[0], "-test.run=TestCheckForVersionFlag")
+	cmd.Env = append(os.Environ(), "GITLAB_SHELL_TEST_CHECK_FOR_VERSION_FLAG=1")
+	out, err := cmd.Output()
+
+	require.Nil(t, err)
+	require.Equal(t, "test 1.2.3-456\n", string(out))
+}