loki/operator/controllers/lokistack_controller_test.go

package controllers

import (
	"flag"
	"io/ioutil"
	"os"
	"testing"

	lokiv1beta1 "github.com/grafana/loki/operator/api/v1beta1"
	"github.com/grafana/loki/operator/internal/external/k8s/k8sfakes"
	"github.com/grafana/loki/operator/internal/manifests"

	"github.com/ViaQ/logerr/log"
	routev1 "github.com/openshift/api/route/v1"
	"github.com/stretchr/testify/require"
	appsv1 "k8s.io/api/apps/v1"
	corev1 "k8s.io/api/core/v1"
	networkingv1 "k8s.io/api/networking/v1"
	rbacv1 "k8s.io/api/rbac/v1"
	"k8s.io/apimachinery/pkg/runtime"
	utilruntime "k8s.io/apimachinery/pkg/util/runtime"
	clientgoscheme "k8s.io/client-go/kubernetes/scheme"
	"sigs.k8s.io/controller-runtime/pkg/builder"
	"sigs.k8s.io/controller-runtime/pkg/client"
)

var (
	logger = log.NewLogger("testing")

	scheme = runtime.NewScheme()
)

func TestMain(m *testing.M) {
	testing.Init()
	flag.Parse()

	sink := log.MustGetSink(logger)
	if testing.Verbose() {
		// set to the highest for verbose testing
		sink.SetVerbosity(5)
	} else {
		sink.SetOutput(ioutil.Discard)
	}

	// Register the clientgo and CRD schemes
	utilruntime.Must(clientgoscheme.AddToScheme(scheme))
	utilruntime.Must(routev1.AddToScheme(scheme))
	utilruntime.Must(lokiv1beta1.AddToScheme(scheme))

	os.Exit(m.Run())
}

func TestLokiStackController_RegistersCustomResourceForCreateOrUpdate(t *testing.T) {
	b := &k8sfakes.FakeBuilder{}
	k := &k8sfakes.FakeClient{}
	c := &LokiStackReconciler{Client: k, Scheme: scheme}

	b.ForReturns(b)
	b.OwnsReturns(b)

	err := c.buildController(b)
	require.NoError(t, err)

	// Require only one For-Call for the custom resource
	require.Equal(t, 1, b.ForCallCount())

	// Require For-call options to have create and  update predicates
	obj, opts := b.ForArgsForCall(0)
	require.Equal(t, &lokiv1beta1.LokiStack{}, obj)
	require.Equal(t, opts[0], createOrUpdateOnlyPred)
}

func TestLokiStackController_RegisterOwnedResourcesForUpdateOrDeleteOnly(t *testing.T) {
	k := &k8sfakes.FakeClient{}

	// Require owned resources
	type test struct {
		obj   client.Object
		index int
		flags manifests.FeatureFlags
		pred  builder.OwnsOption
	}
	table := []test{
		{
			obj:   &corev1.ConfigMap{},
			index: 0,
			pred:  updateOrDeleteOnlyPred,
		},
		{
			obj:   &corev1.ServiceAccount{},
			index: 1,
			pred:  updateOrDeleteOnlyPred,
		},
		{
			obj:   &corev1.Service{},
			index: 2,
			pred:  updateOrDeleteOnlyPred,
		},
		{
			obj:   &appsv1.Deployment{},
			index: 3,
			pred:  updateOrDeleteOnlyPred,
		},
		{
			obj:   &appsv1.StatefulSet{},
			index: 4,
			pred:  updateOrDeleteOnlyPred,
		},
		{
			obj:   &rbacv1.ClusterRole{},
			index: 5,
			pred:  updateOrDeleteOnlyPred,
		},
		{
			obj:   &rbacv1.ClusterRoleBinding{},
			index: 6,
			pred:  updateOrDeleteOnlyPred,
		},
		{
			obj:   &rbacv1.Role{},
			index: 7,
			pred:  updateOrDeleteOnlyPred,
		},
		{
			obj:   &rbacv1.RoleBinding{},
			index: 8,
			pred:  updateOrDeleteOnlyPred,
		},
		// The next two share the same index, because the
		// controller either reconciles an Ingress (i.e. Kubernetes)
		// or a Route (i.e. OpenShift).
		{
			obj:   &networkingv1.Ingress{},
			index: 9,
			flags: manifests.FeatureFlags{
				EnableGatewayRoute: false,
			},
			pred: updateOrDeleteOnlyPred,
		},
		{
			obj:   &routev1.Route{},
			index: 9,
			flags: manifests.FeatureFlags{
				EnableGatewayRoute: true,
			},
			pred: updateOrDeleteOnlyPred,
		},
	}
	for _, tst := range table {
		b := &k8sfakes.FakeBuilder{}
		b.ForReturns(b)
		b.OwnsReturns(b)

		c := &LokiStackReconciler{Client: k, Scheme: scheme, Flags: tst.flags}
		err := c.buildController(b)
		require.NoError(t, err)

		// Require Owns-Calls for all owned resources
		require.Equal(t, 10, b.OwnsCallCount())

		// Require Owns-call options to have delete predicate only
		obj, opts := b.OwnsArgsForCall(tst.index)
		require.Equal(t, tst.obj, obj)
		require.Equal(t, tst.pred, opts[0])
	}
}