Add automated tests for emscripten builds

Author: mcbarton

.github/workflows/emscripten.yml

@@ -550,10 +550,11 @@ jobs:
       if: ${{ runner.os != 'windows' }}
       shell: bash -l {0}
       run: |
+        set -e
         ./emsdk/emsdk activate ${{matrix.emsdk_ver}}
         source ./emsdk/emsdk_env.sh
         micromamba create -f environment-wasm.yml --platform=emscripten-wasm32
-
+        export SYSROOT_PATH=$PWD/emsdk/upstream/emscripten/cache/sysroot
         export PREFIX=$MAMBA_ROOT_PREFIX/envs/CppInterOp-wasm
         export CMAKE_PREFIX_PATH=$PREFIX
         export CMAKE_SYSTEM_PREFIX_PATH=$PREFIX
@@ -587,6 +588,7 @@ jobs:
                 -DCMAKE_INSTALL_PREFIX=$PREFIX         \
                 -DCMAKE_FIND_ROOT_PATH_MODE_PACKAGE=ON            \
                 -DLLVM_ENABLE_WERROR=On                      \
+                -DSYSROOT_PATH=$SYSROOT_PATH               \
                 ../
         else
           emcmake cmake -DCMAKE_BUILD_TYPE=${{ env.BUILD_TYPE }}    \
@@ -599,13 +601,14 @@ jobs:
                 -DCMAKE_INSTALL_PREFIX=$PREFIX      \
                 -DCMAKE_FIND_ROOT_PATH_MODE_PACKAGE=ON            \
                 -DLLVM_ENABLE_WERROR=On                      \
+                -DSYSROOT_PATH=$SYSROOT_PATH                     \
                 ../
         fi
-        
-        emmake make -j ${{ env.ncpus }} install
 
+        emmake make -j ${{ env.ncpus }}  check-cppinterop
         cd ..
-        
+
+        echo "SYSROOT_PATH=$SYSROOT_PATH" >> $GITHUB_ENV
         echo "CB_PYTHON_DIR=$CB_PYTHON_DIR" >> $GITHUB_ENV
         echo "CPPINTEROP_BUILD_DIR=$CPPINTEROP_BUILD_DIR" >> $GITHUB_ENV
         echo "CPPINTEROP_DIR=$CPPINTEROP_DIR" >> $GITHUB_ENV
@@ -618,7 +621,6 @@ jobs:
       run: |
         ./emsdk/emsdk activate ${{matrix.emsdk_ver}}
         source ./emsdk/emsdk_env.sh
-        export SYSROOT_PATH=$PWD/emsdk/upstream/emscripten/cache/sysroot
         micromamba activate CppInterOp-wasm  
         git clone --depth=1 https://github.com/compiler-research/xeus-cpp.git
         cd ./xeus-cpp
@@ -633,6 +635,6 @@ jobs:
           -DXEUS_CPP_EMSCRIPTEN_WASM_BUILD=ON               \
           -DCMAKE_FIND_ROOT_PATH_MODE_PACKAGE=ON            \
           -DCppInterOp_DIR="${{ env.CPPINTEROP_BUILD_DIR }}/lib/cmake/CppInterOp"  \
-          -DSYSROOT_PATH=$SYSROOT_PATH                      \
+          -DSYSROOT_PATH=${{ env.SYSROOT_PATH }}                     \
           ..
         emmake make -j ${{ env.ncpus }} install

CMakeLists.txt

@@ -361,11 +361,15 @@ endif()
 
 # Add appropriate flags for GCC
 if (LLVM_COMPILER_IS_GCC_COMPATIBLE)
-  if (APPLE)
+  if (APPLE OR EMSCRIPTEN)
     set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -fno-common -Woverloaded-virtual -Wcast-qual -fno-strict-aliasing -Wno-long-long -Wall -W -Wno-unused-parameter -Wwrite-strings")
   else()
     set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -fno-common -Woverloaded-virtual -Wcast-qual -fno-strict-aliasing -pedantic -Wno-long-long -Wall -W -Wno-unused-parameter -Wwrite-strings")
   endif ()
+  # Needed due an error which occurs when you compile gtest on emscripten
+  if (EMSCRIPTEN)
+    set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS}  -Wno-sign-compare")
+  endif()
 endif ()
 
 # Fixes "C++ exception handler used, but unwind semantics are not enabled" warning Windows
@@ -451,13 +455,7 @@ option(CPPINTEROP_ENABLE_DOXYGEN "Use doxygen to generate CppInterOp interal API
 option(CPPINTEROP_ENABLE_SPHINX "Use sphinx to generage CppInterOp user documentation")
 
 
-if(EMSCRIPTEN)
-    message("Build with emscripten")
-    option(CPPINTEROP_ENABLE_TESTING "Enables the testing infrastructure." OFF)
-else()
-    message("Build with cmake")
-    option(CPPINTEROP_ENABLE_TESTING "Enables the testing infrastructure." ON)
-endif()
+option(CPPINTEROP_ENABLE_TESTING "Enables the testing infrastructure." ON)
 
 if(MSVC)
 

Emscripten-build-instructions.md

@@ -25,11 +25,12 @@ git clone https://github.com/emscripten-core/emsdk.git
 ./emsdk/emsdk install  3.1.73
 ```
 
-and activate the emsdk environment
+and activate the emsdk environment (we are defining SYSROOT_PATH for use later)
 
 ```bash
 ./emsdk/emsdk activate 3.1.73
 source ./emsdk/emsdk_env.sh
+export SYSROOT_PATH=$PWD/emsdk/upstream/emscripten/cache/sysroot
 ```
 
 Now clone the 19.x release of the LLVM project repository and CppInterOp (the building of the emscripten version of llvm can be
@@ -97,7 +98,7 @@ export CMAKE_PREFIX_PATH=$PREFIX
 export CMAKE_SYSTEM_PREFIX_PATH=$PREFIX
 ```
 
-Now to build CppInterOp execute the following  
+Now to build and test your Emscripten build of CppInterOp by executing the following  
 
 ```bash
 mkdir build
@@ -109,7 +110,14 @@ emcmake cmake -DCMAKE_BUILD_TYPE=Release    \
                 -DBUILD_SHARED_LIBS=ON                      \
                 -DCMAKE_FIND_ROOT_PATH_MODE_PACKAGE=ON            \
                 -DCMAKE_INSTALL_PREFIX=$PREFIX         \
+                -DSYSROOT_PATH=$SYSROOT_PATH                                   \
                 ../
+emmake make -j $(nproc --all) check-cppinterop
+```
+
+Assuming it passes all test you can install by executing the following
+
+```bash
 emmake make -j $(nproc --all) install
 ```
 
@@ -126,7 +134,6 @@ the CppInterOp build folder, you can build the wasm version of xeus-cpp by execu
 
 ```bash
 cd ../..
-export SYSROOT_PATH=$PWD/emsdk/upstream/emscripten/cache/sysroot
 git clone --depth=1 https://github.com/compiler-research/xeus-cpp.git
 cd ./xeus-cpp
 mkdir build

cmake/CppInterOp/CppInterOpConfig.cmake.in

@@ -17,7 +17,11 @@ endif()
 
 ### build/install workaround
 if (@BUILD_SHARED_LIBS@)
-  set(_lib_suffix ${CMAKE_SHARED_LIBRARY_SUFFIX})
+  if(EMSCRIPTEN)
+    set(_lib_suffix ".wasm")
+  else()
+    set(_lib_suffix ${CMAKE_SHARED_LIBRARY_SUFFIX})
+  endif()
   set(_lib_prefix ${CMAKE_SHARED_LIBRARY_PREFIX})
 else()
   set(_lib_suffix ${CMAKE_STATIC_LIBRARY_SUFFIX})

cmake/modules/GoogleTest.cmake

@@ -20,6 +20,8 @@ elseif(APPLE)
 endif()
 
 include(ExternalProject)
+if(EMSCRIPTEN)
+
 ExternalProject_Add(
   googletest
   GIT_REPOSITORY https://github.com/google/googletest.git
@@ -31,15 +33,10 @@ ExternalProject_Add(
   # CMAKE_ARGS -DCMAKE_ARCHIVE_OUTPUT_DIRECTORY_DEBUG:PATH=DebugLibs
   #            -DCMAKE_ARCHIVE_OUTPUT_DIRECTORY_RELEASE:PATH=ReleaseLibs
   #            -Dgtest_force_shared_crt=ON
-  CMAKE_ARGS -G ${CMAKE_GENERATOR}
-                -DCMAKE_BUILD_TYPE=$<CONFIG>
-                -DCMAKE_C_COMPILER=${CMAKE_C_COMPILER}
-                -DCMAKE_C_FLAGS=${CMAKE_C_FLAGS}
-                -DCMAKE_CXX_COMPILER=${CMAKE_CXX_COMPILER}
-                -DCMAKE_CXX_FLAGS=${CMAKE_CXX_FLAGS}
-                -DCMAKE_AR=${CMAKE_AR}
-                -DCMAKE_INSTALL_PREFIX=${CMAKE_INSTALL_PREFIX}
-                ${EXTRA_GTEST_OPTS}
+  CONFIGURE_COMMAND emcmake cmake -DCMAKE_CXX_FLAGS=${CMAKE_CXX_FLAGS}
+  		    -S ${CMAKE_BINARY_DIR}/unittests/googletest-prefix/src/googletest/
+		    -B ${CMAKE_BINARY_DIR}/unittests/googletest-prefix/src/googletest-build/
+  BUILD_COMMAND emmake make
   # Disable install step
   INSTALL_COMMAND ""
   BUILD_BYPRODUCTS ${_gtest_byproducts}
@@ -50,6 +47,40 @@ ExternalProject_Add(
   TIMEOUT 600
   )
 
+else()
+
+  ExternalProject_Add(
+    googletest
+    GIT_REPOSITORY https://github.com/google/googletest.git
+    GIT_SHALLOW 1
+    GIT_TAG v1.15.2
+    UPDATE_COMMAND ""
+    # # Force separate output paths for debug and release builds to allow easy
+    # # identification of correct lib in subsequent TARGET_LINK_LIBRARIES commands
+    # CMAKE_ARGS -DCMAKE_ARCHIVE_OUTPUT_DIRECTORY_DEBUG:PATH=DebugLibs
+    #            -DCMAKE_ARCHIVE_OUTPUT_DIRECTORY_RELEASE:PATH=ReleaseLibs
+    #            -Dgtest_force_shared_crt=ON
+    CMAKE_ARGS -G ${CMAKE_GENERATOR}
+                -DCMAKE_BUILD_TYPE=$<CONFIG>
+                -DCMAKE_C_COMPILER=${CMAKE_C_COMPILER}
+                -DCMAKE_C_FLAGS=${CMAKE_C_FLAGS}
+                -DCMAKE_CXX_COMPILER=${CMAKE_CXX_COMPILER}
+                -DCMAKE_CXX_FLAGS=${CMAKE_CXX_FLAGS}
+                -DCMAKE_AR=${CMAKE_AR}
+                -DCMAKE_INSTALL_PREFIX=${CMAKE_INSTALL_PREFIX}
+                ${EXTRA_GTEST_OPTS}
+    # Disable install step
+    INSTALL_COMMAND ""
+    BUILD_BYPRODUCTS ${_gtest_byproducts}
+    # Wrap download, configure and build steps in a script to log output
+    LOG_DOWNLOAD ON
+    LOG_CONFIGURE ON
+    LOG_BUILD ON
+    TIMEOUT 600
+  )
+
+endif()
+
 # Specify include dirs for gtest and gmock
 ExternalProject_Get_Property(googletest source_dir)
 set(GTEST_INCLUDE_DIR ${source_dir}/googletest/include)

docs/Emscripten-build-instructions.rst

@@ -35,12 +35,13 @@ This can be installed by executing (we only currently support version
    git clone https://github.com/emscripten-core/emsdk.git
    ./emsdk/emsdk install  3.1.73
 
-and activate the emsdk environment
+and activate the emsdk environment (we are defining SYSROOT_PATH for use later)
 
 .. code:: bash
 
    ./emsdk/emsdk activate 3.1.73
    source ./emsdk/emsdk_env.sh
+   export SYSROOT_PATH=$PWD/emsdk/upstream/emscripten/cache/sysroot
 
 Now clone the 19.x release of the LLVM project repository and CppInterOp
 (the building of the emscripten version of llvm can be avoided by
@@ -115,7 +116,7 @@ You will also want to set a few environment variables
    export CMAKE_PREFIX_PATH=$PREFIX
    export CMAKE_SYSTEM_PREFIX_PATH=$PREFIX
 
-Now to build CppInterOp execute the following
+Now to build and test your Emscripten build of CppInterOp by executing the following  
 
 .. code:: bash
 
@@ -128,7 +129,14 @@ Now to build CppInterOp execute the following
                  -DBUILD_SHARED_LIBS=ON                      \
                  -DCMAKE_FIND_ROOT_PATH_MODE_PACKAGE=ON            \
                  -DCMAKE_INSTALL_PREFIX=$PREFIX         \
+                 -DSYSROOT_PATH=$SYSROOT_PATH                                   \
                  ../
+   emmake make -j $(nproc --all) check-cppinterop
+
+Assuming it passes all test you can install by executing the following. 
+
+.. code:: bash
+
    emmake make -j $(nproc --all) install
 
 Once this finishes building we need to take note of where we built
@@ -147,7 +155,6 @@ build folder, you can build the wasm version of xeus-cpp by executing
 .. code:: bash
 
    cd ../..
-   export SYSROOT_PATH=$PWD/emsdk/upstream/emscripten/cache/sysroot
    git clone --depth=1 https://github.com/compiler-research/xeus-cpp.git
    cd ./xeus-cpp
    mkdir build

lib/Interpreter/CMakeLists.txt

@@ -1,33 +1,7 @@
 if(EMSCRIPTEN)
   set_property(GLOBAL PROPERTY TARGET_SUPPORTS_SHARED_LIBS TRUE)
-  set(CMAKE_SHARED_LIBRARY_CREATE_C_FLAGS "-s SIDE_MODULE=1")
-  set(CMAKE_SHARED_LIBRARY_CREATE_CXX_FLAGS "-s SIDE_MODULE=1")
   set(CMAKE_STRIP FALSE)
-
-  add_llvm_library(clangCppInterOp
-    SHARED
-
-    CppInterOp.cpp
-    CXCppInterOp.cpp
-    DynamicLibraryManager.cpp
-    DynamicLibraryManagerSymbol.cpp
-    Paths.cpp
-
-    # Additional libraries from Clang and LLD
-    LINK_LIBS
-    clangInterpreter
-  )
-  #FIXME: Setting no_soname=1 is needed until https://github.com/emscripten-core/emscripten/blob/ac676d5e437525d15df5fd46bc2c208ec6d376a3/cmake/Modules/Platform/Emscripten.cmake#L36
-  # is patched out of emsdk, as --soname is not recognised by emscripten. A PR to do this has been done here https://github.com/emscripten-core/emscripten/pull/23453 
-  #FIXME: A patch is needed to llvm to remove -Wl,-z,defs since it is now recognised on emscripten. What needs to be removed is here
-  # https://github.com/llvm/llvm-project/blob/128e2e446e90c3b1827cfc7d4d19e3c0976beff3/llvm/cmake/modules/HandleLLVMOptions.cmake#L318 . The PR to do try to do this is here 
-  # https://github.com/llvm/llvm-project/pull/123396
-  set_target_properties(clangCppInterOp
-  PROPERTIES NO_SONAME 1
-)
-  target_link_options(clangCppInterOp PRIVATE
-    PUBLIC "SHELL: -s WASM_BIGINT"
-  )
+  set(LLVM_LINK_COMPONENTS "")
 else()
   set(LLVM_LINK_COMPONENTS
     ${LLVM_TARGETS_TO_BUILD}
@@ -41,6 +15,7 @@ else()
   if ("LLVMFrontendDriver" IN_LIST LLVM_AVAILABLE_LIBS)
     list(APPEND LLVM_LINK_COMPONENTS  FrontendDriver)
   endif()
+endif()
   if ("LLVMOrcDebugging" IN_LIST LLVM_AVAILABLE_LIBS)
     list(APPEND LLVM_LINK_COMPONENTS OrcDebugging)
   endif()
@@ -65,6 +40,11 @@ else()
     set(cling_clang_interp clangInterpreter)
   endif()
 
+if(EMSCRIPTEN)
+  set(link_libs
+    ${cling_clang_interp}
+    )
+else()
   set(link_libs
     ${cling_clang_interp}
     clangAST
@@ -73,6 +53,7 @@ else()
     clangLex
     clangSema
     )
+endif()
 
   if(NOT WIN32)
     list(APPEND link_libs dl)
@@ -124,7 +105,6 @@ else()
       clangStaticAnalyzerCore
       )
   endif(LLVM_LINK_LLVM_DYLIB)
-
   add_llvm_library(clangCppInterOp
     DISABLE_LLVM_LINK_LLVM_DYLIB
     CppInterOp.cpp
@@ -133,6 +113,28 @@ else()
     LINK_LIBS
     ${link_libs}
   )
+
+if(EMSCRIPTEN)
+  # Read the undefined symbols from the text file
+  file(READ "${CMAKE_SOURCE_DIR}/lib/Interpreter/undefined_symbols.txt" SYMBOLS_LIST)
+  
+  # Replace newlines with spaces
+  string(REPLACE "\n" " " SYMBOLS_LIST "${SYMBOLS_LIST}")
+  #FIXME: Setting no_soname=1 is needed until https://github.com/emscripten-core/emscripten/blob/ac676d5e437525d15df5fd46bc2c208ec6d376a3/cmake/Modules/Platform/Emscripten.cmake#L36
+  # is patched out of emsdk, as --soname is not recognised by emscripten. A PR to do this has been done here https://github.com/emscripten-core/emscripten/pull/23453 
+  #FIXME: A patch is needed to llvm to remove -Wl,-z,defs since it is now recognised on emscripten. What needs to be removed is here
+  # https://github.com/llvm/llvm-project/blob/128e2e446e90c3b1827cfc7d4d19e3c0976beff3/llvm/cmake/modules/HandleLLVMOptions.cmake#L318 . The PR to do try to do this is here 
+  # https://github.com/llvm/llvm-project/pull/123396
+  set_target_properties(clangCppInterOp PROPERTIES 
+    NO_SONAME 1
+    COMPILE_FLAGS "-s SIDE_MODULE=1"
+    LINK_FLAGS "-s WASM_BIGINT  -s SIDE_MODULE=1 ${SYMBOLS_LIST}"
+    SUFFIX ".wasm"
+  )
+
+  add_custom_command(TARGET clangCppInterOp POST_BUILD
+    COMMAND ${CMAKE_COMMAND} -E copy $<TARGET_FILE:clangCppInterOp> ${CMAKE_BINARY_DIR}/unittests/CppInterOp/
+  )
 endif()
 
 string(REPLACE ";" "\;" _VER CPPINTEROP_VERSION)