/* Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. */ package externalsecret import ( "context" "path/filepath" "testing" "time" "go.uber.org/zap/zapcore" v1 "k8s.io/api/core/v1" "k8s.io/client-go/kubernetes/scheme" "k8s.io/client-go/rest" ctrl "sigs.k8s.io/controller-runtime" "sigs.k8s.io/controller-runtime/pkg/client" "sigs.k8s.io/controller-runtime/pkg/controller" "sigs.k8s.io/controller-runtime/pkg/envtest" logf "sigs.k8s.io/controller-runtime/pkg/log" "sigs.k8s.io/controller-runtime/pkg/log/zap" "sigs.k8s.io/controller-runtime/pkg/metrics/server" esv1beta1 "github.com/external-secrets/external-secrets/apis/externalsecrets/v1beta1" genv1alpha1 "github.com/external-secrets/external-secrets/apis/generators/v1alpha1" ctrlcommon "github.com/external-secrets/external-secrets/pkg/controllers/common" . "github.com/onsi/ginkgo/v2" . "github.com/onsi/gomega" ) // These tests use Ginkgo (BDD-style Go testing framework). Refer to // http://onsi.github.io/ginkgo/ to learn more about Ginkgo. var cfg *rest.Config var k8sClient client.Client var testEnv *envtest.Environment var cancel context.CancelFunc func TestAPIs(t *testing.T) { RegisterFailHandler(Fail) RunSpecs(t, "Controller Suite") } var _ = BeforeSuite(func() { log := zap.New(zap.WriteTo(GinkgoWriter), zap.Level(zapcore.DebugLevel)) logf.SetLogger(log) By("bootstrapping test environment") testEnv = &envtest.Environment{ CRDDirectoryPaths: []string{filepath.Join("..", "..", "..", "deploy", "crds")}, } var ctx context.Context ctx, cancel = context.WithCancel(context.Background()) var err error cfg, err = testEnv.Start() Expect(err).ToNot(HaveOccurred()) Expect(cfg).ToNot(BeNil()) err = esv1beta1.AddToScheme(scheme.Scheme) Expect(err).NotTo(HaveOccurred()) err = genv1alpha1.AddToScheme(scheme.Scheme) Expect(err).NotTo(HaveOccurred()) k8sManager, err := ctrl.NewManager(cfg, ctrl.Options{ Scheme: scheme.Scheme, Metrics: server.Options{ BindAddress: "0", // avoid port collision when testing }, Client: client.Options{ Cache: &client.CacheOptions{ // the client creates a ListWatch for resources that are requested with .Get() or .List() // we disable caching in the production code, so we disable it here as well for consistency // see: https://github.com/external-secrets/external-secrets/issues/721 DisableFor: []client.Object{ &v1.Secret{}, &v1.ConfigMap{}, }, }, }, }) Expect(err).ToNot(HaveOccurred()) // do not use k8sManager.GetClient() // see https://github.com/kubernetes-sigs/controller-runtime/issues/343#issuecomment-469435686 k8sClient, err = client.New(cfg, client.Options{Scheme: scheme.Scheme}) Expect(k8sClient).ToNot(BeNil()) Expect(err).ToNot(HaveOccurred()) // by default, we use a separate cached client for secrets that are managed by the controller // so we should test under the same conditions secretClient, err := ctrlcommon.BuildManagedSecretClient(k8sManager) Expect(err).ToNot(HaveOccurred()) err = (&Reconciler{ Client: k8sManager.GetClient(), SecretClient: secretClient, RestConfig: cfg, Scheme: k8sManager.GetScheme(), Log: ctrl.Log.WithName("controllers").WithName("ExternalSecrets"), RequeueInterval: time.Second, ClusterSecretStoreEnabled: true, }).SetupWithManager(k8sManager, controller.Options{ MaxConcurrentReconciles: 1, RateLimiter: ctrlcommon.BuildRateLimiter(), }) Expect(err).ToNot(HaveOccurred()) go func() { defer GinkgoRecover() Expect(k8sManager.Start(ctx)).ToNot(HaveOccurred()) }() }) var _ = AfterSuite(func() { By("tearing down the test environment") cancel() // stop manager err := (func() (err error) { // Need to sleep if the first stop fails due to a bug: // https://github.com/kubernetes-sigs/controller-runtime/issues/1571 sleepTime := 1 * time.Millisecond for i := 0; i < 12; i++ { // Exponentially sleep up to ~4s if err = testEnv.Stop(); err == nil { return } sleepTime *= 2 time.Sleep(sleepTime) } return })() Expect(err).NotTo(HaveOccurred()) })