Add test for and fix add_to_ld_library_path

If the path to add is a substring of an existing path it was silently
ignored. This is now handled by properly splitting and joining that path
into an array and checking that

Author: Flamefire

CMakeLists.txt

@@ -31,7 +31,7 @@ add_custom_target(ScorepModule ALL
 
 enable_testing()
 add_test(NAME ScorepPythonTests
-         COMMAND Python::Interpreter -m pytest test_scorep.py
+         COMMAND Python::Interpreter -m pytest
          WORKING_DIRECTORY ${CMAKE_CURRENT_LIST_DIR}/test
 )
 set(pythonPath ${CMAKE_CURRENT_BINARY_DIR}/site-packages)

DEVELOPING.md

@@ -22,7 +22,7 @@ Although, we do not actively maintain the CMake build system, and will not help
 
 You might find this build system helpful for development, especially if you are doing C/C++ things:
 * Include paths for C++ are correctly searched for and set up for use by IDEs or other tools. For example Visual Studio Code works out of the box, given the appropriate extensions (C++, Python, CMake) are installed.
-* A folder `site-packages` is created in the build folder where the C/C++ extension module and the scorep module are copied to on each build (e.g. `make`-call). Hence it is possible to add that folder to the PYTHONPATH environment variable, build the project and start debugging or execute the tests in test/test_scorep.py.
+* A folder `site-packages` is created in the build folder where the C/C++ extension module and the scorep module are copied to on each build (e.g. `make`-call). Hence it is possible to add that folder to the PYTHONPATH environment variable, build the project and start debugging or execute the tests in test.
 * A `test` target exists which can be run to execute all tests.
 
 Please note, that changes to the Python source files are not reflected in the build folder unless a build is executed.

scorep/helper.py

@@ -68,15 +68,10 @@ def add_to_ld_library_path(path):
     adds the path to the LD_LIBRARY_PATH.
     @param path path to be added
     """
-    if ("LD_LIBRARY_PATH" not in os.environ):
-        os.environ["LD_LIBRARY_PATH"] = ""
-
-    if (path not in os.environ["LD_LIBRARY_PATH"]):
-        if os.environ["LD_LIBRARY_PATH"] == "":
-            os.environ["LD_LIBRARY_PATH"] = path
-        else:
-            os.environ["LD_LIBRARY_PATH"] = path + \
-                ":" + os.environ["LD_LIBRARY_PATH"]
+    library_path = os.environ.get("LD_LIBRARY_PATH", "")
+    library_paths = library_path.split(":") if library_path else []
+    if path not in library_paths:
+        os.environ["LD_LIBRARY_PATH"] = ':'.join([path] + library_paths)
 
 
 def generate_compile_deps(config=[]):

test/cases/mpi.py

@@ -3,6 +3,7 @@
 from mpi4py import MPI
 import numpy as np
 import mpi4py
+import instrumentation2
 mpi4py.rc.thread_level = "funneled"
 
 
@@ -14,7 +15,9 @@
 N = 5
 if comm.rank == 0:
     A = np.arange(N, dtype=np.float64)    # rank 0 has proper data
+    instrumentation2.baz()
 else:
+    instrumentation2.bar()
     A = np.empty(N, dtype=np.float64)     # all other just an empty array
 
 # Broadcast A from rank 0 to everybody

test/test_helper.py

@@ -0,0 +1,24 @@
+import os
+import scorep.helper
+
+
+def test_add_to_ld_library_path(monkeypatch):
+    # Previous value: Empty
+    monkeypatch.setenv('LD_LIBRARY_PATH', '')
+    scorep.helper.add_to_ld_library_path('/my/path')
+    assert os.environ['LD_LIBRARY_PATH'] == '/my/path'
+    # Don't add duplicates
+    scorep.helper.add_to_ld_library_path('/my/path')
+    assert os.environ['LD_LIBRARY_PATH'] == '/my/path'
+    # Prepend
+    scorep.helper.add_to_ld_library_path('/new/folder')
+    assert os.environ['LD_LIBRARY_PATH'] == '/new/folder:/my/path'
+    # also no duplicates:
+    for p in ('/my/path', '/new/folder'):
+        scorep.helper.add_to_ld_library_path(p)
+        assert os.environ['LD_LIBRARY_PATH'] == '/new/folder:/my/path'
+
+    # Add parent folder of existing one
+    monkeypatch.setenv('LD_LIBRARY_PATH', '/some/folder:/parent/sub')
+    scorep.helper.add_to_ld_library_path('/parent')
+    assert os.environ['LD_LIBRARY_PATH'] == '/parent:/some/folder:/parent/sub'