refactor: toolchains config, add AUTO_BUILD_TOOLCHAIN_CONFIG

Author: iseki0

cmd/murphy/internal/scan/cmd.go

@@ -19,8 +19,8 @@ import (
 	"github.com/murphysecurity/murphysec/inspector"
 	"github.com/murphysecurity/murphysec/model"
 	"github.com/murphysecurity/murphysec/module/gradle"
-	"github.com/murphysecurity/murphysec/module/maven"
 	"github.com/murphysecurity/murphysec/scanerr"
+	"github.com/murphysecurity/murphysec/toolver"
 	"github.com/murphysecurity/murphysec/utils"
 	"github.com/murphysecurity/murphysec/utils/must"
 	"github.com/repeale/fp-go"
@@ -33,7 +33,6 @@ var isDeep bool
 var noBuild bool
 var projectNameCli string
 var projectsNameCli string
-var mavenSettingsPath string
 var onlyTaskId bool
 var privateSourceId string
 var privateSourceName string
@@ -91,7 +90,7 @@ func DfCmd() *cobra.Command {
 	c.Flags().StringArrayVar(&mavenModuleName, "maven-module-name", make([]string, 0), "retains module")
 	c.Flags().StringVar(&projectNameCli, "project-name", "", "specify project name")
 	c.Flags().StringVar(&projectsNameCli, "projects-name", "", "specify projects name(group)")
-	c.Flags().StringVar(&mavenSettingsPath, "maven-settings", "", "specify the path of maven settings")
+	c.Flags().StringVar(&toolver.Default.Maven.MavenSettingPath, "maven-settings", "", "specify the path of maven settings")
 	c.Flags().BoolVar(&onlyTaskId, "only-task-id", false, "print task id after task created, the scan result will not be printed")
 	c.Flags().StringArrayVar(&projectTagNames, "project-tag", make([]string, 0), "specify the tag of the project")
 	c.Flags().StringVar(&sbomOutputConfig, "sbom-output", "-", "Specify the SBOM output file path, use \"-\" to output to stdout")
@@ -271,10 +270,6 @@ func dfScanRun(cmd *cobra.Command, args []string) {
 		ctx = ui.With(ctx, ui.CLI)
 	}
 
-	if mavenSettingsPath != "" {
-		//nolint:all
-		ctx = context.WithValue(ctx, maven.M2SettingsFilePathCtxKey, mavenSettingsPath)
-	}
 	scanDir := args[0]
 	scanDir, e := commonScanPreCheck(ctx, scanDir)
 	if e != nil {

env/maven.go

@@ -1,95 +1,16 @@
 package env
 
 import (
-	"github.com/murphysecurity/murphysec/utils"
 	"os"
-	"path/filepath"
-	"runtime"
 	"strings"
 )
 
-var IdeaMavenHome string
-var IdeaMavenConf string
-var IdeaMavenJre string
 var MvnCommandTimeout = envi("MVN_COMMAND_TIMEOUT", 0)
 var DisableMvnCommand = strings.TrimSpace(os.Getenv("NO_MVN")) != ""
 var MavenCentral string
 
 func init() {
-	var s string
-	s = strings.TrimSpace(os.Getenv("IDEA_MAVEN_CONF"))
-	if s != "" && utils.IsFile(s) && strings.ToLower(filepath.Ext(s)) == ".xml" {
-		IdeaMavenConf = s
-	}
-
-	IdeaMavenHome = locateMavenIdeaMavenHome()
-
-	s = strings.TrimSpace(os.Getenv("IDEA_MAVEN_JRE"))
-	if s != "" && utils.IsDir(s) {
-		IdeaMavenJre = s
-	}
-
 	if strings.TrimSpace(os.Getenv("SKIP_MAVEN_CENTRAL")) == "" {
 		MavenCentral = "https://repo1.maven.org/maven2/"
 	}
 }
-
-func locateMavenIdeaMavenHome() string {
-	// todo: refactor
-	var s = strings.TrimSpace(os.Getenv("IDEA_MAVEN_HOME"))
-	if s == "" {
-		return ""
-	}
-	if !filepath.IsAbs(s) {
-		abs, e := filepath.Abs(s)
-		if e == nil {
-			s = abs
-		}
-	}
-	if _s, e := filepath.EvalSymlinks(s); e == nil && _s != "" {
-		s = _s
-	}
-	if runtime.GOOS == "windows" {
-		return locateMavenIdeaMavenHomeWindows(s)
-	}
-	return locateMavenIdeaMavenHomeUnix(s)
-}
-
-func locateMavenIdeaMavenHomeUnix(s string) string {
-	if utils.IsFile(s) {
-		return s
-	}
-	suffixes := []string{"mvn", "bin/mvn"}
-	for _, it := range suffixes {
-		target := filepath.Join(s, it)
-		if utils.IsFile(target) {
-			return target
-		}
-	}
-	return ""
-}
-
-func locateMavenIdeaMavenHomeWindows(s string) string {
-	if utils.IsFile(s) {
-		ext := strings.ToLower(filepath.Ext(s))
-		if ext == ".exe" || ext == ".bat" || ext == ".cmd" {
-			return s
-		}
-		return ""
-	}
-	var suffixes = []string{
-		"mvn.cmd",
-		"mvn.bat",
-		"mvn.exe",
-		"bin\\mvn.cmd",
-		"bin\\mvn.bat",
-		"bin\\mvn.exe",
-	}
-	for _, suffix := range suffixes {
-		target := filepath.Join(s, suffix)
-		if utils.IsFile(target) {
-			return target
-		}
-	}
-	return ""
-}

module/maven/m2setting.go

@@ -4,17 +4,19 @@ import (
 	"bytes"
 	"context"
 	"fmt"
+	"os"
+	"path/filepath"
+	"runtime"
+	"strings"
+
 	"github.com/antchfx/xmlquery"
 	"github.com/mitchellh/go-homedir"
 	"github.com/murphysecurity/murphysec/env"
 	"github.com/murphysecurity/murphysec/infra/logctx"
+	"github.com/murphysecurity/murphysec/toolver"
 	"github.com/murphysecurity/murphysec/utils"
 	"github.com/murphysecurity/murphysec/utils/must"
 	"go.uber.org/zap"
-	"os"
-	"path/filepath"
-	"runtime"
-	"strings"
 )
 
 type UserConfig struct {
@@ -100,9 +102,10 @@ func locateMvnInstallPath(ctx context.Context) string {
 }
 
 func mavenSettingsPaths(ctx context.Context) (paths []string) {
-	// IDEA specified path
-	if env.IdeaMavenConf != "" {
-		paths = append(paths, env.IdeaMavenConf)
+	// specified path
+	var toolConfig = toolver.Get(ctx)
+	if toolConfig.Maven.MavenSettingPath != "" {
+		paths = append(paths, toolConfig.Maven.MavenSettingPath)
 	}
 	// user path
 	var homeDir = os.Getenv("M2_HOME")

module/maven/mvn_cmd_utils.go

@@ -13,16 +13,19 @@ import (
 
 	"github.com/murphysecurity/murphysec/env"
 	"github.com/murphysecurity/murphysec/infra/logctx"
+	"github.com/murphysecurity/murphysec/toolver"
 	"go.uber.org/zap"
 )
 
-const M2SettingsFilePathCtxKey = "MavenSettingsFilePathCtxKey"
-
 type MvnCommandInfo struct {
 	Path             string `json:"path"`
 	MvnVersion       string `json:"mvn_version"`
 	UserSettingsPath string `json:"user_settings_path"`
 	JavaHome         string `json:"java_home"`
+
+	AdditionalArgs []string `json:"additional_args,omitempty"`
+
+	AdditionalPrependArgs []string `json:"additional_prepend_args,omitempty"`
 }
 
 func (m MvnCommandInfo) String() string {
@@ -33,12 +36,14 @@ func (m MvnCommandInfo) Command(ctx context.Context, args ...string) *exec.Cmd {
 	if ctx == nil {
 		ctx = context.TODO()
 	}
-	var _args = make([]string, 0, len(args)+5)
+	var _args = make([]string, 0)
+	_args = append(_args, m.AdditionalPrependArgs...)
 	if m.UserSettingsPath != "" {
 		_args = append(_args, "--settings", m.UserSettingsPath)
 	}
 	_args = append(_args, "--batch-mode")
 	_args = append(_args, args...)
+	_args = append(_args, m.AdditionalArgs...)
 	cmd := exec.CommandContext(ctx, m.Path, _args...)
 	if m.JavaHome != "" {
 		cmd.Env = os.Environ()
@@ -55,7 +60,7 @@ type _MvnCommandResult struct {
 }
 
 func CheckMvnCommand(ctx context.Context, isNoBuild bool) (info *MvnCommandInfo, err error) {
-
+	var toolVer = toolver.Get(ctx)
 	var logger = logctx.Use(ctx)
 	if cachedMvnCommandResult != nil {
 		if cachedMvnCommandResult.e != nil {
@@ -83,18 +88,15 @@ func CheckMvnCommand(ctx context.Context, isNoBuild bool) (info *MvnCommandInfo,
 	}
 
 	info = &MvnCommandInfo{}
-	info.Path = env.IdeaMavenHome
+	info.Path = toolVer.Maven.MavenCommand
 	if info.Path == "" {
 		info.Path = getMvnCommandOs()
 	}
 	if info.Path == "" {
 		return nil, ErrMvnNotFound
 	}
-	info.JavaHome = env.IdeaMavenJre
-	info.UserSettingsPath = env.IdeaMavenConf
-	if r, ok := ctx.Value(M2SettingsFilePathCtxKey).(string); ok {
-		info.UserSettingsPath = r
-	}
+	info.JavaHome = toolVer.Maven.JavaHome
+	info.UserSettingsPath = toolVer.Maven.MavenSettingPath
 	// check version
 	ver, e := checkMvnVersion(ctx, info.Path, info.JavaHome)
 	if e != nil {

toolver/env.go

@@ -0,0 +1,23 @@
+package toolver
+
+import (
+	"encoding/json"
+	"os"
+	"sync"
+)
+
+var envOnce sync.Once
+var envConfig *Config
+
+func getFromEnv() *Config {
+	envOnce.Do(func() {
+		var s = os.Getenv("AUTO_BUILD_TOOLCHAIN_CONFIG")
+		if s != "" {
+			var o Config
+			if json.Unmarshal([]byte(s), &o) != nil {
+				envConfig = &o
+			}
+		}
+	})
+	return envConfig
+}

toolver/get.go

@@ -0,0 +1,55 @@
+package toolver
+
+import (
+	"context"
+	"reflect"
+)
+
+var Default Config
+var postprocessors []func(context.Context, *Config)
+
+func Get(ctx context.Context) *Config {
+	return mergeConfig(mergeConfig(&Default, getIntellijConfig()), getFromEnv())
+}
+
+func mergeConfig(old *Config, new *Config) *Config {
+	if old == nil && new == nil {
+		return nil
+	}
+	if old == nil {
+		c := *new
+		return &c
+	}
+	if new == nil {
+		c := *old
+		return &c
+	}
+
+	result := *old
+
+	mergeStruct(reflect.ValueOf(&result).Elem(), reflect.ValueOf(new).Elem())
+
+	return &result
+}
+
+func mergeStruct(dst, src reflect.Value) {
+	for i := 0; i < dst.NumField(); i++ {
+		dstField := dst.Field(i)
+		srcField := src.Field(i)
+
+		if !srcField.IsValid() || !srcField.CanInterface() {
+			continue
+		}
+
+		switch dstField.Kind() {
+		case reflect.Struct:
+			mergeStruct(dstField, srcField)
+		default:
+			if !srcField.IsZero() {
+				if dstField.CanSet() {
+					dstField.Set(srcField)
+				}
+			}
+		}
+	}
+}