Merge pull request #117 from falconstryker/devel

Fixed MarsPull Tests

Author: rurata

bin/MarsPull.py

@@ -53,25 +53,10 @@ def debug_wrapper(func):
     :raises Exception: If an error occurs during the function call.
     :raises TypeError: If the function is not callable.
     :raises ValueError: If the function is not found.
-    :raises NameError: If the function is not defined.
     :raises AttributeError: If the function does not have the
         specified attribute.
-    :raises ImportError: If the function cannot be imported.
-    :raises RuntimeError: If the function cannot be run.
-    :raises KeyError: If the function does not have the
-        specified key.
     :raises IndexError: If the function does not have the
         specified index.
-    :raises IOError: If the function cannot be opened.
-    :raises OSError: If the function cannot be accessed.
-    :raises EOFError: If the function cannot be read.
-    :raises MemoryError: If the function cannot be allocated.
-    :raises OverflowError: If the function cannot be overflowed.
-    :raises ZeroDivisionError: If the function cannot be divided by zero.
-    :raises StopIteration: If the function cannot be stopped.
-    :raises KeyboardInterrupt: If the function cannot be interrupted.
-    :raises SystemExit: If the function cannot be exited.
-    :raises AssertionError: If the function cannot be asserted.
     """
 
     @functools.wraps(func)
@@ -319,7 +304,7 @@ def main():
     global debug
 
     if not args.list_files and not args.directory_name:
-        print('Error: You must specify either -list or a directory.')
+        print(f'{Red}ERROR: You must specify either -list or a directory.{Nclr}')
         sys.exit(1)
 
     base_dir = 'https://data.nas.nasa.gov'
@@ -362,30 +347,39 @@ def main():
         #     )
         fv3_urls = [f'{fv3_data_url}']
 
-        print(f'\nSearching for available directories...')
-        print(f'--------------------------------------')
-        for url in legacy_urls:
-            legacy_dir_option = url.split('legacygcmdata/')[1]
-            print(f'{"(Legacy MGCM)":<17} {legacy_dir_option:<20} '
-                  f'{Cyan}{url}{Nclr}')
-
-        # NOTE: See above comment for the FV3-based MGCM data note
-        # for url in fv3_urls:
-        #     fv3_dir_option = url.split('fv3betaout1data/')[1]
-        #     print(f'{"(FV3-based MGCM)":<17} {fv3_dir_option:<17} '
-        #           f'{Cyan}{url}{Nclr}')
-        print(f'{"(FV3-based MGCM)":<17} {"FV3BETAOUT1":<20} '
-              f'{Cyan}{fv3_home_url}{Nclr}')
-        print(f'---------------------\n')
-
+        print(f'\nSearching for available directories...\n')
+        if legacy_urls != []:
+            for url in legacy_urls:
+                legacy_dir_option = url.split('legacygcmdata/')[1]
+                print(f'{"(Legacy MGCM)":<17} {legacy_dir_option:<20} '
+                    f'{Cyan}{url}{Nclr}')
+
+            # NOTE: See above comment for the FV3-based MGCM data note
+            # for url in fv3_urls:
+            #     fv3_dir_option = url.split('fv3betaout1data/')[1]
+            #     print(f'{"(FV3-based MGCM)":<17} {fv3_dir_option:<17} '
+            #           f'{Cyan}{url}{Nclr}')
+            print(f'{"(FV3-based MGCM)":<17} {"FV3BETAOUT1":<20} '
+                f'{Cyan}{fv3_home_url}{Nclr}')
+            
+            print(f'{Yellow}\nYou can list the files in a directory by using '
+                  f'the -list option with a directory name, e.g.\n'
+                  f'> MarsPull -list ACTIVECLDS{Nclr}\n')
+        
+        else:
+            print(f'{Red}No directories were found. This may be because the '
+                  f'file system is unavailable or unresponsive.\nCheck the '
+                  f'URL below to confirm. Otherwise, run with --debug for '
+                  f'more info.\n\n{Nclr}Check URL: '
+                  f'{Cyan}https://data.nas.nasa.gov/mcmcref{Nclr}\n')
+            
         if args.directory_name:
             # If a directory is provided, list the files in that directory
             portal_dir = args.directory_name
             if portal_dir == 'FV3BETAOUT1':
                 # FV3-based MGCM
                 print(f'\n{Green}Selected: (FV3-based MGCM) FV3BETAOUT1{Nclr}')
-                print(f'\nSearching for available files...')
-                print(f'--------------------------------')
+                print(f'\nSearching for available files...\n')
                 fv3_dir_url = f'{fv3_home_url}'
                 fv3_data = requests.get(fv3_dir_url)
                 fv3_file_text = fv3_data.text
@@ -434,7 +428,10 @@ def main():
                 if fv3_files_available:
                     print_file_list(fv3_files_available)
                 else:
-                    print('No .nc files found. Run with --debug for more info')
+                    print(f'{Red}No .nc files found. This may be because the '
+                          f'file system is unavailable or unresponsive.\n'
+                          f'Check the URL below to confirm. Otherwise, run '
+                          f'with --debug for more info.{Nclr}')
                     if debug:
                         # Try a different approach for debugging
                         table_rows = re.findall(
@@ -446,24 +443,23 @@ def main():
                             if '.nc' in row:
                                 print(f'Debug - Found row with .nc: {row}')
 
-                print(f'---------------')
                 # The download URL differs from the listing URL
                 print(f'{Cyan}({fv3_dir_url}){Nclr}\n')
 
-                print(f'{Yellow}You can download files using the -f '
-                      f'option with the directory name, e.g.\n'
-                      f'> MarsPull FV3BETAOUT1 -f 03340.fixed.nc\n'
-                      f'> MarsPull FV3BETAOUT1 -f 03340.fixed.nc '
-                      f'03340.atmos_average.nc{Nclr}\n')
+                if fv3_files_available:
+                    print(f'{Yellow}\nYou can download files using the -f '
+                        f'option with the directory name, e.g.\n'
+                        f'> MarsPull FV3BETAOUT1 -f 03340.fixed.nc\n'
+                        f'> MarsPull FV3BETAOUT1 -f 03340.fixed.nc '
+                        f'03340.atmos_average.nc{Nclr}\n')
 
             elif portal_dir in [
                 'ACTIVECLDS', 'INERTCLDS', 'NEWBASE_ACTIVECLDS',
                 'ACTIVECLDS_NCDF'
                 ]:
                 # Legacy MGCM
                 print(f'\n{Green}Selected: (Legacy MGCM) {portal_dir}{Nclr}')
-                print(f'\nAvailable files:')
-                print(f'---------------')
+                print(f'\nSearching for available files...\n')
                 legacy_dir_url = (f'{legacy_data_url}' + portal_dir + r'/')
                 legacy_data = requests.get(legacy_dir_url)
                 legacy_file_text = legacy_data.text
@@ -495,28 +491,30 @@ def main():
                             )
                         legacy_files_available = href_files
 
-                print_file_list(legacy_files_available)
-                print(f'---------------')
+                # Print the files
+                if legacy_files_available:
+                    print_file_list(legacy_files_available)
+                else:
+                    print(f'{Red}No fort.11 files found. This may be because '
+                          f'the file system is unavailable or unresponsive.\n'
+                          f'Check the URL below to confirm. Otherwise, run '
+                          f'with --debug for more info.{Nclr}')
+                    
                 print(f'{Cyan}({legacy_dir_url}){Nclr}\n')
 
-                print(f'{Yellow}You can download these files using the '
-                      f'-f or -ls options with the directory name, e.g.\n'
-                      f'> MarsPull ACTIVECLDS -f fort.11_0690\n'
-                      f'> MarsPull ACTIVECLDS -f fort.11_0700 fort.11_0701 \n'
-                      f'> MarsPull ACTIVECLDS -ls 90\n'
-                      f'> MarsPull ACTIVECLDS -ls 90 180{Nclr}\n')
+                if legacy_files_available:
+                    print(f'{Yellow}\nYou can download these files using the '
+                        f'-f or -ls options with the directory name, e.g.\n'
+                        f'> MarsPull ACTIVECLDS -f fort.11_0690\n'
+                        f'> MarsPull ACTIVECLDS -f fort.11_0700 fort.11_0701 \n'
+                        f'> MarsPull ACTIVECLDS -ls 90\n'
+                        f'> MarsPull ACTIVECLDS -ls 90 180{Nclr}\n')
 
             else:
-                print(f'Error: Directory {portal_dir} does not exist.')
+                print(f'{Red}ERROR: Directory {portal_dir} does not exist.{Nclr}')
                 sys.exit(1)
             sys.exit(0)
 
-        else:
-            # If no directory is provided, exit with an error
-            print(f'{Yellow}You can list the files in a directory by using '
-                  f'the -list option with a directory name, e.g.\n'
-                  f'> MarsPull -list ACTIVECLDS{Nclr}\n')
-
     if args.directory_name and not args.list_files:
         portal_dir = args.directory_name
         if portal_dir in [
@@ -527,7 +525,7 @@ def main():
             requested_url = (f'{fv3_data_url}')
 
         if not (args.ls or args.filename):
-            print(f'{Yellow}ERROR No file requested. Use [-ls --ls] or '
+            print(f'{Red}ERROR No file requested. Use [-ls --ls] or '
                   f'[-f --filename] to specify a file to download.{Nclr}')
             sys.exit(1)  # Return a non-zero exit code
         portal_dir = args.directory_name
@@ -587,7 +585,7 @@ def main():
 
     elif not args.list_files:
         # If no directory is provided and its not a -list request
-        print(f'{Yellow}ERROR: A directory must be specified unless using '
+        print(f'{Red}ERROR: A directory must be specified unless using '
               f'-list.{Nclr}')
         sys.exit(1)
 

tests/test_marspull.py

@@ -15,122 +15,157 @@
 
 class TestMarsPull(unittest.TestCase):
     """Integration test suite for MarsPull"""
-    
+
     @classmethod
     def setUpClass(cls):
         """Set up the test environment"""
         # Create a temporary directory in the user's home directory
         cls.test_dir = os.path.join(os.path.expanduser('~'), 'MarsPull_test_downloads')
         os.makedirs(cls.test_dir, exist_ok=True)
-        
+
         # Project root directory
         cls.project_root = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
-    
+
     def setUp(self):
         """Change to temporary directory before each test"""
         os.chdir(self.test_dir)
-    
+
     @classmethod
     def tearDownClass(cls):
         """Clean up the test environment"""
         try:
             shutil.rmtree(cls.test_dir, ignore_errors=True)
         except Exception:
             print(f"Warning: Could not remove test directory {cls.test_dir}")
-    
+
     def run_mars_pull(self, args):
         """
         Run MarsPull using subprocess to avoid import-time argument parsing
-        
+
         :param args: List of arguments to pass to MarsPull
         """
         # Construct the full command to run MarsPull
         cmd = [sys.executable, '-m', 'bin.MarsPull'] + args
-        
+
         # Run the command
         try:
             result = subprocess.run(
-                cmd, 
-                capture_output=True, 
-                text=True, 
+                cmd,
+                capture_output=True,
+                text=True,
                 cwd=self.test_dir,  # Run in the test directory
                 env=dict(os.environ, PWD=self.test_dir)  # Ensure current working directory is set
             )
-            
+
             # Check if the command was successful
             if result.returncode != 0:
                 self.fail(f"MarsPull failed with error: {result.stderr}")
-            
+
             return result
         except Exception as e:
             self.fail(f"Failed to run MarsPull: {e}")
-    
+
     def check_files_in_test_directory(self, expected_files):
         """
         Check if files exist in the test directory
-        
+
         If files are not found, list all files in the directory to help diagnose the issue
         """
         test_files = os.listdir(self.test_dir)
-        
+
         for filename in expected_files:
             if filename not in test_files:
                 print(f"Files in test directory ({self.test_dir}):")
                 print(test_files)
                 self.fail(f"File {filename} was not found in the test directory")
-            
+
             # Verify file is not empty
             filepath = os.path.join(self.test_dir, filename)
-            self.assertGreater(os.path.getsize(filepath), 0, 
+            self.assertGreater(os.path.getsize(filepath), 0,
                                f"Downloaded file {filename} is empty")
-    
+
     def test_download_fv3betaout1_specific_file(self):
         """Test downloading a specific file from FV3BETAOUT1"""
         result = self.run_mars_pull(['FV3BETAOUT1', '-f', '03340.fixed.nc'])
-        
+
         # Check that the file was created
         self.check_files_in_test_directory(['03340.fixed.nc'])
-    
+
     def test_download_inertclds_single_ls(self):
         """Test downloading files from INERTCLDS for a single Ls value"""
         result = self.run_mars_pull(['INERTCLDS', '-ls', '90'])
-        
+
         # Check that the file was created
         self.check_files_in_test_directory(['fort.11_0689'])
-    
+
     def test_download_inertclds_ls_range(self):
         """Test downloading files from INERTCLDS for a range of Ls values"""
         result = self.run_mars_pull(['INERTCLDS', '-ls', '90', '95'])
-        
+
         # Check that the files were created
         self.check_files_in_test_directory(['fort.11_0689', 'fort.11_0690'])
-    
+
     def test_list_option(self):
         """Test the list option to ensure it runs without errors"""
         result = self.run_mars_pull(['-list'])
-        
+
         # Check that something was printed
         self.assertTrue(len(result.stdout) > 0, "No output generated by -list option")
-        
+
         # Check for specific expected output
-        self.assertIn("Available directories", result.stdout)
-        self.assertIn("Available files", result.stdout)
+        self.assertIn("Searching for available directories", result.stdout)
+
+        # Check for possible outputs - either directories found or error message
+        if "No directories were found" in result.stdout:
+            # Check error message when no directories found
+            self.assertIn("No directories were found", result.stdout)
+            self.assertIn("file system is unavailable or unresponsive", result.stdout)
+            self.assertIn("Check URL:", result.stdout)
+        else:
+            # If directories are found, check the expected output format
+            self.assertIn("(FV3-based MGCM)", result.stdout)
+            self.assertIn("FV3BETAOUT1", result.stdout)
+            self.assertIn("You can list the files in a directory", result.stdout)
+
+    def test_list_directory_option(self):
+        """Test the list option with a directory to ensure it runs without errors"""
+        result = self.run_mars_pull(['-list', 'FV3BETAOUT1'])
+
+        # Check that something was printed
+        self.assertTrue(len(result.stdout) > 0, "No output generated by -list FV3BETAOUT1 option")
+
+        # Check for expected output sections
+        self.assertIn("Selected: (FV3-based MGCM) FV3BETAOUT1", result.stdout)
+        self.assertIn("Searching for available files", result.stdout)
+
+        # Check for possible outputs - either files found or error message
+        if "No .nc files found" in result.stdout:
+            # Check error message when no files found
+            self.assertIn("No .nc files found", result.stdout)
+            self.assertIn("file system is unavailable or unresponsive", result.stdout)
+        elif "You can download files using the -f option" in result.stdout:
+            # If files are found, check the expected usage information
+            self.assertIn("You can download files using the -f option", result.stdout)
+        
+        # Note: We're not checking for actual files as they might not be available
+        # if the server is down, which is OK according to requirements
 
+
     def test_help_message(self):
         """Test that help message can be displayed"""
         result = self.run_mars_pull(['-h'])
-        
+
         # Check that something was printed
         self.assertTrue(len(result.stdout) > 0, "No help message generated")
-        
+
         # Check for typical help message components
         help_checks = [
             'usage:',
             '-ls',
             '-f',
             '--list'
         ]
-        
+
         for check in help_checks:
             self.assertIn(check, result.stdout.lower(), f"Help message missing '{check}'")