Move CI to doctest instead of gtest

Author: serge-sans-paille

.github/workflows/benchmark.yml

@@ -1,6 +1,6 @@
 name: benchmark & examples
 on: [push, pull_request]
-concurrency: 
+concurrency:
   group: ${{ github.workflow }}-${{ github.job }}-${{ github.ref }}
   cancel-in-progress: true
 jobs:

.github/workflows/clang-format-check.yml

@@ -1,6 +1,6 @@
 name: clang-format
 on: [push, pull_request]
-concurrency: 
+concurrency:
   group: ${{ github.workflow }}-${{ github.job }}-${{ github.ref }}
   cancel-in-progress: true
 jobs:
@@ -13,3 +13,4 @@ jobs:
       uses: jidicula/[email protected]
       with:
         clang-format-version: '13'
+        exclude-regex: 'doctest.h'

.github/workflows/cross-sve.yml

@@ -31,7 +31,7 @@ jobs:
     - name: Setup
       run: |
         mkdir _build
-        cd _build && cmake .. -GNinja -DDOWNLOAD_GTEST=ON -DBUILD_TESTS=ON -DCMAKE_BUILD_TYPE=Release -DTARGET_ARCH=generic -DCMAKE_C_FLAGS="-march=armv8-a+sve -msve-vector-bits=${{ matrix.vector_bits }}" -DCMAKE_CXX_FLAGS="-march=armv8-a+sve -msve-vector-bits=${{ matrix.vector_bits }}" -DCMAKE_TOOLCHAIN_FILE=${{ github.workspace }}/.github/toolchains/gcc-aarch64-linux-gnu.cmake
+        cd _build && cmake .. -GNinja -DBUILD_TESTS=ON -DDOWNLOAD_DOCTEST=ON -DCMAKE_BUILD_TYPE=Release -DTARGET_ARCH=generic -DCMAKE_C_FLAGS="-march=armv8-a+sve -msve-vector-bits=${{ matrix.vector_bits }}" -DCMAKE_CXX_FLAGS="-march=armv8-a+sve -msve-vector-bits=${{ matrix.vector_bits }}" -DCMAKE_TOOLCHAIN_FILE=${{ github.workspace }}/.github/toolchains/gcc-aarch64-linux-gnu.cmake
     - name: Build
       run: cmake --build _build
     - name: Testing xsimd

.github/workflows/cross.yml

@@ -1,6 +1,6 @@
 name: Arm cross-compilation build
 on: [push, pull_request]
-concurrency: 
+concurrency:
   group: ${{ github.workflow }}-${{ github.job }}-${{ github.ref }}
   cancel-in-progress: true
 jobs:
@@ -53,7 +53,7 @@ jobs:
     - name: Setup
       run: |
         mkdir _build
-        cd _build && cmake .. -DDOWNLOAD_GTEST=ON -DBUILD_TESTS=ON -DBUILD_BENCHMARK=ON -DBUILD_EXAMPLES=ON -DCMAKE_BUILD_TYPE=Release -DTARGET_ARCH=generic -DCMAKE_C_FLAGS="-march=${{ matrix.target.arch }} ${{ matrix.target.flags }}" -DCMAKE_CXX_FLAGS="-march=${{ matrix.target.arch }} ${{ matrix.target.flags }}" -DCMAKE_TOOLCHAIN_FILE=${{ github.workspace }}/.github/toolchains/${{ matrix.sys.compiler }}-${{ matrix.target.dir }}.cmake
+        cd _build && cmake .. -DBUILD_TESTS=ON -DDOWNLOAD_DOCTEST=ON -DBUILD_BENCHMARK=ON -DBUILD_EXAMPLES=ON -DCMAKE_BUILD_TYPE=Release -DTARGET_ARCH=generic -DCMAKE_C_FLAGS="-march=${{ matrix.target.arch }} ${{ matrix.target.flags }}" -DCMAKE_CXX_FLAGS="-march=${{ matrix.target.arch }} ${{ matrix.target.flags }}" -DCMAKE_TOOLCHAIN_FILE=${{ github.workspace }}/.github/toolchains/${{ matrix.sys.compiler }}-${{ matrix.target.dir }}.cmake
     - name: Build
       run: cmake --build _build
     - name: Testing xsimd

.github/workflows/cxx-versions.yml

@@ -1,6 +1,6 @@
 name: C++ compatibility build
 on: [push, pull_request]
-concurrency: 
+concurrency:
   group: ${{ github.workflow }}-${{ github.job }}-${{ github.ref }}
   cancel-in-progress: true
 jobs:
@@ -13,11 +13,11 @@ jobs:
     - uses: actions/checkout@v2
     - name: Install dependencies
       run: |
-        sudo apt install g++ cmake
+          sudo apt install g++ cmake
     - name: Setup
       run: |
         mkdir _build
-        cd _build && cmake .. -DDOWNLOAD_GTEST=ON -DBUILD_TESTS=ON -DCMAKE_BUILD_TYPE=Release -DCMAKE_CXX_STANDARD=${{matrix.cxx-version}}
+        cd _build && cmake .. -DBUILD_TESTS=ON -DDOWNLOAD_DOCTEST=ON -DCMAKE_BUILD_TYPE=Release -DCMAKE_CXX_STANDARD=${{matrix.cxx-version}}
     - name: Build
       run: cmake --build _build
 

.github/workflows/linux.yml

@@ -39,9 +39,9 @@ jobs:
           sudo apt-get --no-install-suggests --no-install-recommends install gcc-$GCC_VERSION-multilib g++-$GCC_VERSION-multilib linux-libc-dev:i386
         fi
         CC=gcc-$GCC_VERSION
-        echo "CC=$CC" >> $GITHUB_ENV 
+        echo "CC=$CC" >> $GITHUB_ENV
         CXX=g++-$GCC_VERSION
-        echo "CXX=$CXX" >> $GITHUB_ENV 
+        echo "CXX=$CXX" >> $GITHUB_ENV
     - name: Setup compiler
       if: ${{ matrix.sys.compiler == 'clang' }}
       run: |
@@ -61,10 +61,7 @@ jobs:
         CC=clang-$LLVM_VERSION
         echo "CC=$CC" >> $GITHUB_ENV
         CXX=clang++-$LLVM_VERSION
-        echo "CXX=$CXX" >> $GITHUB_ENV 
-    - name: Setup Ninja
-      run: |
-        sudo apt-get install ninja-build
+        echo "CXX=$CXX" >> $GITHUB_ENV
     - name: Checkout xsimd
       uses: actions/checkout@v2
     - name: Install mamba
@@ -97,8 +94,7 @@ jobs:
 
         mkdir _build
         cd _build
-        cmake  .. -DDOWNLOAD_GTEST=ON \
-                  -DBUILD_TESTS=ON \
+        cmake  .. -DBUILD_TESTS=ON \
                   -DBUILD_BENCHMARK=ON \
                   -DBUILD_EXAMPLES=ON \
                   -DCMAKE_BUILD_TYPE=Release \

.github/workflows/macos.yml

@@ -1,6 +1,6 @@
 name: macOS build
 on: [push, pull_request]
-concurrency: 
+concurrency:
   group: ${{ github.workflow }}-${{ github.job }}-${{ github.ref }}
   cancel-in-progress: true
 jobs:
@@ -17,7 +17,7 @@ jobs:
     - name: Setup
       run: |
         mkdir _build
-        cd _build && cmake .. -DDOWNLOAD_GTEST=ON -DBUILD_TESTS=ON -DBUILD_BENCHMARK=ON -DBUILD_EXAMPLES=ON -DCMAKE_BUILD_TYPE=Release -DCMAKE_OSX_ARCHITECTURES="arm64;x86_64"
+        cd _build && cmake .. -DBUILD_TESTS=ON -DDOWNLOAD_DOCTEST=ON -DBUILD_BENCHMARK=ON -DBUILD_EXAMPLES=ON -DCMAKE_BUILD_TYPE=Release -DCMAKE_OSX_ARCHITECTURES="arm64;x86_64"
     - name: Build
       run: cmake --build _build
     - name: Testing sequential

.github/workflows/windows.yml

@@ -1,6 +1,6 @@
 name: Windows build
 on: [push, pull_request]
-concurrency: 
+concurrency:
   group: ${{ github.workflow }}-${{ github.job }}-${{ github.ref }}
   cancel-in-progress: true
 jobs:
@@ -27,7 +27,7 @@ jobs:
           # On 2019 in _mm256_rsqrt_ps, on 2022 in _mm256_blend_p*
           - { sys: { set: AVX } }
           # On both platforms x86 + AVX512 triggers a compiler crash
-          - { target: x86, sys: { set: AVX512 } } 
+          - { target: x86, sys: { set: AVX512 } }
     runs-on: windows-${{ matrix.os }}
     steps:
     - name: Setup compiler
@@ -43,7 +43,7 @@ jobs:
     - name: Setup
       run: |
         mkdir _build
-        cd _build && cmake .. -DDOWNLOAD_GTEST=ON -DBUILD_TESTS=ON -DBUILD_BENCHMARK=ON -DBUILD_EXAMPLES=ON -DCMAKE_BUILD_TYPE=Release -DCMAKE_CXX_FLAGS="${{ matrix.sys.flags }}" -G Ninja
+        cd _build && cmake .. -DBUILD_TESTS=ON -DDOWNLOAD_DOCTEST=ON -DBUILD_BENCHMARK=ON -DBUILD_EXAMPLES=ON -DCMAKE_BUILD_TYPE=Release -DCMAKE_CXX_FLAGS="${{ matrix.sys.flags }}" -G Ninja
     - name: Build
       run: |
         cd _build && cmake --build .
@@ -73,13 +73,14 @@ jobs:
             cc:p
             cmake:p
             ninja:p
+            doctest:p
       - name: Checkout xsimd
         uses: actions/checkout@v2
       - name: Configure
         run: |
           mkdir _build
           cd _build
-          cmake .. -DDOWNLOAD_GTEST=ON -DBUILD_TESTS=ON -DBUILD_BENCHMARK=ON -DBUILD_EXAMPLES=ON -DCMAKE_BUILD_TYPE=Release -G Ninja
+          cmake .. -DBUILD_TESTS=ON -DBUILD_BENCHMARK=ON -DBUILD_EXAMPLES=ON -DCMAKE_BUILD_TYPE=Release -G Ninja
       - name: Build
         run: ninja -C _build
       - name: Test

CMakeLists.txt

@@ -94,11 +94,6 @@ endif()
 
 OPTION(ENABLE_XTL_COMPLEX "enables support for xcomplex defined in xtl" OFF)
 OPTION(BUILD_TESTS "xsimd test suite" OFF)
-OPTION(DOWNLOAD_GTEST "build gtest from downloaded sources" OFF)
-
-if(DOWNLOAD_GTEST OR GTEST_SRC_DIR)
-    set(BUILD_TESTS ON)
-endif()
 
 if(ENABLE_XTL_COMPLEX)
     add_definitions(-DXSIMD_ENABLE_XTL_COMPLEX=1)

README.md

@@ -179,15 +179,15 @@ void mean(const vector_type& a, const vector_type& b, vector_type& res)
 
 ## Building and Running the Tests
 
-Building the tests requires the [GTest](https://github.com/google/googletest) testing framework and [cmake](https://cmake.org).
+Building the tests requires [cmake](https://cmake.org).
 
-gtest and cmake are available as a packages for most linux distributions. Besides, they can also be installed with the `conda` package manager (even on windows):
+`cmake` is available as a package for most linux distributions. Besides, they can also be installed with the `conda` package manager (even on windows):
 
 ```bash
-conda install -c conda-forge gtest cmake
+conda install -c conda-forge cmake
 ```
 
-Once `gtest` and `cmake` are installed, you can build and run the tests:
+Once `cmake` is installed, you can build and run the tests:
 
 ```bash
 mkdir build

environment.yml

@@ -4,3 +4,4 @@ channels:
 dependencies:
   - ninja
   - xtl
+  - doctest

test/CMakeLists.txt

@@ -33,6 +33,8 @@ string(TOUPPER "${CMAKE_BUILD_TYPE}" U_CMAKE_BUILD_TYPE)
 
 OPTION(XSIMD_ENABLE_WERROR "Turn on -Werror" OFF)
 
+
+
 ################
 # ARM SETTINGS #
 ################
@@ -65,10 +67,10 @@ if (CMAKE_CXX_COMPILER_ID MATCHES "Clang" OR CMAKE_CXX_COMPILER_ID MATCHES "GNU"
         endif()
 
         if (NOT CROSS_COMPILE_ARM)
-            set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -g -fPIC") 
+            set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -g -fPIC")
         endif()
     endif()
-    
+
     if (ANDROID)
         # Nothing to do here, we assume the cmake Android NDK toolchain sets the
         # correct options for arm and neon.
@@ -120,47 +122,6 @@ if(CMAKE_CXX_COMPILER_ID MATCHES Clang AND MSVC AND WIN32) # We are using clang-
     set(CMAKE_EXE_LINKER_FLAGS /MANIFEST:NO)
 endif()
 
-if(DOWNLOAD_GTEST OR GTEST_SRC_DIR)
-    if(DOWNLOAD_GTEST)
-        # Download and unpack googletest at configure time
-        configure_file(downloadGTest.cmake.in googletest-download/CMakeLists.txt)
-    else()
-        # Copy local source of googletest at configure time
-        configure_file(copyGTest.cmake.in googletest-download/CMakeLists.txt)
-    endif()
-    execute_process(COMMAND ${CMAKE_COMMAND} -G "${CMAKE_GENERATOR}" .
-                    RESULT_VARIABLE result
-                    WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/googletest-download )
-    if(result)
-        message(FATAL_ERROR "CMake step for googletest failed: ${result}")
-    endif()
-    execute_process(COMMAND ${CMAKE_COMMAND} --build .
-                    RESULT_VARIABLE result
-                    WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/googletest-download )
-    if(result)
-        message(FATAL_ERROR "Build step for googletest failed: ${result}")
-    endif()
-
-    set(gtest_force_shared_crt ON CACHE BOOL "" FORCE)
-
-    # Add googletest directly to our build. This defines
-    # the gtest and gtest_main targets.
-    add_subdirectory(${CMAKE_CURRENT_BINARY_DIR}/googletest-src
-                     ${CMAKE_CURRENT_BINARY_DIR}/googletest-build EXCLUDE_FROM_ALL)
-
-    set(GTEST_INCLUDE_DIRS "${gtest_SOURCE_DIR}/include")
-    add_library(GTest::GTest INTERFACE IMPORTED)
-    target_link_libraries(GTest::GTest INTERFACE gtest)
-    add_library(GTest::Main INTERFACE IMPORTED)
-    target_link_libraries(GTest::Main INTERFACE gtest_main)
-else()
-    find_package(GTest REQUIRED)
-endif()
-
-find_package(Threads)
-
-include_directories(${GTEST_INCLUDE_DIRS})
-
 set(XSIMD_TESTS
     main.cpp
     test_api.cpp
@@ -204,8 +165,32 @@ if(NOT MSVC)
 endif()
 
 add_executable(test_xsimd ${XSIMD_TESTS} ${XSIMD_HEADERS})
-target_link_libraries(test_xsimd xsimd GTest::GTest GTest::Main ${CMAKE_THREAD_LIBS_INIT})
 target_include_directories(test_xsimd PRIVATE ${XSIMD_INCLUDE_DIR})
+
+option(XSIMD_DOWNLOAD_DOCTEST OFF)
+find_package(doctest QUIET)
+if (doctest_FOUND)
+    set(DOCTEST_MINIMAL_VERSION 2.4.9)
+    if (doctest_VERSION VERSION_LESS DOCTEST_MINIMAL_VERSION)
+        message(FATAL_ERROR "Requires doctest >= ${DOCTEST_MINIMAL_VERSION}")
+    endif()
+    target_link_libraries(test_xsimd PRIVATE doctest::doctest)
+elseif(DOWNLOAD_DOCTEST)
+    file(MAKE_DIRECTORY "${CMAKE_CURRENT_BINARY_DIR}/doctest")
+    file(DOWNLOAD
+        "https://github.com/doctest/doctest/releases/download/v2.4.9/doctest.h"
+        "${CMAKE_CURRENT_BINARY_DIR}/doctest/doctest.h")
+    target_include_directories(test_xsimd PRIVATE ${CMAKE_CURRENT_BINARY_DIR})
+else()
+    message(FATAL_ERROR "
+    Cannot find required doctest component.
+    Please either set CMAKE_PREFIX_PATH to the location of doctestConfig.cmake,
+    or set DOWNLOAD_DOCTEST=ON")
+endif()
+
+if(ENABLE_XTL_COMPLEX)
+  target_include_directories(test_xsimd PRIVATE ${xtl_INCLUDE_DIRS})
+endif()
 add_test(NAME test_xsimd COMMAND test_xsimd)
 
 if(DEFINED XSIMD_FORCE_X86_INSTR_SET)
@@ -237,3 +222,5 @@ endif()
 if (XSIMD_ENABLE_WERROR)
     target_compile_options(test_xsimd PRIVATE -Werror -Wall -DXSIMD_SKIP_ON_WERROR)
 endif()
+
+

test/copyGTest.cmake.in

@@ -9,10 +9,5 @@
  * The full license is in the file LICENSE, distributed with this software. *
  ****************************************************************************/
 
-#include "gtest/gtest.h"
-
-int main(int argc, char* argv[])
-{
-    ::testing::InitGoogleTest(&argc, argv);
-    return RUN_ALL_TESTS();
-}
+#define DOCTEST_CONFIG_IMPLEMENT_WITH_MAIN
+#include "doctest/doctest.h"