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

opendefensecloud / artifact-conduit / 19536006918

20 Nov 2025 11:55AM UTC coverage: 60.0% (-1.1%) from 61.053%
19536006918

push

github

web-flow
add more linting and fix some found issues (#56)

2 of 3 new or added lines in 2 files covered. (66.67%)

7 existing lines in 1 file now uncovered.

399 of 665 relevant lines covered (60.0%)

34.62 hits per line

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

81.52
/pkg/controller/order_controller.go
1
// Copyright 2025 BWI GmbH and Artifact Conduit contributors
2
// SPDX-License-Identifier: Apache-2.0
3

4
package controller
5

6
import (
7
        "context"
8
        "crypto/sha256"
9
        "encoding/hex"
10
        "encoding/json"
11
        "fmt"
12
        "slices"
13
        "strconv"
14
        "strings"
15

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/fields"
21
        "k8s.io/apimachinery/pkg/runtime"
22
        "k8s.io/apimachinery/pkg/types"
23
        ctrl "sigs.k8s.io/controller-runtime"
24
        "sigs.k8s.io/controller-runtime/pkg/builder"
25
        "sigs.k8s.io/controller-runtime/pkg/client"
26
        "sigs.k8s.io/controller-runtime/pkg/controller/controllerutil"
27
        "sigs.k8s.io/controller-runtime/pkg/handler"
28
        "sigs.k8s.io/controller-runtime/pkg/predicate"
29
        "sigs.k8s.io/controller-runtime/pkg/reconcile"
30
)
31

32
const (
33
        orderFinalizer = "arc.bwi.de/order-finalizer"
34
)
35

36
// OrderReconciler reconciles a Order object
37
type OrderReconciler struct {
38
        client.Client
39
        Scheme *runtime.Scheme
40
}
41

42
type desiredAW struct {
43
        index       int
44
        objectMeta  metav1.ObjectMeta
45
        artifact    *arcv1alpha1.OrderArtifact
46
        srcEndpoint *arcv1alpha1.Endpoint
47
        dstEndpoint *arcv1alpha1.Endpoint
48
        srcSecret   *corev1.Secret
49
        dstSecret   *corev1.Secret
50
}
51

52
//+kubebuilder:rbac:groups=arc.bwi.de,resources=endpoints,verbs=get;list;watch
53
//+kubebuilder:rbac:groups=arc.bwi.de,resources=artifactworkflows,verbs=get;list;watch;create;update;patch;delete
54
//+kubebuilder:rbac:groups=arc.bwi.de,resources=orders,verbs=get;list;watch;create;update;patch;delete
55
//+kubebuilder:rbac:groups=arc.bwi.de,resources=orders/status,verbs=get;update;patch
56
//+kubebuilder:rbac:groups=arc.bwi.de,resources=orders/finalizers,verbs=update
57
//+kubebuilder:rbac:groups="",resources=secrets,verbs=get;list;watch;create;update;patch;delete
58

59
// Reconcile moves the current state of the cluster closer to the desired state
60
func (r *OrderReconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctrl.Result, error) {
32✔
61
        log := ctrl.LoggerFrom(ctx)
32✔
62

32✔
63
        // Fetch the Order instance
32✔
64
        order := &arcv1alpha1.Order{}
32✔
65
        if err := r.Get(ctx, req.NamespacedName, order); err != nil {
35✔
66
                if apierrors.IsNotFound(err) {
6✔
67
                        // Object not found, return. Created objects are automatically garbage collected.
3✔
68
                        return ctrl.Result{}, nil
3✔
69
                }
3✔
70
                return ctrl.Result{}, errLogAndWrap(log, err, "failed to get object")
×
71
        }
72

73
        // Handle deletion: cleanup fragments, then remove finalizer
74
        if !order.DeletionTimestamp.IsZero() {
31✔
75
                log.V(1).Info("Order is being deleted")
2✔
76
                if len(order.Status.ArtifactWorkflows) > 0 {
3✔
77
                        for sha := range order.Status.ArtifactWorkflows {
3✔
78
                                // Remove Secret and ArtifactWorkflow
2✔
79
                                aw := &arcv1alpha1.ArtifactWorkflow{
2✔
80
                                        ObjectMeta: awObjectMeta(order, sha),
2✔
81
                                }
2✔
82
                                _ = r.Delete(ctx, aw) // Ignore errors
2✔
83
                                delete(order.Status.ArtifactWorkflows, sha)
2✔
84
                        }
2✔
85
                        if err := r.Status().Update(ctx, order); err != nil {
1✔
UNCOV
86
                                return ctrl.Result{}, errLogAndWrap(log, err, "failed to update order status")
×
UNCOV
87
                        }
×
88
                        log.V(1).Info("Order artifact workflows cleaned up")
1✔
89
                        // Requeue until all fragments are gone
1✔
90
                        return ctrl.Result{Requeue: true}, nil
1✔
91
                }
92
                // All fragments are gone, remove finalizer
93
                if slices.Contains(order.Finalizers, orderFinalizer) {
2✔
94
                        log.V(1).Info("No artifact workflows, removing finalizer from Order")
1✔
95
                        order.Finalizers = slices.DeleteFunc(order.Finalizers, func(f string) bool {
2✔
96
                                return f == orderFinalizer
1✔
97
                        })
1✔
98
                        if err := r.Update(ctx, order); err != nil {
1✔
99
                                return ctrl.Result{}, errLogAndWrap(log, err, "failed to remove finalizer")
×
100
                        }
×
101
                }
102
                return ctrl.Result{}, nil
1✔
103
        }
104

105
        // Add finalizer if not present and not deleting
106
        if order.DeletionTimestamp.IsZero() {
54✔
107
                if !slices.Contains(order.Finalizers, orderFinalizer) {
34✔
108
                        log.V(1).Info("Adding finalizer to Order")
7✔
109
                        order.Finalizers = append(order.Finalizers, orderFinalizer)
7✔
110
                        if err := r.Update(ctx, order); err != nil {
7✔
111
                                return ctrl.Result{}, errLogAndWrap(log, err, "failed to add finalizer")
×
112
                        }
×
113
                        // Return without requeue; the Update event will trigger reconciliation again
114
                        return ctrl.Result{}, nil
7✔
115
                }
116
        }
117

118
        // Before we compare to our status, let's fetch all necessary information
119
        // to compute desired state:
120
        desiredAWs := map[string]desiredAW{}
20✔
121
        for i, artifact := range order.Spec.Artifacts {
55✔
122
                // TODO: When a endpoint or secret fetch fails, we stop the reconciliation of the whole order.
35✔
123
                //       Should we instead not fail but skip invalid artifacts?
35✔
124
                log := log.WithValues("artifactIndex", i)
35✔
125

35✔
126
                // We need the referenced src- and dst-endpoints for the artifact
35✔
127
                srcRefName := artifact.SrcRef.Name
35✔
128
                if srcRefName == "" {
41✔
129
                        srcRefName = order.Spec.Defaults.SrcRef.Name
6✔
130
                }
6✔
131
                dstRefName := artifact.DstRef.Name
35✔
132
                if dstRefName == "" {
43✔
133
                        dstRefName = order.Spec.Defaults.DstRef.Name
8✔
134
                }
8✔
135
                srcEndpoint := &arcv1alpha1.Endpoint{}
35✔
136
                if err := r.Get(ctx, namespacedName(order.Namespace, srcRefName), srcEndpoint); err != nil {
35✔
137
                        return ctrl.Result{}, errLogAndWrap(log, err, "failed to fetch endpoint for source")
×
138
                }
×
139
                dstEndpoint := &arcv1alpha1.Endpoint{}
35✔
140
                if err := r.Get(ctx, namespacedName(order.Namespace, dstRefName), dstEndpoint); err != nil {
35✔
141
                        return ctrl.Result{}, errLogAndWrap(log, err, "failed to fetch endpoint for destination")
×
142
                }
×
143

144
                // Next, we need the secret contents
145
                srcSecret := &corev1.Secret{}
35✔
146
                if srcEndpoint.Spec.SecretRef.Name != "" {
68✔
147
                        if err := r.Get(ctx, namespacedName(order.Namespace, srcEndpoint.Spec.SecretRef.Name), srcSecret); err != nil {
33✔
148
                                return ctrl.Result{}, errLogAndWrap(log, err, "failed to fetch secret for source")
×
149
                        }
×
150
                }
151

152
                dstSecret := &corev1.Secret{}
35✔
153
                if dstEndpoint.Spec.SecretRef.Name != "" {
68✔
154
                        if err := r.Get(ctx, namespacedName(order.Namespace, dstEndpoint.Spec.SecretRef.Name), dstSecret); err != nil {
33✔
155
                                return ctrl.Result{}, errLogAndWrap(log, err, "failed to fetch secret for destination")
×
156
                        }
×
157
                }
158

159
                // Create a hash based on all related data for idempotency and compute the workflow name
160
                h := sha256.New()
35✔
161
                data := []any{
35✔
162
                        order.Namespace,
35✔
163
                        artifact.Type, artifact.Spec.Raw,
35✔
164
                        srcEndpoint.Name, srcEndpoint.Generation,
35✔
165
                        dstEndpoint.Name, dstEndpoint.Generation,
35✔
166
                        srcSecret.Name, srcSecret.Generation,
35✔
167
                        dstSecret.Name, dstSecret.Generation,
35✔
168
                }
35✔
169
                jsonData, err := json.Marshal(data)
35✔
170
                if err != nil {
35✔
171
                        return ctrl.Result{}, errLogAndWrap(log, err, "failed to marshal fragment data")
×
172
                }
×
173
                h.Write(jsonData)
35✔
174
                sha := hex.EncodeToString(h.Sum(nil))[:16]
35✔
175

35✔
176
                // We gave all the information to further process this artifact workflow.
35✔
177
                // Let's store it to compare it to the current status!
35✔
178
                desiredAWs[sha] = desiredAW{
35✔
179
                        index:       i,
35✔
180
                        objectMeta:  awObjectMeta(order, sha),
35✔
181
                        artifact:    &artifact,
35✔
182
                        srcEndpoint: srcEndpoint,
35✔
183
                        dstEndpoint: dstEndpoint,
35✔
184
                        srcSecret:   srcSecret,
35✔
185
                        dstSecret:   dstSecret,
35✔
186
                }
35✔
187
        }
188

189
        // List missing fragments
190
        createAWs := []string{}
20✔
191
        for sha := range desiredAWs {
55✔
192
                _, exists := order.Status.ArtifactWorkflows[sha]
35✔
193
                if exists {
56✔
194
                        continue
21✔
195
                }
196
                createAWs = append(createAWs, sha)
14✔
197
        }
198

199
        // Make sure status is initialized
200
        if order.Status.ArtifactWorkflows == nil {
27✔
201
                order.Status.ArtifactWorkflows = map[string]arcv1alpha1.OrderArtifactWorkflowStatus{}
7✔
202
        }
7✔
203

204
        // Find obsolete fragments
205
        deleteAWs := []string{}
20✔
206
        for sha := range order.Status.ArtifactWorkflows {
42✔
207
                _, exists := desiredAWs[sha]
22✔
208
                if exists {
43✔
209
                        continue
21✔
210
                }
211
                deleteAWs = append(deleteAWs, sha)
1✔
212
        }
213

214
        // Create missing fragments
215
        for _, sha := range createAWs {
34✔
216
                daw := desiredAWs[sha]
14✔
217
                aw, err := r.hydrateArtifactWorkflow(&daw)
14✔
218
                if err != nil {
14✔
219
                        return ctrl.Result{}, errLogAndWrap(log, err, "failed to hydrate artifact workflow")
×
220
                }
×
221

222
                // Set owner references
223
                if err := controllerutil.SetControllerReference(order, aw, r.Scheme); err != nil {
14✔
224
                        return ctrl.Result{}, errLogAndWrap(log, err, "failed to set controller reference")
×
225
                }
×
226

227
                // Create artifact workflow
228
                if err := r.Create(ctx, aw); err != nil {
14✔
UNCOV
229
                        if apierrors.IsAlreadyExists(err) {
×
UNCOV
230
                                // Already created by a previous reconcile — that's fine
×
UNCOV
231
                                continue
×
232
                        }
233
                        return ctrl.Result{}, errLogAndWrap(log, err, "failed to create artifact workflow")
×
234
                }
235

236
                // Update status
237
                order.Status.ArtifactWorkflows[sha] = arcv1alpha1.OrderArtifactWorkflowStatus{
14✔
238
                        ArtifactIndex: daw.index,
14✔
239
                        Phase:         arcv1alpha1.WorkflowUnknown,
14✔
240
                }
14✔
241
        }
242

243
        // Delete obsolete fragments
244
        for _, sha := range deleteAWs {
21✔
245
                // Does not exist anymore, let's clean up!
1✔
246
                if err := r.Delete(ctx, &arcv1alpha1.ArtifactWorkflow{
1✔
247
                        ObjectMeta: awObjectMeta(order, sha),
1✔
248
                }); client.IgnoreNotFound(err) != nil {
1✔
249
                        return ctrl.Result{}, errLogAndWrap(log, err, "failed to delete artifact workflow")
×
250
                }
×
251

252
                // Update status
253
                delete(order.Status.ArtifactWorkflows, sha)
1✔
254
        }
255

256
        // Update status
257
        if len(createAWs) > 0 || len(deleteAWs) > 0 {
29✔
258
                log.V(1).Info("Updating Order.Status")
9✔
259
                if err := r.Status().Update(ctx, order); err != nil {
9✔
UNCOV
260
                        return ctrl.Result{}, errLogAndWrap(log, err, "failed to update status")
×
UNCOV
261
                }
×
262
        }
263

264
        return ctrl.Result{}, nil
20✔
265
}
266

267
func (r *OrderReconciler) hydrateArtifactWorkflow(daw *desiredAW) (*arcv1alpha1.ArtifactWorkflow, error) {
14✔
268
        params, err := dawToParameters(daw)
14✔
269
        if err != nil {
14✔
270
                return nil, err
×
271
        }
×
272

273
        // Next we create the ArtifactWorkflow instance
274
        aw := &arcv1alpha1.ArtifactWorkflow{
14✔
275
                ObjectMeta: daw.objectMeta,
14✔
276
                Spec: arcv1alpha1.ArtifactWorkflowSpec{
14✔
277
                        Type:         daw.artifact.Type,
14✔
278
                        Parameters:   params,
14✔
279
                        SrcSecretRef: daw.srcEndpoint.Spec.SecretRef,
14✔
280
                        DstSecretRef: daw.dstEndpoint.Spec.SecretRef,
14✔
281
                },
14✔
282
        }
14✔
283

14✔
284
        return aw, nil
14✔
285
}
286

287
// generateReconcileRequestsForEndpoint generates reconcile requests for all Endpoints referenced by an Order
288
func (r *OrderReconciler) generateReconcileRequestsForEndpoint(ctx context.Context, endpoint client.Object) []reconcile.Request {
23✔
289
        resourcesReferencingEndpoint := &arcv1alpha1.OrderList{}
23✔
290
        listOps := &client.ListOptions{
23✔
291
                FieldSelector: fields.SelectorFromSet(fields.Set{".spec.srcRef.name": endpoint.GetName(), ".spec.dstRef.name": endpoint.GetName()}),
23✔
292
                Namespace:     endpoint.GetNamespace(),
23✔
293
        }
23✔
294
        err := r.List(ctx, resourcesReferencingEndpoint, listOps)
23✔
295
        if err != nil {
46✔
296
                return []reconcile.Request{}
23✔
297
        }
23✔
298

299
        requests := make([]reconcile.Request, len(resourcesReferencingEndpoint.Items))
×
300
        for i, item := range resourcesReferencingEndpoint.Items {
×
301
                log := ctrl.LoggerFrom(ctx)
×
302
                log.V(1).Info("Generating reconcile request for resource because referenced endpoint has changed...")
×
303
                requests[i] = reconcile.Request{
×
304
                        NamespacedName: types.NamespacedName{
×
305
                                Name:      item.GetName(),
×
306
                                Namespace: item.GetNamespace(),
×
307
                        },
×
308
                }
×
309
        }
×
310
        return requests
×
311
}
312

313
// SetupWithManager sets up the controller with the Manager.
314
func (r *OrderReconciler) SetupWithManager(mgr ctrl.Manager) error {
1✔
315
        return ctrl.NewControllerManagedBy(mgr).
1✔
316
                For(&arcv1alpha1.Order{}).
1✔
317
                Watches(
1✔
318
                        &arcv1alpha1.Endpoint{},
1✔
319
                        handler.EnqueueRequestsFromMapFunc(r.generateReconcileRequestsForEndpoint),
1✔
320
                        builder.WithPredicates(predicate.ResourceVersionChangedPredicate{}),
1✔
321
                ).
1✔
322
                Owns(&arcv1alpha1.ArtifactWorkflow{}).
1✔
323
                Complete(r)
1✔
324
}
1✔
325

326
func namespacedName(namespace, name string) types.NamespacedName {
560✔
327
        return types.NamespacedName{
560✔
328
                Namespace: namespace,
560✔
329
                Name:      name,
560✔
330
        }
560✔
331
}
560✔
332

333
func awName(order *arcv1alpha1.Order, sha string) string {
38✔
334
        return fmt.Sprintf("%s-%s", order.Name, sha)
38✔
335
}
38✔
336

337
func awObjectMeta(order *arcv1alpha1.Order, sha string) metav1.ObjectMeta {
38✔
338
        return metav1.ObjectMeta{
38✔
339
                Namespace: order.Namespace,
38✔
340
                Name:      awName(order, sha),
38✔
341
        }
38✔
342
}
38✔
343

344
// TODO: add unit tests
345
func dawToParameters(daw *desiredAW) ([]arcv1alpha1.ArtifactWorkflowParameter, error) {
14✔
346
        params := []arcv1alpha1.ArtifactWorkflowParameter{
14✔
347
                {
14✔
348
                        Name:  paramName("src", "type"),
14✔
349
                        Value: daw.srcEndpoint.Spec.Type,
14✔
350
                },
14✔
351
                {
14✔
352
                        Name:  paramName("src", "remoteURL"),
14✔
353
                        Value: daw.srcEndpoint.Spec.RemoteURL,
14✔
354
                },
14✔
355
                {
14✔
356
                        Name:  paramName("dst", "type"),
14✔
357
                        Value: daw.dstEndpoint.Spec.Type,
14✔
358
                },
14✔
359
                {
14✔
360
                        Name:  paramName("dst", "remoteURL"),
14✔
361
                        Value: daw.dstEndpoint.Spec.RemoteURL,
14✔
362
                },
14✔
363
                {
14✔
364
                        Name:  "srcSecret",
14✔
365
                        Value: fmt.Sprintf("%v", daw.srcEndpoint.Spec.SecretRef.Name != ""),
14✔
366
                },
14✔
367
                {
14✔
368
                        Name:  "dstSecret",
14✔
369
                        Value: fmt.Sprintf("%v", daw.dstEndpoint.Spec.SecretRef.Name != ""),
14✔
370
                },
14✔
371
        }
14✔
372

14✔
373
        spec := map[string]any{}
14✔
374
        raw := daw.artifact.Spec.Raw
14✔
375
        if len(raw) == 0 {
20✔
376
                raw = []byte("{}")
6✔
377
        }
6✔
378
        if err := json.Unmarshal(raw, &spec); err != nil {
14✔
379
                return nil, err
×
380
        }
×
381
        flattened := map[string]any{}
14✔
382
        flattenMap("spec", spec, flattened)
14✔
383
        for name, value := range flattened {
22✔
384
                params = append(params, arcv1alpha1.ArtifactWorkflowParameter{
8✔
385
                        Name:  name,
8✔
386
                        Value: fmt.Sprintf("%v", value),
8✔
387
                })
8✔
388
        }
8✔
389

390
        return params, nil
14✔
391
}
392

393
// TODO: add unit tests
394
func paramName(prefix, suffix string) string {
56✔
395
        return prefix + strings.ToUpper(suffix[:1]) + suffix[1:]
56✔
396
}
56✔
397

398
// TODO: add unit tests
399
func flattenMap(prefix string, src map[string]any, dst map[string]any) {
14✔
400
        for k, v := range src {
22✔
401
                kt := strings.ToUpper(k[:1]) + k[1:]
8✔
402
                switch child := v.(type) {
8✔
403
                case map[string]any:
×
404
                        flattenMap(prefix+k, child, dst)
×
405
                case []any:
×
406
                        for i, av := range child {
×
407
                                dst[prefix+kt+strconv.Itoa(i)] = av
×
408
                        }
×
409
                default:
8✔
410
                        dst[prefix+kt] = v
8✔
411
                }
412
        }
413
}
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