Building Gradle Projects with Jenkins CI
Once you've begun to use Gradle to build and test projects (see Getting Started with Gradle), you might like to build automatically, run tests on every push to your repo, and push your builds to a deployment system.
This tutorial reflects the author's workplace build environment, with Jenkins CI running on a build server on the local network. You may be able to adapt this guide if you are using Travis CI or CircleCI.
Use your local machine as a testbed to keep track of your environment configuration:
your PATH environment variable, and the other environment variables you set in order to get Gradle to run. This step is ready as soon as you can run gradle assemble in your project and see BUILD SUCCESSFUL.
This tutorial presumes that you already have a Jenkins installation running.
Go to your Jenkins environment through the web UI and determine whether it's running all jobs as the same user, or is configured to use separate user accounts for different jobs. A basic Jenkins configuration will use only one user account on its host server. If you currently have no jobs configured or the existing jobs are all sharing the Jenkins default environment, you can skip ahead to Install the Android SDK, but do consider migrating to the build node approach with a separate user!
In my workspace configuration, Jenkins was set up with multiple node environments because the same machine is used to build iOS and Django projects.
Here's how to determine whether Jenkins is already set up to sandbox projects in their own environments.
- On the build machine, are there already other user accounts corresponding to other projects?
- On Jenkins UI, when you go to Manage Jenkins -> Configure Jenkins, do you see multiple nodes?
If this is the case, you should set up a node environment just for your Android build tasks.
You'll be creating a new user account on the Jenkins server, linking this account to a new virtual node configuration that runs on that user account, and then configuring your Jenkins job to run on the new node.
Your machine is ready to be customized for Android and Gradle. You'll be re-creating many features of your local development environment.
You'll need wget. Check that you've got it:
which wget
If it's not installed, go get it. (My build machine is a Mac.)
Let's create a build node. I have found it helpful to create two accounts on the build server, my own account ari with superuser privileges, and then the ciandroid account with normal user privileges.
SSH to your build server.
$ ssh [email protected]:9229
Become the build node user with su, and go to your build environment's home directory.
$ sudo su ciandroid
$ cd
Note: if su prompts you for a password, it wants your superuser password, not the account password for the ciandroid user.
cd to your home directory (/Users/ciandroid), or your preferred place for file downloads.
Now download the Android SDK without Eclipse bundled. Go to Android SDK and copy the URL for the SDK Tools Only download that's appropriate for your build machine OS.
On your build machine, wget the correct SDK URL:
$ wget http://dl.google.com/android/android-sdk_r22.6.2-macosx.zip
Also download the Gradle binary. Remember, you want Gradle 1.6.
$ wget https://services.gradle.org/distributions/gradle-1.6-bin.zip'
Unzip both of these directories and place the contents in their own locations within your home directory. The directory names can be anything you like, but I like the following setup. The Gradle binary is in /Users/ciandroid/bin/ and the Android SDK is in /Users/ciandroid/src/.
Now it's time to set your build environment's PATH variable and other variables that Jenkins will use to locate Android and Gradle.
cd to your CI environment's home directory (ciandroid home dir) and edit your .bash_profile file. If you're not using bash, edit the right config file for your environment.
Make your .bash_profile look like the following, replacing paths as needed:
# Android
export ANDROID_HOME=/Users/ciandroid/android-sdk-macosx
export PATH=$PATH:$ANDROID_HOME/tools
# Gradle
export GRADLE_HOME=/Users/ciandroid/gradle-1.6
export PATH=$PATH:GRADLE_HOME/bin
Save and quit. Reload .bash_profile:
$ source ~./bash_profile
For this step, it's especially helpful to have GUI access to the build server. Installing particular Android SDK packages from the command line is tricky. So if you have not already done so, use VNC to connect to your build machine and open a terminal there.
At the prompt, type android and hit Enter to launch the Android SDK Manager in a window. If this doesn't work, your PATH variable has not been set up with the Android SDK location.
You will want to install the same Android SDK packages on your build machine as you did to get Gradle running locally. Before you begin, take a look at the build.gradle file in your project.
Here are the SDK packages names you'll definitely need:
-
Android SDK Tools (latest version)
-
Android SDK Platform-tools (latest version)
-
Android SDK Build-tools (latest version)
-
Android SDK Build-tools for the version of Android that you listed in the
build.gradlefile as theandroid: buildToolsVersiontarget. If yourbuild.gradlesaysandroid { buildToolsVersion '17' ... }
then make sure to download that API version in the Android SDK Manager.
Download the complete SDK package set for the API levels that you named in the android: compileSdkVersion section of your build.gradle file.
- Android Support Repository
- Android Support Library
Your environment should be ready to go! You can type gradle at a prompt to see that it's installed.
Now you need to get your project onto the build server so that Jenkins can find it.
Again, if you are using separate environments for different projects (as suggested), make sure you are the ciandroid user in your build environment and that you are in the home directory for that user.
In your build environment, create a directory for Android project source code, and check out your project from version control into that location. I put my projects in /Users/ciandroid/ci/.
$ whoami
ciandroid
$ cd ~/ci; pwd
/Users/ciandroid/ci
$ git clone [email protected]/my_repo/project.git
Cloning into 'project'...
cd into the project directory on your build machine. Make sure you see your build.gradle file, and run gradle assemble.
Hopefully, this is what you'll get:
Now you are ready to set up Jenkins to build for you.
Pre-existing settings on your build machine may cause your setup to vary from these directions. Since I was already using a separate Jenkins node for other projects, I created a node for the Android project. You can skip to Create the Build Job if, instead, you are building all Jenkins jobs within the same user environment.
If you are using SSH key authentication to connect Jenkins, your ciandroid user will need its own SSH key pair. In my work environment, I already had a key pair ready to drop into a /Users/ciandroid/.ssh directory. When you set up SSH keys for your build environment, make certain that the .ssh/ directory and contents are owned by the build environment user (ciandroid) and not by any other user. Use chown on the .ssh/ directory to fix it if necessary.
Using the menus in the Jenkins UI, go to Jenkins -> Manage Jenkins -> Manage Nodes -> New Node. Select "Dumb Slave" and give it the name android.
You'll need to provide your own values for your Host and Credentials settings, tailored to your own systems. But make sure to set Remote FS root with the ci/ path you created earlier. Also ensure that Environment Variables is checked under the Node Properties section, and fill in values for ANDROID_HOME and PATH.
When you set this up, a Jenkins jarfile called slave.jar will be downloaded into your node environment ci/ directory.
One more detail: My build machine uses SSH on a nonstandard port. If this sounds familiar, you may need to hit the "Advanced" button on the Host section and provide the following extra values in the hidden fields:
Port: [your machine's SSH port number]
JVM Options: -Djava.awt.headless=true
Now you have a Jenkins node that's capable of running jobs. You're ready to create the Jenkins job that actually runs the build.
Go back to the Jenkins main page and hit New Item. Give the job a name and select "Build a free-style software project." In the job configuration screen that follows, you will do all the setup to tell Jenkins about your source.
Jenkins build configurations can have many steps. The key fields you want to look out for are:
-
Restrict where this project can be run: give it the name of the build node you created - Source code integration for your version control system
- Build Triggers
- Build
Also, look for an "Advanced" button just below the Restrict where this project can be run setting. This is where Jenkins hides the setting for the source code path on your build node. The workspace part of this path is like a variable name for the Remote FS root path you added when you set up the Jenkins node. So, workspace/ stands in for /Users/ciandroid/ci/.
Under the Build heading, add shell execute statements with the "Add build step" tool:
gradle cleangradle assemble
Make sure you hit "Save" after all this work!
All of the following screenshots are intended as a starting point only.
Once your Jenkins job has been created, give it a go. Click Build Now on the job page. If the build didn't succeed for any reason, Console Output under the page for the failed build will help you debug it. Don't get discouraged!
When the build has succeeded, Gradle will put your build APK in a build/ directory in your project's location in ci/ on the build machine.
From here, you can configure Jenkins to build on push, run tests automatically, and upload APKs to a deployment system such as Hockey.
Congratulations on building your Android project!
- http://ingorichter.blogspot.com/2012/02/jenkins-change-workspaces-and-build.html
- http://www.ericrgon.com/android-with-circle-ci/ - extra tips on building with CircleCI