github.com/1aal/kubeblocks@v0.0.0-20231107070852-e1c03e598921/pkg/controller/component/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 component
    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  	snapshotv1 "github.com/kubernetes-csi/external-snapshotter/client/v6/apis/volumesnapshot/v1"
    32  	"go.uber.org/zap/zapcore"
    33  	"k8s.io/client-go/kubernetes/scheme"
    34  	"k8s.io/client-go/rest"
    35  	ctrl "sigs.k8s.io/controller-runtime"
    36  	"sigs.k8s.io/controller-runtime/pkg/client"
    37  	"sigs.k8s.io/controller-runtime/pkg/envtest"
    38  	logf "sigs.k8s.io/controller-runtime/pkg/log"
    39  	"sigs.k8s.io/controller-runtime/pkg/log/zap"
    40  
    41  	appsv1alpha1 "github.com/1aal/kubeblocks/apis/apps/v1alpha1"
    42  	dpv1alpha1 "github.com/1aal/kubeblocks/apis/dataprotection/v1alpha1"
    43  	intctrlutil "github.com/1aal/kubeblocks/pkg/controllerutil"
    44  	"github.com/1aal/kubeblocks/pkg/testutil"
    45  	viper "github.com/1aal/kubeblocks/pkg/viperx"
    46  )
    47  
    48  // These tests use Ginkgo (BDD-style Go testing framework). Refer to
    49  // http://onsi.github.io/ginkgo/ to learn more about Ginkgo.
    50  
    51  var cfg *rest.Config
    52  var k8sClient client.Client
    53  var testEnv *envtest.Environment
    54  var ctx context.Context
    55  var cancel context.CancelFunc
    56  var testCtx testutil.TestContext
    57  var logger logr.Logger
    58  
    59  func init() {
    60  	viper.AutomaticEnv()
    61  	// viper.Set("ENABLE_DEBUG_LOG", "true")
    62  }
    63  
    64  func TestAPIs(t *testing.T) {
    65  	RegisterFailHandler(Fail)
    66  
    67  	RunSpecs(t, "Controller Suite")
    68  }
    69  
    70  var _ = BeforeSuite(func() {
    71  	if viper.GetBool("ENABLE_DEBUG_LOG") {
    72  		logf.SetLogger(zap.New(zap.WriteTo(GinkgoWriter), zap.UseDevMode(true), func(o *zap.Options) {
    73  			o.TimeEncoder = zapcore.ISO8601TimeEncoder
    74  		}))
    75  	}
    76  
    77  	ctx, cancel = context.WithCancel(context.TODO())
    78  	logger = logf.FromContext(ctx).WithValues()
    79  	logger.Info("logger start")
    80  
    81  	By("bootstrapping test environment")
    82  	testEnv = &envtest.Environment{
    83  		CRDDirectoryPaths: []string{
    84  			filepath.Join("..", "..", "..", "config", "crd", "bases"),
    85  			// use dependent external CRDs.
    86  			// resolved by ref: https://github.com/operator-framework/operator-sdk/issues/4434#issuecomment-786794418
    87  			// filepath.Join(build.Default.GOPATH, "pkg", "mod", "github.com", "kubernetes-csi/external-snapshotter/",
    88  			//	"client/v6@v6.2.0", "config", "crd"),
    89  		},
    90  		ErrorIfCRDPathMissing: true,
    91  	}
    92  
    93  	var err error
    94  	// cfg is defined in this file globally.
    95  	cfg, err = testEnv.Start()
    96  	Expect(err).NotTo(HaveOccurred())
    97  	Expect(cfg).NotTo(BeNil())
    98  
    99  	err = appsv1alpha1.AddToScheme(scheme.Scheme)
   100  	Expect(err).NotTo(HaveOccurred())
   101  
   102  	err = dpv1alpha1.AddToScheme(scheme.Scheme)
   103  	Expect(err).NotTo(HaveOccurred())
   104  
   105  	err = snapshotv1.AddToScheme(scheme.Scheme)
   106  	Expect(err).NotTo(HaveOccurred())
   107  
   108  	// +kubebuilder:scaffold:scheme
   109  
   110  	k8sClient, err = client.New(cfg, client.Options{Scheme: scheme.Scheme})
   111  	Expect(err).NotTo(HaveOccurred())
   112  	Expect(k8sClient).NotTo(BeNil())
   113  
   114  	// run reconcile
   115  	k8sManager, err := ctrl.NewManager(cfg, ctrl.Options{
   116  		Scheme:                scheme.Scheme,
   117  		MetricsBindAddress:    "0",
   118  		ClientDisableCacheFor: intctrlutil.GetUncachedObjects(),
   119  	})
   120  	Expect(err).ToNot(HaveOccurred())
   121  
   122  	testCtx = testutil.NewDefaultTestContext(ctx, k8sClient, testEnv)
   123  
   124  	go func() {
   125  		defer GinkgoRecover()
   126  		err = k8sManager.Start(ctx)
   127  		Expect(err).ToNot(HaveOccurred(), "failed to run manager")
   128  	}()
   129  })
   130  
   131  var _ = AfterSuite(func() {
   132  	cancel()
   133  	By("tearing down the test environment")
   134  	err := testEnv.Stop()
   135  	Expect(err).NotTo(HaveOccurred())
   136  })