doctest/examples/all_features/stringification.cpp

#ifdef _MSC_VER
__pragma(warning(push))
__pragma(warning(disable : 4643))
namespace std {
    template <typename> struct char_traits;
    template <typename, typename> class basic_ostream;
    typedef basic_ostream<char, char_traits<char>> ostream; // NOLINT(modernize-use-using)
    template<class TRAITS>
    basic_ostream<char, TRAITS>& operator<<(basic_ostream<char, TRAITS>&, const char*);
}
__pragma(warning(pop))
#else
#include <iostream>
#endif

namespace N {
    struct A { };
    struct B {
        friend std::ostream& operator<<(std::ostream& os, const B&) { return os << "B"; }
    };
    struct C { };
    static std::ostream& operator<<(std::ostream& os, const C&) { return os << "C"; }
}

static std::ostream& operator<<(std::ostream& os, const N::A&) { return os << "A"; }

#include <doctest/doctest.h>

#include <utility>

TEST_CASE("operator<<") {
    MESSAGE(N::A{ });
    MESSAGE(N::B{ });
    MESSAGE(N::C{ });
}

#include "header.h"

// std::move is broken with VS <= 15
#if defined(_MSC_VER) && _MSC_VER <= 1900
#define MOVE(...) __VA_ARGS__
#else
#define MOVE std::move
#endif

TEST_CASE("no headers") {
    char chs[] = { '1', 'a', 's' }; // NOLINT(*-avoid-c-arrays)
    MESSAGE(chs); CHECK(chs == nullptr);
    MESSAGE("1as"); CHECK("1as" == nullptr);

    int ints[] = { 0, 1, 1, 2, 3, 5, 8, 13 }; // NOLINT(*-avoid-c-arrays)
    MESSAGE(ints); CHECK(ints == nullptr);
    MESSAGE(MOVE(ints)); // NOLINT(*-move-const-arg)

    char* cptr = reinterpret_cast<char*>(ints + 4); // NOLINT
    const char* ccptr = cptr;
    void* vptr = reinterpret_cast<void*>(cptr);
    CHECK(doctest::toString(cptr) == doctest::toString(ccptr));
    CHECK(doctest::toString(ccptr) == doctest::toString(vptr));

    char* cnptr = nullptr;
    MESSAGE(cnptr); CHECK(cnptr != nullptr);

    enum Test {
        A = 0, B, C = 100,
    };
    MESSAGE(A); CHECK(A == C);

    MESSAGE(doctest::toString<int>());
}

DOCTEST_MAKE_STD_HEADERS_CLEAN_FROM_WARNINGS_ON_WALL_BEGIN
#include <string>
#include <vector>
#include <list>
#include <sstream>
#include <limits>
DOCTEST_MAKE_STD_HEADERS_CLEAN_FROM_WARNINGS_ON_WALL_END

DOCTEST_MSVC_SUPPRESS_WARNING(5045) // Spectre mitigation diagnostics

// the standard forbids writing in the std namespace but it works on all compilers
namespace std // NOLINT(cert-dcl58-cpp)
{
template <typename T>
ostream& operator<<(ostream& stream, const vector<T>& in) {
    stream << "[";
    for (size_t i = 0; i < in.size(); ++i) {
        if (i != 0) { stream << ", "; }
        stream << in[i];
    }
    stream << "]";
    return stream;
}
}

// as an alternative you may write a specialization of doctest::StringMaker
namespace doctest
{
template <typename T>
struct StringMaker<std::list<T>>
{
    static String convert(const std::list<T>& in) {
        std::ostringstream oss;

        oss << "[";
        // NOLINTNEXTLINE(*-use-auto)
        for (typename std::list<T>::const_iterator it = in.begin(); it != in.end();) {
            oss << *it;
            if (++it != in.end()) { oss << ", "; }
        }
        oss << "]";
        return oss.str().c_str();
    }
};
}

template <typename T, typename K>
struct MyType
{
    T one;
    K two;
};

template <typename T>
struct MyTypeInherited : MyType<T, unsigned>
{};

template <typename T, typename K>
bool operator==(const MyType<T, K>& lhs, const MyType<T, K>& rhs) {
    return lhs.one == rhs.one && lhs.two == rhs.two;
}

template <typename T, typename K>
std::ostream& operator<<(std::ostream& stream, const MyType<T, K>& in) {
    stream << "[" << in.one << ", " << in.two << "]";
    return stream;
}

namespace Bar
{
struct Foo
{
    friend bool operator==(const Foo&, const Foo&) { return false; }
};

// as a third option you may provide an overload of toString()
inline doctest::String toString(const Foo&) { return "Foo{}"; }

struct MyOtherType
{
    int data;
    friend bool operator==(const MyOtherType& l, const MyOtherType& r) { return l.data == r.data; }
};

// you also can use a template operator<< if your code does not use std::ostream
template <class OStream>
OStream& operator<<(OStream& stream, const MyOtherType& in) {
    stream << "MyOtherType: " << in.data;
    return stream;
}

} // namespace Bar

// set an exception translator for MyTypeInherited<int>
REGISTER_EXCEPTION_TRANSLATOR(MyTypeInherited<int>& ex) {
    return doctest::String("MyTypeInherited<int>(") + doctest::toString(ex.one) + ", " +
           doctest::toString(ex.two) + ")";
}

#define CHECK_NOT_DEFAULT_STR(var) CHECK(toString(var) != "{?}")

TEST_CASE("all asserts should fail and show how the objects get stringified") {
    MyTypeInherited<int> bla1;
    bla1.one = 5;
    bla1.two = 4u;

    Bar::Foo f1;
    MESSAGE(f1);
    Bar::Foo f2;
    CHECK(f1 == f2);

    doctest::String str;
    CHECK(str == doctest::toString(str));

    // std::string already has an operator<< working with std::ostream
    std::string dummy = "omg";

    MESSAGE(dummy);

    CHECK(dummy == "tralala"); // should fail
    CHECK("tralala" == dummy); // should fail

    std::vector<int> vec1;
    vec1.push_back(1);
    vec1.push_back(2);
    vec1.push_back(3);

    MESSAGE(vec1);

    std::vector<int> vec2;
    vec2.push_back(1);
    vec2.push_back(2);
    vec2.push_back(4);

    CHECK(vec1 == vec2);

    std::list<int> lst_1;
    lst_1.push_back(1);
    lst_1.push_back(42);
    lst_1.push_back(3);

    MESSAGE(lst_1);

    std::list<int> lst_2;
    lst_2.push_back(1);
    lst_2.push_back(2);
    lst_2.push_back(666);

    CHECK(lst_1 == lst_2);

    {
        Bar::MyOtherType s1 {42};
        Bar::MyOtherType s2 {666};
        INFO("s1=", s1, " s2=", s2);
        CHECK(s1 == s2);
        CHECK_MESSAGE(s1 == s2, s1, " is not really ", s2);
    }

    CHECK_NOT_DEFAULT_STR(doctest::IsNaN<double>(0.5));
    CHECK_NOT_DEFAULT_STR(!doctest::IsNaN<float>(std::numeric_limits<float>::infinity()));
    CHECK_NOT_DEFAULT_STR(doctest::IsNaN<double long>(std::numeric_limits<double long>::quiet_NaN()));

    CHECK("a" == doctest::Contains("aaa"));

    // lets see if this exception gets translated
    throw_if(true, bla1);
}

static doctest::String intTranslator(int ex) {
    return doctest::String("int: ") + doctest::toString(ex);
}

TEST_CASE("a test case that registers an exception translator for int and then throws one") {
    // set an exception translator for int - note that this shouldn't be done in a test case but
    // in main() or somewhere before executing the tests - but here I'm just lazy...
    doctest::registerExceptionTranslator(intTranslator);

    throw_if(true, 5);
}

static void function() { }
static int*** function2() { return nullptr; }

TEST_CASE("pointer comparisons") {
    int i = 42;
    int* a = &i;
    int* b = a;
    
    CHECK(a == b);
    CHECK_EQ(a, b);

    void (*functionPointer)() = &function;
    CHECK(&function == functionPointer);
    CHECK(&function2 == &function2);
}

enum class Foo { };

static std::ostream& operator<<(std::ostream& os, Foo) {
    return os << "Foo";
}

TEST_CASE("enum with operator<<") {
    CHECK(doctest::toString(Foo()) == "Foo");
}