Store effective check message in report

Previously, the message in the report was always that of the failure state of the check, regardless of the actual check
result.

Author: per1234

Diff for: result/result.go

@@ -92,8 +92,6 @@ func (results *Type) Initialize() {
 
 // Record records the result of a check and returns a text summary for it.
 func (results *Type) Record(checkedProject project.Type, checkConfiguration checkconfigurations.Type, checkResult checkresult.Type, checkOutput string) string {
-	checkMessage := message(checkConfiguration.MessageTemplate, checkOutput)
-
 	checkLevel, err := checklevel.CheckLevel(checkConfiguration, checkResult)
 	if err != nil {
 		feedback.Errorf("Error while determining check level: %v", err)
@@ -102,11 +100,17 @@ func (results *Type) Record(checkedProject project.Type, checkConfiguration chec
 
 	summaryText := fmt.Sprintf("%s\n", checkResult)
 
-	if checkResult == checkresult.NotRun {
-		if checkOutput != "" {
-			summaryText += fmt.Sprintf("%s: %s\n", checklevel.Notice, checkOutput)
-		}
-	} else if checkResult != checkresult.Pass {
+	checkMessage := ""
+	if checkLevel == checklevel.Error {
+		checkMessage = message(checkConfiguration.MessageTemplate, checkOutput)
+	} else {
+		// Checks may provide an explanation for their non-fail result.
+		// The message template should not be used in this case, since it is written for a failure result.
+		checkMessage = checkOutput
+	}
+
+	// Add explanation of check result if present.
+	if checkMessage != "" {
 		summaryText += fmt.Sprintf("%s: %s\n", checkLevel, checkMessage)
 	}
 

Diff for: result/result_test.go

@@ -61,14 +61,12 @@ func TestRecord(t *testing.T) {
 	var results Type
 	checkConfiguration := checkconfigurations.Configurations()[0]
 	checkOutput := "foo"
-	summaryText := results.Record(checkedProject, checkConfiguration, checkresult.Pass, checkOutput)
-	assert.Equal(t, fmt.Sprintf("%s\n", checkresult.Pass), summaryText)
-	summaryText = results.Record(checkedProject, checkConfiguration, checkresult.NotRun, checkOutput)
-	assert.Equal(t, fmt.Sprintf("%s\n%s: %s\n", checkresult.NotRun, checklevel.Notice, checkOutput), summaryText)
-	summaryText = results.Record(checkedProject, checkConfiguration, checkresult.NotRun, "")
-	assert.Equal(t, "", "", summaryText)
-	summaryText = results.Record(checkedProject, checkConfiguration, checkresult.Fail, checkOutput)
+	summaryText := results.Record(checkedProject, checkConfiguration, checkresult.Fail, checkOutput)
 	assert.Equal(t, fmt.Sprintf("%s\n%s: %s\n", checkresult.Fail, checklevel.Error, message(checkConfiguration.MessageTemplate, checkOutput)), summaryText)
+	summaryText = results.Record(checkedProject, checkConfiguration, checkresult.NotRun, checkOutput)
+	assert.Equal(t, fmt.Sprintf("%s\n%s: %s\n", checkresult.NotRun, checklevel.Notice, checkOutput), summaryText, "Non-fail result should not use message")
+	summaryText = results.Record(checkedProject, checkConfiguration, checkresult.Pass, "")
+	assert.Equal(t, "", "", summaryText, "Non-failure result with no check function output should result in an empty summary")
 
 	checkResult := checkresult.Pass
 	results = Type{}
@@ -92,7 +90,7 @@ func TestRecord(t *testing.T) {
 	assert.Equal(t, checkResult.String(), checkReport.Result)
 	checkLevel, _ := checklevel.CheckLevel(checkConfiguration, checkResult)
 	assert.Equal(t, checkLevel.String(), checkReport.Level)
-	assert.Equal(t, message(checkConfiguration.MessageTemplate, checkOutput), checkReport.Message)
+	assert.Equal(t, checkOutput, checkReport.Message)
 
 	assert.Len(t, results.Projects, 1)
 	previousProjectPath := checkedProject.Path