-
Notifications
You must be signed in to change notification settings - Fork 1.4k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #5112 from ywk253100/220711_bsl
[cherry-pick]Fix bsl validation bug
- Loading branch information
Showing
4 changed files
with
236 additions
and
21 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| Fix bsl validation bug: the BSL is validated continually and doesn't respect the validation period configured |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,47 @@ | ||
| /* | ||
| Copyright the Velero contributors. | ||
| Licensed under the Apache License, Version 2.0 (the "License"); | ||
| you may not use this file except in compliance with the License. | ||
| You may obtain a copy of the License at | ||
| http://www.apache.org/licenses/LICENSE-2.0 | ||
| Unless required by applicable law or agreed to in writing, software | ||
| distributed under the License is distributed on an "AS IS" BASIS, | ||
| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| See the License for the specific language governing permissions and | ||
| limitations under the License. | ||
| */ | ||
|
|
||
| package kube | ||
|
|
||
| import ( | ||
| "reflect" | ||
|
|
||
| "sigs.k8s.io/controller-runtime/pkg/event" | ||
| "sigs.k8s.io/controller-runtime/pkg/predicate" | ||
| ) | ||
|
|
||
| // SpecChangePredicate implements a default update predicate function on Spec change | ||
| // As Velero doesn't enable subresource in CRDs, we cannot use the object's metadata.generation field to check the spec change | ||
| // More details about the generation field refer to https://github.com/kubernetes-sigs/controller-runtime/blob/v0.12.2/pkg/predicate/predicate.go#L156 | ||
| type SpecChangePredicate struct { | ||
| predicate.Funcs | ||
| } | ||
|
|
||
| func (SpecChangePredicate) Update(e event.UpdateEvent) bool { | ||
| if e.ObjectOld == nil { | ||
| return false | ||
| } | ||
| if e.ObjectNew == nil { | ||
| return false | ||
| } | ||
| oldSpec := reflect.ValueOf(e.ObjectOld).Elem().FieldByName("Spec") | ||
| // contains no field named "Spec", return false directly | ||
| if oldSpec.IsZero() { | ||
| return false | ||
| } | ||
| newSpec := reflect.ValueOf(e.ObjectNew).Elem().FieldByName("Spec") | ||
| return !reflect.DeepEqual(oldSpec.Interface(), newSpec.Interface()) | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,180 @@ | ||
| /* | ||
| Copyright the Velero contributors. | ||
| Licensed under the Apache License, Version 2.0 (the "License"); | ||
| you may not use this file except in compliance with the License. | ||
| You may obtain a copy of the License at | ||
| http://www.apache.org/licenses/LICENSE-2.0 | ||
| Unless required by applicable law or agreed to in writing, software | ||
| distributed under the License is distributed on an "AS IS" BASIS, | ||
| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| See the License for the specific language governing permissions and | ||
| limitations under the License. | ||
| */ | ||
|
|
||
| package kube | ||
|
|
||
| import ( | ||
| "testing" | ||
| "time" | ||
|
|
||
| "github.com/stretchr/testify/assert" | ||
| corev1api "k8s.io/api/core/v1" | ||
| metav1 "k8s.io/apimachinery/pkg/apis/meta/v1" | ||
| "sigs.k8s.io/controller-runtime/pkg/client" | ||
| "sigs.k8s.io/controller-runtime/pkg/event" | ||
|
|
||
| velerov1 "github.com/vmware-tanzu/velero/pkg/apis/velero/v1" | ||
| ) | ||
|
|
||
| func TestSpecChangePredicate(t *testing.T) { | ||
| cases := []struct { | ||
| name string | ||
| oldObj client.Object | ||
| newObj client.Object | ||
| changed bool | ||
| }{ | ||
| { | ||
| name: "Contains no spec field", | ||
| oldObj: &velerov1.BackupStorageLocation{ | ||
| ObjectMeta: metav1.ObjectMeta{ | ||
| Name: "bsl01", | ||
| }, | ||
| }, | ||
| newObj: &velerov1.BackupStorageLocation{ | ||
| ObjectMeta: metav1.ObjectMeta{ | ||
| Name: "bsl01", | ||
| }, | ||
| }, | ||
| changed: false, | ||
| }, | ||
| { | ||
| name: "ObjectMetas are different, Specs are same", | ||
| oldObj: &velerov1.BackupStorageLocation{ | ||
| ObjectMeta: metav1.ObjectMeta{ | ||
| Name: "bsl01", | ||
| Annotations: map[string]string{"key1": "value1"}, | ||
| }, | ||
| Spec: velerov1.BackupStorageLocationSpec{ | ||
| Provider: "azure", | ||
| }, | ||
| }, | ||
| newObj: &velerov1.BackupStorageLocation{ | ||
| ObjectMeta: metav1.ObjectMeta{ | ||
| Name: "bsl01", | ||
| Annotations: map[string]string{"key2": "value2"}, | ||
| }, | ||
| Spec: velerov1.BackupStorageLocationSpec{ | ||
| Provider: "azure", | ||
| }, | ||
| }, | ||
| changed: false, | ||
| }, | ||
| { | ||
| name: "Statuses are different, Specs are same", | ||
| oldObj: &velerov1.BackupStorageLocation{ | ||
| Spec: velerov1.BackupStorageLocationSpec{ | ||
| Provider: "azure", | ||
| }, | ||
| Status: velerov1.BackupStorageLocationStatus{ | ||
| Phase: velerov1.BackupStorageLocationPhaseAvailable, | ||
| }, | ||
| }, | ||
| newObj: &velerov1.BackupStorageLocation{ | ||
| Spec: velerov1.BackupStorageLocationSpec{ | ||
| Provider: "azure", | ||
| }, | ||
| Status: velerov1.BackupStorageLocationStatus{ | ||
| Phase: velerov1.BackupStorageLocationPhaseUnavailable, | ||
| }, | ||
| }, | ||
| changed: false, | ||
| }, | ||
| { | ||
| name: "Specs are different", | ||
| oldObj: &velerov1.BackupStorageLocation{ | ||
| Spec: velerov1.BackupStorageLocationSpec{ | ||
| Provider: "azure", | ||
| }, | ||
| }, | ||
| newObj: &velerov1.BackupStorageLocation{ | ||
| Spec: velerov1.BackupStorageLocationSpec{ | ||
| Provider: "aws", | ||
| }, | ||
| }, | ||
| changed: true, | ||
| }, | ||
| { | ||
| name: "Specs are same", | ||
| oldObj: &velerov1.BackupStorageLocation{ | ||
| Spec: velerov1.BackupStorageLocationSpec{ | ||
| Provider: "azure", | ||
| Config: map[string]string{"key": "value"}, | ||
| Credential: &corev1api.SecretKeySelector{ | ||
| LocalObjectReference: corev1api.LocalObjectReference{ | ||
| Name: "secret", | ||
| }, | ||
| Key: "credential", | ||
| }, | ||
| StorageType: velerov1.StorageType{ | ||
| ObjectStorage: &velerov1.ObjectStorageLocation{ | ||
| Bucket: "bucket1", | ||
| Prefix: "prefix", | ||
| CACert: []byte{'a'}, | ||
| }, | ||
| }, | ||
| Default: true, | ||
| AccessMode: velerov1.BackupStorageLocationAccessModeReadWrite, | ||
| BackupSyncPeriod: &metav1.Duration{ | ||
| Duration: 1 * time.Minute, | ||
| }, | ||
| ValidationFrequency: &metav1.Duration{ | ||
| Duration: 1 * time.Minute, | ||
| }, | ||
| }, | ||
| }, | ||
| newObj: &velerov1.BackupStorageLocation{ | ||
| Spec: velerov1.BackupStorageLocationSpec{ | ||
| Provider: "azure", | ||
| Config: map[string]string{"key": "value"}, | ||
| Credential: &corev1api.SecretKeySelector{ | ||
| LocalObjectReference: corev1api.LocalObjectReference{ | ||
| Name: "secret", | ||
| }, | ||
| Key: "credential", | ||
| }, | ||
| StorageType: velerov1.StorageType{ | ||
| ObjectStorage: &velerov1.ObjectStorageLocation{ | ||
| Bucket: "bucket1", | ||
| Prefix: "prefix", | ||
| CACert: []byte{'a'}, | ||
| }, | ||
| }, | ||
| Default: true, | ||
| AccessMode: velerov1.BackupStorageLocationAccessModeReadWrite, | ||
| BackupSyncPeriod: &metav1.Duration{ | ||
| Duration: 1 * time.Minute, | ||
| }, | ||
| ValidationFrequency: &metav1.Duration{ | ||
| Duration: 1 * time.Minute, | ||
| }, | ||
| }, | ||
| }, | ||
| changed: false, | ||
| }, | ||
| } | ||
|
|
||
| predicate := SpecChangePredicate{} | ||
|
|
||
| for _, c := range cases { | ||
| t.Run(c.name, func(t *testing.T) { | ||
| changed := predicate.Update(event.UpdateEvent{ | ||
| ObjectOld: c.oldObj, | ||
| ObjectNew: c.newObj, | ||
| }) | ||
| assert.Equal(t, c.changed, changed) | ||
| }) | ||
| } | ||
| } |