UTApprovalTestTests.cpp

// begin-snippet: ut_main
#define APPROVALS_UT
#include "ApprovalTests.hpp"
// end-snippet

#include "tests/DocTest_Tests/reporters/FakeReporter.h"

int main()
{
    using namespace boost::ut;

    auto directory = ApprovalTests::Approvals::useApprovalsSubdirectory("approval_tests");

    "ItReportsAndThrowsIfVerifyFails"_test = []() {
        auto front_loader = std::make_shared<FakeReporter>(true);

        // Use a front-loaded reporter so this is used even we are running
        // in a CI system.
        auto front_loaded_reporter_disposer =
            ApprovalTests::Approvals::useAsFrontLoadedReporter(front_loader);

        bool approvalMissingExceptionReceived = false;
        try
        {
            ApprovalTests::Approvals::verify("cucumber");
        }
        catch (const ApprovalTests::ApprovalMissingException&)
        {
            approvalMissingExceptionReceived = true;
        }
        catch (const std::exception& e)
        {
            expect(approvalMissingExceptionReceived == true)
                << "Unexpected exception received: " << e.what();
        }

        // If these start failing, run the tests with verbose on,
        // or ctest's --output-on-failure.
        // You will probably find that Boost.UT is unable to find the
        // name of the source file.
        // For ways to fix this, see:
        // https://github.com/approvals/ApprovalTests.cpp/blob/master/doc/TroubleshootingMisconfiguredBuild.md
        expect(approvalMissingExceptionReceived == true);
        expect(front_loader->called == true);
    };

    // begin-snippet: ut_main_usage
    "ItCanVerifyAFile"_test = []() {
        ApprovalTests::Approvals::verify(
            "Approval Tests can verify text via the golden master method");
    };
    // end-snippet

    test("AnotherWayItCanVerifyAFile") = []() {
        ApprovalTests::Approvals::verify(
            "Approval Tests can verify text via the golden master method");
    };

    // begin-snippet: ut_main_multiple
    "ItCanUseMultipleVerify"_test = []() {
        {
            // Here we simulate test sections, so that Approval Tests uses different
            // output file names for the different verify() calls.
            auto section =
                ApprovalTests::NamerFactory::appendToOutputFilename("section 1");
            ApprovalTests::Approvals::verify(
                "Approval Tests can verify text via the golden master method");
        }
        {
            auto section =
                ApprovalTests::NamerFactory::appendToOutputFilename("section 2");
            ApprovalTests::Approvals::verify(
                "Approval Tests can verify different text via "
                "the golden master method");
        }
    };
    // end-snippet

    "YouCanUseAWriter"_test = []() {
        // begin-snippet: ut_use_custom_writer
        using HtmlWriter = ApprovalTests::StringWriter;
        HtmlWriter writer("<h1>hello world</h1>", ".html");
        ApprovalTests::Approvals::verify(writer);
        // end-snippet
    };

    "YouCanSpecifyYourFileExtension"_test = []() {
        // begin-snippet: ut_use_custom_file_extension
        ApprovalTests::Approvals::verify(
            "<h1>hello world</h1>",
            ApprovalTests::Options().fileOptions().withFileExtension(".html"));
        // end-snippet
    };

    "YouCanSpecifyYourFileExtensionWithToString"_test = []() {
        ApprovalTests::Approvals::verify(
            1337, ApprovalTests::Options().fileOptions().withFileExtension(".csv"));
    };

    "YouCanSpecifyYourFileExtensionWithFormatter"_test = []() {
        ApprovalTests::Approvals::verify(
            1337,
            [](auto value, auto& os) { os << "**value:** " << value; },
            ApprovalTests::Options().fileOptions().withFileExtension(".md"));
    };

    "VerifyAFileWithAmpersand&"_test = [&]() {
        auto namer = ApprovalTests::Approvals::getDefaultNamer();
        expect(throws([&] { auto name = namer->getReceivedFile(".txt"); }))
            << "documenting bug #157, if you see this, the bug has been fixed upstream "
               "and can be closed, and this test should be updated";
    };
}