Function TestRecordTelemetry

pkg/cmdutil/telemetry_test.go:16–236

(t *testing.T)

)

func TestRecordTelemetry(t *testing.T) {
	t.Run("records commands that fail argument validation", func(t *testing.T) {
		t.Parallel()

		// Given a command that requires a positional argument
		recorder := &telemetry.EventRecorderSpy{}
		cmd := &cobra.Command{
			Use:           "list",
			Args:          cobra.ExactArgs(1),
			SilenceErrors: true,
			SilenceUsage:  true,
			RunE:          func(cmd *cobra.Command, args []string) error { return nil },
		}
		cmd.Flags().Bool("web", false, "")
		cmd.SetArgs([]string{"--web"})
		cmdutil.RecordTelemetry(cmd, recorder)

		// When Cobra rejects its arguments
		_, err := cmd.ExecuteC()

		// Then the failure is preserved and the command is still recorded
		require.EqualError(t, err, "accepts 1 arg(s), received 0")
		events := recorder.Events()
		require.Len(t, events, 1)
		assert.Equal(t, "command_invocation", events[0].Type)
		assert.Equal(t, "list", events[0].Dimensions["command"])
		assert.Equal(t, "web", events[0].Dimensions["flags"])
	})

	tests := []struct {
		name  string
		args  []string
		flags string
	}{
		{
			name:  "records sorted flag names without argument or flag values",
			args:  []string{"--web", "--repo", "private/repository", "private argument"},
			flags: "repo,web",
		},
		{
			name:  "accepts positional arguments with nil Args and records empty flags",
			args:  []string{"private argument"},
			flags: "",
		},
	}
	for _, tt := range tests {
		t.Run(tt.name, func(t *testing.T) {
			t.Parallel()

			// Given a command without argument validation
			recorder := &telemetry.EventRecorderSpy{}
			cmd := &cobra.Command{
				Use:  "list",
				RunE: func(cmd *cobra.Command, args []string) error { return nil },
			}
			cmd.Flags().Bool("web", false, "")
			cmd.Flags().String("repo", "", "")
			cmd.Flags().Bool("unused", false, "")