vrj::test::TestRunner Class Reference

Groups tests together and is also in charge of running them and capturing a list of any failures that occur. More...

#include <vrj/Test/TestRunner.h>

Collaboration diagram for vrj::test::TestRunner:

[legend]List of all members.

Public Types
enum	State { Uninitialized, Processing, DoneProcessing }
Public Member Functions
	TestRunner ()
void	initialize (vrj::App *app)
	Initializes the test suite.
void	processTests ()
	Progresses the state of testing.
void	addTest (Test *test)
State	getState ()
	Are the tests done processing?
void	printFailures ()
	Prints out the test failures.
Protected Attributes
vrj::App *	mApp
	The application to test.
State	mCurState
	Store the current state of processing.
int	mCurTestIndex
	Index of the current test to run.
std::vector< Test * >	mTests
	List of tests to run.
std::vector< TestFailure >	mTestFailures
	List of test failures.

---

Detailed Description

Groups tests together and is also in charge of running them and capturing a list of any failures that occur.

Definition at line 58 of file TestRunner.h.

---

Member Enumeration Documentation

enum vrj::test::TestRunner::State

Enumerator:

Uninitialized
Processing
DoneProcessing

Definition at line 61 of file TestRunner.h.

   {
      Uninitialized,
      Processing,
      DoneProcessing
   };

---

Constructor & Destructor Documentation

vrj::test::TestRunner::TestRunner

(

)

[inline]

Definition at line 69 of file TestRunner.h.

      : mApp(NULL)
      , mCurState(Uninitialized)
      , mCurTestIndex(-1)
   {;}

---

Member Function Documentation

void vrj::test::TestRunner::initialize

(

vrj::App *

app

)

[inline]

Initializes the test suite.

Must be called before running the tests and after all tests have been added.

Definition at line 80 of file TestRunner.h.

References mApp, mCurState, mTestFailures, mTests, and Processing.

   {
      mApp = app;

      // Initialize the tests
      vprASSERT(mTests.size() > 0);
      for(unsigned t=0;t<mTests.size();t++)
      {
         mTests[t]->setApp(app);
      }

      // Clear the failures
      mTestFailures.clear();

      mCurState = Processing;
   }

void vrj::test::TestRunner::processTests

(

)

[inline]

Progresses the state of testing.

Called at the end of preFrame by apps that want to run tests.

Definition at line 101 of file TestRunner.h.

References DoneProcessing, mApp, mCurState, mCurTestIndex, mTestFailures, mTests, and printFailures().

   {
      vprASSERT(NULL != mApp);

      bool test_failed(false);

      if(mCurTestIndex < (int)mTests.size())      // Check to see if there are tests to run
      {
         if(-1 == mCurTestIndex)                   // First time through
         {
            mCurTestIndex = 0;
            std::cout << "TestRunner: Starting test: " << mTests[mCurTestIndex]->getName() << std::endl;
            mTests[mCurTestIndex]->setUp();        // Setup the initial test
         }
         else
         {
            try
            {
               mTests[mCurTestIndex]->processTest();              // Process the current test
            }
            catch(vrj::test::TestFailure& tf)
            {
               mTestFailures.push_back(tf);
               test_failed = true;
            }
            catch(...)
            {
               std::cout << "Recieved unknown exception in TestRunner. rethrowing." << std::endl;
               throw;
            }

            if(test_failed || mTests[mCurTestIndex]->isDone())    // If current test is done or failed
            {
               mTests[mCurTestIndex]->tearDown();               // Tear down the test
               mCurTestIndex++;                                // Goto the next test
               if(mCurTestIndex < (int)mTests.size())          // If test is in range
               {
                  std::cout << "TestRunner: Starting test: " << mTests[mCurTestIndex]->getName() << std::endl;
                  mTests[mCurTestIndex]->setUp();              // - Initialize it
               }
               else
               {
                  mCurState = DoneProcessing;
                  printFailures();
               }
            }
         }
         
      }
   }

void vrj::test::TestRunner::addTest

(

Test *

test

)

[inline]

Definition at line 152 of file TestRunner.h.

References mTests.

   {
      mTests.push_back(test);
   }

State vrj::test::TestRunner::getState

(

)

[inline]

Are the tests done processing?

Returns:

true if there is no more processing to do.

Definition at line 161 of file TestRunner.h.

References mCurState.

   {
      return mCurState;
   }

void vrj::test::TestRunner::printFailures

(

)

[inline]

Prints out the test failures.

Definition at line 167 of file TestRunner.h.

References mTestFailures.

Referenced by processTests().

   {
      if(mTestFailures.empty())
      {
         std::cout << "--- Tests all PASSED!!! ----\n" << std::flush;
      }
      else
      {
         std::cout << "----- Test failures: count: " << mTestFailures.size() << " -----\n" << std::flush;

         for(unsigned f=0; f<mTestFailures.size(); ++f)
         {
            TestFailure cur_failure = mTestFailures[f];
            std::cout << "   Failed: " << cur_failure.getFullDescription() << std::endl;
         }
      }
   }

---

Member Data Documentation

vrj::App* vrj::test::TestRunner::mApp [protected]

The application to test.

Definition at line 186 of file TestRunner.h.

Referenced by initialize(), and processTests().

State vrj::test::TestRunner::mCurState [protected]

Store the current state of processing.

Definition at line 187 of file TestRunner.h.

Referenced by getState(), initialize(), and processTests().

int vrj::test::TestRunner::mCurTestIndex [protected]

Index of the current test to run.

-1 means that we have to start.

Definition at line 188 of file TestRunner.h.

Referenced by processTests().

std::vector<Test*> vrj::test::TestRunner::mTests [protected]

List of tests to run.

Definition at line 189 of file TestRunner.h.

Referenced by addTest(), initialize(), and processTests().

std::vector<TestFailure> vrj::test::TestRunner::mTestFailures [protected]

List of test failures.

Definition at line 190 of file TestRunner.h.

Referenced by initialize(), printFailures(), and processTests().

---

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

• TestRunner.h

---