feat(filter): 添加了ExcludedLabelSelector和ExcludedOrLabelSelectors字段，用于在备份过程中排除特定标签的对象。

am6737 · am6737 · commit b4240a1eda91 · 2023-11-22T18:19:04.000+08:00
diff --git a/api/v1/schedule_types.go b/api/v1/schedule_types.go
@@ -52,6 +52,20 @@ type BackupSpec struct {
 	// +nullable
 	OrLabelSelectors []*metav1.LabelSelector `json:"orLabelSelectors,omitempty"`
 
+	// ExcludedLabelSelector is a metav1.labelSelector to filter out resources.
+	// If provided, any resources matching this label selector will be excluded from the backup.
+	// +optional
+	// +nullable
+	ExcludedLabelSelector *metav1.LabelSelector `json:"excludedLabelSelector,omitempty"`
+
+	// ExcludedOrLabelSelectors is a list of metav1.labelSelector to filter out resources.
+	// If multiple provided, they will be joined by the OR operator.
+	// ExcludedLabelSelector as well as ExcludedOrLabelSelectors cannot co-exist in backup request,
+	// only one of them can be used.
+	// +optional
+	// +nullable
+	ExcludedOrLabelSelectors []*metav1.LabelSelector `json:"excludedOrLabelSelectors,omitempty"`
+
 	// TTL is a time.Duration-parseable string describing how long
 	// Snapshot lifecycle
 	// +optional
diff --git a/internal/controller/schedule_controller.go b/internal/controller/schedule_controller.go
@@ -88,7 +88,6 @@ func (r *ScheduleReconciler) Reconcile(ctx context.Context, req ctrl.Request) (c
 		return ctrl.Result{}, errors.Wrapf(err, "error getting schedule %s", req.String())
 	}
 
-	// 更新状态
 	if err := r.updateScheduleStatus(schedule); err != nil {
 		return ctrl.Result{}, err
 	}
@@ -99,8 +98,8 @@ func (r *ScheduleReconciler) Reconcile(ctx context.Context, req ctrl.Request) (c
 	}
 
 	var wg sync.WaitGroup
-	var mu sync.Mutex // 用于保护错误变量
-	var e []error     // 存储错误信息
+	var mu sync.Mutex
+	var e []error
 
 	wg.Add(2)
 	go func() {
@@ -205,7 +204,7 @@ func (r *ScheduleReconciler) getNextRunTime(schedule string, now time.Time) time
 		r.Log.Error(err, "error parsing schedule")
 		return time.Time{}
 	}
-	// 计算下次运行时间
+	// 计算下一次运行时间
 	nextRunTime := now.Add(interval)
 	return nextRunTime
 }
@@ -261,25 +260,28 @@ func (r *ScheduleReconciler) getResourcesToBackup(schedule *hitoseacomv1.Schedul
 	}
 
 	filteredResources := (&filter.VirtualMachineFilter{
-		IncludedNamespaces: schedule.Spec.Template.IncludedNamespaces,
-		ExcludedNamespaces: schedule.Spec.Template.ExcludedNamespaces,
-		LabelSelector:      schedule.Spec.Template.LabelSelector,
-		OrLabelSelectors:   schedule.Spec.Template.OrLabelSelectors,
+		IncludedNamespaces:       schedule.Spec.Template.IncludedNamespaces,
+		ExcludedNamespaces:       schedule.Spec.Template.ExcludedNamespaces,
+		LabelSelector:            schedule.Spec.Template.LabelSelector,
+		OrLabelSelectors:         schedule.Spec.Template.OrLabelSelectors,
+		ExcludedLabelSelector:    schedule.Spec.Template.ExcludedLabelSelector,
+		ExcludedOrLabelSelectors: schedule.Spec.Template.ExcludedOrLabelSelectors,
 	}).Filter(resources)
 
 	return filteredResources, nil
 }
 
 func (r *ScheduleReconciler) deleteExpiredSnapshots(ctx context.Context, schedule *hitoseacomv1.Schedule) error {
 	nextRunTime := schedule.Status.NextDelete.Time
+	// 检查下次删除的时间是否已到
 	if r.ifDue(nextRunTime, r.Clock.Now()) {
 		vmsList := &hitoseacomv1.VirtualMachineSnapshotList{}
 		if err := r.Client.List(context.TODO(), vmsList); err != nil {
 			r.Log.Error(err, "get VirtualMachineSnapshotList")
 			return err
 		}
 
-		// 先过滤掉特定标签的快照
+		// 只获取Schedule创建的虚拟机快照资源
 		var filteredVMSSList []hitoseacomv1.VirtualMachineSnapshot
 		for _, vms := range vmsList.Items {
 			if _, ok := vms.ObjectMeta.Labels[ScheduleSnapshotLabelKey]; ok && vms.Status.Phase != hitoseacomv1.InProgress {
@@ -292,7 +294,7 @@ func (r *ScheduleReconciler) deleteExpiredSnapshots(ctx context.Context, schedul
 			creationTime := vmss.ObjectMeta.CreationTimestamp.Time
 			expirationTime := creationTime.Add(schedule.Spec.Template.TTL.Duration)
 
-			// ttl到期
+			// 判断是否超过了TTL过期时间
 			if r.Clock.Now().After(expirationTime) {
 				if err := r.Snap.DeleteSnapshot(ctx, vmss.Name, vmss.Namespace); err != nil {
 					r.Log.Error(err, "DeleteSnapshot")
diff --git a/pkg/util/filter/filter.go b/pkg/util/filter/filter.go
@@ -12,10 +12,12 @@ type ResourceFilter interface {
 }
 
 type VirtualMachineFilter struct {
-	IncludedNamespaces []string                `json:"includedNamespaces,omitempty"`
-	ExcludedNamespaces []string                `json:"excludedNamespaces,omitempty"`
-	LabelSelector      *metav1.LabelSelector   `json:"labelSelector,omitempty"`
-	OrLabelSelectors   []*metav1.LabelSelector `json:"orLabelSelectors,omitempty"`
+	IncludedNamespaces       []string                `json:"includedNamespaces,omitempty"`
+	ExcludedNamespaces       []string                `json:"excludedNamespaces,omitempty"`
+	LabelSelector            *metav1.LabelSelector   `json:"labelSelector,omitempty"`
+	OrLabelSelectors         []*metav1.LabelSelector `json:"orLabelSelectors,omitempty"`
+	ExcludedLabelSelector    *metav1.LabelSelector   `json:"excludedLabelSelector,omitempty"`
+	ExcludedOrLabelSelectors []*metav1.LabelSelector `json:"excludedOrLabelSelectors,omitempty"`
 }
 
 func (f *VirtualMachineFilter) Filter(resources []*unstructured.Unstructured) []*unstructured.Unstructured {
@@ -43,6 +45,16 @@ func (f *VirtualMachineFilter) Filter(resources []*unstructured.Unstructured) []
 			continue
 		}
 
+		// Check if the resource matches the excluded label selector
+		if f.ExcludedLabelSelector != nil && f.matchesExcludedLabelSelector(resource) {
+			continue
+		}
+
+		// Check if the resource matches any of the OR excluded label selectors
+		if f.matchesOrExcludedLabelSelectors(resource) {
+			continue
+		}
+
 		// Add the resource to the filtered list
 		filteredResources = append(filteredResources, resource)
 	}
@@ -105,3 +117,35 @@ func (f *VirtualMachineFilter) matchesOrLabelSelectors(resource *unstructured.Un
 
 	return false
 }
+
+func (f *VirtualMachineFilter) matchesExcludedLabelSelector(resource *unstructured.Unstructured) bool {
+	if f.ExcludedLabelSelector == nil {
+		return false
+	}
+
+	selector, err := metav1.LabelSelectorAsSelector(f.ExcludedLabelSelector)
+	if err != nil {
+		return false
+	}
+
+	return selector.Matches(labels.Set(resource.GetLabels()))
+}
+
+func (f *VirtualMachineFilter) matchesOrExcludedLabelSelectors(resource *unstructured.Unstructured) bool {
+	if f.ExcludedOrLabelSelectors == nil {
+		return false
+	}
+
+	for _, selector := range f.ExcludedOrLabelSelectors {
+		selector, err := metav1.LabelSelectorAsSelector(selector)
+		if err != nil {
+			continue
+		}
+
+		if selector.Matches(labels.Set(resource.GetLabels())) {
+			return true
+		}
+	}
+
+	return false
+}
diff --git a/pkg/util/filter/filter_test.go b/pkg/util/filter/filter_test.go
@@ -36,31 +36,51 @@ func createVirtualMachineList() *kubevirtv1.VirtualMachineList {
 			},
 		},
 	}
+	vm4 := kubevirtv1.VirtualMachine{
+		ObjectMeta: metav1.ObjectMeta{
+			Name:      "vm4",
+			Namespace: "namespace3",
+			Labels: map[string]string{
+				"app": "app2",
+			},
+		},
+	}
+	vm5 := kubevirtv1.VirtualMachine{
+		ObjectMeta: metav1.ObjectMeta{
+			Name:      "vm5",
+			Namespace: "namespace3",
+			Labels: map[string]string{
+				"app": "app3",
+			},
+		},
+	}
 	vmList := &kubevirtv1.VirtualMachineList{}
-	vmList.Items = append(vmList.Items, vm1, vm2, vm3)
+	vmList.Items = append(vmList.Items, vm1, vm2, vm3, vm4, vm5)
 	return vmList
 }
 
 func TestVirtualMachineFilter_Filter(t *testing.T) {
 	vmList := createVirtualMachineList()
 
 	testCases := []struct {
-		name               string
-		includedNamespaces []string
-		excludedNamespaces []string
-		labelSelector      *metav1.LabelSelector
-		orLabelSelectors   []*metav1.LabelSelector
-		expectedLength     int
+		name                     string
+		includedNamespaces       []string
+		excludedNamespaces       []string
+		labelSelector            *metav1.LabelSelector
+		orLabelSelectors         []*metav1.LabelSelector
+		excludedLabelSelector    *metav1.LabelSelector
+		excludedOrLabelSelectors []*metav1.LabelSelector
+		expectedLength           int
 	}{
 		{
 			name:               "IncludedNamespaces",
-			includedNamespaces: []string{"namespace1"},
-			expectedLength:     1,
+			includedNamespaces: []string{"namespace1", "namespace3"},
+			expectedLength:     3,
 		},
 		{
 			name:               "ExcludedNamespaces",
 			excludedNamespaces: []string{"namespace2"},
-			expectedLength:     1,
+			expectedLength:     3,
 		},
 		{
 			name: "LabelSelector",
@@ -79,16 +99,47 @@ func TestVirtualMachineFilter_Filter(t *testing.T) {
 					MatchLabels: map[string]string{"app": "app3"},
 				},
 			},
-			expectedLength: 2,
+			expectedLength: 4,
+		},
+		{
+			name: "ExcludedLabelSelector",
+			excludedLabelSelector: &metav1.LabelSelector{
+				MatchLabels: map[string]string{"app": "app2"},
+			},
+			expectedLength: 3,
+		},
+		{
+			name: "ExcludedOrLabelSelectors",
+			excludedOrLabelSelectors: []*metav1.LabelSelector{
+				{
+					MatchLabels: map[string]string{"app": "app2"},
+				},
+				{
+					MatchLabels: map[string]string{"app": "app3"},
+				},
+			},
+			expectedLength: 1, // Excludes resources with "app=app2" or "app=app3"
+		},
+		{
+			name:               "IncludedAndExcludedLabelSelector",
+			includedNamespaces: []string{"namespace2"},
+			excludedLabelSelector: &metav1.LabelSelector{
+				MatchLabels: map[string]string{"app": "app2"},
+			},
+			expectedLength: 1, // Namespace included but label excluded
 		},
+		// Add more test cases here to cover other combinations
 	}
 
+	// Run tests for each test case
 	for _, tc := range testCases {
 		filter := &VirtualMachineFilter{
-			IncludedNamespaces: tc.includedNamespaces,
-			ExcludedNamespaces: tc.excludedNamespaces,
-			LabelSelector:      tc.labelSelector,
-			OrLabelSelectors:   tc.orLabelSelectors,
+			IncludedNamespaces:       tc.includedNamespaces,
+			ExcludedNamespaces:       tc.excludedNamespaces,
+			LabelSelector:            tc.labelSelector,
+			OrLabelSelectors:         tc.orLabelSelectors,
+			ExcludedLabelSelector:    tc.excludedLabelSelector,
+			ExcludedOrLabelSelectors: tc.excludedOrLabelSelectors,
 		}
 
 		var resources []*unstructured.Unstructured
