Merge pull request #589 from neuroinformatics-unit/skip_aws_gdrive_tests

Skip AWS and GDRIVE tests when environment variables not set.

Author: JoeZiminski

.github/workflows/code_test_and_deploy.yml

@@ -87,15 +87,6 @@ jobs:
           pytest tests/tests_transfers/aws
 
       - name: All Other Tests
-        env:
-          GDRIVE_CLIENT_ID: ${{ secrets.GDRIVE_CLIENT_ID }}
-          GDRIVE_CLIENT_SECRET: ${{ secrets.GDRIVE_CLIENT_SECRET }}
-          GDRIVE_ROOT_FOLDER_ID: ${{ secrets.GDRIVE_ROOT_FOLDER_ID }}
-          GDRIVE_CONFIG_TOKEN: ${{ secrets.GDRIVE_CONFIG_TOKEN }}
-          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 --ignore=tests/tests_transfers/ssh --ignore=tests/tests_transfers/gdrive --ignore=tests/tests_transfers/aws
 

tests/tests_transfers/aws/aws_test_utils.py

@@ -42,3 +42,15 @@ def setup_aws_connection(project: DataShuttle):
     project.setup_aws_connection()
 
     aws.get_aws_secret_access_key = original_get_secret
+
+
+def has_aws_environment_variables():
+    for key in [
+        "AWS_BUCKET_NAME",
+        "AWS_ACCESS_KEY_ID",
+        "AWS_REGION",
+        "AWS_SECRET_ACCESS_KEY",
+    ]:
+        if key not in os.environ:
+            return False
+    return True

tests/tests_transfers/aws/test_aws_transfer.py

@@ -6,6 +6,10 @@
 from . import aws_test_utils
 
 
+@pytest.mark.skipif(
+    not aws_test_utils.has_aws_environment_variables(),
+    reason="AWS set up environment variables must be set.",
+)
 class TestAwsTransfer(BaseTransfer):
     @pytest.fixture(
         scope="class",

tests/tests_tui/aws/test_tui_setup_aws.py renamed to tests/tests_transfers/aws/test_tui_setup_aws.py

@@ -6,10 +6,21 @@
 from datashuttle.tui.screens.project_manager import ProjectManagerScreen
 from datashuttle.utils import rclone, utils
 
-from ..tui_base import TuiBase
+from ...tests_tui.tui_base import TuiBase
+from . import aws_test_utils
 
 
+@pytest.mark.skipif(
+    not aws_test_utils.has_aws_environment_variables(),
+    reason="AWS set up environment variables must be set.",
+)
 class TestTuiSetupAws(TuiBase):
+    """
+    Set up the connection to AWS via the TUI. These tests require
+    environment variables to be set to allow the full set up,
+    like other transfer tests.
+    """
+
     @pytest.fixture(scope="function")
     def central_path_and_project(self, setup_project_paths):
         tmp_config_path, tmp_path, project_name = setup_project_paths.values()

tests/tests_transfers/gdrive/gdrive_test_utils.py

@@ -56,3 +56,15 @@ def mock_input(_: str) -> str:
 
     builtins.input = original_input
     gdrive.get_client_secret = original_get_secret
+
+
+def has_gdrive_environment_variables():
+    for key in [
+        "GDRIVE_CLIENT_ID",
+        "GDRIVE_ROOT_FOLDER_ID",
+        "GDRIVE_CONFIG_TOKEN",
+        "GDRIVE_CLIENT_SECRET",
+    ]:
+        if key not in os.environ:
+            return False
+    return True

tests/tests_transfers/gdrive/test_gdrive_transfer.py

@@ -6,6 +6,10 @@
 from . import gdrive_test_utils
 
 
+@pytest.mark.skipif(
+    not gdrive_test_utils.has_gdrive_environment_variables(),
+    reason="Google Drive set up environment variables must be set.",
+)
 class TestGdriveTransfer(BaseTransfer):
     @pytest.fixture(
         scope="class",

tests/tests_tui/gdrive/test_tui_setup_gdrive.py renamed to tests/tests_transfers/gdrive/test_tui_setup_gdrive.py

@@ -7,10 +7,21 @@
 from datashuttle.utils import rclone, utils
 
 from ... import test_utils
-from ..tui_base import TuiBase
+from ...tests_tui.tui_base import TuiBase
+from . import gdrive_test_utils
 
 
+@pytest.mark.skipif(
+    not gdrive_test_utils.has_gdrive_environment_variables(),
+    reason="Google Drive set up environment variables must be set.",
+)
 class TestTuiSetupGdrive(TuiBase):
+    """
+    Set up the connection to GDrive via the TUI. These tests require
+    environment variables to be set to allow the full set up,
+    like other transfer tests.
+    """
+
     @pytest.fixture(scope="function")
     def central_path_and_project(self, setup_project_paths):
         tmp_config_path, tmp_path, project_name = setup_project_paths.values()

tests/tests_tui/gdrive/__init__.py

@@ -4,7 +4,7 @@
 
 from datashuttle.tui.app import TuiApp
 
-from ..tui_configs_base import TuiConfigsBase
+from .tui_configs_base import TuiConfigsBase
 
 
 class TestTuiAwsConfigs(TuiConfigsBase):

tests/tests_tui/aws/test_tui_aws_configs.py renamed to tests/tests_tui/test_tui_aws_configs.py

@@ -4,7 +4,7 @@
 
 from datashuttle.tui.app import TuiApp
 
-from ..tui_configs_base import TuiConfigsBase
+from .tui_configs_base import TuiConfigsBase
 
 
 class TestTuiGdriveConfigs(TuiConfigsBase):