19538961582

Committed 20 Nov 2025 01:44PM UTC coverage: 61.224% (-0.3%) from 61.516%

Build # 19538961582

Build Type

push

github

Committed by

web-flow

Commit Message

mkdocs now contains ADR 003 (#60)

Close #57

Coverage Stats

420 of 686 relevant lines covered (61.22%)

858.13 hits per line

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

87.18

/pkg/controller/artifactworkflow_controller.go

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

package controller

import (
        "context"
        "slices"

        wfv1alpha1 "github.com/argoproj/argo-workflows/v3/pkg/apis/workflow/v1alpha1"
        "github.com/go-logr/logr"
        arcv1alpha1 "go.opendefense.cloud/arc/api/arc/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"
        ctrl "sigs.k8s.io/controller-runtime"
        "sigs.k8s.io/controller-runtime/pkg/client"
        "sigs.k8s.io/controller-runtime/pkg/controller/controllerutil"
)

const (
        artifactWorkflowFinalizer = "arc.bwi.de/artifact-workflow-finalizer"
)

// ArtifactWorkflowReconciler reconciles a ArtifactWorkflow object
type ArtifactWorkflowReconciler struct {
        client.Client
        Scheme *runtime.Scheme
}

//+kubebuilder:rbac:groups=arc.bwi.de,resources=artifacttypes,verbs=get;list;watch
//+kubebuilder:rbac:groups=arc.bwi.de,resources=artifactworkflows/status,verbs=get;update;patch
//+kubebuilder:rbac:groups=arc.bwi.de,resources=artifactworkflows/finalizers,verbs=update
//+kubebuilder:rbac:groups="",resources=secrets,verbs=get;list;watch;create;update;patch;delete
//+kubebuilder:rbac:groups=argoproj.io,resources=workflows,verbs=get;list;watch;create;update;patch;delete

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

        aw := &arcv1alpha1.ArtifactWorkflow{}
        if err := r.Get(ctx, req.NamespacedName, aw); err != nil {
                if apierrors.IsNotFound(err) {
                        // Object not found, return.
                        return ctrl.Result{}, nil
                }
                return ctrl.Result{}, errLogAndWrap(log, err, "failed to get object")
        }

        if !aw.DeletionTimestamp.IsZero() {
                log.V(1).Info("ArtifactWorkflow is being deleted")
                // Cleanup workflow, if exists
                wf := wfv1alpha1.Workflow{
                        ObjectMeta: metav1.ObjectMeta{
                                Namespace: aw.Namespace,
                                Name:      aw.Name,
                        },
                }
                if err := r.Delete(ctx, &wf); client.IgnoreNotFound(err) != nil {
                        return ctrl.Result{}, errLogAndWrap(log, err, "workflow deletion failed")
                }
                // Remove finalizer
                if slices.Contains(aw.Finalizers, artifactWorkflowFinalizer) {
                        log.V(1).Info("Removing finalizer from ArtifactWorkflow")
                        aw.Finalizers = slices.DeleteFunc(aw.Finalizers, func(f string) bool {
                                return f == artifactWorkflowFinalizer
                        })
                        if err := r.Update(ctx, aw); err != nil {
                                return ctrl.Result{}, errLogAndWrap(log, err, "failed to remove finalizer")
                        }
                }
                return ctrl.Result{}, nil
        }

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

        if aw.Status.Phase.Completed() {
                // TODO: check if message has to be compiled from logs of workflow etc...
                return ctrl.Result{}, nil
        }

        if aw.Status.Phase == arcv1alpha1.WorkflowUnknown {
                return r.createArgoWorkflow(ctx, log, aw)
        }

        if aw.Status.Phase.InProgress() {
                return r.checkArgoWorkflow(ctx, log, aw)
        }

        return ctrl.Result{}, nil
}

func (r *ArtifactWorkflowReconciler) createArgoWorkflow(ctx context.Context, log logr.Logger, aw *arcv1alpha1.ArtifactWorkflow) (ctrl.Result, error) {
        artifactType := arcv1alpha1.ArtifactType{}
        if err := r.Get(ctx, namespacedName("", aw.Spec.Type), &artifactType); err != nil {
                return ctrl.Result{}, errLogAndWrap(log, err, "failed to retrieve artifact type")
        }

        srcSecret := corev1.Secret{}
        if aw.Spec.SrcSecretRef.Name != "" {
                if err := r.Get(ctx, namespacedName(aw.Namespace, aw.Spec.SrcSecretRef.Name), &srcSecret); err != nil {
                        return ctrl.Result{}, errLogAndWrap(log, err, "failed to fetch secret for source")
                }
        }

        dstSecret := corev1.Secret{}
        if aw.Spec.DstSecretRef.Name != "" {
                if err := r.Get(ctx, namespacedName(aw.Namespace, aw.Spec.DstSecretRef.Name), &dstSecret); err != nil {
                        return ctrl.Result{}, errLogAndWrap(log, err, "failed to fetch secret for destination")
                }
        }

        wf := r.hydrateArgoWorkflow(aw, &artifactType, &srcSecret, &dstSecret)

        if err := controllerutil.SetControllerReference(aw, wf, r.Scheme); err != nil {
                return ctrl.Result{}, errLogAndWrap(log, err, "failed to set controller reference")
        }

        if err := r.Create(ctx, wf); client.IgnoreAlreadyExists(err) != nil {
                return ctrl.Result{}, errLogAndWrap(log, err, "failed to create argo workflow")
        }

        aw.Status.Phase = arcv1alpha1.WorkflowPending
        if err := r.Status().Update(ctx, aw); err != nil {
                return ctrl.Result{}, errLogAndWrap(log, err, "failed to update status")
        }
        return ctrl.Result{}, nil
}

func (r *ArtifactWorkflowReconciler) hydrateArgoWorkflow(aw *arcv1alpha1.ArtifactWorkflow, artifactType *arcv1alpha1.ArtifactType, srcSecret *corev1.Secret, dstSecret *corev1.Secret) *wfv1alpha1.Workflow {

        srcVolume := corev1.Volume{
                Name: "src-secret-vol",
                VolumeSource: corev1.VolumeSource{
                        EmptyDir: &corev1.EmptyDirVolumeSource{},
                },
        }
        if srcSecret.Name != "" {
                srcVolume.VolumeSource = corev1.VolumeSource{
                        Secret: &corev1.SecretVolumeSource{
                                SecretName: srcSecret.Name,
                        },
                }
        }

        dstVolume := corev1.Volume{
                Name: "dst-secret-vol",
                VolumeSource: corev1.VolumeSource{
                        EmptyDir: &corev1.EmptyDirVolumeSource{},
                },
        }
        if dstSecret.Name != "" {
                dstVolume.VolumeSource = corev1.VolumeSource{
                        Secret: &corev1.SecretVolumeSource{
                                SecretName: dstSecret.Name,
                        },
                }
        }

        parameters := []wfv1alpha1.Parameter{}
        for _, p := range aw.Spec.Parameters {
                parameters = append(parameters, wfv1alpha1.Parameter{
                        Name:  p.Name,
                        Value: (*wfv1alpha1.AnyString)(&p.Value),
                })
        }
        for _, p := range artifactType.Spec.Parameters {
                parameters = append(parameters, wfv1alpha1.Parameter{
                        Name:  p.Name,
                        Value: (*wfv1alpha1.AnyString)(&p.Value),
                })
        }

        wf := &wfv1alpha1.Workflow{
                ObjectMeta: metav1.ObjectMeta{
                        Name:      aw.Name,
                        Namespace: aw.Namespace,
                },
                Spec: wfv1alpha1.WorkflowSpec{
                        WorkflowTemplateRef: &wfv1alpha1.WorkflowTemplateRef{
                                Name:         artifactType.Spec.WorkflowTemplateRef.Name,
                                ClusterScope: true,
                        },
                        Volumes: []corev1.Volume{
                                srcVolume,
                                dstVolume,
                        },
                        Arguments: wfv1alpha1.Arguments{
                                Parameters: parameters,
                        },
                },
        }

        return wf
}

func (r *ArtifactWorkflowReconciler) checkArgoWorkflow(ctx context.Context, log logr.Logger, aw *arcv1alpha1.ArtifactWorkflow) (ctrl.Result, error) {
        wf := wfv1alpha1.Workflow{}
        if err := r.Get(ctx, namespacedName(aw.Namespace, aw.Name), &wf); err != nil {
                return ctrl.Result{}, errLogAndWrap(log, err, "failed to get workflow")
        }

        aw.Status.Phase = arcv1alpha1.WorkflowPhase(wf.Status.Phase)
        if err := r.Status().Update(ctx, aw); err != nil {
                return ctrl.Result{}, errLogAndWrap(log, err, "failed to update status")
        }
        return ctrl.Result{}, nil
}

// SetupWithManager sets up the controller with the Manager.
func (r *ArtifactWorkflowReconciler) SetupWithManager(mgr ctrl.Manager) error {
        return ctrl.NewControllerManagedBy(mgr).
                For(&arcv1alpha1.ArtifactWorkflow{}).
                Owns(&wfv1alpha1.Workflow{}).
                Complete(r)
}

1	// Copyright 2025 BWI GmbH and Artefact Conduit contributors
2	// SPDX-License-Identifier: Apache-2.0
3
4	package controller
5
6	import (
7	"context"
8	"slices"
9
10	wfv1alpha1 "github.com/argoproj/argo-workflows/v3/pkg/apis/workflow/v1alpha1"
11	"github.com/go-logr/logr"
12	arcv1alpha1 "go.opendefense.cloud/arc/api/arc/v1alpha1"
13	corev1 "k8s.io/api/core/v1"
14	apierrors "k8s.io/apimachinery/pkg/api/errors"
15	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
16	"k8s.io/apimachinery/pkg/runtime"
17	ctrl "sigs.k8s.io/controller-runtime"
18	"sigs.k8s.io/controller-runtime/pkg/client"
19	"sigs.k8s.io/controller-runtime/pkg/controller/controllerutil"
20	)
21
22	const (
23	artifactWorkflowFinalizer = "arc.bwi.de/artifact-workflow-finalizer"
24	)
25
26	// ArtifactWorkflowReconciler reconciles a ArtifactWorkflow object
27	type ArtifactWorkflowReconciler struct {
28	client.Client
29	Scheme *runtime.Scheme
30	}
31
32	//+kubebuilder:rbac:groups=arc.bwi.de,resources=artifacttypes,verbs=get;list;watch
33	//+kubebuilder:rbac:groups=arc.bwi.de,resources=artifactworkflows/status,verbs=get;update;patch
34	//+kubebuilder:rbac:groups=arc.bwi.de,resources=artifactworkflows/finalizers,verbs=update
35	//+kubebuilder:rbac:groups="",resources=secrets,verbs=get;list;watch;create;update;patch;delete
36	//+kubebuilder:rbac:groups=argoproj.io,resources=workflows,verbs=get;list;watch;create;update;patch;delete
37
38	// Reconcile moves the current state of the cluster closer to the desired state
39	func (r *ArtifactWorkflowReconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctrl.Result, error) {	1,947✔
40	log := ctrl.LoggerFrom(ctx)	1,947✔
41		1,947✔
42	aw := &arcv1alpha1.ArtifactWorkflow{}	1,947✔
43	if err := r.Get(ctx, req.NamespacedName, aw); err != nil {	1,951✔
44	if apierrors.IsNotFound(err) {	8✔
45	// Object not found, return.	4✔
46	return ctrl.Result{}, nil	4✔
47	}	4✔
48	return ctrl.Result{}, errLogAndWrap(log, err, "failed to get object")	×
49	}
50
51	if !aw.DeletionTimestamp.IsZero() {	1,946✔
52	log.V(1).Info("ArtifactWorkflow is being deleted")	3✔
53	// Cleanup workflow, if exists	3✔
54	wf := wfv1alpha1.Workflow{	3✔
55	ObjectMeta: metav1.ObjectMeta{	3✔
56	Namespace: aw.Namespace,	3✔
57	Name: aw.Name,	3✔
58	},	3✔
59	}	3✔
60	if err := r.Delete(ctx, &wf); client.IgnoreNotFound(err) != nil {	3✔
61	return ctrl.Result{}, errLogAndWrap(log, err, "workflow deletion failed")	×
62	}	×
63	// Remove finalizer
64	if slices.Contains(aw.Finalizers, artifactWorkflowFinalizer) {	6✔
65	log.V(1).Info("Removing finalizer from ArtifactWorkflow")	3✔
66	aw.Finalizers = slices.DeleteFunc(aw.Finalizers, func(f string) bool {	6✔
67	return f == artifactWorkflowFinalizer	3✔
68	})	3✔
69	if err := r.Update(ctx, aw); err != nil {	3✔
70	return ctrl.Result{}, errLogAndWrap(log, err, "failed to remove finalizer")	×
71	}	×
72	}
73	return ctrl.Result{}, nil	3✔
74	}
75
76	// Add finalizer if not present and not deleting
77	if aw.DeletionTimestamp.IsZero() {	3,880✔
78	if !slices.Contains(aw.Finalizers, artifactWorkflowFinalizer) {	1,958✔
79	log.V(1).Info("Adding finalizer to ArtifactWorkflow")	18✔
80	aw.Finalizers = append(aw.Finalizers, artifactWorkflowFinalizer)	18✔
81	if err := r.Update(ctx, aw); err != nil {	18✔
82	return ctrl.Result{}, errLogAndWrap(log, err, "failed to add finalizer")	×
83	}	×
84	// Return without requeue; the Update event will trigger reconciliation again
85	return ctrl.Result{}, nil	18✔
86	}
87	}
88
89	if aw.Status.Phase.Completed() {	1,923✔
90	// TODO: check if message has to be compiled from logs of workflow etc...	1✔
91	return ctrl.Result{}, nil	1✔
92	}	1✔
93
94	if aw.Status.Phase == arcv1alpha1.WorkflowUnknown {	2,951✔
95	return r.createArgoWorkflow(ctx, log, aw)	1,030✔
96	}	1,030✔
97
98	if aw.Status.Phase.InProgress() {	1,782✔
99	return r.checkArgoWorkflow(ctx, log, aw)	891✔
100	}	891✔
101
102	return ctrl.Result{}, nil	×
103	}
104
105	func (r ArtifactWorkflowReconciler) createArgoWorkflow(ctx context.Context, log logr.Logger, aw arcv1alpha1.ArtifactWorkflow) (ctrl.Result, error) {	1,030✔
106	artifactType := arcv1alpha1.ArtifactType{}	1,030✔
107	if err := r.Get(ctx, namespacedName("", aw.Spec.Type), &artifactType); err != nil {	1,163✔
108	return ctrl.Result{}, errLogAndWrap(log, err, "failed to retrieve artifact type")	133✔
109	}	133✔
110
111	srcSecret := corev1.Secret{}	897✔
112	if aw.Spec.SrcSecretRef.Name != "" {	1,689✔
113	if err := r.Get(ctx, namespacedName(aw.Namespace, aw.Spec.SrcSecretRef.Name), &srcSecret); err != nil {	792✔
114	return ctrl.Result{}, errLogAndWrap(log, err, "failed to fetch secret for source")	×
115	}	×
116	}
117
118	dstSecret := corev1.Secret{}	897✔
119	if aw.Spec.DstSecretRef.Name != "" {	1,689✔
120	if err := r.Get(ctx, namespacedName(aw.Namespace, aw.Spec.DstSecretRef.Name), &dstSecret); err != nil {	792✔
121	return ctrl.Result{}, errLogAndWrap(log, err, "failed to fetch secret for destination")	×
122	}	×
123	}
124
125	wf := r.hydrateArgoWorkflow(aw, &artifactType, &srcSecret, &dstSecret)	897✔
126		897✔
127	if err := controllerutil.SetControllerReference(aw, wf, r.Scheme); err != nil {	897✔
128	return ctrl.Result{}, errLogAndWrap(log, err, "failed to set controller reference")	×
129	}	×
130
131	if err := r.Create(ctx, wf); client.IgnoreAlreadyExists(err) != nil {	905✔
132	return ctrl.Result{}, errLogAndWrap(log, err, "failed to create argo workflow")	8✔
133	}	8✔
134
135	aw.Status.Phase = arcv1alpha1.WorkflowPending	889✔
136	if err := r.Status().Update(ctx, aw); err != nil {	889✔
137	return ctrl.Result{}, errLogAndWrap(log, err, "failed to update status")	×
138	}	×
139	return ctrl.Result{}, nil	889✔
140	}
141
142	func (r ArtifactWorkflowReconciler) hydrateArgoWorkflow(aw arcv1alpha1.ArtifactWorkflow, artifactType arcv1alpha1.ArtifactType, srcSecret corev1.Secret, dstSecret corev1.Secret) wfv1alpha1.Workflow {	897✔
143		897✔
144	srcVolume := corev1.Volume{	897✔
145	Name: "src-secret-vol",	897✔
146	VolumeSource: corev1.VolumeSource{	897✔
147	EmptyDir: &corev1.EmptyDirVolumeSource{},	897✔
148	},	897✔
149	}	897✔
150	if srcSecret.Name != "" {	1,689✔
151	srcVolume.VolumeSource = corev1.VolumeSource{	792✔
152	Secret: &corev1.SecretVolumeSource{	792✔
153	SecretName: srcSecret.Name,	792✔
154	},	792✔
155	}	792✔
156	}	792✔
157
158	dstVolume := corev1.Volume{	897✔
159	Name: "dst-secret-vol",	897✔
160	VolumeSource: corev1.VolumeSource{	897✔
161	EmptyDir: &corev1.EmptyDirVolumeSource{},	897✔
162	},	897✔
163	}	897✔
164	if dstSecret.Name != "" {	1,689✔
165	dstVolume.VolumeSource = corev1.VolumeSource{	792✔
166	Secret: &corev1.SecretVolumeSource{	792✔
167	SecretName: dstSecret.Name,	792✔
168	},	792✔
169	}	792✔
170	}	792✔
171
172	parameters := []wfv1alpha1.Parameter{}	897✔
173	for _, p := range aw.Spec.Parameters {	5,733✔
174	parameters = append(parameters, wfv1alpha1.Parameter{	4,836✔
175	Name: p.Name,	4,836✔
176	Value: (*wfv1alpha1.AnyString)(&p.Value),	4,836✔
177	})	4,836✔
178	}	4,836✔
179	for _, p := range artifactType.Spec.Parameters {	1,794✔
180	parameters = append(parameters, wfv1alpha1.Parameter{	897✔
181	Name: p.Name,	897✔
182	Value: (*wfv1alpha1.AnyString)(&p.Value),	897✔
183	})	897✔
184	}	897✔
185
186	wf := &wfv1alpha1.Workflow{	897✔
187	ObjectMeta: metav1.ObjectMeta{	897✔
188	Name: aw.Name,	897✔
189	Namespace: aw.Namespace,	897✔
190	},	897✔
191	Spec: wfv1alpha1.WorkflowSpec{	897✔
192	WorkflowTemplateRef: &wfv1alpha1.WorkflowTemplateRef{	897✔
193	Name: artifactType.Spec.WorkflowTemplateRef.Name,	897✔
194	ClusterScope: true,	897✔
195	},	897✔
196	Volumes: []corev1.Volume{	897✔
197	srcVolume,	897✔
198	dstVolume,	897✔
199	},	897✔
200	Arguments: wfv1alpha1.Arguments{	897✔
201	Parameters: parameters,	897✔
202	},	897✔
203	},	897✔
204	}	897✔
205		897✔
206	return wf	897✔
207	}
208
209	func (r ArtifactWorkflowReconciler) checkArgoWorkflow(ctx context.Context, log logr.Logger, aw arcv1alpha1.ArtifactWorkflow) (ctrl.Result, error) {	891✔
210	wf := wfv1alpha1.Workflow{}	891✔
211	if err := r.Get(ctx, namespacedName(aw.Namespace, aw.Name), &wf); err != nil {	891✔
212	return ctrl.Result{}, errLogAndWrap(log, err, "failed to get workflow")	×
213	}	×
214
215	aw.Status.Phase = arcv1alpha1.WorkflowPhase(wf.Status.Phase)	891✔
216	if err := r.Status().Update(ctx, aw); err != nil {	891✔
217	return ctrl.Result{}, errLogAndWrap(log, err, "failed to update status")	×
218	}	×
219	return ctrl.Result{}, nil	891✔
220	}
221
222	// SetupWithManager sets up the controller with the Manager.
223	func (r *ArtifactWorkflowReconciler) SetupWithManager(mgr ctrl.Manager) error {	1✔
224	return ctrl.NewControllerManagedBy(mgr).	1✔
225	For(&arcv1alpha1.ArtifactWorkflow{}).	1✔
226	Owns(&wfv1alpha1.Workflow{}).	1✔
227	Complete(r)	1✔
228	}	1✔

opendefensecloud / artifact-conduit / 19538961582

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