add: error if entity save_to in undeclared repeat

- in this case a top-level entity instance would be generated and so it
  wouldn't be populated properly by the item in the repeat. Either a
  mistake in where the save_to was placed, or the entity repeat column
  was left blank by mistake.

Author: lindsay-stevens

pyxform/entities/entities_parsing.py

@@ -41,18 +41,26 @@
     name="Invalid entity repeat save_to: question in nested repeat",
     msg=(
         "[row : {row}] On the 'survey' sheet, the 'save_to' value '{value}' is invalid. "
-        "The entity properties populated with 'save_to' must not be inside of a nested "
+        "The entity property populated with 'save_to' must not be inside of a nested "
         "repeat within the entity repeat."
     ),
 )
 ENTITY006 = Detail(
     name="Invalid entity repeat save_to: question not in entity repeat",
     msg=(
         "[row : {row}] On the 'survey' sheet, the 'save_to' value '{value}' is invalid. "
-        "The entity properties populated with 'save_to' must be inside of the entity "
+        "The entity property populated with 'save_to' must be inside of the entity "
         "repeat."
     ),
 )
+ENTITY007 = Detail(
+    name="Invalid entity repeat save_to: question in repeat but no entity repeat defined",
+    msg=(
+        "[row : {row}] On the 'survey' sheet, the 'save_to' value '{value}' is invalid. "
+        "The entity property populated with 'save_to' must be inside a repeat that is "
+        "declared in the 'repeat' column of the 'entities' sheet."
+    ),
+)
 
 
 def get_entity_declaration(
@@ -244,8 +252,8 @@ def get_validated_repeat_name(entity) -> str | None:
 def validate_entity_saveto(
     row: dict,
     row_number: int,
+    stack: Sequence[dict[str, Any]],
     entity_declaration: dict[str, Any] | None = None,
-    stack: Sequence[dict[str, Any]] | None = None,
 ):
     save_to = row.get(const.BIND, {}).get("entities:saveto", "")
     if not save_to:
@@ -262,23 +270,26 @@ def validate_entity_saveto(
         )
 
     entity_repeat = entity_declaration.get(EC.REPEAT, None)
-    if entity_repeat and stack:
-        # Error: saveto in nested repeat inside entity repeat.
-        in_repeat = False
-        located = False
-        for i in reversed(stack):
-            if not i["control_name"] or not i["control_type"]:
-                break
-            elif i["control_type"] == const.REPEAT:
-                if in_repeat:
-                    raise PyXFormError(ENTITY005.format(row=row_number, value=save_to))
-                elif i["control_name"] == entity_repeat:
-                    located = True
-                in_repeat = True
-
-        # Error: saveto not in entity repeat
-        if not located:
-            raise PyXFormError(ENTITY006.format(row=row_number, value=save_to))
+    in_repeat = False
+    located = False
+    for i in reversed(stack):
+        if not i["control_name"] or not i["control_type"]:
+            break
+        elif i["control_type"] == const.REPEAT:
+            # Error: saveto in nested repeat inside entity repeat.
+            if in_repeat:
+                raise PyXFormError(ENTITY005.format(row=row_number, value=save_to))
+            elif i["control_name"] == entity_repeat:
+                located = True
+            in_repeat = True
+
+    # Error: saveto not in entity repeat
+    if entity_repeat and not located:
+        raise PyXFormError(ENTITY006.format(row=row_number, value=save_to))
+
+    # Error: saveto in repeat but no entity repeat declared
+    if in_repeat and not entity_repeat:
+        raise PyXFormError(ENTITY007.format(row=row_number, value=save_to))
 
     error_start = f"{const.ROW_FORMAT_STRING % row_number} Invalid save_to name:"
 

pyxform/xls2json.py

@@ -861,8 +861,8 @@ def workbook_to_json(
         validate_entity_saveto(
             row=row,
             row_number=row_number,
-            entity_declaration=entity_declaration,
             stack=stack,
+            entity_declaration=entity_declaration,
         )
 
         # Try to parse question as begin control statement

tests/entities/test_create_survey.py

@@ -1,4 +1,5 @@
 from pyxform import constants as co
+from pyxform.entities import entities_parsing as ep
 
 from tests.pyxform_test_case import PyxformTestCase
 from tests.xpath_helpers.entities import xpe
@@ -345,6 +346,25 @@ def test_saveto_on_group__errors(self):
             ],
         )
 
+    def test_saveto_in_repeat__errors(self):
+        """Should find that an error is raised if a save_to is in an undeclared entity repeat."""
+        md = """
+        | survey |
+        | | type         | name | label | save_to |
+        | | begin_repeat | r1   | R1    |         |
+        | | text         | q1   | Q1    | q1e     |
+        | | end_repeat   | r1   |       |         |
+
+        | entities |
+        | | dataset | label |
+        | | trees   | ${q1} |
+        """
+        self.assertPyxformXform(
+            md=md,
+            errored=True,
+            error__contains=[ep.ENTITY007.format(row=3, value="q1e")],
+        )
+
     def test_saveto_in_group__works(self):
         self.assertPyxformXform(
             name="data",