forked from jfrog/jfrog-cli-core
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathmetrics_collector_test.go
More file actions
913 lines (777 loc) · 23.2 KB
/
Copy pathmetrics_collector_test.go
File metadata and controls
913 lines (777 loc) · 23.2 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
package commands
import (
"encoding/json"
"fmt"
"os"
"runtime"
"strings"
"testing"
"time"
"github.com/jfrog/jfrog-cli-core/v2/utils/config"
"github.com/jfrog/jfrog-cli-core/v2/utils/usage/visibility"
)
// ClearAllMetrics clears all stored metrics
func ClearAllMetrics() {
globalMetricsCollector.mu.Lock()
defer globalMetricsCollector.mu.Unlock()
globalMetricsCollector.metricsData = make(map[string]*MetricsData)
}
func TestCollectMetrics(t *testing.T) {
// Clear any existing metrics
globalMetricsCollector.mu.Lock()
globalMetricsCollector.metricsData = make(map[string]*MetricsData)
globalMetricsCollector.mu.Unlock()
tests := []struct {
name string
commandName string
flags []string
expected *MetricsData
}{
{
name: "Single flag",
commandName: "test-command",
flags: []string{"verbose"},
expected: &MetricsData{
Flags: []string{"verbose"},
Platform: runtime.GOOS,
Architecture: runtime.GOARCH,
IsCI: detectCISystem() != "",
CISystem: func() string {
ci := detectCISystem()
if ci == "" {
return ""
} else {
return ci
}
}(),
IsContainer: isRunningInContainer(),
},
},
{
name: "Multiple flags",
commandName: "upload-command",
flags: []string{"recursive", "threads", "dry-run"},
expected: &MetricsData{
Flags: []string{"recursive", "threads", "dry-run"},
Platform: runtime.GOOS,
Architecture: runtime.GOARCH,
IsCI: detectCISystem() != "",
CISystem: func() string {
ci := detectCISystem()
if ci == "" {
return ""
} else {
return ci
}
}(),
IsContainer: isRunningInContainer(),
},
},
{
name: "No flags",
commandName: "simple-command",
flags: []string{},
expected: &MetricsData{
Flags: []string{},
Platform: runtime.GOOS,
Architecture: runtime.GOARCH,
IsCI: detectCISystem() != "",
CISystem: func() string {
ci := detectCISystem()
if ci == "" {
return ""
} else {
return ci
}
}(),
IsContainer: isRunningInContainer(),
},
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
// Collect metrics
CollectMetrics(tt.commandName, tt.flags)
// Retrieve metrics
metrics := GetCollectedMetrics(tt.commandName)
// Verify metrics
if metrics == nil {
t.Error("Expected metrics to be collected, but got nil")
return
}
// Compare flags
if len(metrics.Flags) != len(tt.expected.Flags) {
t.Errorf("Expected %d flags, got %d", len(tt.expected.Flags), len(metrics.Flags))
}
for i, flag := range tt.expected.Flags {
if i >= len(metrics.Flags) || metrics.Flags[i] != flag {
t.Errorf("Expected flag %s at index %d, got %s", flag, i, metrics.Flags[i])
}
}
// Compare system information
if metrics.Platform != tt.expected.Platform {
t.Errorf("Expected Platform %s, got %s", tt.expected.Platform, metrics.Platform)
}
if metrics.Architecture != tt.expected.Architecture {
t.Errorf("Expected Architecture %s, got %s", tt.expected.Architecture, metrics.Architecture)
}
if metrics.IsCI != tt.expected.IsCI {
t.Errorf("Expected IsCI %v, got %v", tt.expected.IsCI, metrics.IsCI)
}
if metrics.CISystem != tt.expected.CISystem {
t.Errorf("Expected CISystem %s, got %s", tt.expected.CISystem, metrics.CISystem)
}
if metrics.IsContainer != tt.expected.IsContainer {
t.Errorf("Expected IsContainer %v, got %v", tt.expected.IsContainer, metrics.IsContainer)
}
})
}
}
func TestGetCollectedMetricsDoesNotClearData(t *testing.T) {
// Clear any existing metrics
ClearAllMetrics()
commandName := "test-clear-command"
flags := []string{"test-flag"}
// Collect metrics
CollectMetrics(commandName, flags)
// Retrieve metrics first time
metrics := GetCollectedMetrics(commandName)
if metrics == nil {
t.Error("Expected metrics to be collected")
return
}
// Retrieve metrics second time should still return data (not cleared automatically)
metrics2 := GetCollectedMetrics(commandName)
if metrics2 == nil {
t.Error("Expected metrics to still be available after retrieval")
return
}
// Verify data is the same
if len(metrics.Flags) != len(metrics2.Flags) {
t.Error("Expected same metrics data on repeated retrieval")
}
// Manually clear and verify
ClearAllMetrics()
metrics3 := GetCollectedMetrics(commandName)
if metrics3 != nil {
t.Error("Expected metrics to be cleared after explicit clear")
}
}
func TestDetectCISystem(t *testing.T) {
// Save original environment
originalEnv := make(map[string]string)
ciEnvVars := []string{
"JENKINS_URL", "TRAVIS", "CIRCLECI", "GITHUB_ACTIONS",
"GITLAB_CI", "BUILDKITE", "BAMBOO_BUILD_KEY", "TF_BUILD",
"TEAMCITY_VERSION", "DRONE", "BITBUCKET_BUILD_NUMBER",
"CODEBUILD_BUILD_ID", "CI",
}
for _, envVar := range ciEnvVars {
originalEnv[envVar] = os.Getenv(envVar)
_ = os.Unsetenv(envVar)
}
// Restore environment after test
defer func() {
for envVar, value := range originalEnv {
if value != "" {
if err := os.Setenv(envVar, value); err != nil {
t.Logf("failed restoring %s: %v", envVar, err)
}
} else {
_ = os.Unsetenv(envVar)
}
}
}()
tests := []struct {
name string
envVar string
envValue string
expected string
}{
{"GitHub Actions", "GITHUB_ACTIONS", "true", "github_actions"},
{"Jenkins", "JENKINS_URL", "http://jenkins.example.com", "jenkins"},
{"GitLab CI", "GITLAB_CI", "true", "gitlab"},
{"CircleCI", "CIRCLECI", "true", "circleci"},
{"Travis", "TRAVIS", "true", "travis"},
{"Azure DevOps", "TF_BUILD", "True", "azure_devops"},
{"Generic CI", "CI", "true", "unknown"},
{"No CI", "", "", ""},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
// Clear all CI environment variables
for _, envVar := range ciEnvVars {
_ = os.Unsetenv(envVar)
}
// Set the specific test environment variable
if tt.envVar != "" {
if err := os.Setenv(tt.envVar, tt.envValue); err != nil {
t.Fatalf("failed setting env %s: %v", tt.envVar, err)
}
}
result := detectCISystem()
if result != tt.expected {
t.Errorf("Expected CI system %s, got %s", tt.expected, result)
}
})
}
}
func TestIsRunningInContainer(t *testing.T) {
// This test will mostly work on the actual environment
// We can't easily mock filesystem calls without more complex mocking
result := isRunningInContainer()
// Just verify it returns a boolean value
if result != true && result != false {
t.Error("isRunningInContainer should return a boolean value")
}
// Test with environment variable
originalContainer := os.Getenv("container")
defer func() {
if originalContainer != "" {
_ = os.Setenv("container", originalContainer)
} else {
_ = os.Unsetenv("container")
}
}()
if err := os.Setenv("container", "docker"); err != nil {
t.Fatalf("failed setting env container: %v", err)
}
if !isRunningInContainer() {
t.Error("Expected container detection when 'container' env var is set")
}
_ = os.Unsetenv("container")
// Test with Kubernetes environment
originalK8s := os.Getenv("KUBERNETES_SERVICE_HOST")
defer func() {
if originalK8s != "" {
_ = os.Setenv("KUBERNETES_SERVICE_HOST", originalK8s)
} else {
_ = os.Unsetenv("KUBERNETES_SERVICE_HOST")
}
}()
if err := os.Setenv("KUBERNETES_SERVICE_HOST", "10.96.0.1"); err != nil {
t.Fatalf("failed setting env KUBERNETES_SERVICE_HOST: %v", err)
}
if !isRunningInContainer() {
t.Error("Expected container detection when Kubernetes env var is set")
}
}
func TestMetricsDataStructure(t *testing.T) {
metrics := &MetricsData{
Flags: []string{"test-flag1", "test-flag2"},
Platform: "test-os",
Architecture: "test-arch",
IsCI: true,
CISystem: "test-ci",
IsContainer: false,
}
// Verify all fields are properly set
if len(metrics.Flags) != 2 {
t.Errorf("Expected 2 flags, got %d", len(metrics.Flags))
}
if metrics.Flags[0] != "test-flag1" {
t.Errorf("Expected first flag to be 'test-flag1', got %s", metrics.Flags[0])
}
if metrics.Platform != "test-os" {
t.Errorf("Expected Platform to be 'test-os', got %s", metrics.Platform)
}
if metrics.Architecture != "test-arch" {
t.Errorf("Expected Architecture to be 'test-arch', got %s", metrics.Architecture)
}
if !metrics.IsCI {
t.Error("Expected IsCI to be true")
}
if metrics.CISystem != "test-ci" {
t.Errorf("Expected CISystem to be 'test-ci', got %s", metrics.CISystem)
}
if metrics.IsContainer {
t.Error("Expected IsContainer to be false")
}
}
// TestCommand implements the Command interface for E2E testing
type TestCommand struct {
name string
flags []string
serverDetails *config.ServerDetails
executionError error
executed bool
}
func (tc *TestCommand) Run() error {
tc.executed = true
return tc.executionError
}
func (tc *TestCommand) ServerDetails() (*config.ServerDetails, error) {
if tc.serverDetails != nil {
return tc.serverDetails, nil
}
return &config.ServerDetails{
ArtifactoryUrl: "https://test-e2e.jfrog.io/artifactory/",
User: "test-user",
Password: "test-password",
}, nil
}
func (tc *TestCommand) CommandName() string {
return tc.name
}
func (tc *TestCommand) GetFlags() []string {
return tc.flags
}
func TestE2EBasicMetricsFlow(t *testing.T) {
// Clear metrics to start fresh
ClearAllMetrics()
commandName := "upload"
flags := []string{"recursive", "threads", "dry-run"}
CollectMetrics(commandName, flags)
cmd := &TestCommand{
name: commandName,
flags: flags,
}
err := Exec(cmd)
if err != nil {
t.Errorf("Unexpected error: %v", err)
}
if !cmd.executed {
t.Error("Command should have been executed")
}
CollectMetrics(commandName, flags)
metrics := GetCollectedMetrics(commandName)
if metrics == nil {
t.Error("Metrics should be collected")
return
}
if len(metrics.Flags) != len(flags) {
t.Errorf("Expected %d flags, got %d", len(flags), len(metrics.Flags))
}
if metrics.Platform != runtime.GOOS {
t.Errorf("Expected Platform %s, got %s", runtime.GOOS, metrics.Platform)
}
if metrics.Architecture != runtime.GOARCH {
t.Errorf("Expected Architecture %s, got %s", runtime.GOARCH, metrics.Architecture)
}
}
func TestE2EGitHubActionsEnvironment(t *testing.T) {
// Setup GitHub Actions environment
originalGH := os.Getenv("GITHUB_ACTIONS")
originalCI := os.Getenv("CI")
if err := os.Setenv("GITHUB_ACTIONS", "true"); err != nil {
t.Fatalf("failed setting GITHUB_ACTIONS: %v", err)
}
if err := os.Setenv("CI", "true"); err != nil {
t.Fatalf("failed setting CI: %v", err)
}
defer func() {
if originalGH == "" {
_ = os.Unsetenv("GITHUB_ACTIONS")
} else {
_ = os.Setenv("GITHUB_ACTIONS", originalGH)
}
if originalCI == "" {
_ = os.Unsetenv("CI")
} else {
_ = os.Setenv("CI", originalCI)
}
}()
ClearAllMetrics()
commandName := "download"
flags := []string{"threads", "flat"}
// Collect metrics
CollectMetrics(commandName, flags)
metrics := GetCollectedMetrics(commandName)
if metrics == nil {
t.Error("Metrics should be collected")
return
}
if !metrics.IsCI {
t.Error("Should detect CI environment")
}
if metrics.CISystem != "github_actions" {
t.Errorf("Expected CI system 'github_actions', got '%s'", metrics.CISystem)
}
}
func TestE2EVisibilityIntegration(t *testing.T) {
ClearAllMetrics()
commandName := "full-integration-test"
flags := []string{"recursive", "threads", "exclude", "dry-run"}
// Collect metrics
CollectMetrics(commandName, flags)
metrics := GetCollectedMetrics(commandName)
if metrics == nil {
t.Error("Metrics should be collected")
return
}
// Create visibility metrics
visibilityData := &visibility.MetricsData{
Flags: metrics.Flags,
Platform: metrics.Platform,
Architecture: metrics.Architecture,
IsCI: metrics.IsCI,
CISystem: metrics.CISystem,
IsContainer: metrics.IsContainer,
}
visibilityMetric := visibility.NewCommandsCountMetricWithEnhancedData(commandName, visibilityData)
// Verify metric structure
if visibilityMetric.Name != "jfcli_commands_count" {
t.Errorf("Expected metric name 'jfcli_commands_count', got %s", visibilityMetric.Name)
}
if visibilityMetric.Value != 1 {
t.Errorf("Expected metric value 1, got %d", visibilityMetric.Value)
}
// Verify JSON serialization
metricJSON, err := json.Marshal(visibilityMetric)
if err != nil {
t.Errorf("Failed to marshal metric: %v", err)
}
jsonStr := string(metricJSON)
if !strings.Contains(jsonStr, "flags") {
t.Error("JSON should contain flags")
}
if !strings.Contains(jsonStr, "platform") {
t.Error("JSON should contain platform")
}
if !strings.Contains(jsonStr, "architecture") {
t.Error("JSON should contain architecture")
}
}
func TestE2EFlagSanitization(t *testing.T) {
ClearAllMetrics()
testCases := []struct {
name string
flags []string
expected []string
}{
{
name: "Safe flags only",
flags: []string{"recursive", "threads", "dry-run"},
expected: []string{"recursive", "threads", "dry-run"},
},
{
name: "Empty flags",
flags: []string{},
expected: []string{},
},
}
for _, tc := range testCases {
t.Run(tc.name, func(t *testing.T) {
commandName := "sanitization-test-" + strings.ReplaceAll(tc.name, " ", "-")
// Collect metrics
CollectMetrics(commandName, tc.flags)
metrics := GetCollectedMetrics(commandName)
if metrics == nil {
t.Error("Metrics should be collected")
return
}
sanitized := metrics.Flags
if len(sanitized) != len(tc.expected) {
t.Errorf("Expected %d sanitized flags, got %d", len(tc.expected), len(sanitized))
}
for i, expected := range tc.expected {
if i >= len(sanitized) || sanitized[i] != expected {
t.Errorf("Expected flag %s at index %d, got %s", expected, i, sanitized[i])
}
}
})
}
}
func TestE2EConcurrentMetricsCollection(t *testing.T) {
ClearAllMetrics()
numCommands := 5
done := make(chan struct{}, numCommands)
// Simulate concurrent command executions
for i := 0; i < numCommands; i++ {
go func(id int) {
defer func() { done <- struct{}{} }()
commandName := fmt.Sprintf("concurrent-cmd-%d", id)
flags := []string{fmt.Sprintf("flag-%d", id)}
// Collect metrics
CollectMetrics(commandName, flags)
// Verify metrics were collected
metrics := GetCollectedMetrics(commandName)
if metrics == nil {
t.Errorf("Metrics should be collected for command %s", commandName)
return
}
if len(metrics.Flags) != 1 || metrics.Flags[0] != flags[0] {
t.Errorf("Expected flag %s, got %v", flags[0], metrics.Flags)
}
}(i)
}
// Wait for all goroutines to complete
for i := 0; i < numCommands; i++ {
select {
case <-done:
// Success
case <-time.After(time.Second * 2):
t.Fatal("Timeout waiting for concurrent operations")
}
}
}
func TestE2EMetricsClearing(t *testing.T) {
ClearAllMetrics()
commandName := "clear-test-command"
flags := []string{"test-flag"}
// Collect metrics
CollectMetrics(commandName, flags)
// Retrieve metrics (should NOT clear them - that's done by Exec)
metrics1 := GetCollectedMetrics(commandName)
if metrics1 == nil {
t.Error("First retrieval should return metrics")
}
// Clear metrics explicitly
ClearAllMetrics()
// Try to retrieve again (should be nil after clearing)
metrics2 := GetCollectedMetrics(commandName)
if metrics2 != nil {
t.Error("After clearing, retrieval should return nil")
}
}
func TestE2EEnvironmentDetection(t *testing.T) {
ClearAllMetrics()
// Test Jenkins detection - isolate from existing CI env (e.g., GitHub Actions)
ciEnvVars := []string{
"JENKINS_URL", "TRAVIS", "CIRCLECI", "GITHUB_ACTIONS",
"GITLAB_CI", "BUILDKITE", "BAMBOO_BUILD_KEY", "TF_BUILD",
"TEAMCITY_VERSION", "DRONE", "BITBUCKET_BUILD_NUMBER",
"CODEBUILD_BUILD_ID", "CI",
}
originalEnv := make(map[string]string, len(ciEnvVars))
for _, envVar := range ciEnvVars {
originalEnv[envVar] = os.Getenv(envVar)
_ = os.Unsetenv(envVar)
}
defer func() {
for k, v := range originalEnv {
if v == "" {
_ = os.Unsetenv(k)
} else {
_ = os.Setenv(k, v)
}
}
}()
// Set Jenkins env var explicitly
if err := os.Setenv("JENKINS_URL", "http://jenkins.test"); err != nil {
t.Fatalf("failed setting JENKINS_URL: %v", err)
}
commandName := "jenkins-test"
flags := []string{"test-flag"}
CollectMetrics(commandName, flags)
metrics := GetCollectedMetrics(commandName)
if metrics == nil {
t.Error("Metrics should be collected")
return
}
if !metrics.IsCI {
t.Error("Should detect CI environment")
}
if metrics.CISystem != "jenkins" {
t.Errorf("Expected CI system 'jenkins', got '%s'", metrics.CISystem)
}
}
// MockCommand implements the Command interface for testing
type MockCommand struct {
name string
serverDetails *config.ServerDetails
runFunc func() error
shouldError bool
}
func (m *MockCommand) Run() error {
if m.runFunc != nil {
return m.runFunc()
}
if m.shouldError {
return mockError("mock command error")
}
return nil
}
func (m *MockCommand) ServerDetails() (*config.ServerDetails, error) {
if m.serverDetails != nil {
return m.serverDetails, nil
}
return &config.ServerDetails{
ArtifactoryUrl: "https://test.jfrog.io/artifactory/",
User: "test-user",
Password: "test-password",
}, nil
}
func (m *MockCommand) CommandName() string {
return m.name
}
type mockError string
func (e mockError) Error() string {
return string(e)
}
func TestExecWithBasicCommand(t *testing.T) {
// Clear any existing metrics
globalMetricsCollector.mu.Lock()
globalMetricsCollector.metricsData = make(map[string]*MetricsData)
globalMetricsCollector.mu.Unlock()
commandName := "test-basic-command"
executed := false
cmd := &MockCommand{
name: commandName,
runFunc: func() error {
executed = true
return nil
},
}
err := Exec(cmd)
if err != nil {
t.Errorf("Expected no error, got %v", err)
}
if !executed {
t.Error("Expected command to be executed")
}
}
func TestExecWithCommandError(t *testing.T) {
commandName := "test-error-command"
cmd := &MockCommand{
name: commandName,
shouldError: true,
}
err := Exec(cmd)
if err == nil {
t.Error("Expected command to return error")
}
if err.Error() != "mock command error" {
t.Errorf("Expected specific error message, got %v", err)
}
}
func TestReportUsageToVisibilitySystemWithMetrics(t *testing.T) {
// Clear any existing metrics
globalMetricsCollector.mu.Lock()
globalMetricsCollector.metricsData = make(map[string]*MetricsData)
globalMetricsCollector.mu.Unlock()
commandName := "test-metrics-command"
flags := []string{"verbose", "recursive"}
// Collect metrics first
CollectMetrics(commandName, flags)
// Step 2: Create command for testing server details
cmd := &MockCommand{
name: commandName,
serverDetails: &config.ServerDetails{
ArtifactoryUrl: "https://test.jfrog.io/artifactory/",
},
}
// This will test the reportUsageToVisibilitySystem function indirectly
// In a real scenario, this would send metrics to the visibility system
serverDetails, err := cmd.ServerDetails()
if err != nil {
t.Errorf("Unexpected error getting server details: %v", err)
return
}
// Verify that metrics exist before reporting
metrics := GetCollectedMetrics(commandName)
if metrics == nil {
t.Error("Expected metrics to be collected")
return
}
// Verify the metrics content
if len(metrics.Flags) != 2 {
t.Errorf("Expected 2 flags, got %d", len(metrics.Flags))
}
// Test the visibility metric creation
visibilityMetricsData := &visibility.MetricsData{
Flags: metrics.Flags,
Platform: metrics.Platform,
Architecture: metrics.Architecture,
IsCI: metrics.IsCI,
CISystem: metrics.CISystem,
IsContainer: metrics.IsContainer,
}
metric := visibility.NewCommandsCountMetricWithEnhancedData(commandName, visibilityMetricsData)
if metric.Value != 1 {
t.Errorf("Expected metric value to be 1, got %d", metric.Value)
}
if metric.Name != "jfcli_commands_count" {
t.Errorf("Expected metric name to be 'jfcli_commands_count', got %s", metric.Name)
}
// Verify that serverDetails is properly formed
if serverDetails.ArtifactoryUrl == "" {
t.Error("Expected server details to have ArtifactoryUrl")
}
}
func TestReportUsageToVisibilitySystemWithoutMetrics(t *testing.T) {
// Clear any existing metrics
globalMetricsCollector.mu.Lock()
globalMetricsCollector.metricsData = make(map[string]*MetricsData)
globalMetricsCollector.mu.Unlock()
commandName := "test-no-metrics-command"
// Don't collect any metrics first
// Verify that no metrics exist
metrics := GetCollectedMetrics(commandName)
if metrics != nil {
t.Error("Expected no metrics to be collected")
return
}
// Test the visibility metric creation without enhanced data
metric := visibility.NewCommandsCountMetric(commandName)
if metric.Value != 1 {
t.Errorf("Expected metric value to be 1, got %d", metric.Value)
}
if metric.Name != "jfcli_commands_count" {
t.Errorf("Expected metric name to be 'jfcli_commands_count', got %s", metric.Name)
}
}
func TestMetricsIntegrationFlow(t *testing.T) {
// Clear any existing metrics
globalMetricsCollector.mu.Lock()
globalMetricsCollector.metricsData = make(map[string]*MetricsData)
globalMetricsCollector.mu.Unlock()
commandName := "integration-test-command"
flags := []string{"recursive", "threads", "exclude"}
// Step 1: Collect metrics (simulates CLI flag interception)
CollectMetrics(commandName, flags)
// Step 2: Create and execute command
executed := false
cmd := &MockCommand{
name: commandName,
runFunc: func() error {
executed = true
return nil
},
}
// Step 3: Execute command (this would normally trigger metrics reporting)
err := Exec(cmd)
if err != nil {
t.Errorf("Unexpected error executing command: %v", err)
}
if !executed {
t.Error("Expected command to be executed")
}
// Step 4: Verify metrics were collected and can be retrieved
// Note: In the real flow, GetCollectedMetrics is called during reportUsageToVisibilitySystem
// and the metrics are cleared after retrieval
// Since Exec() -> reportUsage() -> reportUsageToVisibilitySystem() -> GetCollectedMetrics()
// the metrics should have been cleared. Let's test this behavior by collecting again
// and then manually calling the visibility system integration
CollectMetrics(commandName, flags)
// Get metrics (this simulates what happens in reportUsageToVisibilitySystem)
metrics := GetCollectedMetrics(commandName)
if metrics == nil {
t.Error("Expected metrics to be available")
return
}
// Verify metrics content
if len(metrics.Flags) != 3 {
t.Errorf("Expected 3 flags, got %d", len(metrics.Flags))
}
expectedFlags := []string{"recursive", "threads", "exclude"}
for i, expectedFlag := range expectedFlags {
if i >= len(metrics.Flags) || metrics.Flags[i] != expectedFlag {
t.Errorf("Expected flag %s at index %d, got %s", expectedFlag, i, metrics.Flags[i])
}
}
// Verify system information is collected
if metrics.Platform == "" {
t.Error("Expected Platform to be populated")
}
if metrics.Architecture == "" {
t.Error("Expected Architecture to be populated")
}
// Simulate cleanup done in reportUsageToVisibilitySystem
ClearAllMetrics()
// Verify metrics are cleared after cleanup
metricsAfter := GetCollectedMetrics(commandName)
if metricsAfter != nil {
t.Error("Expected metrics to be cleared after retrieval")
}
}