telemetry: start tracking flags usage

pkg/odo/genericclioptions/runnable.go

@@ -94,6 +94,7 @@ func GenericRun(o Runnable, cmd *cobra.Command, args []string) {
 		klog.V(4).Infof("WARNING: debug telemetry, if enabled, will be logged in %s", debugTelemetry)
 	}
 
+	scontext.SetFlags(cmd.Context(), cmd.Flags())
 	// set value for telemetry status in context so that we do not need to call IsTelemetryEnabled every time to check its status
 	scontext.SetTelemetryStatus(cmd.Context(), segment.IsTelemetryEnabled(cfg))
 

pkg/segment/context/context.go

@@ -4,9 +4,11 @@ import (
 	"context"
 	"fmt"
 	"os"
+	"strings"
 	"sync"
 
 	"github.com/redhat-developer/odo/pkg/kclient"
+	"github.com/spf13/pflag"
 
 	dfutil "github.com/devfile/library/pkg/util"
 
@@ -22,6 +24,7 @@ const (
 	ProjectType     = "projectType"
 	NOTFOUND        = "not-found"
 	InteractiveMode = "interactive"
+	Flags           = "flags"
 )
 
 type contextKey struct{}
@@ -111,6 +114,22 @@ func SetInteractive(ctx context.Context, interactive bool) {
 	setContextProperty(ctx, InteractiveMode, interactive)
 }
 
+// SetFlags sets flags property for telemetry to record what flags were used
+func SetFlags(ctx context.Context, flags *pflag.FlagSet) {
+	var changedFlags []string
+	flags.VisitAll(func(f *pflag.Flag) {
+		if f.Changed {
+			if f.Name == "logtostderr" {
+				// skip "logtostderr" flag, for some reason it is showing as changed even when it is not
+				return
+			}
+			changedFlags = append(changedFlags, f.Name)
+		}
+	})
+	// the flags can't have spaces, so the output is space separated list of the flag names
+	setContextProperty(ctx, Flags, strings.Join(changedFlags, " "))
+}
+
 // GetTelemetryStatus gets the telemetry status that is set before a command is run
 func GetTelemetryStatus(ctx context.Context) bool {
 	isEnabled, ok := GetContextProperties(ctx)[TelemetryStatus]

pkg/segment/context/context_test.go

@@ -4,6 +4,8 @@ import (
 	"context"
 	"reflect"
 	"testing"
+
+	"github.com/spf13/pflag"
 )
 
 func TestGetContextProperties(t *testing.T) {
@@ -123,3 +125,79 @@ func TestSetTelemetryStatus(t *testing.T) {
 //	}
 //	fakeClient.SetDiscoveryInterface(fd)
 //}
+
+func TestSetFlags(t *testing.T) {
+	type args struct {
+		ctx   context.Context
+		flags *pflag.FlagSet
+	}
+	tests := []struct {
+		name string
+		args args
+		want string
+	}{
+		{
+			name: "no flags",
+			args: args{
+				ctx:   NewContext(context.Background()),
+				flags: &pflag.FlagSet{},
+			},
+			want: "",
+		},
+		{
+			name: "one changed flag",
+			args: args{
+				ctx: NewContext(context.Background()),
+				flags: func() *pflag.FlagSet {
+					f := &pflag.FlagSet{}
+					f.String("flag1", "", "")
+					//nolint:errcheck
+					f.Set("flag1", "value1")
+					return f
+				}(),
+			},
+			want: "flag1",
+		},
+		{
+			name: "one changed flag, one unchanged flag",
+			args: args{
+				ctx: NewContext(context.Background()),
+				flags: func() *pflag.FlagSet {
+					f := &pflag.FlagSet{}
+					f.String("flag1", "", "")
+					f.String("flag2", "", "")
+					//nolint:errcheck
+					f.Set("flag2", "value1")
+					return f
+				}(),
+			},
+			want: "flag2",
+		},
+		{
+			name: "two changed flags",
+			args: args{
+				ctx: NewContext(context.Background()),
+				flags: func() *pflag.FlagSet {
+					f := &pflag.FlagSet{}
+					f.String("flag1", "", "")
+					f.String("flag2", "", "")
+					//nolint:errcheck
+					f.Set("flag1", "value1")
+					//nolint:errcheck
+					f.Set("flag2", "value1")
+					return f
+				}(),
+			},
+			want: "flag1 flag2",
+		},
+	}
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			SetFlags(tt.args.ctx, tt.args.flags)
+			got := GetContextProperties(tt.args.ctx)[Flags]
+			if got != tt.want {
+				t.Errorf("SetFlags() = %v, want %v", got, tt.want)
+			}
+		})
+	}
+}

tests/integration/cmd_devfile_deploy_test.go

@@ -207,6 +207,8 @@ ComponentSettings:
 			Expect(td.Properties.CmdProperties[segment.ComponentType]).To(ContainSubstring("nodejs"))
 			Expect(td.Properties.CmdProperties[segment.Language]).To(ContainSubstring("javascript"))
 			Expect(td.Properties.CmdProperties[segment.ProjectType]).To(ContainSubstring("nodejs"))
+			Expect(td.Properties.CmdProperties[segment.Flags]).To(BeEmpty())
+
 		})
 	})
 

tests/integration/cmd_devfile_init_test.go

@@ -362,6 +362,8 @@ var _ = Describe("odo devfile init command tests", func() {
 			Expect(td.Properties.CmdProperties[segment.ComponentType]).To(ContainSubstring("Go"))
 			Expect(td.Properties.CmdProperties[segment.Language]).To(ContainSubstring("Go"))
 			Expect(td.Properties.CmdProperties[segment.ProjectType]).To(ContainSubstring("Go"))
+			Expect(td.Properties.CmdProperties[segment.Flags]).To(ContainSubstring("devfile name"))
+
 		})
 	})
 })