Move validate_ functions from relink to shared.

Author: samsrabin

relink.py

@@ -17,6 +17,8 @@
     DEFAULT_STAGING_ROOT,
     get_log_level,
     add_parser_verbosity_group,
+    validate_paths,
+    validate_directory,
 )
 
 # Set up logger
@@ -282,48 +284,6 @@ def replace_one_file_with_symlink(inputdata_root, target_dir, file_path, dry_run
         logger.error("Error creating symlink for %s: %s. Skipping.", link_name, e)
 
 
-def validate_paths(path, check_is_dir=False):
-    """
-    Validate that one or more paths exist.
-
-    Args:
-        path (str or list): The path to validate, or a list of such paths.
-
-    Returns:
-        str or list: The absolute path(s) if valid.
-
-    Raises:
-        argparse.ArgumentTypeError: If a path doesn't exist.
-    """
-    if isinstance(path, list):
-        result = []
-        for item in path:
-            result.append(validate_paths(item, check_is_dir=check_is_dir))
-        return result
-
-    if not os.path.exists(path):
-        raise argparse.ArgumentTypeError(f"'{path}' does not exist")
-    if check_is_dir and not os.path.isdir(path):
-        raise argparse.ArgumentTypeError(f"'{path}' is not a directory")
-    return os.path.abspath(path)
-
-
-def validate_directory(path):
-    """
-    Validate that one or more directories exist.
-
-    Args:
-        path (str or list): The directory to validate, or a list of such directories.
-
-    Returns:
-        str or list: The absolute path(s) if valid.
-
-    Raises:
-        argparse.ArgumentTypeError: If a path doesn't exist.
-    """
-    return validate_paths(path, check_is_dir=True)
-
-
 def parse_arguments():
     """
     Parse command-line arguments.

shared.py

@@ -3,7 +3,8 @@
 """
 
 import logging
-from argparse import ArgumentParser
+import argparse
+import os
 
 DEFAULT_INPUTDATA_ROOT = "/glade/campaign/cesm/cesmdata/cseg/inputdata/"
 DEFAULT_STAGING_ROOT = (
@@ -31,7 +32,7 @@ def get_log_level(quiet: bool = False, verbose: bool = False) -> int:
     return logging.INFO
 
 
-def add_parser_verbosity_group(parser: ArgumentParser):
+def add_parser_verbosity_group(parser: argparse.ArgumentParser):
     """Add mutually exclusive verbosity options to an argument parser.
 
     Adds -v/--verbose and -q/--quiet flags as a mutually exclusive group.
@@ -53,3 +54,45 @@ def add_parser_verbosity_group(parser: ArgumentParser):
         help="Quiet mode (show only warnings and errors)",
     )
     return verbosity_group
+
+
+def validate_paths(path, check_is_dir=False):
+    """
+    Validate that one or more paths exist.
+
+    Args:
+        path (str or list): The path to validate, or a list of such paths.
+
+    Returns:
+        str or list: The absolute path(s) if valid.
+
+    Raises:
+        argparse.ArgumentTypeError: If a path doesn't exist.
+    """
+    if isinstance(path, list):
+        result = []
+        for item in path:
+            result.append(validate_paths(item, check_is_dir=check_is_dir))
+        return result
+
+    if not os.path.exists(path):
+        raise argparse.ArgumentTypeError(f"'{path}' does not exist")
+    if check_is_dir and not os.path.isdir(path):
+        raise argparse.ArgumentTypeError(f"'{path}' is not a directory")
+    return os.path.abspath(path)
+
+
+def validate_directory(path):
+    """
+    Validate that one or more directories exist.
+
+    Args:
+        path (str or list): The directory to validate, or a list of such directories.
+
+    Returns:
+        str or list: The absolute path(s) if valid.
+
+    Raises:
+        argparse.ArgumentTypeError: If a path doesn't exist.
+    """
+    return validate_paths(path, check_is_dir=True)

tests/relink/test_args.py

@@ -205,146 +205,6 @@ def test_inputdata_arguments_accepted(self, temp_dirs, inputdata_flag):
             assert args.inputdata_root == inputdata_root
 
 
-class TestValidateDirectory:
-    """Test suite for validate_directory function."""
-
-    def test_valid_directory(self, tmp_path):
-        """Test that valid directory is accepted and returns absolute path."""
-        test_dir = tmp_path / "valid_dir"
-        test_dir.mkdir()
-
-        result = relink.validate_directory(str(test_dir))
-        assert result == str(test_dir.resolve())
-
-    def test_nonexistent_directory(self):
-        """Test that nonexistent directory raises ArgumentTypeError."""
-        nonexistent = os.path.join(os.sep, "nonexistent", "directory", "12345")
-
-        with pytest.raises(argparse.ArgumentTypeError) as exc_info:
-            relink.validate_directory(nonexistent)
-
-        assert "does not exist" in str(exc_info.value)
-        assert nonexistent in str(exc_info.value)
-
-    def test_relative_path_converted_to_absolute(self, tmp_path):
-        """Test that relative paths are converted to absolute."""
-        test_dir = tmp_path / "relative_test"
-        test_dir.mkdir()
-
-        # Change to parent directory and use relative path
-        cwd = os.getcwd()
-        try:
-            os.chdir(str(tmp_path))
-            result = relink.validate_directory("relative_test")
-            assert os.path.isabs(result)
-            assert result == str(test_dir.resolve())
-        finally:
-            os.chdir(cwd)
-
-    def test_symlink_to_directory(self, tmp_path):
-        """Test that symlink to a directory is accepted."""
-        real_dir = tmp_path / "real_dir"
-        real_dir.mkdir()
-
-        link_dir = tmp_path / "link_dir"
-        link_dir.symlink_to(real_dir)
-
-        result = relink.validate_paths(str(link_dir))
-        # validate_directory returns absolute path of the symlink itself
-        assert result == str(link_dir.absolute())
-        # Verify it's still a symlink
-        assert os.path.islink(result)
-
-    def test_list_with_invalid_directory(self, tmp_path):
-        """Test that a list with one invalid directory raises error."""
-        dir1 = tmp_path / "dir1"
-        dir1.mkdir()
-        nonexistent = tmp_path / "nonexistent"
-
-        with pytest.raises(argparse.ArgumentTypeError) as exc_info:
-            relink.validate_paths([str(dir1), str(nonexistent)])
-
-        assert "does not exist" in str(exc_info.value)
-
-
-class TestValidatePaths:
-    """Test suite for validate_paths function."""
-
-    def test_valid_directory(self, tmp_path):
-        """Test that valid directory is accepted and returns absolute path."""
-        test_dir = tmp_path / "valid_dir"
-        test_dir.mkdir()
-
-        result = relink.validate_paths(str(test_dir))
-        assert result == str(test_dir.resolve())
-
-    def test_nonexistent_directory(self):
-        """Test that nonexistent directory raises ArgumentTypeError."""
-        nonexistent = os.path.join(os.sep, "nonexistent", "directory", "12345")
-
-        with pytest.raises(argparse.ArgumentTypeError) as exc_info:
-            relink.validate_paths(nonexistent)
-
-        assert "does not exist" in str(exc_info.value)
-        assert nonexistent in str(exc_info.value)
-
-    def test_file_instead_of_directory(self, tmp_path):
-        """Test that a file path doesn't raise ArgumentTypeError (or any error)."""
-        test_file = tmp_path / "test_file.txt"
-        test_file.write_text("content")
-
-        relink.validate_paths(str(test_file))
-
-    def test_relative_path_converted_to_absolute(self, tmp_path):
-        """Test that relative paths are converted to absolute."""
-        test_dir = tmp_path / "relative_test"
-        test_dir.mkdir()
-
-        # Change to parent directory and use relative path
-        cwd = os.getcwd()
-        try:
-            os.chdir(str(tmp_path))
-            result = relink.validate_paths("relative_test")
-            assert os.path.isabs(result)
-            assert result == str(test_dir.resolve())
-        finally:
-            os.chdir(cwd)
-
-    def test_symlink_to_directory(self, tmp_path):
-        """Test that symlink to a directory is accepted."""
-        real_dir = tmp_path / "real_dir"
-        real_dir.mkdir()
-
-        link_dir = tmp_path / "link_dir"
-        link_dir.symlink_to(real_dir)
-
-        result = relink.validate_paths(str(link_dir))
-        # validate_directory returns absolute path of the symlink itself
-        assert result == str(link_dir.absolute())
-        # Verify it's still a symlink
-        assert os.path.islink(result)
-
-    def test_list_with_invalid_directory(self, tmp_path):
-        """Test that a list with one invalid directory raises error."""
-        dir1 = tmp_path / "dir1"
-        dir1.mkdir()
-        nonexistent = tmp_path / "nonexistent"
-
-        with pytest.raises(argparse.ArgumentTypeError) as exc_info:
-            relink.validate_paths([str(dir1), str(nonexistent)])
-
-        assert "does not exist" in str(exc_info.value)
-
-    def test_list_with_file_instead_of_directory(self, tmp_path):
-        """Test that a list containing a file doesn't raise error."""
-        dir1 = tmp_path / "dir1"
-        dir1.mkdir()
-        file1 = tmp_path / "file.txt"
-        file1.write_text("content")
-
-        relink.validate_paths([str(dir1), str(file1)])
-
-
 class TestProcessArgs:
     """Test suite for process_args function."""