Small changes to TUI for AWS / GDrive PR (#583)

* Use local only mode as default.

* Capitalise Google Drive.

* Capitalise Rclone.

* Additional newline in tooltip.

* Uncapitalise datashuttle, rename AWS S3 label to AWS S3 Bucket.

* Extend tooltips and add example placeholders.

* Small fixes

* Fix missed uppercase datashuttle.

* Uncomment test parameterisation.

* Fix tests.

Author: JoeZiminski

datashuttle/tui/interface.py

@@ -559,7 +559,7 @@ def get_rclone_message_for_gdrive_without_browser(
             return False, str(e)
 
     def terminate_google_drive_setup(self) -> None:
-        """Terminate rclone setup for google drive by killing the rclone process."""
+        """Terminate rclone setup for Google Drive by killing the rclone process."""
         assert self.google_drive_rclone_setup_process is not None
 
         process = self.google_drive_rclone_setup_process
@@ -572,7 +572,7 @@ def terminate_google_drive_setup(self) -> None:
     def await_successful_gdrive_connection_setup_raise_on_fail(
         self, process: subprocess.Popen
     ):
-        """Wait for rclone setup for google drive to finish and verify successful connection.
+        """Wait for rclone setup for Google Drive to finish and verify successful connection.
 
         The `self.gdrive_setup_process_killed` flag helps prevent raising errors in case the
         process was killed manually.

datashuttle/tui/screens/setup_gdrive.py

@@ -138,7 +138,7 @@ def on_button_pressed(self, event: Button.Pressed) -> None:
     def ask_user_for_browser(self) -> None:
         """Ask the user if their machine has access to a browser."""
         message = (
-            "Are you running Datashuttle on a machine "
+            "Are you running datashuttle on a machine "
             "that can open a web browser?"
         )
         self.update_message_box_message(message)
@@ -185,7 +185,7 @@ def open_browser_and_setup_gdrive_connection(
         The connection setup is asynchronous so that the user is able to
         cancel the setup if anything goes wrong without quitting datashuttle altogether.
         """
-        message = "Please authenticate through browser."
+        message = "Please authenticate through browser (it should open automatically)."
         self.update_message_box_message(message)
 
         asyncio.create_task(
@@ -241,7 +241,7 @@ async def setup_gdrive_connection_and_update_ui(
 
         The setup is run in a worker thread to avoid blocking the UI so that
         the user can cancel the setup if needed. This function starts the worker
-        thread for google drive setup, sets `self.setup_worker` to the worker and
+        thread for Google Drive setup, sets `self.setup_worker` to the worker and
         awaits the worker to finish. After completion, it displays a
         success / failure screen. The setup on the lower level is a bit complicated.
         The worker thread runs the `setup_google_drive_connection` method of the

datashuttle/tui/shared/configs_content.py

@@ -129,13 +129,13 @@ def compose(self) -> ComposeResult:
             Label("Root Folder ID", id="configs_gdrive_root_folder_id_label"),
             ClickableInput(
                 self.parent_class.mainwindow,
-                placeholder="Google Drive Root Folder ID",
+                placeholder="e.g. 1KAN9QLD2K2EANE",
                 id="configs_gdrive_root_folder_id_input",
             ),
             Label("Client ID (Optional)", id="configs_gdrive_client_id_label"),
             ClickableInput(
                 self.parent_class.mainwindow,
-                placeholder="Google Drive Client ID (Optional)",
+                placeholder="e.g. 93412981629-2icf0ba09cks9.apps.googleusercontent.com",
                 id="configs_gdrive_client_id_input",
             ),
         ]
@@ -144,7 +144,7 @@ def compose(self) -> ComposeResult:
             Label("AWS Access Key ID", id="configs_aws_access_key_id_label"),
             ClickableInput(
                 self.parent_class.mainwindow,
-                placeholder="AWS Access Key ID eg. EJIBCLSIP2K2PQK3CDON",
+                placeholder="eg. EJIBCLSIP2K2PQK3CDON",
                 id="configs_aws_access_key_id_input",
             ),
             Label("AWS S3 Region", id="configs_aws_region_label"),
@@ -187,7 +187,7 @@ def compose(self) -> ComposeResult:
                     id=self.radiobutton_id_from_connection_method("gdrive"),
                 ),
                 RadioButton(
-                    "AWS S3",
+                    "AWS S3 Bucket",
                     id=self.radiobutton_id_from_connection_method("aws"),
                 ),
                 id="configs_connect_method_radioset",
@@ -231,7 +231,7 @@ def compose(self) -> ComposeResult:
             Horizontal(
                 Static(
                     "Set your configurations for a new project. For more "
-                    "details on each section,\nsee the Datashuttle "
+                    "details on each section,\nsee the datashuttle "
                     "documentation. Once configs are set, you will "
                     "be able\nto use the 'Create' and 'Transfer' tabs.",
                     id="configs_info_label",
@@ -276,21 +276,18 @@ def on_mount(self) -> None:
                 ]
             )
         else:
-            self.query_one(
-                "#configs_local_filesystem_radiobutton"
-            ).value = True
+            self.query_one("#configs_local_only_radiobutton").value = True
 
-            self.setup_widgets_to_display(connection_method="local_filesystem")
+            self.setup_widgets_to_display(connection_method=None)
 
         # Setup tooltips
         if not self.interface:
             id = "#configs_name_input"
             self.query_one(id).tooltip = get_tooltip(id)
 
-            # Assumes 'local_filesystem' is default if no project set.
+            # Assumes local-only is default if no project set.
             assert (
-                self.query_one("#configs_local_filesystem_radiobutton").value
-                is True
+                self.query_one("#configs_local_only_radiobutton").value is True
             )
 
         for id in [
@@ -303,6 +300,8 @@ def on_mount(self) -> None:
             "#configs_central_host_id_input",
             "#configs_gdrive_client_id_input",
             "#configs_gdrive_root_folder_id_input",
+            "#configs_aws_access_key_id_input",
+            "#configs_aws_region_select",
         ]:
             self.query_one(id).tooltip = get_tooltip(id)
 
@@ -323,7 +322,7 @@ def on_radio_set_changed(self, event: RadioSet.Changed) -> None:
             "Local Filesystem",
             "No connection (local only)",
             "Google Drive",
-            "AWS S3",
+            "AWS S3 Bucket",
         ], "Unexpected label."
 
         connection_method = self.connection_method_from_radiobutton_id(
@@ -359,11 +358,9 @@ def connection_method_from_radiobutton_id(
     def set_central_path_input_tooltip(
         self, connection_method: str | None
     ) -> None:
-        """Set tooltip depending on whether connection method is SSH or local filesystem."""
+        """Set tooltip depending on the connection method."""
         if connection_method is None:
-            tooltip = get_tooltip(
-                "config_central_path_input_mode-local_filesystem"
-            )
+            tooltip = get_tooltip("config_central_path_input_mode-local_only")
         else:
             tooltip = get_tooltip(
                 f"config_central_path_input_mode-{connection_method}"
@@ -396,9 +393,10 @@ def get_platform_dependent_example_paths(
         ):
             if connection_method == "ssh":
                 example_path = "e.g. /nfs/path_on_server/myprojects/central"
-            elif connection_method in ["aws", "gdrive"]:
+            elif connection_method == "aws":
+                example_path = "my-bucket-name/my-folder"
+            elif connection_method == "gdrive":
                 example_path = ""
-
         else:
             if platform.system() == "Windows":
                 example_path = rf"e.g. C:\path\to\{local_or_central}\my_projects\my_first_project"
@@ -799,7 +797,7 @@ def setup_widgets_to_display(self, connection_method: str | None) -> None:
 
         # Central Path Label
         central_path_label = self.query_one("#configs_central_path_label")
-        if connection_method in ["gdrive", "aws"]:
+        if connection_method == "gdrive":
             central_path_label.update(content="Central Path (Optional)")
         else:
             central_path_label.update(content="Central Path")

datashuttle/tui/tooltips.py

@@ -62,16 +62,20 @@ def get_tooltip(id: str) -> str:
             "to a project folder, possibly on a mounted drive.\n\n"
         )
 
+    elif id == "config_central_path_input_mode-local_only":
+        tooltip = "Central Path is not required in local-only mode."
+
     elif id == "config_central_path_input_mode-aws":
         tooltip = (
-            "The path to the project folder within the aws bucket.\n"
-            "Leave blank if the aws bucket is the project folder."
+            "The path to the project folder within the AWS bucket.\n\n"
+            "The first part must be the bucket name. To transfer directly "
+            "into the bucket, use only the bucket name."
         )
 
     elif id == "config_central_path_input_mode-gdrive":
         tooltip = (
-            "The path to the project folder within the google drive folder.\n"
-            "Leave blank if the google drive folder is the project folder."
+            "The path to the project folder within the Google Drive folder.\n\n"
+            "Leave blank if the Google Drive folder is the project folder."
         )
     # Google Drive configs
     # -------------------------------------------------------------------------
@@ -81,15 +85,28 @@ def get_tooltip(id: str) -> str:
         tooltip = (
             "The Google Drive Client ID to use for authentication.\n\n"
             "It can be obtained by creating an OAuth 2.0 client in the Google Cloud Console.\n\n"
-            "Can be left empty to use rclone's default client (slower)"
+            "Can be left empty to use Rclone's default client (may be slower)"
         )
 
     elif id == "#configs_gdrive_root_folder_id_input":
         tooltip = (
             "The Google Drive root folder ID to use for transfer.\n\n"
-            "It can be obtained by navigating to the folder in Google Drive and copying the ID from the URL.\n\n"
+            "It can be obtained by navigating to the folder in Google Drive "
+            "and copying the ID from the URL\n(the code after the /folders/ section).\n\n"
         )
 
+    # AWS configs
+    # -------------------------------------------------------------------------
+
+    elif id == "#configs_aws_access_key_id_input":
+        tooltip = (
+            "The Amazon IAM Access Key ID.\n\n"
+            "Manage or create one in the AWS Console under IAM settings."
+        )
+
+    elif id == "#configs_aws_region_select":
+        tooltip = "Select the region for the S3 Bucket you are connecting to."
+
     # Settings
     # -------------------------------------------------------------------------
 

datashuttle/utils/gdrive.py

@@ -80,7 +80,7 @@ def preliminary_for_setup_without_browser(
 
 def ask_user_for_browser(log: bool = True) -> bool:
     """Ask the user if they have access to an internet browser, for Google Drive set up."""
-    message = "Are you running Datashuttle on a machine with access to a web browser? (y/n): "
+    message = "Are you running datashuttle on a machine with access to a web browser? (y/n): "
     input_ = utils.get_user_input(message).lower()
 
     while input_ not in ["y", "n"]:

tests/tests_integration/test_configs.py

@@ -292,8 +292,7 @@ def test_connection_method_required_args(
             assert no_cfg_project.cfg["central_path"] is None
 
     @pytest.mark.parametrize(
-        "connection_method",
-        ["aws"],  # "local_filesystem", "ssh", "gdrive", "
+        "connection_method", ["aws", "local_filesystem", "ssh", "gdrive"]
     )
     def test_get_base_folder(
         self, tmp_path, no_cfg_project, connection_method

tests/tests_tui/gdrive/test_tui_setup_gdrive.py

@@ -215,7 +215,7 @@ async def test_cancel_gdrive_connection_setup(self, setup_project_paths):
             # Setup connection and cancel midway
             await self.setup_gdrive_connection_via_tui(pilot)
             assert (
-                "Please authenticate through browser."
+                "Please authenticate through browser"
                 in pilot.app.screen.query_one(
                     "#gdrive_setup_messagebox_message"
                 ).renderable
@@ -227,7 +227,7 @@ async def test_cancel_gdrive_connection_setup(self, setup_project_paths):
             # Try setting up the connection again
             await self.setup_gdrive_connection_via_tui(pilot)
             assert (
-                "Please authenticate through browser."
+                "Please authenticate through browser"
                 in pilot.app.screen.query_one(
                     "#gdrive_setup_messagebox_message"
                 ).renderable
@@ -302,7 +302,7 @@ async def setup_gdrive_connection_via_tui(
         await self.scroll_to_click_pause(pilot, "#setup_gdrive_enter_button")
 
         assert (
-            "Are you running Datashuttle on a machine "
+            "Are you running datashuttle on a machine "
             "that can open a web browser?"
             in pilot.app.screen.query_one(
                 "#gdrive_setup_messagebox_message"

tests/tests_tui/test_local_only_project.py

@@ -205,6 +205,10 @@ async def setup_and_check_local_only_project(
             "#new_project_configs_content"
         )
 
+        await self.scroll_to_click_pause(
+            pilot, "#configs_local_filesystem_radiobutton"
+        )
+
         # Input `local_path` and placeholder text in `central_path` which
         # will be deleted when the no-connection option is selected.
         await self.fill_input(pilot, "#configs_name_input", project_name)

tests/tests_tui/test_tui_configs.py

@@ -20,7 +20,7 @@ class TestTuiConfigs(TuiConfigsBase):
 
     @pytest.mark.asyncio
     @pytest.mark.parametrize("kwargs_set", [1, 2])
-    async def test_make_new_project_configs(
+    async def test_make_new_project_configs__(
         self,
         empty_project_paths,
         kwargs_set,
@@ -69,7 +69,9 @@ async def test_make_new_project_configs(
                 pilot,
                 project_name,
                 tmp_config_path,
-                connection_method_name="SSH" if kwargs_set == 2 else "",
+                connection_method_name="SSH"
+                if kwargs_set == 2
+                else "Local Filesystem",
                 config_kwargs=kwargs,
             )
 
@@ -165,6 +167,10 @@ async def test_configs_select_path(self, monkeypatch):
                 "#new_project_configs_content"
             )
 
+            await self.scroll_to_click_pause(
+                pilot, "#configs_local_filesystem_radiobutton"
+            )
+
             local_path_button = pilot.app.screen.query_one(
                 "#configs_local_path_select_button"
             )

tests/tests_tui/test_tui_widgets_and_defaults.py

@@ -52,7 +52,7 @@ async def test_new_project_configs(self, empty_project_paths):
             assert (
                 configs_content.query_one("#configs_info_label").renderable
                 == "Set your configurations for a new project. For more details on "
-                "each section,\nsee the Datashuttle documentation. Once configs "
+                "each section,\nsee the datashuttle documentation. Once configs "
                 "are set, you will be able\nto use the 'Create' and 'Transfer' tabs."
             )
 
@@ -108,7 +108,11 @@ async def test_new_project_configs(self, empty_project_paths):
                 configs_content.query_one(
                     "#configs_connect_method_radioset"
                 ).pressed_button.label._text
-                == "Local Filesystem"
+                == "No connection (local only)"
+            )
+
+            await self.scroll_to_click_pause(
+                pilot, "#configs_local_filesystem_radiobutton"
             )
 
             # Central Path (Local Filesystem) ------------------------------------------