GHUnit with Xcode 4, CI with Jenkins and maybe more

Created for 2011 Barcamp #YXE

Before you start

You will need the following:

• Xcode 4
• Access to a working Jenkins install with the following plugins: Jenkins GIT plugin
• git and a git repo hosted where you and Jenkins can access it

GHUnit

Clone GHUnit to a familiar location.

git clone https://github.com/gabriel/gh-unit.git

Read the instructions, but I'll help you along anyways.

http://gabriel.github.com/gh-unit/docs/index.html

Compile as per the instructions.

To build the framework for iOS, run make from within the Project-iOS directory. The framework is in Project-iOS/build/Framework/.

If this opens a Finder window with GHUnitIOS.framework in it you have successfully built GHUnit.

GHUnit in a Xcode Project

Create a new target in your Xcode project, perhaps named GHUnitTest. This link takes you through it, but we can summarize here.

http://gabriel.github.com/gh-unit/docs/appledoc_include/guide_install_ios_4.html

New Target as Empty Application.

At this point, you want to get GHUnit into your project.

In the root of your project, create a folder: Vendors

Remember that GHUnitIOS.framework package? Copy that folder into Vendors.

git add Vendors; git commit -m "Vendor directory with GHUnit framework"

Add GHUnit Framework to Project

You will want to Add Other and browse to your Vendors/GHUnitIOS.framework you copied earlier

Xcode is dumb, so you will have to move that framework to your frameworks folder if you are OCD.

Project Tweaks

In the build settings for your GHUnitTest target, you need to add two linker flags: -ObjC and -all_load

Modify your main entry point

You will want to use the AppDelegate provided in the GHUnitIOS.framework, "GHUnitIOSAppDelegate"

Run GHUnitTest

If you didn't bugger anything up, everything should compile and run.

Some Simple GHUnit Tests

GHUnit can do all sorts of amazing tests, you can see examples in their docs: http://gabriel.github.com/gh-unit/docs/appledoc_include/guide_testing.html

Pre Jenkins Setup

To do CI with Jenkins you will need to setup some scripts that manage building and testing from the command line. Lucky us, I have included those scripts for you.

Scripts

Copy the Scripts folder from this repo into the root of your project.

Move the script buildAndTest.sh and MakeFile to the root folder of your project:

mv Scripts/buildAndTest.sh .
mv Scripts/Makefile .

Add a Script step to the Build Target GHUnitTest

Add this sh "${PROJECT_DIR}/Scripts/RunTests.sh"

New Jenkins Job for Unit Testing

Before starting this portion, you will want to have your git repo pushed someplace jenkins can get to it. I hear github works?

Create a Free Style Project

Add your git repo

Setup SCM Polling

Use the option Poll SCM with the settings * * * * *

Add Build Step

sh "$WORKSPACE/buildAndTest.sh"

JUnit Report

The path to the JUnit XML files is here: build/test-results/*.xml

New Jenkins Job for CI Build Test

Okay, so we can run our unit tests. What next? In the true nature of CI, we keep integrating. We should build the actual app.

Copy Our First Job

Update Build Trigger

Change it from Poll SCM to Build after other projects are built. Provide the name of your UnitTesting Job.

Update Build Shell Command

Update the shell command to have this:

cd "$WORKSPACE"
xcodebuild -target MyTestApplication -configuration Debug -sdk iphonesimulator build

Notifications

In the Post-build Actions you will want to setup some notifications. E-mail is the easiest if your team is small.

Finished

At this point, Jenkins will build and run the GHUnitTest every time your push an update to your git repo. On success, it will test compiling the entire app as a Debug simulator build. It is possible build signed release versions, but it requires moving keychain and mobileprovisioning profiles around.

Try playing around with some Jenkins notification plugins to make the best use of the feedback it can provide.

Thanks

I've pulled parts of this from all over the place. If you see you work in here, push an update to this section.