feat: Adding cosmovisor version command

cosmovisor/CHANGELOG.md

@@ -41,6 +41,8 @@ Ref: https://keepachangelog.com/en/1.0.0/
 
 + [\#8590](https://github.com/cosmos/cosmos-sdk/pull/8590) File watcher for cosmovisor. Instead of parsing logs from stdin and stderr, we watch the `<DAEMON_HOME>/data/upgrade-info.json` file updates using polling mechanism.
 
++ [\#9999](https://github.com/cosmos/cosmos-sdk/issues/9999) Added `version` command which returns the version of the cosmovisor along with the version of the application
+
 ### Improvements
 
 + [\#10018](https://github.com/cosmos/cosmos-sdk/pull/10018) Strict boolean argument parsing: cosmovisor will fail if user will not set correctly a boolean variable. Correct values are: "true", "false", "" (not setting) - all case not sensitive.

cosmovisor/Makefile

@@ -1,10 +1,11 @@
 #!/usr/bin/make -f
 
+VERSION := $(shell echo $(shell git describe --always --match "cosmovisor/v*") | sed 's/^cosmovisor[/]//')
 
 all: cosmovisor test
 
 cosmovisor:
-	go build -mod=readonly ./cmd/cosmovisor
+	go build -ldflags="-X 'github.com/cosmos/cosmos-sdk/cosmovisor/cmd/cosmovisor/cmd.Version=$(VERSION)'" -mod=readonly ./cmd/cosmovisor
 
 test:
 	go test -mod=readonly -race ./...

cosmovisor/cmd/cosmovisor/cmd/root.go

@@ -0,0 +1,9 @@
+package cmd
+
+func RunCosmovisorCommands(args []string) {
+
+	if isVersionCommand(args) {
+		printVersion()
+	}
+
+}

cosmovisor/cmd/cosmovisor/cmd/version.go

@@ -0,0 +1,51 @@
+package cmd
+
+import (
+	"fmt"
+	"os"
+	"regexp"
+	"strings"
+)
+
+// Cosmovisor version value. Set during build
+var Version string
+
+const (
+	versionRegex = `^v(?P<major>0|[1-9]\d*)\.(?P<minor>0|[1-9]\d*)\.(?P<patch>0|[1-9]\d*)`
+	// ^                       - Ensuring the text starts with the match
+	// v                       - Version string starts with `v`
+	// (?P<major>0|[1-9]\d*)   - Match group `major` - Matches 0 once or digits 1-9 zero or many times
+	// \.                      - Dot between `major` and `minor`
+	// (?P<minor>0|[1-9]\d*)   - Match group `minor`- Matches 0 once or digits 1-9 zero or many times
+	// \.                      - Dot between `minor` and `patch`
+	// (?P<patch>0|[1-9]\d*)   - Match group `patch`- Matches 0 once or digits 1-9 zero or many times
+)
+
+func isVersionCommand(args []string) bool {
+	return len(args) == 1 && strings.EqualFold(args[0], "version")
+}
+
+func printVersion() {
+
+	versionFound, version := getVersion(Version)
+
+	if versionFound {
+		fmt.Println("Cosmovisor Version: ", version)
+	} else {
+		fmt.Fprintf(os.Stderr, "Could not parse the Cosmovisor version from the binary. \nVersion value found in binary: %s \n", Version)
+	}
+
+}
+
+// getVersion does regex matching against the version value set in the cosmovisor binary
+// Returns if valid version was found, and if valid  version is found, returns the version string
+// Returns false and empty string when valid version is not found
+func getVersion(versionStr string) (bool, string) {
+	re := regexp.MustCompile(versionRegex) // Requires major, minor and patch versions in the form v1.0.0
+
+	for _, version_match := range re.FindAllString(versionStr, -1) {
+		return true, version_match
+	}
+
+	return false, ""
+}

cosmovisor/cmd/cosmovisor/cmd/version_test.go

@@ -0,0 +1,90 @@
+package cmd
+
+import (
+	"testing"
+
+	"github.com/stretchr/testify/require"
+)
+
+func TestIsVersionCommand(t *testing.T) {
+	cases := []struct {
+		name      string
+		args      []string
+		expectRes bool
+	}{{
+		name:      "valid args - lowercase",
+		args:      []string{"version"},
+		expectRes: true,
+	}, {
+		name:      "typo",
+		args:      []string{"vrsion"},
+		expectRes: false,
+	}, {
+		name:      "non version command",
+		args:      []string{"start"},
+		expectRes: false,
+	}, {
+		name:      "incorrect format",
+		args:      []string{"start", "version"},
+		expectRes: false,
+	}}
+
+	for i := range cases {
+		tc := cases[i]
+		t.Run(tc.name, func(t *testing.T) {
+			require := require.New(t)
+			res := isVersionCommand(tc.args)
+			require.Equal(tc.expectRes, res)
+		})
+	}
+}
+
+func TestGetVersion(t *testing.T) {
+	cases := []struct {
+		name        string
+		versionStr  string
+		expectValid bool
+		expectRes   string
+	}{
+		{
+			name:        "valid version string",
+			versionStr:  "v1.0.0",
+			expectValid: true,
+			expectRes:   "v1.0.0",
+		}, {
+			name:        "valid git tag string",
+			versionStr:  "v1.1.0-alpha2-1-g81f1347e",
+			expectValid: true,
+			expectRes:   "v1.1.0",
+		}, {
+			name:        "invalid string",
+			versionStr:  "v1.test",
+			expectValid: false,
+			expectRes:   "",
+		}, {
+			name:        "incomplete version string",
+			versionStr:  "v1.1",
+			expectValid: false,
+			expectRes:   "",
+		}, {
+			name:        "incomplete git tag string",
+			versionStr:  "v1.1-alpha2-1-g81f1347e",
+			expectValid: false,
+			expectRes:   "",
+		},
+	}
+
+	for i := range cases {
+		tc := cases[i]
+		t.Run(tc.name, func(t *testing.T) {
+			require := require.New(t)
+			isValid, res := getVersion(tc.versionStr)
+			if tc.expectValid {
+				require.True(isValid)
+				require.Equal(tc.expectRes, res)
+			} else {
+				require.False(isValid)
+			}
+		})
+	}
+}

cosmovisor/cmd/cosmovisor/main.go

@@ -5,6 +5,7 @@ import (
 	"os"
 
 	"github.com/cosmos/cosmos-sdk/cosmovisor"
+	"github.com/cosmos/cosmos-sdk/cosmovisor/cmd/cosmovisor/cmd"
 )
 
 func main() {
@@ -16,6 +17,7 @@ func main() {
 
 // Run is the main loop, but returns an error
 func Run(args []string) error {
+
 	cfg, err := cosmovisor.GetConfigFromEnv()
 	if err != nil {
 		return err
@@ -34,5 +36,8 @@ func Run(args []string) error {
 	if doUpgrade && err == nil {
 		fmt.Println("[cosmovisor] upgrade detected, DAEMON_RESTART_AFTER_UPGRADE is off. Verify new upgrade and start cosmovisor again.")
 	}
+
+	// Run cosmosvisor commands e.g `cosmovisor version`
+	cmd.RunCosmovisorCommands(args)
 	return err
 }

cosmovisor/go.mod

@@ -3,7 +3,11 @@ module github.com/cosmos/cosmos-sdk/cosmovisor
 go 1.15
 
 require (
+	github.com/hashicorp/go-cleanhttp v0.5.1 // indirect
 	github.com/hashicorp/go-getter v1.4.1
 	github.com/otiai10/copy v1.4.2
 	github.com/stretchr/testify v1.7.0
+	google.golang.org/api v0.44.0 // indirect
+	google.golang.org/genproto v0.0.0-20210602131652-f16073e35f0c // indirect
+	gopkg.in/yaml.v3 v3.0.0-20210107192922-496545a6307b // indirect
 )