op-service: Extract shared method for formatting versions.

endpoint-monitor/cmd/main.go

 package main
 
 import (
-	"fmt"
 	"os"
 
+	opservice "github.com/ethereum-optimism/optimism/op-service"
 	oplog "github.com/ethereum-optimism/optimism/op-service/log"
 	"github.com/ethereum/go-ethereum/log"
 	"github.com/urfave/cli/v2"
@@ -22,7 +22,7 @@ func main() {
 
 	app := cli.NewApp()
 	app.Flags = endpointMonitor.CLIFlags("ENDPOINT_MONITOR")
-	app.Version = fmt.Sprintf("%s-%s-%s", Version, GitCommit, GitDate)
+	app.Version = opservice.FormatVersion(Version, GitCommit, GitDate, "")
 	app.Name = "endpoint-monitor"
 	app.Usage = "Endpoint Monitoring Service"
 	app.Description = ""

op-batcher/cmd/main.go

 package main
 
 import (
-	"fmt"
 	"os"
 
+	opservice "github.com/ethereum-optimism/optimism/op-service"
 	"github.com/urfave/cli/v2"
 
 	"github.com/ethereum-optimism/optimism/op-batcher/batcher"
@@ -26,7 +26,7 @@ func main() {
 
 	app := cli.NewApp()
 	app.Flags = cliapp.ProtectFlags(flags.Flags)
-	app.Version = fmt.Sprintf("%s-%s-%s", Version, GitCommit, GitDate)
+	app.Version = opservice.FormatVersion(Version, GitCommit, GitDate, "")
 	app.Name = "op-batcher"
 	app.Usage = "Batch Submitter Service"
 	app.Description = "Service for generating and submitting L2 tx batches to L1"

op-challenger/cmd/main.go

@@ -5,6 +5,7 @@ import (
 	"os"
 
 	op_challenger "github.com/ethereum-optimism/optimism/op-challenger"
+	opservice "github.com/ethereum-optimism/optimism/op-service"
 	"github.com/ethereum/go-ethereum/log"
 	"github.com/urfave/cli/v2"
 
@@ -21,23 +22,7 @@ var (
 )
 
 // VersionWithMeta holds the textual version string including the metadata.
-var VersionWithMeta = func() string {
-	v := version.Version
-	if GitCommit != "" {
-		if len(GitCommit) >= 8 {
-			v += "-" + GitCommit[:8]
-		} else {
-			v += "-" + GitCommit
-		}
-	}
-	if GitDate != "" {
-		v += "-" + GitDate
-	}
-	if version.Meta != "" {
-		v += "-" + version.Meta
-	}
-	return v
-}()
+var VersionWithMeta = opservice.FormatVersion(version.Version, GitCommit, GitDate, version.Meta)
 
 func main() {
 	args := os.Args

op-heartbeat/cmd/main.go

 package main
 
 import (
-	"fmt"
 	"os"
 
 	heartbeat "github.com/ethereum-optimism/optimism/op-heartbeat"
 	"github.com/ethereum-optimism/optimism/op-heartbeat/flags"
+	opservice "github.com/ethereum-optimism/optimism/op-service"
 	oplog "github.com/ethereum-optimism/optimism/op-service/log"
 	"github.com/ethereum/go-ethereum/log"
 	"github.com/urfave/cli/v2"
@@ -22,7 +22,7 @@ func main() {
 
 	app := cli.NewApp()
 	app.Flags = flags.Flags
-	app.Version = fmt.Sprintf("%s-%s-%s", Version, GitCommit, GitDate)
+	app.Version = opservice.FormatVersion(Version, GitCommit, GitDate, "")
 	app.Name = "op-heartbeat"
 	app.Usage = "Heartbeat recorder"
 	app.Description = "Service that records opt-in heartbeats from op nodes"

op-node/cmd/main.go

@@ -29,23 +29,7 @@ var (
 )
 
 // VersionWithMeta holds the textual version string including the metadata.
-var VersionWithMeta = func() string {
-	v := version.Version
-	if GitCommit != "" {
-		if len(GitCommit) >= 8 {
-			v += "-" + GitCommit[:8]
-		} else {
-			v += "-" + GitCommit
-		}
-	}
-	if GitDate != "" {
-		v += "-" + GitDate
-	}
-	if version.Meta != "" {
-		v += "-" + version.Meta
-	}
-	return v
-}()
+var VersionWithMeta = opservice.FormatVersion(version.Version, GitCommit, GitDate, version.Meta)
 
 func main() {
 	// Set up logger with a default INFO level in case we fail to parse flags,

op-program/host/cmd/main.go

@@ -7,6 +7,7 @@ import (
 	"github.com/ethereum-optimism/optimism/op-program/host/config"
 	"github.com/ethereum-optimism/optimism/op-program/host/flags"
 	"github.com/ethereum-optimism/optimism/op-program/host/version"
+	opservice "github.com/ethereum-optimism/optimism/op-service"
 	oplog "github.com/ethereum-optimism/optimism/op-service/log"
 	"github.com/ethereum/go-ethereum/log"
 	"github.com/urfave/cli/v2"
@@ -18,23 +19,7 @@ var (
 )
 
 // VersionWithMeta holds the textual version string including the metadata.
-var VersionWithMeta = func() string {
-	v := version.Version
-	if GitCommit != "" {
-		if len(GitCommit) >= 8 {
-			v += "-" + GitCommit[:8]
-		} else {
-			v += "-" + GitCommit
-		}
-	}
-	if GitDate != "" {
-		v += "-" + GitDate
-	}
-	if version.Meta != "" {
-		v += "-" + version.Meta
-	}
-	return v
-}()
+var VersionWithMeta = opservice.FormatVersion(version.Version, GitCommit, GitDate, version.Meta)
 
 func main() {
 	args := os.Args

op-proposer/cmd/main.go

 package main
 
 import (
-	"fmt"
 	"os"
 
+	opservice "github.com/ethereum-optimism/optimism/op-service"
 	"github.com/urfave/cli/v2"
 
 	"github.com/ethereum-optimism/optimism/op-proposer/flags"
@@ -26,7 +26,7 @@ func main() {
 
 	app := cli.NewApp()
 	app.Flags = cliapp.ProtectFlags(flags.Flags)
-	app.Version = fmt.Sprintf("%s-%s-%s", Version, GitCommit, GitDate)
+	app.Version = opservice.FormatVersion(Version, GitCommit, GitDate, "")
 	app.Name = "op-proposer"
 	app.Usage = "L2Output Submitter"
 	app.Description = "Service for generating and submitting L2 Output checkpoints to the L2OutputOracle contract"

op-service/version.go

+package op_service
+
+func FormatVersion(version string, gitCommit string, gitDate string, meta string) string {
+	v := version
+	if gitCommit != "" {
+		if len(gitCommit) >= 8 {
+			v += "-" + gitCommit[:8]
+		} else {
+			v += "-" + gitCommit
+		}
+	}
+	if gitDate != "" {
+		v += "-" + gitDate
+	}
+	if meta != "" {
+		v += "-" + meta
+	}
+	return v
+}

op-service/version_test.go

+package op_service
+
+import (
+	"testing"
+
+	"github.com/stretchr/testify/require"
+)
+
+func TestFormatVersion(t *testing.T) {
+	tests := []struct {
+		version   string
+		gitCommit string
+		gitDate   string
+		meta      string
+		expected  string
+	}{
+		{
+			version:   "v1.0.0",
+			gitCommit: "c90a760cfaccefb60b942ffe4ccf4f9692587cec",
+			gitDate:   "1698107786",
+			meta:      "",
+			expected:  "v1.0.0-c90a760c-1698107786",
+		},
+		{
+			version:   "v1.0.0",
+			gitCommit: "dev",
+			gitDate:   "1698107786",
+			meta:      "",
+			expected:  "v1.0.0-dev-1698107786",
+		},
+		{
+			version:   "v1.0.0",
+			gitCommit: "",
+			gitDate:   "1698107786",
+			meta:      "",
+			expected:  "v1.0.0-1698107786",
+		},
+		{
+			version:   "v1.0.0",
+			gitCommit: "dev",
+			gitDate:   "",
+			meta:      "",
+			expected:  "v1.0.0-dev",
+		},
+		{
+			version:   "v1.0.0",
+			gitCommit: "",
+			gitDate:   "",
+			meta:      "rc.1",
+			expected:  "v1.0.0-rc.1",
+		},
+		{
+			version:   "v1.0.0",
+			gitCommit: "",
+			gitDate:   "",
+			meta:      "",
+			expected:  "v1.0.0",
+		},
+		{
+			version:   "v1.0.0",
+			gitCommit: "c90a760cfaccefb60b942ffe4ccf4f9692587cec",
+			gitDate:   "1698107786",
+			meta:      "beta",
+			expected:  "v1.0.0-c90a760c-1698107786-beta",
+		},
+	}
+
+	for _, test := range tests {
+		test := test
+		t.Run(test.expected, func(t *testing.T) {
+			actual := FormatVersion(test.version, test.gitCommit, test.gitDate, test.meta)
+			require.Equal(t, test.expected, actual)
+		})
+	}
+}

op-wheel/cmd/main.go

@@ -2,9 +2,9 @@ package main
 
 import (
 	"errors"
-	"fmt"
 	"os"
 
+	opservice "github.com/ethereum-optimism/optimism/op-service"
 	"github.com/urfave/cli/v2"
 
 	"github.com/ethereum/go-ethereum/log"
@@ -21,7 +21,7 @@ var (
 
 func main() {
 	app := cli.NewApp()
-	app.Version = fmt.Sprintf("%s-%s-%s", Version, GitCommit, GitDate)
+	app.Version = opservice.FormatVersion(Version, GitCommit, GitDate, "")
 	app.Name = "op-wheel"
 	app.Usage = "Optimism Wheel is a CLI tool for the execution engine"
 	app.Description = "Optimism Wheel is a CLI tool to direct the engine one way or the other with DB cheats and Engine API routines."