// __ _____ _____ _____ // __| | __| | | | JSON for Modern C++ (supporting code) // | | |__ | | | | | | version 3.12.0 // |_____|_____|_____|_|___| https://github.com/nlohmann/json // // SPDX-FileCopyrightText: 2013-2026 Niels Lohmann // SPDX-License-Identifier: MIT #include "doctest_compatibility.h" #define JSON_TESTS_PRIVATE #include using nlohmann::json; namespace { // special test case to check if memory is leaked if constructor throws template struct bad_allocator : std::allocator { using std::allocator::allocator; bad_allocator() = default; template bad_allocator(const bad_allocator& /*unused*/) { } template [[noreturn]] void construct(T* /*unused*/, Args&& ... /*unused*/) // NOLINT(cppcoreguidelines-missing-std-forward) { throw std::bad_alloc(); } template struct rebind { using other = bad_allocator; }; }; } // namespace TEST_CASE("bad_alloc") { SECTION("bad_alloc") { // create JSON type using the throwing allocator using bad_json = nlohmann::basic_json; // creating an object should throw CHECK_THROWS_AS(bad_json(bad_json::value_t::object), std::bad_alloc&); } } namespace { bool next_construct_fails = false; bool next_destroy_fails = false; bool next_deallocate_fails = false; template struct my_allocator : std::allocator { using std::allocator::allocator; template void construct(T* p, Args&& ... args) { if (next_construct_fails) { next_construct_fails = false; throw std::bad_alloc(); } ::new (reinterpret_cast(p)) T(std::forward(args)...); } void deallocate(T* p, std::size_t n) { if (next_deallocate_fails) { next_deallocate_fails = false; throw std::bad_alloc(); } std::allocator::deallocate(p, n); } void destroy(T* p) { if (next_destroy_fails) { next_destroy_fails = false; throw std::bad_alloc(); } static_cast(p); // fix MSVC's C4100 warning p->~T(); } template struct rebind { using other = my_allocator; }; }; // allows deletion of raw pointer, usually hold by json_value template void my_allocator_clean_up(T* p) { assert(p != nullptr); my_allocator alloc; alloc.destroy(p); alloc.deallocate(p, 1); } } // namespace TEST_CASE("controlled bad_alloc") { // create JSON type using the throwing allocator using my_json = nlohmann::basic_json; SECTION("class json_value") { SECTION("json_value(value_t)") { SECTION("object") { next_construct_fails = false; auto t = my_json::value_t::object; CHECK_NOTHROW(my_allocator_clean_up(my_json::json_value(t).object)); next_construct_fails = true; CHECK_THROWS_AS(my_json::json_value(t), std::bad_alloc&); next_construct_fails = false; } SECTION("array") { next_construct_fails = false; auto t = my_json::value_t::array; CHECK_NOTHROW(my_allocator_clean_up(my_json::json_value(t).array)); next_construct_fails = true; CHECK_THROWS_AS(my_json::json_value(t), std::bad_alloc&); next_construct_fails = false; } SECTION("string") { next_construct_fails = false; auto t = my_json::value_t::string; CHECK_NOTHROW(my_allocator_clean_up(my_json::json_value(t).string)); next_construct_fails = true; CHECK_THROWS_AS(my_json::json_value(t), std::bad_alloc&); next_construct_fails = false; } } SECTION("json_value(const string_t&)") { next_construct_fails = false; const my_json::string_t v("foo"); CHECK_NOTHROW(my_allocator_clean_up(my_json::json_value(v).string)); next_construct_fails = true; CHECK_THROWS_AS(my_json::json_value(v), std::bad_alloc&); next_construct_fails = false; } } SECTION("class basic_json") { SECTION("basic_json(const CompatibleObjectType&)") { next_construct_fails = false; const std::map v {{"foo", "bar"}}; CHECK_NOTHROW(my_json(v)); next_construct_fails = true; CHECK_THROWS_AS(my_json(v), std::bad_alloc&); next_construct_fails = false; } SECTION("basic_json(const CompatibleArrayType&)") { next_construct_fails = false; const std::vector v {"foo", "bar", "baz"}; CHECK_NOTHROW(my_json(v)); next_construct_fails = true; CHECK_THROWS_AS(my_json(v), std::bad_alloc&); next_construct_fails = false; } SECTION("basic_json(const typename string_t::value_type*)") { next_construct_fails = false; CHECK_NOTHROW(my_json("foo")); next_construct_fails = true; CHECK_THROWS_AS(my_json("foo"), std::bad_alloc&); next_construct_fails = false; } SECTION("basic_json(const typename string_t::value_type*)") { next_construct_fails = false; const std::string s("foo"); CHECK_NOTHROW(my_json(s)); next_construct_fails = true; CHECK_THROWS_AS(my_json(s), std::bad_alloc&); next_construct_fails = false; } SECTION("basic_json(const basic_json&) of a deeply nested value (#5387)") { // Copying a value nested deeper than the descent bound builds the // copy from the top down: every value whose own copy has not been // made yet stays a null value until it is. Failing an allocation // part-way through is what proves such a half-built copy can still // be destroyed. // // Which path the failure lands in depends on the build: the first // allocation of a copy belongs to the outermost level, so here it // is the descending one. Built with JSON_NO_THREAD_LOCAL - as the // ci_test_no_thread_local target builds the whole suite - no // descent is made at all and the very same failure lands in the // iterative path instead, part-way through its worklist. const auto check_deep_copy = [](bool objects) { CAPTURE(objects); next_construct_fails = false; // deeper than the 128 levels the copy constructor descends into const std::size_t depth = 300; my_json j = 1; for (std::size_t i = 0; i < depth; ++i) { if (objects) { my_json wrapper = my_json::object(); wrapper["a"] = std::move(j); j = std::move(wrapper); } else { j = my_json::array({std::move(j)}); } } // NOLINTNEXTLINE(performance-unnecessary-copy-initialization): the copy is what is tested CHECK_NOTHROW(my_json(j)); next_construct_fails = true; // NOLINTNEXTLINE(performance-unnecessary-copy-initialization): the copy is what is tested CHECK_THROWS_AS(my_json(j), std::bad_alloc&); next_construct_fails = false; }; check_deep_copy(false); check_deep_copy(true); } } } namespace { // counts the allocations of pairs with a non-const first member: the object // types store std::pair, so only the scratch space of the // iterative deep copy allocates std::pair std::size_t scratch_pair_allocations = 0; template struct is_scratch_pair : std::false_type {}; template struct is_scratch_pair> : std::integral_constant < bool, !std::is_const::value > {}; template struct scratch_counting_allocator : std::allocator { using std::allocator::allocator; T* allocate(std::size_t n) { if (is_scratch_pair::value) { ++scratch_pair_allocations; } return std::allocator::allocate(n); } #ifdef __cpp_lib_allocate_at_least // std::allocator::allocate_at_least would bypass the counting, and // libc++'s containers prefer it over allocate from C++23 on auto allocate_at_least(std::size_t n) { if (is_scratch_pair::value) { ++scratch_pair_allocations; } return std::allocator::allocate_at_least(n); } #endif template struct rebind { using other = scratch_counting_allocator; }; }; } // namespace TEST_CASE("deep copy uses the provided allocator") { using counting_json = nlohmann::basic_json; // deeper than the 128 levels the copy constructor descends into, so the // innermost objects are copied by the iterative deep copy counting_json j = 1; for (std::size_t i = 0; i < 300; ++i) { counting_json wrapper = counting_json::object(); wrapper["a"] = std::move(j); j = std::move(wrapper); } scratch_pair_allocations = 0; // NOLINTNEXTLINE(performance-unnecessary-copy-initialization): the copy is what is tested const counting_json copy(j); CHECK(scratch_pair_allocations > 0); CHECK(copy == j); } namespace { template struct allocator_no_forward : std::allocator { allocator_no_forward() = default; template allocator_no_forward(allocator_no_forward /*unused*/) {} template struct rebind { using other = allocator_no_forward; }; template void construct(T* p, const Args& ... args) noexcept(noexcept(::new (static_cast(p)) T(args...))) { // force copy even if move is available ::new (static_cast(p)) T(args...); } }; } // namespace TEST_CASE("bad my_allocator::construct") { SECTION("my_allocator::construct doesn't forward") { using bad_alloc_json = nlohmann::basic_json; bad_alloc_json j; j["test"] = bad_alloc_json::array_t(); j["test"].push_back("should not leak"); } }