Add base unit test suite for repository server controller(#PR1) (#2100)

* add base suite for repository server controller * use constants for location secret keys * make the constants local to the package * add licence headers * fix licence headers * fix lint issues * remove unused functions and move to next PR * fix build issues * move secret creation utils under test suite * add base suite for repository server controller * use constants for location secret keys * make the constants local to the package * add licence headers * fix licence headers * fix lint issues * remove unused functions and move to next PR * fix build issues * move secret creation utils under test suite * address review comments * move test utilities to pkg/testutil/testutil.go * rename kopia repository path constant name * move constants to const.go * move constants to const.go * initialize reconciler in a better way
kanisterio · Jul 4, 2023 · 3d13005 · 3d13005
1 parent 64595c9
commit 3d13005
Show file tree

Hide file tree

Showing 4 changed files with 301 additions and 72 deletions.
diff --git a/pkg/controllers/repositoryserver/repositoryserver_controller_test.go b/pkg/controllers/repositoryserver/repositoryserver_controller_test.go
@@ -0,0 +1,157 @@
+// Copyright 2023 The Kanister Authors.
+//
+// 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 repositoryserver
+
+import (
+	"context"
+	"testing"
+
+	. "gopkg.in/check.v1"
+	v1 "k8s.io/api/core/v1"
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+	"k8s.io/client-go/kubernetes"
+	"k8s.io/client-go/kubernetes/scheme"
+	ctrl "sigs.k8s.io/controller-runtime"
+
+	crclientv1alpha1 "github.com/kanisterio/kanister/pkg/client/clientset/versioned/typed/cr/v1alpha1"
+	"github.com/kanisterio/kanister/pkg/kube"
+	"github.com/kanisterio/kanister/pkg/resource"
+	"github.com/kanisterio/kanister/pkg/secrets"
+	reposerver "github.com/kanisterio/kanister/pkg/secrets/repositoryserver"
+	"github.com/kanisterio/kanister/pkg/testutil"
+)
+
+// Hook up gocheck into the "go test" runner.
+func Test(t *testing.T) { TestingT(t) }
+
+type RepoServerControllerSuite struct {
+	crCli                         crclientv1alpha1.CrV1alpha1Interface
+	kubeCli                       kubernetes.Interface
+	repoServerControllerNamespace string
+	repoServerSecrets             repositoryServerSecrets
+}
+
+var _ = Suite(&RepoServerControllerSuite{})
+
+func (s *RepoServerControllerSuite) SetUpSuite(c *C) {
+	config, err := kube.LoadConfig()
+	c.Assert(err, IsNil)
+	cli, err := kubernetes.NewForConfig(config)
+	c.Assert(err, IsNil)
+	crCli, err := crclientv1alpha1.NewForConfig(config)
+	c.Assert(err, IsNil)
+
+	// Make sure the CRDs exist.
+	err = resource.CreateCustomResources(context.Background(), config)
+	c.Assert(err, IsNil)
+	err = resource.CreateRepoServerCustomResource(context.Background(), config)
+	c.Assert(err, IsNil)
+
+	s.kubeCli = cli
+	s.crCli = crCli
+
+	mgr, err := ctrl.NewManager(ctrl.GetConfigOrDie(), ctrl.Options{
+		Scheme:             scheme.Scheme,
+		Port:               9443,
+		MetricsBindAddress: "0",
+	})
+	c.Assert(err, IsNil)
+
+	repoReconciler := &RepositoryServerReconciler{
+		Client: mgr.GetClient(),
+		Scheme: mgr.GetScheme(),
+	}
+
+	err = repoReconciler.SetupWithManager(mgr)
+	c.Assert(err, IsNil)
+
+	go func() {
+		err = mgr.Start(ctrl.SetupSignalHandler())
+		c.Assert(err, IsNil)
+	}()
+
+	ns := &v1.Namespace{
+		ObjectMeta: metav1.ObjectMeta{
+			GenerateName: "repositoryservercontrollertest-",
+		},
+	}
+	cns, err := s.kubeCli.CoreV1().Namespaces().Create(context.Background(), ns, metav1.CreateOptions{})
+	c.Assert(err, IsNil)
+	s.repoServerControllerNamespace = cns.Name
+	s.createRepositoryServerSecrets(c)
+}
+
+func (s *RepoServerControllerSuite) createRepositoryServerSecrets(c *C) {
+	kopiaTLSSecretData, err := testutil.GetKopiaTLSSecretData()
+	c.Assert(err, IsNil)
+
+	s.repoServerSecrets = repositoryServerSecrets{}
+	s.repoServerSecrets.serverUserAccess, err = s.CreateRepositoryServerUserAccessSecret(testutil.GetRepoServerUserAccessSecretData("localhost", testutil.KopiaRepositoryServerAccessPassword))
+	c.Assert(err, IsNil)
+
+	s.repoServerSecrets.serverAdmin, err = s.CreateRepositoryServerAdminSecret(testutil.GetRepoServerAdminSecretData(testutil.KopiaRepositoryServerAdminUser, testutil.KopiaRepositoryServerAdminPassword))
+	c.Assert(err, IsNil)
+
+	s.repoServerSecrets.repositoryPassword, err = s.CreateRepositoryPasswordSecret(testutil.GetRepoPasswordSecretData(testutil.KopiaRepositoryPassword))
+	c.Assert(err, IsNil)
+
+	s.repoServerSecrets.serverTLS, err = s.CreateKopiaTLSSecret(kopiaTLSSecretData)
+	c.Assert(err, IsNil)
+
+	s.repoServerSecrets.storage, err = s.CreateStorageLocationSecret(testutil.GetDefaultS3CompliantStorageLocation())
+	c.Assert(err, IsNil)
+
+	s.repoServerSecrets.storageCredentials, err = s.CreateAWSStorageCredentialsSecret(testutil.GetDefaultS3StorageCreds())
+	c.Assert(err, IsNil)
+}
+
+func (s *RepoServerControllerSuite) CreateRepositoryServerAdminSecret(data map[string][]byte) (se *v1.Secret, err error) {
+	return testutil.CreateSecret(s.kubeCli, s.repoServerControllerNamespace, "test-repository-server-admin-", reposerver.AdminCredentialsSecret, data)
+}
+
+func (s *RepoServerControllerSuite) CreateRepositoryServerUserAccessSecret(data map[string][]byte) (se *v1.Secret, err error) {
+	return testutil.CreateSecret(s.kubeCli, s.repoServerControllerNamespace, "test-repository-server-user-access-", "", data)
+}
+
+func (s *RepoServerControllerSuite) CreateRepositoryPasswordSecret(data map[string][]byte) (se *v1.Secret, err error) {
+	return testutil.CreateSecret(s.kubeCli, s.repoServerControllerNamespace, "test-repository-password-", reposerver.RepositoryPasswordSecret, data)
+}
+
+func (s *RepoServerControllerSuite) CreateKopiaTLSSecret(data map[string][]byte) (se *v1.Secret, err error) {
+	return testutil.CreateSecret(s.kubeCli, s.repoServerControllerNamespace, "test-kopia-tls-", v1.SecretTypeTLS, data)
+}
+
+func (s *RepoServerControllerSuite) CreateStorageLocationSecret(data map[string][]byte) (se *v1.Secret, err error) {
+	return testutil.CreateSecret(s.kubeCli, "test-repository-server-storage-", s.repoServerControllerNamespace, reposerver.Location, data)
+}
+
+func (s *RepoServerControllerSuite) CreateAWSStorageCredentialsSecret(data map[string][]byte) (se *v1.Secret, err error) {
+	return testutil.CreateSecret(s.kubeCli, "test-repository-server-storage-creds-", s.repoServerControllerNamespace, v1.SecretType(secrets.AWSSecretType), data)
+}
+
+func (s *RepoServerControllerSuite) CreateAzureStorageCredentialsSecret(data map[string][]byte) (se *v1.Secret, err error) {
+	return testutil.CreateSecret(s.kubeCli, "test-repository-server-storage-creds-", s.repoServerControllerNamespace, v1.SecretType(secrets.AzureSecretType), data)
+}
+
+func (s *RepoServerControllerSuite) CreateGCPStorageCredentialsSecret(data map[string][]byte) (se *v1.Secret, err error) {
+	return testutil.CreateSecret(s.kubeCli, "test-repository-server-storage-creds-", s.repoServerControllerNamespace, v1.SecretType(secrets.GCPSecretType), data)
+}
+
+func (s *RepoServerControllerSuite) TearDownSuite(c *C) {
+	if s.repoServerControllerNamespace != "" {
+		err := s.kubeCli.CoreV1().Namespaces().Delete(context.TODO(), s.repoServerControllerNamespace, metav1.DeleteOptions{})
+		c.Assert(err, IsNil)
+	}
+}
diff --git a/pkg/controllers/repositoryserver/suite_test.go b/pkg/controllers/repositoryserver/suite_test.go
diff --git a/pkg/testutil/const.go b/pkg/testutil/const.go
@@ -0,0 +1,28 @@
+// Copyright 2019 The Kanister Authors.
+//
+// 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 testutil
+
+const (
+	KopiaRepositoryServerAdminUser        = "admin@test"
+	KopiaRepositoryServerAdminPassword    = "admin1234"
+	KopiaRepositoryServerHost             = "localhost"
+	KopiaRepositoryPassword               = "test1234"
+	KopiaRepositoryUser                   = "repository-user"
+	KopiaRepositoryServerAccessUser       = "kanister-user"
+	KopiaRepositoryServerAccessPassword   = "test1234"
+	KanisterNamespace                     = "kanister"
+	KopiaRepositoryPath                   = "kopia-repo-path-test"
+	DefaultKopiaRepositoryServerContainer = "repo-server-container"
+)