github.com/cilium/cilium@v1.16.2/pkg/clustermesh/endpointslicesync/endpointslice_test.go

// SPDX-License-Identifier: Apache-2.0
// Copyright Authors of Cilium

package endpointslicesync

import (
	"context"
	"testing"
	"time"

	"github.com/cilium/hive/cell"
	"github.com/cilium/hive/hivetest"
	"github.com/sirupsen/logrus"
	"github.com/stretchr/testify/assert"
	"github.com/stretchr/testify/require"
	corev1 "k8s.io/api/core/v1"
	discovery "k8s.io/api/discovery/v1"
	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
	cache "k8s.io/client-go/tools/cache"
	mcsapiv1alpha1 "sigs.k8s.io/mcs-api/pkg/apis/v1alpha1"

	"github.com/cilium/cilium/operator/k8s"
	"github.com/cilium/cilium/pkg/annotation"
	"github.com/cilium/cilium/pkg/clustermesh/common"
	"github.com/cilium/cilium/pkg/hive"
	k8sClient "github.com/cilium/cilium/pkg/k8s/client"
	"github.com/cilium/cilium/pkg/k8s/resource"
	slim_corev1 "github.com/cilium/cilium/pkg/k8s/slim/k8s/api/core/v1"
	slim_metav1 "github.com/cilium/cilium/pkg/k8s/slim/k8s/apis/meta/v1"
	"github.com/cilium/cilium/pkg/k8s/utils"
	"github.com/cilium/cilium/pkg/loadbalancer"
	"github.com/cilium/cilium/pkg/metrics/metric"
	"github.com/cilium/cilium/pkg/service/store"
)

const (
	remoteClusterName string = "cluster-1"
	globalSvcIP       string = "42.42.42.42"
)

func createService(name string) *slim_corev1.Service {
	return &slim_corev1.Service{
		ObjectMeta: slim_metav1.ObjectMeta{
			Name:      name,
			Namespace: name,
			Annotations: map[string]string{
				annotation.GlobalService:                   "true",
				annotation.GlobalServiceSyncEndpointSlices: "true",
			},
		},
		Spec: slim_corev1.ServiceSpec{
			Selector:   map[string]string{"test": "test"},
			IPFamilies: []slim_corev1.IPFamily{slim_corev1.IPv4Protocol},
		},
	}
}

func createGlobalService(
	globalService *common.GlobalServiceCache,
	podInformer *meshPodInformer,
	svcName string,
	updateClusterSvc func(*store.ClusterService)) *store.ClusterService {
	clusterSvc := &store.ClusterService{
		Cluster:   remoteClusterName,
		Namespace: svcName,
		Name:      svcName,
		Backends: map[string]store.PortConfiguration{
			globalSvcIP: {"port-name": &loadbalancer.L4Addr{Protocol: loadbalancer.TCP, Port: 42}},
		},
		Shared:    true,
		ClusterID: 1,
	}
	if updateClusterSvc != nil {
		updateClusterSvc(clusterSvc)
	}
	globalService.OnUpdate(clusterSvc)
	// We manually call the rest of the informer for convenience
	podInformer.onClusterServiceUpdate(clusterSvc)
	return clusterSvc
}

func getEndpointSlice(clientset k8sClient.Clientset, svcName string) (*discovery.EndpointSliceList, error) {
	labelSelector := metav1.LabelSelector{MatchLabels: map[string]string{
		discovery.LabelServiceName: svcName,
		discovery.LabelManagedBy:   utils.EndpointSliceMeshControllerName,
	}}
	return clientset.DiscoveryV1().EndpointSlices(svcName).
		List(context.Background(), metav1.ListOptions{LabelSelector: metav1.FormatLabelSelector(&labelSelector)})
}

func Test_meshEndpointSlice_Reconcile(t *testing.T) {
	var fakeClient k8sClient.FakeClientset
	var services resource.Resource[*slim_corev1.Service]
	logger := logrus.New()
	hive := hive.New(
		k8sClient.FakeClientCell,
		k8s.ResourcesCell,
		cell.Invoke(func(
			c *k8sClient.FakeClientset,
			svc resource.Resource[*slim_corev1.Service],
		) error {
			fakeClient = *c
			services = svc
			return nil
		}),
	)
	tlog := hivetest.Logger(t)
	err := hive.Start(tlog, context.Background())
	if err != nil {
		t.Fatal(err)
	}
	defer hive.Stop(tlog, context.Background())

	globalService := common.NewGlobalServiceCache(metric.NewGauge(metric.GaugeOpts{}))
	podInformer := newMeshPodInformer(logger, globalService)
	nodeInformer := newMeshNodeInformer(logger)
	controller, serviceInformer, endpointsliceInformer := newEndpointSliceMeshController(
		context.Background(), logger,
		EndpointSliceSyncConfig{ClusterMeshMaxEndpointsPerSlice: 100},
		podInformer, nodeInformer, &fakeClient, services, globalService,
	)
	endpointsliceInformer.Start(context.Background().Done())
	go serviceInformer.Start(context.Background())
	cache.WaitForCacheSync(context.Background().Done(), serviceInformer.HasSynced)

	go controller.Run(context.Background(), 1)
	nodeInformer.onClusterAdd(remoteClusterName)

	svcStore, _ := services.Store(context.Background())

	tick := 10 * time.Millisecond
	timeout := 200 * time.Millisecond

	t.Run("Create service then global service", func(t *testing.T) {
		svcName := "local-svc-global-svc"
		hostname := svcName + "-0"
		svc1 := createService(svcName)
		svcStore.CacheStore().Add(svc1)
		serviceInformer.refreshAllCluster(svc1)
		createGlobalService(globalService, podInformer, svcName, func(clusterSvc *store.ClusterService) {
			clusterSvc.Hostnames = map[string]string{globalSvcIP: hostname}
		})

		var epList *discovery.EndpointSliceList
		require.EventuallyWithT(t, func(c *assert.CollectT) {
			epList, err = getEndpointSlice(&fakeClient, svcName)
			assert.NoError(c, err)
			assert.Len(c, epList.Items, 1)
		}, timeout, tick, "endpointslice is not reconciled correctly")

		require.Equal(t, map[string]string{
			discovery.LabelServiceName:        svcName,
			discovery.LabelManagedBy:          utils.EndpointSliceMeshControllerName,
			mcsapiv1alpha1.LabelSourceCluster: remoteClusterName,
			corev1.IsHeadlessService:          "",
		}, epList.Items[0].Labels)
		require.Len(t, epList.Items[0].Endpoints, 1)

		require.NotNil(t, epList.Items[0].Endpoints[0].Hostname)
		require.Equal(t, hostname, *epList.Items[0].Endpoints[0].Hostname)

		require.Len(t, epList.Items[0].OwnerReferences, 1)
		require.Equal(t, "v1", epList.Items[0].OwnerReferences[0].APIVersion)
		require.Equal(t, "Service", epList.Items[0].OwnerReferences[0].Kind)
		require.Equal(t, "local-svc-global-svc", epList.Items[0].OwnerReferences[0].Name)
	})

	t.Run("Create global service then service", func(t *testing.T) {
		svcName := "global-svc-local-svc"
		createGlobalService(globalService, podInformer, svcName, nil)
		svc1 := createService(svcName)
		svcStore.CacheStore().Add(svc1)
		serviceInformer.refreshAllCluster(svc1)

		var epList *discovery.EndpointSliceList
		require.EventuallyWithT(t, func(c *assert.CollectT) {
			epList, err = getEndpointSlice(&fakeClient, svcName)
			assert.NoError(c, err)
			assert.Len(c, epList.Items, 1)
		}, timeout, tick, "endpointslice is not reconciled correctly")

		require.Equal(t, map[string]string{
			discovery.LabelServiceName:        svcName,
			discovery.LabelManagedBy:          utils.EndpointSliceMeshControllerName,
			mcsapiv1alpha1.LabelSourceCluster: remoteClusterName,
			corev1.IsHeadlessService:          "",
		}, epList.Items[0].Labels)
	})

	t.Run("Create headless service and global service", func(t *testing.T) {
		svcName := "local-svc-headless-global-svc"
		svc1 := createService(svcName)
		svc1.Spec.ClusterIP = corev1.ClusterIPNone

		svcStore.CacheStore().Add(svc1)
		serviceInformer.refreshAllCluster(svc1)
		createGlobalService(globalService, podInformer, svcName, nil)

		require.EventuallyWithT(t, func(c *assert.CollectT) {
			epList, err := getEndpointSlice(&fakeClient, svcName)
			assert.NoError(c, err)
			assert.Len(c, epList.Items, 1)
		}, timeout, tick, "endpointslice is not reconciled correctly")
	})

	t.Run("Create service with global annotation and remove it", func(t *testing.T) {
		svcName := "svc-remove-annotation"
		createGlobalService(globalService, podInformer, svcName, nil)
		svc1 := createService(svcName)
		svcStore.CacheStore().Add(svc1)
		serviceInformer.refreshAllCluster(svc1)

		var epList *discovery.EndpointSliceList
		require.EventuallyWithT(t, func(c *assert.CollectT) {
			// Make sure that we have 1 endpointslice
			epList, err = getEndpointSlice(&fakeClient, svcName)
			assert.NoError(c, err)
			assert.Len(c, epList.Items, 1)
		}, timeout, tick, "endpointslice is not reconciled correctly")

		svc1.Annotations[annotation.GlobalServiceSyncEndpointSlices] = "false"
		svcStore.CacheStore().Update(svc1)
		serviceInformer.refreshAllCluster(svc1)

		require.EventuallyWithT(t, func(c *assert.CollectT) {
			epList, err := getEndpointSlice(&fakeClient, svcName)
			assert.NoError(c, err)
			assert.Len(c, epList.Items, 0)
		}, timeout, tick, "endpointslice is not reconciled correctly")
	})

	t.Run("Create service and global service and then delete global svc", func(t *testing.T) {
		svcName := "local-svc-no-global-svc"
		clusterSvc := createGlobalService(globalService, podInformer, svcName, nil)
		svc1 := createService(svcName)
		svcStore.CacheStore().Add(svc1)
		serviceInformer.refreshAllCluster(svc1)

		var epList *discovery.EndpointSliceList
		require.EventuallyWithT(t, func(c *assert.CollectT) {
			// Make sure that we have 1 endpointslice
			epList, err = getEndpointSlice(&fakeClient, svcName)
			assert.NoError(c, err)
			assert.Len(c, epList.Items, 1)
		}, timeout, tick, "endpointslice is not reconciled correctly")

		globalService.OnDelete(clusterSvc)
		// We manually call the rest of the informer for convenience
		podInformer.onClusterServiceDelete(clusterSvc)

		require.EventuallyWithT(t, func(c *assert.CollectT) {
			epList, err := getEndpointSlice(&fakeClient, svcName)
			assert.NoError(c, err)
			assert.Len(c, epList.Items, 0)
		}, timeout, tick, "endpointslice is not reconciled correctly")
	})
}