fix GN001 (#78)

wenyez · web-flow · commit 657c74d05f8e · 2025-01-10T15:51:26.000-08:00
diff --git a/src/rpdk/guard_rail/rule_library/core/schema-linter-core-rules.guard b/src/rpdk/guard_rail/rule_library/core/schema-linter-core-rules.guard
@@ -192,7 +192,7 @@ rule verify_property_notation
 
 
 rule ensure_description_is_descriptive {
-    description != /^Resource Type definition for/
+    description == /^Resource Type definition for/
     <<
     {
         "result": "WARNING",
diff --git a/tests/integ/runner/test_integ_runner.py b/tests/integ/runner/test_integ_runner.py
@@ -147,6 +147,13 @@
                         path="/taggable",
                     )
                 },
+                "ensure_description_is_descriptive": {
+                    GuardRuleResult(
+                        check_id="GN001",
+                        message="description should start with `Resource Type definition for ...`",
+                        path="/description",
+                    )
+                },
             },
         ),
         (

Original file line number	Diff line number	Diff line change
`@@ -192,7 +192,7 @@ rule verify_property_notation`
`192`	`192`
`193`	`193`
`194`	`194`	`rule ensure_description_is_descriptive {`
`195`		`- description != /^Resource Type definition for/`
	`195`	`+ description == /^Resource Type definition for/`
`196`	`196`	`<<`
`197`	`197`	`{`
`198`	`198`	`"result": "WARNING",`
Original file line number	Diff line number	Diff line change
`@@ -147,6 +147,13 @@`
`147`	`147`	`path="/taggable",`
`148`	`148`	`)`
`149`	`149`	`},`
	`150`	`+ "ensure_description_is_descriptive": {`
	`151`	`+ GuardRuleResult(`
	`152`	`+ check_id="GN001",`
	`153`	+ message="description should start with `Resource Type definition for ...`",
	`154`	`+ path="/description",`
	`155`	`+ )`
	`156`	`+ },`
`150`	`157`	`},`
`151`	`158`	`),`
`152`	`159`	`(`