-
Notifications
You must be signed in to change notification settings - Fork 5.4k
/
fixture.go
1011 lines (873 loc) · 34.2 KB
/
fixture.go
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 fixture
import (
"bufio"
"context"
goerrors "errors"
"fmt"
"os"
"path"
"path/filepath"
"strconv"
"strings"
"testing"
"time"
"github.com/argoproj/pkg/errors"
jsonpatch "github.com/evanphx/json-patch"
log "github.com/sirupsen/logrus"
corev1 "k8s.io/api/core/v1"
v1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/client-go/dynamic"
"k8s.io/client-go/kubernetes"
"k8s.io/client-go/rest"
"k8s.io/client-go/tools/clientcmd"
"sigs.k8s.io/yaml"
"github.com/argoproj/argo-cd/v2/common"
"github.com/argoproj/argo-cd/v2/pkg/apiclient"
sessionpkg "github.com/argoproj/argo-cd/v2/pkg/apiclient/session"
"github.com/argoproj/argo-cd/v2/pkg/apis/application/v1alpha1"
appclientset "github.com/argoproj/argo-cd/v2/pkg/client/clientset/versioned"
"github.com/argoproj/argo-cd/v2/util/env"
. "github.com/argoproj/argo-cd/v2/util/errors"
grpcutil "github.com/argoproj/argo-cd/v2/util/grpc"
"github.com/argoproj/argo-cd/v2/util/io"
"github.com/argoproj/argo-cd/v2/util/rand"
"github.com/argoproj/argo-cd/v2/util/settings"
)
const (
defaultApiServer = "localhost:8080"
defaultAdminPassword = "password"
defaultAdminUsername = "admin"
DefaultTestUserPassword = "password"
TestingLabel = "e2e.argoproj.io"
ArgoCDNamespace = "argocd-e2e"
ArgoCDAppNamespace = "argocd-e2e-external"
// ensure all repos are in one directory tree, so we can easily clean them up
TmpDir = "/tmp/argo-e2e"
repoDir = "testdata.git"
submoduleDir = "submodule.git"
submoduleParentDir = "submoduleParent.git"
GuestbookPath = "guestbook"
ProjectName = "argo-project"
// cmp plugin sock file path
PluginSockFilePath = "/app/config/plugin"
E2ETestPrefix = "e2e-test-"
)
const (
EnvAdminUsername = "ARGOCD_E2E_ADMIN_USERNAME"
EnvAdminPassword = "ARGOCD_E2E_ADMIN_PASSWORD"
EnvArgoCDServerName = "ARGOCD_E2E_SERVER_NAME"
EnvArgoCDRedisHAProxyName = "ARGOCD_E2E_REDIS_HAPROXY_NAME"
EnvArgoCDRedisName = "ARGOCD_E2E_REDIS_NAME"
EnvArgoCDRepoServerName = "ARGOCD_E2E_REPO_SERVER_NAME"
EnvArgoCDAppControllerName = "ARGOCD_E2E_APPLICATION_CONTROLLER_NAME"
)
var (
id string
deploymentNamespace string
name string
KubeClientset kubernetes.Interface
KubeConfig *rest.Config
DynamicClientset dynamic.Interface
AppClientset appclientset.Interface
ArgoCDClientset apiclient.Client
adminUsername string
AdminPassword string
apiServerAddress string
token string
plainText bool
testsRun map[string]bool
argoCDServerName string
argoCDRedisHAProxyName string
argoCDRedisName string
argoCDRepoServerName string
argoCDAppControllerName string
)
type RepoURLType string
type ACL struct {
Resource string
Action string
Scope string
}
const (
RepoURLTypeFile = "file"
RepoURLTypeHTTPS = "https"
RepoURLTypeHTTPSOrg = "https-org"
RepoURLTypeHTTPSClientCert = "https-cc"
RepoURLTypeHTTPSSubmodule = "https-sub"
RepoURLTypeHTTPSSubmoduleParent = "https-par"
RepoURLTypeSSH = "ssh"
RepoURLTypeSSHSubmodule = "ssh-sub"
RepoURLTypeSSHSubmoduleParent = "ssh-par"
RepoURLTypeHelm = "helm"
RepoURLTypeHelmParent = "helm-par"
RepoURLTypeHelmOCI = "helm-oci"
GitUsername = "admin"
GitPassword = "password"
GithubAppID = "2978632978"
GithubAppInstallationID = "7893789433789"
GpgGoodKeyID = "D56C4FCA57A46444"
HelmOCIRegistryURL = "localhost:5000/myrepo"
)
// TestNamespace returns the namespace where Argo CD E2E test instance will be
// running in.
func TestNamespace() string {
return GetEnvWithDefault("ARGOCD_E2E_NAMESPACE", ArgoCDNamespace)
}
func AppNamespace() string {
return GetEnvWithDefault("ARGOCD_E2E_APP_NAMESPACE", ArgoCDAppNamespace)
}
// getKubeConfig creates new kubernetes client config using specified config path and config overrides variables
func getKubeConfig(configPath string, overrides clientcmd.ConfigOverrides) *rest.Config {
loadingRules := clientcmd.NewDefaultClientConfigLoadingRules()
loadingRules.ExplicitPath = configPath
clientConfig := clientcmd.NewInteractiveDeferredLoadingClientConfig(loadingRules, &overrides, os.Stdin)
restConfig, err := clientConfig.ClientConfig()
CheckError(err)
return restConfig
}
func GetEnvWithDefault(envName, defaultValue string) string {
r := os.Getenv(envName)
if r == "" {
return defaultValue
}
return r
}
// IsRemote returns true when the tests are being run against a workload that
// is running in a remote cluster.
func IsRemote() bool {
return env.ParseBoolFromEnv("ARGOCD_E2E_REMOTE", false)
}
// IsLocal returns when the tests are being run against a local workload
func IsLocal() bool {
return !IsRemote()
}
// creates e2e tests fixture: ensures that Application CRD is installed, creates temporal namespace, starts repo and api server,
// configure currently available cluster.
func init() {
// ensure we log all shell execs
log.SetLevel(log.DebugLevel)
// set-up variables
config := getKubeConfig("", clientcmd.ConfigOverrides{})
AppClientset = appclientset.NewForConfigOrDie(config)
KubeClientset = kubernetes.NewForConfigOrDie(config)
DynamicClientset = dynamic.NewForConfigOrDie(config)
KubeConfig = config
apiServerAddress = GetEnvWithDefault(apiclient.EnvArgoCDServer, defaultApiServer)
adminUsername = GetEnvWithDefault(EnvAdminUsername, defaultAdminUsername)
AdminPassword = GetEnvWithDefault(EnvAdminPassword, defaultAdminPassword)
argoCDServerName = GetEnvWithDefault(EnvArgoCDServerName, common.DefaultServerName)
argoCDRedisHAProxyName = GetEnvWithDefault(EnvArgoCDRedisHAProxyName, common.DefaultRedisHaProxyName)
argoCDRedisName = GetEnvWithDefault(EnvArgoCDRedisName, common.DefaultRedisName)
argoCDRepoServerName = GetEnvWithDefault(EnvArgoCDRepoServerName, common.DefaultRepoServerName)
argoCDAppControllerName = GetEnvWithDefault(EnvArgoCDAppControllerName, common.DefaultApplicationControllerName)
dialTime := 30 * time.Second
tlsTestResult, err := grpcutil.TestTLS(apiServerAddress, dialTime)
CheckError(err)
ArgoCDClientset, err = apiclient.NewClient(&apiclient.ClientOptions{
Insecure: true,
ServerAddr: apiServerAddress,
PlainText: !tlsTestResult.TLS,
ServerName: argoCDServerName,
RedisHaProxyName: argoCDRedisHAProxyName,
RedisName: argoCDRedisName,
RepoServerName: argoCDRepoServerName,
AppControllerName: argoCDAppControllerName,
})
CheckError(err)
plainText = !tlsTestResult.TLS
LoginAs(adminUsername)
log.WithFields(log.Fields{"apiServerAddress": apiServerAddress}).Info("initialized")
// Preload a list of tests that should be skipped
testsRun = make(map[string]bool)
rf := os.Getenv("ARGOCD_E2E_RECORD")
if rf == "" {
return
}
f, err := os.Open(rf)
if err != nil {
if goerrors.Is(err, os.ErrNotExist) {
return
} else {
panic(fmt.Sprintf("Could not read record file %s: %v", rf, err))
}
}
defer func() {
err := f.Close()
if err != nil {
panic(fmt.Sprintf("Could not close record file %s: %v", rf, err))
}
}()
scanner := bufio.NewScanner(f)
for scanner.Scan() {
testsRun[scanner.Text()] = true
}
}
func loginAs(username, password string) {
closer, client, err := ArgoCDClientset.NewSessionClient()
CheckError(err)
defer io.Close(closer)
sessionResponse, err := client.Create(context.Background(), &sessionpkg.SessionCreateRequest{Username: username, Password: password})
CheckError(err)
token = sessionResponse.Token
ArgoCDClientset, err = apiclient.NewClient(&apiclient.ClientOptions{
Insecure: true,
ServerAddr: apiServerAddress,
AuthToken: token,
PlainText: plainText,
ServerName: argoCDServerName,
RedisHaProxyName: argoCDRedisHAProxyName,
RedisName: argoCDRedisName,
RepoServerName: argoCDRepoServerName,
AppControllerName: argoCDAppControllerName,
})
CheckError(err)
}
func LoginAs(username string) {
password := DefaultTestUserPassword
if username == "admin" {
password = AdminPassword
}
loginAs(username, password)
}
func Name() string {
return name
}
func repoDirectory() string {
return path.Join(TmpDir, repoDir)
}
func submoduleDirectory() string {
return path.Join(TmpDir, submoduleDir)
}
func submoduleParentDirectory() string {
return path.Join(TmpDir, submoduleParentDir)
}
const (
EnvRepoURLTypeSSH = "ARGOCD_E2E_REPO_SSH"
EnvRepoURLTypeSSHSubmodule = "ARGOCD_E2E_REPO_SSH_SUBMODULE"
EnvRepoURLTypeSSHSubmoduleParent = "ARGOCD_E2E_REPO_SSH_SUBMODULE_PARENT"
EnvRepoURLTypeHTTPS = "ARGOCD_E2E_REPO_HTTPS"
EnvRepoURLTypeHTTPSOrg = "ARGOCD_E2E_REPO_HTTPS_ORG"
EnvRepoURLTypeHTTPSClientCert = "ARGOCD_E2E_REPO_HTTPS_CLIENT_CERT"
EnvRepoURLTypeHTTPSSubmodule = "ARGOCD_E2E_REPO_HTTPS_SUBMODULE"
EnvRepoURLTypeHTTPSSubmoduleParent = "ARGOCD_E2E_REPO_HTTPS_SUBMODULE_PARENT"
EnvRepoURLTypeHelm = "ARGOCD_E2E_REPO_HELM"
EnvRepoURLDefault = "ARGOCD_E2E_REPO_DEFAULT"
)
func RepoURL(urlType RepoURLType) string {
switch urlType {
// Git server via SSH
case RepoURLTypeSSH:
return GetEnvWithDefault(EnvRepoURLTypeSSH, "ssh://root@localhost:2222/tmp/argo-e2e/testdata.git")
// Git submodule repo
case RepoURLTypeSSHSubmodule:
return GetEnvWithDefault(EnvRepoURLTypeSSHSubmodule, "ssh://root@localhost:2222/tmp/argo-e2e/submodule.git")
// Git submodule parent repo
case RepoURLTypeSSHSubmoduleParent:
return GetEnvWithDefault(EnvRepoURLTypeSSHSubmoduleParent, "ssh://root@localhost:2222/tmp/argo-e2e/submoduleParent.git")
// Git server via HTTPS
case RepoURLTypeHTTPS:
return GetEnvWithDefault(EnvRepoURLTypeHTTPS, "https://localhost:9443/argo-e2e/testdata.git")
// Git "organisation" via HTTPS
case RepoURLTypeHTTPSOrg:
return GetEnvWithDefault(EnvRepoURLTypeHTTPSOrg, "https://localhost:9443/argo-e2e")
// Git server via HTTPS - Client Cert protected
case RepoURLTypeHTTPSClientCert:
return GetEnvWithDefault(EnvRepoURLTypeHTTPSClientCert, "https://localhost:9444/argo-e2e/testdata.git")
case RepoURLTypeHTTPSSubmodule:
return GetEnvWithDefault(EnvRepoURLTypeHTTPSSubmodule, "https://localhost:9443/argo-e2e/submodule.git")
// Git submodule parent repo
case RepoURLTypeHTTPSSubmoduleParent:
return GetEnvWithDefault(EnvRepoURLTypeHTTPSSubmoduleParent, "https://localhost:9443/argo-e2e/submoduleParent.git")
// Default - file based Git repository
case RepoURLTypeHelm:
return GetEnvWithDefault(EnvRepoURLTypeHelm, "https://localhost:9444/argo-e2e/testdata.git/helm-repo/local")
// When Helm Repo has sub repos, this is the parent repo URL
case RepoURLTypeHelmParent:
return GetEnvWithDefault(EnvRepoURLTypeHelm, "https://localhost:9444/argo-e2e/testdata.git/helm-repo")
case RepoURLTypeHelmOCI:
return HelmOCIRegistryURL
default:
return GetEnvWithDefault(EnvRepoURLDefault, fmt.Sprintf("file://%s", repoDirectory()))
}
}
func RepoBaseURL(urlType RepoURLType) string {
return path.Base(RepoURL(urlType))
}
func DeploymentNamespace() string {
return deploymentNamespace
}
// creates a secret for the current test, this currently can only create a single secret
func CreateSecret(username, password string) string {
secretName := fmt.Sprintf("argocd-e2e-%s", name)
FailOnErr(Run("", "kubectl", "create", "secret", "generic", secretName,
"--from-literal=username="+username,
"--from-literal=password="+password,
"-n", TestNamespace()))
FailOnErr(Run("", "kubectl", "label", "secret", secretName, TestingLabel+"=true", "-n", TestNamespace()))
return secretName
}
// Convenience wrapper for updating argocd-cm
func updateSettingConfigMap(updater func(cm *corev1.ConfigMap) error) {
updateGenericConfigMap(common.ArgoCDConfigMapName, updater)
}
// Convenience wrapper for updating argocd-notifications-cm
func updateNotificationsConfigMap(updater func(cm *corev1.ConfigMap) error) {
updateGenericConfigMap(common.ArgoCDNotificationsConfigMapName, updater)
}
// Convenience wrapper for updating argocd-cm-rbac
func updateRBACConfigMap(updater func(cm *corev1.ConfigMap) error) {
updateGenericConfigMap(common.ArgoCDRBACConfigMapName, updater)
}
// Updates a given config map in argocd-e2e namespace
func updateGenericConfigMap(name string, updater func(cm *corev1.ConfigMap) error) {
cm, err := KubeClientset.CoreV1().ConfigMaps(TestNamespace()).Get(context.Background(), name, v1.GetOptions{})
errors.CheckError(err)
if cm.Data == nil {
cm.Data = make(map[string]string)
}
errors.CheckError(updater(cm))
_, err = KubeClientset.CoreV1().ConfigMaps(TestNamespace()).Update(context.Background(), cm, v1.UpdateOptions{})
errors.CheckError(err)
}
func SetEnableManifestGeneration(val map[v1alpha1.ApplicationSourceType]bool) {
updateSettingConfigMap(func(cm *corev1.ConfigMap) error {
for k, v := range val {
cm.Data[fmt.Sprintf("%s.enable", strings.ToLower(string(k)))] = strconv.FormatBool(v)
}
return nil
})
}
func SetResourceOverrides(overrides map[string]v1alpha1.ResourceOverride) {
updateSettingConfigMap(func(cm *corev1.ConfigMap) error {
if len(overrides) > 0 {
yamlBytes, err := yaml.Marshal(overrides)
if err != nil {
return err
}
cm.Data["resource.customizations"] = string(yamlBytes)
} else {
delete(cm.Data, "resource.customizations")
}
return nil
})
SetResourceOverridesSplitKeys(overrides)
}
func SetTrackingMethod(trackingMethod string) {
updateSettingConfigMap(func(cm *corev1.ConfigMap) error {
cm.Data["application.resourceTrackingMethod"] = trackingMethod
return nil
})
}
func SetTrackingLabel(trackingLabel string) {
updateSettingConfigMap(func(cm *corev1.ConfigMap) error {
cm.Data["application.instanceLabelKey"] = trackingLabel
return nil
})
}
func SetResourceOverridesSplitKeys(overrides map[string]v1alpha1.ResourceOverride) {
updateSettingConfigMap(func(cm *corev1.ConfigMap) error {
for k, v := range overrides {
if v.HealthLua != "" {
cm.Data[getResourceOverrideSplitKey(k, "health")] = v.HealthLua
}
cm.Data[getResourceOverrideSplitKey(k, "useOpenLibs")] = strconv.FormatBool(v.UseOpenLibs)
if v.Actions != "" {
cm.Data[getResourceOverrideSplitKey(k, "actions")] = v.Actions
}
if len(v.IgnoreDifferences.JSONPointers) > 0 ||
len(v.IgnoreDifferences.JQPathExpressions) > 0 ||
len(v.IgnoreDifferences.ManagedFieldsManagers) > 0 {
yamlBytes, err := yaml.Marshal(v.IgnoreDifferences)
if err != nil {
return err
}
cm.Data[getResourceOverrideSplitKey(k, "ignoreDifferences")] = string(yamlBytes)
}
if len(v.KnownTypeFields) > 0 {
yamlBytes, err := yaml.Marshal(v.KnownTypeFields)
if err != nil {
return err
}
cm.Data[getResourceOverrideSplitKey(k, "knownTypeFields")] = string(yamlBytes)
}
}
return nil
})
}
func getResourceOverrideSplitKey(key string, customizeType string) string {
groupKind := key
parts := strings.Split(key, "/")
if len(parts) == 2 {
groupKind = fmt.Sprintf("%s_%s", parts[0], parts[1])
}
return fmt.Sprintf("resource.customizations.%s.%s", customizeType, groupKind)
}
func SetAccounts(accounts map[string][]string) {
updateSettingConfigMap(func(cm *corev1.ConfigMap) error {
for k, v := range accounts {
cm.Data[fmt.Sprintf("accounts.%s", k)] = strings.Join(v, ",")
}
return nil
})
}
func SetPermissions(permissions []ACL, username string, roleName string) {
updateRBACConfigMap(func(cm *corev1.ConfigMap) error {
var aclstr string
for _, permission := range permissions {
aclstr += fmt.Sprintf("p, role:%s, %s, %s, %s, allow \n", roleName, permission.Resource, permission.Action, permission.Scope)
}
aclstr += fmt.Sprintf("g, %s, role:%s", username, roleName)
cm.Data["policy.csv"] = aclstr
return nil
})
}
func SetResourceFilter(filters settings.ResourcesFilter) {
updateSettingConfigMap(func(cm *corev1.ConfigMap) error {
exclusions, err := yaml.Marshal(filters.ResourceExclusions)
if err != nil {
return err
}
inclusions, err := yaml.Marshal(filters.ResourceInclusions)
if err != nil {
return err
}
cm.Data["resource.exclusions"] = string(exclusions)
cm.Data["resource.inclusions"] = string(inclusions)
return nil
})
}
func SetHelmRepos(repos ...settings.HelmRepoCredentials) {
updateSettingConfigMap(func(cm *corev1.ConfigMap) error {
yamlBytes, err := yaml.Marshal(repos)
if err != nil {
return err
}
cm.Data["helm.repositories"] = string(yamlBytes)
return nil
})
}
func SetRepos(repos ...settings.RepositoryCredentials) {
updateSettingConfigMap(func(cm *corev1.ConfigMap) error {
yamlBytes, err := yaml.Marshal(repos)
if err != nil {
return err
}
cm.Data["repositories"] = string(yamlBytes)
return nil
})
}
func SetProjectSpec(project string, spec v1alpha1.AppProjectSpec) {
proj, err := AppClientset.ArgoprojV1alpha1().AppProjects(TestNamespace()).Get(context.Background(), project, v1.GetOptions{})
errors.CheckError(err)
proj.Spec = spec
_, err = AppClientset.ArgoprojV1alpha1().AppProjects(TestNamespace()).Update(context.Background(), proj, v1.UpdateOptions{})
errors.CheckError(err)
}
func SetParamInSettingConfigMap(key, value string) {
updateSettingConfigMap(func(cm *corev1.ConfigMap) error {
cm.Data[key] = value
return nil
})
}
func SetParamInNotificationsConfigMap(key, value string) {
updateNotificationsConfigMap(func(cm *corev1.ConfigMap) error {
cm.Data[key] = value
return nil
})
}
type TestOption func(option *testOption)
type testOption struct {
testdata string
}
func newTestOption(opts ...TestOption) *testOption {
to := &testOption{
testdata: "testdata",
}
for _, opt := range opts {
opt(to)
}
return to
}
func WithTestData(testdata string) TestOption {
return func(option *testOption) {
option.testdata = testdata
}
}
func EnsureCleanState(t *testing.T, opts ...TestOption) {
opt := newTestOption(opts...)
// In large scenarios, we can skip tests that already run
SkipIfAlreadyRun(t)
// Register this test after it has been run & was successfull
t.Cleanup(func() {
RecordTestRun(t)
})
start := time.Now()
policy := v1.DeletePropagationBackground
// delete resources
// kubectl delete apps --all
CheckError(AppClientset.ArgoprojV1alpha1().Applications(TestNamespace()).DeleteCollection(context.Background(), v1.DeleteOptions{PropagationPolicy: &policy}, v1.ListOptions{}))
CheckError(AppClientset.ArgoprojV1alpha1().Applications(AppNamespace()).DeleteCollection(context.Background(), v1.DeleteOptions{PropagationPolicy: &policy}, v1.ListOptions{}))
// kubectl delete appprojects --field-selector metadata.name!=default
CheckError(AppClientset.ArgoprojV1alpha1().AppProjects(TestNamespace()).DeleteCollection(context.Background(),
v1.DeleteOptions{PropagationPolicy: &policy}, v1.ListOptions{FieldSelector: "metadata.name!=default"}))
// kubectl delete secrets -l argocd.argoproj.io/secret-type=repo-config
CheckError(KubeClientset.CoreV1().Secrets(TestNamespace()).DeleteCollection(context.Background(),
v1.DeleteOptions{PropagationPolicy: &policy}, v1.ListOptions{LabelSelector: common.LabelKeySecretType + "=" + common.LabelValueSecretTypeRepository}))
// kubectl delete secrets -l argocd.argoproj.io/secret-type=repo-creds
CheckError(KubeClientset.CoreV1().Secrets(TestNamespace()).DeleteCollection(context.Background(),
v1.DeleteOptions{PropagationPolicy: &policy}, v1.ListOptions{LabelSelector: common.LabelKeySecretType + "=" + common.LabelValueSecretTypeRepoCreds}))
// kubectl delete secrets -l argocd.argoproj.io/secret-type=cluster
CheckError(KubeClientset.CoreV1().Secrets(TestNamespace()).DeleteCollection(context.Background(),
v1.DeleteOptions{PropagationPolicy: &policy}, v1.ListOptions{LabelSelector: common.LabelKeySecretType + "=" + common.LabelValueSecretTypeCluster}))
// kubectl delete secrets -l e2e.argoproj.io=true
CheckError(KubeClientset.CoreV1().Secrets(TestNamespace()).DeleteCollection(context.Background(),
v1.DeleteOptions{PropagationPolicy: &policy}, v1.ListOptions{LabelSelector: TestingLabel + "=true"}))
FailOnErr(Run("", "kubectl", "delete", "ns", "-l", TestingLabel+"=true", "--field-selector", "status.phase=Active", "--wait=false"))
FailOnErr(Run("", "kubectl", "delete", "crd", "-l", TestingLabel+"=true", "--wait=false"))
FailOnErr(Run("", "kubectl", "delete", "clusterroles", "-l", TestingLabel+"=true", "--wait=false"))
// reset settings
updateSettingConfigMap(func(cm *corev1.ConfigMap) error {
cm.Data = map[string]string{}
return nil
})
updateNotificationsConfigMap(func(cm *corev1.ConfigMap) error {
cm.Data = map[string]string{}
return nil
})
// reset rbac
updateRBACConfigMap(func(cm *corev1.ConfigMap) error {
cm.Data = map[string]string{}
return nil
})
// We can switch user and as result in previous state we will have non-admin user, this case should be reset
LoginAs(adminUsername)
// reset gpg-keys config map
updateGenericConfigMap(common.ArgoCDGPGKeysConfigMapName, func(cm *corev1.ConfigMap) error {
cm.Data = map[string]string{}
return nil
})
SetProjectSpec("default", v1alpha1.AppProjectSpec{
OrphanedResources: nil,
SourceRepos: []string{"*"},
Destinations: []v1alpha1.ApplicationDestination{{Namespace: "*", Server: "*"}},
ClusterResourceWhitelist: []v1.GroupKind{{Group: "*", Kind: "*"}},
SourceNamespaces: []string{AppNamespace()},
})
// Create separate project for testing gpg signature verification
FailOnErr(RunCli("proj", "create", "gpg"))
SetProjectSpec("gpg", v1alpha1.AppProjectSpec{
OrphanedResources: nil,
SourceRepos: []string{"*"},
Destinations: []v1alpha1.ApplicationDestination{{Namespace: "*", Server: "*"}},
ClusterResourceWhitelist: []v1.GroupKind{{Group: "*", Kind: "*"}},
SignatureKeys: []v1alpha1.SignatureKey{{KeyID: GpgGoodKeyID}},
SourceNamespaces: []string{AppNamespace()},
})
// Recreate temp dir
CheckError(os.RemoveAll(TmpDir))
FailOnErr(Run("", "mkdir", "-p", TmpDir))
// random id - unique across test runs
randString, err := rand.String(5)
CheckError(err)
postFix := "-" + strings.ToLower(randString)
id = t.Name() + postFix
name = DnsFriendly(t.Name(), "")
deploymentNamespace = DnsFriendly(fmt.Sprintf("argocd-e2e-%s", t.Name()), postFix)
// create TLS and SSH certificate directories
if IsLocal() {
FailOnErr(Run("", "mkdir", "-p", TmpDir+"/app/config/tls"))
FailOnErr(Run("", "mkdir", "-p", TmpDir+"/app/config/ssh"))
}
// For signing during the tests
FailOnErr(Run("", "mkdir", "-p", TmpDir+"/gpg"))
FailOnErr(Run("", "chmod", "0700", TmpDir+"/gpg"))
prevGnuPGHome := os.Getenv("GNUPGHOME")
os.Setenv("GNUPGHOME", TmpDir+"/gpg")
// nolint:errcheck
Run("", "pkill", "-9", "gpg-agent")
FailOnErr(Run("", "gpg", "--import", "../fixture/gpg/signingkey.asc"))
os.Setenv("GNUPGHOME", prevGnuPGHome)
// recreate GPG directories
if IsLocal() {
FailOnErr(Run("", "mkdir", "-p", TmpDir+"/app/config/gpg/source"))
FailOnErr(Run("", "mkdir", "-p", TmpDir+"/app/config/gpg/keys"))
FailOnErr(Run("", "chmod", "0700", TmpDir+"/app/config/gpg/keys"))
FailOnErr(Run("", "mkdir", "-p", TmpDir+PluginSockFilePath))
FailOnErr(Run("", "chmod", "0700", TmpDir+PluginSockFilePath))
}
// set-up tmp repo, must have unique name
FailOnErr(Run("", "cp", "-Rf", opt.testdata, repoDirectory()))
FailOnErr(Run(repoDirectory(), "chmod", "777", "."))
FailOnErr(Run(repoDirectory(), "git", "init"))
FailOnErr(Run(repoDirectory(), "git", "add", "."))
FailOnErr(Run(repoDirectory(), "git", "commit", "-q", "-m", "initial commit"))
if IsRemote() {
FailOnErr(Run(repoDirectory(), "git", "remote", "add", "origin", os.Getenv("ARGOCD_E2E_GIT_SERVICE")))
FailOnErr(Run(repoDirectory(), "git", "push", "origin", "master", "-f"))
}
// create namespace
FailOnErr(Run("", "kubectl", "create", "ns", DeploymentNamespace()))
FailOnErr(Run("", "kubectl", "label", "ns", DeploymentNamespace(), TestingLabel+"=true"))
// delete old namespaces used by E2E tests
namespaces, err := KubeClientset.CoreV1().Namespaces().List(context.Background(), v1.ListOptions{})
CheckError(err)
for _, namespace := range namespaces.Items {
if strings.HasPrefix(namespace.Name, E2ETestPrefix) {
FailOnErr(Run("", "kubectl", "delete", "ns", namespace.Name))
}
}
// delete old ClusterRoles that begin with "e2e-test-" prefix (E2ETestPrefix), which were created by tests
clusterRoles, err := KubeClientset.RbacV1().ClusterRoles().List(context.Background(), v1.ListOptions{})
CheckError(err)
for _, clusterRole := range clusterRoles.Items {
if strings.HasPrefix(clusterRole.Name, E2ETestPrefix) {
FailOnErr(Run("", "kubectl", "delete", "clusterrole", clusterRole.Name))
}
}
// delete old ClusterRoleBindings that begin with "e2e-test-prefix", which were created by E2E tests
clusterRoleBindings, err := KubeClientset.RbacV1().ClusterRoleBindings().List(context.Background(), v1.ListOptions{})
CheckError(err)
for _, clusterRoleBinding := range clusterRoleBindings.Items {
if strings.HasPrefix(clusterRoleBinding.Name, E2ETestPrefix) {
FailOnErr(Run("", "kubectl", "delete", "clusterrolebinding", clusterRoleBinding.Name))
}
}
log.WithFields(log.Fields{"duration": time.Since(start), "name": t.Name(), "id": id, "username": "admin", "password": "password"}).Info("clean state")
}
func RunCliWithRetry(maxRetries int, args ...string) (string, error) {
var out string
var err error
for i := 0; i < maxRetries; i++ {
out, err = RunCli(args...)
if err == nil {
break
}
time.Sleep(time.Second)
}
return out, err
}
func RunCli(args ...string) (string, error) {
return RunCliWithStdin("", args...)
}
func RunCliWithStdin(stdin string, args ...string) (string, error) {
if plainText {
args = append(args, "--plaintext")
}
args = append(args, "--server", apiServerAddress, "--auth-token", token, "--insecure")
return RunWithStdin(stdin, "", "../../dist/argocd", args...)
}
func Patch(path string, jsonPatch string) {
log.WithFields(log.Fields{"path": path, "jsonPatch": jsonPatch}).Info("patching")
filename := filepath.Join(repoDirectory(), path)
bytes, err := os.ReadFile(filename)
CheckError(err)
patch, err := jsonpatch.DecodePatch([]byte(jsonPatch))
CheckError(err)
isYaml := strings.HasSuffix(filename, ".yaml")
if isYaml {
log.Info("converting YAML to JSON")
bytes, err = yaml.YAMLToJSON(bytes)
CheckError(err)
}
log.WithFields(log.Fields{"bytes": string(bytes)}).Info("JSON")
bytes, err = patch.Apply(bytes)
CheckError(err)
if isYaml {
log.Info("converting JSON back to YAML")
bytes, err = yaml.JSONToYAML(bytes)
CheckError(err)
}
CheckError(os.WriteFile(filename, bytes, 0644))
FailOnErr(Run(repoDirectory(), "git", "diff"))
FailOnErr(Run(repoDirectory(), "git", "commit", "-am", "patch"))
if IsRemote() {
FailOnErr(Run(repoDirectory(), "git", "push", "-f", "origin", "master"))
}
}
func Delete(path string) {
log.WithFields(log.Fields{"path": path}).Info("deleting")
CheckError(os.Remove(filepath.Join(repoDirectory(), path)))
FailOnErr(Run(repoDirectory(), "git", "diff"))
FailOnErr(Run(repoDirectory(), "git", "commit", "-am", "delete"))
if IsRemote() {
FailOnErr(Run(repoDirectory(), "git", "push", "-f", "origin", "master"))
}
}
func WriteFile(path, contents string) {
log.WithFields(log.Fields{"path": path}).Info("adding")
CheckError(os.WriteFile(filepath.Join(repoDirectory(), path), []byte(contents), 0644))
}
func AddFile(path, contents string) {
WriteFile(path, contents)
FailOnErr(Run(repoDirectory(), "git", "diff"))
FailOnErr(Run(repoDirectory(), "git", "add", "."))
FailOnErr(Run(repoDirectory(), "git", "commit", "-am", "add file"))
if IsRemote() {
FailOnErr(Run(repoDirectory(), "git", "push", "-f", "origin", "master"))
}
}
func AddSignedFile(path, contents string) {
WriteFile(path, contents)
prevGnuPGHome := os.Getenv("GNUPGHOME")
os.Setenv("GNUPGHOME", TmpDir+"/gpg")
FailOnErr(Run(repoDirectory(), "git", "diff"))
FailOnErr(Run(repoDirectory(), "git", "add", "."))
FailOnErr(Run(repoDirectory(), "git", "-c", fmt.Sprintf("user.signingkey=%s", GpgGoodKeyID), "commit", "-S", "-am", "add file"))
os.Setenv("GNUPGHOME", prevGnuPGHome)
if IsRemote() {
FailOnErr(Run(repoDirectory(), "git", "push", "-f", "origin", "master"))
}
}
func AddSignedTag(name string) {
prevGnuPGHome := os.Getenv("GNUPGHOME")
os.Setenv("GNUPGHOME", TmpDir+"/gpg")
defer os.Setenv("GNUPGHOME", prevGnuPGHome)
FailOnErr(Run(repoDirectory(), "git", "-c", fmt.Sprintf("user.signingkey=%s", GpgGoodKeyID), "tag", "-sm", "add signed tag", name))
if IsRemote() {
FailOnErr(Run(repoDirectory(), "git", "push", "--tags", "-f", "origin", "master"))
}
}
func AddTag(name string) {
prevGnuPGHome := os.Getenv("GNUPGHOME")
os.Setenv("GNUPGHOME", TmpDir+"/gpg")
defer os.Setenv("GNUPGHOME", prevGnuPGHome)
FailOnErr(Run(repoDirectory(), "git", "tag", name))
if IsRemote() {
FailOnErr(Run(repoDirectory(), "git", "push", "--tags", "-f", "origin", "master"))
}
}
// create the resource by creating using "kubectl apply", with bonus templating
func Declarative(filename string, values interface{}) (string, error) {
bytes, err := os.ReadFile(path.Join("testdata", filename))
CheckError(err)
tmpFile, err := os.CreateTemp("", "")
CheckError(err)
_, err = tmpFile.WriteString(Tmpl(string(bytes), values))
CheckError(err)
defer tmpFile.Close()
return Run("", "kubectl", "-n", TestNamespace(), "apply", "-f", tmpFile.Name())
}
func CreateSubmoduleRepos(repoType string) {
oldEnv := os.Getenv("GIT_ALLOW_PROTOCOL")
CheckError(os.Setenv("GIT_ALLOW_PROTOCOL", "file"))
// set-up submodule repo
FailOnErr(Run("", "cp", "-Rf", "testdata/git-submodule/", submoduleDirectory()))
FailOnErr(Run(submoduleDirectory(), "chmod", "777", "."))
FailOnErr(Run(submoduleDirectory(), "git", "init"))
FailOnErr(Run(submoduleDirectory(), "git", "add", "."))
FailOnErr(Run(submoduleDirectory(), "git", "commit", "-q", "-m", "initial commit"))
if IsRemote() {
FailOnErr(Run(submoduleDirectory(), "git", "remote", "add", "origin", os.Getenv("ARGOCD_E2E_GIT_SERVICE_SUBMODULE")))
FailOnErr(Run(submoduleDirectory(), "git", "push", "origin", "master", "-f"))
}
// set-up submodule parent repo
FailOnErr(Run("", "mkdir", submoduleParentDirectory()))
FailOnErr(Run(submoduleParentDirectory(), "chmod", "777", "."))
FailOnErr(Run(submoduleParentDirectory(), "git", "init"))
FailOnErr(Run(submoduleParentDirectory(), "git", "add", "."))
FailOnErr(Run(submoduleParentDirectory(), "git", "submodule", "add", "-b", "master", "../submodule.git", "submodule/test"))
if repoType == "ssh" {
FailOnErr(Run(submoduleParentDirectory(), "git", "config", "--file=.gitmodules", "submodule.submodule/test.url", RepoURL(RepoURLTypeSSHSubmodule)))
} else if repoType == "https" {
FailOnErr(Run(submoduleParentDirectory(), "git", "config", "--file=.gitmodules", "submodule.submodule/test.url", RepoURL(RepoURLTypeHTTPSSubmodule)))
}
FailOnErr(Run(submoduleParentDirectory(), "git", "add", "--all"))
FailOnErr(Run(submoduleParentDirectory(), "git", "commit", "-q", "-m", "commit with submodule"))
if IsRemote() {
FailOnErr(Run(submoduleParentDirectory(), "git", "remote", "add", "origin", os.Getenv("ARGOCD_E2E_GIT_SERVICE_SUBMODULE_PARENT")))
FailOnErr(Run(submoduleParentDirectory(), "git", "push", "origin", "master", "-f"))
}
CheckError(os.Setenv("GIT_ALLOW_PROTOCOL", oldEnv))
}
func RemoveSubmodule() {
log.Info("removing submodule")
FailOnErr(Run(submoduleParentDirectory(), "git", "rm", "submodule/test"))
FailOnErr(Run(submoduleParentDirectory(), "touch", "submodule/.gitkeep"))
FailOnErr(Run(submoduleParentDirectory(), "git", "add", "submodule/.gitkeep"))
FailOnErr(Run(submoduleParentDirectory(), "git", "commit", "-m", "remove submodule"))
if IsRemote() {
FailOnErr(Run(submoduleParentDirectory(), "git", "push", "-f", "origin", "master"))
}
}
// RestartRepoServer performs a restart of the repo server deployment and waits
// until the rollout has completed.
func RestartRepoServer() {
if IsRemote() {
log.Infof("Waiting for repo server to restart")
prefix := os.Getenv("ARGOCD_E2E_NAME_PREFIX")
workload := "argocd-repo-server"
if prefix != "" {
workload = prefix + "-repo-server"
}
FailOnErr(Run("", "kubectl", "rollout", "restart", "deployment", workload))
FailOnErr(Run("", "kubectl", "rollout", "status", "deployment", workload))
// wait longer to avoid error on s390x
time.Sleep(10 * time.Second)
}
}
// RestartAPIServer performs a restart of the API server deployemt and waits
// until the rollout has completed.
func RestartAPIServer() {
if IsRemote() {
log.Infof("Waiting for API server to restart")
prefix := os.Getenv("ARGOCD_E2E_NAME_PREFIX")
workload := "argocd-server"
if prefix != "" {
workload = prefix + "-server"
}
FailOnErr(Run("", "kubectl", "rollout", "restart", "deployment", workload))
FailOnErr(Run("", "kubectl", "rollout", "status", "deployment", workload))
}
}
// LocalOrRemotePath selects a path for a given application based on whether
// tests are running local or remote.
func LocalOrRemotePath(base string) string {
if IsRemote() {
return base + "/remote"
} else {
return base + "/local"
}
}
// SkipOnEnv allows to skip a test when a given environment variable is set.
// Environment variable names follow the ARGOCD_E2E_SKIP_<suffix> pattern,
// and must be set to the string value 'true' in order to skip a test.
func SkipOnEnv(t *testing.T, suffixes ...string) {
for _, suffix := range suffixes {
e := os.Getenv("ARGOCD_E2E_SKIP_" + suffix)
if e == "true" {
t.Skip()
}
}
}
// SkipIfAlreadyRun skips a test if it has been already run by a previous
// test cycle and was recorded.
func SkipIfAlreadyRun(t *testing.T) {
if _, ok := testsRun[t.Name()]; ok {
t.Skip()
}
}
// RecordTestRun records a test that has been run successfully to a text file,
// so that it can be automatically skipped if requested.
func RecordTestRun(t *testing.T) {
if t.Skipped() || t.Failed() {
return
}
rf := os.Getenv("ARGOCD_E2E_RECORD")
if rf == "" {
return
}
log.Infof("Registering test execution at %s", rf)
f, err := os.OpenFile(rf, os.O_APPEND|os.O_CREATE|os.O_WRONLY, 0644)
if err != nil {
t.Fatalf("could not open record file %s: %v", rf, err)