21589617294

Committed 02 Feb 2026 12:13PM UTC coverage: 65.546% (+0.06%) from 65.488%

Build # 21589617294

Build Type

push

github

Committed by

jastBytes

Commit Message

Refactor DiscoveryReconciler to use dedicated methods for worker resource management

Coverage Stats

13 of 23 new or added lines in 1 file covered. (56.52%)

2 existing lines in 1 file now uncovered.

468 of 714 relevant lines covered (65.55%)

4.64 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

70.3

/pkg/controller/discovery_controller.go

// Copyright 2026 BWI GmbH and Artefact Conduit contributors
// SPDX-License-Identifier: Apache-2.0

package controller

import (
        "context"
        "fmt"
        "slices"

        solarv1alpha1 "go.opendefense.cloud/solar/api/solar/v1alpha1"
        corev1 "k8s.io/api/core/v1"
        apierrors "k8s.io/apimachinery/pkg/api/errors"
        metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
        "k8s.io/apimachinery/pkg/runtime"
        "k8s.io/client-go/tools/record"
        ctrl "sigs.k8s.io/controller-runtime"

        "k8s.io/client-go/kubernetes"
        "sigs.k8s.io/controller-runtime/pkg/controller/controllerutil"

        "sigs.k8s.io/controller-runtime/pkg/client"
)

const (
        discoveryFinalizer = "solar.opendefense.cloud/discovery-finalizer"
)

// DiscoveryReconciler reconciles a Discovery object
type DiscoveryReconciler struct {
        client.Client
        ClientSet     kubernetes.Interface
        Scheme        *runtime.Scheme
        Recorder      record.EventRecorder
        WorkerImage   string
        WorkerCommand string
        WorkerArgs    []string
}

//+kubebuilder:rbac:groups=solar.opendefense.cloud,resources=discoveries,verbs=get;list;watch;create;update;patch;delete
//+kubebuilder:rbac:groups=solar.opendefense.cloud,resources=discoveries/status,verbs=get;update;patch
//+kubebuilder:rbac:groups=solar.opendefense.cloud,resources=discoveries/finalizers,verbs=update
//+kubebuilder:rbac:groups="",resources=pods,verbs=get;list;watch;create;update;patch;delete
//+kubebuilder:rbac:groups="",resources=secrets,verbs=get;list;watch;create;update;patch;delete
//+kubebuilder:rbac:groups=core,resources=events,verbs=create;patch

// Reconcile moves the current state of the cluster closer to the desired state
func (r *DiscoveryReconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctrl.Result, error) {
        log := ctrl.LoggerFrom(ctx)
        ctrlResult := ctrl.Result{}

        log.V(1).Info("Discovery is being reconciled", "req", req)

        // Fetch the Order instance
        res := &solarv1alpha1.Discovery{}
        if err := r.Get(ctx, req.NamespacedName, res); err != nil {
                if apierrors.IsNotFound(err) {
                        // Object not found, return. Created objects are automatically garbage collected.
                        return ctrlResult, nil
                }
                return ctrlResult, errLogAndWrap(log, err, "failed to get object")
        }

        // Handle deletion: cleanup artifact workflows, then remove finalizer
        if !res.DeletionTimestamp.IsZero() {
                log.V(1).Info("Discovery is being deleted")
                r.Recorder.Event(res, corev1.EventTypeWarning, "Deleting", "Discovery is being deleted, cleaning up worker")

                // Cleanup worker resources, if exists
                if err := r.deleteWorkerResources(ctx, res); err != nil {
                        return ctrlResult, errLogAndWrap(log, err, "failed to clean up worker resources")
                }

                // Remove finalizer
                if slices.Contains(res.Finalizers, discoveryFinalizer) {
                        log.V(1).Info("Removing finalizer from resource")
                        res.Finalizers = slices.DeleteFunc(res.Finalizers, func(f string) bool {
                                return f == discoveryFinalizer
                        })
                        if err := r.Update(ctx, res); err != nil {
                                return ctrlResult, errLogAndWrap(log, err, "failed to remove finalizer")
                        }
                }
        }

        // Add finalizer if not present and not deleting
        if res.DeletionTimestamp.IsZero() {
                if !slices.Contains(res.Finalizers, discoveryFinalizer) {
                        log.V(1).Info("Adding finalizer to resource")
                        res.Finalizers = append(res.Finalizers, discoveryFinalizer)
                        if err := r.Update(ctx, res); err != nil {
                                return ctrlResult, errLogAndWrap(log, err, "failed to add finalizer")
                        }
                        // Return without requeue; the Update event will trigger reconciliation again
                        return ctrlResult, nil
                }
        }

        pod, err := r.ClientSet.CoreV1().Pods(res.Namespace).Get(ctx, discoveryPrefixed(res.Name), metav1.GetOptions{})
        if err != nil && !apierrors.IsNotFound(err) {
                r.Recorder.Eventf(res, corev1.EventTypeWarning, "Reconcile", "Failed to get pod", err)
                return ctrlResult, errLogAndWrap(log, err, "failed to get pod information")
        }

        // No pod yet, create it.
        if pod == nil || pod.Name == "" {
                if err := r.createWorkerResources(ctx, res); err != nil {
                        return ctrlResult, errLogAndWrap(log, err, "failed to create pod")
                }
                return ctrlResult, nil
        }

        // Pod exists, check if it's up to date with our configuration and if it is healthy.
        if res.Status.PodGeneration != res.GetGeneration() {
                // Recreate pod, configuration mismatch
                r.Recorder.Eventf(res, corev1.EventTypeNormal, "Reconcile", "Configuration changed. Replacing pod.")
                if err := r.deleteWorkerResources(ctx, res); err != nil {
                        return ctrlResult, errLogAndWrap(log, err, "failed to clean up worker resources")
                }

                if err := r.createWorkerResources(ctx, res); err != nil {
                        return ctrlResult, errLogAndWrap(log, err, "failed to create pod")
                }
                return ctrlResult, nil
        } else {
                log.V(1).Info("Configuration hasn't changed", "podGen", res.Status.PodGeneration, "gen", res.GetGeneration())
        }

        return ctrlResult, nil
}

// deleteWorkerResources deletes the resources of the worker pod
func (r *DiscoveryReconciler) deleteWorkerResources(ctx context.Context, res *solarv1alpha1.Discovery) error {
        log := ctrl.LoggerFrom(ctx)

        if err := r.ClientSet.CoreV1().Secrets(res.Namespace).Delete(ctx, discoveryPrefixed(res.Name), metav1.DeleteOptions{}); err != nil && !apierrors.IsNotFound(err) {
                r.Recorder.Eventf(res, corev1.EventTypeWarning, "DeletionFailed", "Failed to delete secret", err)
                return errLogAndWrap(log, err, "secret deletion failed")
        }
        if err := r.ClientSet.CoreV1().Pods(res.Namespace).Delete(ctx, discoveryPrefixed(res.Name), metav1.DeleteOptions{}); err != nil && !apierrors.IsNotFound(err) {
                r.Recorder.Eventf(res, corev1.EventTypeWarning, "DeletionFailed", "Failed to delete pod", err)
                return errLogAndWrap(log, err, "pod deletion failed")
        }

        return nil
}

// createWorkerResources creates the necessary resources for the worker pod
func (r *DiscoveryReconciler) createWorkerResources(ctx context.Context, res *solarv1alpha1.Discovery) error {
        log := ctrl.LoggerFrom(ctx)

        // Create secret
        // TODO: Use the actual configuration file instead of a dummy one
        secret := &corev1.Secret{
                ObjectMeta: metav1.ObjectMeta{
                        Namespace: res.Namespace,
                        Name:      discoveryPrefixed(res.Name),
                },
                StringData: map[string]string{
                        "config.yaml": "not implemented",
                },
        }
        _, err := r.ClientSet.CoreV1().Secrets(res.Namespace).Create(ctx, secret, metav1.CreateOptions{})
        if err != nil {
                r.Recorder.Eventf(res, corev1.EventTypeWarning, "CreationFailed", "Failed to create secret", err)
                return errLogAndWrap(log, err, "failed to create secret")
        }
        r.Recorder.Eventf(res, corev1.EventTypeNormal, "PodCreate", "Secret created")

        // Set owner references
        if err := controllerutil.SetControllerReference(res, secret, r.Scheme); err != nil {
                return errLogAndWrap(log, err, "failed to set controller reference")
        }

        // Create pod
        var args []string
        args = append(args, r.WorkerArgs...)
        args = append(args, "--config", "/etc/worker/config.yaml")
        pod := &corev1.Pod{
                ObjectMeta: metav1.ObjectMeta{
                        Name:        discoveryPrefixed(res.Name),
                        Namespace:   res.Namespace,
                        Labels:      res.Labels,
                        Annotations: res.Annotations,
                },
                Spec: corev1.PodSpec{
                        Containers: []corev1.Container{
                                {
                                        Name:    "worker",
                                        Image:   r.WorkerImage,
                                        Command: []string{r.WorkerCommand},
                                        Args:    args,
                                        VolumeMounts: []corev1.VolumeMount{
                                                {
                                                        Name:      "config",
                                                        ReadOnly:  true,
                                                        MountPath: "/etc/worker"},
                                        },
                                },
                        },
                        Volumes: []corev1.Volume{
                                {
                                        Name: "config",
                                        VolumeSource: corev1.VolumeSource{
                                                Secret: &corev1.SecretVolumeSource{
                                                        SecretName: res.Name,
                                                },
                                        },
                                },
                        },
                },
        }

        // Set owner references
        if err := controllerutil.SetControllerReference(res, pod, r.Scheme); err != nil {
                return errLogAndWrap(log, err, "failed to set controller reference")
        }

        _, err = r.ClientSet.CoreV1().Pods(res.Namespace).Create(ctx, pod, metav1.CreateOptions{})
        if err != nil {
                r.Recorder.Eventf(res, corev1.EventTypeWarning, "PodCreate", "Failed to create pod", err)
                return errLogAndWrap(log, err, "failed to create pod")
        }
        r.Recorder.Eventf(res, corev1.EventTypeNormal, "PodCreate", "Worker pod created")
        log.V(1).Info("Pod created", "podGen", res.GetGeneration())

        // Update discovery version in status
        res.Status.PodGeneration = res.GetGeneration()
        if err := r.Status().Update(ctx, res); err != nil {
                return errLogAndWrap(log, err, "failed to update status")
        }

        return nil
}

// discoveryPrefixed returns the name of the discovery prefixed resource
func discoveryPrefixed(discoveryName string) string {
        return fmt.Sprintf("discovery-%s", discoveryName)
}

// SetupWithManager sets up the controller with the Manager.
func (r *DiscoveryReconciler) SetupWithManager(mgr ctrl.Manager) error {
        return ctrl.NewControllerManagedBy(mgr).
                For(&solarv1alpha1.Discovery{}).
                Owns(&corev1.Pod{}).
                Owns(&corev1.Secret{}).
                Complete(r)
}

1	// Copyright 2026 BWI GmbH and Artefact Conduit contributors
2	// SPDX-License-Identifier: Apache-2.0
3
4	package controller
5
6	import (
7	"context"
8	"fmt"
9	"slices"
10
11	solarv1alpha1 "go.opendefense.cloud/solar/api/solar/v1alpha1"
12	corev1 "k8s.io/api/core/v1"
13	apierrors "k8s.io/apimachinery/pkg/api/errors"
14	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
15	"k8s.io/apimachinery/pkg/runtime"
16	"k8s.io/client-go/tools/record"
17	ctrl "sigs.k8s.io/controller-runtime"
18
19	"k8s.io/client-go/kubernetes"
20	"sigs.k8s.io/controller-runtime/pkg/controller/controllerutil"
21
22	"sigs.k8s.io/controller-runtime/pkg/client"
23	)
24
25	const (
26	discoveryFinalizer = "solar.opendefense.cloud/discovery-finalizer"
27	)
28
29	// DiscoveryReconciler reconciles a Discovery object
30	type DiscoveryReconciler struct {
31	client.Client
32	ClientSet kubernetes.Interface
33	Scheme *runtime.Scheme
34	Recorder record.EventRecorder
35	WorkerImage string
36	WorkerCommand string
37	WorkerArgs []string
38	}
39
40	//+kubebuilder:rbac:groups=solar.opendefense.cloud,resources=discoveries,verbs=get;list;watch;create;update;patch;delete
41	//+kubebuilder:rbac:groups=solar.opendefense.cloud,resources=discoveries/status,verbs=get;update;patch
42	//+kubebuilder:rbac:groups=solar.opendefense.cloud,resources=discoveries/finalizers,verbs=update
43	//+kubebuilder:rbac:groups="",resources=pods,verbs=get;list;watch;create;update;patch;delete
44	//+kubebuilder:rbac:groups="",resources=secrets,verbs=get;list;watch;create;update;patch;delete
45	//+kubebuilder:rbac:groups=core,resources=events,verbs=create;patch
46
47	// Reconcile moves the current state of the cluster closer to the desired state
48	func (r *DiscoveryReconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctrl.Result, error) {	5✔
49	log := ctrl.LoggerFrom(ctx)	5✔
50	ctrlResult := ctrl.Result{}	5✔
51		5✔
52	log.V(1).Info("Discovery is being reconciled", "req", req)	5✔
53		5✔
54	// Fetch the Order instance	5✔
55	res := &solarv1alpha1.Discovery{}	5✔
56	if err := r.Get(ctx, req.NamespacedName, res); err != nil {	5✔
57	if apierrors.IsNotFound(err) {	×
58	// Object not found, return. Created objects are automatically garbage collected.	×
59	return ctrlResult, nil	×
60	}	×
61	return ctrlResult, errLogAndWrap(log, err, "failed to get object")	×
62	}
63
64	// Handle deletion: cleanup artifact workflows, then remove finalizer
65	if !res.DeletionTimestamp.IsZero() {	5✔
66	log.V(1).Info("Discovery is being deleted")	×
67	r.Recorder.Event(res, corev1.EventTypeWarning, "Deleting", "Discovery is being deleted, cleaning up worker")	×
68		×
NEW 69	// Cleanup worker resources, if exists	×
NEW 70	if err := r.deleteWorkerResources(ctx, res); err != nil {	×
NEW 71	return ctrlResult, errLogAndWrap(log, err, "failed to clean up worker resources")	×
UNCOV 72	}	×
73
74	// Remove finalizer
75	if slices.Contains(res.Finalizers, discoveryFinalizer) {	×
76	log.V(1).Info("Removing finalizer from resource")	×
77	res.Finalizers = slices.DeleteFunc(res.Finalizers, func(f string) bool {	×
78	return f == discoveryFinalizer	×
79	})	×
80	if err := r.Update(ctx, res); err != nil {	×
81	return ctrlResult, errLogAndWrap(log, err, "failed to remove finalizer")	×
82	}	×
83	}
84	}
85
86	// Add finalizer if not present and not deleting
87	if res.DeletionTimestamp.IsZero() {	10✔
88	if !slices.Contains(res.Finalizers, discoveryFinalizer) {	6✔
89	log.V(1).Info("Adding finalizer to resource")	1✔
90	res.Finalizers = append(res.Finalizers, discoveryFinalizer)	1✔
91	if err := r.Update(ctx, res); err != nil {	1✔
92	return ctrlResult, errLogAndWrap(log, err, "failed to add finalizer")	×
93	}	×
94	// Return without requeue; the Update event will trigger reconciliation again
95	return ctrlResult, nil	1✔
96	}
97	}
98
99	pod, err := r.ClientSet.CoreV1().Pods(res.Namespace).Get(ctx, discoveryPrefixed(res.Name), metav1.GetOptions{})	4✔
100	if err != nil && !apierrors.IsNotFound(err) {	4✔
101	r.Recorder.Eventf(res, corev1.EventTypeWarning, "Reconcile", "Failed to get pod", err)	×
102	return ctrlResult, errLogAndWrap(log, err, "failed to get pod information")	×
103	}	×
104
105	// No pod yet, create it.
106	if pod == nil \|\| pod.Name == "" {	5✔
107	if err := r.createWorkerResources(ctx, res); err != nil {	1✔
108	return ctrlResult, errLogAndWrap(log, err, "failed to create pod")	×
109	}	×
110	return ctrlResult, nil	1✔
111	}
112
113	// Pod exists, check if it's up to date with our configuration and if it is healthy.
114	if res.Status.PodGeneration != res.GetGeneration() {	4✔
115	// Recreate pod, configuration mismatch	1✔
116	r.Recorder.Eventf(res, corev1.EventTypeNormal, "Reconcile", "Configuration changed. Replacing pod.")	1✔
117	if err := r.deleteWorkerResources(ctx, res); err != nil {	1✔
NEW 118	return ctrlResult, errLogAndWrap(log, err, "failed to clean up worker resources")	×
UNCOV 119	}	×
120
121	if err := r.createWorkerResources(ctx, res); err != nil {	1✔
122	return ctrlResult, errLogAndWrap(log, err, "failed to create pod")	×
123	}	×
124	return ctrlResult, nil	1✔
125	} else {	2✔
126	log.V(1).Info("Configuration hasn't changed", "podGen", res.Status.PodGeneration, "gen", res.GetGeneration())	2✔
127	}	2✔
128
129	return ctrlResult, nil	2✔
130	}
131
132	// deleteWorkerResources deletes the resources of the worker pod
133	func (r DiscoveryReconciler) deleteWorkerResources(ctx context.Context, res solarv1alpha1.Discovery) error {	1✔
134	log := ctrl.LoggerFrom(ctx)	1✔
135		1✔
136	if err := r.ClientSet.CoreV1().Secrets(res.Namespace).Delete(ctx, discoveryPrefixed(res.Name), metav1.DeleteOptions{}); err != nil && !apierrors.IsNotFound(err) {	1✔
NEW 137	r.Recorder.Eventf(res, corev1.EventTypeWarning, "DeletionFailed", "Failed to delete secret", err)	×
NEW 138	return errLogAndWrap(log, err, "secret deletion failed")	×
NEW 139	}	×
140	if err := r.ClientSet.CoreV1().Pods(res.Namespace).Delete(ctx, discoveryPrefixed(res.Name), metav1.DeleteOptions{}); err != nil && !apierrors.IsNotFound(err) {	1✔
NEW 141	r.Recorder.Eventf(res, corev1.EventTypeWarning, "DeletionFailed", "Failed to delete pod", err)	×
NEW 142	return errLogAndWrap(log, err, "pod deletion failed")	×
NEW 143	}	×
144
145	return nil	1✔
146	}
147
148	// createWorkerResources creates the necessary resources for the worker pod
149	func (r DiscoveryReconciler) createWorkerResources(ctx context.Context, res solarv1alpha1.Discovery) error {	2✔
150	log := ctrl.LoggerFrom(ctx)	2✔
151		2✔
152	// Create secret	2✔
153	// TODO: Use the actual configuration file instead of a dummy one	2✔
154	secret := &corev1.Secret{	2✔
155	ObjectMeta: metav1.ObjectMeta{	2✔
156	Namespace: res.Namespace,	2✔
157	Name: discoveryPrefixed(res.Name),	2✔
158	},	2✔
159	StringData: map[string]string{	2✔
160	"config.yaml": "not implemented",	2✔
161	},	2✔
162	}	2✔
163	_, err := r.ClientSet.CoreV1().Secrets(res.Namespace).Create(ctx, secret, metav1.CreateOptions{})	2✔
164	if err != nil {	2✔
165	r.Recorder.Eventf(res, corev1.EventTypeWarning, "CreationFailed", "Failed to create secret", err)	×
166	return errLogAndWrap(log, err, "failed to create secret")	×
167	}	×
168	r.Recorder.Eventf(res, corev1.EventTypeNormal, "PodCreate", "Secret created")	2✔
169		2✔
170	// Set owner references	2✔
171	if err := controllerutil.SetControllerReference(res, secret, r.Scheme); err != nil {	2✔
172	return errLogAndWrap(log, err, "failed to set controller reference")	×
173	}	×
174
175	// Create pod
176	var args []string	2✔
177	args = append(args, r.WorkerArgs...)	2✔
178	args = append(args, "--config", "/etc/worker/config.yaml")	2✔
179	pod := &corev1.Pod{	2✔
180	ObjectMeta: metav1.ObjectMeta{	2✔
181	Name: discoveryPrefixed(res.Name),	2✔
182	Namespace: res.Namespace,	2✔
183	Labels: res.Labels,	2✔
184	Annotations: res.Annotations,	2✔
185	},	2✔
186	Spec: corev1.PodSpec{	2✔
187	Containers: []corev1.Container{	2✔
188	{	2✔
189	Name: "worker",	2✔
190	Image: r.WorkerImage,	2✔
191	Command: []string{r.WorkerCommand},	2✔
192	Args: args,	2✔
193	VolumeMounts: []corev1.VolumeMount{	2✔
194	{	2✔
195	Name: "config",	2✔
196	ReadOnly: true,	2✔
197	MountPath: "/etc/worker"},	2✔
198	},	2✔
199	},	2✔
200	},	2✔
201	Volumes: []corev1.Volume{	2✔
202	{	2✔
203	Name: "config",	2✔
204	VolumeSource: corev1.VolumeSource{	2✔
205	Secret: &corev1.SecretVolumeSource{	2✔
206	SecretName: res.Name,	2✔
207	},	2✔
208	},	2✔
209	},	2✔
210	},	2✔
211	},	2✔
212	}	2✔
213		2✔
214	// Set owner references	2✔
215	if err := controllerutil.SetControllerReference(res, pod, r.Scheme); err != nil {	2✔
216	return errLogAndWrap(log, err, "failed to set controller reference")	×
217	}	×
218
219	_, err = r.ClientSet.CoreV1().Pods(res.Namespace).Create(ctx, pod, metav1.CreateOptions{})	2✔
220	if err != nil {	2✔
221	r.Recorder.Eventf(res, corev1.EventTypeWarning, "PodCreate", "Failed to create pod", err)	×
222	return errLogAndWrap(log, err, "failed to create pod")	×
223	}	×
224	r.Recorder.Eventf(res, corev1.EventTypeNormal, "PodCreate", "Worker pod created")	2✔
225	log.V(1).Info("Pod created", "podGen", res.GetGeneration())	2✔
226		2✔
227	// Update discovery version in status	2✔
228	res.Status.PodGeneration = res.GetGeneration()	2✔
229	if err := r.Status().Update(ctx, res); err != nil {	2✔
230	return errLogAndWrap(log, err, "failed to update status")	×
231	}	×
232
233	return nil	2✔
234	}
235
236	// discoveryPrefixed returns the name of the discovery prefixed resource
237	func discoveryPrefixed(discoveryName string) string {	12✔
238	return fmt.Sprintf("discovery-%s", discoveryName)	12✔
239	}	12✔
240
241	// SetupWithManager sets up the controller with the Manager.
242	func (r *DiscoveryReconciler) SetupWithManager(mgr ctrl.Manager) error {	1✔
243	return ctrl.NewControllerManagedBy(mgr).	1✔
244	For(&solarv1alpha1.Discovery{}).	1✔
245	Owns(&corev1.Pod{}).	1✔
246	Owns(&corev1.Secret{}).	1✔
247	Complete(r)	1✔
248	}	1✔

opendefensecloud / solution-arsenal / 21589617294

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous