Add commit field to --version --format=json output

Author: per1234

internal/command/command.go

@@ -39,13 +39,20 @@ func ArduinoLint(rootCommand *cobra.Command, cliArguments []string) {
 
 	if configuration.VersionMode() {
 		if configuration.OutputFormat() == outputformat.Text {
-			fmt.Println(configuration.Version() + " " + configuration.BuildTimestamp())
+			if configuration.Version() == "" {
+				fmt.Print("0.0.0+" + configuration.Commit())
+			} else {
+				fmt.Print(configuration.Version())
+			}
+			fmt.Println(" " + configuration.BuildTimestamp())
 		} else {
 			versionObject := struct {
 				Version        string `json:"version"`
+				Commit         string `json:"commit"`
 				BuildTimestamp string `json:"buildTimestamp"`
 			}{
 				Version:        configuration.Version(),
+				Commit:         configuration.Commit(),
 				BuildTimestamp: configuration.BuildTimestamp(),
 			}
 			versionJSON, err := json.MarshalIndent(versionObject, "", "  ")

internal/configuration/configuration.go

@@ -200,16 +200,18 @@ func VersionMode() bool {
 }
 
 var version string
-var commit string
 
 func Version() string {
-	if version == "" {
-		return "0.0.0+" + commit
-	}
-
 	return version
 }
 
+var commit string
+
+// Commit returns the HEAD commit of the arduino-lint repository when the application was built.
+func Commit() string {
+	return commit
+}
+
 var buildTimestamp string
 
 func BuildTimestamp() string {

internal/configuration/configuration_test.go

@@ -237,12 +237,15 @@ func TestInitializeOfficial(t *testing.T) {
 }
 
 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 TestCommit(t *testing.T) {
+	commit = "abcd"
+	assert.Equal(t, commit, Commit())
+}
+
 func TestBuildTimestamp(t *testing.T) {
 	buildTimestamp = "2020-11-27T04:05:19+00:00"
 	assert.Equal(t, buildTimestamp, BuildTimestamp())

test/test_all.py

@@ -177,6 +177,14 @@ def test_version(run_command):
     assert semver.VersionInfo.isvalid(version=output_list[0])
     dateutil.parser.isoparse(output_list[1])
 
+    result = run_command(cmd=["--version", "--format", "json"])
+    assert result.ok
+    version_output = json.loads(result.stdout)
+    if version_output["version"] != "":
+        assert semver.VersionInfo.isvalid(version=version_output["version"])
+    assert version_output["commit"] != ""
+    dateutil.parser.isoparse(version_output["buildTimestamp"])
+
 
 def test_arduino_lint_official(run_command):
     project_path = test_data_path.joinpath("ARDUINO_LINT_OFFICIAL")