SimpleTDD.ccx3: A TDD Framework for cocos2d-x 3.x

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

Goal

• Help cocos2d-x developers make unit test easily so that we can develop in a Test Driven style.
• Make a test in few steps.

Core Features

• Tests can be created easily using script.
• Tests can be found by giving a keyword or based on test history.

Requirement

• cocos2d-x 3.10 or above
• python 2.7

Folder will be installed

• /script : The script to create a new test
• /Classes/SimpleTDD : The library folder
• /Classes/UnitTest : Unit Test Source folder

Installation

0. Software and Project Ready

Before installation, make sure the required software are ready; Also the cocos2d-x project is already setup.

1. Download the Library project

Download our project at

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

2. Run the setup script

• Go to the download Git project;
• Run the install script ./script/installTDD.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

3. Add the Library and Unit Test to your project

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

• Classes/SimpleTDD
• Classes/UnitTest

4. Set the MACRO 'ENABLE_TDD'

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.

5. Add the Test Button

Unlike the way of most unit test framework, SimpleTDD 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:

SimpleTDD::setup(this, Vec2(100, 100));

How to add a new test

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

1. Run the 'createTest' script

• 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

2. Add the new test class

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

3. Create the MyTDDCases.h

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

4. Build and Run

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

5. Adding test code

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

5.1 Using the sub test

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()
{
	log("testSomethingNew");
}

• Add the entry in setSubTest method

void ExampleTest::defineTests()
{
	ADD_TEST(testSomethingNew);
	ADD_TEST(testSprite);
}

5.2 Override the Unit Test content

Every Unit Test Class (TDDBaseTest) 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)

How to support this project

• Use it in your own project;
• Send me some feedbacks about the project (bugs or suggestions are welcome);
• Tell other about this project;

Future Development

• Feature:

  • Make the Test UI theme configurable;
  • Assertion and Error Report;
  • Different way to browse sub test;

• Testing:

• Sample Code

  • Custom Test UI. e.g particle test with setting sliders
  • Test with Physics Engine