Harmonize default root var names across rimport and relink.

Author: samsrabin

relink.py

@@ -12,8 +12,8 @@
 import time
 from pathlib import Path
 
-DEFAULT_SOURCE_ROOT = "/glade/campaign/cesm/cesmdata/cseg/inputdata/"
-DEFAULT_TARGET_ROOT = (
+DEFAULT_INPUTDATA_ROOT = "/glade/campaign/cesm/cesmdata/cseg/inputdata/"
+DEFAULT_STAGING_ROOT = (
     "/glade/campaign/collections/gdex/data/d651077/cesmdata/inputdata/"
 )
 
@@ -131,7 +131,7 @@ def handle_non_dir(var, user_uid):
     return file_path
 
 
-def find_owned_files_scandir(item, user_uid, inputdata_root=DEFAULT_SOURCE_ROOT):
+def find_owned_files_scandir(item, user_uid, inputdata_root=DEFAULT_INPUTDATA_ROOT):
     """
     Efficiently find all files owned by a specific user using os.scandir().
 
@@ -178,7 +178,7 @@ def find_owned_files_scandir(item, user_uid, inputdata_root=DEFAULT_SOURCE_ROOT)
 
 
 def replace_files_with_symlinks(
-    item_to_process, target_dir, username, inputdata_root=DEFAULT_SOURCE_ROOT, dry_run=False
+    item_to_process, target_dir, username, inputdata_root=DEFAULT_INPUTDATA_ROOT, dry_run=False
 ):
     """
     Finds files owned by a specific user in a source directory tree,
@@ -334,19 +334,19 @@ def parse_arguments():
     parser.add_argument(
         "items_to_process",
         nargs="*",
-        default=DEFAULT_SOURCE_ROOT,
+        default=DEFAULT_INPUTDATA_ROOT,
         type=validate_paths,
         help=(
-            f"One or more (directories to search for) files (default: {DEFAULT_SOURCE_ROOT})"
+            f"One or more (directories to search for) files (default: {DEFAULT_INPUTDATA_ROOT})"
         ),
     )
     parser.add_argument(
         "--target-root",
         type=validate_directory,
-        default=DEFAULT_TARGET_ROOT,
+        default=DEFAULT_STAGING_ROOT,
         help=(
             f"The root of the directory tree where files should be moved to "
-            f"(default: {DEFAULT_TARGET_ROOT})"
+            f"(default: {DEFAULT_STAGING_ROOT})"
         ),
     )
 
@@ -356,7 +356,7 @@ def parse_arguments():
         "--inputdata-root",
         "-inputdata",  # to match rimport
         type=validate_directory,
-        default=DEFAULT_SOURCE_ROOT,
+        default=DEFAULT_INPUTDATA_ROOT,
         help=argparse.SUPPRESS,
     )
 

rimport

@@ -16,7 +16,7 @@ import sys
 from pathlib import Path
 from typing import Iterable, List
 
-DEFAULT_SOURCE_ROOT = Path("/glade/campaign/cesm/cesmdata/cseg/inputdata")
+DEFAULT_INPUTDATA_ROOT = Path("/glade/campaign/cesm/cesmdata/cseg/inputdata")
 DEFAULT_STAGING_ROOT = Path(
     "/glade/campaign/collections/gdex/data/d651077/cesmdata/inputdata"
 )
@@ -50,10 +50,10 @@ def build_parser() -> argparse.ArgumentParser:
         "-inputdata",
         dest="inputdata",
         metavar="inputdata_dir",
-        default=DEFAULT_SOURCE_ROOT,
+        default=DEFAULT_INPUTDATA_ROOT,
         help=(
             "Change the default local top level inputdata directory."
-            f" Default: '{DEFAULT_SOURCE_ROOT}'"
+            f" Default: '{DEFAULT_INPUTDATA_ROOT}'"
         ),
     )
 

tests/relink/conftest.py

@@ -16,8 +16,8 @@ def fixture_temp_dirs():
     source_dir = tempfile.mkdtemp(prefix="test_source_")
     target_dir = tempfile.mkdtemp(prefix="test_target_")
 
-    with patch("relink.DEFAULT_SOURCE_ROOT", source_dir):
-        with patch("relink.DEFAULT_TARGET_ROOT", target_dir):
+    with patch("relink.DEFAULT_INPUTDATA_ROOT", source_dir):
+        with patch("relink.DEFAULT_STAGING_ROOT", target_dir):
             yield source_dir, target_dir
 
     # Cleanup

tests/rimport/test_build_parser.py

@@ -72,7 +72,7 @@ def test_inputdata_default(self):
         """Test that -inputdata has correct default value."""
         parser = rimport.build_parser()
         args = parser.parse_args(["-file", "test.txt"])
-        assert args.inputdata == rimport.DEFAULT_SOURCE_ROOT
+        assert args.inputdata == rimport.DEFAULT_INPUTDATA_ROOT
 
     def test_inputdata_custom(self):
         """Test that -inputdata can be customized."""