TestingFramework.c

Go to the documentation of this file.

 
//-----------------------------------------------------------------------------
class Test
{
    typename Suite;
 
    int TimeoutS;
    int TimeoutMs;
    int MaxAttempts;

    void Test(string suiteStr = "", typename suite = void, int timeoutS = 0, int timeoutMs = 0, int maxAttempts = 1)
    {
        if (suite != void)
        {
            Suite = suite;
        }
        else
        {
            PrintFormat(
                "Test referring to TestSuite using string '%1' instead of typename. This is deprecated and should be replaced by explicitly setting passing 'suite' parameter",
                suiteStr, level: LogLevel.WARNING
            );
            Suite = suiteStr.ToType();
        }
        TimeoutS = timeoutS;
        TimeoutMs = timeoutMs;
        MaxAttempts = maxAttempts;
    }
}
 
//-----------------------------------------------------------------------------
typedef TestStage EStage;
 
//-----------------------------------------------------------------------------
class TestStep
{
    TestStage Stage;
    int TimeoutS;
    int TimeoutMs;
 
    void TestStep(TestStage stage = TestStage.Main, int timeoutS = 0, int timeoutMs = 0)
    {
        Stage = stage;
        TimeoutS = timeoutS;
        TimeoutMs = timeoutMs;
    }
}

typedef TestStep Step;

 
#ifdef DOXYGEN
 
//-----------------------------------------------------------------------------
class TestBoolResult : TestResultBase
{
    bool Value;
 
    void TestBoolResult(bool val) { Value = val; }
 
    override bool Failure() { return !Value; }
 
    override string FailureText()
    {
        // junit kind of error report. (simple)
        return "<failure type=\"TestBoolResult\" message=\"Failed.\" />";
    }
}
 
//-----------------------------------------------------------------------------
class MyTestSuite : TestSuite
{
    private int m_Count;
 
    [TestStep(TestStage.Setup)]
    void Prep()
    {
        Print("MyTestSuite.Prep");
        m_Count = 3;
    }
 
    [TestStep(TestStage.Setup)]
    bool Count()
    {
        --m_Count;
        Print("MyTestSuite.Count: " + m_Count);
        return m_Count == 0;
    }
 
    [TestStep(TestStage.TearDown)]
    bool CountUp()
    {
        ++m_Count;
        Print("MyTestSuite.CountUp: " + m_Count);
        return m_Count == 10;
    }
}
 
//-----------------------------------------------------------------------------
[Test(suite: MyTestSuite, timeoutS: 2, timeoutMs: 250)]
class MyAsyncTest : TestBase
{
    private int m_Count;
 
    // Simple blocking initialization.
    [TestStep(TestStage.Setup)]
    void Init()
    {
        Print("MyAsyncTest.Init");
        m_Count = 10;
    }
 
    // Async test which is waiting for result for several frames.
    [TestStep(TestStage.Main)]
    bool Poll()
    {
        Print("MyAsyncTest.Poll: " + m_Count);
 
        if (m_Count == 0)
        {
            Print("MyAsyncTest.Poll Result");
            SetResult(new TestBoolResult(false));
            m_Count = 3;
            return true;
        }
 
        Print("MyAsyncTest.Poll Progress");
 
        m_Count--;
        return false;
    }
 
    // Finalization process waiting for result for several frames.
    [TestStep(TestStage.TearDown)]
    bool Finalizing()
    {
        Print("MyAsyncTest.Finalizing: " + m_Count);
        if (m_Count == 0)
        {
            Print("MyAsyncTest.Finalizing Done");
            return true;
        }
 
        Print("MyAsyncTest.Finalizing Progress");
        m_Count--;
        return false;
    }
 
    // Simple blocking finalization call.
    [TestStep(TestStage.TearDown)]
    void Finalized()
    {
        Print("MyAsyncTest.Finalized");
    }
}
 
#endif