Testing

Table of Contents

• Dependencies
• Features
• Status
• Description
  • SC::TestCase
  • SC::TestReport
• Roadmap
• Statistics

🟨 Simple testing framework used by all of the other libraries

SaneCppTesting.h is a very simple test framework that allows splitting tests in sections and record successful/failed expectations.

Dependencies

• Dependencies: (none)
• All dependencies: (none)

Features

Class	Description
SC::TestCase	A test case that can be split into multiple sections.
SC::TestReport	Collects multiple TestCase and reports their results.

Status

🟨 MVP
Testing library is minimal but it's useful as is for now.

Description

Testing integrates with the SC::Result object provided by the Common fragments. So far it doesn't support test discovery and all tests must be manually invoked in the main test file.

SC::TestCase

A test case that can be split into multiple sections.

To create a test case derive from SC::TestCase and run tests in the constructor

Example:

namespace SC
{
struct ConsoleTest;
}
 
struct SC::ConsoleTest : public SC::TestCase
{
    ConsoleTest(SC::TestReport& report) : TestCase(report, "ConsoleTest")
    {
        using namespace SC;
 
        // Totally optional conversion buffer for UTF conversions on Windows (default is 256 bytes)
        char optionalConversionBuffer[512];
 
        Console console(optionalConversionBuffer);
 
        if (test_section("print"))
        {
            String str = StringView("Test Test\n");
            console.print(str.view());
            console.print({});
            SC_TEST_EXPECT(console.print("test {}", 1));
            SC_TEST_EXPECT(not console.print("test {}"_u16, 1));
            SC_TEST_EXPECT(console.print("test {}", StringSpan("1")));
            SC_TEST_EXPECT(not console.print("test {}"_u16, StringSpan("1")));
        }
        if (test_section("printError"))
        {
            console.printError("Test Error\n");
            console.printErrorLine("Test Error Line");
            console.flushStdErr();
        }
    }
};
 
namespace SC
{
void runConsoleTest(SC::TestReport& report) { ConsoleTest test(report); }
} // namespace SC

SC::TestReport

Collects multiple TestCase and reports their results.

This is passed as argument to SC::TestCase derived classes, and contains handle to globals like a console, paths to the library and application root, path to executable etc.

Roadmap

🟩 Usable

• Test discovery

🟦 Complete Features:

• IDE Integration

💡 Unplanned Features:

• Template tests

Statistics

LOC counts exclude comments. Library counts files physically under Libraries/Testing. Single File counts SaneCppTesting.h. Standalone counts SaneCppTestingStandalone.h and intentionally includes dependency payloads.

Metric	Header	Source	Sum
Library	155	791	946
Single File	1178	1382	2560
Standalone	1178	1382	2560