updated code and made state as pass and throw suggestion instead of e…

…rror for missing spec in CR. (#6245) * updated code and made state as pass and thrown suggestions for the same Signed-off-by: laxmikantbpandhare <laxmikantpandhare@gmail.com> * updated code and made state as pass and thrown suggestions for the same Signed-off-by: laxmikantbpandhare <laxmikantpandhare@gmail.com> * updated test cases Signed-off-by: laxmikantbpandhare <laxmikantpandhare@gmail.com> * updated according to suggestions Signed-off-by: laxmikantbpandhare <laxmikantpandhare@gmail.com> * updated according to suggestions Signed-off-by: laxmikantbpandhare <laxmikantpandhare@gmail.com> Signed-off-by: laxmikantbpandhare <laxmikantpandhare@gmail.com>
operator-framework · Jan 11, 2023 · a5d933b · a5d933b
1 parent 346012f
commit a5d933b
Show file tree

Hide file tree

Showing 3 changed files with 19 additions and 3 deletions.
diff --git a/changelog/fragments/spec-scoreacrd-fix.yaml b/changelog/fragments/spec-scoreacrd-fix.yaml
@@ -0,0 +1,17 @@
+# entries is a list of entries to include in
+# release notes and/or the migration guide
+entries:
+  - description: >
+      (scorecard): Fixes a bug where an error would be thrown if a Custom Resource did not have a `.spec` field, which is a perfectly valid scenario.  Instead of throwing an error scorecard will now issue a suggestion.
+
+    # kind is one of:
+    # - addition
+    # - change
+    # - deprecation
+    # - removal
+    # - bugfix
+    kind: "bugfix"
+
+    # Is this a breaking change?
+    breaking: false
+
diff --git a/internal/scorecard/tests/basic.go b/internal/scorecard/tests/basic.go
@@ -50,8 +50,7 @@ func checkSpec(crSet []unstructured.Unstructured,
 	res scapiv1alpha3.TestResult) scapiv1alpha3.TestResult {
 	for _, cr := range crSet {
 		if cr.Object["spec"] == nil {
-			res.Errors = append(res.Errors, fmt.Sprintf("error spec does not exist for the custom resource %s", cr.GetName()))
-			res.State = scapiv1alpha3.FailState
+			res.State = scapiv1alpha3.PassState
 			res.Suggestions = append(res.Suggestions, fmt.Sprintf("spec missing from [%+v]", cr.GetName()))
 			return res
 		}

diff --git a/internal/scorecard/tests/bundle_test.go b/internal/scorecard/tests/bundle_test.go
@@ -283,7 +283,7 @@ var _ = Describe("Basic and OLM tests", func() {
 					},
 				}
 				result = checkSpec(cr, result)
-				Expect(result.State).To(Equal(scapiv1alpha3.FailState))
+				Expect(result.State).To(Equal(scapiv1alpha3.PassState))
 			})
 			It("should pass when CRs do have spec field specified", func() {
 				cr := []unstructured.Unstructured{