PR fixes

Author: Ickerday

splunklib/searchcommands/environment.py

@@ -121,21 +121,23 @@ def configure_logging(logger_name, filename=None):
 _current_logging_configuration_file = None
 
 
-def _find_app_root(app_file: str) -> str:
-    """Return the app root directory for a search command script."""
-    directory: str = path.abspath(path.dirname(app_file))
-    while True:
-        parent, name = path.split(directory)
-        if name == "bin":
-            return parent
-        if parent == directory:
-            return path.dirname(path.abspath(path.dirname(app_file)))
-        directory = parent
+def _find_app_root(app_file: str, splunk_home: str) -> str:
+    """Return the app root directory for a search command script.
+
+    An app root is $SPLUNK_HOME/etc/apps/<app-name>, and app_file is located somewhere
+    underneath its bin directory.
+    """
+    apps_directory = path.join(splunk_home, "etc", "apps")
+    relative = path.relpath(path.abspath(app_file), apps_directory)
+    app_name = relative.split(path.sep, 1)[0]
+    if app_name == path.pardir: # app_file not in $SPLUNK_HOME/etc/apps
+        return path.dirname(path.abspath(path.dirname(app_file)))
+    return path.join(apps_directory, app_name)
 
 
 splunk_home = path.abspath(path.join(getcwd(), environ.get("SPLUNK_HOME", "")))
 app_file = getattr(sys.modules["__main__"], "__file__", sys.executable)
-app_root = _find_app_root(app_file)
+app_root = _find_app_root(app_file, splunk_home)
 
 splunklib_logger, logging_configuration = configure_logging("splunklib")
 

tests/unit/searchcommands/test_environment.py

@@ -20,18 +20,29 @@
     _find_app_root,  # pyright: ignore[reportPrivateUsage]
 )
 
+_SPLUNK_HOME = os.path.join(os.sep, "opt", "splunk")
+_APPS_DIRECTORY = os.path.join(_SPLUNK_HOME, "etc", "apps")
+
 
 @pytest.mark.parametrize(
     ("app_file_parts", "expected_app_root_parts"),
     [
-        (("apps", "my_app", "bin", "command.py"), ("apps", "my_app")),
-        (("apps", "my_app", "bin", "linux_x86_64", "command.py"), ("apps", "my_app")),
-        (("apps", "my_app", "bin", "foo", "bar", "command.py"), ("apps", "my_app")),
-        (("some", "other", "layout", "command.py"), ("some", "other")),
+        # A script located directly in the app's bin directory
+        (("my_app", "bin", "command.py"), ("my_app",)),
+        # A script located in a subdirectory of bin, including one that happens to be
+        # named "bin" itself; the app root is still $SPLUNK_HOME/etc/apps/my_app
+        (("my_app", "bin", "foo", "bin", "command.py"), ("my_app",)),
     ],
 )
 def test_find_app_root(
     app_file_parts: tuple[str, ...], expected_app_root_parts: tuple[str, ...]
 ) -> None:
-    app_file = os.path.join(*app_file_parts)
-    assert _find_app_root(app_file) == os.path.abspath(os.path.join(*expected_app_root_parts))
+    app_file = os.path.join(_APPS_DIRECTORY, *app_file_parts)
+    expected_app_root = os.path.join(_APPS_DIRECTORY, *expected_app_root_parts)
+    assert _find_app_root(app_file, _SPLUNK_HOME) == expected_app_root
+
+
+def test_find_app_root_falls_back_on_nonstandard_splunk_home() -> None:
+    app_file = os.path.join("some", "other", "layout", "command.py")
+    expected_app_root = os.path.dirname(os.path.abspath(os.path.dirname(app_file)))
+    assert _find_app_root(app_file, _SPLUNK_HOME) == expected_app_root