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

Azure / aks-app-routing-operator / 15917652759

27 Jun 2025 03:44AM UTC coverage: 81.708% (+0.1%) from 81.574%
15917652759

push

github

OliverMKing
unit tests

1 of 1 new or added line in 1 file covered. (100.0%)

59 existing lines in 5 files now uncovered.

3761 of 4603 relevant lines covered (81.71%)

44.1 hits per line

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

44.1
/pkg/controller/controller.go
1
// Copyright (c) Microsoft Corporation.
2
// Licensed under the MIT License.
3

4
package controller
5

6
import (
7
        "context"
8
        "fmt"
9
        "net/http"
10

11
        approutingv1alpha1 "github.com/Azure/aks-app-routing-operator/api/v1alpha1"
12
        placeholderpod "github.com/Azure/aks-app-routing-operator/pkg/controller/keyvault/placeholderpod"
13
        "github.com/Azure/aks-app-routing-operator/pkg/controller/keyvault/spc"
14
        "github.com/Azure/aks-app-routing-operator/pkg/controller/nginxingress"
15
        "github.com/Azure/aks-app-routing-operator/pkg/controller/service"
16
        "github.com/Azure/aks-app-routing-operator/pkg/util"
17
        "github.com/go-logr/logr"
18
        cfgv1alpha2 "github.com/openservicemesh/osm/pkg/apis/config/v1alpha2"
19
        policyv1alpha1 "github.com/openservicemesh/osm/pkg/apis/policy/v1alpha1"
20
        ubzap "go.uber.org/zap"
21
        appsv1 "k8s.io/api/apps/v1"
22
        corev1 "k8s.io/api/core/v1"
23
        netv1 "k8s.io/api/networking/v1"
24
        apiextensionsv1 "k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1"
25
        "k8s.io/apimachinery/pkg/api/errors"
26
        metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
27
        "k8s.io/apimachinery/pkg/runtime"
28
        utilruntime "k8s.io/apimachinery/pkg/util/runtime"
29
        "k8s.io/client-go/kubernetes"
30
        clientgoscheme "k8s.io/client-go/kubernetes/scheme"
31
        "k8s.io/client-go/rest"
32
        "k8s.io/klog/v2"
33
        ctrl "sigs.k8s.io/controller-runtime"
34
        "sigs.k8s.io/controller-runtime/pkg/cache"
35
        "sigs.k8s.io/controller-runtime/pkg/client"
36
        "sigs.k8s.io/controller-runtime/pkg/log/zap"
37
        metricsserver "sigs.k8s.io/controller-runtime/pkg/metrics/server"
38
        gatewayv1 "sigs.k8s.io/gateway-api/apis/v1"
39
        secv1 "sigs.k8s.io/secrets-store-csi-driver/apis/v1"
40

41
        "github.com/Azure/aks-app-routing-operator/pkg/config"
42
        "github.com/Azure/aks-app-routing-operator/pkg/controller/dns"
43
        "github.com/Azure/aks-app-routing-operator/pkg/controller/ingress"
44
        "github.com/Azure/aks-app-routing-operator/pkg/controller/osm"
45
)
46

47
var scheme = runtime.NewScheme()
48

49
const (
50
        nicIngressClassIndex     = "spec.ingressClassName"
51
        gatewayListenerIndexName = "spec.listeners.tls.options.kubernetes.azure.com/tls-cert-service-account"
52
)
53

54
func init() {
2✔
55
        registerSchemes(scheme)
2✔
56
        ctrl.SetLogger(getLogger())
2✔
57
        // need to set klog logger to same logger to get consistent logging format for all logs.
2✔
58
        // without this things like leader election that use klog will not have the same format.
2✔
59
        // https://github.com/kubernetes/client-go/blob/560efb3b8995da3adcec09865ca78c1ddc917cc9/tools/leaderelection/leaderelection.go#L250
2✔
60
        klog.SetLogger(getLogger())
2✔
61
}
2✔
62

63
func getLogger(opts ...zap.Opts) logr.Logger {
6✔
64
        // use raw opts to add caller info to logs
6✔
65
        rawOpts := zap.RawZapOpts(ubzap.AddCaller())
6✔
66

6✔
67
        // zap is the default recommended logger for controller-runtime when wanting json structured output
6✔
68
        return zap.New(append(opts, rawOpts)...)
6✔
69
}
6✔
70

71
func registerSchemes(s *runtime.Scheme) {
2✔
72
        utilruntime.Must(clientgoscheme.AddToScheme(s))
2✔
73
        utilruntime.Must(secv1.Install(s))
2✔
74
        utilruntime.Must(cfgv1alpha2.AddToScheme(s))
2✔
75
        utilruntime.Must(policyv1alpha1.AddToScheme(s))
2✔
76
        utilruntime.Must(approutingv1alpha1.AddToScheme(s))
2✔
77
        utilruntime.Must(apiextensionsv1.AddToScheme(s))
2✔
78
        utilruntime.Must(gatewayv1.Install(s))
2✔
79
}
2✔
80

81
func NewRestConfig(conf *config.Config) *rest.Config {
×
82
        rc := ctrl.GetConfigOrDie()
×
83
        if conf.ServiceAccountTokenPath != "" {
×
UNCOV
84
                rc.BearerTokenFile = conf.ServiceAccountTokenPath
×
85
        }
×
86

UNCOV
87
        return rc
×
88
}
89

90
func NewManagerForRestConfig(conf *config.Config, rc *rest.Config) (ctrl.Manager, error) {
×
91
        // client creates ListWatch cache for all resources that are
×
92
        // GET or LISTed. this uses too much memory on large clusters.
×
93
        var clientOpts *client.CacheOptions
×
94
        cacheOpts := cache.Options{}
×
95
        if conf.DisableExpensiveCache {
×
96
                clientOpts = &client.CacheOptions{
×
97
                        // we only interact with a small subset of pods
×
98
                        // but there's no good filter to only cache the pods we care about
×
99
                        // so we disable caching them for now.
×
100
                        DisableFor: []client.Object{&corev1.Pod{}},
×
101
                }
×
102

×
103
                cacheOpts.ByObject = map[client.Object]cache.ByObject{
×
104
                        &corev1.Event{}: {
×
105
                                Field: placeholderpod.EventMirrorSelector,
×
106
                        },
×
UNCOV
107
                }
×
108
        }
×
109

110
        m, err := ctrl.NewManager(rc, ctrl.Options{
×
111
                Metrics:                metricsserver.Options{BindAddress: conf.MetricsAddr},
×
112
                HealthProbeBindAddress: conf.ProbeAddr,
×
113
                Scheme:                 scheme,
×
114

×
115
                // we use an active-passive HA model meaning only the leader performs actions
×
116
                LeaderElection:          true,
×
117
                LeaderElectionNamespace: "kube-system",
×
118
                LeaderElectionID:        "aks-app-routing-operator-leader",
×
119

×
120
                Client: client.Options{Cache: clientOpts},
×
121
                Cache:  cacheOpts,
×
122
        })
×
123
        if err != nil {
×
UNCOV
124
                return nil, fmt.Errorf("creating manager: %w", err)
×
125
        }
×
126

127
        setupLog := m.GetLogger().WithName("setup")
×
128
        if err := setupProbes(conf, m, setupLog); err != nil {
×
129
                setupLog.Error(err, "failed to set up probes")
×
UNCOV
130
                return nil, fmt.Errorf("setting up probes: %w", err)
×
UNCOV
131
        }
×
132

133
        // create non-caching clients, non-caching for use before manager has started
134
        cl, err := client.New(rc, client.Options{Scheme: scheme})
×
135
        if err != nil {
×
136
                setupLog.Error(err, "unable to create non-caching client")
×
UNCOV
137
                return nil, fmt.Errorf("creating non-caching client: %w", err)
×
138
        }
×
139

140
        if err := loadCRDs(cl, conf, setupLog); err != nil {
×
141
                setupLog.Error(err, "failed to load CRDs")
×
UNCOV
142
                return nil, fmt.Errorf("loading CRDs: %w", err)
×
143
        }
×
144

145
        if err := setupIndexers(m, setupLog, conf); err != nil {
×
146
                setupLog.Error(err, "unable to setup indexers")
×
UNCOV
147
                return nil, fmt.Errorf("setting up indexers: %w", err)
×
148
        }
×
149

150
        if err := setupControllers(m, conf, setupLog, cl); err != nil {
×
151
                setupLog.Error(err, "unable to setup controllers")
×
UNCOV
152
                return nil, fmt.Errorf("setting up controllers: %w", err)
×
153
        }
×
154

UNCOV
155
        return m, nil
×
156
}
157

158
func setupIndexers(mgr ctrl.Manager, lgr logr.Logger, conf *config.Config) error {
2✔
159
        lgr.Info("setting up indexers")
2✔
160

2✔
161
        lgr.Info("adding Nginx Ingress Controller IngressClass indexer")
2✔
162
        if err := nginxingress.AddIngressClassNameIndex(mgr.GetFieldIndexer(), nicIngressClassIndex); err != nil {
2✔
163
                lgr.Error(err, "adding Nginx Ingress Controller IngressClass indexer")
×
UNCOV
164
                return fmt.Errorf("adding Nginx Ingress Controller IngressClass indexer: %w", err)
×
UNCOV
165
        }
×
166

167
        if conf.EnableGateway {
2✔
168
                if err := util.AddGatewayServiceAccountIndex(mgr.GetFieldIndexer(), gatewayListenerIndexName); err != nil {
×
169
                        lgr.Error(err, "adding Gateway Service Account indexer")
×
UNCOV
170
                        return fmt.Errorf("adding Gateway Service Account indexer: %w", err)
×
UNCOV
171
                }
×
172
        }
173

174
        lgr.Info("finished setting up indexers")
2✔
175
        return nil
2✔
176
}
177

178
func setupControllers(mgr ctrl.Manager, conf *config.Config, lgr logr.Logger, cl client.Client) error {
2✔
179
        lgr.Info("setting up controllers")
2✔
180

2✔
181
        lgr.Info("determining default IngressClass controller class")
2✔
182
        defaultCc, err := nginxingress.GetDefaultIngressClassControllerClass(cl)
2✔
183
        if err != nil {
2✔
UNCOV
184
                return fmt.Errorf("determining default IngressClass controller class: %w", err)
×
UNCOV
185
        }
×
186

187
        lgr.Info("settup up ExternalDNS controller")
2✔
188
        if err := dns.NewExternalDns(mgr, conf); err != nil {
2✔
UNCOV
189
                return fmt.Errorf("setting up external dns controller: %w", err)
×
UNCOV
190
        }
×
191

192
        lgr.Info("setting up Nginx Ingress Controller reconciler")
2✔
193
        if err := nginxingress.NewReconciler(conf, mgr, defaultCc); err != nil {
2✔
UNCOV
194
                return fmt.Errorf("setting up nginx ingress controller reconciler: %w", err)
×
UNCOV
195
        }
×
196

197
        lgr.Info("setting up ingress cert config reconciler")
2✔
198
        if err = osm.NewIngressCertConfigReconciler(mgr, conf); err != nil {
2✔
UNCOV
199
                return fmt.Errorf("setting up ingress cert config reconciler: %w", err)
×
UNCOV
200
        }
×
201

202
        defaultNic := nginxingress.GetDefaultNginxIngressController()
2✔
203
        if err := service.NewNginxIngressReconciler(mgr, nginxingress.ToNginxIngressConfig(&defaultNic, defaultCc)); err != nil {
2✔
UNCOV
204
                return fmt.Errorf("setting up nginx ingress reconciler: %w", err)
×
UNCOV
205
        }
×
206

207
        lgr.Info("setting up default Nginx Ingress Controller reconciler")
2✔
208
        if err := nginxingress.NewDefaultReconciler(mgr, conf); err != nil {
2✔
UNCOV
209
                return fmt.Errorf("setting up nginx ingress default controller reconciler: %w", err)
×
UNCOV
210
        }
×
211

212
        lgr.Info("setting up ingress concurrency watchdog")
2✔
213
        if err := ingress.NewConcurrencyWatchdog(mgr, conf, ingress.GetListNginxWatchdogTargets(mgr.GetClient(), defaultCc)); err != nil {
2✔
UNCOV
214
                return fmt.Errorf("setting up ingress concurrency watchdog: %w", err)
×
UNCOV
215
        }
×
216

217
        ingressManager := util.NewIngressManagerFromFn(func(ing *netv1.Ingress) (bool, error) {
2✔
UNCOV
218
                return nginxingress.IsIngressManaged(context.Background(), mgr.GetClient(), ing, nicIngressClassIndex)
×
UNCOV
219
        })
×
220
        lgr.Info("setting up keyvault secret provider class reconciler")
2✔
221
        if err := spc.NewIngressSecretProviderClassReconciler(mgr, conf, ingressManager); err != nil {
2✔
UNCOV
222
                return fmt.Errorf("setting up ingress secret provider class reconciler: %w", err)
×
UNCOV
223
        }
×
224
        lgr.Info("setting up nginx keyvault secret provider class reconciler")
2✔
225
        if err := spc.NewNginxSecretProviderClassReconciler(mgr, conf); err != nil {
2✔
UNCOV
226
                return fmt.Errorf("setting up nginx secret provider class reconciler: %w", err)
×
UNCOV
227
        }
×
228
        lgr.Info("setting up keyvault placeholder pod controller")
2✔
229
        if err := placeholderpod.NewPlaceholderPodController(mgr, conf, ingressManager); err != nil {
2✔
UNCOV
230
                return fmt.Errorf("setting up placeholder pod controller: %w", err)
×
UNCOV
231
        }
×
232
        lgr.Info("setting up keyvault event mirror")
2✔
233
        if err = placeholderpod.NewEventMirror(mgr, conf); err != nil {
2✔
UNCOV
234
                return fmt.Errorf("setting up event mirror: %w", err)
×
UNCOV
235
        }
×
236

237
        ingressSourceSpecer := osm.NewIngressControllerSourceSpecerFromFn(func(ing *netv1.Ingress) (policyv1alpha1.IngressSourceSpec, bool, error) {
2✔
UNCOV
238
                return nginxingress.IngressSource(context.Background(), mgr.GetClient(), conf, defaultCc, ing, nicIngressClassIndex)
×
UNCOV
239
        })
×
240
        lgr.Info("setting up ingress backend reconciler")
2✔
241
        if err := osm.NewIngressBackendReconciler(mgr, conf, ingressSourceSpecer); err != nil {
2✔
UNCOV
242
                return fmt.Errorf("setting up ingress backend reconciler: %w", err)
×
UNCOV
243
        }
×
244

245
        if conf.EnableGateway {
2✔
UNCOV
246
                lgr.Info("setting up gateway reconcilers")
×
UNCOV
247
                if err := spc.NewGatewaySecretClassProviderReconciler(mgr, conf, gatewayListenerIndexName); err != nil {
×
248
                        return fmt.Errorf("setting up Gateway SPC reconciler: %w", err)
×
249
                }
×
250
        }
251

252
        lgr.Info("finished setting up controllers")
2✔
253
        return nil
2✔
254
}
255

256
func setupProbes(conf *config.Config, mgr ctrl.Manager, log logr.Logger) error {
2✔
257
        log.Info("adding probes to manager")
2✔
258

2✔
259
        check := func(req *http.Request) error { return nil }
2✔
260

261
        if err := mgr.AddReadyzCheck("readyz", check); err != nil {
2✔
UNCOV
262
                return fmt.Errorf("adding readyz check: %w", err)
×
UNCOV
263
        }
×
264

265
        if err := mgr.AddHealthzCheck("healthz", check); err != nil {
2✔
UNCOV
266
                return fmt.Errorf("adding healthz check: %w", err)
×
UNCOV
267
        }
×
268

269
        log.Info("added probes to manager")
2✔
270
        return nil
2✔
271
}
272

273
func getSelfDeploy(kcs kubernetes.Interface, conf *config.Config, log logr.Logger) (*appsv1.Deployment, error) {
4✔
274
        // this doesn't actually work today. operator ns is not the same as resource ns which means we can't set this operator
4✔
275
        // as the owner of any child resources. https://kubernetes.io/docs/concepts/overview/working-with-objects/owners-dependents/#owner-references-in-object-specifications
4✔
276
        // dynamic provisioning through a crd will fix this and fix our garbage collection.
4✔
277

4✔
278
        deploy, err := kcs.AppsV1().Deployments(conf.NS).Get(context.Background(), conf.OperatorDeployment, metav1.GetOptions{})
4✔
279
        if errors.IsNotFound(err) {
6✔
280
                // It's okay if we don't find the deployment - just skip setting ownership references latter
2✔
281
                log.Info("self deploy not found")
2✔
282
                return nil, nil
2✔
283
        }
2✔
284
        if err != nil {
2✔
UNCOV
285
                return nil, err
×
UNCOV
286
        }
×
287
        return deploy, nil
2✔
288
}
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