Change --version output

Author: silvanocerza

.goreleaser.yml

@@ -30,9 +30,9 @@ builds:
       - amd64
     ldflags:
       - -s -w
-      - -X github.com/arduino/arduino-lint/configuration.version={{.Tag}}
-      - -X github.com/arduino/arduino-lint/configuration.commit={{ .ShortCommit }}
-      - -X github.com/arduino/arduino-lint/configuration.buildTimestamp={{.Date}}
+      - -X github.com/arduino/arduino-lint/version.version={{.Tag}}
+      - -X github.com/arduino/arduino-lint/version.commit={{ .ShortCommit }}
+      - -X github.com/arduino/arduino-lint/version.date={{.Date}}
   - # ARM
     id: arduino_lint_arm
     binary: arduino-lint
@@ -47,9 +47,9 @@ builds:
       - 6
     ldflags:
       - -s -w
-      - -X github.com/arduino/arduino-lint/configuration.version={{.Tag}}
-      - -X github.com/arduino/arduino-lint/configuration.commit={{ .ShortCommit }}
-      - -X github.com/arduino/arduino-lint/configuration.buildTimestamp={{.Date}}
+      - -X github.com/arduino/arduino-lint/version.version={{.Tag}}
+      - -X github.com/arduino/arduino-lint/version.commit={{ .ShortCommit }}
+      - -X github.com/arduino/arduino-lint/version.date={{.Date}}
       - "-extldflags '-static'"
   - # ARMv7
     id: arduino_lint_armv7
@@ -65,9 +65,9 @@ builds:
       - 7
     ldflags:
       - -s -w
-      - -X github.com/arduino/arduino-lint/configuration.version={{.Tag}}
-      - -X github.com/arduino/arduino-lint/configuration.commit={{ .ShortCommit }}
-      - -X github.com/arduino/arduino-lint/configuration.buildTimestamp={{.Date}}
+      - -X github.com/arduino/arduino-lint/version.version={{.Tag}}
+      - -X github.com/arduino/arduino-lint/version.commit={{ .ShortCommit }}
+      - -X github.com/arduino/arduino-lint/version.date={{.Date}}
       - "-extldflags '-static'"
   - # ARM64
     id: arduino_lint_arm64
@@ -81,9 +81,9 @@ builds:
       - arm64
     ldflags:
       - -s -w
-      - -X github.com/arduino/arduino-lint/configuration.version={{.Tag}}
-      - -X github.com/arduino/arduino-lint/configuration.commit={{ .ShortCommit }}
-      - -X github.com/arduino/arduino-lint/configuration.buildTimestamp={{.Date}}
+      - -X github.com/arduino/arduino-lint/version.version={{.Tag}}
+      - -X github.com/arduino/arduino-lint/version.commit={{ .ShortCommit }}
+      - -X github.com/arduino/arduino-lint/version.date={{.Date}}
       - "-extldflags '-static'"
   - # All the other platforms
     id: arduino_lint
@@ -98,9 +98,9 @@ builds:
       - 386
     ldflags:
       - -s -w
-      - -X github.com/arduino/arduino-lint/configuration.version={{.Tag}}
-      - -X github.com/arduino/arduino-lint/configuration.commit={{ .ShortCommit }}
-      - -X github.com/arduino/arduino-lint/configuration.buildTimestamp={{.Date}}
+      - -X github.com/arduino/arduino-lint/version.version={{.Tag}}
+      - -X github.com/arduino/arduino-lint/version.commit={{ .ShortCommit }}
+      - -X github.com/arduino/arduino-lint/version.date={{.Date}}
       - "-extldflags '-static'"
 
 archives:

Taskfile.yml

@@ -26,7 +26,7 @@ tasks:
   go:test-unit:
     desc: Run unit tests
     cmds:
-      - go test -short -run '{{ default ".*" .TEST_REGEX }}' {{ default "-v" .GOFLAGS }} -coverprofile=coverage_unit.txt {{ default .DEFAULT_PACKAGES .PACKAGES }}
+      - go test -short -run '{{ default ".*" .TEST_REGEX }}' {{ default "-v" .GOFLAGS }} -coverprofile=coverage_unit.txt {{ default .DEFAULT_PACKAGES .PACKAGES }} {{ .TEST_LDFLAGS }}
 
   test-integration:
     desc: Run integration tests
@@ -255,9 +255,14 @@ vars:
   TIMESTAMP:
     sh: echo "$(date -u +"%Y-%m-%dT%H:%M:%SZ")"
   LDFLAGS: >
-    -ldflags '-X github.com/arduino/arduino-lint/configuration.commit={{.COMMIT}} -X github.com/arduino/arduino-lint/configuration.buildTimestamp={{.TIMESTAMP}}'
+    -ldflags '-X github.com/arduino/arduino-lint/version.commit="{{.COMMIT}}" -X github.com/arduino/arduino-lint/version.date={{.TIMESTAMP}}'
+  TEST_VERSION: "0.0.0-test.preview"
+  TEST_COMMIT: "deadbeef"
+  TEST_LDFLAGS: >
+    -ldflags  '-X github.com/arduino/arduino-lint/version.version={{.TEST_VERSION}}
+    -X github.com/arduino/arduino-lint/version.commit={{.TEST_COMMIT}}
+    -X github.com/arduino/arduino-lint/version.date={{.TIMESTAMP}}'
   GOFLAGS: "-timeout 10m -v -coverpkg=./... -covermode=atomic"
-
   GOLINTFLAGS: "-min_confidence 0.8 -set_exit_status"
 
   DOCS_VERSION: dev

command/command.go

@@ -39,16 +39,9 @@ func ArduinoLint(rootCommand *cobra.Command, cliArguments []string) {
 
 	if configuration.VersionMode() {
 		if configuration.OutputFormat() == outputformat.Text {
-			fmt.Println(configuration.Version() + " " + configuration.BuildTimestamp())
+			fmt.Println(configuration.VersionInfo())
 		} else {
-			versionObject := struct {
-				Version        string `json:"version"`
-				BuildTimestamp string `json:"buildTimestamp"`
-			}{
-				Version:        configuration.Version(),
-				BuildTimestamp: configuration.BuildTimestamp(),
-			}
-			versionJSON, err := json.MarshalIndent(versionObject, "", "  ")
+			versionJSON, err := json.MarshalIndent(configuration.VersionInfo(), "", "  ")
 			if err != nil {
 				panic(err)
 			}

configuration/configuration.go

@@ -20,12 +20,14 @@ import (
 	"fmt"
 	"io/ioutil"
 	"os"
+	"path/filepath"
 	"strconv"
 	"strings"
 
 	"github.com/arduino/arduino-lint/configuration/checkmode"
 	"github.com/arduino/arduino-lint/project/projecttype"
 	"github.com/arduino/arduino-lint/result/outputformat"
+	"github.com/arduino/arduino-lint/version"
 	"github.com/arduino/go-paths-helper"
 	"github.com/sirupsen/logrus"
 	"github.com/spf13/pflag"
@@ -199,21 +201,10 @@ func VersionMode() bool {
 	return versionMode
 }
 
-var version string
-var commit string
+var versionInfo = version.NewInfo(filepath.Base(os.Args[0]))
 
-func Version() string {
-	if version == "" {
-		return "0.0.0+" + commit
-	}
-
-	return version
-}
-
-var buildTimestamp string
-
-func BuildTimestamp() string {
-	return buildTimestamp
+func VersionInfo() *version.Info {
+	return versionInfo
 }
 
 var targetPaths paths.PathList

configuration/configuration_test.go

@@ -235,15 +235,3 @@ func TestInitializeOfficial(t *testing.T) {
 	os.Setenv("ARDUINO_LINT_OFFICIAL", "invalid value")
 	assert.Error(t, Initialize(test.ConfigurationFlags(), projectPaths))
 }
-
-func TestVersion(t *testing.T) {
-	commit = "abcd"
-	assert.Equal(t, "0.0.0+"+commit, Version())
-	version = "42.1.2"
-	assert.Equal(t, version, Version())
-}
-
-func TestBuildTimestamp(t *testing.T) {
-	buildTimestamp = "2020-11-27T04:05:19+00:00"
-	assert.Equal(t, buildTimestamp, BuildTimestamp())
-}