Merge pull request #454 from JohanMabille/doctest

Migrated to doctest

Author: JohanMabille

.appveyor.yml

@@ -27,11 +27,11 @@ install:
   - conda update -q conda
   - conda info -a
   # Install dependencies
-  - conda install cmake dirent xeus-zmq=1.0.0 cling=0.8 clangdev=5 llvmdev=5 nlohmann_json cppzmq xtl=0.7 pugixml cxxopts=2.1.2 -c conda-forge
+  - conda install cmake dirent xeus-zmq=1.0.0 cling=0.8 clangdev=5 llvmdev=5 nlohmann_json cppzmq xtl=0.7 pugixml cxxopts=2.1.2 doctest>=2.4.6 -c conda-forge
   # Build and install xeus-cling
   - mkdir build
   - cd build
-  - cmake -G "NMake Makefiles" -D CMAKE_INSTALL_PREFIX=%MINICONDA%\\Library -D CMAKE_BUILD_TYPE=Release -D XEXTRA_JUPYTER_DATA_DIR=%MINICONDA%\\share\\jupyter -D DOWNLOAD_GTEST=ON ..
+  - cmake -G "NMake Makefiles" -D CMAKE_INSTALL_PREFIX=%MINICONDA%\\Library -D CMAKE_BUILD_TYPE=Release -D XEXTRA_JUPYTER_DATA_DIR=%MINICONDA%\\share\\jupyter -D XEUS_CLING_BUILD_TESTS=ON ..
   - nmake
   - nmake install
   # Install jupyter_kernel_test and pytest

.azure-pipelines/unix-build.yml

@@ -20,7 +20,7 @@ steps:
       source activate build-xeus-cling
       mkdir build
       cd build
-      cmake -DCMAKE_PREFIX_PATH=$PREFIX -DCMAKE_INSTALL_PREFIX=$PREFIX -DDOWNLOAD_GTEST=ON -DCMAKE_INSTALL_LIBDIR=lib $(Build.SourcesDirectory)
+      cmake -DCMAKE_PREFIX_PATH=$PREFIX -DCMAKE_INSTALL_PREFIX=$PREFIX -DXEUS_CLING_BUILD_TESTS=ON -DCMAKE_INSTALL_LIBDIR=lib $(Build.SourcesDirectory)
     displayName: Configure xeus-cling
     workingDirectory: $(Build.BinariesDirectory)
 

CMakeLists.txt

@@ -330,14 +330,9 @@ endif(MSVC)
 # Tests #
 #########
 
-OPTION(BUILD_TESTS "xeus-cling test suite" OFF)
-OPTION(DOWNLOAD_GTEST "build gtest from downloaded sources" OFF)
+OPTION(XEUS_CLING_BUILD_TESTS "xeus-cling test suite" OFF)
 
-if(DOWNLOAD_GTEST OR GTEST_SRC_DIR)
-    set(BUILD_TESTS ON)
-endif()
-
-if(BUILD_TESTS)
+if(XEUS_CLING_BUILD_TESTS)
     add_subdirectory(test)
 endif()
 

environment-host.yml

@@ -17,3 +17,4 @@ dependencies:
   # Test dependencies
   - pytest
   - jupyter_kernel_test
+  - doctest >= 2.4.6

test/CMakeLists.txt

@@ -30,52 +30,17 @@ if(CMAKE_CXX_COMPILER_ID MATCHES MSVC)
     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")
-    set(GTEST_BOTH_LIBRARIES  gtest_main gtest)
-else()
-    find_package(GTest REQUIRED)
-endif()
-
+find_package(doctest)
 find_package(Threads)
 
 include_directories(${GTEST_INCLUDE_DIRS} SYSTEM)
 
 set(XEUS_CLING_TESTS
+    main.cpp
     test_stream.cpp
 )
 
 add_executable(test_xeus_cling ${XEUS_CLING_TESTS})
-if(DOWNLOAD_GTEST OR GTEST_SRC_DIR)
-    add_dependencies(test_xeus_cling gtest_main)
-endif()
 
 if (APPLE)
     set_target_properties(test_xeus_cling PROPERTIES
@@ -93,7 +58,7 @@ set_target_properties(test_xeus_cling PROPERTIES
 )
 
 target_link_libraries(test_xeus_cling
-                      PRIVATE ${GTEST_BOTH_LIBRARIES}
+                      PRIVATE doctest::doctest
                       PRIVATE ${CMAKE_THREAD_LIBS_INIT})
 target_include_directories(test_xeus_cling PRIVATE ${XEUS_CLING_INCLUDE_DIR})
 

test/copyGTest.cmake.in

@@ -7,10 +7,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"

test/downloadGTest.cmake.in

@@ -7,7 +7,7 @@
 * The full license is in the file LICENSE, distributed with this software.         *
 ************************************************************************************/
 
-#include "gtest/gtest.h"
+#include "doctest/doctest.h"
 
 #include <functional>
 #include <iostream>
@@ -23,13 +23,16 @@ void callback(std::string value, std::list<std::string>& outputs)
     outputs.push_back(value);
 }
 
-TEST(stream, output)
+TEST_SUITE("stream")
 {
-    std::list<std::string> outputs;
-    xcpp::xoutput_buffer buffer(std::bind(callback, _1, std::ref(outputs)));
-    auto cout_strbuf = std::cout.rdbuf();
-    std::cout.rdbuf(&buffer);
-    std::cout << "Some output" << std::endl;
-    EXPECT_EQ(outputs.front(), "Some output\n");
-    std::cout.rdbuf(cout_strbuf);
+    TEST_CASE("output")
+    {
+        std::list<std::string> outputs;
+        xcpp::xoutput_buffer buffer(std::bind(callback, _1, std::ref(outputs)));
+        auto cout_strbuf = std::cout.rdbuf();
+        std::cout.rdbuf(&buffer);
+        std::cout << "Some output" << std::endl;
+        REQUIRE_EQ(outputs.front(), "Some output\n");
+        std::cout.rdbuf(cout_strbuf);
+    }
 }