- Fixed go imports

- Added additional checks for not null flag name if given

Author: cx-anjali-deore

internal/commands/asca/asca-engine.go

@@ -7,8 +7,14 @@ import (
 	"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"
+	"strings"
+)
+
+const (
+	ascaLocationParam = "asca-location"
 )
 
 func RunScanASCACommand(jwtWrapper wrappers.JWTWrapper) func(cmd *cobra.Command, args []string) error {
@@ -18,12 +24,18 @@ func RunScanASCACommand(jwtWrapper wrappers.JWTWrapper) func(cmd *cobra.Command,
 		fileSourceFlag, _ := cmd.Flags().GetString(commonParams.SourcesFlag)
 		ignoredFilePathFlag, _ := cmd.Flags().GetString(commonParams.IgnoredFilePathFlag)
 		agent, _ := cmd.Flags().GetString(commonParams.AgentFlag)
-		vorpal := viper.GetString(commonParams.VorpalCustomPathKey)
+		err := validateASCALocationFlags(cmd)
+		if err != nil {
+			return err
+		}
+
+		vorpal := strings.TrimSpace(viper.GetString(commonParams.VorpalCustomPathKey))
 		if vorpal != "" {
 			vorpalLocation = vorpal
-		} else if location := utils.GetOptionalParam(commonParams.ASCALocationFlag); location != "" {
+		} else if location := utils.GetOptionalParam(ascaLocationParam); location != "" {
 			vorpalLocation = location
 		}
+
 		var port = viper.GetInt(commonParams.ASCAPortKey)
 		ASCAWrapper := grpcs.NewASCAGrpcWrapper(port)
 		ASCAParams := services.AscaScanParams{
@@ -40,7 +52,6 @@ func RunScanASCACommand(jwtWrapper wrappers.JWTWrapper) func(cmd *cobra.Command,
 		if err != nil {
 			return err
 		}
-
 		err = printer.Print(cmd.OutOrStdout(), scanResult, printer.FormatJSON)
 		if err != nil {
 			return err
@@ -49,3 +60,16 @@ func RunScanASCACommand(jwtWrapper wrappers.JWTWrapper) func(cmd *cobra.Command,
 		return nil
 	}
 }
+
+func validateASCALocationFlags(cmd *cobra.Command) error {
+	if cmd.Flags().Changed(commonParams.ASCALocationFlag) {
+		flagVal, err := cmd.Flags().GetString(commonParams.ASCALocationFlag)
+		if err != nil {
+			return err
+		}
+		if strings.TrimSpace(flagVal) == "" {
+			return errors.Errorf("%s flag is provided but empty", commonParams.ASCALocationFlag)
+		}
+	}
+	return nil
+}

internal/commands/root.go

@@ -118,7 +118,10 @@ func NewAstCLI(
 	// are passed to Cobra.
 	rootCmd.PersistentPreRunE = func(cmd *cobra.Command, args []string) error {
 		CheckPreferredCredentials(cmd)
-		err := extractOptionalFlags()
+		err := extractOptionalFlags(cmd)
+		if err != nil {
+			return err
+		}
 		err = customLogConfiguration(rootCmd)
 		if err != nil {
 			return err
@@ -434,7 +437,13 @@ func CheckPreferredCredentials(cmd *cobra.Command) {
 	}
 }
 
-func extractOptionalFlags() error {
+func extractOptionalFlags(cmd *cobra.Command) error {
+	if cmd.Flags().Changed(params.OptionalFlags) {
+		flagVal := strings.TrimSpace(viper.GetString(params.OptionalFlags))
+		if strings.TrimSpace(flagVal) == "" {
+			return errors.Errorf("%s flag is provided but empty", params.OptionalFlags)
+		}
+	}
 	optionalFlags := strings.TrimSpace(viper.GetString(params.OptionalFlagsKey))
 	if optionalFlags == "" {
 		return nil

internal/commands/scan.go

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

internal/params/flags.go

@@ -68,7 +68,7 @@ const (
 	BaseURIFlag                    = "base-uri"
 	ProxyFlag                      = "proxy"
 	ProxyFlagUsage                 = "Proxy server to send communication through"
-	OptionalFlagUsage              = "Optional global flags for CLI "
+	OptionalFlagUsage              = "Flag for adding optional global configurations"
 	IgnoreProxyFlag                = "ignore-proxy"
 	IgnoreProxyFlagUsage           = "Ignore proxy configuration"
 	ProxyTypeFlag                  = "proxy-auth-type"

internal/services/asca.go

@@ -76,7 +76,7 @@ func CreateASCAScanRequest(ascaParams AscaScanParams, wrapperParams AscaWrappers
 		if err != nil {
 			return nil, err
 		}
-	} else if err = ValidateCustomASCAInstallation(vorpalLocation); err != nil {
+	} else if err := ValidateCustomASCAInstallation(vorpalLocation); err != nil {
 		return nil, err
 	}
 	err = ensureASCAServiceRunning(wrapperParams, ascaParams)

internal/services/asca_test.go

@@ -2,11 +2,12 @@ package services
 
 import (
 	"fmt"
-	"github.com/checkmarx/ast-cli/internal/commands/asca/ascaconfig"
+
 	"os"
 	"path/filepath"
 	"testing"
 
+	"github.com/checkmarx/ast-cli/internal/commands/asca/ascaconfig"
 	errorconstants "github.com/checkmarx/ast-cli/internal/constants/errors"
 	"github.com/checkmarx/ast-cli/internal/params"
 	"github.com/checkmarx/ast-cli/internal/wrappers"

internal/wrappers/utils/utils.go

@@ -1,11 +1,12 @@
 package utils
 
 import (
-	"github.com/checkmarx/ast-cli/internal/logger"
 	"net/url"
 	"path"
 	"strings"
 	"sync"
+
+	"github.com/checkmarx/ast-cli/internal/logger"
 )
 
 var (

internal/wrappers/utils/utils_test.go

@@ -231,11 +231,11 @@ func TestConcurrentSetOptionalParam(t *testing.T) {
 	// spawn several goroutines setting allowed and disallowed keys
 	for i := 0; i < 10; i++ {
 		wg.Add(1)
-		go func(i int) {
+		go func() {
 			defer wg.Done()
 			SetOptionalParam(ascaLocationKey, "v")
 			SetOptionalParam("not-allowed", "x")
-		}(i)
+		}()
 	}
 	wg.Wait()