add: check the "name" setting as well as "form_name"

- it's possible to set the primary instance root node name via the
  setting "name" (which overrides other ways to set the name), so check
  the settings code path as well.

Author: lindsay-stevens

pyxform/validators/pyxform/settings.py

@@ -1,12 +1,21 @@
+from pyxform import constants as co
 from pyxform.errors import ErrorCode, PyXFormError
 from pyxform.parsing.expression import is_xml_tag
 
 
-def validate_form_name(form_name: str | None):
+def validate_name(name: str | None, from_sheet: bool = True):
     """
-    The form_name must be a valid XML tag since it is used for the primary instance element.
+    The name must be a valid XML Name since it is used for the primary instance element.
 
-    :param form_name: The value to check.
+    :param name: The value to check.
+    :param from_sheet: If True, the value is from the settings sheet (rather than the
+      file name or form_name API usage), so the sheet name should be included in the
+      error (if any).
     """
-    if form_name is not None and not is_xml_tag(value=form_name):
-        raise PyXFormError(ErrorCode.NAMES_009.value.format(name="form_name"))
+    if name is not None and not is_xml_tag(value=name):
+        if from_sheet:
+            raise PyXFormError(
+                ErrorCode.NAMES_008.value.format(sheet=co.SETTINGS, row=1, column=co.NAME)
+            )
+        else:
+            raise PyXFormError(ErrorCode.NAMES_009.value.format(name="form_name"))

pyxform/xls2json.py

@@ -264,7 +264,7 @@ def workbook_to_json(
         raise PyXFormError(msg)
 
     # Make sure the passed in vars are unicode
-    validate_settings.validate_form_name(form_name=form_name)
+    validate_settings.validate_name(name=form_name, from_sheet=False)
     form_name = str(coalesce(form_name, constants.DEFAULT_FORM_NAME))
     default_language = str(coalesce(default_language, constants.DEFAULT_LANGUAGE_VALUE))
 
@@ -308,6 +308,7 @@ def workbook_to_json(
             header_columns=set(Survey.get_slot_names()),
         )
         settings = settings_sheet.data[0]
+        validate_settings.validate_name(name=settings.get(constants.NAME, None))
     else:
         similar = find_sheet_misspellings(key=constants.SETTINGS, keys=sheet_names)
         if similar is not None:

tests/test_settings.py

@@ -1,3 +1,4 @@
+from pyxform import constants as co
 from pyxform.errors import ErrorCode
 
 from tests.pyxform_test_case import PyxformTestCase
@@ -43,7 +44,39 @@ def test_form_id(self):
             xml__xpath_match=[xps.form_id("my_form")],
         )
 
-    def test_form_name__valid_characters(self):
+    def test_name__from_sheet__valid_characters(self):
+        """Should allow a custom name with valid characters."""
+        md = """
+        | settings |
+        | | name             |
+        | | master-form_v2.1 |
+
+        | survey |
+        | | type  | name | label |
+        | | text  | q1   | hello |
+        """
+        self.assertPyxformXform(md=md, xml__xpath_match=[xps.name("master-form_v2.1")])
+
+    def test_name__from_sheet__invalid_characters__error(self):
+        """Should raise an error if the form_name is not a valid name."""
+        md = """
+        | settings |
+        | | name         |
+        | | bad@filename |
+
+        | survey |
+        | | type  | name | label |
+        | | text  | q1   | hello |
+        """
+        self.assertPyxformXform(
+            md=md,
+            errored=True,
+            error__contains=[
+                ErrorCode.NAMES_008.value.format(sheet=co.SETTINGS, row=1, column=co.NAME)
+            ],
+        )
+
+    def test_name__from_file__valid_characters(self):
         """Should allow a custom form_name with valid characters."""
         md = """
         | survey |
@@ -53,9 +86,10 @@ def test_form_name__valid_characters(self):
         self.assertPyxformXform(
             md=md,
             name="master-form_v2.1",
+            xml__xpath_match=[xps.name("master-form_v2.1")],
         )
 
-    def test_form_name__invalid_characters__error(self):
+    def test_name__from_file__invalid_characters__error(self):
         """Should raise an error if the form_name is not a valid name."""
         md = """
         | survey |

tests/xpath_helpers/settings.py

@@ -17,6 +17,16 @@ def form_id(value: str) -> str:
         /h:html/h:head/x:model/x:instance/x:test_name/@id[.='{value}']
         """
 
+    @staticmethod
+    def name(value: str) -> str:
+        """The primary instance root node name is set to this value."""
+        return f"""
+        /h:html/h:head/x:model/x:instance/*[
+          namespace-uri()='http://www.w3.org/2002/xforms'
+          and local-name()='{value}'
+        ]
+        """
+
     @staticmethod
     def language_is_default(lang: str) -> str:
         """The language translation has itext and is marked as the default."""