My name is Philipp C. Heckel and I write about nerdy things.
This site moved here recently from blog.philippheckel.com!

The magic of Gradle: create Windows installers, Debian packages, manage a PPA, and optional sub-projects


Programming

The magic of Gradle: create Windows installers, Debian packages, manage a PPA, and optional sub-projects


Gradle is great build tool. Compared to Ant or Maven, it’s so much easier to use and write proper code for it — it’s unbelievable at times. A little while ago, I switched from an ugly Ant/Maven installation to Gradle with my open source project Syncany. Ever since then, I am simply amazed about what Gradle can do. Granted, it’s not always easy to understand and the lack of proper documentation and IDE support makes things more like a trial-and-error-based packaging experience. However, the amount of time that it saves is worth it.

Since I really like Gradle and I myself often have a hard time finding proper answers for the questions I have, I’d like to demonstrate a few solutions that I have come up with. In particular, I’ll describe how to create a Windows installer using Inno Setup under Linux, create Debian packages and manage a PPA (debuild/dput) as well as how to add an optional Gradle sub-project.


Content


0. Real-world code available at GitHub

For the impatient folks, please note that this blog post talks about a real-life project. The entire code and Gradle build scripts are available on GitHub. Check out the Syncany organization page for a list of all the projects, the the main project page, or simply check out the build.gradle file directly.. The post relies on revision 74c737d871.

1. Project setup

1.1. Multi-project setup

Syncany comprises multiple modules (sub-projects) that depend on each other. Luckily Gradle provides a neat sub-projects support out of the box. There are many examples and blog posts that show you how to do multi-projects in Gradle, so I’m not going into detail here. Instead, I’ll just show the essential parts of the configuration.

The settings.gradle file defines the mandatory sub-projects for the project:

And the build.gradle (and all of the included files) define the sub-projects in detail:

1.2. Optional additional Gradle projects (from another Git repo)

Syncany has a concept of storage plugins: Users can extend the functionality of Syncany by downloading and installing plugins. These plugins are not part of the main project and everyone can write those plugins.

Obviously these plugins can’t be part of the main project source tree. In fact, they probably shouldn’t even be part of the same Git repository. However, even though plugins are defined in a completely different Git repository, they still depend on the main project. For a plugin to build correctly, it must know and embed the main project.

So what we actually want is to dynamically add a Gradle subproject. Using git subtree, this can be easily done: Suppose we have an optional plugin syncany-plugin-sftp from which we’d like to build a plugin JAR file. Using git-subtree, the main project is added in a subfolder core (e.g. by git remote add coreorigin git://...; git subtree pull --prefix=core coreorigin master --squash). That way, the entire main project code is available to the plugin (listing shortened):

In its own build.gradle, the plugin can define its own dependencies and tasks. However, if there are a lot of similar plugins (or optional subprojects), including code from the main project might be a good idea: Using apply from: 'core/...' can be used to avoid duplicate build code — something like I’ve done in this SFTP plugin.

All that’s missing to a complete configuration is to tell Gradle about the relationship between this project (= the plugin) and the main project in the core folder. In the settings.gradle file, we need to tell Gradle that the rootProject is located in core and that the current folder is actually just a plugin. If we wouldn’t redefine rootProject.projectDir, Gradle would assume that . (= the plugin directory) is the root project. That might work in some cases, but it didn’t in mine. Here’s how you can redefine the root project:

This code does the regular includes, but then tells Gradle where to map the given virtual project names, so that :syncany maps to core (main project), :syncany-lib maps to core/syncany-lib, and so on.

Since this is very generic code (applicable to any plugin), this code can be moved to a separate .gradle-file in the main project, and then included by the plugin.

2. Versioning releases in Gradle (using the Git commit)

When generating snapshots for the project, a proper versioning and file naming is necessary. Ideally, we want the version to follow semantic versioning 2.0 — so basically have a MAJOR.MINOR.PATCH version as well as alphabetically orderable build information such as compile date and the Git revision in the build metadata. For Syncany, a snapshot version looks like this: 0.1.5-alpha+SNAPSHOT.1405262224.git9c07793, and a normal release looks like this: 0.1.5-alpha.

In Syncany’s Gradle configuration, the following code is used to create this version:

As you can see above, we first determine three things: the compile date, whether or not this is a release version (= commit on the master branch, as per the nvie branching model), and the Git commit/revision. This information is then simply concatenated.

Retrieving the Git branch (“Is this a release?”) and the Git commit happens in the isApplicationRelease() and getRevision() methods. They simply use git log -n 1 --pretty=%d HEAD to determine the branch (also works on a detached branch, i.e. on Travis-CI) and git rev-parse --short HEAD to determine the commit:

These methods can be called from any Gradle build scripts in all sub-projects, because we define their scope to be in the rootProject. Especially the execAndGetOutput() method is very useful: It can be used to run any Linux/Windows command. Since I want the central parts of the Syncany build script to run on Windows and Linux, the git commands must be platform-independent.

3. Building Debian/Ubuntu packages and uploading to a PPA

I’d like Syncany to be available on Debian and Ubuntu systems (since I myself use an Ubuntu-based distro), so having a proper .deb-file installation and a PPA is a must. Here’s how to do it with the help of several Gradle tasks and shell scripts.

Debian packages are built using the debuild tool, uploads to a PPA are managed via dput. To create valid Debian packages, debuild expects a debian directory containing files such as debian/control, debian/changelog, etc. (Details to Debian/Ubuntu packaging can be found in the Debian New Maintainers’ Guide or the Ubuntu Packaging Guide).

If these files are present and valid, debuild -i -us -uc -b builds a standalone .deb file, and debuild -S builds the source package that can be uploaded to a Launchpad PPA. For Syncany, I completely automated both of these processes in the following tasks (see packaging.debian.gradle):

  • gradle debianPrepare<distribution> creates a source directory ready for debuild and includes a valid debian/changelog (generated from the CHANGELOG.md).
  • gradle debian generates a standalone .deb file from the above-prepared directory using debuild -i -us -uc -b. This task depends on a debianPrepare*-task.
  • gradle ppa generates a source package and uploads it to the PPA. It uses two helper shell scripts debuild-signed.sh and dput-ppa.sh. As above, this task depends on a debianPrepare*-task.

3.1. Standalone .deb-file

Compared to the PPA upload, creating a standalone Debian package is really easy: The debianPrepare<distribution> task depends on the installApp task of the Gradle application plugin (which copies relevant JAR files to a lib folder and shell/batch scripts to a bin folder). In addition to these two folders, it copies a prepared debian folder and creates a valid debian/changelog file.

The task is created using Gradle’s task rules. It matches every string that begins with ‘debianPrepare’ and uses the rest of the task name as the Ubuntu/Debian distribution. This distribution string is used in the changelog file and the filename. Running gradle debianPrepareTrusty, for instance, will ultimately result in syncany_0.1.5.alpha~trustyppa1_all.deb (for Ubuntu Trusty Tahr). Running gradle debianPrepareSaucy, however, will result in syncany_0.1.5.alpha~saucyppa1_all.deb (for Ubuntu Saucy Salamander).

Here’s how the task looks like (check out the full file in packaging.debian.gradle):

If we’re building a package for Ubuntu Trusty Tahr, for instance, the folder structure looks like this after running the task:

Except for the debian/changelog file, all the other files in debian/* are just copied from the template folder. The changelog file is created using a tiny perl script that translates my Markdown-based CHANGELOG file to the proper Debian changelog format. After the script is run, the changelog file looks like this:

While the changelog file seems really unimportant, it is used by debuild to determine the package name, version and the keypair to sign the package with. Based on this changelog file, the resulting package will be named syncany_0.1.5.alpha+SNAPSHOT.1405271541.git74c737d~trustyppa1_all.deb:

3.2. Signed PPA upload

Personal package archives (PPA) a very essential and important part to distribute software packages for Ubuntu/Debian. Launchpad offers a pretty neat infrastructure to manage PPAs: Instead of uploading the .deb-file yourself, Launchpad expects you to build a so called source package with debuild, sign it with your private key (for which the public key is known by Launchpad) and upload it using dput. Launchpad will then build the .deb-file on their machines and provide it in the PPA.

If you do this on your local machine, it’s pretty straight forward:

  1. Generate a RSA keypair, upload the public key to a keyserver and make it known to Launchpad
  2. Run debuild -S on the prepared source directory (like above, e.g. via gradle debianPrepareTrusty) to package the source files archive (.tar.gz), create a changes file (.changes) and a detached signature file (.dsc).
  3. And then upload all of these files via dput ppa:syncany/snapshot

Doing that from a script via Gradle (especially on Travis-CI) is not as easy, because a private key is required — and that key is obviously meant to be private, and not up on GitHub. And yet, I uploaded a the Syncany Team private key to GitHub. It’s encrypted with an AES-256 symmetric key, so don’t get any ideas :D.

To automate all that on Travis-CI without exposing the private key (to anyone but Travis), a bit of fiddling was necessary. Here’s how I did it:

  • The generated private key is protected with a passphrase (key-priv), exported to syncany-team.asc (e.g. using Seahorse) and then encrypted with a second passphrase (key-wrap, = AES key): cat syncany-team.asc | gpg --symmetric --cipher-algo aes256 > syncany-team.asc.aes256.
  • The two passphrases are written to Travis’ encrypted environment variables and added to the .travis.yml file (here: SYNCANY_GPG_KEY_WRAP and SYNCANY_GPG_KEY_PRIV).
  • The Gradle task gradle ppa runs two shell scripts: (1) debuild-signed.sh decrypts the private key, sets up a GnuPG keyring and runs debuild -S, and (2) dput-ppa.sh simply runs dput ppa:syncany/(snapshot|release).

Here’s what the call sequence during build time looks like. Note that this is shortened output. Please checkout the debuild-signed.sh script for details:

After running this, the source package files are created:

That’s it. Once dput is run for the correct PPA and the files were uploaded successfully, Launchpad will go ahead and build the .deb-file for given distribution. If you like, check out the Syncany Snapshot PPA or the Syncany Realease PPA to see the result, or the Travis-CI output to see how it’s done in the wild.

4. Windows installers with Inno Setup on Linux (automated using Gradle)

Inno Setup can create pretty neat installers for Windows — and since I really like how the resulting installer looks like, I wanted to use it for Syncany. In case you’ve never seen an Inno Setup created installer, here’s what it looks like:

Unfortunately, the software itself is only available on Windows which makes the build process for Syncany a bit trickier, because the continuous integration server (Travis-CI) runs Linux. This didn’t stop me though.

4.1. Manually creating an installer on Linux

Without any automation, it’s pretty easy: Simple install Wine (Windows emulator), then download/install Inno Setup within Wine. With Inno Setup installed, you can either run the GUI to create/edit your install file (.iss-file) or use the Inno Setup command line compiler (ISCC.exe) to compile it from anywhere.

For Syncany, the setup.iss file looks like this (excerpt):

To compile this .iss-file and package the .exe-installer on Linux, you can either click the little play icon in the Inno Setup GUI or run wine "C:\Program Files (x86)\Inno Setup 5\ISCC.exe" "setup.iss" "/q" on the command line.

4.2. Automating installer creation on Linux

To automate this process, we need to do a few more things:

  1. Preparation: Install Wine and Inno Setup on Linux without user interaction or an attached display
  2. During build: Automatically replace version numbers in the setup.iss file
4.2.1. Install Wine and Inno Setup on Linux without user interaction

Installing Wine is easy: a simple apt-get install wine is enough on a Debian based system. To install Inno Setup within wine, however, one needs to download a tool called innoextract to extract the Inno Setup installer (is.exe), and then copy the extracted Inno Setup executables somewhere in Wine’s virtual C:\ drive:

For Syncany, I described these steps in the Travis-CI instruction file .travis.yml and the tiny shell script innoinstall.sh.

4.2.2. Build .exe-installer with Inno Setup in Gradle

After that preparation, the actual building is not much effort. This gradle exe task copies over the necessary resources into the build directory and then calls the Inno Setup compiler ISCC (wrapped in the tiny shell script iscc).

While copying the main Inno Setup build file setup.iss, the application version is replaced with the version that’s currently being built (as shown above) using the expand() method.

Once you’ve run gradle exe, an installer will be created: syncany-0.1.5-alpha+SNAPSHOT.1405271541.git74c737d.exe.

5. Summary

Even though these are not all Gradle-only topics and they are only partially related, I hope that they are still valuable to you guys. Please let me know what you think and please feel free to give feedback if you like. I am not a Gradle Pro and I’d love to learn how things could be improved.

3 Comments

  1. Ivan

    Thanks for sharing this! I used Gradle + Inno Setup to automatically create Windows installers.
    For the Gradle code, I made the task depend on installDist and instead of delete and mkdir I just used delete fileTree(dir: innoSetupDir).
    I also made some changes in the Pascal code section of Inno Setup, since it is possible to have a value for JAVA_HOME regarding of Java being installed or not. So, I check first if JDK/JRE exists and only then I decide about JAVA_HOME.



  2. NanoDano

    Great article. If you ever consider updating the article, I suggest including a Mac app bundler into the examples.


Leave a comment

I'd very much like to hear what you think of this post. Feel free to leave a comment. I usually respond within a day or two, sometimes even faster. I will not share or publish your e-mail address anywhere.