Merge branch 'main' into feature/saraChen/addTelemetryCmd

Author: cx-sarah-chen

internal/commands/root.go

@@ -2,8 +2,10 @@ package commands
 
 import (
 	"fmt"
+	"io"
 	"log"
 	"os"
+	"path/filepath"
 	"strings"
 
 	"github.com/MakeNowJust/heredoc"
@@ -103,12 +105,21 @@ func NewAstCLI(
 	rootCmd.PersistentFlags().Bool(params.ApikeyOverrideFlag, false, "")
 
 	_ = rootCmd.PersistentFlags().MarkHidden(params.ApikeyOverrideFlag)
+	rootCmd.PersistentFlags().String(params.LogFileFlag, "", params.LogFileUsage)
+	rootCmd.PersistentFlags().String(params.LogFileConsoleFlag, "", params.LogFileConsoleUsage)
 
 	// This monitors and traps situations where "extra/garbage" commands
 	// are passed to Cobra.
 	rootCmd.PersistentPreRunE = func(cmd *cobra.Command, args []string) error {
+		err := customLogConfiguration(rootCmd)
+		if err != nil {
+			return err
+		}
 		PrintConfiguration()
-		err := configuration.LoadConfiguration()
+		err = configuration.LoadConfiguration()
+		if err != nil {
+			return err
+		}
 		// Need to check the __complete command to allow correct behavior of the autocomplete
 		if len(args) > 0 && cmd.Name() != params.Help && cmd.Name() != "__complete" {
 			_ = cmd.Help()
@@ -137,7 +148,8 @@ func NewAstCLI(
 	_ = viper.BindPFlag(params.RetryFlag, rootCmd.PersistentFlags().Lookup(params.RetryFlag))
 	_ = viper.BindPFlag(params.RetryDelayFlag, rootCmd.PersistentFlags().Lookup(params.RetryDelayFlag))
 	_ = viper.BindPFlag(params.ApikeyOverrideFlag, rootCmd.PersistentFlags().Lookup(params.ApikeyOverrideFlag))
-
+	_ = viper.BindPFlag(params.LogFileFlag, rootCmd.PersistentFlags().Lookup(params.LogFileFlag))
+	_ = viper.BindPFlag(params.LogFileConsoleFlag, rootCmd.PersistentFlags().Lookup(params.LogFileConsoleFlag))
 	// Set help func
 	rootCmd.SetHelpFunc(
 		func(command *cobra.Command, args []string) {
@@ -336,3 +348,61 @@ func printByScanInfoFormat(cmd *cobra.Command, view interface{}) error {
 	f, _ := cmd.Flags().GetString(params.ScanInfoFormatFlag)
 	return printer.Print(cmd.OutOrStdout(), view, f)
 }
+
+func customLogConfiguration(cmd *cobra.Command) error {
+	if cmd.PersistentFlags().Changed(params.LogFileFlag) {
+		if err := setLogOutputFromFlag(params.LogFileFlag, viper.GetString(params.LogFileFlag)); err != nil {
+			return err
+		}
+	}
+	if cmd.PersistentFlags().Changed(params.LogFileConsoleFlag) {
+		if err := setLogOutputFromFlag(params.LogFileConsoleFlag, viper.GetString(params.LogFileConsoleFlag)); err != nil {
+			return err
+		}
+	}
+	return nil
+}
+
+func setLogOutputFromFlag(flag, dirPath string) error {
+	if strings.TrimSpace(dirPath) == "" {
+		return errors.New("flag needs an argument: --" + flag)
+	}
+
+	// Confirm it’s a directory
+	info, err := os.Stat(dirPath)
+	if err != nil {
+		if os.IsNotExist(err) {
+			return fmt.Errorf("the specified directory path does not exist. Please check the path: %s", dirPath)
+		}
+		return fmt.Errorf("an error occurred while accessing the directory path. Please check the path: %s", dirPath)
+	}
+	if !info.IsDir() {
+		return fmt.Errorf("expected a directory path but got a file: %s", dirPath)
+	}
+
+	// Create full path for the log file
+	logFilePath := filepath.Join(dirPath, "ast-cli.log")
+
+	const defaultFilePermissions = 0666
+	// open the log file with write and append permissions
+	// If file doesn't exist, it will be created. If permission is denied for directory path, return an error.
+	file, err := os.OpenFile(logFilePath, os.O_CREATE|os.O_WRONLY|os.O_APPEND, defaultFilePermissions)
+	if err != nil {
+		if os.IsPermission(err) {
+			return fmt.Errorf("permission denied: cannot write to directory %s", dirPath)
+		}
+		return fmt.Errorf("unable to open log file %s: %v", logFilePath, err)
+	}
+
+	// Configure the logger to write to the log file and optionally to stdout.
+	// If the flag indicates stdout logging is enabled, log output is duplicated to both file and console.
+	// Otherwise, logs are written only to the file.
+	var multiWriter io.Writer
+	if flag == params.LogFileConsoleFlag {
+		multiWriter = io.MultiWriter(file, os.Stdout)
+	} else {
+		multiWriter = io.MultiWriter(file)
+	}
+	log.SetOutput(multiWriter)
+	return nil
+}

internal/commands/root_test.go

@@ -10,6 +10,8 @@ import (
 	"strings"
 	"testing"
 
+	"github.com/checkmarx/ast-cli/internal/params"
+
 	"github.com/checkmarx/ast-cli/internal/wrappers"
 	"github.com/checkmarx/ast-cli/internal/wrappers/mock"
 	"github.com/spf13/viper"
@@ -254,3 +256,55 @@ func Test_stateExclude_not_exploitableRepalceForAllStatesExceptNot_exploitable(t
 		})
 	}
 }
+func TestSetLogOutputFromFlag_InvalidDir1(t *testing.T) {
+	err := setLogOutputFromFlag(params.LogFileFlag, "/custom/path")
+	assert.ErrorContains(t, err, "the specified directory path does not exist.")
+}
+
+func TestSetLogOutputFromFlag_EmptyDirPath(t *testing.T) {
+	err := setLogOutputFromFlag(params.LogFileFlag, "")
+	assert.ErrorContains(t, err, "flag needs an argument")
+}
+
+func TestSetLogOutputFromFlag_DirPathIsFilePath(t *testing.T) {
+	tempFile, _ := os.CreateTemp("", "ast-cli.txt")
+	defer func() {
+		if err := os.RemoveAll(tempFile.Name()); err != nil {
+			fmt.Printf("Warning: failed to clean up temp directory %s: %v\n", tempFile.Name(), err)
+		}
+	}()
+	err := setLogOutputFromFlag(params.LogFileFlag, tempFile.Name())
+	assert.ErrorContains(t, err, "expected a directory path but got a file")
+}
+
+func TestSetLogOutputFromFlag_DirPathPermissionDenied(t *testing.T) {
+	tempDir, _ := os.MkdirTemp("", "tempdir")
+	_ = os.Chmod(tempDir, 0000)
+	defer func(path string) {
+		_ = os.RemoveAll(path)
+	}(tempDir)
+	err := setLogOutputFromFlag(params.LogFileFlag, tempDir)
+	assert.ErrorContains(t, err, "permission denied: cannot write to directory")
+}
+
+func TestSetLogOutputFromFlag_DirPath_Success(t *testing.T) {
+	tempDir, _ := os.MkdirTemp("", "tempdir")
+	defer func() {
+		if err := os.RemoveAll(tempDir); err != nil {
+			fmt.Printf("Warning: failed to clean up temp directory %s: %v\n", tempDir, err)
+		}
+	}()
+	err := setLogOutputFromFlag(params.LogFileFlag, tempDir)
+	assert.NilError(t, err)
+}
+
+func TestSetLogOutputFromFlag_DirPath_Console_Success(t *testing.T) {
+	tempDir, _ := os.MkdirTemp("", "tempdir")
+	defer func() {
+		if err := os.RemoveAll(tempDir); err != nil {
+			fmt.Printf("Warning: failed to clean up temp directory %s: %v\n", tempDir, err)
+		}
+	}()
+	err := setLogOutputFromFlag(params.LogFileConsoleFlag, tempDir)
+	assert.NilError(t, err)
+}

internal/logger/utils.go

@@ -38,7 +38,7 @@ func Printf(msg string, args ...interface{}) {
 }
 
 func PrintIfVerbose(msg string) {
-	if viper.GetBool(params.DebugFlag) {
+	if viper.GetBool(params.DebugFlag) || viper.GetString(params.LogFileFlag) != "" || viper.GetString(params.LogFileConsoleFlag) != "" {
 		Print(msg)
 	}
 }

internal/params/flags.go

@@ -164,7 +164,10 @@ const (
 	ScaHideDevAndTestDepFlag     = "sca-hide-dev-test-dependencies"
 	LimitFlag                    = "limit"
 	ConfigFilePathFlag           = "config-file-path"
-
+	LogFileFlag                  = "log-file"
+	LogFileUsage                 = "Saves logs to the specified file path only"
+	LogFileConsoleFlag           = "log-file-console"
+	LogFileConsoleUsage          = "Saves logs to the specified file path as well as to the console"
 	// INDIVIDUAL FILTER FLAGS
 	SastFilterFlag  = "sast-filter"
 	SastFilterUsage = "SAST filter"

internal/wrappers/client.go

@@ -268,7 +268,7 @@ func SendHTTPRequestByFullURLContentLength(
 
 func addReqMonitor(req *http.Request) *http.Request {
 	startTime := time.Now().UnixNano() / int64(time.Millisecond)
-	if viper.GetBool(commonParams.DebugFlag) {
+	if viper.GetBool(commonParams.DebugFlag) || viper.GetString(commonParams.LogFileFlag) != "" || viper.GetString(commonParams.LogFileConsoleFlag) != "" {
 		trace := &httptrace.ClientTrace{
 			GetConn: func(hostPort string) {
 				startTime = time.Now().UnixNano() / int64(time.Millisecond)

test/integration/root_test.go

@@ -12,6 +12,7 @@ import (
 	commonParams "github.com/checkmarx/ast-cli/internal/params"
 	"github.com/checkmarx/ast-cli/internal/wrappers"
 	"github.com/spf13/viper"
+	"gotest.tools/assert"
 )
 
 const (
@@ -123,3 +124,50 @@ func isFFEnabled(t *testing.T, featureFlag string) bool {
 	flagResponse, _ := wrappers.GetSpecificFeatureFlag(featureFlagsWrapper, featureFlag)
 	return flagResponse.Status
 }
+
+func TestSetLogOutputFromFlag_InvalidDir(t *testing.T) {
+	err, _ := executeCommand(t, "auth", "validate", "--log-file", "/custom/path")
+	assert.ErrorContains(t, err, "the specified directory path does not exist.")
+}
+
+func TestSetLogOutputFromFlag_EmptyDirPath(t *testing.T) {
+	err, _ := executeCommand(t, "auth", "validate", "--log-file", "")
+	assert.ErrorContains(t, err, "flag needs an argument")
+}
+
+func TestSetLogOutputFromFlag_DirPathIsFilePath(t *testing.T) {
+	tempFile, _ := os.CreateTemp("", "ast-cli.txt")
+	defer func(path string) {
+		_ = os.Remove(path)
+	}(tempFile.Name())
+	err, _ := executeCommand(t, "auth", "validate", "--log-file", tempFile.Name())
+	assert.ErrorContains(t, err, "expected a directory path but got a file")
+}
+
+func TestSetLogOutputFromFlag_DirPathPermissionDenied(t *testing.T) {
+	tempDir, _ := os.MkdirTemp("", "tempdir")
+	_ = os.Chmod(tempDir, 0000)
+	defer func(path string) {
+		_ = os.RemoveAll(path)
+	}(tempDir)
+	err, _ := executeCommand(t, "auth", "validate", "--log-file", tempDir)
+	assert.ErrorContains(t, err, "permission denied: cannot write to directory")
+}
+
+func TestSetLogOutputFromFlag_DirPath_Success(t *testing.T) {
+	tempDir, _ := os.MkdirTemp("", "tempdir")
+	defer func(path string) {
+		_ = os.RemoveAll(path)
+	}(tempDir)
+	err, _ := executeCommand(t, "auth", "validate", "--log-file", tempDir)
+	assert.NilError(t, err)
+}
+
+func TestSetLogOutputFromFlag_DirPath_Console_Success(t *testing.T) {
+	tempDir, _ := os.MkdirTemp("", "tempdir")
+	defer func(path string) {
+		_ = os.RemoveAll(path)
+	}(tempDir)
+	err, _ := executeCommand(t, "auth", "validate", "--log-file-console", tempDir)
+	assert.NilError(t, err)
+}