Bootstrap controller tests and add basic test cases

amisevsk · amisevsk · commit 9d40f9e53850 · 2022-12-14T11:10:35.000-05:00
Bootstrap test files for DevWorkspace controller and add a basic
DevWorkspace creation test.

Signed-off-by: Angel Misevski &lt;amisevsk@redhat.com&gt;
diff --git a/controllers/workspace/devworkspace_controller_test.go b/controllers/workspace/devworkspace_controller_test.go
@@ -0,0 +1,96 @@
+// Copyright (c) 2019-2022 Red Hat, Inc.
+// 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 controllers_test
+
+import (
+	"os"
+	"path/filepath"
+	"time"
+
+	dw "github.com/devfile/api/v2/pkg/apis/workspaces/v1alpha2"
+	"github.com/devfile/devworkspace-operator/pkg/conditions"
+	. "github.com/onsi/ginkgo/v2"
+	. "github.com/onsi/gomega"
+	corev1 "k8s.io/api/core/v1"
+	"k8s.io/apimachinery/pkg/types"
+	"sigs.k8s.io/controller-runtime/pkg/client"
+	"sigs.k8s.io/yaml"
+)
+
+func loadObjectFromFile(objName string, obj client.Object, filename string) error {
+	path := filepath.Join("testdata", filename)
+	bytes, err := os.ReadFile(path)
+	if err != nil {
+		return err
+	}
+	err = yaml.Unmarshal(bytes, obj)
+	if err != nil {
+		return err
+	}
+	obj.SetNamespace(testNamespace)
+	obj.SetName(objName)
+
+	return nil
+}
+
+var _ = Describe("DevWorkspace Controller", func() {
+	const (
+		timeout  = 10 * time.Second
+		interval = 250 * time.Millisecond
+	)
+
+	Context("Basic DevWorkspace Tests", func() {
+		It("Sets DevWorkspace ID and Starting status", func() {
+			By("Reading DevWorkspace from testdata file")
+			devworkspace := &dw.DevWorkspace{}
+			err := loadObjectFromFile(devWorkspaceName, devworkspace, "test-devworkspace.yaml")
+			Expect(err).NotTo(HaveOccurred())
+
+			By("Creating a new DevWorkspace")
+			Expect(k8sClient.Create(ctx, devworkspace)).Should(Succeed())
+			dwNamespacedName := types.NamespacedName{
+				Namespace: testNamespace,
+				Name:      devWorkspaceName,
+			}
+			defer deleteDevWorkspace(devWorkspaceName)
+
+			createdDW := &dw.DevWorkspace{}
+			Eventually(func() bool {
+				err := k8sClient.Get(ctx, dwNamespacedName, createdDW)
+				return err == nil
+			}, timeout, interval).Should(BeTrue(), "DevWorkspace should exist in cluster")
+
+			By("Checking DevWorkspace ID has been set")
+			Eventually(func() (devworkspaceID string, err error) {
+				if err := k8sClient.Get(ctx, dwNamespacedName, createdDW); err != nil {
+					return "", err
+				}
+				return createdDW.Status.DevWorkspaceId, nil
+			}, timeout, interval).Should(Not(Equal("")), "Should set DevWorkspace ID after creation")
+
+			By("Checking DevWorkspace Status is updated to starting")
+			Eventually(func() (phase dw.DevWorkspacePhase, err error) {
+				if err := k8sClient.Get(ctx, dwNamespacedName, createdDW); err != nil {
+					return "", err
+				}
+				return createdDW.Status.Phase, nil
+			}, timeout, interval).Should(Equal(dw.DevWorkspaceStatusStarting), "DevWorkspace should have Starting phase")
+			Expect(createdDW.Status.Message).ShouldNot(BeEmpty(), "Status message should be set for starting workspaces")
+			startingCondition := conditions.GetConditionByType(createdDW.Status.Conditions, conditions.Started)
+			Expect(startingCondition).ShouldNot(BeNil(), "Should have 'Starting' condition")
+			Expect(startingCondition.Status).Should(Equal(corev1.ConditionTrue), "Starting condition should be 'true'")
+		})
+
+	})
+})
diff --git a/controllers/workspace/suite_test.go b/controllers/workspace/suite_test.go
@@ -0,0 +1,189 @@
+// Copyright (c) 2019-2022 Red Hat, Inc.
+// 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 controllers_test
+
+import (
+	"context"
+	"fmt"
+	"os"
+	"path/filepath"
+	"testing"
+
+	dwv1 "github.com/devfile/api/v2/pkg/apis/workspaces/v1alpha1"
+	dwv2 "github.com/devfile/api/v2/pkg/apis/workspaces/v1alpha2"
+	controllerv1alpha1 "github.com/devfile/devworkspace-operator/apis/controller/v1alpha1"
+	appsv1 "k8s.io/api/apps/v1"
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+	"sigs.k8s.io/yaml"
+
+	workspacecontroller "github.com/devfile/devworkspace-operator/controllers/workspace"
+	"github.com/devfile/devworkspace-operator/pkg/cache"
+	"github.com/devfile/devworkspace-operator/pkg/config"
+	"github.com/devfile/devworkspace-operator/pkg/infrastructure"
+	. "github.com/onsi/ginkgo/v2"
+	. "github.com/onsi/gomega"
+	corev1 "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/envtest"
+	logf "sigs.k8s.io/controller-runtime/pkg/log"
+	"sigs.k8s.io/controller-runtime/pkg/log/zap"
+)
+
+const (
+	testNamespace    = "devworkspace-test"
+	devWorkspaceName = "test-devworkspace"
+)
+
+var (
+	cfg               *rest.Config
+	k8sClient         client.Client
+	testEnv           *envtest.Environment
+	ctx               context.Context
+	cancel            context.CancelFunc
+	testControllerCfg = &controllerv1alpha1.OperatorConfiguration{
+		Routing: &controllerv1alpha1.RoutingConfig{
+			ClusterHostSuffix: "test-environment-cluster-suffix",
+		},
+	}
+)
+
+func TestAPIs(t *testing.T) {
+	// if os.Getenv("TEST_CONTROLLER") != "true" {
+	// 	t.Skip()
+	// }
+
+	RegisterFailHandler(Fail)
+
+	RunSpecs(t, "Controller Suite")
+}
+
+var _ = BeforeSuite(func() {
+	logf.SetLogger(zap.New(zap.WriteTo(GinkgoWriter), zap.UseDevMode(true)))
+
+	ctx, cancel = context.WithCancel(context.TODO())
+
+	By("setting up controller environment")
+	Expect(setupEnvVars()).To(Succeed())
+
+	By("bootstrapping test environment")
+	testEnv = &envtest.Environment{
+		CRDDirectoryPaths:     []string{filepath.Join("..", "..", "deploy", "templates", "crd", "bases")},
+		ErrorIfCRDPathMissing: true,
+	}
+
+	cfg, err := testEnv.Start()
+	Expect(err).NotTo(HaveOccurred())
+	Expect(cfg).NotTo(BeNil())
+
+	infrastructure.InitializeForTesting(infrastructure.Kubernetes)
+
+	err = controllerv1alpha1.AddToScheme(scheme.Scheme)
+	Expect(err).NotTo(HaveOccurred())
+	err = dwv1.AddToScheme(scheme.Scheme)
+	Expect(err).NotTo(HaveOccurred())
+	err = dwv2.AddToScheme(scheme.Scheme)
+	Expect(err).NotTo(HaveOccurred())
+
+	k8sClient, err = client.New(cfg, client.Options{Scheme: scheme.Scheme})
+	Expect(err).NotTo(HaveOccurred())
+	Expect(k8sClient).NotTo(BeNil())
+
+	// Replicate controller setup similarly to how we do for main.go
+	cacheFunc, err := cache.GetCacheFunc()
+	Expect(err).NotTo(HaveOccurred())
+
+	mgr, err := ctrl.NewManager(cfg, ctrl.Options{
+		Scheme:   scheme.Scheme,
+		Port:     9443,
+		NewCache: cacheFunc,
+	})
+	Expect(err).NotTo(HaveOccurred())
+	// Use default config
+	config.SetConfigForTesting(testControllerCfg)
+
+	nonCachingClient, err := client.New(mgr.GetConfig(), client.Options{Scheme: scheme.Scheme})
+	Expect(err).NotTo(HaveOccurred())
+
+	err = mgr.GetFieldIndexer().IndexField(context.Background(), &corev1.Event{}, "involvedObject.name", func(obj client.Object) []string {
+		ev := obj.(*corev1.Event)
+		return []string{ev.InvolvedObject.Name}
+	})
+	Expect(err).NotTo(HaveOccurred())
+
+	// Don't set up DevWorkspaceRouting Reconciler so that we can manage routings
+
+	err = (&workspacecontroller.DevWorkspaceReconciler{
+		Client:           mgr.GetClient(),
+		NonCachingClient: nonCachingClient,
+		Log:              ctrl.Log.WithName("controllers").WithName("DevWorkspace"),
+		Scheme:           mgr.GetScheme(),
+	}).SetupWithManager(mgr)
+	Expect(err).NotTo(HaveOccurred())
+
+	// Skip trying to set up / test webhooks for now
+
+	By("Creating Namespace for the DevWorkspace")
+	ns := &corev1.Namespace{
+		ObjectMeta: metav1.ObjectMeta{
+			Name: testNamespace,
+		},
+	}
+	Expect(k8sClient.Create(ctx, ns)).Should(Succeed())
+
+	go func() {
+		defer GinkgoRecover()
+		err = mgr.Start(ctx)
+		Expect(err).ToNot(HaveOccurred(), "failed to run manager")
+	}()
+})
+
+var _ = AfterSuite(func() {
+	cancel()
+	By("tearing down the test environment")
+	err := testEnv.Stop()
+	Expect(err).NotTo(HaveOccurred())
+})
+
+func setupEnvVars() error {
+	bytes, err := os.ReadFile(filepath.Join("..", "..", "deploy", "templates", "components", "manager", "manager.yaml"))
+	if err != nil {
+		return err
+	}
+	deploy := &appsv1.Deployment{}
+	if err := yaml.Unmarshal(bytes, deploy); err != nil {
+		return err
+	}
+
+	var dwContainer *corev1.Container
+	for _, container := range deploy.Spec.Template.Spec.Containers {
+		if container.Name == "devworkspace-controller" {
+			dwContainer = &container
+			break
+		}
+	}
+	if dwContainer == nil {
+		return fmt.Errorf("could not read devworkspace-controller container from manager.yaml")
+	}
+
+	for _, envvar := range dwContainer.Env {
+		if err := os.Setenv(envvar.Name, envvar.Value); err != nil {
+			return err
+		}
+	}
+
+	return nil
+}
diff --git a/controllers/workspace/testdata/test-devworkspace.yaml b/controllers/workspace/testdata/test-devworkspace.yaml
@@ -0,0 +1,24 @@
+kind: DevWorkspace
+apiVersion: workspace.devfile.io/v1alpha2
+metadata:
+  labels:
+    controller.devfile.io/creator: ""
+spec:
+  started: true
+  routingClass: 'basic'
+  template:
+    projects:
+      - name: web-nodejs-sample
+        git:
+          remotes:
+            origin: "https://github.com/che-samples/web-nodejs-sample.git"
+    components:
+      - name: web-terminal
+        container:
+          image: quay.io/wto/web-terminal-tooling:latest
+          memoryLimit: 512Mi
+          mountSources: true
+          command:
+           - "tail"
+           - "-f"
+           - "/dev/null"
diff --git a/controllers/workspace/util_test.go b/controllers/workspace/util_test.go
