• Home
  • Features
  • Pricing
  • Docs
  • Announcements
  • Sign In

opendefensecloud / artifact-conduit / 19758032356

28 Nov 2025 08:17AM UTC coverage: 62.045% (+0.2%) from 61.842%
19758032356

push

github

jastBytes
add helm readme to installation docs

613 of 988 relevant lines covered (62.04%)

1249.7 hits per line

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

83.84
/pkg/controller/artifactworkflow_controller.go
1
// Copyright 2025 BWI GmbH and Artefact Conduit contributors
2
// SPDX-License-Identifier: Apache-2.0
3

4
package controller
5

6
import (
7
        "bytes"
8
        "context"
9
        "fmt"
10
        "io"
11
        "slices"
12

13
        wfv1alpha1 "github.com/argoproj/argo-workflows/v3/pkg/apis/workflow/v1alpha1"
14
        "github.com/go-logr/logr"
15
        "github.com/jastBytes/sprint"
16
        arcv1alpha1 "go.opendefense.cloud/arc/api/arc/v1alpha1"
17
        corev1 "k8s.io/api/core/v1"
18
        apierrors "k8s.io/apimachinery/pkg/api/errors"
19
        metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
20
        "k8s.io/apimachinery/pkg/runtime"
21
        "k8s.io/client-go/kubernetes"
22
        "k8s.io/client-go/tools/record"
23
        ctrl "sigs.k8s.io/controller-runtime"
24
        "sigs.k8s.io/controller-runtime/pkg/client"
25
        "sigs.k8s.io/controller-runtime/pkg/controller/controllerutil"
26
)
27

28
const (
29
        artifactWorkflowFinalizer = "arc.bwi.de/artifact-workflow-finalizer"
30
)
31

32
// ArtifactWorkflowReconciler reconciles a ArtifactWorkflow object
33
type ArtifactWorkflowReconciler struct {
34
        client.Client
35
        ClientSet kubernetes.Interface
36
        Scheme    *runtime.Scheme
37
        Recorder  record.EventRecorder
38
}
39

40
//+kubebuilder:rbac:groups=arc.bwi.de,resources=clusterartifacttypes,verbs=get;list;watch
41
//+kubebuilder:rbac:groups=arc.bwi.de,resources=artifactworkflows/status,verbs=get;update;patch
42
//+kubebuilder:rbac:groups=arc.bwi.de,resources=artifactworkflows/finalizers,verbs=update
43
//+kubebuilder:rbac:groups="",resources=secrets,verbs=get;list;watch;create;update;patch;delete
44
//+kubebuilder:rbac:groups=argoproj.io,resources=workflows,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 *ArtifactWorkflowReconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctrl.Result, error) {
3,219✔
49
        log := ctrl.LoggerFrom(ctx)
3,219✔
50
        ctrlResult := ctrl.Result{}
3,219✔
51

3,219✔
52
        aw := &arcv1alpha1.ArtifactWorkflow{}
3,219✔
53
        if err := r.Get(ctx, req.NamespacedName, aw); err != nil {
3,224✔
54
                if apierrors.IsNotFound(err) {
10✔
55
                        // Object not found, return.
5✔
56
                        return ctrlResult, nil
5✔
57
                }
5✔
58
                return ctrlResult, errLogAndWrap(log, err, "failed to get object")
×
59
        }
60

61
        // Update last reconcile time
62
        aw.Status.LastReconcileAt = metav1.Now()
3,214✔
63

3,214✔
64
        // Handle deletion
3,214✔
65
        if !aw.DeletionTimestamp.IsZero() {
3,219✔
66
                log.V(1).Info("ArtifactWorkflow is being deleted")
5✔
67
                // Cleanup workflow, if exists
5✔
68
                if err := r.deleteArgoWorkflow(ctx, log, aw); err != nil {
5✔
69
                        return ctrlResult, errLogAndWrap(log, err, "workflow deletion failed")
×
70
                }
×
71

72
                // Remove finalizer
73
                if slices.Contains(aw.Finalizers, artifactWorkflowFinalizer) {
10✔
74
                        log.V(1).Info("Removing finalizer from ArtifactWorkflow")
5✔
75
                        aw.Finalizers = slices.DeleteFunc(aw.Finalizers, func(f string) bool {
10✔
76
                                return f == artifactWorkflowFinalizer
5✔
77
                        })
5✔
78
                        if err := r.Update(ctx, aw); err != nil {
5✔
79
                                return ctrlResult, errLogAndWrap(log, err, "failed to remove finalizer")
×
80
                        }
×
81
                }
82
                return ctrlResult, nil
5✔
83
        }
84

85
        // Add finalizer if not present and not deleting
86
        if aw.DeletionTimestamp.IsZero() {
6,418✔
87
                if !slices.Contains(aw.Finalizers, artifactWorkflowFinalizer) {
3,233✔
88
                        log.V(1).Info("Adding finalizer to ArtifactWorkflow")
24✔
89
                        aw.Finalizers = append(aw.Finalizers, artifactWorkflowFinalizer)
24✔
90
                        if err := r.Update(ctx, aw); err != nil {
24✔
91
                                return ctrlResult, errLogAndWrap(log, err, "failed to add finalizer")
×
92
                        }
×
93
                        // Return without requeue; the Update event will trigger reconciliation again
94
                        return ctrlResult, nil
24✔
95
                }
96
        }
97

98
        // Handle force reconcile annotation
99
        forceAt, err := GetForceAtAnnotationValue(aw)
3,185✔
100
        if err != nil {
3,185✔
101
                log.V(1).Error(err, "Invalid force reconcile annotation, ignoring")
×
102
        }
×
103
        if !forceAt.IsZero() && (aw.Status.LastForceAt.IsZero() || forceAt.After(aw.Status.LastForceAt.Time)) {
3,186✔
104
                log.V(1).Info("Force reconcile requested")
1✔
105
                r.Recorder.Event(aw, corev1.EventTypeNormal, "ForceReconcile", "Force reconcile requested via annotation")
1✔
106
                // Delete existing workflow, if any
1✔
107
                if err := r.deleteArgoWorkflow(ctx, log, aw); err != nil {
1✔
108
                        return ctrlResult, errLogAndWrap(log, err, "failed to delete existing workflow for force reconcile")
×
109
                }
×
110
                // Update last force time
111
                aw.Status.LastForceAt = metav1.Now()
1✔
112
                if err := r.Status().Update(ctx, aw); err != nil {
1✔
113
                        return ctrlResult, errLogAndWrap(log, err, "failed to update last force time")
×
114
                }
×
115
                // Return without requeue; the update event will trigger reconciliation again
116
                return ctrlResult, nil
1✔
117
        }
118

119
        if aw.Status.Phase == arcv1alpha1.WorkflowUnknown {
4,868✔
120
                return ctrlResult, r.createArgoWorkflow(ctx, log, aw)
1,684✔
121
        }
1,684✔
122

123
        if aw.Status.Phase.InProgress() {
2,997✔
124
                return ctrlResult, r.checkArgoWorkflow(ctx, log, aw)
1,497✔
125
        }
1,497✔
126

127
        return ctrlResult, nil
3✔
128
}
129

130
func (r *ArtifactWorkflowReconciler) deleteArgoWorkflow(ctx context.Context, log logr.Logger, aw *arcv1alpha1.ArtifactWorkflow) error {
6✔
131
        wf := wfv1alpha1.Workflow{
6✔
132
                ObjectMeta: metav1.ObjectMeta{
6✔
133
                        Namespace: aw.Namespace,
6✔
134
                        Name:      aw.Name,
6✔
135
                },
6✔
136
        }
6✔
137
        if err := r.Delete(ctx, &wf); client.IgnoreNotFound(err) != nil {
6✔
138
                r.Recorder.Event(aw, corev1.EventTypeWarning, "DeletionFailed", fmt.Sprintf("Failed to delete associated workflow '%s': %v", aw.Name, err))
×
139
                return errLogAndWrap(log, err, "workflow deletion failed")
×
140
        }
×
141
        r.Recorder.Event(aw, corev1.EventTypeNormal, "Deleted", fmt.Sprintf("Deleted workflow '%s'", aw.Name))
6✔
142
        return nil
6✔
143
}
144

145
func (r *ArtifactWorkflowReconciler) createArgoWorkflow(ctx context.Context, log logr.Logger, aw *arcv1alpha1.ArtifactWorkflow) error {
1,684✔
146
        srcSecret := corev1.Secret{}
1,684✔
147
        if aw.Spec.SrcSecretRef.Name != "" {
3,013✔
148
                if err := r.Get(ctx, namespacedName(aw.Namespace, aw.Spec.SrcSecretRef.Name), &srcSecret); err != nil {
1,329✔
149
                        r.Recorder.Event(aw, corev1.EventTypeWarning, "InvalidSecret", fmt.Sprintf("Failed to fetch source secret '%s': %v", aw.Spec.SrcSecretRef.Name, err))
×
150
                        return errLogAndWrap(log, err, "failed to fetch secret for source")
×
151
                }
×
152
        }
153

154
        dstSecret := corev1.Secret{}
1,684✔
155
        if aw.Spec.DstSecretRef.Name != "" {
3,013✔
156
                if err := r.Get(ctx, namespacedName(aw.Namespace, aw.Spec.DstSecretRef.Name), &dstSecret); err != nil {
1,329✔
157
                        r.Recorder.Event(aw, corev1.EventTypeWarning, "InvalidSecret", fmt.Sprintf("Failed to fetch destination secret '%s': %v", aw.Spec.DstSecretRef.Name, err))
×
158
                        return errLogAndWrap(log, err, "failed to fetch secret for destination")
×
159
                }
×
160
        }
161

162
        wf := r.hydrateArgoWorkflow(aw, &srcSecret, &dstSecret)
1,684✔
163

1,684✔
164
        if err := controllerutil.SetControllerReference(aw, wf, r.Scheme); err != nil {
1,684✔
165
                return errLogAndWrap(log, err, "failed to set controller reference")
×
166
        }
×
167

168
        if err := r.Create(ctx, wf); client.IgnoreAlreadyExists(err) != nil {
1,868✔
169
                r.Recorder.Event(aw, corev1.EventTypeWarning, "CreationFailed", fmt.Sprintf("Failed to create workflow '%s': %v", wf.Name, err))
184✔
170
                return errLogAndWrap(log, err, "failed to create argo workflow")
184✔
171
        }
184✔
172
        r.Recorder.Event(aw, corev1.EventTypeNormal, "Created", fmt.Sprintf("Created workflow '%s'", wf.Name))
1,500✔
173

1,500✔
174
        aw.Status.Phase = arcv1alpha1.WorkflowPending
1,500✔
175
        if err := r.Status().Update(ctx, aw); err != nil {
1,505✔
176
                return errLogAndWrap(log, err, "failed to update status")
5✔
177
        }
5✔
178
        return nil
1,495✔
179
}
180

181
func (r *ArtifactWorkflowReconciler) hydrateArgoWorkflow(aw *arcv1alpha1.ArtifactWorkflow, srcSecret *corev1.Secret, dstSecret *corev1.Secret) *wfv1alpha1.Workflow {
1,684✔
182
        srcVolume := corev1.Volume{
1,684✔
183
                Name: "src-secret-vol",
1,684✔
184
                VolumeSource: corev1.VolumeSource{
1,684✔
185
                        EmptyDir: &corev1.EmptyDirVolumeSource{},
1,684✔
186
                },
1,684✔
187
        }
1,684✔
188
        if srcSecret.Name != "" {
3,013✔
189
                srcVolume.VolumeSource = corev1.VolumeSource{
1,329✔
190
                        Secret: &corev1.SecretVolumeSource{
1,329✔
191
                                SecretName: srcSecret.Name,
1,329✔
192
                        },
1,329✔
193
                }
1,329✔
194
        }
1,329✔
195

196
        dstVolume := corev1.Volume{
1,684✔
197
                Name: "dst-secret-vol",
1,684✔
198
                VolumeSource: corev1.VolumeSource{
1,684✔
199
                        EmptyDir: &corev1.EmptyDirVolumeSource{},
1,684✔
200
                },
1,684✔
201
        }
1,684✔
202
        if dstSecret.Name != "" {
3,013✔
203
                dstVolume.VolumeSource = corev1.VolumeSource{
1,329✔
204
                        Secret: &corev1.SecretVolumeSource{
1,329✔
205
                                SecretName: dstSecret.Name,
1,329✔
206
                        },
1,329✔
207
                }
1,329✔
208
        }
1,329✔
209

210
        parameters := []wfv1alpha1.Parameter{}
1,684✔
211
        for _, p := range aw.Spec.Parameters {
11,587✔
212
                parameters = append(parameters, wfv1alpha1.Parameter{
9,903✔
213
                        Name:  p.Name,
9,903✔
214
                        Value: (*wfv1alpha1.AnyString)(&p.Value),
9,903✔
215
                })
9,903✔
216
        }
9,903✔
217

218
        wf := &wfv1alpha1.Workflow{
1,684✔
219
                ObjectMeta: workflowObjectMeta(aw),
1,684✔
220
                Spec: wfv1alpha1.WorkflowSpec{
1,684✔
221
                        WorkflowTemplateRef: &wfv1alpha1.WorkflowTemplateRef{
1,684✔
222
                                Name:         aw.Spec.WorkflowTemplateRef.Name,
1,684✔
223
                                ClusterScope: aw.Spec.WorkflowTemplateRef.ClusterScope,
1,684✔
224
                        },
1,684✔
225
                        Volumes: []corev1.Volume{
1,684✔
226
                                srcVolume,
1,684✔
227
                                dstVolume,
1,684✔
228
                        },
1,684✔
229
                        Arguments: wfv1alpha1.Arguments{
1,684✔
230
                                Parameters: parameters,
1,684✔
231
                        },
1,684✔
232
                },
1,684✔
233
        }
1,684✔
234

1,684✔
235
        return wf
1,684✔
236
}
237

238
func (r *ArtifactWorkflowReconciler) checkArgoWorkflow(ctx context.Context, log logr.Logger, aw *arcv1alpha1.ArtifactWorkflow) error {
1,497✔
239
        wf := wfv1alpha1.Workflow{}
1,497✔
240
        if err := r.Get(ctx, namespacedName(aw.Namespace, aw.Name), &wf); err != nil {
1,497✔
241
                return errLogAndWrap(log, err, "failed to get workflow")
×
242
        }
×
243
        if aw.Status.Phase == arcv1alpha1.WorkflowPhase(wf.Status.Phase) {
1,499✔
244
                return nil // nothing updated
2✔
245
        }
2✔
246
        aw.Status.Phase = arcv1alpha1.WorkflowPhase(wf.Status.Phase)
1,495✔
247

1,495✔
248
        switch aw.Status.Phase {
1,495✔
249
        case arcv1alpha1.WorkflowSucceeded:
2✔
250
                aw.Status.CompletionTime = metav1.Now()
2✔
251
        case arcv1alpha1.WorkflowError, arcv1alpha1.WorkflowFailed:
1✔
252
                // If workflow has errored or failed, fetch logs and update status message
1✔
253
                switch aw.Status.Phase {
1✔
254
                case arcv1alpha1.WorkflowFailed:
1✔
255
                        r.generateWorkflowStatusMessage(ctx, wf, log, aw)
1✔
256
                case arcv1alpha1.WorkflowError:
×
257
                        // TODO: Properly show why the workflow errored
×
258
                        aw.Status.Message = wf.Status.Message
×
259
                }
260
        }
261

262
        if err := r.Status().Update(ctx, aw); err != nil {
1,495✔
263
                return errLogAndWrap(log, err, "failed to update status")
×
264
        }
×
265

266
        return nil
1,495✔
267
}
268

269
func (r *ArtifactWorkflowReconciler) generateWorkflowStatusMessage(ctx context.Context, wf wfv1alpha1.Workflow, log logr.Logger, aw *arcv1alpha1.ArtifactWorkflow) {
1✔
270
        failedNodes := []struct {
1✔
271
                Name    string
1✔
272
                Pod     string
1✔
273
                Message string
1✔
274
        }{}
1✔
275
        for _, node := range wf.Status.Nodes {
4✔
276
                if node.Phase == wfv1alpha1.NodeFailed && node.Type == wfv1alpha1.NodeTypePod {
5✔
277
                        nr := struct {
2✔
278
                                Name    string
2✔
279
                                Pod     string
2✔
280
                                Message string
2✔
281
                        }{
2✔
282
                                Name:    node.DisplayName,
2✔
283
                                Pod:     generatePodNameFromNodeStatus(node),
2✔
284
                                Message: node.Message,
2✔
285
                        }
2✔
286
                        failedNodes = append(failedNodes, nr)
2✔
287
                }
2✔
288
        }
289

290
        for _, nr := range failedNodes {
3✔
291
                logs, err := r.fetchPodLogs(ctx, aw.Namespace, nr.Pod)
2✔
292
                if err != nil {
2✔
293
                        log.V(1).Info("failed to fetch pod logs", "pod", nr.Pod, "error", err)
×
294
                        continue
×
295
                }
296
                aw.Status.Message += fmt.Sprintf("Step '%s' failed:\n%s\nLogs:\n%s\n\n", nr.Name, nr.Message, logs)
2✔
297
        }
298
}
299

300
func (r *ArtifactWorkflowReconciler) fetchPodLogs(ctx context.Context, namespace, podName string) (string, error) {
2✔
301
        podLogOptions := corev1.PodLogOptions{
2✔
302
                Container: "main", // Assuming the main container
2✔
303
                Follow:    false,
2✔
304
                TailLines: sprint.ToPointer(int64(30)), // Fetch last 30 lines
2✔
305
        }
2✔
306
        req := r.ClientSet.CoreV1().Pods(namespace).GetLogs(podName, &podLogOptions)
2✔
307
        podLogs, err := req.Stream(ctx)
2✔
308
        if err != nil {
2✔
309
                return "", err
×
310
        }
×
311
        defer sprint.PanicOnErrorFunc(podLogs.Close) // Close the stream when done
2✔
312

2✔
313
        buf := new(bytes.Buffer)
2✔
314
        _, err = io.Copy(buf, podLogs)
2✔
315
        if err != nil {
2✔
316
                return "", err
×
317
        }
×
318
        return buf.String(), nil
2✔
319
}
320

321
// SetupWithManager sets up the controller with the Manager.
322
func (r *ArtifactWorkflowReconciler) SetupWithManager(mgr ctrl.Manager) error {
1✔
323
        return ctrl.NewControllerManagedBy(mgr).
1✔
324
                For(&arcv1alpha1.ArtifactWorkflow{}).
1✔
325
                Owns(&wfv1alpha1.Workflow{}).
1✔
326
                Complete(r)
1✔
327
}
1✔
STATUS · Troubleshooting · Open an Issue · Sales · Support · CAREERS · ENTERPRISE · START FREE · SCHEDULE DEMO
ANNOUNCEMENTS · TWITTER · TOS & SLA · Supported CI Services · What's a CI service? · Automated Testing

© 2026 Coveralls, Inc