fix(cmake): add rpath properties for installation

.github/workflows/ci.yml

@@ -119,6 +119,47 @@ jobs:
           with_deps: true
           unity: "Off"
 
+  install-arkscript:
+    runs-on: ${{ matrix.os }}
+    name: Install ArkScript on ${{ matrix.os }}
+    needs: [ check ]
+
+    strategy:
+      fail-fast: false
+      matrix:
+        os:
+          - ubuntu-24.04
+          - macos-14
+
+    steps:
+      - uses: actions/checkout@v5
+        with:
+          submodules: recursive
+
+      - name: Setup compilers, dependencies, project and build
+        uses: ./.github/workflows/setup-compilers
+        with:
+          os_name: ${{ matrix.os }}
+          compiler: clang
+          compiler_version: 16
+          sanitizers: "On"
+          with_deps: false
+
+      - name: Install via cmake
+        run: |
+          mkdir -p /tmp/ArkScript
+          cmake --install build --prefix /tmp/ArkScript
+          # to ensure that the executable won't try to load libArkReactor.so/dylib from build/
+          rm -rf build
+
+      - name: Test installation
+        run: |
+          export ARKSCRIPT_PATH=/tmp/ArkScript/lib/Ark
+          echo /tmp/ArkScript; ls /tmp/ArkScript
+          echo /tmp/ArkScript/bin; ls /tmp/ArkScript/bin
+          echo /tmp/ArkScript/lib; ls /tmp/ArkScript/lib
+          DYLD_PRINT_LIBRARIES=1 /tmp/ArkScript/bin/arkscript -e '(import std.List) (print list:map " is a function")' || exit 1
+
   build:
     runs-on: ${{ matrix.config.os }}
     name: ${{ matrix.config.name }}
@@ -174,13 +215,13 @@ jobs:
           mkdir -p artifact/lib/std
           # Linux/MacOS
           if [[ '${{ startsWith(matrix.config.os, 'ubuntu') }}' == 'true' ]] || [[ '${{ startsWith(matrix.config.os, 'macos') }}' == 'true' ]]; then
-            cp build/arkscript artifact || true
-            cp build/libArkReactor.* artifact || true
+            cp build/arkscript artifact
+            cp build/bin/libArkReactor.* artifact
           fi
           # Windows
           if [[ '${{ startsWith(matrix.config.os, 'windows') }}' == 'true' ]]; then
-            cp build/$BUILD_TYPE/arkscript.exe artifact || true
-            cp build/$BUILD_TYPE/ArkReactor.dll artifact  || true
+            cp build/$BUILD_TYPE/arkscript.exe artifact
+            cp build/$BUILD_TYPE/ArkReactor.dll artifact
           fi
           # Generic
           cp lib/*.arkm artifact/lib
@@ -191,8 +232,11 @@ jobs:
         shell: bash
         run: |
           mkdir -p temp/tests/unittests/
-          cp build/unittests temp/ || true
-          cp build/$BUILD_TYPE/unittests.exe temp/ || true
+          if [[ '${{ startsWith(matrix.config.os, 'windows') }}' == 'true' ]]; then
+            cp build/$BUILD_TYPE/unittests.exe temp/
+          else
+            cp build/unittests temp/
+          fi
           cp tests/unittests/*.arkm temp/tests/unittests
           cp -r tests/unittests temp/tests/unittests
 
@@ -336,6 +380,9 @@ jobs:
 
       - name: Fuzz
         run: |
+          # ensure the executable works first
+          ARKSCRIPT_PATH=$(pwd)/lib ${BUILD_FOLDER}/arkscript -e '(import std.List) (print list:map " is a function")' || exit 1
+          # then we can fuzz. If the executable doesn't work, the fuzzer crashes with a cryptic error message
           afl-fuzz -i tests/fuzzing/corpus-cmin-tmin \
             -o output \
             -s $FUZZER_SEED \

.github/workflows/setup-tests/action.yaml

@@ -47,6 +47,10 @@ runs:
         cp artifact/unittests .
         chmod u+x unittests
 
+    - shell: bash
+      if: ${{ !startsWith(inputs.os_name, 'windows') }}
+      run: cp build/libArkReactor.* .
+
     - shell: bash
       if: startsWith(matrix.config.name, 'Windows')
       run: |

CMakeLists.txt

@@ -35,9 +35,7 @@ option(ARK_COVERAGE "Enable coverage while building (clang, gcc) (requires ARK_T
 option(ARK_UNITY_BUILD "Enable unity build" Off)
 option(ARK_JS_ONLY "Compiles to native JS (No WASM). Can be used only when compiling with emsdk" OFF)
 
-if (${CMAKE_SYSTEM_NAME} MATCHES "Emscripten")
-    set(ARK_EMSCRIPTEN TRUE)
-endif ()
+include(cmake/vars.cmake)
 
 if (NOT ARK_EMSCRIPTEN)
     include(cmake/link_time_optimization.cmake)
@@ -67,18 +65,18 @@ configure_file(
 
 set(CMAKE_POSITION_INDEPENDENT_CODE ON)
 
-if ("${CMAKE_CXX_COMPILER_ID}" STREQUAL "Clang" OR "${CMAKE_CXX_COMPILER_ID}" STREQUAL "AppleClang")
-    set(CMAKE_COMPILER_IS_CLANG ON)
-endif ()
-
 file(GLOB_RECURSE SOURCE_FILES
         ${ark_SOURCE_DIR}/src/arkreactor/*.cpp
         ${ark_SOURCE_DIR}/thirdparties/fmt/src/format.cc)
 
-add_library(ArkReactor SHARED ${SOURCE_FILES})
-
 if (NOT ARK_EMSCRIPTEN)
+    add_library(ArkReactor SHARED ${SOURCE_FILES})
     enable_lto(ArkReactor)
+    set_target_properties(ArkReactor PROPERTIES
+            INSTALL_NAME_DIR "@rpath"
+            LIBRARY_OUTPUT_DIRECTORY ${CMAKE_INSTALL_BINDIR})
+else ()
+    add_library(ArkReactor STATIC ${SOURCE_FILES})
 endif ()
 
 target_include_directories(ArkReactor
@@ -90,6 +88,7 @@ target_include_directories(ArkReactor
         "${ark_SOURCE_DIR}/thirdparties/fmt/include")
 
 target_compile_features(ArkReactor PRIVATE cxx_std_20)
+target_compile_definitions(ArkReactor PRIVATE ARK_EXPORT)
 
 if (ARK_ENABLE_SYSTEM)
     target_compile_definitions(ArkReactor PRIVATE ARK_ENABLE_SYSTEM)
@@ -145,7 +144,6 @@ if (CMAKE_COMPILER_IS_GNUCXX OR CMAKE_COMPILER_IS_CLANG OR APPLE)
     elseif (CMAKE_COMPILER_IS_GNUCXX)
         target_compile_options(ArkReactor PRIVATE -Wno-unused-local-typedefs)
     endif ()
-
 elseif (MSVC)
     target_compile_definitions(ArkReactor PRIVATE ARK_USE_COMPUTED_GOTOS=0)
     target_compile_options(ArkReactor
@@ -189,16 +187,21 @@ if (NOT ARK_EMSCRIPTEN)
 
     # Install the standard library
     if (NOT ARK_NO_STDLIB)
+        if (CMAKE_INSTALL_PREFIX_INITIALIZED_TO_DEFAULT)
+            set(ARK_STD_INSTALL_PATH ${CMAKE_INSTALL_LIBDIR}/Ark/std)
+        else ()
+            # custom installation prefix, no need for lib/Ark/std, use lib/std instead
+            set(ARK_STD_INSTALL_PATH ${CMAKE_INSTALL_LIBDIR}/std)
+        endif ()
+
         install(DIRECTORY ${ark_SOURCE_DIR}/lib/std/
-                DESTINATION ${CMAKE_INSTALL_LIBDIR}/Ark/std
+                DESTINATION ${ARK_STD_INSTALL_PATH}
                 FILES_MATCHING PATTERN "*.ark"
                 PATTERN "std/tests" EXCLUDE
                 PATTERN "std/.github" EXCLUDE)
     endif ()
 endif ()
 
-target_compile_definitions(ArkReactor PRIVATE ARK_EXPORT)
-
 #####################################################
 # Create the different (optional) targets
 #####################################################
@@ -250,14 +253,13 @@ if (ARK_TESTS)
             ${ark_SOURCE_DIR}/src/arkscript/REPL/Utils.cpp)
     add_executable(unittests ${SOURCES})
     target_include_directories(unittests PUBLIC ${ark_SOURCE_DIR}/tests/unittests)
-
+    target_include_directories(unittests PUBLIC ${ark_SOURCE_DIR}/include)
     target_include_directories(unittests SYSTEM PUBLIC ${ark_SOURCE_DIR}/thirdparties/dtl/dtl)
 
+    set(BOOST_UT_DISABLE_MODULE On)
     add_subdirectory(${ark_SOURCE_DIR}/thirdparties/ut)
-    target_include_directories(unittests PUBLIC ${ark_SOURCE_DIR}/include)
     target_link_libraries(unittests PUBLIC ArkReactor ut replxx)
 
-    set(BOOST_UT_DISABLE_MODULE On)
     target_compile_features(unittests PRIVATE cxx_std_20)
     target_compile_definitions(unittests PRIVATE ARK_TESTS_ROOT="${CMAKE_CURRENT_SOURCE_DIR}/")
 
@@ -266,7 +268,10 @@ if (ARK_TESTS)
     endif ()
     set_target_properties(unittests PROPERTIES
             VS_DEBUGGER_WORKING_DIRECTORY "${ark_SOURCE_DIR}"
-            VS_DEBUGGER_COMMAND "$<TARGET_FILE:unittests>")
+            VS_DEBUGGER_COMMAND "$<TARGET_FILE:unittests>"
+            BUILD_WITH_INSTALL_RPATH ON
+            INSTALL_RPATH_USE_LINK_PATH ON)
+    set_target_rpath(unittests)
 
     if (ARK_COVERAGE AND CMAKE_COMPILER_IS_CLANG)
         target_compile_options(unittests PRIVATE -coverage -fcoverage-mapping -fprofile-instr-generate)
@@ -335,11 +340,17 @@ if (ARK_BUILD_EXE)
     target_compile_features(arkscript PRIVATE cxx_std_20)
 
     if (ARK_UNITY_BUILD)
-        set_target_properties(arkscript PROPERTIES UNITY_BUILD ON UNITY_BUILD_MODE BATCH UNITY_BUILD_BATCH_SIZE 16)
+        set_target_properties(arkscript PROPERTIES
+                UNITY_BUILD ON
+                UNITY_BUILD_MODE BATCH
+                UNITY_BUILD_BATCH_SIZE 16)
     endif ()
     set_target_properties(arkscript PROPERTIES
             VS_DEBUGGER_WORKING_DIRECTORY "${ark_SOURCE_DIR}"
-            VS_DEBUGGER_COMMAND "$<TARGET_FILE:arkscript>")
+            VS_DEBUGGER_COMMAND "$<TARGET_FILE:arkscript>"
+            BUILD_WITH_INSTALL_RPATH ON
+            INSTALL_RPATH_USE_LINK_PATH ON)
+    set_target_rpath(arkscript)
 
     enable_lto(arkscript)
 

cmake/vars.cmake

@@ -0,0 +1,17 @@
+if ("${CMAKE_CXX_COMPILER_ID}" STREQUAL "Clang" OR "${CMAKE_CXX_COMPILER_ID}" STREQUAL "AppleClang")
+    set(CMAKE_COMPILER_IS_CLANG ON)
+endif ()
+
+if (${CMAKE_SYSTEM_NAME} MATCHES "Emscripten")
+    set(ARK_EMSCRIPTEN TRUE)
+endif ()
+
+function(set_target_rpath target)
+    if (APPLE)
+        set_target_properties(${target} PROPERTIES
+                INSTALL_RPATH "@executable_path;@executable_path/../lib;@executable_path/bin;@executable_path/lib")
+    elseif (UNIX)
+        set_target_properties(${target} PROPERTIES
+                INSTALL_RPATH "\$ORIGIN:\$ORIGIN/../lib:\$ORIGIN/bin:\$ORIGIN/lib")
+    endif ()
+endfunction()