Finalise aws and other tests, revert changes made to setup_aws during erroneous 'fix linting' PR.

JoeZiminski · JoeZiminski · commit 3a68ff8f71f5 · 2025-11-03T15:43:21.000Z
diff --git a/.github/workflows/code_test_and_deploy.yml b/.github/workflows/code_test_and_deploy.yml
@@ -85,7 +85,6 @@ jobs:
           FPR="$(gpg --list-secret-keys --with-colons | awk -F: '/^fpr:/ {print $10; exit}')"
           pass init "$FPR"
 
-
         # run SSH tests only on Linux because Windows and macOS
         # are already run within a virtual container and so cannot
         # run Linux containers because nested containerisation is disabled.
@@ -104,22 +103,18 @@ jobs:
         run: |
           pytest tests/tests_transfers/gdrive
 
-#      - name: Test AWS
-#        env:
-#          AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }}
-#          AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
-#          AWS_REGION: ${{ secrets.AWS_REGION }}
-#          AWS_BUCKET_NAME: ${{ secrets.AWS_BUCKET_NAME }}
-#        run: |
-#          pytest tests/tests_transfers/aws
-
-#      - name: All Other Tests
-#        run: |
-#          pytest --ignore=tests/tests_transfers/ssh --ignore=tests/tests_transfers/gdrive --ignore=tests/tests_transfers/aws
+      - name: Test AWS
+        env:
+          AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }}
+          AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
+          AWS_REGION: ${{ secrets.AWS_REGION }}
+          AWS_BUCKET_NAME: ${{ secrets.AWS_BUCKET_NAME }}
+        run: |
+          pytest tests/tests_transfers/aws
 
-      - name: RClone Encryption
+      - name: All Other Tests
         run: |
-          pytest -k test_rclone_encryption
+          pytest --ignore=tests/tests_transfers/ssh --ignore=tests/tests_transfers/gdrive --ignore=tests/tests_transfers/aws
 
   build_sdist_wheels:
     name: Build source distribution
diff --git a/datashuttle/tui/screens/setup_aws.py b/datashuttle/tui/screens/setup_aws.py
@@ -11,6 +11,8 @@
 from textual.screen import ModalScreen
 from textual.widgets import Button, Input, Static
 
+from datashuttle.utils import rclone_encryption
+
 
 class SetupAwsScreen(ModalScreen):
     """Dialog window that sets up connection to an Amazon Web Service S3 bucket.
@@ -26,7 +28,7 @@ def __init__(self, interface: Interface) -> None:
         super(SetupAwsScreen, self).__init__()
 
         self.interface = interface
-        self.stage = 0
+        self.stage = "init"
 
     def compose(self) -> ComposeResult:
         """Set widgets on the SetupAwsScreen."""
@@ -52,18 +54,35 @@ def on_mount(self) -> None:
         self.query_one("#setup_aws_secret_access_key_input").visible = False
 
     def on_button_pressed(self, event: Button.Pressed) -> None:
-        """Handle button press on the screen."""
+        """Handle button press on the screen.
+
+        The `setup_aws_ok_button` is used for all 'positive' events ('Yes, Ok')
+        and 'setup_aws_cancel_button' is used for 'negative' events ('No', 'Cancel').
+        The appropriate action to take on the button press is determined by the
+        current stage.
+
+        """
         if event.button.id == "setup_aws_cancel_button":
-            self.dismiss()
+            if self.stage == "ask_rclone_encryption":
+                message = "AWS Connection Successful!"  #
+                self.query_one("#setup_aws_messagebox_message").update(message)
+                self.query_one("#setup_aws_ok_button").label = "Finish"
+                self.query_one("#setup_aws_cancel_button").remove()
+                self.stage = "finished"
+            else:
+                self.dismiss()
 
-        if event.button.id == "setup_aws_ok_button":
-            if self.stage == 0:
+        elif event.button.id == "setup_aws_ok_button":
+            if self.stage == "init":
                 self.prompt_user_for_aws_secret_access_key()
 
-            elif self.stage == 1:
+            elif self.stage == "use_secret_access_key":
                 self.use_secret_access_key_to_setup_aws_connection()
 
-            elif self.stage == 2:
+            elif self.stage == "ask_rclone_encryption":
+                self.set_rclone_encryption()
+
+            elif self.stage == "finished":
                 self.dismiss()
 
     def prompt_user_for_aws_secret_access_key(self) -> None:
@@ -73,10 +92,15 @@ def prompt_user_for_aws_secret_access_key(self) -> None:
         self.query_one("#setup_aws_messagebox_message").update(message)
         self.query_one("#setup_aws_secret_access_key_input").visible = True
 
-        self.stage += 1
+        self.query_one("#setup_aws_ok_button")
+
+        self.stage = "use_secret_access_key"
 
     def use_secret_access_key_to_setup_aws_connection(self) -> None:
-        """Set up the AWS connection and inform user of success or failure."""
+        """Set up the AWS connection and failure.
+
+        If success, move onto the rclone_encryption screen.
+        """
         secret_access_key = self.query_one(
             "#setup_aws_secret_access_key_input"
         ).value
@@ -86,11 +110,13 @@ def use_secret_access_key_to_setup_aws_connection(self) -> None:
         )
 
         if success:
-            message = "AWS Connection Successful!"
-            self.query_one(
-                "#setup_aws_secret_access_key_input"
-            ).visible = False
+            message = f"{rclone_encryption.get_explanation_message(self.interface.project.cfg)}"
+            self.query_one("#setup_aws_messagebox_message").update(message)
 
+            self.query_one("#setup_aws_secret_access_key_input").remove()
+            self.query_one("#setup_aws_ok_button").label = "Yes"
+            self.query_one("#setup_aws_cancel_button").label = "No"
+            self.stage = "ask_rclone_encryption"
         else:
             message = (
                 f"AWS setup failed. Please check your configs and secret access key"
@@ -100,7 +126,23 @@ def use_secret_access_key_to_setup_aws_connection(self) -> None:
                 "#setup_aws_secret_access_key_input"
             ).disabled = True
 
-        self.query_one("#setup_aws_ok_button").label = "Finish"
-        self.query_one("#setup_aws_messagebox_message").update(message)
-        self.query_one("#setup_aws_cancel_button").disabled = True
-        self.stage += 1
+            self.query_one("#setup_aws_ok_button").label = "Retry"
+            self.query_one("#setup_aws_messagebox_message").update(message)
+
+    def set_rclone_encryption(self):
+        """Try and encrypt the Rclone config file and inform the user of success / failure."""
+        success, output = self.interface.try_setup_rclone_encryption()
+
+        if success:
+            message = (
+                "The rclone_encryption was successfully set. Setup complete!"
+            )
+            self.query_one("#setup_aws_messagebox_message").update(message)
+            self.query_one("#setup_aws_ok_button").label = "Finish"
+            self.query_one("#setup_aws_cancel_button").remove()
+            self.stage = "finished"
+        else:
+            message = (
+                f"The rclone_encryption set up failed. Exception: {output}"
+            )
+            self.query_one("#setup_aws_messagebox_message").update(message)
diff --git a/datashuttle/tui/screens/setup_gdrive.py b/datashuttle/tui/screens/setup_gdrive.py
@@ -357,7 +357,7 @@ def set_rclone_encryption(self):
 
         if success:
             self.set_finish_page(
-                "The password was successfully set. Setup complete!"
+                "The encryption was successful. Setup complete!"
             )
         else:
             message = f"The password set up failed. Exception: {output}"
diff --git a/tests/test_utils.py b/tests/test_utils.py
@@ -432,6 +432,13 @@ def check_config_file(config_path, *kwargs):
             assert value == config_yaml[name], f"{name}"
 
 
+def check_rclone_file_is_encrypted(rclone_config_path):
+    with open(rclone_config_path, "r", encoding="utf-8") as file:
+        first_line = file.readline().strip()
+
+    assert first_line == "# Encrypted rclone configuration File"
+
+
 # -----------------------------------------------------------------------------
 # Test Helpers
 # -----------------------------------------------------------------------------
diff --git a/tests/tests_integration/test_rclone_encryption.py b/tests/tests_integration/test_rclone_encryption.py
@@ -2,6 +2,7 @@
 
 from datashuttle.utils import rclone_encryption
 
+from .. import test_utils
 from ..base import BaseTest
 from ..tests_transfers.ssh import ssh_test_utils
 
@@ -42,10 +43,7 @@ def test_set_and_remove_password(self, project):
 
         assert "RCLONE_PASSWORD_COMMAND" not in os.environ
 
-        with open(rclone_config_path, "r", encoding="utf-8") as f:
-            first_line = f.readline().strip()
-
-        assert first_line == "# Encrypted rclone configuration File"
+        test_utils.check_rclone_file_is_encrypted(rclone_config_path)
 
         rclone_encryption.remove_rclone_encryption(project.cfg)
 
diff --git a/tests/tests_transfers/aws/test_tui_setup_aws.py b/tests/tests_transfers/aws/test_tui_setup_aws.py
@@ -2,10 +2,12 @@
 
 import pytest
 
+from datashuttle import DataShuttle
 from datashuttle.tui.app import TuiApp
 from datashuttle.tui.screens.project_manager import ProjectManagerScreen
 from datashuttle.utils import rclone, utils
 
+from ... import test_utils
 from ...tests_tui.tui_base import TuiBase
 from . import aws_test_utils
 
@@ -31,12 +33,18 @@ def central_path_and_project(self, setup_project_paths):
 
         yield central_path, project_name
 
-        rclone.call_rclone(
-            f"purge central_{project_name}_aws:{central_path}"
-        )  # TODO: I think this will fail, needs config
+        project = DataShuttle(project_name)
+
+        rclone.call_rclone_for_central_connection(
+            project.cfg,
+            f"purge central_{project_name}_aws:{central_path} {rclone.get_config_arg(project.cfg)}",
+        )
 
     @pytest.mark.asyncio
-    async def test_aws_connection_setup(self, central_path_and_project):
+    @pytest.mark.parametrize("set_encryption", [True, False])
+    async def test_aws_connection_setup(
+        self, central_path_and_project, set_encryption
+    ):
         """Test AWS connection setup via the TUI.
 
         AWS connection details are filled in the configs tab. The setup
@@ -60,12 +68,40 @@ async def test_aws_connection_setup(self, central_path_and_project):
             )
 
             assert (
-                "AWS Connection Successful!"
+                "Would you like to encrypt the RClone config file"
                 in pilot.app.screen.query_one(
                     "#setup_aws_messagebox_message"
                 ).renderable
             )
 
+            if set_encryption:
+                await self.scroll_to_click_pause(pilot, "#setup_aws_ok_button")
+
+                assert (
+                    "The rclone_encryption was successfully set. Setup complete!"
+                    in pilot.app.screen.query_one(
+                        "#setup_aws_messagebox_message"
+                    ).renderable
+                )
+
+                project = pilot.app.screen.interface.project
+
+                test_utils.check_rclone_file_is_encrypted(
+                    project.cfg.rclone.get_rclone_central_connection_config_filepath()
+                )
+
+            else:
+                await self.scroll_to_click_pause(
+                    pilot, "#setup_aws_cancel_button"
+                )
+
+                assert (
+                    "AWS Connection Successful!"
+                    in pilot.app.screen.query_one(
+                        "#setup_aws_messagebox_message"
+                    ).renderable
+                )
+
     @pytest.mark.asyncio
     async def test_aws_connection_setup_failed(self, central_path_and_project):
         """Test AWS connection setup using an incorrect client secret and check
diff --git a/tests/tests_transfers/gdrive/test_tui_setup_gdrive.py b/tests/tests_transfers/gdrive/test_tui_setup_gdrive.py
@@ -117,12 +117,18 @@ async def test_gdrive_connection_setup_without_browser(
                 )
 
                 assert (
-                    "The password was successfully set. Setup complete!"
+                    "The encryption was successful. Setup complete!"
                     in pilot.app.screen.query_one(
                         "#gdrive_setup_messagebox_message"
                     ).renderable
                 )
 
+                project = pilot.app.screen.interface.project
+
+                test_utils.check_rclone_file_is_encrypted(
+                    project.cfg.rclone.get_rclone_central_connection_config_filepath()
+                )
+
             else:
                 await self.scroll_to_click_pause(
                     pilot, "#setup_gdrive_set_encryption_no_button"
diff --git a/tests/tests_transfers/ssh/test_ssh_transfer.py b/tests/tests_transfers/ssh/test_ssh_transfer.py
@@ -3,6 +3,7 @@
 
 import pytest
 
+from ... import test_utils
 from . import ssh_test_utils
 from .base_ssh import BaseSSHTransfer
 
@@ -157,3 +158,11 @@ def test_ssh_wildcards_3(self, ssh_setup):
         self.run_and_check_transfers(
             project, sub_names, ses_names, datatype, expected_transferred_paths
         )
+
+    def test_rclone_config_file_encrypted(self, ssh_setup):
+        """Quick confidence check the set up rclone config is indeed ecrypted."""
+        pathtable, project = ssh_setup
+
+        test_utils.check_rclone_file_is_encrypted(
+            project.cfg.rclone.get_rclone_central_connection_config_filepath()
+        )

Original file line number	Diff line number	Diff line change
`@@ -357,7 +357,7 @@ def set_rclone_encryption(self):`
`357`	`357`
`358`	`358`	`if success:`
`359`	`359`	`self.set_finish_page(`
`360`		`- "The password was successfully set. Setup complete!"`
	`360`	`+ "The encryption was successful. Setup complete!"`
`361`	`361`	`)`
`362`	`362`	`else:`
`363`	`363`	`message = f"The password set up failed. Exception: {output}"`