SC::TestCase Struct Reference

A test case that can be split into multiple sections. More...

#include <Testing.h>

Public Types
enum class	Execute {   Default ,   OnlyExplicit }

Public Member Functions
	TestCase (TestReport &report, StringSpan testName)
	Adds this TestCase to a TestReport with a name.
bool	recordExpectation (StringSpan expression, bool status, StringSpan detailedError=StringSpan())
	Records an expectation for a given expression.
bool	recordExpectation (StringSpan expression, Result status)
	Records an expectation for a given expression.
bool	test_section (StringSpan sectionName, Execute execution=Execute::Default)
	Starts a new test section.

Public Attributes
TestReport &	report
	The TestReport object passed in the constructor.

Friends
struct	TestReport

Detailed Description

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")));
        }
    }
};
 
namespace SC
{
void runConsoleTest(SC::TestReport& report) { ConsoleTest test(report); }
} // namespace SC

Member Enumeration Documentation

Execute

enum class SC::TestCase::Execute

strong

Enumerator
Default	Test is executed if all tests are enabled or if this specific one matches –test-section.
OnlyExplicit	Test is executed only if explicitly requested with –test-section.

Constructor & Destructor Documentation

TestCase()

SC::TestCase::TestCase	(	TestReport &	report,
		StringSpan	testName )

Adds this TestCase to a TestReport with a name.

Parameters

report	The current TestReport
testName	Name of this TestCase

Member Function Documentation

recordExpectation() [1/2]

bool SC::TestCase::recordExpectation	(	StringSpan	expression,
		bool	status,
		StringSpan	detailedError = StringSpan() )

Records an expectation for a given expression.

Parameters

expression	Expression converted to string
status	The boolean expectation of a test
detailedError	A detailed error message

Returns

status

recordExpectation() [2/2]

bool SC::TestCase::recordExpectation	(	StringSpan	expression,
		Result	status )

Records an expectation for a given expression.

Parameters

expression	Expression converted to string
status	A Result object, output from a test

Returns

false if status Result is not valid

test_section()

bool SC::TestCase::test_section ( StringSpan sectionName, Execute execution = Execute::Default )

nodiscard

Starts a new test section.

Parameters

sectionName	The name of the section
execution	Execution criteria

Returns

true if the test is enabled, false otherwise

Member Data Documentation

report

TestReport& SC::TestCase::report

The TestReport object passed in the constructor.

---

The documentation for this struct was generated from the following file:

• Testing.h