Added subroutines to detect compiler family and version

Author: cmaglie

Diff for: internal/builder/diagnostics/compiler_detection.go

@@ -0,0 +1,85 @@
+// This file is part of arduino-cli.
+//
+// Copyright 2023 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 [email protected].
+
+package diagnostics
+
+import (
+	"bytes"
+	"path/filepath"
+	"strings"
+
+	"github.com/arduino/arduino-cli/executils"
+	semver "go.bug.st/relaxed-semver"
+)
+
+// DetectedCompiler represents a compiler detected from a given command line
+type DetectedCompiler struct {
+	Name            string
+	Family          string
+	Version         *semver.Version
+	DetailedVersion []string
+}
+
+// This function is overridden for mocking unit tests
+var runProcess = func(args ...string) []string {
+	if cmd, err := executils.NewProcess(nil, args...); err == nil {
+		out := &bytes.Buffer{}
+		cmd.RedirectStdoutTo(out)
+		cmd.Run()
+		return splitLines(out.Bytes())
+	}
+	return nil
+}
+
+// DetectCompilerFromCommandLine tries to detect a compiler from a given command line.
+// If probleCompiler is true, the compiler may be executed with different flags to
+// infer the version or capabilities.
+func DetectCompilerFromCommandLine(args []string, probeCompiler bool) *DetectedCompiler {
+	if len(args) == 0 {
+		return nil
+	}
+	basename := filepath.Base(args[0])
+	family := ""
+	if strings.Contains(basename, "g++") || strings.Contains(basename, "gcc") {
+		family = "gcc"
+	}
+	res := &DetectedCompiler{
+		Name:   basename,
+		Family: family,
+	}
+
+	if family == "gcc" && probeCompiler {
+		// Run "gcc --verion" to obtain more info
+		res.DetailedVersion = runProcess(args[0], "--version")
+
+		// Usually on the first line we get the compiler architecture and
+		// version (as last field), followed by the compiler license, for
+		// example:
+		//
+		//   g++ (Ubuntu 12.2.0-3ubuntu1) 12.2.0
+		//   Copyright (C) 2022 Free Software Foundation, Inc.
+		//   This is free software; see the source for copying conditions.  There is NO
+		//   warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+		//
+		if len(res.DetailedVersion) > 0 {
+			split := strings.Split(res.DetailedVersion[0], " ")
+			if len(split) >= 3 {
+				res.Name = split[0]
+				res.Version, _ = semver.Parse(split[len(split)-1])
+			}
+		}
+	}
+	return res
+}

Diff for: internal/builder/diagnostics/compiler_detection_test.go

@@ -0,0 +1,79 @@
+// This file is part of arduino-cli.
+//
+// Copyright 2023 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 [email protected].
+
+package diagnostics
+
+import (
+	"strings"
+	"testing"
+
+	"github.com/stretchr/testify/require"
+)
+
+func init() {
+	runProcess = mockedRunProcessToGetCompilerVersion
+}
+
+func mockedRunProcessToGetCompilerVersion(args ...string) []string {
+	if strings.HasSuffix(args[0], "7.3.0-atmel3.6.1-arduino7/bin/avr-g++") && args[1] == "--version" {
+		return []string{
+			"avr-g++ (GCC) 7.3.0",
+			"Copyright (C) 2017 Free Software Foundation, Inc.",
+			"This is free software; see the source for copying conditions.  There is NO",
+			"warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.",
+			"",
+		}
+	}
+	if strings.HasSuffix(args[0], "7.3.0-atmel3.6.1-arduino7/bin/avr-gcc") && args[1] == "--version" {
+		return []string{
+			"avr-gcc (GCC) 7.3.0",
+			"Copyright (C) 2017 Free Software Foundation, Inc.",
+			"This is free software; see the source for copying conditions.  There is NO",
+			"warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.",
+			"",
+		}
+	}
+	if strings.HasSuffix(args[0], "xtensa-esp32-elf-gcc/gcc8_4_0-esp-2021r2-patch3/bin/xtensa-esp32-elf-g++") && args[1] == "--version" {
+		return []string{
+			"xtensa-esp32-elf-g++ (crosstool-NG esp-2021r2-patch3) 8.4.0",
+			"Copyright (C) 2018 Free Software Foundation, Inc.",
+			"This is free software; see the source for copying conditions.  There is NO",
+			"warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.",
+			"",
+		}
+	}
+
+	panic("missing mock for command line: " + strings.Join(args, " "))
+}
+
+func TestCompilerDetection(t *testing.T) {
+	comp := DetectCompilerFromCommandLine([]string{"~/.arduino15/packages/arduino/tools/avr-gcc/7.3.0-atmel3.6.1-arduino7/bin/avr-g++"}, true)
+	require.NotNil(t, comp)
+	require.Equal(t, "gcc", comp.Family)
+	require.Equal(t, "avr-g++", comp.Name)
+	require.Equal(t, "7.3.0", comp.Version.String())
+
+	comp = DetectCompilerFromCommandLine([]string{"~/.arduino15/packages/arduino/tools/avr-gcc/7.3.0-atmel3.6.1-arduino7/bin/avr-gcc"}, true)
+	require.NotNil(t, comp)
+	require.Equal(t, "gcc", comp.Family)
+	require.Equal(t, "avr-gcc", comp.Name)
+	require.Equal(t, "7.3.0", comp.Version.String())
+
+	comp = DetectCompilerFromCommandLine([]string{"/home/megabug/.arduino15/packages/esp32/tools/xtensa-esp32-elf-gcc/gcc8_4_0-esp-2021r2-patch3/bin/xtensa-esp32-elf-g++"}, true)
+	require.NotNil(t, comp)
+	require.Equal(t, "gcc", comp.Family)
+	require.Equal(t, "xtensa-esp32-elf-g++", comp.Name)
+	require.Equal(t, "8.4.0", comp.Version.String())
+}