Merge pull request #140 from DARMA-tasking/125-generate-pre-built-binaries-for-standalone-app

#125: Generate pre built binaries

Author: lifflander

.github/workflows/build-and-test-ubuntu.yml

@@ -86,6 +86,31 @@ jobs:
             VT_TV_COVERAGE_ENABLED=${{ env.VT_TV_COVERAGE_ENABLED }}
           outputs: type=local,dest=${{ env.OUTPUT_DIR }}
 
+      - name: Prepare Debian Package Structure
+        run: |
+          COMMIT_HASH=$(echo "${GITHUB_SHA}" | cut -c1-7)
+          mkdir -p pkg/DEBIAN
+          mkdir -p pkg/usr/local/bin
+          cp ${{ env.OUTPUT_DIR }}/tmp/pkg-artifacts/bin/vttv pkg/usr/local/bin/
+          cat <<EOF > pkg/DEBIAN/control
+          Package: vttv
+          Version: 1.6.0-${COMMIT_HASH}
+          Section: base
+          Priority: optional
+          Architecture: amd64
+          Maintainer: Pierre Pébay <[email protected]>
+          Depends: libx11-dev, libgl1-mesa-dev, libgomp1
+          Description: DARMA vt task visualizer.
+          EOF
+
+      - name: Build the Debian Package
+        run: |
+          COMMIT_HASH=$(echo "${GITHUB_SHA}" | cut -c1-7)
+          dpkg-deb --build pkg "${OUTPUT_DIR}/vttv-amd64-${COMMIT_HASH}.deb"
+
+      - name: Clean out pkg-artifacts
+        run: rm -rf "${OUTPUT_DIR}/tmp/pkg-artifacts"
+
       - name: Upload artifacts
         uses: actions/upload-artifact@v4
         if: always()

apps/CMakeLists.txt

@@ -1,6 +1,6 @@
 
 macro(add_test_for_app_vt_tv test_name test_exec)
-  if(${test_name} STREQUAL "vt-tv:vt-tv_standalone")
+  if(${test_name} STREQUAL "vt-tv:vttv")
     add_test(
       NAME ${test_name}
       COMMAND ${test_exec} -c tests/config/conf.yaml
@@ -59,4 +59,9 @@ foreach(APP_FULL ${PROJECT_APPS})
     MODULES ${VTK_LIBRARIES}
   )
 
+  install(
+    TARGETS ${APP}
+    DESTINATION bin
+  )
+
 endforeach()

apps/vt-tv_standalone.cc renamed to apps/vttv.cc

@@ -2,7 +2,7 @@
 //@HEADER
 // *****************************************************************************
 //
-//                                example2.cc
+//                                   vttv.cc
 //             DARMA/vt-tv => Virtual Transport -- Task Visualizer
 //
 // Copyright 2019-2024 National Technology & Engineering Solutions of Sandia, LLC

bindings/python/CMakeLists.txt

@@ -10,13 +10,17 @@ file(
 nanobind_build_library(nanobind SHARED)
 
 # Create the Python bindings for the module
-nanobind_add_module(vttv ${PYTHON_BINDING_SRCS} tv.cc)
+# small workaround here, use pyvttv target name to avoid conflict with binary executable
+# target, called vttv as well; we want the python package to be called vttv too,
+# thus the set_target_properties on OUTPUT_NAME.
+nanobind_add_module(pyvttv ${PYTHON_BINDING_SRCS} tv.cc)
+set_target_properties(pyvttv PROPERTIES OUTPUT_NAME "vttv")
 
 # .. Link it to necessary libraries
-target_link_libraries(vttv PUBLIC ${VT_TV_LIBRARY_NS} ${JSON_LIBRARY} ${FMT_LIBRARY})
-add_vttv_definitions(vttv)
+target_link_libraries(pyvttv PUBLIC ${VT_TV_LIBRARY_NS} ${JSON_LIBRARY} ${FMT_LIBRARY})
+add_vttv_definitions(pyvttv)
 
 vtk_module_autoinit(
-  TARGETS vttv
+  TARGETS pyvttv
   MODULES ${VTK_LIBRARIES}
 )

build.sh

@@ -45,6 +45,8 @@ GCOV="${GCOV:-gcov}"
 VT_TV_DIR="${VT_TV_DIR:-$CURRENT_DIR}"
 VT_TV_BUILD_DIR="${VT_TV_BUILD_DIR:-$PARENT_DIR/vt-tv/build}"
 VT_TV_OUTPUT_DIR="${VT_TV_OUTPUT_DIR:-$CURRENT_DIR/output}"
+VT_TV_INSTALL="${VT_TV_INSTALL:-OFF}"
+VT_TV_INSTALL_DIR="${VT_TV_INSTALL_DIR:-$VT_TV_BUILD_DIR/install}"
 # >> Build settings
 VT_TV_BUILD=$(on_off ${VT_TV_BUILD:-ON}) # option to turn off the build to only run tests
 VT_TV_BUILD_TYPE=${VT_TV_BUILD_TYPE:-Release}
@@ -76,6 +78,8 @@ help() {
 
       -b   --build=[bool]           Build vt-tv. Can be turned off for example to run tests without rebuilding. (VT_TV_BUILD=$VT_TV_BUILD)
       -d   --build-dir=[str]        Build directory (VT_TV_BUILD_DIR=$VT_TV_BUILD_DIR)
+      -i   --install                Enable installation after build (VT_TV_INSTALL=$VT_TV_INSTALL)
+      -l   --install-dir=[str]      Installation directory (VT_TV_INSTALL_DIR=$VT_TV_INSTALL_DIR)
       -m   --build-type=[str]       Set the CMAKE_BUILD_TYPE value (Debug|Release|...) (VT_TV_BUILD_TYPE=$VT_TV_BUILD_TYPE)
       -y   --clean=[bool]           Clean the output directory and the CMake cache. (VT_TV_CLEAN=$VT_TV_CLEAN)
       -p   --bindings               Build with Python bindings (VT_TV_PYTHON_BINDINGS_ENABLED=$VT_TV_PYTHON_BINDINGS_ENABLED)
@@ -124,6 +128,8 @@ while getopts btch-: OPT; do  # allow -b -t -c -h, and --long_attr=value"
   case "$OPT" in
     b | build )           VT_TV_BUILD=$(on_off $OPTARG) ;;
     d | build-dir )       VT_TV_BUILD_DIR=$(realpath "$OPTARG") ;;
+    i | install)          VT_TV_INSTALL=$(on_off $OPTARG) ;;
+    l | install-dir)      VT_TV_INSTALL_DIR=$(realpath "$OPTARG") ;;
     m | build-type)       VT_TV_BUILD_TYPE=$(on_off $OPTARG) ;;
     p | bindings )        VT_TV_PYTHON_BINDINGS_ENABLED=$(on_off $OPTARG) ;;
     c | cc)               CC="$OPTARG" ;;
@@ -185,6 +191,7 @@ if [[ "${VT_TV_BUILD}" == "ON" ]]; then
     \
     -DCMAKE_C_COMPILER="${CC}" \
     -DCMAKE_CXX_COMPILER="${CXX}" \
+    -DCMAKE_INSTALL_PREFIX="${VT_TV_INSTALL_DIR}" \
     \
     -DVT_TV_WERROR_ENABLED="${VT_TV_WERROR_ENABLED}" \
     \
@@ -201,6 +208,11 @@ if [[ "${VT_TV_BUILD}" == "ON" ]]; then
 
   time cmake --build . --parallel -j "${VT_TV_CMAKE_JOBS}"
 
+  if [[ "$VT_TV_INSTALL" == "ON" ]]; then
+    echo "> Installing to ${VT_TV_INSTALL_DIR}..."
+    cmake --install . --prefix "${VT_TV_INSTALL_DIR}"
+  fi
+
   popd
 
 fi # End build

ci/build.sh

@@ -11,6 +11,7 @@ bash -c "VT_TV_BUILD_DIR=/opt/build/vt-tv \
     VT_TV_TESTS_ENABLED=ON \
     VT_TV_COVERAGE_ENABLED=${VT_TV_COVERAGE_ENABLED:-OFF} \
     VT_TV_WERROR_ENABLED=ON \
+    VT_TV_INSTALL=ON \
     /opt/src/vt-tv/build.sh"
 
 echo "VT-TV build success"

ci/docker/build-and-test-ubuntu.dockerfile

@@ -40,3 +40,4 @@ RUN VTK_DIR=/opt/build/vtk bash /opt/src/vt-tv/ci/python_test.sh
 FROM scratch AS artifacts
 COPY --from=test-cpp /tmp/artifacts /tmp/artifacts
 COPY --from=test-python /opt/src/vt-tv/output/python_tests /tmp/python-artifacts
+COPY --from=build /opt/build/vt-tv/install /tmp/pkg-artifacts

ci/setup_vtk.sh

@@ -17,7 +17,7 @@ pushd $VTK_DIR
 cmake \
   -DCMAKE_BUILD_TYPE:STRING=Release \
   -DBUILD_TESTING:BOOL=OFF \
-  -DBUILD_SHARED_LIBS:BOOL=ON \
+  -DBUILD_SHARED_LIBS:BOOL=OFF \
   -S "$VTK_SRC_DIR" -B "$VTK_DIR"
 cmake --build "$VTK_DIR" -j$(nproc)
 

cmake/load_vtk_package.cmake

@@ -20,3 +20,22 @@ find_package(
 message(STATUS "VTK version: ${VTK_VERSION}")
 
 message(STATUS "VTK libraries: ${VTK_LIBRARIES}")
+
+foreach(VTK_LIBRARY ${VTK_LIBRARIES})
+  get_target_property(VTK_RUNTIME_LIBRARY_DIR ${VTK_LIBRARY} LOCATION)
+
+  list(
+    APPEND
+    VTK_RUNTIME_LIBRARY_DIRS
+    "${VTK_RUNTIME_LIBRARY_DIR}"
+  )
+endforeach()
+
+if(NOT VTK_RUNTIME_LIBRARY_DIRS)
+  message(FATAL_ERROR "VTK runtime library paths could not be determined!")
+endif()
+
+install(
+    FILES ${VTK_RUNTIME_LIBRARY_DIRS}
+    DESTINATION lib
+)

tests/unit/render/test_standalone_app.cc

@@ -73,9 +73,9 @@ TEST_P(StandaloneAppTest, test_run) {
     fmt::format("{}/tests/config/{}", SRC_DIR, std::get<0>(GetParam()));
   int expected_phases = std::get<1>(GetParam());
 
-  // Run vt-tv_standalone process
+  // Run vttv process
   auto cmd =
-    fmt::format("{}/apps/vt-tv_standalone --conf={}", BUILD_DIR, config_file);
+    fmt::format("{}/apps/vttv --conf={}", BUILD_DIR, config_file);
   const auto [status, output] = Util::exec(cmd.c_str());
   fmt::print(output);