Add resource property validation framework to SAM translator. by vicheey · Pull Request #3805 · aws/serverless-application-model

vicheey · 2025-08-22T21:16:21Z

Issue #, if available

None

Description of changes

This PR introduces a comprehensive validation framework for SAM resource properties, and enhancing the translator's ability to catch configuration errors early in the deployment process.

Added property rule validation method in samtranslator/model/init.py
Enhanced add propagate tags logic in samtranslator/model/init.py
Add enhance property rule validation logic samtranslator/validator/property_rule.py
Updated SAM resources in samtranslator/model/sam_resources.py to integrate
validation
Comprehensive test coverage in tests/test_model.py
Comprehensive test coverage in tests/validator/test_property_rule.py

Description of how you validated changes

Added extensive test suite covering validation scenarios
All existing tests continue to pass

Checklist

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

vicheey · 2025-08-22T23:23:18Z

The Tests failed because of lower coverage percentage. (94.82% instead of 95%). Added validation logic push the overall total line increase and lower the coverage percentage.

Low coverage files:
• samtranslator/validator/validator.py - 27% coverage
• samtranslator/model/init.py - 69% coverage
• samtranslator/model/naming.py - 71% coverage
• samtranslator/region_configuration.py - 79% coverage

Removing deprecated and unused samtranslator/validator/validator.py

vicheey · 2025-08-22T23:28:39Z

Current usage analysis:
• No active imports of SamTemplateValidator in any source
files
• No test files directly testing SamTemplateValidator

What IS being used:
• samtranslator.validator.value_validator.sam_expect - Used extensively across 12+ files
• Direct jsonschema.validate() calls in tests (instead of the deprecated SAM wrapper)

However, we cannot delete this file yet because this public facing interface might be used by package consuming this package.
I added the samtranslator.validator.validator.py to test coverage ignore list.

--------------------------------
TOTAL   9640    314   3402    220    95%

Required test coverage of 95% reached. Total coverage: 95.28%

=============== 4118 passed in 86.15s (0:01:26) ================

samtranslator/model/__init__.py

tests/test_model.py

samtranslator/model/__init__.py

valerena · 2025-09-02T21:08:25Z

samtranslator/model/sam_resources.py

+    # def get_property_validation_rules(self) -> Optional[PropertyRules]:
+    #     """Override to provide PropertyRules validation for SAM Function."""
+    # TODO: To enable these rules, we need to update translator test input/output files to property configure template
+    #       to avoid fail-fast. eg: test with DeploymentPreference without AutoPublishAlias would fail fast before reaching testing state
+    # from samtranslator.internal.schema_source.aws_serverless_function import Properties as FunctionProperties
+    # return (PropertyRules(FunctionProperties)
+    #     .addMutuallyExclusive("ImageUri", "InlineCode", "CodeUri")
+    #     .addConditionalInclusive("DeploymentPreference", ["AutoPublishAlias"])
+    #     .addConditionalInclusive("ProvisionedConcurrencyConfig", ["AutoPublishAlias"])
+    #     .addConditionalInclusive("PackageType=Zip", ["Runtime", "Handler"])
+    #     .addConditionalInclusive("PackageType=Image", ["ImageUri"])
+    #     .addConditionalExclusive("PackageType=Zip", ["ImageUri", "ImageConfig"])
+    #     .addConditionalExclusive("PackageType=Image", ["Runtime", "Handler", "Layers"]))
+    # return None
+


Do we plan to leave this here, commented out?

valerena · 2025-09-02T21:21:54Z

samtranslator/model/sam_resources.py

+        # TODO: Skip pass schema_class=aws_serverless_function.Properties to skip schema validation for now.
+        # - adding this now would required update error message in error error_function_*_test.py
+        # - add this when we can verify that changing error message would not break customers
+        # self.validate_before_transform(schema_class=aws_serverless_function.Properties)


what is this validate_before_transform that appears here? Is it defined somewhere else?

valerena · 2025-09-02T21:27:59Z

samtranslator/validator/property_rule.py

+            missing = [prop for prop in target_props if not self._check_property_condition(validated_model, prop)]
+            if missing:
+                missing_props = ", ".join(f"'{p}'" for p in missing)
+                return f"'{source_props[0]}' requires all of: {missing_props}."


is source_props only of length 1?

If so, can you change line 101 to just take the first one from source_props instead of loop over the array?

Or if we want to still keep it extensible, we would have to change this error here to point to the all the source_props (or the right one), instead of just using source_props[0]

same for conditional_exclusive

valerena · 2025-09-02T21:50:49Z

tests/test_model.py

+            mock_attr1 = Mock()
+            mock_attr2 = Mock()
+            mock_attr1.return_value = "value1"
+            mock_attr2.return_value = "value2"


Not necessary (and I don't know how much it's used in other places, but you can also set the return value right away:

mock_attr1 = Mock(return_value="value1") mock_attr2 = Mock(return_value="value2")

roger-zhangg · 2025-10-07T22:06:32Z

samtranslator/validator/property_rule.py

+        if rule_type == RuleType.MUTUALLY_EXCLUSIVE:
+            return self._validate_mutually_exclusive(validated_model, source_props)
+        if rule_type == RuleType.CONDITIONAL_EXCLUSIVE:
+            return self._validate_conditional_exclusive(validated_model, source_props, target_props)
+        if rule_type == RuleType.MUTUALLY_INCLUSIVE:
+            return self._validate_mutually_inclusive(validated_model, source_props)
+        if rule_type == RuleType.CONDITIONAL_INCLUSIVE:
+            return self._validate_conditional_inclusive(validated_model, source_props, target_props)
+        return None


consider making the rule a class, so we can do

Suggested change

if rule_type == RuleType.MUTUALLY_EXCLUSIVE:

return self._validate_mutually_exclusive(validated_model, source_props)

if rule_type == RuleType.CONDITIONAL_EXCLUSIVE:

return self._validate_conditional_exclusive(validated_model, source_props, target_props)

if rule_type == RuleType.MUTUALLY_INCLUSIVE:

return self._validate_mutually_inclusive(validated_model, source_props)

if rule_type == RuleType.CONDITIONAL_INCLUSIVE:

return self._validate_conditional_inclusive(validated_model, source_props, target_props)

return None

return self.rule.validate()

add resource property validation rule and logic

89f8a01

vicheey requested a review from a team as a code owner August 22, 2025 21:16

Merge branch 'develop' into validation-framework-extraction

f762c86

vicheey requested review from bnusunny and roger-zhangg August 22, 2025 21:17

comment out validation rules for functions

d5410b0

chore: ignore validator.oy from test coverage

b52c322

vicheey force-pushed the validation-framework-extraction branch from 188db2a to b52c322 Compare August 22, 2025 23:50

roger-zhangg reviewed Aug 26, 2025

View reviewed changes

tests/test_model.py Outdated Show resolved Hide resolved

roger-zhangg reviewed Aug 26, 2025

View reviewed changes

tests/test_model.py Outdated Show resolved Hide resolved

roger-zhangg reviewed Aug 26, 2025

View reviewed changes

tests/test_model.py Outdated Show resolved Hide resolved

roger-zhangg reviewed Aug 26, 2025

View reviewed changes

samtranslator/model/__init__.py Outdated Show resolved Hide resolved

vicheey and others added 3 commits August 27, 2025 01:11

address comments

7f854fb

address comments

9d2125c

Merge branch 'develop' into validation-framework-extraction

d638ffd

vicheey requested a review from roger-zhangg August 28, 2025 05:00

vicheey added 3 commits August 28, 2025 11:35

Merge branch 'develop' into validation-framework-extraction

d10dbd2

Merge branch 'develop' into validation-framework-extraction

75de835

Merge branch 'develop' into validation-framework-extraction

dcc9fdb

valerena reviewed Sep 2, 2025

View reviewed changes

Merge branch 'develop' into validation-framework-extraction

3aa6b58

roger-zhangg reviewed Oct 7, 2025

View reviewed changes

Merge branch 'develop' into validation-framework-extraction

dba1825

Comments

Conversation

vicheey commented Aug 22, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Issue #, if available

Description of changes

Description of how you validated changes

Checklist

Uh oh!

vicheey commented Aug 22, 2025

Uh oh!

vicheey commented Aug 22, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

valerena Sep 2, 2025

Choose a reason for hiding this comment

Uh oh!

valerena Sep 2, 2025

Choose a reason for hiding this comment

Uh oh!

valerena Sep 2, 2025

Choose a reason for hiding this comment

Uh oh!

valerena Sep 2, 2025

Choose a reason for hiding this comment

Uh oh!

valerena Sep 2, 2025

Choose a reason for hiding this comment

Uh oh!

roger-zhangg Oct 7, 2025

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

vicheey commented Aug 22, 2025 •

edited

Loading

vicheey commented Aug 22, 2025 •

edited

Loading