TestController类 参考

#include <controller.h>

TestController 的协作图:

Public 成员函数
	~TestController ()
void	startAutoTest ()
void	stopAutoTest ()
void	handleCrash ()
void	onEnterBackground ()
void	onEnterForeground ()
bool	blockTouchBegan (cocos2d::Touch *touch, cocos2d::Event *event)
void	setCurrTestSuite (TestSuite *testSuite)
TestSuite *	getCurrTestSuite ()
bool	isAutoTestRunning () const

静态 Public 成员函数
static TestController *	getInstance ()
static void	destroyInstance ()

Private 成员函数
	TestController ()
void	traverseThreadFunc ()
void	traverseTestList (TestList *testList)
void	traverseTestSuite (TestSuite *testSuite)
bool	checkTest (TestCase *testCase)
void	logEx (const char *format,...)

Private 属性
std::atomic< bool >	_stopAutoTest
bool	_isRunInBackground
TestList *	_rootTestList
TestSuite *	_testSuite
std::thread	_autoTestThread
std::condition_variable	_sleepCondition
std::unique_lock< std::mutex > *	_sleepUniqueLock
cocos2d::Director *	_director
cocos2d::EventListenerTouchOneByOne *	_touchListener
std::string	_logIndentation

详细描述

在文件 controller.h 第 46 行定义.

构造及析构函数说明

~TestController()

TestController::~TestController

(

)

在文件 controller.cpp 第 149 行定义.

{
    _director->getEventDispatcher()->removeEventListener(_touchListener);
 
    _rootTestList->release();
    _rootTestList = nullptr;
}

引用了 _director, _rootTestList , 以及 _touchListener.

TestController()

TestController::TestController ( )

private

在文件 controller.cpp 第 133 行定义.

: _stopAutoTest(true)
, _isRunInBackground(false)
, _testSuite(nullptr)
{
    _rootTestList = new (std::nothrow) RootTests;
    _rootTestList->runThisTest();
    _director = Director::getInstance();
 
    _touchListener = EventListenerTouchOneByOne::create();
    _touchListener->onTouchBegan = CC_CALLBACK_2(TestController::blockTouchBegan, this);
    _touchListener->setSwallowTouches(true);
 
    _director->getEventDispatcher()->addEventListenerWithFixedPriority(_touchListener, -200);
}

引用了 _director, _rootTestList, _touchListener, blockTouchBegan() , 以及 TestList::runThisTest().

函数调用图:

成员函数说明

blockTouchBegan()

bool TestController::blockTouchBegan	(	cocos2d::Touch *	touch,
		cocos2d::Event *	event
	)

在文件 controller.cpp 第 482 行定义.

{
    return !_stopAutoTest;
}

引用了 _stopAutoTest.

被这些函数引用 TestController().

这是这个函数的调用关系图:

checkTest()

bool TestController::checkTest ( TestCase *  testCase )

private

在文件 controller.cpp 第 375 行定义.

{
    if (testCase)
    {
        switch (testCase->getTestType())
        {
        case TestCase::Type::UNIT:
        {
            if (testCase && testCase->getExpectedOutput() != testCase->getActualOutput())
            {
                logEx("%s %s test fail", LOG_TAG, testCase->getTestCaseName().c_str());
            }
            else
            {
                logEx("%s %s test pass", LOG_TAG, testCase->getTestCaseName().c_str());
            }
            break;
        }
        case TestCase::Type::ROBUSTNESS:
        {
            break;
        }
        case TestCase::Type::MANUAL:
        {
            break;
        }
        default:
            break;
        }
    }
 
    return true;
}

引用了 TestCase::getActualOutput(), TestCase::getExpectedOutput(), TestCase::getTestCaseName(), TestCase::getTestType(), LOG_TAG, logEx(), TestCase::MANUAL, TestCase::ROBUSTNESS , 以及 TestCase::UNIT.

被这些函数引用 traverseTestSuite().

函数调用图:

这是这个函数的调用关系图:

destroyInstance()

void TestController::destroyInstance ( )

static

在文件 controller.cpp 第 470 行定义.

{
    if (s_testController)
    {
        s_testController->stopAutoTest();
        delete s_testController;
        s_testController = nullptr;
    }
 
    disableCrashCatch();
}

引用了 disableCrashCatch(), s_testController , 以及 stopAutoTest().

被这些函数引用 TestList::runThisTest().

函数调用图:

这是这个函数的调用关系图:

getCurrTestSuite()

TestSuite * TestController::getCurrTestSuite ( )

inline

在文件 controller.h 第 65 行定义.

{ return _testSuite; }

引用了 _testSuite.

getInstance()

TestController * TestController::getInstance ( )

static

在文件 controller.cpp 第 458 行定义.

{
    if (s_testController == nullptr)
    {
        s_testController = new (std::nothrow) TestController;
 
        initCrashCatch();
    }
 
    return s_testController;
}

引用了 initCrashCatch() , 以及 s_testController.

被这些函数引用 AppDelegate::applicationDidFinishLaunching(), TestCase::onEnter(), TestSuite::runThisTest(), TestList::runThisTest() , 以及 SchedulerRemoveAllFunctionsToBePerformedInCocosThread::update().

函数调用图:

这是这个函数的调用关系图:

handleCrash()

void TestController::handleCrash

(

)

在文件 controller.cpp 第 409 行定义.

{
    disableCrashCatch();
 
    logEx("%sCatch an crash event", LOG_TAG);
 
    if (!_stopAutoTest)
    {
        stopAutoTest();
    }
}

引用了 _stopAutoTest, disableCrashCatch(), LOG_TAG, logEx() , 以及 stopAutoTest().

被这些函数引用 windowExceptionFilter().

函数调用图:

这是这个函数的调用关系图:

isAutoTestRunning()

bool TestController::isAutoTestRunning ( ) const

inline

在文件 controller.h 第 66 行定义.

{ return !_stopAutoTest; }

引用了 _stopAutoTest.

logEx()

void TestController::logEx ( const char *  format,   ...  )

private

在文件 controller.cpp 第 431 行定义.

{
    char buff[1024];
 
    va_list args;
    va_start(args, format);
    vsnprintf(buff, 1020, format, args);
    strcat(buff, "\n");
 
#if CC_TARGET_PLATFORM == CC_PLATFORM_ANDROID
    __android_log_print(ANDROID_LOG_DEBUG, "cocos2d-x debug info", "%s", buff);
 
#elif CC_TARGET_PLATFORM == CC_PLATFORM_WIN32
    WCHAR wszBuf[1024] = { 0 };
    MultiByteToWideChar(CP_UTF8, 0, buff, -1, wszBuf, sizeof(wszBuf));
    OutputDebugStringW(wszBuf);
 
#else
    // Linux, Mac, iOS, etc
    fprintf(stdout, "%s", buff);
    fflush(stdout);
#endif
    va_end(args);
}

被这些函数引用 checkTest(), handleCrash(), traverseTestList() , 以及 traverseTestSuite().

这是这个函数的调用关系图:

onEnterBackground()

void TestController::onEnterBackground

(

)

在文件 controller.cpp 第 421 行定义.

{
    _isRunInBackground = true;
}

引用了 _isRunInBackground.

onEnterForeground()

void TestController::onEnterForeground

(

)

在文件 controller.cpp 第 426 行定义.

{
    _isRunInBackground = false;
}

引用了 _isRunInBackground.

setCurrTestSuite()

void TestController::setCurrTestSuite ( TestSuite *  testSuite )

inline

在文件 controller.h 第 64 行定义.

{ _testSuite = testSuite; }

引用了 _testSuite.

被这些函数引用 TestSuite::runThisTest().

这是这个函数的调用关系图:

startAutoTest()

void TestController::startAutoTest

(

)

在文件 controller.cpp 第 157 行定义.

{
    if (!_autoTestThread.joinable())
    {
        _stopAutoTest = false;
        _logIndentation = "";
        _autoTestThread = std::thread(&TestController::traverseThreadFunc, this);
        _autoTestThread.detach();
    }
}

引用了 _autoTestThread, _logIndentation, _stopAutoTest , 以及 traverseThreadFunc().

被这些函数引用 TestList::runThisTest().

函数调用图:

这是这个函数的调用关系图:

stopAutoTest()

void TestController::stopAutoTest

(

)

在文件 controller.cpp 第 168 行定义.

{
    _stopAutoTest = true;
    
    if (_autoTestThread.joinable()) {
        _sleepCondition.notify_all();
        _autoTestThread.join();
    }
}

引用了 _autoTestThread, _sleepCondition , 以及 _stopAutoTest.

被这些函数引用 destroyInstance(), handleCrash() , 以及 TestList::runThisTest().

这是这个函数的调用关系图:

traverseTestList()

void TestController::traverseTestList ( TestList *  testList )

private

在文件 controller.cpp 第 187 行定义.

{
    if (testList == _rootTestList)
    {
        _sleepCondition.wait_for(*_sleepUniqueLock, std::chrono::milliseconds(500));
    }
    else
    {
        _logIndentation += LOG_INDENTATION;
        _sleepCondition.wait_for(*_sleepUniqueLock, std::chrono::milliseconds(500));
    }
    logEx("%s%sBegin traverse TestList:%s", LOG_TAG, _logIndentation.c_str(), testList->getTestName().c_str());
 
    auto scheduler = _director->getScheduler();
    int testIndex = 0;
    for (auto& callback : testList->_testCallbacks)
    {
        if (_stopAutoTest) break;
        while (_isRunInBackground)
        {
            logEx("_director is paused");
            _sleepCondition.wait_for(*_sleepUniqueLock, std::chrono::milliseconds(500));
        }
        if (callback)
        {
            auto test = callback();
            test->setTestParent(testList);
            test->setTestName(testList->_childTestNames[testIndex++]);
            if (test->isTestList())
            {
                scheduler->performFunctionInCocosThread([&](){
                    test->runThisTest();
                });
 
                traverseTestList((TestList*)test);
            }
            else
            {
                traverseTestSuite((TestSuite*)test);
            }
        }
    }
 
    if (testList == _rootTestList)
    {
        _stopAutoTest = true;
    }
    else
    {
        if (!_stopAutoTest)
        {
            //Backs up one level and release TestList object.
            scheduler->performFunctionInCocosThread([&](){
                testList->_parentTest->runThisTest();
            });
            _sleepCondition.wait_for(*_sleepUniqueLock, std::chrono::milliseconds(500));
            testList->release();
        }
        
        _logIndentation.erase(_logIndentation.rfind(LOG_INDENTATION));
    }
}

引用了 TestBase::_childTestNames, _director, _isRunInBackground, _logIndentation, TestBase::_parentTest, _rootTestList, _sleepCondition, _sleepUniqueLock, _stopAutoTest, TestList::_testCallbacks, TestBase::getTestName(), LOG_INDENTATION, LOG_TAG, logEx(), TestBase::runThisTest(), traverseTestList() , 以及 traverseTestSuite().

被这些函数引用 traverseTestList() , 以及 traverseThreadFunc().

函数调用图:

这是这个函数的调用关系图:

traverseTestSuite()

void TestController::traverseTestSuite ( TestSuite *  testSuite )

private

在文件 controller.cpp 第 250 行定义.

{
    auto scheduler = _director->getScheduler();
    int testIndex = 0;
    float testCaseDuration = 0.0f;
    _logIndentation += LOG_INDENTATION;
    logEx("%s%sBegin traverse TestSuite:%s", LOG_TAG, _logIndentation.c_str(), testSuite->getTestName().c_str());
 
    _logIndentation += LOG_INDENTATION;
    testSuite->_currTestIndex = -1;
 
    auto logIndentation = _logIndentation;
    for (auto& callback : testSuite->_testCallbacks)
    {
        auto testName = testSuite->_childTestNames[testIndex++];
        
        Scene* testScene = nullptr;
        TestCase* testCase = nullptr;
        TransitionScene* transitionScene = nullptr;
 
        if (_stopAutoTest) break;
 
        while (_isRunInBackground)
        {
            logEx("_director is paused");
            _sleepCondition.wait_for(*_sleepUniqueLock, std::chrono::milliseconds(500));
        }
        //Run test case in the cocos[GL] thread.
        scheduler->performFunctionInCocosThread([&, logIndentation, testName](){
            if (_stopAutoTest) return;
            logEx("%s%sRun test:%s.", LOG_TAG, logIndentation.c_str(), testName.c_str());
 
            auto scene = callback();
            if (_stopAutoTest) return;
 
            if (scene)
            {
                transitionScene = dynamic_cast<TransitionScene*>(scene);
                if (transitionScene)
                {
                    testCase = (TestCase*)transitionScene->getInScene();
                    testCaseDuration = transitionScene->getDuration() + 0.5f;
                }
                else
                {
                    testCase = (TestCase*)scene;
                    testCaseDuration = testCase->getDuration();
                }
                testSuite->_currTestIndex++;
                testCase->setTestSuite(testSuite);
                testCase->setTestCaseName(testName);
                _director->replaceScene(scene);
 
                testScene = scene;
            }
        });
 
        if (_stopAutoTest) break;
 
        //Wait for the test case be created.
        float waitTime = 0.0f;
        while (!testScene && !_stopAutoTest)
        {
            _sleepCondition.wait_for(*_sleepUniqueLock, std::chrono::milliseconds(50));
            if (!_isRunInBackground)
            {
                waitTime += 0.05f;
            }
 
            if (waitTime > CREATE_TIME_OUT)
            {
                logEx("%sCreate test %s time out", LOG_TAG, testName.c_str());
                _stopAutoTest = true;
                break;
            }
        }
 
        if (_stopAutoTest) break;
 
        //Wait for test completed.
        _sleepCondition.wait_for(*_sleepUniqueLock, std::chrono::milliseconds(int(1000 * testCaseDuration)));
 
        if (transitionScene == nullptr)
        {
            waitTime = 0.0f;
            while (!_stopAutoTest && testCase->getRunTime() < testCaseDuration)
            {
                _sleepCondition.wait_for(*_sleepUniqueLock, std::chrono::milliseconds(50));
                if (!_isRunInBackground)
                {
                    waitTime += 0.05f;
                }
 
                if (waitTime > TEST_TIME_OUT)
                {
                    logEx("%sRun test %s time out", LOG_TAG, testName.c_str());
                    _stopAutoTest = true;
                    break;
                }
            }
 
            if (!_stopAutoTest)
            {
                //Check the result of test.
                checkTest(testCase);
            }
        }
    }
 
    if (!_stopAutoTest)
    {
        //Backs up one level and release TestSuite object.
        auto parentTest = testSuite->_parentTest;
        scheduler->performFunctionInCocosThread([&](){
            parentTest->runThisTest();
        });
 
        _sleepCondition.wait_for(*_sleepUniqueLock, std::chrono::milliseconds(1000));
        testSuite->release();
    }
 
    _logIndentation.erase(_logIndentation.rfind(LOG_INDENTATION));
    _logIndentation.erase(_logIndentation.rfind(LOG_INDENTATION));
}

引用了 TestBase::_childTestNames, TestSuite::_currTestIndex, _director, _isRunInBackground, _logIndentation, TestBase::_parentTest, _sleepCondition, _sleepUniqueLock, _stopAutoTest, TestSuite::_testCallbacks, checkTest(), CREATE_TIME_OUT, TestCase::getDuration(), TestCase::getRunTime(), TestBase::getTestName(), LOG_INDENTATION, LOG_TAG, logEx(), TestCase::setTestCaseName(), TestCase::setTestSuite() , 以及 TEST_TIME_OUT.

被这些函数引用 traverseTestList().

函数调用图:

这是这个函数的调用关系图:

traverseThreadFunc()

void TestController::traverseThreadFunc ( )

private

在文件 controller.cpp 第 178 行定义.

{
    std::mutex sleepMutex;
    auto lock = std::unique_lock<std::mutex>(sleepMutex);
    _sleepUniqueLock = &lock;
    traverseTestList(_rootTestList);
    _sleepUniqueLock = nullptr;
}

引用了 _rootTestList, _sleepUniqueLock , 以及 traverseTestList().

被这些函数引用 startAutoTest().

函数调用图:

这是这个函数的调用关系图:

类成员变量说明

_autoTestThread

std::thread TestController::_autoTestThread

private

在文件 controller.h 第 84 行定义.

被这些函数引用 startAutoTest() , 以及 stopAutoTest().

_director

cocos2d::Director* TestController::_director

private

在文件 controller.h 第 89 行定义.

被这些函数引用 TestController(), traverseTestList(), traverseTestSuite() , 以及 ~TestController().

_isRunInBackground

bool TestController::_isRunInBackground

private

在文件 controller.h 第 79 行定义.

被这些函数引用 onEnterBackground(), onEnterForeground(), traverseTestList() , 以及 traverseTestSuite().

_logIndentation

std::string TestController::_logIndentation

private

在文件 controller.h 第 92 行定义.

被这些函数引用 startAutoTest(), traverseTestList() , 以及 traverseTestSuite().

_rootTestList

TestList* TestController::_rootTestList

private

在文件 controller.h 第 81 行定义.

被这些函数引用 TestController(), traverseTestList(), traverseThreadFunc() , 以及 ~TestController().

_sleepCondition

std::condition_variable TestController::_sleepCondition

private

在文件 controller.h 第 86 行定义.

被这些函数引用 stopAutoTest(), traverseTestList() , 以及 traverseTestSuite().

_sleepUniqueLock

std::unique_lock<std::mutex>* TestController::_sleepUniqueLock

private

在文件 controller.h 第 87 行定义.

被这些函数引用 traverseTestList(), traverseTestSuite() , 以及 traverseThreadFunc().

_stopAutoTest

std::atomic<bool> TestController::_stopAutoTest

private

在文件 controller.h 第 78 行定义.

被这些函数引用 blockTouchBegan(), handleCrash(), isAutoTestRunning(), startAutoTest(), stopAutoTest(), traverseTestList() , 以及 traverseTestSuite().

_testSuite

TestSuite* TestController::_testSuite

private

在文件 controller.h 第 82 行定义.

被这些函数引用 getCurrTestSuite() , 以及 setCurrTestSuite().

_touchListener

cocos2d::EventListenerTouchOneByOne* TestController::_touchListener

private

在文件 controller.h 第 90 行定义.

被这些函数引用 TestController() , 以及 ~TestController().

---

该类的文档由以下文件生成:

• /Users/yujizhu/Documents/Git/cocos2d-x-4.0/tests/cpp-tests/Classes/controller.h
• /Users/yujizhu/Documents/Git/cocos2d-x-4.0/tests/cpp-tests/Classes/controller.cpp