Merge pull request #1008 from linsword13/test-cov

Add tests to various utils

Author: douglasjacobsen

lib/ramble/ramble/cmd/debug.py

@@ -7,19 +7,11 @@
 # except according to those terms.
 
 
-import os
 import platform
-import re
-from datetime import datetime
 
-from llnl.util.filesystem import working_dir
-
-import ramble.config
-import ramble.paths
 import ramble.util.version
 
 import spack.platforms
-from spack.util.executable import which
 
 description = "debugging commands for troubleshooting Ramble"
 section = "developer"
@@ -31,31 +23,6 @@ def setup_parser(subparser):
     sp.add_parser("report", help="print information useful for bug reports")
 
 
-def _debug_tarball_suffix():
-    now = datetime.now()
-    suffix = now.strftime("%Y-%m-%d-%H%M%S")
-
-    git = which("git")
-    if not git:
-        return "nobranch-nogit-%s" % suffix
-
-    with working_dir(ramble.paths.prefix):
-        if not os.path.isdir(".git"):
-            return "nobranch.nogit.%s" % suffix
-
-        # Get symbolic branch name and strip any special chars (mainly '/')
-        symbolic = git("rev-parse", "--abbrev-ref", "--short", "HEAD", output=str).strip()
-        symbolic = re.sub(r"[^\w.-]", "-", symbolic)
-
-        # Get the commit hash too.
-        commit = git("rev-parse", "--short", "HEAD", output=str).strip()
-
-        if symbolic == commit:
-            return f"nobranch.{commit}.{suffix}"
-        else:
-            return f"{symbolic}.{commit}.{suffix}"
-
-
 def report(args):
     host_platform = spack.platforms.host()
     host_os = host_platform.operating_system("frontend")

lib/ramble/ramble/test/namespace_trie.py

@@ -22,6 +22,7 @@ def test_add_single(trie):
     assert trie.is_prefix("foo")
     assert trie.has_value("foo")
     assert trie["foo"] == "bar"
+    assert not trie.is_leaf("foo")
 
 
 def test_add_multiple(trie):

lib/ramble/ramble/test/util/naming.py

@@ -0,0 +1,93 @@
+# Copyright 2022-2025 The Ramble Authors
+#
+# Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
+# https://www.apache.org/licenses/LICENSE-2.0> or the MIT license
+# <LICENSE-MIT or https://opensource.org/licenses/MIT>, at your
+# option. This file may not be copied, modified, or distributed
+# except according to those terms.
+"""Perform tests of the util/naming functions"""
+
+import pytest
+
+from ramble.util import naming
+
+
+@pytest.mark.parametrize(
+    "mod_name,expected_cls_name",
+    [
+        ("test_mod_1", "TestMod1"),
+        ("2_test_mod", "_2TestMod"),
+    ],
+)
+def test_mod_to_class(mod_name, expected_cls_name):
+    assert naming.mod_to_class(mod_name) == expected_cls_name
+
+
+@pytest.mark.parametrize(
+    "mod_name,expected_py_mod_name",
+    [
+        ("app", "app"),
+        ("intel-mlc", "intel_mlc"),
+        ("1-app", "num1_app"),
+    ],
+)
+def test_ramble_module_to_python_module(mod_name, expected_py_mod_name):
+    assert naming.ramble_module_to_python_module(mod_name) == expected_py_mod_name
+
+
+@pytest.mark.parametrize(
+    "py_mod_name,expected_names",
+    [
+        ("app", ["app"]),
+        ("py_mod", ["py_mod", "py-mod"]),
+        ("num1_app", ["1_app", "1-app"]),
+    ],
+)
+def test_possible_ramble_module_names(py_mod_name, expected_names):
+    assert naming.possible_ramble_module_names(py_mod_name) == expected_names
+
+
+@pytest.mark.parametrize(
+    "in_name,expected_out_name",
+    [
+        ("ImageMagick", "imagemagick"),
+        ("l_mkl", "mkl"),
+        ("ALLCAPS", "allcaps"),
+        ("a_b.c++", "a-b-cpp"),
+    ],
+)
+def test_simplify_name(in_name, expected_out_name):
+    assert naming.simplify_name(in_name) == expected_out_name
+
+
+@pytest.mark.parametrize(
+    "mod_name,expect_error",
+    [
+        ("valid-mod", False),
+        ("a.b", True),
+        ("-ab", True),
+    ],
+)
+def test_validate_module_name(mod_name, expect_error):
+    if expect_error:
+        with pytest.raises(naming.InvalidModuleNameError):
+            naming.validate_module_name(mod_name)
+    else:
+        naming.validate_module_name(mod_name)
+
+
+@pytest.mark.parametrize(
+    "mod_name,expect_error",
+    [
+        ("valid-mod", False),
+        ("a.b", False),
+        ("-ab", True),
+        ("valid-mod.a.b-c", False),
+    ],
+)
+def test_validate_fully_qualified_module_name(mod_name, expect_error):
+    if expect_error:
+        with pytest.raises(naming.InvalidFullyQualifiedModuleNameError):
+            naming.validate_fully_qualified_module_name(mod_name)
+    else:
+        naming.validate_fully_qualified_module_name(mod_name)

lib/ramble/ramble/test/util/output_capture.py

@@ -0,0 +1,26 @@
+# Copyright 2022-2025 The Ramble Authors
+#
+# Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
+# https://www.apache.org/licenses/LICENSE-2.0> or the MIT license
+# <LICENSE-MIT or https://opensource.org/licenses/MIT>, at your
+# option. This file may not be copied, modified, or distributed
+# except according to those terms.
+"""Perform tests of the util/output_capture functions"""
+
+from ramble.util import output_capture
+
+
+def test_output_capture():
+    mapper = output_capture.output_mapper()
+    assert (
+        mapper.generate_out_string("log.out", output_capture.OUTPUT_CAPTURE.STDOUT)
+        == ' >> "log.out"'
+    )
+    assert (
+        mapper.generate_out_string("log.out", output_capture.OUTPUT_CAPTURE.STDERR)
+        == ' 2>> "log.out"'
+    )
+    assert (
+        mapper.generate_out_string("log.out", output_capture.OUTPUT_CAPTURE.ALL)
+        == ' >> "log.out" 2>&1'
+    )

lib/ramble/ramble/test/util/web.py

@@ -0,0 +1,49 @@
+# Copyright 2022-2025 The Ramble Authors
+#
+# Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
+# https://www.apache.org/licenses/LICENSE-2.0> or the MIT license
+# <LICENSE-MIT or https://opensource.org/licenses/MIT>, at your
+# option. This file may not be copied, modified, or distributed
+# except according to those terms.
+"""Perform tests of the util/web functions"""
+
+import pytest
+
+from ramble.util import web
+
+
+def test_get_header():
+    headers = {"Content-type": "text/plain"}
+
+    assert web.get_header(headers, "Content-type") == "text/plain"
+
+    # test fuzzy lookup
+    assert web.get_header(headers, "contentType") == "text/plain"
+    headers["contentType"] = "text/html"
+    assert web.get_header(headers, "contentType") == "text/html"
+
+    # test no match
+    with pytest.raises(KeyError):
+        web.get_header(headers, "ContentLength")
+
+
+def test_gcs_url_exists(monkeypatch):
+
+    def _get_client():
+        return MockGcsClient()
+
+    import spack.util.gcs
+
+    monkeypatch.setattr(spack.util.gcs, "gcs_client", _get_client)
+    test_url = "gs://abc/xyz.txt"
+    with pytest.raises(MockGcsClientError, match="Mock error for bucket abc"):
+        web.url_exists(test_url)
+
+
+class MockGcsClient:
+    def bucket(self, name):
+        raise MockGcsClientError(f"Mock error for bucket {name}")
+
+
+class MockGcsClientError(Exception):
+    pass

lib/ramble/ramble/util/path.py

@@ -13,14 +13,10 @@
 import getpass
 import os
 import re
-import subprocess
 import tempfile
 import urllib.parse
 
-from llnl.util.lang import memoized
-
 import ramble.paths
-from ramble.util.logger import logger
 
 __all__ = ["substitute_config_variables", "substitute_path_variables", "canonicalize_path"]
 
@@ -31,35 +27,6 @@
     "tempdir": tempfile.gettempdir(),
 }
 
-# This is intended to be longer than the part of the install path
-# ramble generates from the root path we give it.  Included in the
-# estimate:
-#
-#   os-arch      ->   30
-#   compiler     ->   30
-#   package name ->   50   (longest is currently 47 characters)
-#   version      ->   20
-#   hash         ->   32
-#   buffer       ->  138
-#  ---------------------
-#   total        ->  300
-
-
-@memoized
-def get_system_path_max():
-    # Choose a conservative default
-    sys_max_path_length = 256
-    try:
-        path_max_proc = subprocess.Popen(
-            ["getconf", "PATH_MAX", "/"], stdout=subprocess.PIPE, stderr=subprocess.STDOUT
-        )
-        proc_output = str(path_max_proc.communicate()[0].decode())
-        sys_max_path_length = int(proc_output)
-    except (ValueError, subprocess.CalledProcessError, OSError):
-        logger.msg(f"Unable to find system max path length, using: {sys_max_path_length}")
-
-    return sys_max_path_length
-
 
 def substitute_config_variables(path, local_replacements):
     """Substitute placeholders into paths.