Change --version output

Author: silvanocerza

.goreleaser.yml

@@ -32,9 +32,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
@@ -49,9 +49,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
@@ -67,9 +67,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
@@ -83,9 +83,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
@@ -100,9 +100,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
@@ -224,9 +224,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"
 
   PRETTIER: prettier@2.1.2

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())
-}

test/test_all.py

@@ -170,14 +170,6 @@ def test_verbose(run_command):
     assert True in [check.get("result") == "fail" for check in report["projects"][0]["checks"]]
 
 
-def test_version(run_command):
-    result = run_command(cmd=["--version"])
-    assert result.ok
-    output_list = result.stdout.strip().split(sep=" ")
-    assert semver.VersionInfo.isvalid(version=output_list[0])
-    dateutil.parser.isoparse(output_list[1])
-
-
 def test_arduino_lint_official(run_command):
     project_path = test_data_path.joinpath("ARDUINO_LINT_OFFICIAL")
 

version/version.go

@@ -0,0 +1,59 @@
+// This file is part of arduino-cli.
+//
+// Copyright 2020 ARDUINO SA (http://www.arduino.cc/)
+//
+// This software is released under the GNU General Public License version 3,
+// which covers the main part of arduino-cli.
+// The terms of this license can be found at:
+// https://www.gnu.org/licenses/gpl-3.0.en.html
+//
+// You can be released from the requirements of the above licenses by purchasing
+// a commercial license. Buying such a license is mandatory if you want to
+// modify or otherwise use the software for commercial activities involving the
+// Arduino software without disclosing the source code of your own applications.
+// To purchase a commercial license, send an email to license@arduino.cc.
+
+package version
+
+import (
+	"fmt"
+)
+
+var (
+	defaultVersion = "0.0.0-git"
+	version        = ""
+	commit         = ""
+	status         = "alpha"
+	date           = ""
+)
+
+// Info FIXMEDOC
+type Info struct {
+	Application string `json:"Application"`
+	Version     string `json:"Version"`
+	Commit      string `json:"Commit"`
+	Status      string `json:"Status"`
+	Date        string `json:"Date"`
+}
+
+// NewInfo FIXMEDOC
+func NewInfo(application string) *Info {
+	return &Info{
+		Application: application,
+		Version:     version,
+		Commit:      commit,
+		Status:      status,
+		Date:        date,
+	}
+}
+
+func (i *Info) String() string {
+	return fmt.Sprintf("%s %s Version: %s Commit: %s Date: %s", i.Application, i.Status, i.Version, i.Commit, i.Date)
+}
+
+//nolint:gochecknoinits
+func init() {
+	if version == "" {
+		version = defaultVersion
+	}
+}

version/version_test.go

@@ -0,0 +1,25 @@
+package version
+
+import (
+	"testing"
+
+	"github.com/stretchr/testify/require"
+)
+
+// TestBuildInjectedInfo tests the Info strings passed to the binary at build time
+// in order to have this test green launch your testing using the provided task (see /Taskfile.yml) or use:
+//     go test -run TestBuildInjectedInfo -v ./... -ldflags '
+//       -X github.com/arduino/arduino-lint/version.version=0.0.0-test.preview
+//       -X github.com/arduino/arduino-lint/version.commit=deadbeef'
+func TestBuildInjectedInfo(t *testing.T) {
+	goldenAppName := "arduino-lint"
+	goldenInfo := Info{
+		Application: goldenAppName,
+		Version:     "0.0.0-test.preview",
+		Commit:      "deadbeef",
+	}
+	info := NewInfo(goldenAppName)
+	require.Equal(t, goldenInfo.Application, info.Application)
+	require.Equal(t, goldenInfo.Version, info.Version)
+	require.Equal(t, goldenInfo.Commit, info.Commit)
+}