Add automated tests for Emscripten builds

Author: mcbarton

.github/workflows/deploy-pages.yml

@@ -93,10 +93,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
@@ -130,6 +131,7 @@ jobs:
                 -DCODE_COVERAGE=${{ env.CODE_COVERAGE }}        \
                 -DCMAKE_INSTALL_PREFIX=$PREFIX         \
                 -DCMAKE_FIND_ROOT_PATH_MODE_PACKAGE=ON            \
+                -DSYSROOT_PATH=$SYSROOT_PATH               \
                 ../
         else
           emcmake cmake -DCMAKE_BUILD_TYPE=${{ env.BUILD_TYPE }}    \
@@ -141,13 +143,15 @@ jobs:
                 -DCODE_COVERAGE=${{ env.CODE_COVERAGE }}    \
                 -DCMAKE_INSTALL_PREFIX=$PREFIX      \
                 -DCMAKE_FIND_ROOT_PATH_MODE_PACKAGE=ON            \
+                -DSYSROOT_PATH=$SYSROOT_PATH               \
                 ../
         fi
-        
+        emmake make -j ${{ env.ncpus }} check-cppinterop
         emmake make -j ${{ env.ncpus }} install
 
         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
@@ -160,7 +164,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
@@ -175,7 +178,7 @@ 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
 

.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,15 @@ 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
+        emmake make -j ${{ env.ncpus }} install
         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 +622,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 +636,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 to 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

@@ -13,41 +13,49 @@ if(WIN32)
     -DCMAKE_ARCHIVE_OUTPUT_DIRECTORY_MINSIZEREL:PATH=${_gtest_byproduct_binary_dir}/lib/
     -DCMAKE_ARCHIVE_OUTPUT_DIRECTORY_RELEASE:PATH=${_gtest_byproduct_binary_dir}/lib/
     -DCMAKE_ARCHIVE_OUTPUT_DIRECTORY_RELWITHDEBINFO:PATH=${_gtest_byproduct_binary_dir}/lib/
-    -Dgtest_force_shared_crt=ON
-    BUILD_COMMAND ${CMAKE_COMMAND} --build <BINARY_DIR> --config $<CONFIG>)
+    -Dgtest_force_shared_crt=ON)
 elseif(APPLE)
   set(EXTRA_GTEST_OPTS -DCMAKE_OSX_SYSROOT=${CMAKE_OSX_SYSROOT})
 endif()
 
 include(ExternalProject)
-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}
+if (EMSCRIPTEN)
+  set(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/)
+  set(BUILD_COMMAND emmake make)
+else()
+  set(CONFIGURE_COMMAND ${CMAKE_COMMAND} 
+  		-S ${CMAKE_BINARY_DIR}/unittests/googletest-prefix/src/googletest/
+		-B ${CMAKE_BINARY_DIR}/unittests/googletest-prefix/src/googletest-build/
+    		-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
+                ${EXTRA_GTEST_OPTS})
+  set(BUILD_COMMAND ${CMAKE_COMMAND} --build ${CMAKE_BINARY_DIR}/unittests/googletest-prefix/src/googletest-build/ --config $<CONFIG>)
+endif()
+
+  ExternalProject_Add(
+    googletest
+    GIT_REPOSITORY https://github.com/google/googletest.git
+    GIT_SHALLOW 1
+    GIT_TAG v1.15.2
+    UPDATE_COMMAND ""
+    CONFIGURE_COMMAND ${CONFIGURE_COMMAND}
+    BUILD_COMMAND ${BUILD_COMMAND}
+    # 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
   )
 
 # Specify include dirs for gtest and gmock

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