Implemented test-credentials

Author: Victor Machado

Diff for: .github/workflows/test-credentials.yml

@@ -0,0 +1,35 @@
+name: Test "froster credentials" command
+
+run-name: Test "froster credentials" command
+
+on: [push, pull_request]
+
+jobs:
+  froster-index:
+    runs-on: ubuntu-latest
+    steps:
+
+      - uses: actions/checkout@v4
+        with:
+          ref: ${{ github.ref }}
+
+      - name: Set up Python
+        uses: actions/setup-python@v3
+        with:
+          python-version: '3.10'
+
+      - name: Create and activate virtual environment
+        run: |
+          python -m venv .venv
+          source .venv/bin/activate
+
+      - name: Install froster locally
+        env:
+          LOCAL_INSTALL: true
+        run: ./install.sh
+
+      - name: Run test_credentials tests
+        env:
+          AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }}
+          AWS_SECRET: ${{ secrets.AWS_SECRET }}
+        run: python3 tests/test_credentials.py

Diff for: .github/workflows/test-froster-index.yml renamed to .github/workflows/test-index.yml

@@ -26,10 +26,10 @@ jobs:
 
       - name: Create and activate virtual environment
         run: |
-          python -m venv venv
-          source venv/bin/activate
+          python -m venv .venv
+          source .venv/bin/activate
 
-      - name: Install froster
+      - name: Install froster locally
         env:
           LOCAL_INSTALL: true
         run: ./install.sh

Diff for: .vscode/settings.json

@@ -3,5 +3,8 @@
         "-c",
         "source .venv/bin/activate"
     ],
-    "python.pythonPath": ".venv/bin/python"
+    "python.pythonPath": ".venv/bin/python",
+    "python.analysis.extraPaths": [
+        "./tests"
+    ]
 }

Diff for: froster/froster.py

@@ -7533,9 +7533,7 @@ def main():
         if cfg.check_update():
             cmd.subcmd_update(mute_no_update=True)
 
-        if res:
-            sys.exit(0)
-        else:
+        if not res:
             sys.exit(1)
 
     except KeyboardInterrupt:

Diff for: tests/config.py

@@ -4,20 +4,26 @@
 import string
 import tempfile
 
-
 def random_string(length=4):
     return ''.join(random.choices(string.ascii_lowercase + string.digits, k=length))
 
-NAME = "Test-Bob"
-NAME_2 = "Test-Alice"
-EMAIL = "[email protected]"
+NAME_1 = "bob"
+NAME_2 = "alice"
+
+EMAIL_1 = "[email protected]"
 EMAIL_2 = "[email protected]"
 
-AWS_DEFAULT_PATH = os.path.join(tempfile.gettempdir(), '.aws')
-AWS_REGION = "eu-west-1"
+PROVIDER_1 = "AWS"
+PROVIDER_2 = "AWS"
+
+PROFILE_1 = "profile bob"
+PROFILE_2 = "profile alice"
+
+AWS_CREDENTIALS_PROFILE_1 = "bob"
+AWS_CREDENTIALS_PROFILE_2 = "alice"
+
+AWS_REGION_1 = "eu-west-2"
 AWS_REGION_2 = "eu-west-2"
-AWS_PROFILE = "froster-unittest-bob"
-AWS_PROFILE_2 = "froster-unittest-alice"
 
 AWS_ACCESS_KEY_ID = os.getenv('AWS_ACCESS_KEY_ID')
 AWS_SECRET = os.getenv('AWS_SECRET')
@@ -28,15 +34,19 @@ def random_string(length=4):
 NIH_SECTION = 'NIH'
 S3_SECTION = 'S3'
 
-S3_BUCKET_NAME_CONFIG = 'froster-unittest-config-' + random_string(4)
+S3_BUCKET_NAME_CONFIG_1 = 'froster-unittest-config-' + random_string(4)
 S3_BUCKET_NAME_CONFIG_2 = 'froster-unittest-config-' + random_string(4)
 
-S3_BUCKET_NAME_INDEX = 'froster-unittest-index-' + random_string(4)
+S3_BUCKET_NAME_INDEX_1 = 'froster-unittest-index-' + random_string(4)
 S3_BUCKET_NAME_INDEX_2 = 'froster-unittest-index-' + random_string(4)
 
-S3_ARCHIVE_DIR = 'froster_bob'
-S3_ARCHIVE_DIR_2 = 'froster_alice'
-S3_STORAGE_CLASS = 'DEEP_ARCHIVE'
+S3_BUCKET_NAME_CREDENTIALS_1 = 'froster-unittest-credentials-' + random_string(4)
+S3_BUCKET_NAME_CREDENTIALS_2 = 'froster-unittest-credentials-' + random_string(4)
+
+S3_ARCHIVE_DIR_1 = 'froster-bob'
+S3_ARCHIVE_DIR_2 = 'froster-alice'
+
+S3_STORAGE_CLASS_1 = 'DEEP_ARCHIVE'
 S3_STORAGE_CLASS_2 = 'GLACIER'
 
 SLURM_WALLTIME_DAYS = 8

Diff for: tests/test_credentials.py

@@ -0,0 +1,86 @@
+import sys
+import unittest
+from unittest.mock import patch
+from froster import *
+from tests.config import *
+
+
+class TestCredentials(unittest.TestCase):
+    '''Test the froster credentials command.'''
+
+    # Method executed once before all tests
+    @classmethod
+    def setUpClass(cls):
+        '''- Set up class.'''
+
+        # Setup the froster configuration by mocking user input
+        with \
+                patch('sys.argv', ['froster', 'config']), \
+                patch('inquirer.text', side_effect=[NAME_1, EMAIL_1, PROFILE_1, AWS_CREDENTIALS_PROFILE_1, AWS_ACCESS_KEY_ID, AWS_SECRET, S3_BUCKET_NAME_CREDENTIALS_1, S3_ARCHIVE_DIR_1]), \
+                patch('inquirer.confirm', side_effect=[False, False, True, False]), \
+                patch('inquirer.list_input', side_effect=['+ Create new profile', PROVIDER_1, '+ Create new credentials', AWS_REGION_1, '+ Create new bucket', S3_STORAGE_CLASS_1]), \
+                patch('builtins.print') as mock_print:
+            main()
+
+    # Method executed once after all tests
+
+    @classmethod
+    def tearDownClass(cls):
+        '''- Tear down class.'''
+
+        # Delete the S3 buckets
+        with \
+                patch('sys.argv', ['froster', '--debug', 'delete', '--bucket', S3_BUCKET_NAME_CONFIG_1]), \
+                patch('builtins.print') as mock_print:
+            main()
+
+        with \
+                patch('sys.argv', ['froster', '--debug', 'delete', '--bucket', S3_BUCKET_NAME_CONFIG_2]), \
+                patch('builtins.print') as mock_print:
+            main()
+
+    def test_subcmd_credentials(self):
+        '''- Test the froster credentials command.'''
+
+        # Run the index command and check if sys.exit(0), which means no issues detected while executing the command
+        with \
+                patch('sys.argv', ['froster', 'credentials']), \
+                patch('builtins.print') as mock_print:
+            self.assertFalse(main())
+
+
+if __name__ == '__main__':
+
+    try:
+        if True:
+            unittest.main(verbosity=2)
+        else:
+            suite = unittest.TestSuite()
+            # FULL CONFIGURATION
+            # suite.addTests(unittest.TestLoader().loadTestsFromTestCase(TestConfig))
+
+            # PARTIAL CONFIGURATION
+            # suite.addTests(unittest.TestLoader().loadTestsFromTestCase(TestConfigUser))
+            # suite.addTests(unittest.TestLoader().loadTestsFromTestCase(TestConfigAWS))
+            # suite.addTest(unittest.TestLoader().loadTestsFromTestCase(TestConfigShared))
+            # suite.addTests(unittest.TestLoader().loadTestsFromTestCase(TestConfigNIH))
+            # suite.addTests(unittest.TestLoader().loadTestsFromTestCase(TestConfigS3))
+            # suite.addTests(unittest.TestLoader().loadTestsFromTestCase(TestConfigSlurm))
+
+            # BASIC TEST CASE FOR EVERY TEST
+            # suite.addTest(TestConfig('test_subcmd_config'))
+            # suite.addTest(TestConfigUser('test_set_user'))
+            # suite.addTest(TestConfigAWS('test_set_aws'))
+            # suite.addTest(TestConfigShared('test_set_shared'))
+            # suite.addTest(TestConfigNIH('test_set_nih'))
+            suite.addTest(TestConfigS3('test_set_s3'))
+
+            runner = unittest.TextTestRunner(verbosity=2)
+            runner.run(suite)
+
+    except KeyboardInterrupt:
+        print("\nTests interrupted by the user. Exiting...")
+        sys.exit(1)
+    except Exception as e:
+        print("\nAn error occurred during the tests execution: %s" % e)
+        sys.exit(1)