Skip to content

Commit 414af9d

Browse files
AlinsRanAlinsRan
authored
feat: support secret for consumers (#82)
1 parent aebd2af commit 414af9d

File tree

5 files changed

+135
-88
lines changed

5 files changed

+135
-88
lines changed

‎internal/controller/consumer_controller.go‎

Lines changed: 29 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,9 +59,37 @@ func (r *ConsumerReconciler) SetupWithManager(mgr ctrl.Manager) error {
5959
},
6060
),
6161
).
62+
Watches(&corev1.Secret{},
63+
handler.EnqueueRequestsFromMapFunc(r.listConsumersForSecret),
64+
).
6265
Complete(r)
6366
}
6467

68+
func (r *ConsumerReconciler) listConsumersForSecret(ctx context.Context, obj client.Object) []reconcile.Request {
69+
secret, ok := obj.(*corev1.Secret)
70+
if !ok {
71+
r.Log.Error(nil, "failed to convert to Secret", "object", obj)
72+
return nil
73+
}
74+
consumerList := &v1alpha1.ConsumerList{}
75+
if err := r.List(ctx, consumerList, client.MatchingFields{
76+
indexer.SecretIndexRef: indexer.GenIndexKey(secret.GetNamespace(), secret.GetName()),
77+
}); err != nil {
78+
r.Log.Error(err, "failed to list consumers")
79+
return nil
80+
}
81+
requests := make([]reconcile.Request, 0, len(consumerList.Items))
82+
for _, consumer := range consumerList.Items {
83+
requests = append(requests, reconcile.Request{
84+
NamespacedName: client.ObjectKey{
85+
Name: consumer.Name,
86+
Namespace: consumer.Namespace,
87+
},
88+
})
89+
}
90+
return requests
91+
}
92+
6593
func (r *ConsumerReconciler) listConsumersForGateway(ctx context.Context, obj client.Object) []reconcile.Request {
6694
gateway, ok := obj.(*gatewayv1.Gateway)
6795
if !ok {
@@ -70,7 +98,7 @@ func (r *ConsumerReconciler) listConsumersForGateway(ctx context.Context, obj cl
7098
}
7199
consumerList := &v1alpha1.ConsumerList{}
72100
if err := r.List(ctx, consumerList, client.MatchingFields{
73-
indexer.ConsumerGatewayRef: indexer.GenIndexKey(gateway.Name, gateway.GetNamespace()),
101+
indexer.ConsumerGatewayRef: indexer.GenIndexKey(gateway.GetNamespace(), gateway.GetName()),
74102
}); err != nil {
75103
r.Log.Error(err, "failed to list consumers")
76104
return nil

‎internal/controller/indexer/indexer.go‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -58,8 +58,35 @@ func setupConsumerIndexer(mgr ctrl.Manager) error {
5858
); err != nil {
5959
return err
6060
}
61+
if err := mgr.GetFieldIndexer().IndexField(
62+
context.Background(),
63+
&v1alpha1.Consumer{},
64+
SecretIndexRef,
65+
ConsumerSecretIndexFunc,
66+
); err != nil {
67+
return err
68+
}
6169
return nil
6270
}
71+
72+
func ConsumerSecretIndexFunc(rawObj client.Object) []string {
73+
consumer := rawObj.(*v1alpha1.Consumer)
74+
secretKeys := make([]string, 0)
75+
76+
for _, credential := range consumer.Spec.Credentials {
77+
if credential.SecretRef == nil {
78+
continue
79+
}
80+
ns := consumer.GetNamespace()
81+
if credential.SecretRef.Namespace != nil {
82+
ns = *credential.SecretRef.Namespace
83+
}
84+
key := GenIndexKey(ns, credential.SecretRef.Name)
85+
secretKeys = append(secretKeys, key)
86+
}
87+
return secretKeys
88+
}
89+
6390
func ConsumerGatewayRefIndexFunc(rawObj client.Object) []string {
6491
consumer := rawObj.(*v1alpha1.Consumer)
6592

‎internal/provider/adc/translator/consumer.go‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ func (t *Translator) TranslateConsumerV1alpha1(tctx *provider.TranslateContext,
3939
}
4040
authConfig := make(map[string]any)
4141
for k, v := range secret.Data {
42-
authConfig[k] = v
42+
authConfig[k] = string(v)
4343
}
4444
credential.Config = authConfig
4545
} else {

‎test/e2e/crds/consumer.go‎

Lines changed: 78 additions & 85 deletions
Original file line numberDiff line numberDiff line change
@@ -109,73 +109,97 @@ spec:
109109
s.ResourceApplied("httproute", "httpbin", defaultHTTPRoute, 1)
110110
}
111111

112-
Context("Consumer plugins", func() {
113-
var keyAuthConsumer = `apiVersion: gateway.apisix.io/v1alpha1
112+
Context("Credential", func() {
113+
var defaultCredential = `apiVersion: gateway.apisix.io/v1alpha1
114114
kind: Consumer
115115
metadata:
116116
name: consumer-sample
117117
spec:
118118
gatewayRef:
119119
name: api7ee
120-
plugins:
121-
- name: key-auth
120+
credentials:
121+
- type: basic-auth
122+
name: basic-auth-sample
123+
config:
124+
username: sample-user
125+
password: sample-password
126+
- type: key-auth
127+
name: key-auth-sample
122128
config:
123129
key: sample-key
130+
- type: key-auth
131+
name: key-auth-sample2
132+
config:
133+
key: sample-key2
124134
`
125-
var basicAuthConsumer = `apiVersion: gateway.apisix.io/v1alpha1
135+
var updateCredential = `apiVersion: gateway.apisix.io/v1alpha1
126136
kind: Consumer
127137
metadata:
128138
name: consumer-sample
129139
spec:
130140
gatewayRef:
131141
name: api7ee
132-
plugins:
133-
- name: basic-auth
142+
credentials:
143+
- type: basic-auth
144+
name: basic-auth-sample
134145
config:
135146
username: sample-user
136147
password: sample-password
148+
plugins:
149+
- name: key-auth
150+
config:
151+
key: consumer-key
137152
`
138-
139153
BeforeEach(beforeEachHTTP)
140154

141-
It("key-auth", func() {
142-
s.ResourceApplied("Consumer", "consumer-sample", keyAuthConsumer, 1)
155+
It("Create/Update/Delete", func() {
156+
s.ResourceApplied("Consumer", "consumer-sample", defaultCredential, 1)
143157

144158
s.NewAPISIXClient().
145159
GET("/get").
160+
WithHeader("apikey", "sample-key").
146161
WithHost("httpbin.org").
147162
Expect().
148-
Status(401)
163+
Status(200)
149164

150165
s.NewAPISIXClient().
151166
GET("/get").
152-
WithHeader("apikey", "sample-key").
167+
WithHeader("apikey", "sample-key2").
153168
WithHost("httpbin.org").
154169
Expect().
155170
Status(200)
156171

157-
By("delete Consumer")
158-
err := s.DeleteResourceFromString(keyAuthConsumer)
159-
Expect(err).NotTo(HaveOccurred(), "deleting Consumer")
160-
time.Sleep(5 * time.Second)
172+
s.NewAPISIXClient().
173+
GET("/get").
174+
WithBasicAuth("sample-user", "sample-password").
175+
WithHost("httpbin.org").
176+
Expect().
177+
Status(200)
178+
179+
By("update Consumer")
180+
s.ResourceApplied("Consumer", "consumer-sample", updateCredential, 2)
161181

162182
s.NewAPISIXClient().
163183
GET("/get").
164184
WithHeader("apikey", "sample-key").
165185
WithHost("httpbin.org").
166186
Expect().
167187
Status(401)
168-
})
169-
170-
It("basic-auth", func() {
171-
s.ResourceApplied("Consumer", "consumer-sample", basicAuthConsumer, 1)
172188

173189
s.NewAPISIXClient().
174190
GET("/get").
191+
WithHeader("apikey", "sample-key2").
175192
WithHost("httpbin.org").
176193
Expect().
177194
Status(401)
178195

196+
s.NewAPISIXClient().
197+
GET("/get").
198+
WithHeader("apikey", "consumer-key").
199+
WithHost("httpbin.org").
200+
Expect().
201+
Status(200)
202+
179203
s.NewAPISIXClient().
180204
GET("/get").
181205
WithBasicAuth("sample-user", "sample-password").
@@ -184,7 +208,7 @@ spec:
184208
Status(200)
185209

186210
By("delete Consumer")
187-
err := s.DeleteResourceFromString(basicAuthConsumer)
211+
err := s.DeleteResourceFromString(updateCredential)
188212
Expect(err).NotTo(HaveOccurred(), "deleting Consumer")
189213
time.Sleep(5 * time.Second)
190214

@@ -197,8 +221,26 @@ spec:
197221
})
198222
})
199223

200-
Context("Credential", func() {
201-
var defaultCredential = `apiVersion: gateway.apisix.io/v1alpha1
224+
Context("SecretRef", func() {
225+
var keyAuthSecret = `
226+
apiVersion: v1
227+
kind: Secret
228+
metadata:
229+
name: key-auth-secret
230+
data:
231+
key: c2FtcGxlLWtleQ==
232+
`
233+
var basicAuthSecret = `
234+
apiVersion: v1
235+
kind: Secret
236+
metadata:
237+
name: basic-auth-secret
238+
data:
239+
username: c2FtcGxlLXVzZXI=
240+
password: c2FtcGxlLXBhc3N3b3Jk
241+
`
242+
var defaultConsumer = `
243+
apiVersion: gateway.apisix.io/v1alpha1
202244
kind: Consumer
203245
metadata:
204246
name: consumer-sample
@@ -208,40 +250,25 @@ spec:
208250
credentials:
209251
- type: basic-auth
210252
name: basic-auth-sample
211-
config:
212-
username: sample-user
213-
password: sample-password
253+
secretRef:
254+
name: basic-auth-secret
214255
- type: key-auth
215256
name: key-auth-sample
216-
config:
217-
key: sample-key
257+
secretRef:
258+
name: key-auth-secret
218259
- type: key-auth
219260
name: key-auth-sample2
220261
config:
221262
key: sample-key2
222-
`
223-
var updateCredential = `apiVersion: gateway.apisix.io/v1alpha1
224-
kind: Consumer
225-
metadata:
226-
name: consumer-sample
227-
spec:
228-
gatewayRef:
229-
name: api7ee
230-
credentials:
231-
- type: basic-auth
232-
name: basic-auth-sample
233-
config:
234-
username: sample-user
235-
password: sample-password
236-
plugins:
237-
- name: key-auth
238-
config:
239-
key: consumer-key
240263
`
241264
BeforeEach(beforeEachHTTP)
242265

243266
It("Create/Update/Delete", func() {
244-
s.ResourceApplied("Consumer", "consumer-sample", defaultCredential, 1)
267+
err := s.CreateResourceFromString(keyAuthSecret)
268+
Expect(err).NotTo(HaveOccurred(), "creating key-auth secret")
269+
err = s.CreateResourceFromString(basicAuthSecret)
270+
Expect(err).NotTo(HaveOccurred(), "creating basic-auth secret")
271+
s.ResourceApplied("Consumer", "consumer-sample", defaultConsumer, 1)
245272

246273
s.NewAPISIXClient().
247274
GET("/get").
@@ -250,22 +277,17 @@ spec:
250277
Expect().
251278
Status(200)
252279

253-
s.NewAPISIXClient().
254-
GET("/get").
255-
WithHeader("apikey", "sample-key2").
256-
WithHost("httpbin.org").
257-
Expect().
258-
Status(200)
259-
260280
s.NewAPISIXClient().
261281
GET("/get").
262282
WithBasicAuth("sample-user", "sample-password").
263283
WithHost("httpbin.org").
264284
Expect().
265285
Status(200)
266286

267-
By("update Consumer")
268-
s.ResourceApplied("Consumer", "consumer-sample", updateCredential, 2)
287+
By("delete consumer")
288+
err = s.DeleteResourceFromString(defaultConsumer)
289+
Expect(err).NotTo(HaveOccurred(), "deleting consumer")
290+
time.Sleep(5 * time.Second)
269291

270292
s.NewAPISIXClient().
271293
GET("/get").
@@ -274,32 +296,6 @@ spec:
274296
Expect().
275297
Status(401)
276298

277-
s.NewAPISIXClient().
278-
GET("/get").
279-
WithHeader("apikey", "sample-key2").
280-
WithHost("httpbin.org").
281-
Expect().
282-
Status(401)
283-
284-
s.NewAPISIXClient().
285-
GET("/get").
286-
WithHeader("apikey", "consumer-key").
287-
WithHost("httpbin.org").
288-
Expect().
289-
Status(200)
290-
291-
s.NewAPISIXClient().
292-
GET("/get").
293-
WithBasicAuth("sample-user", "sample-password").
294-
WithHost("httpbin.org").
295-
Expect().
296-
Status(200)
297-
298-
By("delete Consumer")
299-
err := s.DeleteResourceFromString(updateCredential)
300-
Expect(err).NotTo(HaveOccurred(), "deleting Consumer")
301-
time.Sleep(5 * time.Second)
302-
303299
s.NewAPISIXClient().
304300
GET("/get").
305301
WithBasicAuth("sample-user", "sample-password").
@@ -308,7 +304,4 @@ spec:
308304
Status(401)
309305
})
310306
})
311-
312-
PContext("SecretRef", func() {
313-
})
314307
})

‎test/e2e/scaffold/scaffold.go‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -512,7 +512,6 @@ func (s *Scaffold) GetDeploymentLogs(name string) string {
512512
Resource("pods").
513513
Namespace(s.namespace).
514514
Name(pod.Name).SubResource("log").
515-
Param("container", name).
516515
Do(context.TODO()).
517516
Raw()
518517
if err == nil {

0 commit comments

Comments
 (0)