|
| 1 | +package cmd |
| 2 | + |
| 3 | +import ( |
| 4 | + "testing" |
| 5 | + |
| 6 | + "github.com/spf13/cobra" |
| 7 | + "github.com/stretchr/testify/assert" |
| 8 | + "github.com/stretchr/testify/require" |
| 9 | + |
| 10 | + "github.com/hookdeck/hookdeck-cli/pkg/hookdeck" |
| 11 | +) |
| 12 | + |
| 13 | +// parseRuleFlags binds the rule flags to a throwaway command and parses args, |
| 14 | +// so flag values are set the same way cobra sets them at runtime. |
| 15 | +func parseRuleFlags(t *testing.T, args []string) *connectionRuleFlags { |
| 16 | + t.Helper() |
| 17 | + f := &connectionRuleFlags{} |
| 18 | + cmd := &cobra.Command{Use: "test"} |
| 19 | + addConnectionRuleFlags(cmd, f) |
| 20 | + require.NoError(t, cmd.ParseFlags(args)) |
| 21 | + return f |
| 22 | +} |
| 23 | + |
| 24 | +func ruleTypes(rules []hookdeck.Rule) []string { |
| 25 | + types := make([]string, 0, len(rules)) |
| 26 | + for _, r := range rules { |
| 27 | + types = append(types, r["type"].(string)) |
| 28 | + } |
| 29 | + return types |
| 30 | +} |
| 31 | + |
| 32 | +// TestBuildConnectionRulesFollowsFlagOrder verifies that rules built from |
| 33 | +// --rule-<type>-* flags follow the position of the first flag for each type. |
| 34 | +// Filter, transform and deduplicate run in rules array order, so a fixed |
| 35 | +// order made filter-before-transform impossible to express with flags. |
| 36 | +func TestBuildConnectionRulesFollowsFlagOrder(t *testing.T) { |
| 37 | + tests := []struct { |
| 38 | + name string |
| 39 | + args []string |
| 40 | + want []string |
| 41 | + }{ |
| 42 | + { |
| 43 | + name: "filter before transform", |
| 44 | + args: []string{"--rule-filter-body", `{"type":"order"}`, "--rule-transform-name", "tx1"}, |
| 45 | + want: []string{"filter", "transform"}, |
| 46 | + }, |
| 47 | + { |
| 48 | + name: "transform before filter", |
| 49 | + args: []string{"--rule-transform-name", "tx1", "--rule-filter-body", `{"type":"order"}`}, |
| 50 | + want: []string{"transform", "filter"}, |
| 51 | + }, |
| 52 | + { |
| 53 | + name: "first flag of a type sets its position", |
| 54 | + args: []string{ |
| 55 | + "--rule-filter-body", `{"type":"order"}`, |
| 56 | + "--rule-transform-name", "tx1", |
| 57 | + "--rule-filter-headers", `{"x-topic":"orders/create"}`, |
| 58 | + }, |
| 59 | + want: []string{"filter", "transform"}, |
| 60 | + }, |
| 61 | + { |
| 62 | + name: "all five types in flag order", |
| 63 | + args: []string{ |
| 64 | + "--rule-retry-strategy", "exponential", |
| 65 | + "--rule-filter-body", `{"type":"order"}`, |
| 66 | + "--rule-delay", "1000", |
| 67 | + "--rule-transform-name", "tx1", |
| 68 | + "--rule-deduplicate-window", "60", |
| 69 | + }, |
| 70 | + want: []string{"retry", "filter", "delay", "transform", "deduplicate"}, |
| 71 | + }, |
| 72 | + { |
| 73 | + name: "retry position set by a non-strategy retry flag", |
| 74 | + args: []string{"--rule-retry-count", "3", "--rule-filter-body", `{"type":"order"}`, "--rule-retry-strategy", "linear"}, |
| 75 | + want: []string{"retry", "filter"}, |
| 76 | + }, |
| 77 | + } |
| 78 | + for _, tt := range tests { |
| 79 | + t.Run(tt.name, func(t *testing.T) { |
| 80 | + rules, err := buildConnectionRules(parseRuleFlags(t, tt.args)) |
| 81 | + require.NoError(t, err) |
| 82 | + assert.Equal(t, tt.want, ruleTypes(rules)) |
| 83 | + }) |
| 84 | + } |
| 85 | +} |
| 86 | + |
| 87 | +// TestBuildConnectionRulesDefaultOrderWithoutFlags verifies the fallback order |
| 88 | +// when connectionRuleFlags is populated directly rather than parsed from flags. |
| 89 | +func TestBuildConnectionRulesDefaultOrderWithoutFlags(t *testing.T) { |
| 90 | + flags := connectionRuleFlags{ |
| 91 | + RuleRetryStrategy: "linear", |
| 92 | + RuleFilterBody: `{"type":"order"}`, |
| 93 | + RuleTransformName: "tx1", |
| 94 | + RuleDelay: 1000, |
| 95 | + RuleDeduplicateWindow: 60, |
| 96 | + } |
| 97 | + rules, err := buildConnectionRules(&flags) |
| 98 | + require.NoError(t, err) |
| 99 | + assert.Equal(t, []string{"deduplicate", "transform", "filter", "delay", "retry"}, ruleTypes(rules)) |
| 100 | +} |
| 101 | + |
| 102 | +// TestConnectionCommandsRuleFlagOrder verifies that create, update and upsert |
| 103 | +// all record rule flag order through their own flag sets. |
| 104 | +func TestConnectionCommandsRuleFlagOrder(t *testing.T) { |
| 105 | + args := []string{"--rule-filter-body", `{"type":"order"}`, "--rule-transform-name", "tx1"} |
| 106 | + |
| 107 | + create := newConnectionCreateCmd() |
| 108 | + require.NoError(t, create.cmd.ParseFlags(args)) |
| 109 | + rules, err := buildConnectionRules(&create.connectionRuleFlags) |
| 110 | + require.NoError(t, err) |
| 111 | + assert.Equal(t, []string{"filter", "transform"}, ruleTypes(rules), "create") |
| 112 | + |
| 113 | + update := newConnectionUpdateCmd() |
| 114 | + require.NoError(t, update.cmd.ParseFlags(args)) |
| 115 | + rules, err = buildConnectionRules(&update.connectionRuleFlags) |
| 116 | + require.NoError(t, err) |
| 117 | + assert.Equal(t, []string{"filter", "transform"}, ruleTypes(rules), "update") |
| 118 | + |
| 119 | + upsert := newConnectionUpsertCmd() |
| 120 | + require.NoError(t, upsert.cmd.ParseFlags(args)) |
| 121 | + rules, err = buildConnectionRules(&upsert.connectionCreateCmd.connectionRuleFlags) |
| 122 | + require.NoError(t, err) |
| 123 | + assert.Equal(t, []string{"filter", "transform"}, ruleTypes(rules), "upsert") |
| 124 | +} |
0 commit comments