Merge pull request #477 from replicatedhq/divolgin/selectors

divolgin · web-flow · commit b4c97e377e56 · 2021-10-28T17:21:11.000-07:00
replicaset analyzer supports label selectors
diff --git a/config/crds/troubleshoot.sh_analyzers.yaml b/config/crds/troubleshoot.sh_analyzers.yaml
@@ -869,10 +869,15 @@ spec:
                                 type: object
                             type: object
                           type: array
+                        selector:
+                          items:
+                            type: string
+                          type: array
                       required:
                       - name
                       - namespace
                       - outcomes
+                      - selector
                       type: object
                     secret:
                       properties:
diff --git a/config/crds/troubleshoot.sh_preflights.yaml b/config/crds/troubleshoot.sh_preflights.yaml
@@ -869,10 +869,15 @@ spec:
                                 type: object
                             type: object
                           type: array
+                        selector:
+                          items:
+                            type: string
+                          type: array
                       required:
                       - name
                       - namespace
                       - outcomes
+                      - selector
                       type: object
                     secret:
                       properties:
diff --git a/config/crds/troubleshoot.sh_supportbundles.yaml b/config/crds/troubleshoot.sh_supportbundles.yaml
@@ -900,10 +900,15 @@ spec:
                                 type: object
                             type: object
                           type: array
+                        selector:
+                          items:
+                            type: string
+                          type: array
                       required:
                       - name
                       - namespace
                       - outcomes
+                      - selector
                       type: object
                     secret:
                       properties:
diff --git a/pkg/analyze/replicaset_status.go b/pkg/analyze/replicaset_status.go
@@ -10,6 +10,7 @@ import (
 	"github.com/pkg/errors"
 	troubleshootv1beta2 "github.com/replicatedhq/troubleshoot/pkg/apis/troubleshoot/v1beta2"
 	appsv1 "k8s.io/api/apps/v1"
+	"k8s.io/apimachinery/pkg/labels"
 )
 
 func analyzeReplicaSetStatus(analyzer *troubleshootv1beta2.ReplicaSetStatus, getFileContents func(string) (map[string][]byte, error)) ([]*AnalyzeResult, error) {
@@ -74,6 +75,11 @@ func analyzeAllReplicaSetStatuses(analyzer *troubleshootv1beta2.ReplicaSetStatus
 		return nil, errors.Wrap(err, "failed to read collected replicaset from file")
 	}
 
+	labelSelector, err := labels.Parse(strings.Join(analyzer.Selector, ","))
+	if err != nil {
+		return nil, errors.Wrap(err, "failed to parse selector")
+	}
+
 	results := []*AnalyzeResult{}
 	for _, collected := range files {
 		var replicasets []appsv1.ReplicaSet
@@ -82,20 +88,31 @@ func analyzeAllReplicaSetStatuses(analyzer *troubleshootv1beta2.ReplicaSetStatus
 		}
 
 		for _, replicaset := range replicasets {
-			if replicaset.Spec.Replicas == nil && replicaset.Status.AvailableReplicas == 1 { // default is 1
+			if !labelSelector.Matches(labels.Set(replicaset.Labels)) {
 				continue
 			}
 
-			if replicaset.Spec.Replicas != nil && *replicaset.Spec.Replicas == replicaset.Status.AvailableReplicas {
-				continue
-			}
-
-			result := &AnalyzeResult{
-				Title:   fmt.Sprintf("%s/%s ReplicaSet Status", replicaset.Namespace, replicaset.Name),
-				IconKey: "kubernetes_deployment_status",                                                  // TODO: need new icon
-				IconURI: "https://troubleshoot.sh/images/analyzer-icons/deployment-status.svg?w=17&h=17", // TODO: need new icon
-				IsFail:  true,
-				Message: fmt.Sprintf("The replicaset %s/%s is not ready", replicaset.Namespace, replicaset.Name),
+			var result *AnalyzeResult
+			if len(analyzer.Outcomes) > 0 {
+				result, err = replicasetStatus(analyzer.Outcomes, &replicaset)
+				if err != nil {
+					return nil, errors.Wrap(err, "failed to process status")
+				}
+			} else {
+				if replicaset.Spec.Replicas == nil && replicaset.Status.AvailableReplicas == 1 { // default is 1
+					continue
+				}
+				if replicaset.Spec.Replicas != nil && *replicaset.Spec.Replicas == replicaset.Status.AvailableReplicas {
+					continue
+				}
+
+				result = &AnalyzeResult{
+					Title:   fmt.Sprintf("%s/%s ReplicaSet Status", replicaset.Namespace, replicaset.Name),
+					IconKey: "kubernetes_deployment_status",                                                  // TODO: need new icon
+					IconURI: "https://troubleshoot.sh/images/analyzer-icons/deployment-status.svg?w=17&h=17", // TODO: need new icon
+					IsFail:  true,
+					Message: fmt.Sprintf("The replicaset %s/%s is not ready", replicaset.Namespace, replicaset.Name),
+				}
 			}
 
 			results = append(results, result)
diff --git a/pkg/analyze/replicaset_status_test.go b/pkg/analyze/replicaset_status_test.go
@@ -66,7 +66,7 @@ func Test_analyzeReplicaSetStatus(t *testing.T) {
 					},
 				},
 				Namespace: "rook-ceph",
-				Name:      "csi-cephfsplugin-provisioner-56d4db5b99",
+				Selector:  []string{"app=csi-cephfsplugin-provisioner"},
 			},
 			expectResult: []*AnalyzeResult{
 				{
@@ -84,37 +84,17 @@ func Test_analyzeReplicaSetStatus(t *testing.T) {
 			},
 		},
 		{
-			name: "pass because 1 is available",
+			name: "find the one failing replicaset",
 			analyzer: troubleshootv1beta2.ReplicaSetStatus{
-				Outcomes: []*troubleshootv1beta2.Outcome{
-					{
-						Pass: &troubleshootv1beta2.SingleOutcome{
-							When:    "available = 1",
-							Message: "pass",
-						},
-					},
-					{
-						Warn: &troubleshootv1beta2.SingleOutcome{
-							When:    "ready = 1",
-							Message: "warn",
-						},
-					},
-					{
-						Fail: &troubleshootv1beta2.SingleOutcome{
-							Message: "default fail",
-						},
-					},
-				},
 				Namespace: "rook-ceph",
-				Name:      "csi-rbdplugin-provisioner-d84959fcb",
 			},
 			expectResult: []*AnalyzeResult{
 				{
-					IsPass:  true,
+					IsPass:  false,
 					IsWarn:  false,
-					IsFail:  false,
-					Title:   "csi-rbdplugin-provisioner-d84959fcb Status",
-					Message: "pass",
+					IsFail:  true,
+					Title:   "rook-ceph/rook-ceph-mds-rook-shared-fs-b-7895f484f5 ReplicaSet Status",
+					Message: "The replicaset rook-ceph/rook-ceph-mds-rook-shared-fs-b-7895f484f5 is not ready",
 					IconKey: "kubernetes_deployment_status",
 					IconURI: "https://troubleshoot.sh/images/analyzer-icons/deployment-status.svg?w=17&h=17",
 				},
diff --git a/pkg/apis/troubleshoot/v1beta2/analyzer_shared.go b/pkg/apis/troubleshoot/v1beta2/analyzer_shared.go
@@ -75,6 +75,7 @@ type ReplicaSetStatus struct {
 	Outcomes    []*Outcome `json:"outcomes" yaml:"outcomes"`
 	Namespace   string     `json:"namespace" yaml:"namespace"`
 	Name        string     `json:"name" yaml:"name"`
+	Selector    []string   `json:"selector" yaml:"selector"`
 }
 
 type ClusterPodStatuses struct {
diff --git a/pkg/apis/troubleshoot/v1beta2/zz_generated.deepcopy.go b/pkg/apis/troubleshoot/v1beta2/zz_generated.deepcopy.go
diff --git a/schemas/analyzer-troubleshoot-v1beta2.json b/schemas/analyzer-troubleshoot-v1beta2.json
@@ -1244,7 +1244,8 @@
                 "required": [
                   "name",
                   "namespace",
-                  "outcomes"
+                  "outcomes",
+                  "selector"
                 ],
                 "properties": {
                   "checkName": {
@@ -1308,6 +1309,12 @@
                         }
                       }
                     }
+                  },
+                  "selector": {
+                    "type": "array",
+                    "items": {
+                      "type": "string"
+                    }
                   }
                 }
               },
diff --git a/schemas/preflight-troubleshoot-v1beta2.json b/schemas/preflight-troubleshoot-v1beta2.json
@@ -1244,7 +1244,8 @@
                 "required": [
                   "name",
                   "namespace",
-                  "outcomes"
+                  "outcomes",
+                  "selector"
                 ],
                 "properties": {
                   "checkName": {
@@ -1308,6 +1309,12 @@
                         }
                       }
                     }
+                  },
+                  "selector": {
+                    "type": "array",
+                    "items": {
+                      "type": "string"
+                    }
                   }
                 }
               },
diff --git a/schemas/supportbundle-troubleshoot-v1beta2.json b/schemas/supportbundle-troubleshoot-v1beta2.json
@@ -1290,7 +1290,8 @@
                 "required": [
                   "name",
                   "namespace",
-                  "outcomes"
+                  "outcomes",
+                  "selector"
                 ],
                 "properties": {
                   "checkName": {
@@ -1354,6 +1355,12 @@
                         }
                       }
                     }
+                  },
+                  "selector": {
+                    "type": "array",
+                    "items": {
+                      "type": "string"
+                    }
                   }
                 }
               },

Original file line number	Diff line number	Diff line change
`@@ -75,6 +75,7 @@ type ReplicaSetStatus struct {`
`75`	`75`	Outcomes []*Outcome `json:"outcomes" yaml:"outcomes"`
`76`	`76`	Namespace string `json:"namespace" yaml:"namespace"`
`77`	`77`	Name string `json:"name" yaml:"name"`
	`78`	+ Selector []string `json:"selector" yaml:"selector"`
`78`	`79`	`}`
`79`	`80`
`80`	`81`	`type ClusterPodStatuses struct {`
Original file line number	Diff line number	Diff line change
`@@ -1244,7 +1244,8 @@`
`1244`	`1244`	`"required": [`
`1245`	`1245`	`"name",`
`1246`	`1246`	`"namespace",`
`1247`		`- "outcomes"`
	`1247`	`+ "outcomes",`
	`1248`	`+ "selector"`
`1248`	`1249`	`],`
`1249`	`1250`	`"properties": {`
`1250`	`1251`	`"checkName": {`
`@@ -1308,6 +1309,12 @@`
`1308`	`1309`	`}`
`1309`	`1310`	`}`
`1310`	`1311`	`}`
	`1312`	`+ },`
	`1313`	`+ "selector": {`
	`1314`	`+ "type": "array",`
	`1315`	`+ "items": {`
	`1316`	`+ "type": "string"`
	`1317`	`+ }`
`1311`	`1318`	`}`
`1312`	`1319`	`}`
`1313`	`1320`	`},`
Original file line number	Diff line number	Diff line change
`@@ -1290,7 +1290,8 @@`
`1290`	`1290`	`"required": [`
`1291`	`1291`	`"name",`
`1292`	`1292`	`"namespace",`
`1293`		`- "outcomes"`
	`1293`	`+ "outcomes",`
	`1294`	`+ "selector"`
`1294`	`1295`	`],`
`1295`	`1296`	`"properties": {`
`1296`	`1297`	`"checkName": {`
`@@ -1354,6 +1355,12 @@`
`1354`	`1355`	`}`
`1355`	`1356`	`}`
`1356`	`1357`	`}`
	`1358`	`+ },`
	`1359`	`+ "selector": {`
	`1360`	`+ "type": "array",`
	`1361`	`+ "items": {`
	`1362`	`+ "type": "string"`
	`1363`	`+ }`
`1357`	`1364`	`}`
`1358`	`1365`	`}`
`1359`	`1366`	`},`