Add tests.

Author: JoeZiminski

datashuttle/tui/shared/validate_content.py

@@ -106,7 +106,7 @@ def compose(self) -> ComposeResult:
                 Checkbox(
                     "ALLOW_ALPHANUMERIC",
                     value=False,
-                    id="ALLOW_ALPHANUMERIC_checkbox",
+                    id="validate_ALLOW_ALPHANUMERIC_checkbox",
                 ),
                 id="validate_arguments_horizontal",
             ),
@@ -163,7 +163,7 @@ def on_button_pressed(self, event: Button.Pressed) -> None:
             ).value
 
             ALLOW_ALPHANUMERIC = self.query_one(
-                "#ALLOW_ALPHANUMERIC_checkbox"
+                "#validate_ALLOW_ALPHANUMERIC_checkbox"
             ).value
 
             if self.interface:

tests/tests_tui/test_tui_create_folders.py

@@ -259,7 +259,7 @@ async def test_validation_error_and_bypass_validation(
         checking an error displays. Next, turn on 'bypass validation'
         and check the folders are created despite being invalid.
         """
-        tmp_config_path, tmp_path, project_name = setup_project_paths.values()
+        _, _, project_name = setup_project_paths.values()
 
         app = TuiApp()
         async with app.run_test(size=self.tui_size()) as pilot:
@@ -323,6 +323,52 @@ async def test_validation_error_and_bypass_validation(
 
             await pilot.pause()
 
+    @pytest.mark.asyncio
+    async def test_ALLOW_ALPHANUMERIC(self, setup_project_paths):
+        """"""
+        _, _, project_name = setup_project_paths.values()
+
+        app = TuiApp()
+        async with app.run_test(size=self.tui_size()) as pilot:
+            await self.check_and_click_onto_existing_project(
+                pilot, project_name
+            )
+
+            await self.fill_input(
+                pilot, "#create_folders_subject_input", "sub-abc"
+            )
+            await self.fill_input(
+                pilot, "#create_folders_session_input", "ses-abc"
+            )
+
+            await self.scroll_to_click_pause(
+                pilot, "#create_folders_settings_button"
+            )
+            await self.scroll_to_click_pause(
+                pilot, "#create_folders_ALLOW_ALPHANUMERIC_checkbox"
+            )
+            await self.scroll_to_click_pause(
+                pilot, "#create_folders_settings_close_button"
+            )
+
+            await self.scroll_to_click_pause(
+                pilot, "#create_folders_create_folders_button"
+            )
+
+            assert (
+                pilot.app.screen.interface.project.cfg["local_path"]
+                / "rawdata"
+                / "sub-abc"
+            ).is_dir()
+            assert (
+                pilot.app.screen.interface.project.cfg["local_path"]
+                / "rawdata"
+                / "sub-abc"
+                / "ses-abc"
+            ).is_dir()
+
+            await pilot.pause()
+
     # -------------------------------------------------------------------------
     # Test Name Templates
     # -------------------------------------------------------------------------

tests/tests_tui/test_tui_validate.py

@@ -104,6 +104,7 @@ async def test_validate_on_project_manager_kwargs(
                 "ses": None,
             }
             assert kwargs_["strict_mode"] is False
+            assert kwargs_["ALLOW_ALPHANUMERIC"] is False
 
             # Then, change all arguments and check these are
             # changed at the level of the called function.
@@ -117,6 +118,10 @@ async def test_validate_on_project_manager_kwargs(
             )
             await self.change_checkbox(pilot, "#validate_strict_mode_checkbox")
 
+            await self.change_checkbox(
+                pilot, "#validate_ALLOW_ALPHANUMERIC_checkbox"
+            )
+
             await self.scroll_to_click_pause(
                 pilot, "#validate_validate_button"
             )
@@ -146,6 +151,7 @@ async def test_validate_on_project_manager_kwargs(
                 "ses": None,
             }
             assert kwargs_["strict_mode"] is False
+            assert kwargs_["ALLOW_ALPHANUMERIC"] is True
 
             # Check the widgets are hidden as expected.
             # Path widgets are not shown for Transfer tab
@@ -176,6 +182,10 @@ async def test_validate_at_path_kwargs(self, setup_project_paths, mocker):
             )
             await self.fill_input(pilot, "#validate_path_input", project_path)
 
+            await self.change_checkbox(
+                pilot, "#validate_ALLOW_ALPHANUMERIC_checkbox"
+            )
+
             # Spy the function and click 'validate' button
             spy_validate = mocker.spy(
                 datashuttle.tui.shared.validate_content,
@@ -194,6 +204,7 @@ async def test_validate_at_path_kwargs(self, setup_project_paths, mocker):
             assert args_[0] == project_path
             assert kwargs_["top_level_folder"] == "rawdata"
             assert kwargs_["strict_mode"] is False
+            assert kwargs_["ALLOW_ALPHANUMERIC"] is True
 
             # Check removed widgets, this should be removed because always local
             with pytest.raises(textual.css.query.InvalidQueryFormat):

tests/tests_tui/test_tui_widgets_and_defaults.py

@@ -416,6 +416,20 @@ async def test_create_folder_settings_widgets(self, setup_project_paths):
                 is False
             )
 
+            # ALLOW_ALPHANUMERIC
+            assert (
+                pilot.app.screen.query_one(
+                    "#create_folders_ALLOW_ALPHANUMERIC_checkbox"
+                ).label._text
+                == "ALLOW_ALPHANUMERIC"
+            )
+            assert (
+                pilot.app.screen.query_one(
+                    "#create_folders_ALLOW_ALPHANUMERIC_checkbox"
+                ).value
+                is False
+            )
+
             # Template validation
             assert (
                 pilot.app.screen.query_one(
@@ -650,12 +664,26 @@ async def test_name_templates_widgets_and_settings(
             await pilot.pause()
 
     @pytest.mark.asyncio
-    async def test_bypass_validation_settings(self, setup_project_paths):
-        """Test all configs that underly the 'bypass validation'
+    @pytest.mark.parametrize(
+        "parameter_name", ["bypass_validation", "ALLOW_ALPHANUMERIC"]
+    )
+    async def test_create_folderes_validation_settings(
+        self, setup_project_paths, parameter_name
+    ):
+        """Test all configs that underly the 'bypass validation' and `ALLOW_ALPHANUMERIC`
         setting are updated correctly by the widget.
+
+        These two options are similar and are both default off, we so we can test
+        them using the same process (turning them on and checking the underlying
+        parameters in the stored dictionaries are also changed as expected).
         """
         tmp_config_path, tmp_path, project_name = setup_project_paths.values()
 
+        if parameter_name == "bypass_validation":
+            checkbox_id = "#create_folders_settings_bypass_validation_checkbox"
+        else:
+            checkbox_id = "#create_folders_ALLOW_ALPHANUMERIC_checkbox"
+
         app = TuiApp()
         async with app.run_test(size=self.tui_size()) as pilot:
             await self.setup_existing_project_create_tab_filled_sub_and_ses(
@@ -665,30 +693,17 @@ async def test_bypass_validation_settings(self, setup_project_paths):
                 pilot, "#create_folders_settings_button"
             )
 
+            assert pilot.app.screen.query_one(checkbox_id).value is False
             assert (
-                pilot.app.screen.query_one(
-                    "#create_folders_settings_bypass_validation_checkbox"
-                ).value
-                is False
-            )
-            assert (
-                pilot.app.screen.interface.tui_settings["bypass_validation"]
+                pilot.app.screen.interface.tui_settings[parameter_name]
                 is False
             )
 
-            await self.scroll_to_click_pause(
-                pilot, "#create_folders_settings_bypass_validation_checkbox"
-            )
+            await self.scroll_to_click_pause(pilot, checkbox_id)
 
+            assert pilot.app.screen.query_one(checkbox_id).value is True
             assert (
-                pilot.app.screen.query_one(
-                    "#create_folders_settings_bypass_validation_checkbox"
-                ).value
-                is True
-            )
-            assert (
-                pilot.app.screen.interface.tui_settings["bypass_validation"]
-                is True
+                pilot.app.screen.interface.tui_settings[parameter_name] is True
             )
 
             await self.scroll_to_click_pause(
@@ -701,15 +716,9 @@ async def test_bypass_validation_settings(self, setup_project_paths):
                 pilot, "#create_folders_settings_button"
             )
 
+            assert pilot.app.screen.query_one(checkbox_id).value is True
             assert (
-                pilot.app.screen.query_one(
-                    "#create_folders_settings_bypass_validation_checkbox"
-                ).value
-                is True
-            )
-            assert (
-                pilot.app.screen.interface.tui_settings["bypass_validation"]
-                is True
+                pilot.app.screen.interface.tui_settings[parameter_name] is True
             )
 
             await pilot.pause()