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