Add source on resolution clean errors

Author: kddejong

src/cfnlint/match.py

@@ -118,14 +118,12 @@ def create(
         if linenumberend is None:
             linenumberend = linenumber
 
-        filename = getattr(rulematch_obj, "filename", filename)
-
         return cls(
             linenumber=linenumber,
             columnnumber=columnnumber,
             linenumberend=linenumberend,
             columnnumberend=columnnumberend,
-            filename=filename,
+            filename=getattr(rulematch_obj, "filename", filename),
             rule=rule,
             message=message,
             rulematch_obj=rulematch_obj,

src/cfnlint/rules/deployment_files/Parameters.py

@@ -5,6 +5,7 @@
 
 from __future__ import annotations
 
+from pathlib import Path
 from typing import Any
 
 from cfnlint.jsonschema import Validator
@@ -97,5 +98,5 @@ def validate(self, validator: Validator, _: Any, instance: Any, schema: Any):
 
             for err in super()._iter_errors(cfn_validator, parameter_set.parameters):
                 if parameter_set.source:
-                    err.extra_args["filename"] = parameter_set.source
+                    err.extra_args["filename"] = str(Path(parameter_set.source))
                 yield err

src/cfnlint/rules/functions/_BaseFn.py

@@ -8,7 +8,7 @@
 from collections import namedtuple
 from typing import Any, Tuple
 
-from cfnlint.helpers import ToPy, ensure_list, is_types_compatible
+from cfnlint.helpers import ToPy, ensure_list, is_function, is_types_compatible
 from cfnlint.jsonschema import ValidationError, ValidationResult, Validator
 from cfnlint.rules import CloudFormationLintRule
 
@@ -57,14 +57,35 @@ def validator(self, validator: Validator) -> Validator:
         )
 
     def _clean_resolve_errors(
-        self, err: ValidationError, value: Any, instance: Any
+        self, err: ValidationError, value: Any, instance: Any, validator: Validator
     ) -> ValidationError:
         err.message = err.message.replace(f"{value!r}", f"{instance!r}")
         err.message = f"{err.message} when {self.fn.name!r} is resolved"
+        if validator.context.parameter_sets:
+            k, v = is_function(instance)
+            if k == "Ref":
+                if v in validator.context.parameters:
+                    deployment_files = []
+                    for parameter_set in validator.context.parameter_sets:
+                        if (
+                            v in parameter_set.parameters
+                            and value == parameter_set.parameters[v]
+                        ):
+                            if parameter_set.source:
+                                deployment_files.append(parameter_set.source)
+                            else:
+                                err.message = f"{err.message} to {value!r}"
+                                break
+                    else:
+                        err.message = (
+                            f"{err.message} to {value!r} from {deployment_files!r}"
+                        )
         if self.child_rules[self.resolved_rule]:
             err.rule = self.child_rules[self.resolved_rule]
             for i, err_ctx in enumerate(err.context):
-                err.context[i] = self._clean_resolve_errors(err_ctx, value, instance)
+                err.context[i] = self._clean_resolve_errors(
+                    err_ctx, value, instance, validator
+                )
         return err
 
     def resolve(
@@ -103,7 +124,9 @@ def resolve(
                 return
 
             for err in errs:
-                all_errs.append(self._clean_resolve_errors(err, value, instance))
+                all_errs.append(
+                    self._clean_resolve_errors(err, value, instance, validator)
+                )
 
         yield from iter(all_errs)
 

src/cfnlint/template/template.py

@@ -14,7 +14,8 @@
 
 import cfnlint.conditions
 import cfnlint.helpers
-from cfnlint._typing import CheckValueFn, Path
+from cfnlint._typing import CheckValueFn
+from cfnlint._typing import Path as CfnPath
 from cfnlint.context import Context, ParameterSet, create_context_for_template
 from cfnlint.context.conditions.exceptions import Unsatisfiable
 from cfnlint.decode.node import dict_node, list_node
@@ -357,7 +358,7 @@ def get_directives(self) -> dict[str, list[str]]:
         return results
 
     # pylint: disable=dangerous-default-value
-    def _search_deep_keys(self, searchText: str | re.Pattern, cfndict, path: Path):
+    def _search_deep_keys(self, searchText: str | re.Pattern, cfndict, path: CfnPath):
         """Search deep for keys and get their values.
 
         Args:
@@ -371,7 +372,7 @@ def _search_deep_keys(self, searchText: str | re.Pattern, cfndict, path: Path):
         keys = []
         if isinstance(cfndict, dict):
             for key in cfndict:
-                pathprop: Path = path[:]
+                pathprop: CfnPath = path[:]
                 pathprop.append(key)
                 if isinstance(searchText, str):
                     if key == searchText:
@@ -511,7 +512,9 @@ def _get_cfn_path(
 
         yield from _get_cfn_path(path, self.template, context)
 
-    def get_condition_values(self, template, path: Path | None) -> list[dict[str, Any]]:
+    def get_condition_values(
+        self, template, path: CfnPath | None
+    ) -> list[dict[str, Any]]:
         """
         Evaluates conditions in the provided CloudFormation template and returns the values.
 
@@ -568,7 +571,7 @@ def get_condition_values(self, template, path: Path | None) -> list[dict[str, An
 
         return matches
 
-    def get_values(self, obj, key, path: Path | None = None):
+    def get_values(self, obj, key, path: CfnPath | None = None):
         """
         Logic for getting the value of a key in the provided object.
 
@@ -694,7 +697,7 @@ def get_sub_parameters(self, sub_string):
 
         return results
 
-    def get_location_yaml(self, text: Any, path: Path):
+    def get_location_yaml(self, text: Any, path: CfnPath):
         """
         Get the location information for the given YAML text and path.
 
@@ -750,7 +753,7 @@ def check_value(
         self,
         obj: dict[str, Any],
         key: str,
-        path: Path,
+        path: CfnPath,
         check_value: CheckValueFn | None = None,
         check_ref: CheckValueFn | None = None,
         check_get_att: CheckValueFn | None = None,
@@ -859,7 +862,9 @@ def check_value(
 
         return matches
 
-    def is_resource_available(self, path: Path, resource: str) -> list[dict[str, bool]]:
+    def is_resource_available(
+        self, path: CfnPath, resource: str
+    ) -> list[dict[str, bool]]:
         """
         Compares a path to a resource to see if it is available.
 
@@ -911,7 +916,7 @@ def is_resource_available(self, path: Path, resource: str) -> list[dict[str, boo
         return results
 
     def get_object_without_nested_conditions(
-        self, obj: dict | list, path: Path, region: str | None = None
+        self, obj: dict | list, path: CfnPath, region: str | None = None
     ):
         """
         Get a list of object values without conditions included.
@@ -1136,7 +1141,7 @@ def get_object_without_conditions(self, obj, property_names=None, region=None):
 
     def get_condition_scenarios_below_path(
         self,
-        path: Path,
+        path: CfnPath,
         include_if_in_function: bool = False,
         region: str | None = None,
     ) -> list[dict[str, bool]]:
@@ -1238,7 +1243,7 @@ def get_conditions_from_property(value):
     def get_conditions_from_path(
         self,
         text: Any,
-        path: Path,
+        path: CfnPath,
         include_resource_conditions: bool = True,
         include_if_in_function: bool = True,
         only_last: bool = False,
@@ -1282,7 +1287,7 @@ def get_conditions_from_path(
     def _get_conditions_from_path(
         self,
         text: Any,
-        path: Path,
+        path: CfnPath,
         include_if_in_function: bool = True,
         only_last: bool = False,
     ) -> dict[str, set[bool]]:

test/integration/test_deployment_files.py

@@ -3,6 +3,8 @@
 SPDX-License-Identifier: MIT-0
 """
 
+from pathlib import Path
+
 import pytest
 
 from cfnlint.config import ConfigMixIn
@@ -27,7 +29,7 @@
                 Match(
                     message="'ImageId' is a required property",
                     rule=Parameters(),
-                    filename="test/fixtures/deployment_files/dev.yaml",
+                    filename=str(Path("test/fixtures/deployment_files/dev.yaml")),
                     linenumber=1,
                     linenumberend=1,
                     columnnumber=1,
@@ -39,7 +41,7 @@
                         "('Environment' was unexpected)"
                     ),
                     rule=Parameters(),
-                    filename="test/fixtures/deployment_files/dev.yaml",
+                    filename=str(Path("test/fixtures/deployment_files/dev.yaml")),
                     linenumber=3,
                     linenumberend=3,
                     columnnumber=3,
@@ -59,7 +61,7 @@
                 Match(
                     message="'ImageId' is a required property",
                     rule=Parameters(),
-                    filename="test/fixtures/deployment_files/dev.yaml",
+                    filename=str(Path("test/fixtures/deployment_files/dev.yaml")),
                     linenumber=1,
                     linenumberend=1,
                     columnnumber=1,
@@ -71,7 +73,7 @@
                         "('Environment' was unexpected)"
                     ),
                     rule=Parameters(),
-                    filename="test/fixtures/deployment_files/dev.yaml",
+                    filename=str(Path("test/fixtures/deployment_files/dev.yaml")),
                     linenumber=3,
                     linenumberend=3,
                     columnnumber=3,
@@ -80,7 +82,7 @@
                 Match(
                     message="'host' is not one of ['default', 'dedicated']",
                     rule=Parameters(),
-                    filename="test/fixtures/deployment_files/stage.yaml",
+                    filename=str(Path("test/fixtures/deployment_files/stage.yaml")),
                     linenumber=5,
                     linenumberend=5,
                     columnnumber=3,
@@ -89,10 +91,16 @@
                 Match(
                     message=(
                         "{'Ref': 'Affinity'} is not one of ['default', 'host'] "
-                        "when 'Ref' is resolved"
+                        "when 'Ref' is resolved to 'dne' from "
+                        "['test/fixtures/deployment_files/test.yaml', "
+                        "'test/fixtures/deployment_files/stage.yaml']"
                     ),
                     rule=RefResolved(),
-                    filename="test/fixtures/templates/integration/deployment-file-template.yaml",
+                    filename=str(
+                        Path(
+                            "test/fixtures/templates/integration/deployment-file-template.yaml"
+                        )
+                    ),
                     linenumber=34,
                     linenumberend=34,
                     columnnumber=7,
@@ -102,10 +110,16 @@
                     message=(
                         "{'Ref': 'ImageId'} is not a 'AWS::EC2::Image.Id' with "
                         "pattern '^ami-([0-9a-z]{8}|[0-9a-z]{17})$' when 'Ref' "
-                        "is resolved"
+                        "is resolved to 'ami-zxyzabc123' from "
+                        "['test/fixtures/deployment_files/test.yaml', "
+                        "'test/fixtures/deployment_files/stage.yaml']"
                     ),
                     rule=RefResolved(),
-                    filename="test/fixtures/templates/integration/deployment-file-template.yaml",
+                    filename=str(
+                        Path(
+                            "test/fixtures/templates/integration/deployment-file-template.yaml"
+                        )
+                    ),
                     linenumber=35,
                     linenumberend=35,
                     columnnumber=7,
@@ -129,12 +143,13 @@ def test_deployment_files(
     runner = Runner(config)
     results = list(runner.run())
 
-    # for result in results:
-    #    print(result.message)
-    #    print(result.rule)
-    #    print(result.linenumber)
-    #    print(result.linenumberend)
-    #    print(result.columnnumber)
-    #    print(result.columnnumberend)
+    for i, result in enumerate(results):
+        print(result.message)
+        print(result.rule)
+        print(result.filename, expected[i].filename)
+        print(result.linenumber)
+        print(result.linenumberend)
+        print(result.columnnumber)
+        print(result.columnnumberend)
 
     assert results == expected, f"{name}: {results} != {expected}"