capsule/controllers/resources/processor.go

// Copyright 2020-2023 Project Capsule Authors.
// SPDX-License-Identifier: Apache-2.0

package resources

import (
	"context"
	"errors"
	"fmt"
	"sync"

	"github.com/valyala/fasttemplate"
	corev1 "k8s.io/api/core/v1"
	apierr "k8s.io/apimachinery/pkg/api/errors"
	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
	"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
	"k8s.io/apimachinery/pkg/labels"
	"k8s.io/apimachinery/pkg/runtime/schema"
	"k8s.io/apimachinery/pkg/runtime/serializer"
	"k8s.io/apimachinery/pkg/selection"
	"k8s.io/apimachinery/pkg/util/sets"
	"sigs.k8s.io/controller-runtime/pkg/client"
	"sigs.k8s.io/controller-runtime/pkg/controller/controllerutil"
	ctrllog "sigs.k8s.io/controller-runtime/pkg/log"

	capsulev1beta2 "github.com/projectcapsule/capsule/api/v1beta2"
)

const (
	Label     = "capsule.clastix.io/resources"
	finalizer = "capsule.clastix.io/resources"
)

type Processor struct {
	client client.Client
}

func prepareAdditionalMetadata(m map[string]string) map[string]string {
	if m == nil {
		return make(map[string]string)
	}

	return m
}

func (r *Processor) HandlePruning(ctx context.Context, current, desired sets.Set[string]) (updateStatus bool) {
	log := ctrllog.FromContext(ctx)

	diff := current.Difference(desired)
	// We don't want to trigger a reconciliation of the Status every time,
	// rather, only in case of a difference between the processed and the actual status.
	// This can happen upon the first reconciliation, or a removal, or a change, of a resource.
	updateStatus = diff.Len() > 0 || current.Len() != desired.Len()

	if diff.Len() > 0 {
		log.Info("starting processing pruning", "length", diff.Len())
	}

	// The outer resources must be removed, iterating over these to clean-up
	for item := range diff {
		or := capsulev1beta2.ObjectReferenceStatus{}
		if err := or.ParseFromString(item); err != nil {
			log.Error(err, "unable to parse resource to prune", "resource", item)

			continue
		}

		obj := unstructured.Unstructured{}
		obj.SetNamespace(or.Namespace)
		obj.SetName(or.Name)
		obj.SetGroupVersionKind(schema.FromAPIVersionAndKind(or.APIVersion, or.Kind))

		if err := r.client.Delete(ctx, &obj); err != nil {
			if apierr.IsNotFound(err) {
				// Object may have been already deleted, we can ignore this error
				continue
			}

			log.Error(err, "unable to prune resource", "resource", item)

			continue
		}

		log.Info("resource has been pruned", "resource", item)
	}

	return updateStatus
}

//nolint:gocognit
func (r *Processor) HandleSection(ctx context.Context, tnt capsulev1beta2.Tenant, allowCrossNamespaceSelection bool, tenantLabel string, resourceIndex int, spec capsulev1beta2.ResourceSpec) ([]string, error) {
	log := ctrllog.FromContext(ctx)

	var err error
	// Creating Namespace selector
	var selector labels.Selector

	if spec.NamespaceSelector != nil {
		selector, err = metav1.LabelSelectorAsSelector(spec.NamespaceSelector)
		if err != nil {
			log.Error(err, "cannot create Namespace selector for Namespace filtering and resource replication", "index", resourceIndex)

			return nil, err
		}
	} else {
		selector = labels.NewSelector()
	}
	// Resources can be replicated only on Namespaces belonging to the same Global:
	// preventing a boundary cross by enforcing the selection.
	tntRequirement, err := labels.NewRequirement(tenantLabel, selection.Equals, []string{tnt.GetName()})
	if err != nil {
		log.Error(err, "unable to create requirement for Namespace filtering and resource replication", "index", resourceIndex)

		return nil, err
	}

	selector = selector.Add(*tntRequirement)
	// Selecting the targeted Namespace according to the TenantResource specification.
	namespaces := corev1.NamespaceList{}
	if err = r.client.List(ctx, &namespaces, client.MatchingLabelsSelector{Selector: selector}); err != nil {
		log.Error(err, "cannot retrieve Namespaces for resource", "index", resourceIndex)

		return nil, err
	}
	// Generating additional metadata
	objAnnotations, objLabels := map[string]string{}, map[string]string{}

	if spec.AdditionalMetadata != nil {
		objAnnotations = prepareAdditionalMetadata(spec.AdditionalMetadata.Annotations)
		objLabels = prepareAdditionalMetadata(spec.AdditionalMetadata.Labels)
	}

	objAnnotations[tenantLabel] = tnt.GetName()

	objLabels[Label] = fmt.Sprintf("%d", resourceIndex)
	objLabels[tenantLabel] = tnt.GetName()
	// processed will contain the sets of resources replicated, both for the raw and the Namespaced ones:
	// these are required to perform a final pruning once the replication has been occurred.
	processed := sets.NewString()

	tntNamespaces := sets.NewString(tnt.Status.Namespaces...)

	var syncErr error

	codecFactory := serializer.NewCodecFactory(r.client.Scheme())

	for _, ns := range namespaces.Items {
		for nsIndex, item := range spec.NamespacedItems {
			keysAndValues := []any{"index", nsIndex, "namespace", item.Namespace}
			// A TenantResource is created by a TenantOwner, and potentially, they could point to a resource in a non-owned
			// Namespace: this must be blocked by checking it this is the case.
			if !allowCrossNamespaceSelection && !tntNamespaces.Has(item.Namespace) {
				log.Info("skipping processing of namespacedItem, referring a Namespace that is not part of the given Tenant", keysAndValues...)

				continue
			}
			// Namespaced Items are relying on selecting resources, rather than specifying a specific name:
			// creating it to get used by the client List action.
			objSelector := item.Selector

			itemSelector, selectorErr := metav1.LabelSelectorAsSelector(&objSelector)
			if selectorErr != nil {
				log.Error(selectorErr, "cannot create Selector for namespacedItem", keysAndValues...)

				syncErr = errors.Join(syncErr, selectorErr)

				continue
			}

			objs := unstructured.UnstructuredList{}
			objs.SetGroupVersionKind(schema.FromAPIVersionAndKind(item.APIVersion, fmt.Sprintf("%sList", item.Kind)))

			if clientErr := r.client.List(ctx, &objs, client.InNamespace(item.Namespace), client.MatchingLabelsSelector{Selector: itemSelector}); clientErr != nil {
				log.Error(clientErr, "cannot retrieve object for namespacedItem", keysAndValues...)

				syncErr = errors.Join(syncErr, clientErr)

				continue
			}

			var wg sync.WaitGroup

			errorsChan := make(chan error, len(objs.Items))
			// processedRaw is used to avoid concurrent map writes during iteration of namespaced items:
			// the objects will be then added to processed variable if the resulting string is not empty,
			// meaning it has been processed correctly.
			processedRaw := make([]string, len(objs.Items))
			// Iterating over all the retrieved objects from the resource spec to get replicated in all the selected Namespaces:
			// in case of error during the create or update function, this will be appended to the list of errors.
			for i, o := range objs.Items {
				obj := o
				obj.SetNamespace(ns.Name)
				obj.SetOwnerReferences(nil)

				wg.Add(1)

				go func(index int, obj unstructured.Unstructured) {
					defer wg.Done()

					kv := keysAndValues
					kv = append(kv, "resource", fmt.Sprintf("%s/%s", obj.GetNamespace(), obj.GetNamespace()))

					if opErr := r.createOrUpdate(ctx, &obj, objLabels, objAnnotations); opErr != nil {
						log.Error(opErr, "unable to sync namespacedItems", kv...)
						errorsChan <- opErr

						return
					}

					log.Info("resource has been replicated", kv...)

					replicatedItem := &capsulev1beta2.ObjectReferenceStatus{}
					replicatedItem.Name = obj.GetName()
					replicatedItem.Kind = obj.GetKind()
					replicatedItem.Namespace = ns.Name
					replicatedItem.APIVersion = obj.GetAPIVersion()

					processedRaw[index] = replicatedItem.String()
				}(i, obj)
			}

			wg.Wait()
			close(errorsChan)

			for err := range errorsChan {
				if err != nil {
					syncErr = errors.Join(syncErr, err)
				}
			}

			for _, p := range processedRaw {
				if p == "" {
					continue
				}

				processed.Insert(p)
			}
		}

		for rawIndex, item := range spec.RawItems {
			template := string(item.Raw)

			t := fasttemplate.New(template, "{{ ", " }}")

			tmplString := t.ExecuteString(map[string]interface{}{
				"tenant.name": tnt.Name,
				"namespace":   ns.Name,
			})

			obj, keysAndValues := unstructured.Unstructured{}, []interface{}{"index", rawIndex}

			if _, _, decodeErr := codecFactory.UniversalDeserializer().Decode([]byte(tmplString), nil, &obj); decodeErr != nil {
				log.Error(decodeErr, "unable to deserialize rawItem", keysAndValues...)

				syncErr = errors.Join(syncErr, decodeErr)

				continue
			}

			obj.SetNamespace(ns.Name)

			if rawErr := r.createOrUpdate(ctx, &obj, objLabels, objAnnotations); rawErr != nil {
				log.Info("unable to sync rawItem", keysAndValues...)
				// In case of error processing an item in one of any selected Namespaces, storing it to report it lately
				// to the upper call to ensure a partial sync that will be fixed by a subsequent reconciliation.
				syncErr = errors.Join(syncErr, rawErr)
			} else {
				log.Info("resource has been replicated", keysAndValues...)

				replicatedItem := &capsulev1beta2.ObjectReferenceStatus{}
				replicatedItem.Name = obj.GetName()
				replicatedItem.Kind = obj.GetKind()
				replicatedItem.Namespace = ns.Name
				replicatedItem.APIVersion = obj.GetAPIVersion()

				processed.Insert(replicatedItem.String())
			}
		}
	}

	return processed.List(), syncErr
}

// createOrUpdate replicates the provided unstructured object to all the provided Namespaces:
// this function mimics the CreateOrUpdate, by retrieving the object to understand if it must be created or updated,
// along adding the additional metadata, if required.
func (r *Processor) createOrUpdate(ctx context.Context, obj *unstructured.Unstructured, labels map[string]string, annotations map[string]string) (err error) {
	actual, desired := &unstructured.Unstructured{}, obj.DeepCopy()

	actual.SetAPIVersion(desired.GetAPIVersion())
	actual.SetKind(desired.GetKind())
	actual.SetNamespace(desired.GetNamespace())
	actual.SetName(desired.GetName())

	_, err = controllerutil.CreateOrUpdate(ctx, r.client, actual, func() error {
		UID := actual.GetUID()
		rv := actual.GetResourceVersion()
		actual.SetUnstructuredContent(desired.Object)

		combinedLabels := obj.GetLabels()
		if combinedLabels == nil {
			combinedLabels = make(map[string]string)
		}

		for key, value := range labels {
			combinedLabels[key] = value
		}

		actual.SetLabels(combinedLabels)

		combinedAnnotations := obj.GetAnnotations()
		if combinedAnnotations == nil {
			combinedAnnotations = make(map[string]string)
		}

		for key, value := range annotations {
			combinedAnnotations[key] = value
		}

		actual.SetAnnotations(combinedAnnotations)
		actual.SetResourceVersion(rv)
		actual.SetUID(UID)

		return nil
	})

	return err
}