Add support for Kubernetes and OpenShift-type DevWorkspace components

controllers/workspace/condition.go

@@ -29,6 +29,7 @@ var conditionOrder = []dw.DevWorkspaceConditionType{
 	dw.DevWorkspaceRoutingReady,
 	dw.DevWorkspaceServiceAccountReady,
 	conditions.PullSecretsReady,
+	conditions.KubeComponentsReady,
 	conditions.DeploymentReady,
 	dw.DevWorkspaceReady,
 }

controllers/workspace/devworkspace_controller.go

@@ -33,6 +33,7 @@ import (
 	containerlib "github.com/devfile/devworkspace-operator/pkg/library/container"
 	"github.com/devfile/devworkspace-operator/pkg/library/env"
 	"github.com/devfile/devworkspace-operator/pkg/library/flatten"
+	kubesync "github.com/devfile/devworkspace-operator/pkg/library/kubernetes"
 	"github.com/devfile/devworkspace-operator/pkg/library/projects"
 	"github.com/devfile/devworkspace-operator/pkg/provision/automount"
 	"github.com/devfile/devworkspace-operator/pkg/provision/metadata"
@@ -467,6 +468,24 @@ func (r *DevWorkspaceReconciler) Reconcile(ctx context.Context, req ctrl.Request
 	allPodAdditions = append(allPodAdditions, pullSecretStatus.PodAdditions)
 	reconcileStatus.setConditionTrue(conditions.PullSecretsReady, "DevWorkspace secrets ready")
 
+	if kubesync.HasKubelikeComponent(workspace) {
+		if err := kubesync.HandleKubernetesComponents(workspace, clusterAPI); err != nil {
+			switch syncErr := err.(type) {
+			case *kubesync.RetryError:
+				reqLogger.Info(syncErr.Error())
+				reconcileStatus.setConditionFalse(conditions.KubeComponentsReady, "Waiting for DevWorkspace Kubernetes components to be created on cluster")
+				return reconcile.Result{Requeue: true}, nil
+			case *kubesync.FailError:
+				return r.failWorkspace(workspace, fmt.Sprintf("Error provisioning workspace Kubernetes components: %s", syncErr), metrics.ReasonBadRequest, reqLogger, &reconcileStatus)
+			case *kubesync.WarningError:
+				reconcileStatus.setConditionTrue(conditions.DevWorkspaceWarning, fmt.Sprintf("Warning in Kubernetes components: %s", syncErr))
+			default:
+				return reconcile.Result{}, err
+			}
+		}
+		reconcileStatus.setConditionTrue(conditions.KubeComponentsReady, "Kubernetes components ready")
+	}
+
 	// Step six: Create deployment and wait for it to be ready
 	timing.SetTime(timingInfo, timing.DeploymentCreated)
 	deploymentStatus := wsprovision.SyncDeploymentToCluster(workspace, allPodAdditions, serviceAcctName, clusterAPI)

main.go

@@ -27,6 +27,7 @@ import (
 	"github.com/devfile/devworkspace-operator/pkg/cache"
 	"github.com/devfile/devworkspace-operator/pkg/config"
 	"github.com/devfile/devworkspace-operator/pkg/infrastructure"
+	kubesync "github.com/devfile/devworkspace-operator/pkg/library/kubernetes"
 	"github.com/devfile/devworkspace-operator/pkg/webhook"
 	"github.com/devfile/devworkspace-operator/version"
 
@@ -105,6 +106,10 @@ func main() {
 	setupLog.Info(fmt.Sprintf("Commit: %s", version.Commit))
 	setupLog.Info(fmt.Sprintf("BuildTime: %s", version.BuildTime))
 
+	if err := kubesync.InitializeDeserializer(scheme); err != nil {
+		setupLog.Error(err, "failed to initialized Kubernetes objects decoder")
+	}
+
 	cacheFunc, err := cache.GetCacheFunc()
 	if err != nil {
 		setupLog.Error(err, "failed to set up objects cache")

pkg/conditions/conditions.go

@@ -22,6 +22,7 @@ const (
 	PullSecretsReady     dw.DevWorkspaceConditionType = "PullSecretsReady"
 	DevWorkspaceResolved dw.DevWorkspaceConditionType = "DevWorkspaceResolved"
 	StorageReady         dw.DevWorkspaceConditionType = "StorageReady"
+	KubeComponentsReady  dw.DevWorkspaceConditionType = "KubernetesComponentsProvisioned"
 	DeploymentReady      dw.DevWorkspaceConditionType = "DeploymentReady"
 	DevWorkspaceWarning  dw.DevWorkspaceConditionType = "DevWorkspaceWarning"
 )

pkg/library/kubernetes/common_test.go

@@ -0,0 +1,36 @@
+// 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 kubernetes
+
+import (
+	dw "github.com/devfile/api/v2/pkg/apis/workspaces/v1alpha2"
+	"github.com/devfile/devworkspace-operator/apis/controller/v1alpha1"
+	"github.com/devfile/devworkspace-operator/pkg/provision/sync"
+	"k8s.io/apimachinery/pkg/runtime"
+	utilruntime "k8s.io/apimachinery/pkg/util/runtime"
+	clientgoscheme "k8s.io/client-go/kubernetes/scheme"
+)
+
+var (
+	testScheme = runtime.NewScheme()
+	testAPI    = sync.ClusterAPI{
+		Scheme: testScheme,
+	}
+)
+
+func init() {
+	utilruntime.Must(clientgoscheme.AddToScheme(testScheme))
+	utilruntime.Must(v1alpha1.AddToScheme(testScheme))
+	utilruntime.Must(dw.AddToScheme(testScheme))
+}

pkg/library/kubernetes/deserialize.go

@@ -0,0 +1,58 @@
+// 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 kubernetes
+
+import (
+	"fmt"
+	gosync "sync"
+
+	"github.com/devfile/devworkspace-operator/pkg/provision/sync"
+	"k8s.io/apimachinery/pkg/runtime"
+	"k8s.io/apimachinery/pkg/runtime/serializer"
+	"sigs.k8s.io/controller-runtime/pkg/client"
+)
+
+var (
+	decoder      runtime.Decoder
+	decoderMutex gosync.Mutex
+)
+
+func InitializeDeserializer(scheme *runtime.Scheme) error {
+	decoderMutex.Lock()
+	defer decoderMutex.Unlock()
+	if decoder != nil {
+		return fmt.Errorf("attempting to re-initialize kubernetes object decoder")
+	}
+	decoder = serializer.NewCodecFactory(scheme).UniversalDeserializer()
+	return nil
+}
+
+func deserializeToObject(jsonObj []byte, api sync.ClusterAPI) (client.Object, error) {
+	if decoder == nil {
+		return nil, fmt.Errorf("kubernetes object deserializer is not initialized")
+	}
+	obj, _, err := decoder.Decode(jsonObj, nil, nil)
+	if err != nil {
+		return nil, err
+	}
+	if obj.GetObjectKind().GroupVersionKind().Kind == "List" {
+		return nil, fmt.Errorf("objects of kind 'List' are unsupported")
+	}
+	clientObj, ok := obj.(client.Object)
+	if !ok {
+		// Should never occur but to avoid a panic
+		return nil, fmt.Errorf("object does not have standard metadata and cannot be processed")
+	}
+	return clientObj, nil
+}

pkg/library/kubernetes/deserialize_test.go

@@ -0,0 +1,105 @@
+// 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 kubernetes
+
+import (
+	"fmt"
+	"os"
+	"testing"
+
+	"github.com/google/go-cmp/cmp"
+	"github.com/stretchr/testify/assert"
+	corev1 "k8s.io/api/core/v1"
+	"sigs.k8s.io/controller-runtime/pkg/client"
+	"sigs.k8s.io/yaml"
+)
+
+func TestDeserializeObject(t *testing.T) {
+	if err := InitializeDeserializer(testScheme); err != nil {
+		t.Fatalf("Unexpected error: %s", err)
+	}
+	defer func() {
+		decoder = nil
+	}()
+	tests := []struct {
+		name              string
+		filePath          string
+		expectedObjStub   client.Object
+		expectedErrRegexp string
+	}{
+		{
+			name:            "Deserializes Pod",
+			filePath:        "testdata/k8s_objects/pod.yaml",
+			expectedObjStub: &corev1.Pod{},
+		},
+		{
+			name:            "Deserializes Service",
+			filePath:        "testdata/k8s_objects/service.yaml",
+			expectedObjStub: &corev1.Service{},
+		},
+		{
+			name:            "Deserializes ConfigMap",
+			filePath:        "testdata/k8s_objects/configmap.yaml",
+			expectedObjStub: &corev1.ConfigMap{},
+		},
+		{
+			name:              "Kubernetes list",
+			filePath:          "testdata/k8s_objects/kubernetes-list.yaml",
+			expectedErrRegexp: "objects of kind 'List' are unsupported",
+		},
+		{
+			name:              "Random yaml that is not a Kubernetes object",
+			filePath:          "testdata/k8s_objects/non-k8s-object.yaml",
+			expectedErrRegexp: "Object 'Kind' is missing",
+		},
+		{
+			name:              "Object with unrecognized kind",
+			filePath:          "testdata/k8s_objects/unrecognized-kind.yaml",
+			expectedErrRegexp: "no kind .* is registered for version .* in scheme",
+		},
+	}
+	for _, tt := range tests {
+		t.Run(fmt.Sprintf("%s (%s)", tt.name, tt.filePath), func(t *testing.T) {
+			jsonBytes := readBytesFromFile(t, tt.filePath)
+			actualObj, err := deserializeToObject(jsonBytes, testAPI)
+			if tt.expectedErrRegexp != "" {
+				if !assert.Error(t, err, "Expect error to be returned") {
+					return
+				}
+				assert.Regexp(t, tt.expectedErrRegexp, err.Error(), "Expect error to match pattern")
+			} else {
+				if !assert.NoError(t, err, "Expect no error to be returned") {
+					return
+				}
+				err := yaml.Unmarshal(jsonBytes, tt.expectedObjStub)
+				assert.NoError(t, err)
+				assert.True(t, cmp.Equal(tt.expectedObjStub, actualObj), cmp.Diff(tt.expectedObjStub, actualObj))
+			}
+		})
+	}
+}
+
+func TestErrorIfDeserializerNotInitialized(t *testing.T) {
+	_, err := deserializeToObject([]byte(""), testAPI)
+	assert.Error(t, err)
+	assert.Equal(t, "kubernetes object deserializer is not initialized", err.Error())
+}
+
+func readBytesFromFile(t *testing.T, filePath string) []byte {
+	bytes, err := os.ReadFile(filePath)
+	if err != nil {
+		t.Fatal(err)
+	}
+	return bytes
+}

pkg/library/kubernetes/errors.go

@@ -0,0 +1,53 @@
+// 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 kubernetes
+
+import "github.com/devfile/devworkspace-operator/pkg/provision/sync"
+
+type RetryError struct {
+	Err error
+}
+
+func (e *RetryError) Error() string {
+	return e.Err.Error()
+}
+
+type FailError struct {
+	Err error
+}
+
+func (e *FailError) Error() string {
+	return e.Err.Error()
+}
+
+func wrapSyncError(err error) error {
+	switch syncErr := err.(type) {
+	case *sync.NotInSyncError:
+		return &RetryError{syncErr}
+	case *sync.UnrecoverableSyncError:
+		return &FailError{syncErr}
+	case *sync.WarningError:
+		return &WarningError{syncErr}
+	default:
+		return err
+	}
+}
+
+type WarningError struct {
+	Err error
+}
+
+func (e *WarningError) Error() string {
+	return e.Err.Error()
+}