commands/.../scorecard: add suggestions (#961)

**Description of the change:** Add support for printing suggestions to improve scorecard score


**Motivation for the change:** This provides a better experience for the user as it directly tells them how to improve their score

Author: AlexNPavel

commands/operator-sdk/cmd/scorecard/basic_tests.go

@@ -66,6 +66,12 @@ func checkSpecAndStat(runtimeClient client.Client, obj *unstructured.Unstructure
 	if err != nil && err != wait.ErrWaitTimeout {
 		return err
 	}
+	if testSpec.earnedPoints != 1 {
+		scSuggestions = append(scSuggestions, "Add a 'spec' field to your Custom Resource")
+	}
+	if testStat.earnedPoints != 1 {
+		scSuggestions = append(scSuggestions, "Add a 'status' field to your Custom Resource")
+	}
 	return nil
 }
 
@@ -93,6 +99,7 @@ func checkStatusUpdate(runtimeClient client.Client, obj *unstructured.Unstructur
 	err = modifySpecAndCheck(specMap, obj)
 	if err != nil {
 		test.earnedPoints = 0
+		scSuggestions = append(scSuggestions, "Make sure that the 'status' block is always updated to reflect changes after the 'spec' block is changed")
 		scTests = append(scTests, test)
 		return nil
 	}
@@ -211,5 +218,8 @@ func writingIntoCRsHasEffect(obj *unstructured.Unstructured) (string, error) {
 		}
 	}
 	scTests = append(scTests, test)
+	if test.earnedPoints != 1 {
+		scSuggestions = append(scSuggestions, "The operator should write into objects to update state. No PUT or POST requests from you operator were recorded by the scorecard.")
+	}
 	return buf.String(), nil
 }

commands/operator-sdk/cmd/scorecard/olm_tests.go

@@ -33,6 +33,9 @@ func crdsHaveResources(csv *olmAPI.ClusterServiceVersion) {
 		}
 	}
 	scTests = append(scTests, test)
+	if test.earnedPoints == 0 {
+		scSuggestions = append(scSuggestions, "Add resources to owned CRDs")
+	}
 }
 
 // annotationsContainExamples makes sure that the CSVs list at least 1 example for the CR
@@ -42,6 +45,9 @@ func annotationsContainExamples(csv *olmAPI.ClusterServiceVersion) {
 		test.earnedPoints = 1
 	}
 	scTests = append(scTests, test)
+	if test.earnedPoints == 0 {
+		scSuggestions = append(scSuggestions, "Add an alm-examples annotation to your CSV to pass the " + test.name + " test")
+	}
 }
 
 // statusDescriptors makes sure that all status fields found in the created CR has a matching descriptor in the CSV
@@ -73,11 +79,15 @@ func statusDescriptors(csv *olmAPI.ClusterServiceVersion, runtimeClient client.C
 		for _, statDesc := range crd.StatusDescriptors {
 			if statDesc.Path == key {
 				test.earnedPoints++
+				delete(statusBlock, key)
 				break
 			}
 		}
 	}
 	scTests = append(scTests, test)
+	for key := range statusBlock {
+		scSuggestions = append(scSuggestions, "Add a status descriptor for "+key)
+	}
 	return nil
 }
 
@@ -110,10 +120,14 @@ func specDescriptors(csv *olmAPI.ClusterServiceVersion, runtimeClient client.Cli
 		for _, specDesc := range crd.SpecDescriptors {
 			if specDesc.Path == key {
 				test.earnedPoints++
+				delete(specBlock, key)
 				break
 			}
 		}
 	}
 	scTests = append(scTests, test)
+	for key := range specBlock {
+		scSuggestions = append(scSuggestions, "Add a spec descriptor for " + key)
+	}
 	return nil
 }

commands/operator-sdk/cmd/scorecard/scorecard.go

@@ -80,6 +80,7 @@ type cleanupFn func() error
 var (
 	kubeconfig     *rest.Config
 	scTests        []scorecardTest
+	scSuggestions  []string
 	dynamicDecoder runtime.Decoder
 	runtimeClient  client.Client
 	restMapper     *restmapper.DeferredDiscoveryRESTMapper
@@ -262,5 +263,9 @@ func ScorecardTests(cmd *cobra.Command, args []string) error {
 		}
 	}
 	fmt.Printf("\nTotal Score: %d/%d points\n", totalEarned, totalMax)
+	for _, suggestion := range scSuggestions {
+		// 33 is yellow (specifically, the same shade of yellow that logrus uses for warnings)
+		fmt.Printf("\x1b[%dmSUGGESTION:\x1b[0m %s\n", 33, suggestion)
+	}
 	return nil
 }