A Jenkins job setup for your Xcode project.
Installing Jenkins
Xcode project setup
Jenkins plugins
Installing code metrics tools
Setting up the job
Troubleshooting
Download Jenkins from here: https://www.jenkins.io/download/weekly/macos/
I would recommend that the install should be made under the administrator user and not let the Jenkins installer create it's own user. That will generate issues when trying to access the keychain.
To run Jenkins go to /Applications/Jenkins and run the jenkins.war file. Make sure you have the latest Java JDK installed.
After that, you can access the Jenkins Dashboard using the following URL: http://localhost:8080
First, go to your project target from the left top corner of Xcode, click on the target and select "Manage Schemes".
There you should check the "Shared" option for your Xcode project (do not check shared for the Pods project).
Target - > Manage schemes - > Check “Shared”
Then, in the project's Build Settings turn on Generate Test Coverage Files and Instrument Program Flow for the Debug configuration on your main target and for both Debug an Release for your test target.
To take advantage of the generated files you need to set the Build Products and Intermediates to be saved in a folder relative to the Workspace. You can do this by accessing Xcode Preferences -> Locations -> Custom -> Relative to Workspace.
To check if everything it's OK you can build the project and check the following folders for .gcno and .gcda files
Build/Intermediates/YOUR-TEST-TARGET-NAME.build/Objects-normal/i386'
and
Build/Intermediates/YOUR-MAIN-TARGET-NAME.build/Objects-normal/i386'
You can find these based on the setting you have in Xcode for Locations.
To setup you job, you will need the following plugins:
Xcode plugin
Git plugin
Keychains and Provisioning Profiles Plugin
Duplicate Code Scanner Plug-in
Cobertura plugin
SLOCCount Plugin
EnvInject Plugin
To add Jenkins plugins you must go to Jenkins -> Manage Jenkins -> Manage plugins.
To install Homebrew, simply copy-paste this code into your Terminal and press enter:
ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
You can download 4.3 from here. The latest versions have suffered major changes that aren't supported by the ObjectiveC language definition yet.
To be able to make use of PMD you will also need to dowload the PMD Objective-C language definition from here - courtesy of Josh Kennedy.
cd ~
git clone https://github.com/gcovr/gcovr.git
sudo cp ./gcovr/scripts/gcovr /usr/local/bin
sudo chown root:wheel /usr/local/bin/gcovr
sudo chmod 755 /usr/local/bin/gcovr
cd ~
rm -rf ./gcovr/
Here comes the fun part: setting up the Jenkins job. The first step is creating the job: New item -> Freestyle project. This will let you do all the configuration of a job.
Our project is usually stored in a Git or SVN repository. The Jenkins job begins with this step: cloning the latest version of your branch.
You can setup this by adding your repository info & credentials in the Source Code Management section. For our job, we have a GitHub repostiory: https://github.com/cyupa/JenkinsCI-iOS.git and your GitHub credentials. Then you can specify the branch you want to clone and build, in this case: */master.
A Jenkins job does not have access to environment variables such as PATH, that allows us the invoke different scripts and tools without specifing the full path to that script. This scripts are stored at different locations and this variable knows about those locations.
You can check the PATH variableby opening a Terminal window and type echo $PATH.
In my case: /usr/local/bin:/usr/bin:/bin:/usr/sbin:/sbin:/Applications/Server.app/Contents/ServerRoot/usr/bin:/Applications/Server.app/Contents/ServerRoot/usr/sbin:/usr/local/Cellar/
Next, in the Build Environment section, we will add the line PATH=/usr/local/bin:/usr/bin:/bin:/usr/sbin:/sbin:/Applications/Server.app/Contents/ServerRoot/usr/bin:/Applications/Server.app/Contents/ServerRoot/usr/sbin:/usr/local/Cellar/ in the Properties Content field.
Before we go on, we should run our unit tests on our project, to make sure everything is OK. Add a new Execute Shell build step with the following code:
xctool -workspace ${WORKSPACE}/JenkinsCI.xcworkspace \
-scheme JenkinsCI \
-reporter plain \
-sdk iphonesimulator \
-reporter junit:test-reports/ios-report.xml \
test \
-resetSimulator \
-freshInstall
After this, add a Publish JUnit test results post build action to view the results of your test in your Dashboard.
At this point you can take a step back and try to build the project to check if everything is ok.
Obtaining code coverage can be tricky. First, you must check that your Intermediates/{PROJECT NAME}.build/Debug-iphonesimulator/{PROJECT NAME}.build/Objects-normal/i386 contains .gcno and .gcda files. After that, running the following command via an Execute shell build step will generate the code coverage.
gcovr -r . --object-directory ${WORKSPACE}/Build/Intermediates/JenkinsCI.build/Debug-iphonesimulator/JenkinsCI.build/Objects-normal/i386 --exclude '.*Tests.*' --xml > ${WORKSPACE}/test-reports/ios-cobertura-coverage.xml
The results can be published by adding a "Publish Cobertura coverage report" as a post build step.
This one is quite simple: it runs a script to see the total lines of code in your project, modules and in each file. To take advantage of SLOCCount you must add a build step with an Execute shell script:
sloccount --duplicates --wide --details ${WORKSPACE}/JenkinsCI/Classes > ${WORKSPACE}/test-reports/ios-sloccount.sc
Then you can publish the results just by adding a Post build step: Publish SLOCCount analisys results and use the test-reports/ios-sloccount.sc output as a source.
Now comes the tricky part: setting up the duplicate code metric.
We'll be using PMD 4.2.6 because the ObjectiveC Language dictionary isn't up to date with the latest PMD versions. After you downloaded both (links posted up in the Read me file), you must use the full path to the files you compose your shell script.
In my case I have dowloaded the files in /usr/local/Cellar/pmd/. In this case, the script will look something like this:
java -Xmx512m -classpath /usr/local/Cellar/pmd/4.3/lib/pmd-4.3.jar:/usr/local/Cellar/pmd/ObjCLanguage-0.0.7-SNAPSHOT.jar net.sourceforge.pmd.cpd.CPD \
--minimum-tokens 100 \
--files ${WORKSPACE}/JenkinsCI/Classes \
--language ObjectiveC \
--encoding UTF-8 \
--format net.sourceforge.pmd.cpd.XMLRenderer > ${WORKSPACE}/test-reports/ios-cpd-output.xml
If the test-reports/ios-cpd-output.xml is generated you can publish the results by adding a Publish duplicate code analisys results in the Post build section.
If everything is fine until this point, you can move on to the buil & distribute part of the job. Go on and add an Xcode build step. This plugin will invoke the xcodebuild command line tool and you can add all the build parameters here. Keep in mind that I'm using CocoaPods.
In this case:
- Target: JenkinsCI
- Clean before build? YES
- Generate Archive? YES
- Pack application and build .ipa? YES
- .ipa filename pattern: ${VERSION}
- Output directory: ${workspace}/Builds/${BUILD_NUMBER}/${BUILD_ID}
- Unlock Keychain? YES
- Keychain path: ${HOME}/Library/Keychains/login.keychain
- Keychain password: your administrator user password
- Xcode Schema File: JenkinsCI
- Xcode Workspace File: ${WORKSPACE}/JenkinsCI
- Xcode Project Directory: ${WORKSPACE}
- Xcode Project File: ${WORKSPACE}/JenkinsCI
- Build output directory: ${WORKSPACE}/Build
- Provide version number and run avgtool? YES
- Technical version: ${BUILD_ID}
After you configured this to your needs you should check if the job finishes successfully before moving on to the next step.
The Crashlytics frameworks comes with a really nice tool to distribute your build to the testers, client and your team. To simply upload and notify your user groups about a new build you can add another Execute shell build step with the following command:
${WORKSPACE}/Pods/CrashlyticsFramework/Crashlytics.framework/submit \
<API_KEY> \
<BUILD_SECRET> \
-ipaPath ${WORKSPACE}/builds/${BUILD_NUMBER}/${BUILD_ID}/${BUILD_ID}.ipa \
-groupAliases clients,developers,testers \
If you would like to add some notes to your upload you could add a "Release notes extractios" step. You can do this by adding an Execute shell build step:
curl -s "http://localhost:8080/job/JenkinsCI/$BUILD_NUMBER/api/xml?wrapper=changes&xpath=//changeSet//comment" | sed -e "s/<\/comment>//g; s/<comment>//g; s/<\/*changes\/*>//g" | sed '/^$/d;G' > ${WORKSPACE}/changelog.txt
This will extract the comments from your commits since the last build and put them into the changelog.txt file. Once you've done this, add the following option in your Crashlytics submission script: -notesPath ${WORKSPACE}/changelog.txt \.
If you encounter issues when running 'brew install sloccount' such as:
looking for OpenSSL headers 'openssl/md5.h'... Cannot find it. Please run this script as such: SSLINCPATH=<path/to/ssl/include> ./configure
Install OpenSSL via Homebrew ('brew install openssl') and retry.
If that doesn't work, go to /Library/Caches/Homebrew/, unpack the md5sha1sum archive, open it, and run the following command in the Terminal: SSLINCPATH=/usr/local/Cellar/openssl/1.0.1i/include ./configure.
If your build fails with a linker error in the Build step while trying to build and archive (for some reason xcodebuild tries to build the test scheme in the Archive configuration) for some class included in your test case, go to Build Settings and turn Symbols Hidden by Default to NO on your main target.