relink now indents like rimport.

Author: samsrabin

relink.py

@@ -21,6 +21,7 @@
     validate_directory,
     configure_logging,
     logger,
+    INDENT,
 )
 
 # Define a custom log level that always prints
@@ -237,7 +238,7 @@ def replace_one_file_with_symlink(inputdata_root, target_dir, file_path, dry_run
         file_path (str): The path of the file to be replaced.
         dry_run (bool): If True, only show what would be done without making changes.
     """
-    logger.info("Found owned file: %s", file_path)
+    logger.info("'%s':", file_path)
 
     # Determine the relative path and the new link's destination
     relative_path = os.path.relpath(file_path, inputdata_root)
@@ -246,9 +247,9 @@ def replace_one_file_with_symlink(inputdata_root, target_dir, file_path, dry_run
     # Check if the target file actually exists
     if not os.path.exists(link_target):
         logger.warning(
-            "Warning: Corresponding file '%s' not found for '%s'. Skipping.",
+            "%sWarning: Corresponding file '%s' not found. Skipping.",
+            INDENT,
             link_target,
-            file_path,
         )
         return
 
@@ -257,7 +258,8 @@ def replace_one_file_with_symlink(inputdata_root, target_dir, file_path, dry_run
 
     if dry_run:
         logger.info(
-            "[DRY RUN] Would create symbolic link: %s -> %s",
+            "%s[DRY RUN] Would create symbolic link: %s -> %s",
+            INDENT,
             link_name,
             link_target,
         )
@@ -266,9 +268,9 @@ def replace_one_file_with_symlink(inputdata_root, target_dir, file_path, dry_run
     # Remove the original file
     try:
         os.rename(link_name, link_name + ".tmp")
-        logger.info("Deleted original file: %s", link_name)
+        logger.info("%sDeleted original file: %s", INDENT, link_name)
     except OSError as e:
-        logger.error("Error deleting file %s: %s. Skipping.", link_name, e)
+        logger.error("%sError deleting file %s: %s. Skipping.", INDENT, link_name, e)
         return
 
     # Create the symbolic link, handling necessary parent directories
@@ -277,10 +279,10 @@ def replace_one_file_with_symlink(inputdata_root, target_dir, file_path, dry_run
         os.makedirs(os.path.dirname(link_name), exist_ok=True)
         os.symlink(link_target, link_name)
         os.remove(link_name + ".tmp")
-        logger.info("Created symbolic link: %s -> %s", link_name, link_target)
+        logger.info("%sCreated symbolic link: %s -> %s", INDENT, link_name, link_target)
     except OSError as e:
         os.rename(link_name + ".tmp", link_name)
-        logger.error("Error creating symlink for %s: %s. Skipping.", link_name, e)
+        logger.error("%sError creating symlink for %s: %s. Skipping.", INDENT, link_name, e)
 
 
 def parse_arguments():

rimport

@@ -20,11 +20,11 @@ from urllib.request import Request, urlopen
 from urllib.error import HTTPError
 
 import shared
+INDENT = shared.INDENT
 
 DEFAULT_INPUTDATA_ROOT = Path(shared.DEFAULT_INPUTDATA_ROOT)
 DEFAULT_STAGING_ROOT = Path(shared.DEFAULT_STAGING_ROOT)
 STAGE_OWNER = "cesmdata"
-INDENT = "    "
 INPUTDATA_URL = "https://osdf-data.gdex.ucar.edu/ncar/gdex/d651077/cesmdata/inputdata"
 
 # Configure logging

shared.py

@@ -11,6 +11,7 @@
 DEFAULT_STAGING_ROOT = (
     "/glade/campaign/collections/gdex/data/d651077/cesmdata/inputdata/"
 )
+INDENT = "    "
 
 logger = logging.getLogger("rimport_relink")
 

tests/relink/test_cmdline.py

@@ -9,6 +9,8 @@
 
 import pytest
 
+from shared import INDENT
+
 
 @pytest.fixture(name="mock_dirs")
 def fixture_mock_dirs(tmp_path):
@@ -57,7 +59,7 @@ def test_command_line_execution_dry_run(mock_dirs):
 
     # Verify dry-run messages in output
     assert "DRY RUN MODE" in result.stdout
-    assert "[DRY RUN] Would create symbolic link:" in result.stdout
+    assert f"{INDENT}[DRY RUN] Would create symbolic link:" in result.stdout
 
     # Verify no actual changes were made
     assert source_file.is_file()
@@ -96,7 +98,7 @@ def test_command_line_execution_given_dir(mock_dirs):
     assert os.readlink(str(source_file)) == str(target_file)
 
     # Verify success messages in output
-    assert "Created symbolic link:" in result.stdout
+    assert f"{INDENT}Created symbolic link:" in result.stdout
 
 
 def test_command_line_execution_given_file(mock_dirs):
@@ -131,7 +133,7 @@ def test_command_line_execution_given_file(mock_dirs):
     assert os.readlink(str(source_file)) == str(target_file)
 
     # Verify success messages in output
-    assert "Created symbolic link:" in result.stdout
+    assert f"{INDENT}Created symbolic link:" in result.stdout
 
 
 def test_command_line_multiple_source_dirs(temp_dirs):

tests/relink/test_dryrun.py

@@ -16,6 +16,8 @@
 # pylint: disable=wrong-import-position
 import relink  # noqa: E402
 
+from shared import INDENT
+
 
 @pytest.fixture(name="dry_run_setup")
 def fixture_dry_run_setup(temp_dirs):
@@ -70,7 +72,7 @@ def test_dry_run_shows_message(dry_run_setup, caplog):
 
     # Check that dry-run messages were logged
     assert "DRY RUN MODE" in caplog.text
-    assert "[DRY RUN] Would create symbolic link:" in caplog.text
+    assert f"{INDENT}[DRY RUN] Would create symbolic link:" in caplog.text
     assert f"{source_file} -> {target_file}" in caplog.text
 
 
@@ -85,7 +87,7 @@ def test_dry_run_no_delete_or_create_messages(dry_run_setup, caplog):
         )
 
     # Verify actual operation messages are NOT logged
-    assert "Deleted original file:" not in caplog.text
-    assert "Created symbolic link:" not in caplog.text
+    assert f"{INDENT}Deleted original file:" not in caplog.text
+    assert f"{INDENT}Created symbolic link:" not in caplog.text
     # But the dry-run message should be there
-    assert "[DRY RUN] Would create symbolic link: " in caplog.text
+    assert f"{INDENT}[DRY RUN] Would create symbolic link: " in caplog.text

tests/relink/test_replace_one_file_with_symlink.py

@@ -14,6 +14,8 @@
 # pylint: disable=wrong-import-position
 import relink  # noqa: E402
 
+from shared import INDENT
+
 
 def test_basic_file_replacement(temp_dirs):
     """Test basic functionality: replace owned file with symlink."""
@@ -83,7 +85,7 @@ def test_missing_target_file(temp_dirs, caplog):
     assert os.path.isfile(source_file), "Original file should still exist"
 
     # Check warning message
-    assert "Warning: Corresponding file " in caplog.text
+    assert f"{INDENT}Warning: Corresponding file " in caplog.text
     assert " not found" in caplog.text
 
 
@@ -117,7 +119,7 @@ def test_absolute_paths(temp_dirs):
 
 
 def test_print_found_owned_file(temp_dirs, caplog):
-    """Test that 'Found owned file' message is printed."""
+    """Test that message with filename is printed."""
     source_dir, target_dir = temp_dirs
 
     # Create a file owned by current user
@@ -133,8 +135,8 @@ def test_print_found_owned_file(temp_dirs, caplog):
     with caplog.at_level(logging.INFO):
         relink.replace_one_file_with_symlink(source_dir, target_dir, source_file)
 
-    # Check that "Found owned file" message was logged
-    assert "Found owned file:" in caplog.text
+    # Check that message was logged
+    assert f"'{source_file}':" in caplog.text
     assert source_file in caplog.text
 
 
@@ -156,8 +158,8 @@ def test_print_deleted_and_created_messages(temp_dirs, caplog):
         relink.replace_one_file_with_symlink(source_dir, target_dir, source_file)
 
     # Check messages
-    assert "Deleted original file:" in caplog.text
-    assert "Created symbolic link:" in caplog.text
+    assert f"{INDENT}Deleted original file:" in caplog.text
+    assert f"{INDENT}Created symbolic link:" in caplog.text
     assert f"{source_file} -> {target_file}" in caplog.text
 
 
@@ -184,7 +186,7 @@ def mock_symlink(src, dst):
             relink.replace_one_file_with_symlink(source_dir, target_dir, source_file)
 
         # Check error message
-        assert "Error creating symlink" in caplog.text
+        assert f"{INDENT}Error creating symlink" in caplog.text
         assert source_file in caplog.text
 
 
@@ -254,5 +256,5 @@ def mock_rename(src, dst):
             relink.replace_one_file_with_symlink(source_dir, target_dir, source_file)
 
         # Check error message
-        assert "Error deleting file" in caplog.text
+        assert f"{INDENT}Error deleting file" in caplog.text
         assert source_file in caplog.text

tests/relink/test_verbosity.py

@@ -15,6 +15,8 @@
 # pylint: disable=wrong-import-position
 import relink  # noqa: E402
 
+from shared import INDENT
+
 
 def test_quiet_mode_suppresses_info_messages(temp_dirs, caplog):
     """Test that quiet mode suppresses INFO level messages."""
@@ -45,8 +47,8 @@ def test_quiet_mode_suppresses_info_messages(temp_dirs, caplog):
     assert "Searching for files owned by" not in caplog.text
     assert "Skipping symlink:" not in caplog.text
     assert "Found owned file:" not in caplog.text
-    assert "Deleted original file:" not in caplog.text
-    assert "Created symbolic link:" not in caplog.text
+    assert f"{INDENT}Deleted original file:" not in caplog.text
+    assert f"{INDENT}Created symbolic link:" not in caplog.text
 
 
 def test_quiet_mode_shows_warnings(temp_dirs, caplog):
@@ -66,7 +68,7 @@ def test_quiet_mode_shows_warnings(temp_dirs, caplog):
         )
 
     # Verify WARNING message IS in the log
-    assert "Warning: Corresponding file" in caplog.text
+    assert f"{INDENT}Warning: Corresponding file" in caplog.text
     assert "not found" in caplog.text
 
 
@@ -104,7 +106,7 @@ def mock_rename(src, dst):
             relink.replace_files_with_symlinks(
                 source_dir, target_dir, username, inputdata_root=source_dir
             )
-        assert "Error deleting file" in caplog.text
+        assert f"{INDENT}Error deleting file" in caplog.text
 
     # Clear the log for next test
     caplog.clear()
@@ -126,4 +128,4 @@ def mock_symlink(src, dst):
             relink.replace_files_with_symlinks(
                 source_dir, target_dir, username, inputdata_root=source_dir
             )
-        assert "Error creating symlink" in caplog.text
+        assert f"{INDENT}Error creating symlink" in caplog.text