Function TestRecordTelemetryForSubcommands

pkg/cmdutil/telemetry_test.go:119–168

(t *testing.T)

}

func TestRecordTelemetryForSubcommands(t *testing.T) {
	t.Run("instruments nested subcommands", func(t *testing.T) {
		recorder := &telemetry.EventRecorderSpy{}

		root := &cobra.Command{Use: "gh"}
		parent := &cobra.Command{Use: "pr"}
		child := &cobra.Command{
			Use:  "list",
			RunE: func(cmd *cobra.Command, args []string) error { return nil },
		}
		root.AddCommand(parent)
		parent.AddCommand(child)

		cmdutil.RecordTelemetryForSubcommands(root, recorder)
		require.NoError(t, child.RunE(child, nil))

		require.Len(t, recorder.Events, 1)
		assert.Equal(t, "command_invocation", recorder.Events[0].Type)
		assert.Equal(t, "gh pr list", recorder.Events[0].Dimensions["command"])
	})

	t.Run("skips subcommands with nil RunE", func(t *testing.T) {
		recorder := &telemetry.EventRecorderSpy{}

		root := &cobra.Command{Use: "gh"}
		child := &cobra.Command{Use: "help"} // no RunE
		root.AddCommand(child)

		cmdutil.RecordTelemetryForSubcommands(root, recorder)

		assert.Nil(t, child.RunE, "nil RunE should remain nil")
	})

	t.Run("skips subcommands with telemetry disabled", func(t *testing.T) {
		recorder := &telemetry.EventRecorderSpy{}

		root := &cobra.Command{Use: "gh"}
		child := &cobra.Command{
			Use:  "send-telemetry",
			RunE: func(cmd *cobra.Command, args []string) error { return nil },
		}
		cmdutil.DisableTelemetry(child)
		root.AddCommand(child)

		cmdutil.RecordTelemetryForSubcommands(root, recorder)
		require.NoError(t, child.RunE(child, nil))

		assert.Empty(t, recorder.Events, "disabled commands should not record telemetry")
	})
}