-
-
Notifications
You must be signed in to change notification settings - Fork 153
Expand file tree
/
Copy pathregistry_test.go
More file actions
1000 lines (809 loc) · 27.7 KB
/
registry_test.go
File metadata and controls
1000 lines (809 loc) · 27.7 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
package internal
import (
"errors"
"fmt"
"testing"
"github.com/spf13/cobra"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
errUtils "github.com/cloudposse/atmos/errors"
"github.com/cloudposse/atmos/pkg/flags"
"github.com/cloudposse/atmos/pkg/flags/compat"
)
// mockCommandProvider is a test implementation of CommandProvider.
type mockCommandProvider struct {
name string
group string
cmd *cobra.Command
aliases []CommandAlias
}
func (m *mockCommandProvider) GetCommand() *cobra.Command {
return m.cmd
}
func (m *mockCommandProvider) GetName() string {
return m.name
}
func (m *mockCommandProvider) GetGroup() string {
return m.group
}
func (m *mockCommandProvider) GetFlagsBuilder() flags.Builder {
return nil
}
func (m *mockCommandProvider) GetPositionalArgsBuilder() *flags.PositionalArgsBuilder {
return nil
}
func (m *mockCommandProvider) GetCompatibilityFlags() map[string]compat.CompatibilityFlag {
return nil
}
func (m *mockCommandProvider) GetAliases() []CommandAlias {
return m.aliases
}
func (m *mockCommandProvider) IsExperimental() bool {
return false
}
func TestRegister(t *testing.T) {
Reset() // Clear registry for clean test
provider := &mockCommandProvider{
name: "test",
group: "Test Commands",
cmd: &cobra.Command{Use: "test"},
}
Register(provider)
assert.Equal(t, 1, Count())
retrieved, ok := GetProvider("test")
assert.True(t, ok)
assert.Equal(t, provider, retrieved)
}
func TestRegisterMultiple(t *testing.T) {
Reset()
provider1 := &mockCommandProvider{
name: "test1",
group: "Group A",
cmd: &cobra.Command{Use: "test1"},
}
provider2 := &mockCommandProvider{
name: "test2",
group: "Group B",
cmd: &cobra.Command{Use: "test2"},
}
Register(provider1)
Register(provider2)
assert.Equal(t, 2, Count())
retrieved1, ok1 := GetProvider("test1")
assert.True(t, ok1)
assert.Equal(t, provider1, retrieved1)
retrieved2, ok2 := GetProvider("test2")
assert.True(t, ok2)
assert.Equal(t, provider2, retrieved2)
}
func TestRegisterOverride(t *testing.T) {
Reset()
provider1 := &mockCommandProvider{
name: "test",
group: "Test",
cmd: &cobra.Command{Use: "test", Short: "First"},
}
provider2 := &mockCommandProvider{
name: "test",
group: "Test",
cmd: &cobra.Command{Use: "test", Short: "Second"},
}
Register(provider1)
Register(provider2)
// Should only have one provider (override)
assert.Equal(t, 1, Count())
// Should retrieve the second provider
retrieved, ok := GetProvider("test")
assert.True(t, ok)
assert.Equal(t, "Second", retrieved.GetCommand().Short)
}
func TestRegisterAll(t *testing.T) {
Reset()
rootCmd := &cobra.Command{Use: "root"}
provider1 := &mockCommandProvider{
name: "test1",
group: "Test",
cmd: &cobra.Command{Use: "test1"},
}
provider2 := &mockCommandProvider{
name: "test2",
group: "Test",
cmd: &cobra.Command{Use: "test2"},
}
Register(provider1)
Register(provider2)
err := RegisterAll(rootCmd)
require.NoError(t, err)
// Root command should have both subcommands
assert.True(t, rootCmd.HasSubCommands())
assert.Len(t, rootCmd.Commands(), 2)
// Verify commands are accessible
cmd1, _, err1 := rootCmd.Find([]string{"test1"})
assert.NoError(t, err1)
assert.Equal(t, "test1", cmd1.Use)
cmd2, _, err2 := rootCmd.Find([]string{"test2"})
assert.NoError(t, err2)
assert.Equal(t, "test2", cmd2.Use)
}
func TestRegisterAllNilCommand(t *testing.T) {
Reset()
rootCmd := &cobra.Command{Use: "root"}
provider := &mockCommandProvider{
name: "test",
group: "Test",
cmd: nil, // Nil command should cause error
}
Register(provider)
err := RegisterAll(rootCmd)
assert.Error(t, err)
assert.True(t, errors.Is(err, errUtils.ErrCommandNil), "error should wrap ErrCommandNil")
assert.Contains(t, err.Error(), "test", "error message should include provider name")
}
func TestGetProviderNotFound(t *testing.T) {
Reset()
provider, ok := GetProvider("nonexistent")
assert.False(t, ok)
assert.Nil(t, provider)
}
func TestListProviders(t *testing.T) {
Reset()
provider1 := &mockCommandProvider{
name: "test1",
group: "Group A",
cmd: &cobra.Command{Use: "test1"},
}
provider2 := &mockCommandProvider{
name: "test2",
group: "Group A",
cmd: &cobra.Command{Use: "test2"},
}
provider3 := &mockCommandProvider{
name: "test3",
group: "Group B",
cmd: &cobra.Command{Use: "test3"},
}
Register(provider1)
Register(provider2)
Register(provider3)
grouped := ListProviders()
assert.Len(t, grouped, 2)
assert.Len(t, grouped["Group A"], 2)
assert.Len(t, grouped["Group B"], 1)
// Verify providers are in correct groups
groupA := grouped["Group A"]
assert.Contains(t, []CommandProvider{provider1, provider2}, groupA[0])
assert.Contains(t, []CommandProvider{provider1, provider2}, groupA[1])
groupB := grouped["Group B"]
assert.Equal(t, provider3, groupB[0])
}
func TestNestedCommands(t *testing.T) {
Reset()
// Create parent command with subcommands
parentCmd := &cobra.Command{Use: "parent"}
childCmd1 := &cobra.Command{Use: "child1"}
childCmd2 := &cobra.Command{Use: "child2"}
parentCmd.AddCommand(childCmd1)
parentCmd.AddCommand(childCmd2)
provider := &mockCommandProvider{
name: "parent",
group: "Test",
cmd: parentCmd,
}
Register(provider)
// Verify parent is registered
retrieved, ok := GetProvider("parent")
assert.True(t, ok)
assert.True(t, retrieved.GetCommand().HasSubCommands())
// Verify children are accessible
subCmd1, _, err1 := retrieved.GetCommand().Find([]string{"child1"})
assert.NoError(t, err1)
assert.Equal(t, "child1", subCmd1.Use)
subCmd2, _, err2 := retrieved.GetCommand().Find([]string{"child2"})
assert.NoError(t, err2)
assert.Equal(t, "child2", subCmd2.Use)
}
func TestDeeplyNestedCommands(t *testing.T) {
Reset()
// Create deeply nested command hierarchy
grandparentCmd := &cobra.Command{Use: "grandparent"}
parentCmd := &cobra.Command{Use: "parent"}
childCmd := &cobra.Command{Use: "child"}
parentCmd.AddCommand(childCmd)
grandparentCmd.AddCommand(parentCmd)
provider := &mockCommandProvider{
name: "grandparent",
group: "Test",
cmd: grandparentCmd,
}
Register(provider)
// Verify grandparent is registered
retrieved, ok := GetProvider("grandparent")
assert.True(t, ok)
// Verify deeply nested child is accessible
subCmd, _, err := retrieved.GetCommand().Find([]string{"parent", "child"})
assert.NoError(t, err)
assert.Equal(t, "child", subCmd.Use)
}
func TestCount(t *testing.T) {
Reset()
assert.Equal(t, 0, Count())
Register(&mockCommandProvider{name: "test1", group: "Test", cmd: &cobra.Command{Use: "test1"}})
assert.Equal(t, 1, Count())
Register(&mockCommandProvider{name: "test2", group: "Test", cmd: &cobra.Command{Use: "test2"}})
assert.Equal(t, 2, Count())
Register(&mockCommandProvider{name: "test1", group: "Test", cmd: &cobra.Command{Use: "test1"}})
assert.Equal(t, 2, Count()) // Override doesn't increase count
}
func TestReset(t *testing.T) {
Reset()
Register(&mockCommandProvider{name: "test", group: "Test", cmd: &cobra.Command{Use: "test"}})
assert.Equal(t, 1, Count())
Reset()
assert.Equal(t, 0, Count())
_, ok := GetProvider("test")
assert.False(t, ok)
}
func TestConcurrency(t *testing.T) {
Reset()
// Test concurrent registration
done := make(chan bool)
for i := 0; i < 10; i++ {
go func(idx int) {
provider := &mockCommandProvider{
name: fmt.Sprintf("test%d", idx),
group: "Test",
cmd: &cobra.Command{Use: fmt.Sprintf("test%d", idx)},
}
Register(provider)
done <- true
}(i)
}
// Wait for all goroutines
for i := 0; i < 10; i++ {
<-done
}
assert.Equal(t, 10, Count())
}
func TestCustomCommandCanExtendRegistryCommand(t *testing.T) {
Reset()
// Simulate a registry command (e.g., "terraform")
registryCmd := &cobra.Command{
Use: "terraform",
Short: "Built-in terraform command",
}
provider := &mockCommandProvider{
name: "terraform",
group: "Core Stack Commands",
cmd: registryCmd,
}
Register(provider)
// Register with root
rootCmd := &cobra.Command{Use: "root"}
err := RegisterAll(rootCmd)
require.NoError(t, err)
// Verify command is registered
tfCmd, _, err := rootCmd.Find([]string{"terraform"})
require.NoError(t, err)
assert.Equal(t, "terraform", tfCmd.Use)
assert.False(t, tfCmd.HasSubCommands(), "should have no subcommands initially")
// Simulate custom command extending it by adding a subcommand
// This is what processCustomCommands() would do in cmd/cmd_utils.go
customSubCmd := &cobra.Command{
Use: "custom-plan",
Short: "Custom terraform plan with extra validation",
}
tfCmd.AddCommand(customSubCmd)
// Verify the registry command now has the custom subcommand
assert.True(t, tfCmd.HasSubCommands(), "should have subcommands after extension")
customCmd, _, err := tfCmd.Find([]string{"custom-plan"})
require.NoError(t, err)
assert.Equal(t, "custom-plan", customCmd.Use)
}
// resetCompatFlagsRegistry clears the compat flags registry for testing.
// This ensures tests start with a clean state.
func resetCompatFlagsRegistry() {
commandCompatFlagsRegistry.mu.Lock()
defer commandCompatFlagsRegistry.mu.Unlock()
commandCompatFlagsRegistry.flags = make(map[string]map[string]map[string]compat.CompatibilityFlag)
}
func TestRegisterCommandCompatFlags(t *testing.T) {
resetCompatFlagsRegistry()
// Register terraform global flags.
RegisterCommandCompatFlags("terraform", "terraform", map[string]compat.CompatibilityFlag{
"-chdir": {Behavior: compat.AppendToSeparated, Description: "Switch to a different working directory"},
"-help": {Behavior: compat.AppendToSeparated, Description: "Show terraform help output"},
"-version": {Behavior: compat.AppendToSeparated, Description: "Show terraform version"},
})
// Verify registration.
flags := GetSubcommandCompatFlags("terraform", "terraform")
require.NotNil(t, flags)
assert.Len(t, flags, 3)
assert.Contains(t, flags, "-chdir")
assert.Contains(t, flags, "-help")
assert.Contains(t, flags, "-version")
}
func TestRegisterCommandCompatFlags_MultipleSubcommands(t *testing.T) {
resetCompatFlagsRegistry()
// Register terraform global flags.
RegisterCommandCompatFlags("terraform", "terraform", map[string]compat.CompatibilityFlag{
"-chdir": {Behavior: compat.AppendToSeparated, Description: "Switch to a different working directory"},
"-help": {Behavior: compat.AppendToSeparated, Description: "Show terraform help output"},
"-version": {Behavior: compat.AppendToSeparated, Description: "Show terraform version"},
})
// Register plan-specific flags.
RegisterCommandCompatFlags("terraform", "plan", map[string]compat.CompatibilityFlag{
"-var": {Behavior: compat.AppendToSeparated, Description: "Set a value for one of the input variables"},
"-var-file": {Behavior: compat.AppendToSeparated, Description: "Load variable values from the given file"},
"-out": {Behavior: compat.AppendToSeparated, Description: "Write the plan to the given path"},
"-destroy": {Behavior: compat.AppendToSeparated, Description: "Create a plan to destroy all objects"},
"-detailed-exitcode": {Behavior: compat.AppendToSeparated, Description: "Return detailed exit codes"},
})
// Register apply-specific flags.
RegisterCommandCompatFlags("terraform", "apply", map[string]compat.CompatibilityFlag{
"-var": {Behavior: compat.AppendToSeparated, Description: "Set a value for one of the input variables"},
"-var-file": {Behavior: compat.AppendToSeparated, Description: "Load variable values from the given file"},
"-auto-approve": {Behavior: compat.AppendToSeparated, Description: "Skip interactive approval"},
"-backup": {Behavior: compat.AppendToSeparated, Description: "Path to backup the existing state file"},
})
// Verify terraform global flags.
globalFlags := GetSubcommandCompatFlags("terraform", "terraform")
require.NotNil(t, globalFlags)
assert.Len(t, globalFlags, 3)
assert.Contains(t, globalFlags, "-chdir")
assert.Contains(t, globalFlags, "-help")
assert.Contains(t, globalFlags, "-version")
assert.NotContains(t, globalFlags, "-var") // Should not have subcommand flags.
// Verify plan flags.
planFlags := GetSubcommandCompatFlags("terraform", "plan")
require.NotNil(t, planFlags)
assert.Len(t, planFlags, 5)
assert.Contains(t, planFlags, "-var")
assert.Contains(t, planFlags, "-var-file")
assert.Contains(t, planFlags, "-out")
assert.Contains(t, planFlags, "-destroy")
assert.Contains(t, planFlags, "-detailed-exitcode")
assert.NotContains(t, planFlags, "-chdir") // Should not have global flags.
assert.NotContains(t, planFlags, "-auto-approve") // Should not have apply flags.
// Verify apply flags.
applyFlags := GetSubcommandCompatFlags("terraform", "apply")
require.NotNil(t, applyFlags)
assert.Len(t, applyFlags, 4)
assert.Contains(t, applyFlags, "-var")
assert.Contains(t, applyFlags, "-var-file")
assert.Contains(t, applyFlags, "-auto-approve")
assert.Contains(t, applyFlags, "-backup")
assert.NotContains(t, applyFlags, "-chdir") // Should not have global flags.
assert.NotContains(t, applyFlags, "-out") // Should not have plan flags.
}
func TestGetSubcommandCompatFlags_NotFound(t *testing.T) {
resetCompatFlagsRegistry()
// Query non-existent provider.
flags := GetSubcommandCompatFlags("nonexistent", "plan")
assert.Nil(t, flags)
// Query non-existent subcommand.
RegisterCommandCompatFlags("terraform", "plan", map[string]compat.CompatibilityFlag{
"-var": {Behavior: compat.AppendToSeparated, Description: "Set a variable"},
})
flags = GetSubcommandCompatFlags("terraform", "nonexistent")
assert.Nil(t, flags)
}
func TestRegisterCommandCompatFlags_OverwriteExisting(t *testing.T) {
resetCompatFlagsRegistry()
// Register initial flags.
RegisterCommandCompatFlags("terraform", "plan", map[string]compat.CompatibilityFlag{
"-var": {Behavior: compat.AppendToSeparated, Description: "Original description"},
})
// Overwrite with new flags.
RegisterCommandCompatFlags("terraform", "plan", map[string]compat.CompatibilityFlag{
"-var": {Behavior: compat.AppendToSeparated, Description: "Updated description"},
"-var-file": {Behavior: compat.AppendToSeparated, Description: "New flag"},
})
// Verify flags were overwritten.
flags := GetSubcommandCompatFlags("terraform", "plan")
require.NotNil(t, flags)
assert.Len(t, flags, 2)
assert.Equal(t, "Updated description", flags["-var"].Description)
assert.Contains(t, flags, "-var-file")
}
func TestRegisterCommandCompatFlags_MultipleProviders(t *testing.T) {
resetCompatFlagsRegistry()
// Register terraform flags.
RegisterCommandCompatFlags("terraform", "plan", map[string]compat.CompatibilityFlag{
"-var": {Behavior: compat.AppendToSeparated, Description: "Terraform variable"},
})
// Register helmfile flags.
RegisterCommandCompatFlags("helmfile", "sync", map[string]compat.CompatibilityFlag{
"-f": {Behavior: compat.AppendToSeparated, Description: "Path to helmfile.yaml"},
})
// Verify terraform flags.
tfFlags := GetSubcommandCompatFlags("terraform", "plan")
require.NotNil(t, tfFlags)
assert.Contains(t, tfFlags, "-var")
assert.NotContains(t, tfFlags, "-f")
// Verify helmfile flags.
hfFlags := GetSubcommandCompatFlags("helmfile", "sync")
require.NotNil(t, hfFlags)
assert.Contains(t, hfFlags, "-f")
assert.NotContains(t, hfFlags, "-var")
// Verify providers are isolated.
assert.Nil(t, GetSubcommandCompatFlags("terraform", "sync"))
assert.Nil(t, GetSubcommandCompatFlags("helmfile", "plan"))
}
func TestRegisterCommandCompatFlags_Concurrent(t *testing.T) {
resetCompatFlagsRegistry()
done := make(chan bool)
// Concurrently register flags for different subcommands.
for i := 0; i < 10; i++ {
go func(idx int) {
subcommand := fmt.Sprintf("cmd%d", idx)
RegisterCommandCompatFlags("terraform", subcommand, map[string]compat.CompatibilityFlag{
"-var": {Behavior: compat.AppendToSeparated, Description: fmt.Sprintf("Flag for %s", subcommand)},
})
done <- true
}(i)
}
// Wait for all goroutines.
for i := 0; i < 10; i++ {
<-done
}
// Verify all registrations succeeded.
for i := 0; i < 10; i++ {
subcommand := fmt.Sprintf("cmd%d", i)
flags := GetSubcommandCompatFlags("terraform", subcommand)
require.NotNil(t, flags, "flags for %s should exist", subcommand)
assert.Contains(t, flags, "-var")
}
}
// resetFlagRegistries clears the commandFlagRegistries for test isolation.
func resetFlagRegistries() {
commandFlagRegistries.mu.Lock()
defer commandFlagRegistries.mu.Unlock()
commandFlagRegistries.registries = make(map[string]*flags.FlagRegistry)
}
func TestRegisterCommandFlagRegistry(t *testing.T) {
resetFlagRegistries()
flagReg := flags.NewFlagRegistry()
flagReg.Register(&flags.StringFlag{
Name: "identity",
NoOptDefVal: "__SELECT__",
})
RegisterCommandFlagRegistry("terraform", flagReg)
got := GetCommandFlagRegistry("terraform")
require.NotNil(t, got, "registered flag registry should be retrievable")
assert.Same(t, flagReg, got, "should return the exact same registry instance")
}
func TestGetCommandFlagRegistry_NotFound(t *testing.T) {
resetFlagRegistries()
got := GetCommandFlagRegistry("nonexistent")
assert.Nil(t, got, "should return nil for unregistered provider")
}
func TestRegisterCommandFlagRegistry_Overwrite(t *testing.T) {
resetFlagRegistries()
first := flags.NewFlagRegistry()
second := flags.NewFlagRegistry()
RegisterCommandFlagRegistry("terraform", first)
RegisterCommandFlagRegistry("terraform", second)
got := GetCommandFlagRegistry("terraform")
assert.Same(t, second, got, "second registration should overwrite the first")
}
func TestRegisterCommandFlagRegistry_MultipleProviders(t *testing.T) {
resetFlagRegistries()
tfRegistry := flags.NewFlagRegistry()
hfRegistry := flags.NewFlagRegistry()
RegisterCommandFlagRegistry("terraform", tfRegistry)
RegisterCommandFlagRegistry("helmfile", hfRegistry)
assert.Same(t, tfRegistry, GetCommandFlagRegistry("terraform"))
assert.Same(t, hfRegistry, GetCommandFlagRegistry("helmfile"))
assert.Nil(t, GetCommandFlagRegistry("packer"))
}
func TestRegisterCommandFlagRegistry_Concurrent(t *testing.T) {
resetFlagRegistries()
done := make(chan bool)
// Concurrently register flag registries for different providers.
for i := 0; i < 10; i++ {
go func(idx int) {
provider := fmt.Sprintf("provider%d", idx)
reg := flags.NewFlagRegistry()
RegisterCommandFlagRegistry(provider, reg)
done <- true
}(i)
}
for i := 0; i < 10; i++ {
<-done
}
// Verify all registrations succeeded.
for i := 0; i < 10; i++ {
provider := fmt.Sprintf("provider%d", i)
got := GetCommandFlagRegistry(provider)
require.NotNil(t, got, "flag registry for %s should exist", provider)
}
}
// mockExperimentalCommandProvider is a test implementation that returns IsExperimental = true.
type mockExperimentalCommandProvider struct {
mockCommandProvider
}
func (m *mockExperimentalCommandProvider) IsExperimental() bool {
return true
}
func TestMarkCommandExperimental(t *testing.T) {
tests := []struct {
name string
setupCmd func() *cobra.Command
expectedMarked []string // Command names expected to be marked
}{
{
name: "marks single command",
setupCmd: func() *cobra.Command {
return &cobra.Command{Use: "test"}
},
expectedMarked: []string{"test"},
},
{
name: "marks command with nil annotations",
setupCmd: func() *cobra.Command {
cmd := &cobra.Command{Use: "test"}
cmd.Annotations = nil
return cmd
},
expectedMarked: []string{"test"},
},
{
name: "marks command with existing annotations",
setupCmd: func() *cobra.Command {
cmd := &cobra.Command{
Use: "test",
Annotations: map[string]string{"other": "value"},
}
return cmd
},
expectedMarked: []string{"test"},
},
{
name: "marks command and subcommands recursively",
setupCmd: func() *cobra.Command {
parent := &cobra.Command{Use: "parent"}
child1 := &cobra.Command{Use: "child1"}
child2 := &cobra.Command{Use: "child2"}
grandchild := &cobra.Command{Use: "grandchild"}
child1.AddCommand(grandchild)
parent.AddCommand(child1)
parent.AddCommand(child2)
return parent
},
expectedMarked: []string{"parent", "child1", "child2", "grandchild"},
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
cmd := tt.setupCmd()
markCommandExperimental(cmd)
// Verify all expected commands are marked.
for _, name := range tt.expectedMarked {
foundCmd := findCommandByName(cmd, name)
require.NotNil(t, foundCmd, "command %q should exist", name)
assert.NotNil(t, foundCmd.Annotations, "annotations should not be nil for %q", name)
assert.Equal(t, "true", foundCmd.Annotations["experimental"], "command %q should be marked experimental", name)
}
})
}
}
// findCommandByName recursively searches for a command by name in the command tree.
func findCommandByName(root *cobra.Command, name string) *cobra.Command {
if root.Name() == name {
return root
}
for _, sub := range root.Commands() {
if found := findCommandByName(sub, name); found != nil {
return found
}
}
return nil
}
func TestIsCommandExperimental(t *testing.T) {
tests := []struct {
name string
setup func()
cmdName string
expected bool
}{
{
name: "non-existent command returns false",
setup: func() {
Reset()
},
cmdName: "nonexistent",
expected: false,
},
{
name: "non-experimental command returns false",
setup: func() {
Reset()
provider := &mockCommandProvider{
name: "regular",
group: "Test",
cmd: &cobra.Command{Use: "regular"},
}
Register(provider)
},
cmdName: "regular",
expected: false,
},
{
name: "experimental command returns true",
setup: func() {
Reset()
provider := &mockExperimentalCommandProvider{
mockCommandProvider: mockCommandProvider{
name: "experimental",
group: "Test",
cmd: &cobra.Command{Use: "experimental"},
},
}
Register(provider)
},
cmdName: "experimental",
expected: true,
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
tt.setup()
result := IsCommandExperimental(tt.cmdName)
assert.Equal(t, tt.expected, result)
})
}
}
func TestRegisterAll_DefaultNoArgs(t *testing.T) {
t.Run("applies NoArgs to parent command with subcommands", func(t *testing.T) {
Reset()
rootCmd := &cobra.Command{Use: "root"}
// Create parent command with subcommands (no Args set).
parentCmd := &cobra.Command{Use: "parent"}
childCmd := &cobra.Command{Use: "child"}
parentCmd.AddCommand(childCmd)
provider := &mockCommandProvider{
name: "parent",
group: "Test",
cmd: parentCmd,
}
Register(provider)
err := RegisterAll(rootCmd)
require.NoError(t, err)
// Verify NoArgs was applied to parent.
registeredCmd, _, err := rootCmd.Find([]string{"parent"})
require.NoError(t, err)
require.NotNil(t, registeredCmd.Args, "Args should be set")
// Verify NoArgs behavior: accepts zero args.
err = registeredCmd.Args(registeredCmd, []string{})
assert.NoError(t, err)
// Verify NoArgs behavior: rejects any args.
err = registeredCmd.Args(registeredCmd, []string{"unexpected"})
assert.Error(t, err)
})
t.Run("applies NoArgs to leaf command without subcommands", func(t *testing.T) {
Reset()
rootCmd := &cobra.Command{Use: "root"}
// Create leaf command without subcommands (no Args set).
cmd := &cobra.Command{Use: "standalone"}
provider := &mockCommandProvider{
name: "standalone",
group: "Test",
cmd: cmd,
}
Register(provider)
err := RegisterAll(rootCmd)
require.NoError(t, err)
// Verify NoArgs was applied to leaf command.
registeredCmd, _, err := rootCmd.Find([]string{"standalone"})
require.NoError(t, err)
require.NotNil(t, registeredCmd.Args, "Args should be set for leaf command")
// Verify NoArgs behavior: accepts zero args.
err = registeredCmd.Args(registeredCmd, []string{})
assert.NoError(t, err)
// Verify NoArgs behavior: rejects any args.
err = registeredCmd.Args(registeredCmd, []string{"unexpected"})
assert.Error(t, err)
})
t.Run("does not overwrite explicit Args", func(t *testing.T) {
Reset()
rootCmd := &cobra.Command{Use: "root"}
// Create parent command with subcommands AND explicit Args.
parentCmd := &cobra.Command{
Use: "parent",
Args: cobra.MaximumNArgs(1), // Explicit Args - should not be overwritten.
}
childCmd := &cobra.Command{Use: "child"}
parentCmd.AddCommand(childCmd)
provider := &mockCommandProvider{
name: "parent",
group: "Test",
cmd: parentCmd,
}
Register(provider)
err := RegisterAll(rootCmd)
require.NoError(t, err)
// Verify original Args is preserved.
registeredCmd, _, err := rootCmd.Find([]string{"parent"})
require.NoError(t, err)
require.NotNil(t, registeredCmd.Args, "Args should be set")
// Verify MaximumNArgs behavior: accepts 0 or 1 args.
err = registeredCmd.Args(registeredCmd, []string{})
assert.NoError(t, err)
err = registeredCmd.Args(registeredCmd, []string{"one"})
assert.NoError(t, err)
err = registeredCmd.Args(registeredCmd, []string{"one", "two"})
assert.Error(t, err) // MaximumNArgs(1) rejects 2 args.
})
t.Run("does not modify command with PositionalArgsBuilder", func(t *testing.T) {
Reset()
rootCmd := &cobra.Command{Use: "root"}
// Create parent command with subcommands.
parentCmd := &cobra.Command{Use: "parent"}
childCmd := &cobra.Command{Use: "child"}
parentCmd.AddCommand(childCmd)
// Provider that returns a PositionalArgsBuilder.
provider := &mockProviderWithPositionalArgs{
mockCommandProvider: mockCommandProvider{
name: "parent",
group: "Test",
cmd: parentCmd,
},
}
Register(provider)
err := RegisterAll(rootCmd)
require.NoError(t, err)
// Verify Args was NOT set (provider has PositionalArgsBuilder).
registeredCmd, _, err := rootCmd.Find([]string{"parent"})
require.NoError(t, err)
assert.Nil(t, registeredCmd.Args, "Args should remain nil when PositionalArgsBuilder is set")
})
}
// mockProviderWithPositionalArgs is a test provider that returns a PositionalArgsBuilder.
type mockProviderWithPositionalArgs struct {
mockCommandProvider
}
func (m *mockProviderWithPositionalArgs) GetPositionalArgsBuilder() *flags.PositionalArgsBuilder {
// Return non-nil builder to simulate command that accepts positional args.
return &flags.PositionalArgsBuilder{}
}
func TestRegisterAllMarksExperimentalCommands(t *testing.T) {
Reset()
rootCmd := &cobra.Command{Use: "root"}
// Register a non-experimental command.
regularProvider := &mockCommandProvider{
name: "regular",
group: "Test",
cmd: &cobra.Command{Use: "regular"},
}
Register(regularProvider)
// Register an experimental command with subcommands.
experimentalCmd := &cobra.Command{Use: "experimental"}
subCmd := &cobra.Command{Use: "sub"}
experimentalCmd.AddCommand(subCmd)
experimentalProvider := &mockExperimentalCommandProvider{
mockCommandProvider: mockCommandProvider{
name: "experimental",
group: "Test",
cmd: experimentalCmd,
},
}
Register(experimentalProvider)
err := RegisterAll(rootCmd)
require.NoError(t, err)
// Verify regular command is NOT marked experimental.
regularCmd, _, err := rootCmd.Find([]string{"regular"})
require.NoError(t, err)
if regularCmd.Annotations != nil {
assert.NotEqual(t, "true", regularCmd.Annotations["experimental"], "regular command should NOT be marked experimental")
}
// Verify experimental command IS marked.
expCmd, _, err := rootCmd.Find([]string{"experimental"})
require.NoError(t, err)
assert.NotNil(t, expCmd.Annotations)
assert.Equal(t, "true", expCmd.Annotations["experimental"], "experimental command should be marked")
// Verify subcommand is also marked.
expSubCmd, _, err := expCmd.Find([]string{"sub"})
require.NoError(t, err)
assert.NotNil(t, expSubCmd.Annotations)
assert.Equal(t, "true", expSubCmd.Annotations["experimental"], "subcommand should be marked experimental")
}