github.com/1aal/kubeblocks@v0.0.0-20231107070852-e1c03e598921/controllers/apps/components/suite_test.go (about)

     1  /*
     2  Copyright (C) 2022-2023 ApeCloud Co., Ltd
     3  
     4  This file is part of KubeBlocks project
     5  
     6  This program is free software: you can redistribute it and/or modify
     7  it under the terms of the GNU Affero General Public License as published by
     8  the Free Software Foundation, either version 3 of the License, or
     9  (at your option) any later version.
    10  
    11  This program is distributed in the hope that it will be useful
    12  but WITHOUT ANY WARRANTY; without even the implied warranty of
    13  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    14  GNU Affero General Public License for more details.
    15  
    16  You should have received a copy of the GNU Affero General Public License
    17  along with this program.  If not, see <http://www.gnu.org/licenses/>.
    18  */
    19  
    20  package components
    21  
    22  import (
    23  	"context"
    24  	"path/filepath"
    25  	"testing"
    26  
    27  	. "github.com/onsi/ginkgo/v2"
    28  	. "github.com/onsi/gomega"
    29  
    30  	"github.com/go-logr/logr"
    31  	"go.uber.org/zap/zapcore"
    32  	corev1 "k8s.io/api/core/v1"
    33  	"k8s.io/client-go/kubernetes/scheme"
    34  	"k8s.io/client-go/rest"
    35  	"k8s.io/client-go/tools/record"
    36  	ctrl "sigs.k8s.io/controller-runtime"
    37  	"sigs.k8s.io/controller-runtime/pkg/client"
    38  	"sigs.k8s.io/controller-runtime/pkg/envtest"
    39  	logf "sigs.k8s.io/controller-runtime/pkg/log"
    40  	"sigs.k8s.io/controller-runtime/pkg/log/zap"
    41  
    42  	snapshotv1 "github.com/kubernetes-csi/external-snapshotter/client/v6/apis/volumesnapshot/v1"
    43  
    44  	appsv1alpha1 "github.com/1aal/kubeblocks/apis/apps/v1alpha1"
    45  	dpv1alpha1 "github.com/1aal/kubeblocks/apis/dataprotection/v1alpha1"
    46  	workloads "github.com/1aal/kubeblocks/apis/workloads/v1alpha1"
    47  	intctrlutil "github.com/1aal/kubeblocks/pkg/controllerutil"
    48  	"github.com/1aal/kubeblocks/pkg/testutil"
    49  	viper "github.com/1aal/kubeblocks/pkg/viperx"
    50  )
    51  
    52  // These tests use Ginkgo (BDD-style Go testing framework). Refer to
    53  // http://onsi.github.io/ginkgo/ to learn more about Ginkgo.
    54  
    55  var cfg *rest.Config
    56  var k8sClient client.Client
    57  var testEnv *envtest.Environment
    58  var ctx context.Context
    59  var cancel context.CancelFunc
    60  var testCtx testutil.TestContext
    61  var logger logr.Logger
    62  var recorder record.EventRecorder
    63  
    64  func init() {
    65  	viper.AutomaticEnv()
    66  }
    67  
    68  func TestAPIs(t *testing.T) {
    69  	RegisterFailHandler(Fail)
    70  
    71  	RunSpecs(t, "Component Controller Suite")
    72  }
    73  
    74  var _ = BeforeSuite(func() {
    75  	if viper.GetBool("ENABLE_DEBUG_LOG") {
    76  		logf.SetLogger(zap.New(zap.WriteTo(GinkgoWriter), zap.UseDevMode(true), func(o *zap.Options) {
    77  			o.TimeEncoder = zapcore.ISO8601TimeEncoder
    78  		}))
    79  	}
    80  
    81  	ctx, cancel = context.WithCancel(context.TODO())
    82  	logger = logf.FromContext(ctx).WithValues()
    83  	logger.Info("logger start")
    84  
    85  	By("bootstrapping test environment")
    86  	testEnv = &envtest.Environment{
    87  		CRDDirectoryPaths:     []string{filepath.Join("..", "..", "..", "config", "crd", "bases")},
    88  		ErrorIfCRDPathMissing: true,
    89  	}
    90  
    91  	var err error
    92  	// cfg is defined in this file globally.
    93  	cfg, err = testEnv.Start()
    94  	Expect(err).NotTo(HaveOccurred())
    95  	Expect(cfg).NotTo(BeNil())
    96  
    97  	err = appsv1alpha1.AddToScheme(scheme.Scheme)
    98  	Expect(err).NotTo(HaveOccurred())
    99  
   100  	err = dpv1alpha1.AddToScheme(scheme.Scheme)
   101  	Expect(err).NotTo(HaveOccurred())
   102  
   103  	err = snapshotv1.AddToScheme(scheme.Scheme)
   104  	Expect(err).NotTo(HaveOccurred())
   105  
   106  	err = workloads.AddToScheme(scheme.Scheme)
   107  	Expect(err).NotTo(HaveOccurred())
   108  
   109  	err = corev1.AddToScheme(scheme.Scheme)
   110  	Expect(err).NotTo(HaveOccurred())
   111  
   112  	// +kubebuilder:scaffold:scheme
   113  
   114  	k8sClient, err = client.New(cfg, client.Options{Scheme: scheme.Scheme})
   115  	Expect(err).NotTo(HaveOccurred())
   116  	Expect(k8sClient).NotTo(BeNil())
   117  
   118  	// run reconcile
   119  	k8sManager, err := ctrl.NewManager(cfg, ctrl.Options{
   120  		Scheme:                scheme.Scheme,
   121  		MetricsBindAddress:    "0",
   122  		ClientDisableCacheFor: intctrlutil.GetUncachedObjects(),
   123  	})
   124  	Expect(err).ToNot(HaveOccurred())
   125  
   126  	recorder = k8sManager.GetEventRecorderFor("cluster-component")
   127  	testCtx = testutil.NewDefaultTestContext(ctx, k8sClient, testEnv)
   128  
   129  	go func() {
   130  		defer GinkgoRecover()
   131  		err = k8sManager.Start(ctx)
   132  		Expect(err).ToNot(HaveOccurred(), "failed to run manager")
   133  	}()
   134  })
   135  
   136  var _ = AfterSuite(func() {
   137  	cancel()
   138  	By("tearing down the test environment")
   139  	err := testEnv.Stop()
   140  	Expect(err).NotTo(HaveOccurred())
   141  })