- Added changes as per review comments

Author: cx-anjali-deore

internal/commands/asca/asca-engine.go

@@ -1,14 +1,14 @@
 package asca
 
 import (
+	"github.com/checkmarx/ast-cli/internal/wrappers/utils"
 	"strings"
 
 	"github.com/checkmarx/ast-cli/internal/commands/util/printer"
 	commonParams "github.com/checkmarx/ast-cli/internal/params"
 	"github.com/checkmarx/ast-cli/internal/services"
 	"github.com/checkmarx/ast-cli/internal/wrappers"
 	"github.com/checkmarx/ast-cli/internal/wrappers/grpcs"
-	"github.com/checkmarx/ast-cli/internal/wrappers/utils"
 	"github.com/pkg/errors"
 	"github.com/spf13/cobra"
 	"github.com/spf13/viper"
@@ -30,7 +30,7 @@ func RunScanASCACommand(jwtWrapper wrappers.JWTWrapper) func(cmd *cobra.Command,
 			return err
 		}
 
-		vorpal := strings.TrimSpace(viper.GetString(commonParams.VorpalCustomPathKey))
+		vorpal := strings.TrimSpace(viper.GetString(commonParams.ASCALocationKey))
 		if vorpal != "" {
 			vorpalLocation = vorpal
 		} else if location := utils.GetOptionalParam(ascaLocationParam); location != "" {
@@ -44,12 +44,14 @@ func RunScanASCACommand(jwtWrapper wrappers.JWTWrapper) func(cmd *cobra.Command,
 			ASCAUpdateVersion: ASCALatestVersion,
 			IsDefaultAgent:    agent == commonParams.DefaultAgent,
 			IgnoredFilePath:   ignoredFilePathFlag,
+			VorpalLocation:    vorpalLocation,
 		}
+
 		wrapperParams := services.AscaWrappersParam{
 			JwtWrapper:  jwtWrapper,
 			ASCAWrapper: ASCAWrapper,
 		}
-		scanResult, err := services.CreateASCAScanRequest(ASCAParams, wrapperParams, vorpalLocation)
+		scanResult, err := services.CreateASCAScanRequest(ASCAParams, wrapperParams)
 		if err != nil {
 			return err
 		}

internal/commands/root.go

@@ -461,7 +461,10 @@ func extractOptionalFlags(cmd *cobra.Command) error {
 		if len(keyVal) != params.KeyValuePairSize {
 			return errors.New("Invalid optional flags. Optional flags should be in a KEY1=VALUE1;KEY2=VALUE2 format")
 		}
-		utils.SetOptionalParam(keyVal[0], keyVal[1])
+		err := utils.SetOptionalParam(keyVal[0], keyVal[1])
+		if err != nil {
+			return err
+		}
 	}
 	return nil
 }

internal/commands/scan.go

@@ -482,8 +482,8 @@ func scanASCASubCommand(jwtWrapper wrappers.JWTWrapper, featureFlagsWrapper wrap
 	)
 
 	scanASCACmd.PersistentFlags().String(commonParams.IgnoredFilePathFlag, "", "Path to ignored secrets file")
-	scanASCACmd.PersistentFlags().String(commonParams.ASCALocationFlag, "", "Path to custom location where ASCA is installed")
-	_ = viper.BindPFlag(commonParams.VorpalCustomPathKey, scanASCACmd.PersistentFlags().Lookup(commonParams.ASCALocationFlag))
+	scanASCACmd.PersistentFlags().String(commonParams.ASCALocationFlag, "", "Path to custom location where ASCA engine is installed")
+	_ = viper.BindPFlag(commonParams.ASCALocationKey, scanASCACmd.PersistentFlags().Lookup(commonParams.ASCALocationFlag))
 
 	return scanASCACmd
 }

internal/params/binds.go

@@ -87,6 +87,6 @@ var EnvVarsBinds = []struct {
 	{CompleteMultiPartUploadPathKey, CompleteMultipartUploadPathEnv, "api/uploads/complete-multipart-upload"},
 	{MultipartFileSizeKey, MultipartFileSizeEnv, "2"},
 	{DisableASCALatestVersionKey, DisableASCALatestVersionEnv, ""},
-	{VorpalCustomPathKey, VorpalPathEnv, ""},
+	{ASCALocationKey, ASCALocationEnv, ""},
 	{OptionalFlagsKey, OptionalFlagsEnv, ""},
 }

internal/params/envs.go

@@ -90,6 +90,6 @@ const (
 	CompleteMultipartUploadPathEnv      = "CX_COMPLETE_MULTIPART_UPLOAD_PATH"
 	MultipartFileSizeEnv                = "MULTIPART_FILE_SIZE"
 	DisableASCALatestVersionEnv         = "DISABLE_ASCA_UPDATE"
-	VorpalPathEnv                       = "CX_ASCA_PATH"
+	ASCALocationEnv                     = "CX_ASCA_LOCATION"
 	OptionalFlagsEnv                    = "CX_OPTIONAL_FLAGS"
 )

internal/params/flags.go

@@ -68,7 +68,7 @@ const (
 	BaseURIFlag                    = "base-uri"
 	ProxyFlag                      = "proxy"
 	ProxyFlagUsage                 = "Proxy server to send communication through"
-	OptionalFlagUsage              = "Flag for adding optional global configurations"
+	OptionalFlagUsage              = "Flag for providing command specific flag from IDE or CI/CD plugins."
 	IgnoreProxyFlag                = "ignore-proxy"
 	IgnoreProxyFlagUsage           = "Ignore proxy configuration"
 	ProxyTypeFlag                  = "proxy-auth-type"

internal/params/keys.go

@@ -89,6 +89,6 @@ var (
 	CompleteMultiPartUploadPathKey      = strings.ToLower(CompleteMultipartUploadPathEnv)
 	MultipartFileSizeKey                = strings.ToLower(MultipartFileSizeEnv)
 	DisableASCALatestVersionKey         = strings.ToLower(DisableASCALatestVersionEnv)
-	VorpalCustomPathKey                 = strings.ToLower(VorpalPathEnv)
+	ASCALocationKey                     = strings.ToLower(ASCALocationEnv)
 	OptionalFlagsKey                    = strings.ToLower(OptionalFlagsEnv)
 )

internal/services/asca.go

@@ -33,6 +33,7 @@ type AscaScanParams struct {
 	ASCAUpdateVersion bool
 	IsDefaultAgent    bool
 	IgnoredFilePath   string
+	VorpalLocation    string
 }
 
 type AscaWrappersParam struct {
@@ -59,24 +60,24 @@ func validateVorpalDirExist(dirPath string) error {
 
 func ValidateCustomASCAInstallation(vorpalLocation string) error {
 	if err := validateVorpalDirExist(vorpalLocation); err != nil {
-		return errors.Wrap(err, "Failed to validate ASCA location")
+		return errors.Wrap(err, "Failed to validate ASCA custom location")
 	}
-	ascaconfig.Params.SetVorpalCustomPath(vorpalLocation)
-	ASCAInstalled, _ := osinstaller.FileExists(ascaconfig.Params.ExecutableFilePath())
+	ASCAInstalled, _ := osinstaller.FileExists(filepath.Join(vorpalLocation, ascaconfig.Params.ExecutableFile))
 	if !ASCAInstalled {
 		return errors.Errorf("No ASCA executable found in provided location: %s", vorpalLocation)
 	}
+	logger.PrintIfVerbose("Using custom ASCA engine installed at: " + vorpalLocation)
 	return nil
 }
 
-func CreateASCAScanRequest(ascaParams AscaScanParams, wrapperParams AscaWrappersParam, vorpalLocation string) (*grpcs.ScanResult, error) {
+func CreateASCAScanRequest(ascaParams AscaScanParams, wrapperParams AscaWrappersParam) (*grpcs.ScanResult, error) {
 	var err error
-	if vorpalLocation == "" {
+	if ascaParams.VorpalLocation == "" {
 		err = manageASCAInstallation(ascaParams, wrapperParams)
 		if err != nil {
 			return nil, err
 		}
-	} else if err := ValidateCustomASCAInstallation(vorpalLocation); err != nil {
+	} else if err := ValidateCustomASCAInstallation(ascaParams.VorpalLocation); err != nil {
 		return nil, err
 	}
 	err = ensureASCAServiceRunning(wrapperParams, ascaParams)
@@ -254,7 +255,7 @@ func ensureASCAServiceRunning(wrappersParam AscaWrappersParam, ascaParams AscaSc
 		if err != nil {
 			return err
 		}
-		if err := RunASCAEngine(wrappersParam.ASCAWrapper.GetPort()); err != nil {
+		if err := RunASCAEngine(wrappersParam.ASCAWrapper.GetPort(), ascaParams.VorpalLocation); err != nil {
 			return err
 		}
 
@@ -281,16 +282,21 @@ func readSourceCode(filePath string) (string, error) {
 	return string(data), nil
 }
 
-func RunASCAEngine(port int) error {
+func RunASCAEngine(port int, vorpalLocation string) error {
 	dialTimeout := 5 * time.Second
 	args := []string{
 		"-listen",
 		fmt.Sprintf("%d", port),
 	}
 
 	logger.PrintIfVerbose(fmt.Sprintf("Running ASCA engine with args: %v \n", args))
+	var cmd *exec.Cmd
 
-	cmd := exec.Command(ascaconfig.Params.ExecutableFilePath(), args...)
+	if vorpalLocation != "" {
+		cmd = exec.Command(filepath.Join(vorpalLocation, ascaconfig.Params.ExecutableFile), args...)
+	} else {
+		cmd = exec.Command(ascaconfig.Params.ExecutableFilePath(), args...)
+	}
 
 	osinstaller.ConfigureIndependentProcess(cmd)
 

internal/services/osinstaller/os-installer-structs.go

@@ -3,30 +3,18 @@ package osinstaller
 import (
 	"os"
 	"path/filepath"
-
-	"github.com/checkmarx/ast-cli/internal/logger"
 )
 
 type InstallationConfiguration struct {
-	ExecutableFile   string
-	DownloadURL      string
-	HashDownloadURL  string
-	FileName         string
-	HashFileName     string
-	WorkingDirName   string
-	VorpalCustomPath string
-}
-
-func (i *InstallationConfiguration) SetVorpalCustomPath(path string) {
-	i.VorpalCustomPath = path
+	ExecutableFile  string
+	DownloadURL     string
+	HashDownloadURL string
+	FileName        string
+	HashFileName    string
+	WorkingDirName  string
 }
 
 func (i *InstallationConfiguration) ExecutableFilePath() string {
-	if i.VorpalCustomPath != "" && i.WorkingDirName == "CxVorpal" {
-		logger.PrintfIfVerbose("Using custom ASCA path: %s", i.VorpalCustomPath)
-		return filepath.Join(i.VorpalCustomPath, i.ExecutableFile)
-	}
-
 	basePath := os.TempDir()
 	homeDir, err := os.UserHomeDir()
 	if err == nil {

internal/wrappers/utils/utils.go

@@ -1,6 +1,7 @@
 package utils
 
 import (
+	"errors"
 	"net/url"
 	"path"
 	"strings"
@@ -44,15 +45,18 @@ func LimitSlice[T any](slice []T, limit int) []T {
 	return slice[:limit]
 }
 
-func SetOptionalParam(key, value string) {
+func SetOptionalParam(key, value string) error {
 	logger.PrintfIfVerbose("Setting optional parameter: %s", key)
 	mutex.Lock()
 	defer mutex.Unlock()
 	value = strings.TrimSpace(value)
 	key = strings.TrimSpace(key)
 	if _, ok := allowedOptionalKeys[key]; ok {
 		optionalParams[key] = value
+	} else {
+		return errors.New("Invalid optional parameter key: " + key)
 	}
+	return nil
 }
 
 func hasOptionalParam(key string) bool {