Added stateful test to verify default values (#62)

docs/BREAKING_CHANGE.md

@@ -58,3 +58,11 @@
 ||`MI010`|`"cannot remove maximum from properties"`|
 ||`MI011`|`"only NEWLY ADDED properties can have additional maximum constraint"`|
 ||`MI012`|`"new maximum value cannot be less than the old value"`|
+
+
+***
+#### Non CFN Enforced Rules
+| Rule Name | Check Id | Message |
+|----------|-------------|------------------------------------------------------------|
+|`ensure_default_values_have_not_changed`|`TFDF001`| `"cannot remove default values from properties"` |
+||`TFDF002`|`"cannot change default values"`|

src/rpdk/guard_rail/core/stateful.py

@@ -89,6 +89,7 @@ class DIFFKEYS:
  "additionalProperties",
  "uniqueItems",
  "dependencies",
+ "default",
 }
 
 

src/rpdk/guard_rail/rule_library/stateful/schema-stateful-non-cfn-enforced-checks.guard

@@ -0,0 +1,20 @@
+rule ensure_default_values_have_not_changed when default exists
+{
+ default.removed !exists
+ <<
+ {
+ "result": "NON_COMPLIANT",
+ "check_id": "TFDF001",
+ "message": "cannot remove default values from properties"
+ }
+ >>
+
+ default.changed !exists
+ <<
+ {
+ "result": "NON_COMPLIANT",
+ "check_id": "TFDF002",
+ "message": "cannot change default values"
+ }
+ >>
+}

tests/integ/runner/test_integ_runner.py

@@ -1,3 +1,4 @@
+# pylint: disable=C0302
 """
 Integ test for runner.py
 """
@@ -914,3 +915,98 @@ def test_exec_compliance_stateful_create_only_breaking_change_with_no_properties
  assert (
  non_compliant_result == compliance_result.non_compliant[non_compliant_rule]
  )
+
+
+@pytest.mark.parametrize(
+ "previous_schema, current_schema, collected_rules,non_compliant_rules,warning_rules",
+ [
+ (
+ {
+ "properties": {
+ "LastName": {
+ "type": "string",
+ "default": "Snow",
+ },
+ "Name": {
+ "type": "string",
+ "default": "Jon",
+ },
+ },
+ },
+ {
+ "properties": {
+ "LastName": {
+ "type": "string",
+ "default": "Targaryen",
+ },
+ "Name": {
+ "type": "string",
+ "default": "Jon",
+ },
+ },
+ },
+ [],
+ {
+ "ensure_default_values_have_not_changed": {
+ GuardRuleResult(
+ check_id="TFDF002",
+ message="cannot change default values",
+ path="/default/changed",
+ )
+ },
+ },
+ [],
+ ),
+ (
+ {
+ "properties": {
+ "LastName": {
+ "type": "string",
+ "default": "Snow",
+ },
+ "Name": {
+ "type": "string",
+ "default": "Jon",
+ },
+ },
+ },
+ {
+ "properties": {
+ "LastName": {
+ "type": "string",
+ },
+ "Name": {
+ "type": "string",
+ "default": "Jon",
+ },
+ },
+ },
+ [],
+ {
+ "ensure_default_values_have_not_changed": {
+ GuardRuleResult(
+ check_id="TFDF001",
+ message="cannot remove default values from properties",
+ path="/default/removed",
+ )
+ },
+ },
+ [],
+ ),
+ ],
+)
+def test_exec_compliance_stateful_default_value_breaking_change(
+ previous_schema, current_schema, collected_rules, non_compliant_rules, warning_rules
+):
+ """Test exec_compliance for stateful"""
+ payload: Stateful = Stateful(
+ previous_schema=previous_schema,
+ current_schema=current_schema,
+ rules=collected_rules,
+ )
+ compliance_result = exec_compliance(payload)[0]
+ for non_compliant_rule, non_compliant_result in non_compliant_rules.items():
+ assert non_compliant_rule in compliance_result.non_compliant
+ assert (
+ non_compliant_result == compliance_result.non_compliant[non_compliant_rule]
+ )