forked from red-hat-storage/ocs-operator
-
Notifications
You must be signed in to change notification settings - Fork 0
/
external_resources_test.go
604 lines (564 loc) · 19.4 KB
/
external_resources_test.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
package storagecluster
import (
"context"
"encoding/json"
"fmt"
"math/rand"
"net"
"strconv"
"testing"
"time"
nbv1 "github.com/noobaa/noobaa-operator/v5/pkg/apis/noobaa/v1alpha1"
api "github.com/red-hat-storage/ocs-operator/api/v1"
cephv1 "github.com/rook/rook/pkg/apis/ceph.rook.io/v1"
"github.com/stretchr/testify/assert"
corev1 "k8s.io/api/core/v1"
storagev1 "k8s.io/api/storage/v1"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/apimachinery/pkg/types"
"sigs.k8s.io/controller-runtime/pkg/client"
"sigs.k8s.io/controller-runtime/pkg/reconcile"
)
var globalTestExternalResources = []ExternalResource{
{
Kind: "ConfigMap",
Data: map[string]string{
"maxMonId": "0",
"data": "a=10.20.30.40:1234",
"mapping": "{}",
},
Name: "rook-ceph-mon-endpoints",
},
{
Kind: "Secret",
Data: map[string]string{
"userKey": "someUserKeyRBD==",
"userID": "csi-rbd-node",
},
Name: "rook-csi-rbd-node",
},
{
Kind: "StorageClass",
Data: map[string]string{
"pool": "device_health_metrics",
},
Name: "ceph-rbd",
},
{
Kind: "StorageClass",
Data: map[string]string{
"fsName": "myfs",
"pool": "myfs-data0",
},
Name: "cephfs",
},
{
Kind: "StorageClass",
Data: map[string]string{
"endpoint": fmt.Sprintf("localhost:%d", generateRandomPort(10000, 30000)),
},
Name: "ceph-rgw",
},
{
Kind: "CephCluster",
Data: map[string]string{
"MonitoringEndpoint": "127.0.0.1, localhost",
"MonitoringPort": fmt.Sprintf("%d", generateRandomPort(19000, 29000)),
},
Name: "monitoring-endpoint",
},
}
func TestEnsureExternalStorageClusterResources(t *testing.T) {
request := reconcile.Request{
NamespacedName: types.NamespacedName{
Name: "ocsinit",
Namespace: "",
},
}
reconciler := createExternalClusterReconciler(t)
result, err := reconciler.Reconcile(context.TODO(), request)
assert.NoError(t, err)
assert.Equal(t, reconcile.Result{}, result)
assertExpectedExternalResources(t, reconciler)
}
func newRookCephOperatorConfig(namespace string) *corev1.ConfigMap {
config := &corev1.ConfigMap{
ObjectMeta: metav1.ObjectMeta{
Name: rookCephOperatorConfigName,
Namespace: namespace,
},
}
data := make(map[string]string)
config.Data = data
return config
}
func createExternalCephClusterSecret(extResources []ExternalResource) (*corev1.Secret, error) {
jsonBlob, err := json.Marshal(extResources)
if err != nil {
return nil, err
}
externalSecret := &corev1.Secret{
ObjectMeta: metav1.ObjectMeta{
Name: externalClusterDetailsSecret,
},
Data: map[string][]byte{
externalClusterDetailsKey: jsonBlob,
},
}
return externalSecret, err
}
func createExternalClusterReconciler(t *testing.T) StorageClusterReconciler {
return createExternalClusterReconcilerFromCustomResources(t, globalTestExternalResources)
}
func createExternalClusterReconcilerFromCustomResources(
t *testing.T, extResources []ExternalResource) StorageClusterReconciler {
cr := &api.StorageCluster{
ObjectMeta: metav1.ObjectMeta{
Name: "ocsinit",
Annotations: map[string]string{
UninstallModeAnnotation: string(UninstallModeGraceful),
CleanupPolicyAnnotation: string(CleanupPolicyDelete),
},
},
Spec: api.StorageClusterSpec{
ExternalStorage: api.ExternalStorageClusterSpec{
Enable: true,
},
Monitoring: &api.MonitoringSpec{
ReconcileStrategy: string(ReconcileStrategyIgnore),
},
},
}
if extResource, err := findNamedResourceFromArray(extResources, "ceph-rgw"); err == nil {
servEndpoint := extResource.Data["endpoint"]
startServerAt(t, servEndpoint)
}
if extResource, err := findNamedResourceFromArray(extResources, "monitoring-endpoint"); err == nil {
monEndpointIP := extResource.Data["MonitoringEndpoint"]
monEndpointPort := extResource.Data["MonitoringPort"]
if monEndpointIP != "" && monEndpointPort != "" {
monEndpointIP = parseMonitoringIPs(monEndpointIP)[0]
servEndpoint := net.JoinHostPort(monEndpointIP, monEndpointPort)
startServerAt(t, servEndpoint)
}
}
externalSecret, err := createExternalCephClusterSecret(extResources)
if err != nil {
t.Fatalf("failed to create external secret: %v", err)
}
rookCephConfig := newRookCephOperatorConfig("")
reconciler := createFakeInitializationStorageClusterReconciler(t, &nbv1.NooBaa{})
clientObjs := []client.Object{cr, externalSecret, rookCephConfig}
for _, obj := range clientObjs {
if err = reconciler.Client.Create(context.TODO(), obj); err != nil {
t.Fatalf("failed to create a needed runtime object: %v", err)
}
}
return reconciler
}
func assertExpectedExternalResources(t *testing.T, reconciler StorageClusterReconciler) {
request := reconcile.Request{
NamespacedName: types.NamespacedName{
Name: "ocsinit",
Namespace: "",
},
}
sc := &api.StorageCluster{}
err := reconciler.Client.Get(context.TODO(), request.NamespacedName, sc)
assert.NoError(t, err)
externalSecret := &corev1.Secret{}
request.Name = externalClusterDetailsSecret
err = reconciler.Client.Get(context.TODO(), request.NamespacedName, externalSecret)
assert.NoError(t, err)
var data []ExternalResource
err = json.Unmarshal(externalSecret.Data[externalClusterDetailsKey], &data)
if err != nil {
t.Errorf("fatal err %+v", err)
}
for _, expected := range data {
request.Name = expected.Name
switch expected.Kind {
case "CephCluster":
actual := &cephv1.CephCluster{}
err := reconciler.Client.Get(context.TODO(),
types.NamespacedName{Name: generateNameForCephCluster(sc)}, actual)
assert.NoError(t, err)
assert.True(t, actual.Spec.Monitoring.Enabled, "Expecting 'Monitoring' to be enabled")
if uint16Port, err := strconv.ParseUint(expected.Data["MonitoringPort"], 10, 16); err == nil {
assert.Equal(t, actual.Spec.Monitoring.ExternalMgrPrometheusPort, uint16(uint16Port))
} else {
assert.Zero(t, actual.Spec.Monitoring.ExternalMgrPrometheusPort, "Expected the port to be ZERO")
}
case "ConfigMap":
actual := &corev1.ConfigMap{}
err := reconciler.Client.Get(context.TODO(), request.NamespacedName, actual)
assert.NoError(t, err)
for er := range expected.Data {
assert.Equal(t, expected.Data[er], actual.Data[er])
}
case "Secret":
actual := &corev1.Secret{}
err := reconciler.Client.Get(context.TODO(), request.NamespacedName, actual)
assert.NoError(t, err)
for er := range expected.Data {
assert.Equal(t, []byte(expected.Data[er]), actual.Data[er])
}
case "StorageClass":
actual := &storagev1.StorageClass{}
request.Name = fmt.Sprintf("%s-%s", sc.Name, expected.Name)
err := reconciler.Client.Get(context.TODO(), request.NamespacedName, actual)
assert.NoError(t, err)
// 'endpoint's are not required, as they are moved out to CephObjectStore
delete(expected.Data, "endpoint")
for param, value := range expected.Data {
assert.Equal(t, value, actual.Parameters[param])
}
// Verify the RGW SC parameters in external mode are correct
// The main difference between external and converged is the presence of an endpoint
// and the absence of the "objectStoreName" parameter
if actual.Name == "ocsinit-ceph-rgw" {
assert.NotEmpty(t, actual.Parameters["region"], actual.Parameters)
assert.NotContains(t, actual.Parameters["objectStoreName"], actual.Parameters)
assert.Equal(t, actual.Parameters["region"], "us-east-1")
assert.Equal(t, 3, len(actual.Parameters), actual.Parameters)
}
}
}
}
// removeNamedResourceFromArray removes the first resource with 'Name' == 'name'
func removeNamedResourceFromArray(extArr []ExternalResource, name string) []ExternalResource {
extArrLen := len(extArr)
var indx int
for indx = 0; indx < extArrLen; indx++ {
extRsrc := extArr[indx]
if extRsrc.Name == name {
break
}
}
var newExtArr []ExternalResource
newExtArr = append(newExtArr, extArr[:indx]...)
if indx < extArrLen {
newExtArr = append(newExtArr, extArr[indx+1:]...)
}
return newExtArr
}
// updateNamedResourceInArray updates the provided 'extArr' with the given 'extRsrc' external resource
func updateNamedResourceInArray(extArr []ExternalResource, extRsrc ExternalResource) []ExternalResource {
_, err := findNamedResourceFromArray(extArr, extRsrc.Name)
if err == nil {
extArr = removeNamedResourceFromArray(extArr, extRsrc.Name)
}
extArr = append(extArr, extRsrc)
return extArr
}
func generateRandomPort(minPort, maxPort int) int {
rand.Seed(time.Now().UnixNano())
portRange := minPort - maxPort
if portRange < 0 {
portRange *= -1
}
retPort := rand.Intn(portRange) + minPort
return retPort
}
func TestOptionalExternalStorageClusterResources(t *testing.T) {
request := reconcile.Request{
NamespacedName: types.NamespacedName{
Name: "ocsinit",
Namespace: "",
},
}
optionalTestParams := []struct {
label string
resourceToBeRemoved string
expectedRookCephConfigVal string
}{
{
label: "RemoveRGW",
resourceToBeRemoved: "ceph-rgw",
expectedRookCephConfigVal: "true",
},
{
label: "RemoveCephFS",
resourceToBeRemoved: "cephfs",
expectedRookCephConfigVal: "false",
},
}
for _, testParam := range optionalTestParams {
t.Run(testParam.label, func(t *testing.T) {
extResources := removeNamedResourceFromArray(globalTestExternalResources, testParam.resourceToBeRemoved)
reconciler := createExternalClusterReconcilerFromCustomResources(t, extResources)
result, err := reconciler.Reconcile(context.TODO(), request)
assert.NoError(t, err)
assert.Equal(t, reconcile.Result{}, result)
// rest of the resources should be available
assertExpectedExternalResources(t, reconciler)
// make sure we are missing the provided resource
assertMissingExternalResource(t, reconciler, testParam.resourceToBeRemoved)
// make sure that we have expected rook ceph config value
assertRookCephOperatorConfigValue(t, reconciler, testParam.expectedRookCephConfigVal)
// make sure about the availability of 'CephObjectStore' according to the resource removed
assertCephObjectStore(t, reconciler, testParam.resourceToBeRemoved)
})
}
}
func assertRookCephOperatorConfigValue(t *testing.T, reconciler StorageClusterReconciler, checkValue string) {
request := reconcile.Request{
NamespacedName: types.NamespacedName{
Name: "ocsinit",
Namespace: "",
},
}
sc := &api.StorageCluster{}
err := reconciler.Client.Get(context.TODO(), request.NamespacedName, sc)
assert.NoError(t, err)
rookCephOperatorConfig := &corev1.ConfigMap{}
err = reconciler.Client.Get(context.TODO(),
types.NamespacedName{Name: rookCephOperatorConfigName, Namespace: sc.ObjectMeta.Namespace},
rookCephOperatorConfig)
assert.NoErrorf(t, err, "Unable to get '%s' config", rookCephOperatorConfigName)
assert.Truef(t,
rookCephOperatorConfig.Data[rookEnableCephFSCSIKey] == checkValue,
"'%s' key is supposed to be '%s'", rookEnableCephFSCSIKey, checkValue)
}
func assertMissingExternalResource(t *testing.T, reconciler StorageClusterReconciler, resourceName string) {
request := reconcile.Request{
NamespacedName: types.NamespacedName{
Name: "ocsinit",
Namespace: "",
},
}
sc := &api.StorageCluster{}
err := reconciler.Client.Get(context.TODO(), request.NamespacedName, sc)
assert.NoError(t, err)
externalSecret := &corev1.Secret{}
request.Name = externalClusterDetailsSecret
err = reconciler.Client.Get(context.TODO(), request.NamespacedName, externalSecret)
assert.NoError(t, err)
var data []ExternalResource
err = json.Unmarshal(externalSecret.Data[externalClusterDetailsKey], &data)
if err != nil {
t.Errorf("fatal err %+v", err)
}
actual := &storagev1.StorageClass{}
request.Name = fmt.Sprintf("%s-%s", sc.Name, resourceName)
err = reconciler.Client.Get(context.TODO(), request.NamespacedName, actual)
// as the resource is missing, we are expecting an 'error'
assert.Error(t, err)
}
func assertCephObjectStore(t *testing.T, reconciler StorageClusterReconciler, removedResource string) {
request := reconcile.Request{
NamespacedName: types.NamespacedName{
Name: "ocsinit",
Namespace: "",
},
}
sc := &api.StorageCluster{}
err := reconciler.Client.Get(context.TODO(), request.NamespacedName, sc)
assert.NoError(t, err)
expectedName := fmt.Sprintf("%s-cephobjectstore", sc.Name)
request.Name = expectedName
cObjS := &cephv1.CephObjectStore{
ObjectMeta: metav1.ObjectMeta{
Name: expectedName,
},
}
err = reconciler.Client.Get(context.TODO(), request.NamespacedName, cObjS)
// if removed resource is 'ceph-rgw', we should not get CephObjectStore object
if removedResource == "ceph-rgw" {
assert.Error(t, err)
} else {
assert.NoError(t, err)
extRs, err := reconciler.retrieveExternalSecretData(sc)
assert.NoError(t, err)
extR, err := findNamedResourceFromArray(extRs, "ceph-rgw")
assert.NoError(t, err)
hostFound, portFound, err := net.SplitHostPort(extR.Data["endpoint"])
assert.NoError(t, err)
if cObjS.Spec.Gateway.Port == 0 {
assert.Equal(t, portFound, fmt.Sprintf("%d", cObjS.Spec.Gateway.SecurePort))
assert.Equal(t, cephRgwTLSSecretKey, cObjS.Spec.Gateway.SSLCertificateRef)
} else {
assert.Equal(t, portFound, fmt.Sprintf("%d", cObjS.Spec.Gateway.Port))
}
// length of 'ExternalRgwEndpoints' should be atleast 1
assert.True(t, len(cObjS.Spec.Gateway.ExternalRgwEndpoints) > 0, true)
// and the first IP should be that of the host we passed from 'ceph-rgw' resource
assert.Equal(t, hostFound, cObjS.Spec.Gateway.ExternalRgwEndpoints[0].IP)
}
}
func TestExternalResourceReconcile(t *testing.T) {
reconciler := createExternalClusterReconciler(t)
assertReconciliationOfExternalResource(t, reconciler)
}
func assertReconciliationOfExternalResource(t *testing.T, reconciler StorageClusterReconciler) {
request := reconcile.Request{
NamespacedName: types.NamespacedName{
Name: "ocsinit",
Namespace: "",
},
}
ctx := context.TODO()
// first reconcile, which sets everything in place
result, err := reconciler.Reconcile(ctx, request)
assert.NoError(t, err)
assert.Equal(t, reconcile.Result{}, result)
assertExpectedExternalResources(t, reconciler)
sc := &api.StorageCluster{}
err = reconciler.Client.Get(ctx, request.NamespacedName, sc)
assert.NoError(t, err)
firstExtSecretChecksum := sc.Status.ExternalSecretHash
extRsrcs, err := reconciler.retrieveExternalSecretData(sc)
assert.NoError(t, err)
rgwRsrc, err := findNamedResourceFromArray(extRsrcs, cephRgwStorageClassName)
assert.NoError(t, err)
// change 'rgw-endpoint'
rgwRsrc.Data[externalCephRgwEndpointKey] = fmt.Sprintf("localhost:%d", generateRandomPort(20000, 30000))
// start a dummy / local server at the endpoint
startServerAt(t, rgwRsrc.Data[externalCephRgwEndpointKey])
extRsrcs = updateNamedResourceInArray(extRsrcs, rgwRsrc)
// create and update external secret with new changes
extSecret, err := createExternalCephClusterSecret(extRsrcs)
assert.NoError(t, err)
secret := corev1.Secret{}
err = reconciler.Client.Get(ctx, types.NamespacedName{Name: externalClusterDetailsSecret, Namespace: ""}, &secret)
assert.NoError(t, err)
extSecret.ObjectMeta = secret.ObjectMeta
err = reconciler.Client.Update(ctx, extSecret)
assert.NoError(t, err)
// second reconcile on same 'reconciler', we should have expected/changed resources
result, err = reconciler.Reconcile(ctx, request)
assert.NoError(t, err)
assert.Equal(t, reconcile.Result{}, result)
assertExpectedExternalResources(t, reconciler)
// get the updated storagecluster object after second reconciliation
sc = &api.StorageCluster{}
err = reconciler.Client.Get(ctx, request.NamespacedName, sc)
assert.NoError(t, err)
secondExtSecretChecksum := sc.Status.ExternalSecretHash
// as there are changes, first and second checksums should not match
assert.NotEqual(t, firstExtSecretChecksum, secondExtSecretChecksum)
// third reconcile on same 'reconciler', without any change in the resources
result, err = reconciler.Reconcile(ctx, request)
assert.NoError(t, err)
assert.Equal(t, reconcile.Result{}, result)
assertExpectedExternalResources(t, reconciler)
// get the updated storagecluster object after third reconciliation
sc = &api.StorageCluster{}
err = reconciler.Client.Get(ctx, request.NamespacedName, sc)
assert.NoError(t, err)
thirdExtSecretChecksum := sc.Status.ExternalSecretHash
// as there are no changes, second and third checksums should match
assert.Equal(t, secondExtSecretChecksum, thirdExtSecretChecksum)
}
func TestExternalMonitoringResources(t *testing.T) {
type testResources struct {
ExternalResource
Label string
ReconcileExpectedToFail bool
}
monAddedExternalResources := []testResources{
{
ExternalResource: ExternalResource{
Kind: "CephCluster",
Data: map[string]string{
"MonitoringEndpoint": "127.0.0.1",
"MonitoringPort": fmt.Sprint(generateRandomPort(30000, 40000)),
},
Name: "monitoring-endpoint",
},
Label: "ValidEndpointAndPort",
ReconcileExpectedToFail: false,
},
{
ExternalResource: ExternalResource{
Kind: "CephCluster",
Data: map[string]string{
"MonitoringEndpoint": "127.0.0.1",
},
Name: "monitoring-endpoint",
},
Label: "ValidEndpointWithoutPort",
ReconcileExpectedToFail: false,
},
{
ExternalResource: ExternalResource{
Kind: "CephCluster",
Data: map[string]string{
"MonitoringEndpoint": "127.0.0.1",
"MonitoringPort": "abcde",
},
Name: "monitoring-endpoint",
},
Label: "InvalidPort",
ReconcileExpectedToFail: true,
},
}
request := reconcile.Request{
NamespacedName: types.NamespacedName{
Name: "ocsinit",
Namespace: "",
},
}
for _, extR := range monAddedExternalResources {
t.Run(extR.Label, func(t *testing.T) {
extRArr := updateNamedResourceInArray(globalTestExternalResources, extR.ExternalResource)
reconciler := createExternalClusterReconcilerFromCustomResources(t, extRArr)
result, err := reconciler.Reconcile(context.TODO(), request)
if extR.ReconcileExpectedToFail && err != nil {
return
}
if ok := assert.NoError(t, err); !ok {
t.Fatalf("Reconcile Error: %v", err)
}
assert.Equal(t, reconcile.Result{}, result)
assertExpectedExternalResources(t, reconciler)
})
}
}
func TestErasureCodedExternalResources(t *testing.T) {
cr := &api.StorageCluster{
ObjectMeta: metav1.ObjectMeta{
Name: "ocsinit",
Namespace: "openshift-storage",
},
Spec: api.StorageClusterSpec{
ExternalStorage: api.ExternalStorageClusterSpec{
Enable: true,
},
Monitoring: &api.MonitoringSpec{
ReconcileStrategy: string(ReconcileStrategyIgnore),
},
},
}
externalResource := []ExternalResource{
{
Name: "ceph-rbd",
Kind: "StorageClass",
Data: map[string]string{
"pool": generateNameForCephBlockPool(cr),
},
},
{
Name: "ceph-rbd-ec",
Kind: "StorageClass",
Data: map[string]string{
"dataPool": "ec-data-pool",
"pool": "replicated-metadata-pool",
},
},
}
for _, extR := range externalResource {
t.Run(extR.Name, func(t *testing.T) {
actualSC := newCephBlockPoolStorageClassConfiguration(cr)
// To override the values for external cluster
for k, v := range extR.Data {
actualSC.storageClass.Parameters[k] = v
}
assert.NotEmpty(t, actualSC.storageClass.Parameters["clusterID"])
assert.Equal(t, extR.Data["dataPool"], actualSC.storageClass.Parameters["dataPool"])
assert.Equal(t, extR.Data["pool"], actualSC.storageClass.Parameters["pool"])
assert.NotEmpty(t, actualSC.storageClass.Parameters["csi.storage.k8s.io/provisioner-secret-name"])
assert.NotEmpty(t, actualSC.storageClass.Parameters["csi.storage.k8s.io/provisioner-secret-namespace"])
})
}
}