Analyze longhorn engine

Author: Andrew Reed

pkg/analyze/longhorn.go

@@ -58,6 +58,24 @@ func longhorn(analyzer *troubleshootv1beta2.LonghornAnalyze, getCollectedFileCon
 		replicas = append(replicas, replica)
 	}
 
+	// get engines.longhorn.io
+	enginesDir := collect.GetLonghornEnginesDirectory(ns)
+	enginesGlob := filepath.Join(enginesDir, "*")
+	enginesYaml, err := findFiles(enginesGlob)
+	if err != nil {
+		return nil, errors.Wrapf(err, "failed to find longhorn engines files under %s", enginesDir)
+	}
+	engines := []*longhornv1beta1.Engine{}
+	for key, engineYaml := range enginesYaml {
+		engineYaml = stripRedactedLines(engineYaml)
+		engine := &longhornv1beta1.Engine{}
+		err := yaml.Unmarshal(engineYaml, engine)
+		if err != nil {
+			return nil, errors.Wrapf(err, "failed to unmarshal engine yaml from %s", key)
+		}
+		engines = append(engines, engine)
+	}
+
 	results := []*AnalyzeResult{}
 
 	for _, node := range nodes {
@@ -68,6 +86,10 @@ func longhorn(analyzer *troubleshootv1beta2.LonghornAnalyze, getCollectedFileCon
 		results = append(results, analyzeLonghornReplica(replica))
 	}
 
+	for _, engine := range engines {
+		results = append(results, analyzeLonghornEngine(engine))
+	}
+
 	return results, nil
 }
 
@@ -123,17 +145,35 @@ func analyzeLonghornReplica(replica *longhornv1beta1.Replica) *AnalyzeResult {
 	return result
 }
 
+func analyzeLonghornEngine(engine *longhornv1beta1.Engine) *AnalyzeResult {
+	result := &AnalyzeResult{
+		Title: fmt.Sprintf("Longhorn Engine: %s", engine.Name),
+	}
+
+	desired := engine.Spec.InstanceSpec.DesireState
+	actual := engine.Status.InstanceStatus.CurrentState
+
+	if desired != actual {
+		result.IsWarn = true
+		result.Message = fmt.Sprintf("Longhorn engine %s current status %q, should be %q", engine.Name, actual, desired)
+		return result
+	}
+
+	result.IsPass = true
+	result.Message = fmt.Sprintf("Engine is %s", actual)
+
+	return result
+}
+
 func stripRedactedLines(yaml []byte) []byte {
 	buf := bytes.NewBuffer(yaml)
 	scanner := bufio.NewScanner(buf)
 
 	out := []byte{}
 
 	for scanner.Scan() {
-		if strings.Contains(scanner.Text(), redact.MASK_TEXT) {
-			continue
-		}
-		out = append(out, scanner.Bytes()...)
+		line := strings.ReplaceAll(scanner.Text(), redact.MASK_TEXT, "HIDDEN")
+		out = append(out, []byte(line)...)
 		out = append(out, '\n')
 	}
 

pkg/analyze/longhorn_test.go

@@ -142,3 +142,65 @@ func TestAnalyzeLonghornReplica(t *testing.T) {
 		})
 	}
 }
+
+func TestAnalyzeLonghornEngine(t *testing.T) {
+	tests := []struct {
+		name   string
+		engine *longhornv1beta1.Engine
+		expect *AnalyzeResult
+	}{
+		{
+			name: "running",
+			engine: &longhornv1beta1.Engine{
+				ObjectMeta: metav1.ObjectMeta{
+					Name: "pvc-uuid-1",
+				},
+				Spec: longhorntypes.EngineSpec{
+					InstanceSpec: longhorntypes.InstanceSpec{
+						DesireState: longhorntypes.InstanceStateRunning,
+					},
+				},
+				Status: longhorntypes.EngineStatus{
+					InstanceStatus: longhorntypes.InstanceStatus{
+						CurrentState: longhorntypes.InstanceStateRunning,
+					},
+				},
+			},
+			expect: &AnalyzeResult{
+				Title:   "Longhorn Engine: pvc-uuid-1",
+				IsPass:  true,
+				Message: "Engine is running",
+			},
+		},
+		{
+			name: "stopped",
+			engine: &longhornv1beta1.Engine{
+				ObjectMeta: metav1.ObjectMeta{
+					Name: "pvc-uuid-1",
+				},
+				Spec: longhorntypes.EngineSpec{
+					InstanceSpec: longhorntypes.InstanceSpec{
+						DesireState: longhorntypes.InstanceStateRunning,
+					},
+				},
+				Status: longhorntypes.EngineStatus{
+					InstanceStatus: longhorntypes.InstanceStatus{
+						CurrentState: longhorntypes.InstanceStateStopped,
+					},
+				},
+			},
+			expect: &AnalyzeResult{
+				Title:   "Longhorn Engine: pvc-uuid-1",
+				IsWarn:  true,
+				Message: `Longhorn engine pvc-uuid-1 current status "stopped", should be "running"`,
+			},
+		},
+	}
+	for _, test := range tests {
+		t.Run(test.name, func(t *testing.T) {
+			got := analyzeLonghornEngine(test.engine)
+
+			assert.Equal(t, test.expect, got)
+		})
+	}
+}