c331706644
Github issue: https://github.com/nlohmann/json/issues/2073 nlohmann::json documents 2 way of depending on it using CMake 1) Copy-paste the project/source into your own project. 2) Install nlohman::json and then use find_package. (1) pollutes your git repository, (2) requires everyone to install the dependencies themselves. Since 2018, CMake provide some kind of 'package manager' features using [FetchContent](https://cmake.org/cmake/help/v3.17/module/FetchContent.html) It gives the following: ~~~cmake include(FetchContent) FetchContent_Declare(json GIT_REPOSITORY https://github.com/nlohmann/json GIT_TAG v3.7.3) FetchContent_GetProperties(json) if(NOT json_POPULATED) FetchContent_Populate(json) add_subdirectory( ${json_SOURCE_DIR} ${json_BINARY_DIR} EXCLUDE_FROM_ALL) endif() ~~~ Then declares the dependency in the target using it: ~~~cmake target_link_library(my_project PRIVATE nlohmann_json::nlohmann_json ~~~ This patch updates the documentation and provides tests.
192 lines
7.9 KiB
CMake
192 lines
7.9 KiB
CMake
option(JSON_Sanitizer "Build test suite with Clang sanitizer" OFF)
|
|
option(JSON_Valgrind "Execute test suite with Valgrind" OFF)
|
|
option(JSON_NoExceptions "Build test suite without exceptions" OFF)
|
|
option(JSON_Coverage "Build test suite with coverage information" OFF)
|
|
|
|
if(JSON_Sanitizer)
|
|
message(STATUS "Building test suite with Clang sanitizer")
|
|
if(NOT MSVC)
|
|
set(CMAKE_CXX_FLAGS "-g -O0 -fsanitize=address -fsanitize=undefined -fsanitize=integer -fsanitize=nullability -fno-omit-frame-pointer -fno-sanitize-recover=all -fsanitize-recover=unsigned-integer-overflow")
|
|
endif()
|
|
endif()
|
|
|
|
if(JSON_Valgrind)
|
|
find_program(CMAKE_MEMORYCHECK_COMMAND valgrind)
|
|
message(STATUS "Executing test suite with Valgrind (${CMAKE_MEMORYCHECK_COMMAND})")
|
|
set(memcheck_command "${CMAKE_MEMORYCHECK_COMMAND} ${CMAKE_MEMORYCHECK_COMMAND_OPTIONS} --error-exitcode=1 --leak-check=full")
|
|
separate_arguments(memcheck_command)
|
|
endif()
|
|
|
|
if(JSON_NoExceptions)
|
|
message(STATUS "Building test suite without exceptions")
|
|
if(NOT MSVC)
|
|
set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -DJSON_NOEXCEPTION")
|
|
endif()
|
|
set(DOCTEST_TEST_FILTER --no-throw)
|
|
endif()
|
|
|
|
if(JSON_Coverage)
|
|
message(STATUS "Building test suite with coverage information")
|
|
if(NOT "${CMAKE_CXX_COMPILER_ID}" STREQUAL "GNU")
|
|
message(FATAL_ERROR "JSON_Coverage requires GCC.")
|
|
endif()
|
|
|
|
# enable profiling
|
|
set(CMAKE_CXX_FLAGS "--coverage -g -O0 -fprofile-arcs -ftest-coverage")
|
|
|
|
# from https://github.com/RWTH-HPC/CMake-codecov/blob/master/cmake/FindGcov.cmake
|
|
get_filename_component(COMPILER_PATH "${CMAKE_CXX_COMPILER}" PATH)
|
|
string(REGEX MATCH "^[0-9]+" GCC_VERSION "${CMAKE_CXX_COMPILER_VERSION}")
|
|
find_program(GCOV_BIN NAMES gcov-${GCC_VERSION} gcov HINTS ${COMPILER_PATH})
|
|
|
|
# collect all source files from the chosen include dir
|
|
file(GLOB_RECURSE SOURCE_FILES ${NLOHMANN_JSON_INCLUDE_BUILD_DIR}*.hpp)
|
|
|
|
# add target to collect coverage information and generate HTML file
|
|
# (filter script from https://stackoverflow.com/a/43726240/266378)
|
|
add_custom_target(lcov_html
|
|
COMMAND lcov --directory . --capture --output-file json.info --rc lcov_branch_coverage=1
|
|
COMMAND lcov -e json.info ${SOURCE_FILES} --output-file json.info.filtered --gcov-tool ${GCOV_BIN} --rc lcov_branch_coverage=1
|
|
COMMAND ${CMAKE_SOURCE_DIR}/test/thirdparty/imapdl/filterbr.py json.info.filtered > json.info.filtered.noexcept
|
|
COMMAND genhtml --title "JSON for Modern C++" --legend --demangle-cpp --output-directory html --show-details --branch-coverage json.info.filtered.noexcept
|
|
COMMENT "Generating HTML report test/html/index.html"
|
|
)
|
|
|
|
add_custom_target(fastcov_html
|
|
COMMAND ${CMAKE_SOURCE_DIR}/test/thirdparty/fastcov/fastcov.py --branch-coverage --lcov -o json.info --gcov ${GCOV_BIN} --compiler-directory ${CMAKE_BINARY_DIR} --source-files ${SOURCE_FILES}
|
|
COMMAND ${CMAKE_SOURCE_DIR}/test/thirdparty/imapdl/filterbr.py json.info > json.info.noexcept
|
|
COMMAND genhtml --title "JSON for Modern C++" --legend --demangle-cpp --output-directory html --show-details --branch-coverage json.info.noexcept
|
|
COMMENT "Generating HTML report test/html/index.html"
|
|
)
|
|
endif()
|
|
|
|
#############################################################################
|
|
# doctest library with the main function to speed up build
|
|
#############################################################################
|
|
|
|
add_library(doctest_main OBJECT
|
|
"src/unit.cpp"
|
|
)
|
|
set_target_properties(doctest_main PROPERTIES
|
|
COMPILE_DEFINITIONS "$<$<CXX_COMPILER_ID:MSVC>:_SCL_SECURE_NO_WARNINGS>"
|
|
COMPILE_OPTIONS "$<$<CXX_COMPILER_ID:MSVC>:/EHsc;$<$<CONFIG:Release>:/Od>>"
|
|
)
|
|
if (${CMAKE_VERSION} VERSION_LESS "3.8.0")
|
|
target_compile_features(doctest_main PUBLIC cxx_range_for)
|
|
else()
|
|
target_compile_features(doctest_main PUBLIC cxx_std_11)
|
|
endif()
|
|
target_include_directories(doctest_main PRIVATE "thirdparty/doctest")
|
|
|
|
# https://stackoverflow.com/questions/2368811/how-to-set-warning-level-in-cmake
|
|
if(MSVC)
|
|
# Force to always compile with W4
|
|
if(CMAKE_CXX_FLAGS MATCHES "/W[0-4]")
|
|
string(REGEX REPLACE "/W[0-4]" "/W4" CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS}")
|
|
else()
|
|
set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} /W4")
|
|
endif()
|
|
|
|
# Disable warning C4566: character represented by universal-character-name '\uFF01' cannot be represented in the current code page (1252)
|
|
# Disable warning C4996: 'nlohmann::basic_json<std::map,std::vector,std::string,bool,int64_t,uint64_t,double,std::allocator,nlohmann::adl_serializer>::operator <<': was declared deprecated
|
|
set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} /wd4566 /wd4996")
|
|
|
|
# https://github.com/nlohmann/json/issues/1114
|
|
set(CMAKE_CXX_FLAGS_DEBUG "${CMAKE_CXX_FLAGS_DEBUG} /bigobj")
|
|
endif()
|
|
|
|
#############################################################################
|
|
# one executable for each unit test file
|
|
#############################################################################
|
|
|
|
set(files
|
|
src/unit-algorithms.cpp
|
|
src/unit-allocator.cpp
|
|
src/unit-alt-string.cpp
|
|
src/unit-bson.cpp
|
|
src/unit-capacity.cpp
|
|
src/unit-cbor.cpp
|
|
src/unit-class_const_iterator.cpp
|
|
src/unit-class_iterator.cpp
|
|
src/unit-class_lexer.cpp
|
|
src/unit-class_parser.cpp
|
|
src/unit-comparison.cpp
|
|
src/unit-concepts.cpp
|
|
src/unit-constructor1.cpp
|
|
src/unit-constructor2.cpp
|
|
src/unit-convenience.cpp
|
|
src/unit-conversions.cpp
|
|
src/unit-deserialization.cpp
|
|
src/unit-element_access1.cpp
|
|
src/unit-element_access2.cpp
|
|
src/unit-inspection.cpp
|
|
src/unit-items.cpp
|
|
src/unit-iterators1.cpp
|
|
src/unit-iterators2.cpp
|
|
src/unit-json_patch.cpp
|
|
src/unit-json_pointer.cpp
|
|
src/unit-large_json.cpp
|
|
src/unit-merge_patch.cpp
|
|
src/unit-meta.cpp
|
|
src/unit-modifiers.cpp
|
|
src/unit-msgpack.cpp
|
|
src/unit-noexcept.cpp
|
|
src/unit-pointer_access.cpp
|
|
src/unit-readme.cpp
|
|
src/unit-reference_access.cpp
|
|
src/unit-regression.cpp
|
|
src/unit-serialization.cpp
|
|
src/unit-testsuites.cpp
|
|
src/unit-to_chars.cpp
|
|
src/unit-ubjson.cpp
|
|
src/unit-udt.cpp
|
|
src/unit-unicode.cpp
|
|
src/unit-wstring.cpp)
|
|
|
|
foreach(file ${files})
|
|
get_filename_component(file_basename ${file} NAME_WE)
|
|
string(REGEX REPLACE "unit-([^$]+)" "test-\\1" testcase ${file_basename})
|
|
|
|
add_executable(${testcase} $<TARGET_OBJECTS:doctest_main> ${file})
|
|
target_compile_definitions(${testcase} PRIVATE
|
|
DOCTEST_CONFIG_SUPER_FAST_ASSERTS
|
|
)
|
|
target_compile_options(${testcase} PRIVATE
|
|
$<$<CXX_COMPILER_ID:MSVC>:/EHsc;$<$<CONFIG:Release>:/Od>>
|
|
$<$<NOT:$<CXX_COMPILER_ID:MSVC>>:-Wno-deprecated;-Wno-float-equal>
|
|
$<$<CXX_COMPILER_ID:GNU>:-Wno-deprecated-declarations>
|
|
)
|
|
target_include_directories(${testcase} PRIVATE
|
|
thirdparty/doctest
|
|
thirdparty/fifo_map
|
|
)
|
|
target_link_libraries(${testcase} ${NLOHMANN_JSON_TARGET_NAME})
|
|
|
|
add_test(NAME "${testcase}_default"
|
|
COMMAND ${testcase} ${DOCTEST_TEST_FILTER}
|
|
WORKING_DIRECTORY ${CMAKE_SOURCE_DIR}
|
|
)
|
|
set_tests_properties("${testcase}_default" PROPERTIES LABELS "default")
|
|
|
|
add_test(NAME "${testcase}_all"
|
|
COMMAND ${testcase} ${DOCTEST_TEST_FILTER} --no-skip
|
|
WORKING_DIRECTORY ${CMAKE_SOURCE_DIR}
|
|
)
|
|
set_tests_properties("${testcase}_all" PROPERTIES LABELS "all")
|
|
|
|
if(JSON_Valgrind)
|
|
add_test(NAME "${testcase}_valgrind"
|
|
COMMAND ${memcheck_command} ${CMAKE_CURRENT_BINARY_DIR}/${testcase} ${DOCTEST_TEST_FILTER}
|
|
WORKING_DIRECTORY ${CMAKE_SOURCE_DIR}
|
|
)
|
|
set_tests_properties("${testcase}_valgrind" PROPERTIES LABELS "valgrind")
|
|
endif()
|
|
endforeach()
|
|
|
|
#############################################################################
|
|
# Test the generated build configs
|
|
#############################################################################
|
|
add_subdirectory(cmake_import)
|
|
add_subdirectory(cmake_import_minver)
|
|
add_subdirectory(cmake_add_subdirectory)
|
|
add_subdirectory(cmake_fetch_content)
|