test_basic_features workflow

Author: Victor Machado

Diff for: .github/workflows/test-basic-features.yml

@@ -0,0 +1,42 @@
+name: Test basic features
+
+run-name: Test basic features
+
+on: [push, pull_request]
+
+jobs:
+  test-credentials:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.8", "3.9", "3.10", "3.11", "3.12"]
+
+    steps:
+
+      - uses: actions/checkout@v4
+        with:
+          ref: ${{ github.ref }}
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Display Python version
+        run: python3 -c "import sys; print(sys.version)"
+
+      - name: Create and activate virtual environment
+        run: |
+          python3 -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_basic_features.py

Diff for: froster/froster.py

@@ -6940,16 +6940,14 @@ def tearDown(bucket_name, folder_path):
             cfg.bucket_name = new_bucket_name
 
             # Create a dummy file
+            log(f'\nCreating dummy file {file_path}...')
+
             folder_path = tempfile.mkdtemp(prefix='froster_test_')
             file_path = os.path.join(folder_path, 'dummy_file')
 
-            log(f'\nCreating dummy file {file_path}...')
-
             with open(file_path, 'wb') as f:
                 f.truncate(1)
 
-            subprocess.run(['touch', file_path])
-
             log(f'    ....dummy file create')
 
             # Create a new bucket

Diff for: tests/config.py

@@ -47,7 +47,7 @@ def random_string(length=4):
 S3_ARCHIVE_DIR_2 = 'froster-alice'
 
 S3_STORAGE_CLASS_1 = 'DEEP_ARCHIVE'
-S3_STORAGE_CLASS_2 = 'GLACIER'
+S3_STORAGE_CLASS_2 = 'STANDARD'
 
 SLURM_WALLTIME_DAYS = 8
 SLURM_WALLTIME_HOURS = 1

Diff for: tests/test_basic_features.py

@@ -0,0 +1,81 @@
+import subprocess
+import sys
+from time import sleep
+import unittest
+from unittest.mock import patch
+from froster import *
+from tests.config import *
+
+
+class TestBasicFeatures(unittest.TestCase):
+    '''Test the froster basic features.'''
+
+    # 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]):
+            main()
+
+    # Method executed once after all tests
+    @classmethod
+    def tearDownClass(cls):
+        '''- Tear down class.'''
+
+        # Delete the created S3 bucket
+        with \
+                patch('sys.argv', ['froster', '--debug', 'delete', '--bucket', S3_BUCKET_NAME_CREDENTIALS_1]):
+            main()
+
+    def test_basic_features(self):
+        '''- Test the froster basic features.'''
+
+        try:
+            # Create a dummy file
+            folder_path = tempfile.mkdtemp(prefix='froster_')
+            print(f"\nTemporary directory created at: {folder_path}")
+
+            file_path = os.path.join(folder_path, 'dummy_file')
+            with open(file_path, 'wb') as f:
+                f.truncate(1)
+            print(f"Dummy file created at: {file_path}")
+
+            # Run the basic features commands and check if return value is 0, which means no issues detected while executing the command
+            
+            # NOTE: config command is tested into the setUpClass method
+            
+            with \
+                    patch('sys.argv', ['froster', 'index', folder_path]):
+                self.assertFalse(main())
+
+            with \
+                    patch('sys.argv', ['froster', 'archive', folder_path]):
+                self.assertFalse(main())
+
+            with \
+                    patch('sys.argv', ['froster', 'delete', folder_path]):
+                self.assertFalse(main())
+
+        except Exception as e:
+            print(f"Error: {e}")
+        
+
+
+if __name__ == '__main__':
+
+    try:
+
+        unittest.main(verbosity=2, failfast=True)
+
+    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)

Diff for: tests/test_config.py renamed to tests/test_config.py.pending

@@ -28,13 +28,7 @@ def tearDownClass(cls):
 
         # Delete the S3 buckets
         with \
-                patch('sys.argv', ['froster', '--debug', 'delete', '--bucket', S3_BUCKET_NAME_CREDENTIALS_1]), \
-                patch('builtins.print') as mock_print:
-            main()
-
-        with \
-                patch('sys.argv', ['froster', '--debug', 'delete', '--bucket', S3_BUCKET_NAME_CREDENTIALS_2]), \
-                patch('builtins.print') as mock_print:
+                patch('sys.argv', ['froster', '--debug', 'delete', '--bucket', S3_BUCKET_NAME_CREDENTIALS_1]):
             main()
 
     def test_subcmd_credentials(self):
@@ -49,31 +43,8 @@ def test_subcmd_credentials(self):
 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)
+        unittest.main(verbosity=2)
 
     except KeyboardInterrupt:
         print("\nTests interrupted by the user. Exiting...")