T2TestingFramework Class Reference

#include <T2TestingFramework.h>

Classes
struct	Category
struct	Check
struct	Test
class	TestAutoReg

Public Types
using	TestMethod_t = void ( * )()
using	FailCallback_t = void ( * )( Test* a_pTest, Check* a_pCheck )
using	SuccessCallback_t = void ( * )( Test* a_pTest, Check* a_pCheck )

Public Member Functions
	T2TestingFramework ()=default
	~T2TestingFramework ()=default
Category *	FindCategory (const TCHAR *a_pchName)
Category *	RegisterCategory (const TCHAR *a_pchName)
Test *	RegisterTest (const TCHAR *a_pchTestName, Category *a_pCategory, TestMethod_t a_fnMethod)
TINT	RunTests (FailCallback_t a_fnFailCallback=TNULL, SuccessCallback_t a_fnSuccessCallback=TNULL)
void	SignalRequirementResult (Test *a_pTest, const TCHAR *a_pchFileName, TINT a_iLineNum, const TCHAR *a_pchStatement, TBOOL a_bFailed)
Test *	GetCurrentTest () const

Detailed Description

Definition at line 20 of file T2TestingFramework.h.

Member Typedef Documentation

FailCallback_t

using T2TestingFramework::FailCallback_t = void ( * )( Test* a_pTest, Check* a_pCheck )

Definition at line 61 of file T2TestingFramework.h.

SuccessCallback_t

using T2TestingFramework::SuccessCallback_t = void ( * )( Test* a_pTest, Check* a_pCheck )

Definition at line 62 of file T2TestingFramework.h.

TestMethod_t

using T2TestingFramework::TestMethod_t = void ( * )()

Definition at line 23 of file T2TestingFramework.h.

Constructor & Destructor Documentation

T2TestingFramework()

T2TestingFramework::T2TestingFramework ( )

default

~T2TestingFramework()

T2TestingFramework::~T2TestingFramework ( )

default

Member Function Documentation

FindCategory()

T2TestingFramework::Category * T2TestingFramework::FindCategory

(

const TCHAR *

a_pchName

)

Definition at line 45 of file T2TestingFramework.cpp.

{
    Category* pCategory = m_pHeadCategory;
 
    while ( pCategory )
    {
        if ( !strcmp( pCategory->pchName, a_pchName ) )
            return pCategory;
 
        pCategory = pCategory->pNext;
    }
 
    return TNULL;
}

GetCurrentTest()

Test * T2TestingFramework::GetCurrentTest ( ) const

inline

Definition at line 85 of file T2TestingFramework.h.

{ return m_pCurrentTest; }

RegisterCategory()

T2TestingFramework::Category * T2TestingFramework::RegisterCategory

(

const TCHAR *

a_pchName

)

Definition at line 60 of file T2TestingFramework.cpp.

{
    Category* pCategory = FindCategory( a_pchName );
 
    if ( !pCategory )
    {
        pCategory          = New<Category>();
        pCategory->pchName = a_pchName;
        pCategory->pNext   = m_pHeadCategory;
 
        m_pHeadCategory = pCategory;
    }
 
    return pCategory;
}

RegisterTest()

T2TestingFramework::Test * T2TestingFramework::RegisterTest	(	const TCHAR *	a_pchTestName,
		Category *	a_pCategory,
		TestMethod_t	a_fnMethod )

Definition at line 76 of file T2TestingFramework.cpp.

{
    if ( !a_pCategory )
        return TNULL;
 
    Test* pTest      = New<Test>();
    pTest->pchName   = a_pchTestName;
    pTest->pCategory = a_pCategory;
    pTest->fnMethod  = a_fnMethod;
    pTest->pNext     = a_pCategory->pHeadTest;
 
    a_pCategory->pHeadTest = pTest;
 
    return pTest;
}

RunTests()

TINT T2TestingFramework::RunTests	(	FailCallback_t	a_fnFailCallback = TNULL,
		SuccessCallback_t	a_fnSuccessCallback = TNULL )

Definition at line 122 of file T2TestingFramework.cpp.

{
    TINT      iNumFails = 0;
    Category* pCategory = m_pHeadCategory;
 
    // Update callbacks
    g_fnFailCallback    = a_fnFailCallback;
    g_fnSuccessCallback = a_fnSuccessCallback;
 
    while ( pCategory )
    {
        Test* pTest = pCategory->pHeadTest;
 
        while ( pTest )
        {
            if ( !pTest->bWasExecuted )
            {
                // Run the actual test
                m_pCurrentTest = pTest;
 
                pTest->fnMethod();
                pTest->bWasExecuted = TTRUE;
 
                // Count number of fails
                iNumFails += pTest->iNumFails;
                pCategory->iNumTotalFails += pTest->iNumFails;
            }
 
            m_pCurrentTest = TNULL;
            pTest          = pTest->pNext;
        }
 
        pCategory = pCategory->pNext;
    }
 
    // Reset callbacks
    g_fnFailCallback    = TNULL;
    g_fnSuccessCallback = TNULL;
 
    return iNumFails;
}

SignalRequirementResult()

void T2TestingFramework::SignalRequirementResult	(	Test *	a_pTest,
		const TCHAR *	a_pchFileName,
		TINT	a_iLineNum,
		const TCHAR *	a_pchStatement,
		TBOOL	a_bFailed )

Definition at line 95 of file T2TestingFramework.cpp.

{
    if ( !a_pTest )
        return;
 
    Check* pCheck        = New<Check>();
    pCheck->pchFileName  = a_pchFileName;
    pCheck->pchStatement = a_pchStatement;
    pCheck->iLineNum     = a_iLineNum;
    pCheck->bFailed      = a_bFailed;
    pCheck->pNext        = a_pTest->pHeadCheck;
 
    a_pTest->pHeadCheck = pCheck;
 
    if ( a_bFailed )
    {
        a_pTest->iNumFails += 1;
 
        if ( g_fnFailCallback )
            g_fnFailCallback( a_pTest, pCheck );
    }
    else if ( g_fnSuccessCallback )
    {
        g_fnSuccessCallback( a_pTest, pCheck );
    }
}

---

The documentation for this class was generated from the following files:

• D:/_dev/OpenBarnyard/Source/Toshi/Source/ToshiTools/T2TestingFramework.h
• D:/_dev/OpenBarnyard/Source/Toshi/Source/ToshiTools/T2TestingFramework.cpp