Adding the mic package.

This package will be used by the `Module` reconciler in the following
commits.

Signed-off-by: Yoni Bettan <[email protected]>

Author: ybettan

internal/mic/mic.go

@@ -0,0 +1,63 @@
+package mic
+
+import (
+	"context"
+	"fmt"
+
+	kmmv1beta1 "github.com/kubernetes-sigs/kernel-module-management/api/v1beta1"
+	v1 "k8s.io/api/core/v1"
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+	"k8s.io/apimachinery/pkg/runtime"
+	"sigs.k8s.io/controller-runtime/pkg/client"
+	"sigs.k8s.io/controller-runtime/pkg/controller/controllerutil"
+	"sigs.k8s.io/controller-runtime/pkg/log"
+)
+
+//go:generate mockgen -source=mic.go -package=mic -destination=mock_mic.go
+
+type MIC interface {
+	ApplyMIC(ctx context.Context, name, ns string, images []kmmv1beta1.ModuleImageSpec,
+		imageRepoSecret *v1.LocalObjectReference, owner metav1.Object) error
+}
+
+type micImpl struct {
+	client client.Client
+	scheme *runtime.Scheme
+}
+
+func NewModuleImagesConfigAPI(client client.Client, scheme *runtime.Scheme) MIC {
+	return &micImpl{
+		client: client,
+		scheme: scheme,
+	}
+}
+
+func (mici *micImpl) ApplyMIC(ctx context.Context, name, ns string, images []kmmv1beta1.ModuleImageSpec,
+	imageRepoSecret *v1.LocalObjectReference, owner metav1.Object) error {
+
+	logger := log.FromContext(ctx)
+
+	mic := &kmmv1beta1.ModuleImagesConfig{
+		ObjectMeta: metav1.ObjectMeta{
+			Name:      name,
+			Namespace: ns,
+		},
+	}
+
+	opRes, err := controllerutil.CreateOrPatch(ctx, mici.client, mic, func() error {
+
+		mic.Spec = kmmv1beta1.ModuleImagesConfigSpec{
+			Images:          images,
+			ImageRepoSecret: imageRepoSecret,
+		}
+
+		return controllerutil.SetOwnerReference(owner, mic, mici.scheme)
+	})
+	if err != nil {
+		return fmt.Errorf("failed to create or patch %s/%s: %v", ns, name, err)
+	}
+
+	logger.Info("Applied MIC", "name", name, "namespace", ns, "result", opRes)
+
+	return nil
+}

internal/mic/mic_test.go

@@ -0,0 +1,133 @@
+package mic
+
+import (
+	"context"
+
+	kmmv1beta1 "github.com/kubernetes-sigs/kernel-module-management/api/v1beta1"
+	v1beta1 "github.com/kubernetes-sigs/kernel-module-management/api/v1beta1"
+	"github.com/kubernetes-sigs/kernel-module-management/internal/client"
+	. "github.com/onsi/ginkgo/v2"
+	. "github.com/onsi/gomega"
+	gomock "go.uber.org/mock/gomock"
+	v1 "k8s.io/api/core/v1"
+	k8serrors "k8s.io/apimachinery/pkg/api/errors"
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+	"k8s.io/apimachinery/pkg/runtime/schema"
+	"k8s.io/apimachinery/pkg/types"
+	utilruntime "k8s.io/apimachinery/pkg/util/runtime"
+	ctrlclient "sigs.k8s.io/controller-runtime/pkg/client"
+)
+
+var _ = Describe("ApplyMIC", func() {
+
+	const (
+		micName      = "my-name"
+		micNamespace = "my-namespace"
+	)
+
+	var (
+		ctx        context.Context
+		ctrl       *gomock.Controller
+		mockClient *client.MockClient
+		micAPI     MIC
+	)
+
+	BeforeEach(func() {
+		ctx = context.Background()
+		ctrl = gomock.NewController(GinkgoT())
+		mockClient = client.NewMockClient(ctrl)
+		micAPI = NewModuleImagesConfigAPI(mockClient, scheme)
+		utilruntime.Must(v1beta1.AddToScheme(scheme))
+	})
+
+	It("should fail if we failed to create or patch", func() {
+
+		mockClient.EXPECT().Get(ctx, gomock.Any(), gomock.Any()).Return(nil)
+
+		err := micAPI.ApplyMIC(ctx, micName, micNamespace, []v1beta1.ModuleImageSpec{}, nil, nil)
+
+		Expect(err).To(HaveOccurred())
+		Expect(err.Error()).To(ContainSubstring("failed to create or patch"))
+		Expect(err.Error()).To(ContainSubstring("cannot call SetOwnerReference"))
+	})
+
+	It("should create the MIC if it doesn't exist", func() {
+
+		gomock.InOrder(
+			mockClient.EXPECT().Get(ctx, types.NamespacedName{Name: micName, Namespace: micNamespace},
+				gomock.Any()).Return(k8serrors.NewNotFound(schema.GroupResource{}, micName)),
+			mockClient.EXPECT().Create(ctx, gomock.Any()).Return(nil),
+		)
+
+		images := []kmmv1beta1.ModuleImageSpec{
+			{
+				Image: "example.registry.com/org/user/image1:tag",
+			},
+			{
+				Image: "example.registry.com/org/user/image2:tag",
+			},
+		}
+
+		imageRepoSecret :=
+			&v1.LocalObjectReference{
+				Name: "some-secret",
+			}
+
+		owner := &kmmv1beta1.Module{
+			ObjectMeta: metav1.ObjectMeta{
+				Name:      "my-module",
+				Namespace: micNamespace,
+			},
+		}
+
+		err := micAPI.ApplyMIC(ctx, micName, micNamespace, images, imageRepoSecret, owner)
+
+		Expect(err).NotTo(HaveOccurred())
+	})
+
+	It("should patch the MIC if it exists", func() {
+
+		gomock.InOrder(
+			mockClient.EXPECT().Get(ctx, types.NamespacedName{Name: micName, Namespace: micNamespace}, gomock.Any()).DoAndReturn(
+				func(_ interface{}, _ interface{}, mic *kmmv1beta1.ModuleImagesConfig, _ ...ctrlclient.GetOption) error {
+					mic.ObjectMeta = metav1.ObjectMeta{
+						Name:      micName,
+						Namespace: micNamespace,
+					}
+					mic.Spec = kmmv1beta1.ModuleImagesConfigSpec{
+						Images: []kmmv1beta1.ModuleImageSpec{
+							{
+								Image: "example.registry.com/org/user/image1:tag",
+							},
+							{
+								Image: "example.registry.com/org/user/image2:tag",
+							},
+						},
+						ImageRepoSecret: &v1.LocalObjectReference{
+							Name: "some-secret",
+						},
+					}
+					return nil
+				},
+			),
+			mockClient.EXPECT().Patch(ctx, gomock.Any(), gomock.Any()),
+		)
+
+		images := []kmmv1beta1.ModuleImageSpec{
+			{
+				Image: "example.registry.com/org/user/image3:tag",
+			},
+		}
+
+		owner := &kmmv1beta1.Module{
+			ObjectMeta: metav1.ObjectMeta{
+				Name:      "my-module",
+				Namespace: micNamespace,
+			},
+		}
+
+		err := micAPI.ApplyMIC(ctx, micName, micNamespace, images, nil, owner)
+
+		Expect(err).NotTo(HaveOccurred())
+	})
+})

internal/mic/mock_mic.go

@@ -0,0 +1,22 @@
+package mic
+
+import (
+	"testing"
+
+	"github.com/kubernetes-sigs/kernel-module-management/internal/test"
+	. "github.com/onsi/ginkgo/v2"
+	. "github.com/onsi/gomega"
+	"k8s.io/apimachinery/pkg/runtime"
+)
+
+var scheme *runtime.Scheme
+
+func TestSuite(t *testing.T) {
+	RegisterFailHandler(Fail)
+
+	var err error
+	scheme, err = test.TestScheme()
+	Expect(err).NotTo(HaveOccurred())
+
+	RunSpecs(t, "MIC Suite")
+}