Update feature controller to update featureset dependency (#218)

Signed-off-by: Masudur Rahman <[email protected]>

Author: masudur-rahman

go.mod

@@ -39,11 +39,11 @@ require (
 	k8s.io/kube-state-metrics/v2 v2.7.0
 	kmodules.xyz/apiversion v0.2.0
 	kmodules.xyz/authorizer v0.25.1
-	kmodules.xyz/client-go v0.25.27
+	kmodules.xyz/client-go v0.25.28
 	kmodules.xyz/custom-resources v0.25.1
 	kmodules.xyz/go-containerregistry v0.0.11
 	kmodules.xyz/monitoring-agent-api v0.25.1
-	kmodules.xyz/resource-metadata v0.17.9-0.20230725050232-984a47870958
+	kmodules.xyz/resource-metadata v0.17.9-0.20230727064228-3d5e2c06b6f8
 	kmodules.xyz/resource-metrics v0.25.2
 	kmodules.xyz/sets v0.25.0
 	kubeops.dev/scanner v0.0.13-0.20230610152531-83d060ed8780

go.sum

@@ -2108,8 +2108,8 @@ kmodules.xyz/apiversion v0.2.0 h1:vAQYqZFm4xu4pbB1cAdHbFEPES6EQkcR4wc06xdTOWk=
 kmodules.xyz/apiversion v0.2.0/go.mod h1:oPX8g8LvlPdPX3Yc5YvCzJHQnw3YF/X4/jdW0b1am80=
 kmodules.xyz/authorizer v0.25.1 h1:W19AtlPD2A1+Q4UqDmNCJKfX9bKIgj+J6bQmkYwsHwY=
 kmodules.xyz/authorizer v0.25.1/go.mod h1:hKAbHpRkbxZJjc+cMTUiyxQxp7amKUVDiN145IrpnhA=
-kmodules.xyz/client-go v0.25.27 h1:Ivl054xbXSvMNMKAJtK7TkS0iZX0AHvVQzxtsrIk9ik=
-kmodules.xyz/client-go v0.25.27/go.mod h1:PYfJtJs+AhgfkJNIeUObU4SqAkY85ARTlXxC+2gAsgo=
+kmodules.xyz/client-go v0.25.28 h1:KmkoiQ6Uf1xqD1Y9owth/OM+0/alOaLdP629Z65HyAk=
+kmodules.xyz/client-go v0.25.28/go.mod h1:SKUDh1za0YOCaqZoNUlg3/pxbWLY8MWLFXx/DiUXv5o=
 kmodules.xyz/crd-schema-fuzz v0.25.0 h1:c5ZxNRqJak1bkGhECmyrKpzKGThFMB4088Kynyvngbc=
 kmodules.xyz/custom-resources v0.25.1 h1:0qHPTxbT/q0afl2GCOnwPFaoxKziRIPXgVu77YwrCa4=
 kmodules.xyz/custom-resources v0.25.1/go.mod h1:ULwzvLmOqZJcPSXKI7iLclYL5eYRlKx8Nbex28Ht19E=
@@ -2119,8 +2119,8 @@ kmodules.xyz/monitoring-agent-api v0.25.1 h1:E1H8U/vMfYQ8wevmJv6Lcj0Z4DF7cH3hZ2x
 kmodules.xyz/monitoring-agent-api v0.25.1/go.mod h1:IphGzRWbuV00B3TLalcBs6+IlchSZVTwKDty+J3LLz4=
 kmodules.xyz/offshoot-api v0.25.0 h1:Svq9da/+sg5afOjpgo9vx2J/Lu90Mo0aFxkdQmgKnGI=
 kmodules.xyz/offshoot-api v0.25.0/go.mod h1:ysEBn7LJuT3+s8ynAQA/OG0BSsJugXa6KGtDLMRjlKo=
-kmodules.xyz/resource-metadata v0.17.9-0.20230725050232-984a47870958 h1:KSgFzmsf0mbdS34By/IoaLuUX+1U9mQokIXwE5Hbk0g=
-kmodules.xyz/resource-metadata v0.17.9-0.20230725050232-984a47870958/go.mod h1:gUy7cQ7QvB/SQ3upgsmS4BVxm5NLbJEXBI7M2CLSymA=
+kmodules.xyz/resource-metadata v0.17.9-0.20230727064228-3d5e2c06b6f8 h1:kI0QLIpBWo0EA77je/kMXu/YFq9oUOXIJ1t9+POK3y0=
+kmodules.xyz/resource-metadata v0.17.9-0.20230727064228-3d5e2c06b6f8/go.mod h1:gUy7cQ7QvB/SQ3upgsmS4BVxm5NLbJEXBI7M2CLSymA=
 kmodules.xyz/resource-metrics v0.25.2 h1:BwCb6qyunvQBa0u8UUkw+wYG5/T4qtNtAKcHjSsk0JU=
 kmodules.xyz/resource-metrics v0.25.2/go.mod h1:ZK/52NLuwMk+Jt0bmUtGQHtSxPLYYpsFILG7SJhYPg0=
 kmodules.xyz/sets v0.25.0 h1:belY/3trp/M/CKc1TEteA40jb2uCIdwKHhjpvrIxG+8=

pkg/controllers/feature/dependency.go

@@ -0,0 +1,117 @@
+/*
+Copyright AppsCode Inc. and Contributors.
+
+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 feature
+
+import (
+	"context"
+
+	"gomodules.xyz/pointer"
+	"gomodules.xyz/sets"
+	"k8s.io/apimachinery/pkg/api/errors"
+	"k8s.io/apimachinery/pkg/types"
+	cu "kmodules.xyz/client-go/client"
+	"kmodules.xyz/resource-metadata/apis/ui/v1alpha1"
+	"sigs.k8s.io/controller-runtime/pkg/client"
+)
+
+func (r *frReconciler) updateAllFeatureSetDependencies(ctx context.Context) error {
+	enabled := pointer.Bool(r.feature.Status.Managed) && pointer.Bool(r.feature.Status.Enabled)
+
+	for _, name := range r.feature.Spec.Requirements.Features {
+		f := &v1alpha1.Feature{}
+		if err := r.client.Get(ctx, types.NamespacedName{Name: name}, f); err != nil {
+			if errors.IsNotFound(err) {
+				// required feature isn't available yet
+				continue
+			}
+			return err
+		}
+
+		if !pointer.Bool(f.Status.Enabled) || f.Spec.FeatureSet == r.feature.Spec.FeatureSet {
+			// required feature isn't enabled or belongs to same feature set
+			continue
+		}
+
+		if err := r.updateFeatureSetDependencyStatus(ctx, f.Spec.FeatureSet, enabled); err != nil {
+			return err
+		}
+
+	}
+	return nil
+}
+
+func (r *frReconciler) updateFeatureSetDependencyStatus(ctx context.Context, fsName string, enabled bool) error {
+	fs := &v1alpha1.FeatureSet{}
+	err := r.client.Get(ctx, types.NamespacedName{Name: fsName}, fs)
+	if err != nil {
+		return err
+	}
+
+	if enabled {
+		fs.Status.Dependents = addFeatureDependents(fs.Status.Dependents, r.feature)
+	} else {
+		fs.Status.Dependents = removeFeatureDependents(fs.Status.Dependents, r.feature)
+	}
+
+	_, err = cu.PatchStatus(ctx, r.client, fs, func(obj client.Object) client.Object {
+		in := obj.(*v1alpha1.FeatureSet)
+		in.Status.Dependents = fs.Status.Dependents
+		return in
+	})
+	return err
+}
+
+func addFeatureDependents(dependents v1alpha1.Dependents, f *v1alpha1.Feature) v1alpha1.Dependents {
+	for idx := range dependents.FeatureSets {
+		fs := dependents.FeatureSets[idx]
+		if fs.Name == f.Spec.FeatureSet {
+			dependents.FeatureSets[idx].Features = addIfNotExists(fs.Features, f.Name)
+			return dependents
+		}
+	}
+
+	dependents.FeatureSets = append(dependents.FeatureSets, v1alpha1.DependentFeatureSet{
+		Name:     f.Spec.FeatureSet,
+		Features: []string{f.Name},
+	})
+	return dependents
+}
+
+func removeFeatureDependents(dependents v1alpha1.Dependents, f *v1alpha1.Feature) v1alpha1.Dependents {
+	dfs := make([]v1alpha1.DependentFeatureSet, 0, len(dependents.FeatureSets))
+	for idx := range dependents.FeatureSets {
+		fs := dependents.FeatureSets[idx]
+		if fs.Name == f.Spec.FeatureSet {
+			fs.Features = removeIfExists(fs.Features, f.Name)
+			if len(fs.Features) > 0 {
+				dfs = append(dfs, fs)
+			}
+		} else {
+			dfs = append(dfs, fs)
+		}
+	}
+	dependents.FeatureSets = dfs
+	return dependents
+}
+
+func addIfNotExists(slice []string, s string) []string {
+	return sets.NewString(slice...).Insert(s).List()
+}
+
+func removeIfExists(slice []string, s string) []string {
+	return sets.NewString(slice...).Delete(s).List()
+}

pkg/controllers/feature/feature_controller.go

@@ -89,7 +89,7 @@ func (r *FeatureReconciler) Reconcile(ctx context.Context, req ctrl.Request) (ct
 	}
 
 	if fr.feature.DeletionTimestamp != nil {
-		err := fr.updateFeatureSetAndRemoveFinalizer(ctx)
+		err = fr.updateFeatureSetAndRemoveFinalizer(ctx)
 		if err != nil && kerr.IsNotFound(err) {
 			return ctrl.Result{}, err
 		}
@@ -102,7 +102,7 @@ func (r *FeatureReconciler) Reconcile(ctx context.Context, req ctrl.Request) (ct
 		return ctrl.Result{}, nil
 	}
 
-	if err := fr.updateStatus(ctx); err != nil {
+	if err = fr.updateStatus(ctx); err != nil {
 		return ctrl.Result{}, err
 	}
 
@@ -111,6 +111,10 @@ func (r *FeatureReconciler) Reconcile(ctx context.Context, req ctrl.Request) (ct
 		return ctrl.Result{}, err
 	}
 
+	if err = fr.updateAllFeatureSetDependencies(ctx); err != nil {
+		return ctrl.Result{}, err
+	}
+
 	// We need to requeue the Feature periodically so that it works with third party resources.
 	// Here, we are requeueing every Feature after a random interval between 30s to 150s so that
 	// all Features do not get requeued at the same time.

vendor/kmodules.xyz/client-go/Makefile

@@ -154,7 +154,7 @@ gen-crd-protos:
 			--packages=-k8s.io/api/core/v1,kmodules.xyz/client-go/api/v1
 
 .PHONY: gen-enum
-gen-enum:
+gen-enum: $(BUILD_DIRS)
 	@docker run                                                 \
 	    -i                                                      \
 	    --rm                                                    \

vendor/kmodules.xyz/client-go/client/client.go

@@ -111,9 +111,6 @@ func CreateOrPatch(ctx context.Context, c client.Client, obj client.Object, tran
 		patch = client.MergeFrom(cur)
 	}
 	mod := transform(cur.DeepCopyObject().(client.Object), false)
-	if p, err := patch.Data(mod); err != nil || string(p) == "{}" {
-		return kutil.VerbUnchanged, err
-	}
 	err = c.Patch(ctx, mod, patch, opts...)
 	if err != nil {
 		return kutil.VerbUnchanged, err
@@ -149,9 +146,6 @@ func PatchStatus(ctx context.Context, c client.Client, obj client.Object, transf
 	//   - application/apply-patch+yaml
 	patch := client.MergeFrom(cur)
 	mod := transform(cur.DeepCopyObject().(client.Object))
-	if p, err := patch.Data(mod); err != nil || string(p) == "{}" {
-		return kutil.VerbUnchanged, err
-	}
 	err = c.Status().Patch(ctx, mod, patch, opts...)
 	if err != nil {
 		return kutil.VerbUnchanged, err

vendor/kmodules.xyz/client-go/tools/clientcmd/rest_config.go

@@ -0,0 +1,74 @@
+/*
+Copyright AppsCode Inc. and Contributors
+
+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 clientcmd
+
+import (
+	"k8s.io/apimachinery/pkg/runtime"
+	"k8s.io/client-go/rest"
+	clientcmdapi "k8s.io/client-go/tools/clientcmd/api"
+	clientcmdlatest "k8s.io/client-go/tools/clientcmd/api/latest"
+)
+
+// https://github.com/kubernetes/client-go/issues/711#issuecomment-730112049
+func GenerateKubeConfiguration(cfg *rest.Config, namespace string) ([]byte, error) {
+	if err := rest.LoadTLSFiles(cfg); err != nil {
+		return nil, err
+	}
+
+	clusters := make(map[string]*clientcmdapi.Cluster)
+	clusters["default-cluster"] = &clientcmdapi.Cluster{
+		Server:                   cfg.Host,
+		CertificateAuthorityData: cfg.CAData,
+	}
+
+	contexts := make(map[string]*clientcmdapi.Context)
+	contexts["default-context"] = &clientcmdapi.Context{
+		Cluster:   "default-cluster",
+		Namespace: namespace,
+		AuthInfo:  "default-user",
+	}
+
+	authinfos := make(map[string]*clientcmdapi.AuthInfo)
+	authinfos["default-user"] = &clientcmdapi.AuthInfo{
+		LocationOfOrigin:      "",
+		ClientCertificate:     "",
+		ClientCertificateData: cfg.CertData,
+		ClientKey:             "",
+		ClientKeyData:         cfg.KeyData,
+		Token:                 cfg.BearerToken,
+		TokenFile:             "",
+		Impersonate:           cfg.Impersonate.UserName,
+		ImpersonateUID:        cfg.Impersonate.UID,
+		ImpersonateGroups:     cfg.Impersonate.Groups,
+		ImpersonateUserExtra:  cfg.Impersonate.Extra,
+		Username:              cfg.Username,
+		Password:              cfg.Password,
+		AuthProvider:          cfg.AuthProvider,
+		Exec:                  cfg.ExecProvider,
+		Extensions:            nil,
+	}
+
+	clientConfig := clientcmdapi.Config{
+		Kind:           "Config",
+		APIVersion:     "v1",
+		Clusters:       clusters,
+		Contexts:       contexts,
+		CurrentContext: "default-context",
+		AuthInfos:      authinfos,
+	}
+	return runtime.Encode(clientcmdlatest.Codec, &clientConfig)
+}

vendor/kmodules.xyz/resource-metadata/apis/meta/v1alpha1/openapi_generated.go

@@ -76,6 +76,9 @@ type FeatureSetStatus struct {
 	// Features specifies the status of the component features that belong to this feature set.
 	// +optional
 	Features []ComponentStatus `json:"features,omitempty"`
+	// Dependents specifies the feature sets which depend on this FeatureSet
+	// +optional
+	Dependents Dependents `json:"dependents,omitempty"`
 	// Note specifies the respective reason if the feature set is considered as disabled.
 	// +optional
 	Note string `json:"note,omitempty"`
@@ -95,6 +98,19 @@ type ComponentStatus struct {
 	Managed *bool `json:"managed,omitempty"`
 }
 
+type Dependents struct {
+	// FeatureSets specifies a list of FeatureSet names that depend on this FeatureSet
+	// +optional
+	FeatureSets []DependentFeatureSet `json:"featureSets,omitempty"`
+}
+
+type DependentFeatureSet struct {
+	// Name specifies the name of the dependent FeatureSet
+	Name string `json:"name,omitempty"`
+	// Features specifies the Feature names of the dependent FeatureSet
+	Features []string `json:"features,omitempty"`
+}
+
 // +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
 // +kubebuilder:object:root=true