Testing.h

// Copyright (c) Stefano Cristiano
// SPDX-License-Identifier: MIT
#pragma once
#include "../Foundation/Result.h"
#include "../Strings/Console.h" // SC_COMPILER_DEBUG_BREAK
#include "../Strings/StringView.h"
 
namespace SC
{
struct TestCase;
struct TestReport;
} // namespace SC
 
 
 
struct SC::TestReport
{
    Console&   console;                  
    StringView libraryRootDirectory;     
    StringView executableFile;           
    StringView applicationRootDirectory; 
 
    // Options
    bool abortOnFirstFailedTest = true;  
    bool debugBreakOnFailedTest = true;  
    bool quietMode              = false; 
 
    TestReport(Console& console, int argc, const char** argv);
    ~TestReport();
 
    [[nodiscard]] int getTestReturnCode() const;
 
    void runGlobalMemoryReport(bool reportFailure = true);
 
  private:
    [[nodiscard]] bool isTestEnabled(StringView testName) const;
    [[nodiscard]] bool isSectionEnabled(StringView sectionName) const;
 
    void testCaseFinished(TestCase& testCase);
    void printSectionResult(TestCase& testCase);
 
    friend struct TestCase;
    uint32_t   numTestsSucceeded = 0;
    uint32_t   numTestsFailed    = 0;
    StringView currentSection;
    StringView firstFailedTest;
    StringView testToRun;
    StringView sectionToRun;
};
 
struct SC::TestCase
{
    TestCase(TestReport& report, StringView testName);
    ~TestCase();
 
    bool recordExpectation(StringView expression, bool status, StringView detailedError = StringView());
 
    bool recordExpectation(StringView expression, Result status);
 
    enum class Execute
    {
        Default,     
        OnlyExplicit 
    };
 
    [[nodiscard]] bool test_section(StringView sectionName, Execute execution = Execute::Default);
 
    TestReport& report; 
  private:
    friend struct TestReport;
    const StringView testName;
 
    uint32_t numTestsSucceeded;
    uint32_t numTestsFailed;
    uint32_t numSectionTestsFailed;
    bool     printedSection;
};
 
#define SC_TEST_EXPECT(e)                                                                                              \
    recordExpectation(StringView(#e##_a8), (e))                                                                        \
        ? (void)0                                                                                                      \
        : (TestCase::report.debugBreakOnFailedTest ? SC_COMPILER_DEBUG_BREAK : (void)0)