(This README is composed in http://dillinger.io/)

SimpleTDD is a TDD framework that help making unit test easily for mobile application.

• This project wanna help cocos2d-x developers make unit test easily so that we can develop in a Test Driven style.

• Tests can be created easily
• Tests can be filtered out
• Test History is kept so it is ease to redo the recent tests;

• /script : The script to create a new test
• /Classes : The example project source
• /Classes/TDDLib : The TDDLib library source
• /Classes/UnitTest : Example Unit test

Before using this library, make sure your cocos2d-x is ready. Also make sure you have installed python, our script will use it.

Download our project at

• https://github.com/tklee1975/SimpleTDD-cocos2dx

• Run the following command to setup SimpleTDD in your project ./script/setupTDD.py (your project path)
• This script will do the following things:
• Copy the SimpleTDD library to your project
• Copy the script of SimpleTDD to your project
• Setup the Unit Test Folder

When setup is done, the following Sources folder will be added, They are:

• Classes/SimpleTDD
• Classes/UnitTest

As we don't want to let the unit test stuff affect the size of the release build, all the UnitTest code and most of the library are enclosed by the 'ENABLE_TDD' macro. The test will not be included if 'ENABLE_TDD' isn't defined.

To turn the test code on, we need add the Marcro "ENABLE_TDD" definition to the compile setting.

Unlike the way of most unit test framework, TDDLib will build with the main code; Thus, the unit tests are linked with the main code in Test build version.

The way to do so is that add "test" button is placed on the Main View (e.g title scene or main scene) of the game.

The code sample is:

TDDHelper::addTestButton(this, Point(visibleSize.width/2, 50)); 

(note: we will use ExampleTest as the example of the new UnitTest)

• Go to the main folder e.g MyProject/
• Run the createTest.sh script

 ./script/createTest.sh Example
 

noted that the following files will be generated.

• MyProject/Classes/UnitTest/ExampleTest.h
• MyProject/Classes/UnitTest/ExampleTest.cpp

• Add the new UnitTest header and source files to XCode
• For my preference, I will place them in a group called 'UnitTest'.

MyTDDCases.h is the your header defining the test cases you created.

This is the sample code

// include files
#include "ExampleTest.h"	// Test class header

// Test Class Definition 
TDD_CASES
{
	TEST(ExampleTest),	// Test class name
};

To add a new test, just include your test class header and define it inside TDD_CASES block

• Build (Cmd+B) and Run (Cmd + R) in Xcode.

If the unit test is successfully added. you can place your test code inside.

Every Unit Test is designed to contain many sub tests to be invoked. Just add the sub test method and add the entry in the setSubTest method.

The code sample are as follows:

• Add the sub test method

void ExampleTest::testSomethingNew(Ref *sender)
{
	log("testSomethingNew");
}

• Add the entry in setSubTest method

void ExampleTest::setSubTest(Vector &menuArray)
{
	SUBTEST(ExampleTest::testSomethingNew);
	SUBTEST(ExampleTest::testSprite);
}

Every Unit Test Class (TDDTest) is the sub class of Scene. So it can do everything you expect to be done in Scene. But the different is that TDDTest will run 'setUp' after the Scene is loaded and 'tearDown' below the Scene is removed.

So, we can setup a custom testing UI at the setUp logic to fit the test environment we needed.

(note: build an example in the future)

• Document:
  • Tutorial #1: Setup TDDLib
  • Tutorial #2: Very simple unit test
• Feature:
  • Beautify the UI
  • More compact subtest menu
  • Clear the current filtering keyword
• Sample Code
  • Custom Test UI. e.g particle test with setting sliders