Add version command (#22)

.github/workflows/docker.yaml

@@ -24,3 +24,5 @@ jobs:
         with:
           push: true
           tags: evertras/cynomys:${{ env.EVERTRAS_PUBLISHED_VERSION }},evertras/cynomys:latest
+          build-args: |
+            BUILD_VERSION=${{ env.EVERTRAS_PUBLISHED_VERSION }}

.github/workflows/goreleaser.yaml

@@ -25,5 +25,7 @@ jobs:
           distribution: goreleaser
           version: latest
           args: release --rm-dist
+          ldflags:
+            - github.com/evertras/cynomys/cmd/cyn/cmds.BuildVersion=v{{ .Version }}
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

Dockerfile

@@ -1,5 +1,6 @@
 # Builder image
 FROM golang:1.19.3 AS builder
+ARG BUILD_VERSION=docker-dev
 
 WORKDIR /app
 COPY go.mod .
@@ -8,13 +9,15 @@ RUN go mod download
 
 COPY cmd/ cmd/
 COPY pkg/ pkg/
-RUN CGO_ENABLED=0 go build -o /cyn ./cmd/cyn/*.go
+RUN CGO_ENABLED=0 go build \
+      -o /cyn \
+      -ldflags="-X github.com/evertras/cynomys/cmd/cyn/cmds.BuildVersion=$BUILD_VERSION" \
+      ./cmd/cyn/*.go
 
 # We want to access some basic shell tools for debugging, but we want to be
 # as tiny as possible...
 FROM alpine:3.17.0
 RUN apk add strace
-RUN which strace
 COPY --from=builder /cyn /usr/local/bin/cyn
 
 ENTRYPOINT ["/usr/local/bin/cyn"]

Makefile

@@ -5,7 +5,7 @@ build: bin/cyn
 build-all: bin/cyn bin/cyn-linux bin/cyn-mac bin/cyn-windows
 
 # Build for local
-bin/cyn: ./cmd/cyn/*.go ./pkg/listener/*.go ./pkg/sender/*.go
+bin/cyn: ./cmd/cyn/*.go ./pkg/listener/*.go ./pkg/sender/*.go ./cmd/cyn/cmds/*.go
 	CGO_ENABLED=0 go build -o bin/cyn ./cmd/cyn/*.go
 
 # Build for other OSes

cmd/cyn/root.go → cmd/cyn/cmds/root.go

@@ -1,4 +1,4 @@
-package main
+package cmds
 
 import (
 	"fmt"
@@ -150,3 +150,7 @@ var rootCmd = &cobra.Command{
 		return eg.Wait()
 	},
 }
+
+func Execute() error {
+	return rootCmd.Execute()
+}

cmd/cyn/cmds/version.go

@@ -0,0 +1,21 @@
+package cmds
+
+import (
+	"fmt"
+
+	"github.com/spf13/cobra"
+)
+
+var BuildVersion string = "dev"
+
+func init() {
+	rootCmd.AddCommand(versionCmd)
+}
+
+var versionCmd = &cobra.Command{
+	Use:   "version",
+	Short: "Displays the version",
+	Run: func(cmd *cobra.Command, args []string) {
+		fmt.Println(BuildVersion)
+	},
+}

cmd/cyn/main.go

@@ -4,11 +4,13 @@ import (
 	"fmt"
 	"log"
 	"os"
+
+	"github.com/evertras/cynomys/cmd/cyn/cmds"
 )
 
 func main() {
 	log.SetOutput(os.Stdout)
-	err := rootCmd.Execute()
+	err := cmds.Execute()
 
 	if err != nil {
 		fmt.Println("Failed to run:", err)

tests/features/cli-help.feature

@@ -1,6 +1,7 @@
-Feature: run to trigger CLI help
+Feature: run to trigger CLI information
   In order to use cyn more easily
-  Cyn should provide help text when run with incorrect configurations
+  Cyn should provide help text when run with incorrect configurations or
+  when prompted to do so
 
   Scenario: run with no flags or config
     Given cyn is run with no flags or config
@@ -12,3 +13,7 @@ Feature: run to trigger CLI help
     Given cyn is run with an unknown flag
     When I wait a moment
     Then the stderr contains "Usage"
+
+  Scenario: get version
+    Given cyn is run with the version command
+    Then the stdout contains "dev"

tests/run_test.go

@@ -15,6 +15,10 @@ func (t *testContext) cynIsRunWithAnUnknownFlag() error {
 	return t.startCynInBackground("--thisdoesntexist")
 }
 
+func (t *testContext) cynIsRunWithTheVersionCommand() error {
+	return t.startCynInBackground("version")
+}
+
 func (t *testContext) cynIsRunWithTheConfigFile() error {
 	return t.startCynInBackground("--config-file", configFileLocation)
 }

tests/steps_test.go

@@ -53,6 +53,7 @@ func InitializeScenario(sc *godog.ScenarioContext) {
 	sc.Step(`^cyn is sending (UDP|TCP) to (.*)$`, t.cynIsSendingTo)
 	sc.Step(`^cyn is run with no flags or config$`, t.cynIsRunWithoutFlagsOrConfig)
 	sc.Step(`^cyn is run with an unknown flag$`, t.cynIsRunWithAnUnknownFlag)
+	sc.Step(`^cyn is run with the version command$`, t.cynIsRunWithTheVersionCommand)
 	sc.Step(`^cyn is started with the config file$`, t.cynIsRunWithTheConfigFile)
 	sc.Step(`^I wait (\d+) seconds?$`, t.waitSeconds)
 	sc.Step(`^I wait a moment$`, t.waitAMoment)