Merge branch 'main' into miryamFoifer/containersRTScanCommand

Author: cx-miryam-foifer

cmd/main.go

@@ -95,6 +95,7 @@ func main() {
 	byorWrapper := wrappers.NewByorHTTPWrapper(byorPath)
 	containerResolverWrapper := wrappers.NewContainerResolverWrapper()
 	realTimeWrapper := wrappers.NewRealtimeScannerHTTPWrapper(realtimeScannerPath, jwtWrapper, featureFlagsWrapper)
+	telemetryWrapper := wrappers.NewHTTPTelemetryAIWrapper(realtimeScannerPath)
 
 	astCli := commands.NewAstCLI(
 		applicationsWrapper,
@@ -133,6 +134,7 @@ func main() {
 		byorWrapper,
 		containerResolverWrapper,
 		realTimeWrapper,
+		telemetryWrapper,
 	)
 	exitListener()
 	err = astCli.Execute()

internal/commands/root.go

@@ -60,6 +60,7 @@ func NewAstCLI(
 	byorWrapper wrappers.ByorWrapper,
 	containerResolverWrapper wrappers.ContainerResolverWrapper,
 	realTimeWrapper wrappers.RealtimeScannerWrapper,
+	telemetryWrapper wrappers.TelemetryWrapper,
 ) *cobra.Command {
 	// Create the root
 	rootCmd := &cobra.Command{
@@ -224,7 +225,7 @@ func NewAstCLI(
 
 	chatCmd := NewChatCommand(chatWrapper, tenantWrapper)
 	hooksCmd := NewHooksCommand(jwtWrapper)
-
+	telemetryCmd := NewTelemetryCommand(telemetryWrapper)
 	rootCmd.AddCommand(
 		scanCmd,
 		projectCmd,
@@ -236,6 +237,7 @@ func NewAstCLI(
 		configCmd,
 		chatCmd,
 		hooksCmd,
+		telemetryCmd,
 	)
 
 	rootCmd.SilenceUsage = true

internal/commands/root_test.go

@@ -72,6 +72,7 @@ func createASTTestCommand() *cobra.Command {
 	containerResolverMockWrapper := &mock.ContainerResolverMockWrapper{}
 	customStatesMockWrapper := &mock.CustomStatesMockWrapper{}
 	realTimeWrapper := &mock.RealtimeScannerMockWrapper{}
+	telemetryWrapper := &mock.TelemetryMockWrapper{}
 	return NewAstCLI(
 		applicationWrapper,
 		scansMockWrapper,
@@ -109,6 +110,7 @@ func createASTTestCommand() *cobra.Command {
 		byorWrapper,
 		containerResolverMockWrapper,
 		realTimeWrapper,
+		telemetryWrapper,
 	)
 }
 

internal/commands/telemetry.go

@@ -0,0 +1,71 @@
+package commands
+
+import (
+	"github.com/MakeNowJust/heredoc"
+	"github.com/checkmarx/ast-cli/internal/params"
+	"github.com/checkmarx/ast-cli/internal/wrappers"
+	"github.com/pkg/errors"
+	"github.com/spf13/cobra"
+)
+
+func NewTelemetryCommand(telemetryWrapper wrappers.TelemetryWrapper) *cobra.Command {
+	telemetryCmd := &cobra.Command{
+		Use:   "telemetry",
+		Short: "Telemetry user events",
+		Long:  "The 'telemetry' command allows collecting and sending user interaction events for analysis purposes.",
+	}
+	telemetryAICmd := telemetryAISubCommand(telemetryWrapper)
+
+	telemetryCmd.AddCommand(telemetryAICmd)
+	return telemetryCmd
+}
+
+func telemetryAISubCommand(telemetryAIWrapper wrappers.TelemetryWrapper) *cobra.Command {
+	telemetryAICmd := &cobra.Command{
+		Use:   "ai",
+		Short: "telemetry for user events related to AI functionality.",
+		Long:  "Collects telemetry data for user interactions related to AI features.",
+		Example: heredoc.Doc(
+			`
+			$ cx telemetry ai --ai-provider <AI Provider> --problem-severity <Problem Severity> --type<Event Type> --sub-type<Event Name> --agent <Agent> --engine <Engine>
+		`,
+		),
+
+		RunE: runTelemetryAI(telemetryAIWrapper),
+	}
+
+	telemetryAICmd.PersistentFlags().String(params.AiProviderFlag, "", "AI Provider")
+	telemetryAICmd.PersistentFlags().String(params.ProblemSeverityFlag, "", "Problem Severity")
+	telemetryAICmd.PersistentFlags().String(params.TypeFlag, "", "Type")
+	telemetryAICmd.PersistentFlags().String(params.SubTypeFlag, "", "Sub Type")
+	telemetryAICmd.PersistentFlags().String(params.EngineFlag, "", "Engine")
+	telemetryAICmd.PersistentFlags().String(params.AgentFlag, "", "Agent")
+
+	return telemetryAICmd
+}
+
+func runTelemetryAI(telemetryWrapper wrappers.TelemetryWrapper) func(*cobra.Command, []string) error {
+	return func(cmd *cobra.Command, _ []string) error {
+		aiProvider, _ := cmd.Flags().GetString("ai-provider")
+		problemSeverity, _ := cmd.Flags().GetString("problem-severity")
+		eventType, _ := cmd.Flags().GetString("type")
+		subType, _ := cmd.Flags().GetString("sub-type")
+		agent, _ := cmd.Flags().GetString("agent")
+		engine, _ := cmd.Flags().GetString("engine")
+
+		err := telemetryWrapper.SendAIDataToLog(&wrappers.DataForAITelemetry{
+			AIProvider:      aiProvider,
+			ProblemSeverity: problemSeverity,
+			Type:            eventType,
+			SubType:         subType,
+			Agent:           agent,
+			Engine:          engine,
+		})
+
+		if err != nil {
+			return errors.Wrapf(err, "%s", "Failed logging the data")
+		}
+
+		return nil
+	}
+}

internal/commands/telemetry_test.go

@@ -0,0 +1,19 @@
+package commands
+
+import (
+	"testing"
+
+	"github.com/checkmarx/ast-cli/internal/wrappers"
+	"github.com/checkmarx/ast-cli/internal/wrappers/mock"
+)
+
+func TestRunTelemetryAI_SendToLogSuccess(t *testing.T) {
+	mock.Flag = wrappers.FeatureFlagResponseModel{Name: wrappers.OssRealtimeEnabled, Status: true}
+	execCmdNilAssertion(
+		t,
+		"telemetry", "ai", "--ai-provider", "Cursor", "--problem-severity", "Critical", "--type", "click", "--sub-type", "ast-results.viewPackageDetails", "--agent", "Cursor", "--engine", "secrets")
+}
+
+func TestTelemetryHelp(t *testing.T) {
+	execCmdNilAssertion(t, "help", "telemetry", "ai")
+}

internal/params/flags.go

@@ -4,6 +4,11 @@ package params
 const (
 	AllStatesFlag                  = "all"
 	AgentFlag                      = "agent"
+	AiProviderFlag                 = "ai-provider"
+	ProblemSeverityFlag            = "problem-severity"
+	TypeFlag                       = "type"
+	SubTypeFlag                    = "sub-type"
+	EngineFlag                     = "engine"
 	OriginFlag                     = "origin"
 	AgentFlagUsage                 = "Scan origin name"
 	ApplicationName                = "application-name"

internal/wrappers/mock/telemetry-mock.go

@@ -0,0 +1,10 @@
+package mock
+
+import "github.com/checkmarx/ast-cli/internal/wrappers"
+
+type TelemetryMockWrapper struct {
+}
+
+func (t TelemetryMockWrapper) SendAIDataToLog(data *wrappers.DataForAITelemetry) error {
+	return nil
+}

internal/wrappers/telemetry-http.go

@@ -0,0 +1,50 @@
+package wrappers
+
+import (
+	"bytes"
+	"encoding/json"
+	"fmt"
+	"net/http"
+
+	commonParams "github.com/checkmarx/ast-cli/internal/params"
+	"github.com/pkg/errors"
+	"github.com/spf13/viper"
+)
+
+type TelemetryHTTPWrapper struct {
+	path string
+}
+
+func NewHTTPTelemetryAIWrapper(path string) *TelemetryHTTPWrapper {
+	return &TelemetryHTTPWrapper{
+		path: path,
+	}
+}
+
+func (r *TelemetryHTTPWrapper) SendAIDataToLog(data *DataForAITelemetry) error {
+	clientTimeout := viper.GetUint(commonParams.ClientTimeoutKey)
+	jsonBytes, err := json.Marshal(data)
+	if err != nil {
+		return err
+	}
+
+	fn := func() (*http.Response, error) {
+		return SendHTTPRequest(http.MethodPost, fmt.Sprint(r.path, "/log"), bytes.NewBuffer(jsonBytes), true, clientTimeout)
+	}
+	resp, err := retryHTTPRequest(fn, retryAttempts, retryDelay)
+	if err != nil {
+		return err
+	}
+	defer func() {
+		if err == nil {
+			_ = resp.Body.Close()
+		}
+	}()
+	switch resp.StatusCode {
+	case http.StatusBadRequest, http.StatusInternalServerError:
+		return errors.Errorf("Failed to log the data, status code: %s", resp.Status)
+	case http.StatusNotFound:
+		return errors.Errorf("Telemetry AI endpoint not found")
+	}
+	return nil
+}

internal/wrappers/telemetry.go

@@ -0,0 +1,14 @@
+package wrappers
+
+type DataForAITelemetry struct {
+	AIProvider      string `json:"aiProvider"`
+	ProblemSeverity string `json:"problemSeverity"`
+	Type            string `json:"type"`
+	SubType         string `json:"subType"`
+	Agent           string `json:"agent"`
+	Engine          string `json:"engine"`
+}
+
+type TelemetryWrapper interface {
+	SendAIDataToLog(data *DataForAITelemetry) error
+}

test/integration/telemetry_test.go

@@ -0,0 +1,26 @@
+//go:build integration
+
+package integration
+
+import (
+	"github.com/checkmarx/ast-cli/internal/params"
+	"github.com/stretchr/testify/assert"
+	"testing"
+)
+
+func TestTelemetryAI(t *testing.T) {
+	t.Skip()
+	bindKeysToEnvAndDefault(t)
+	args := []string{
+		"telemetry", "ai",
+		flag(params.AiProviderFlag), "Cursor",
+		flag(params.ProblemSeverityFlag), "Critical",
+		flag(params.TypeFlag), "click",
+		flag(params.SubTypeFlag), "ast-results.viewPackageDetails",
+		flag(params.AgentFlag), "Cursor",
+		flag(params.EngineFlag), "secrets",
+	}
+
+	err, _ := executeCommand(t, args...)
+	assert.Nil(t, err)
+}