Merge #399

399: score/apps: support more topology keys r=zegl a=zegl <p>score/apps: support more topology keys</p><p>Adds support for additional “approved” topology keys in the hasPodAntiAffinity score</p> Fixes #390 ``` RELNOTE: Add support for more topology kets in the hasPodAntiAffinity test ``` --- This PR was created from Gustav Westling's (zegl) [workspace](https://getsturdy.com/kube-score-QEduUvS/ec482ab3-1b84-47fc-8b77-3974d49c7dbb) on [Sturdy](https://getsturdy.com/). Join your team, and code and collaborate on Sturdy, [join now!](https://getsturdy.com/get-started/github) Update this PR by making changes through Sturdy. Co-authored-by: Gustav Westling <gustav@westling.dev>
zegl · Oct 1, 2021 · 26db090 · 26db090
2 parents 5b64b0d + 188bca6
commit 26db090
Show file tree

Hide file tree

Showing 2 changed files with 75 additions and 5 deletions.
diff --git a/score/apps/apps.go b/score/apps/apps.go
@@ -117,21 +117,31 @@ func statefulsetHasAntiAffinity(statefulset appsv1.StatefulSet) (score scorecard
 	return
 }
 
-func hasPodAntiAffinity(selfLables internal.MapLables, affinity *corev1.Affinity) bool {
+func hasPodAntiAffinity(selfLabels internal.MapLables, affinity *corev1.Affinity) bool {
+	approvedTopologyKeys := map[string]struct{}{
+		"kubernetes.io/hostname":        {},
+		"topology.kubernetes.io/region": {},
+		"topology.kubernetes.io/zone":   {},
+
+		// Deprecated in Kubernetes v1.17
+		"failure-domain.beta.kubernetes.io/region": {},
+		"failure-domain.beta.kubernetes.io/zone":   {},
+	}
+
 	for _, pref := range affinity.PodAntiAffinity.PreferredDuringSchedulingIgnoredDuringExecution {
-		if pref.PodAffinityTerm.TopologyKey == "kubernetes.io/hostname" {
+		if _, ok := approvedTopologyKeys[pref.PodAffinityTerm.TopologyKey]; ok {
 			if selector, err := metav1.LabelSelectorAsSelector(pref.PodAffinityTerm.LabelSelector); err == nil {
-				if selector.Matches(internal.MapLables(selfLables)) {
+				if selector.Matches(selfLabels) {
 					return true
 				}
 			}
 		}
 	}
 
 	for _, req := range affinity.PodAntiAffinity.RequiredDuringSchedulingIgnoredDuringExecution {
-		if req.TopologyKey == "kubernetes.io/hostname" {
+		if _, ok := approvedTopologyKeys[req.TopologyKey]; ok {
 			if selector, err := metav1.LabelSelectorAsSelector(req.LabelSelector); err == nil {
-				if selector.Matches(internal.MapLables(selfLables)) {
+				if selector.Matches(selfLabels) {
 					return true
 				}
 			}

diff --git a/score/apps/apps_test.go b/score/apps/apps_test.go
@@ -52,6 +52,66 @@ func antiAffinityTestCases() []testcase {
 			},
 			expectedSkipped: false,
 		},
+		{
+			// OK! (required) ( topology.kubernetes.io/zone )
+			expectedGrade: scorecard.GradeAllOK,
+			replicas:      i(5),
+			affinity: &corev1.Affinity{
+				PodAntiAffinity: &corev1.PodAntiAffinity{
+					RequiredDuringSchedulingIgnoredDuringExecution: []corev1.PodAffinityTerm{
+						{
+							TopologyKey: "topology.kubernetes.io/zone",
+							LabelSelector: &metav1.LabelSelector{
+								MatchLabels: map[string]string{
+									"app": "foo",
+								},
+							},
+						},
+					},
+				},
+			},
+			expectedSkipped: false,
+		},
+		{
+			// OK! (required) ( topology.kubernetes.io/region )
+			expectedGrade: scorecard.GradeAllOK,
+			replicas:      i(5),
+			affinity: &corev1.Affinity{
+				PodAntiAffinity: &corev1.PodAntiAffinity{
+					RequiredDuringSchedulingIgnoredDuringExecution: []corev1.PodAffinityTerm{
+						{
+							TopologyKey: "topology.kubernetes.io/region",
+							LabelSelector: &metav1.LabelSelector{
+								MatchLabels: map[string]string{
+									"app": "foo",
+								},
+							},
+						},
+					},
+				},
+			},
+			expectedSkipped: false,
+		},
+		{
+			// Not OK! (required) ( some other topology key )
+			expectedGrade: scorecard.GradeWarning,
+			replicas:      i(5),
+			affinity: &corev1.Affinity{
+				PodAntiAffinity: &corev1.PodAntiAffinity{
+					RequiredDuringSchedulingIgnoredDuringExecution: []corev1.PodAffinityTerm{
+						{
+							TopologyKey: "topology.kubernetes.io/what-is-this-key",
+							LabelSelector: &metav1.LabelSelector{
+								MatchLabels: map[string]string{
+									"app": "foo",
+								},
+							},
+						},
+					},
+				},
+			},
+			expectedSkipped: false,
+		},
 		{
 			// OK (preferred)
 			expectedGrade: scorecard.GradeAllOK,