Skip to content

development.md

Latest commit

 

History

History
77 lines (50 loc) · 3.27 KB

development.md

File metadata and controls

77 lines (50 loc) · 3.27 KB
Raw

Development

This document describes how to build and test Homestead.

Homestead development is ongoing on Ubuntu 14.04, so the processes described below are targetted for (and tested on) this platform. The code has been written to be portable, though, and should compile on other platforms once the required dependencies are installed.

Dependencies

Homestead depends on a number of tools and libraries. Some of these are included as git submodules, but the rest must be installed separately.

On Ubuntu 14.04,

  1. update the package list

    sudo apt-get update

  2. install the required packages

    sudo apt-get install git cmake make gcc g++ bison flex libsctp-dev libgnutls-dev libgcrypt-dev libidn11-dev ssl-cert debhelper fakeroot libpq-dev libmysqlclient-dev libxml2-dev swig python-dev libevent-dev libtool autoconf libboost-all-dev automake pkg-config libssl-dev libzmq3-dev libcurl4-openssl-dev debhelper devscripts libxml2-utils libsnmp-dev valgrind

Getting the Code

The homestead code is all in the homestead repository, and its submodules, which are in the modules subdirectory.

To get all the code, clone the homestead repository with the --recursive flag to indicate that submodules should be cloned too.

git clone --recursive git@github.com:Metaswitch/homestead.git

This accesses the repository over SSH on Github, and will not work unless you have a Github account and registered SSH key. If you do not have both of these, you will need to configure Git to read over HTTPS instead:

git config --global url."https://github.com/".insteadOf git@github.com:
git clone --recursive git@github.com:Metaswitch/homestead.git

Building Binaries

Note that the first build can take a long time. It takes 10-15 minutes on an EC2 m1.small instance.

To build homestead and all its dependencies, change to the top-level homestead directory and issue make.

On completion,

  • the homestead binary is in build/bin
  • libraries on which it depends are in usr/lib.

Subsequent builds should be quicker, but still check all of the dependencies. For fast builds when you've only changed homestead code, change to the src subdirectory below the top-level homestead directory and then run make.

Building Debian Packages

To build Debian packages, run make deb. On completion, Debian packages are in the parent of the top-level homestead directory.

make deb does a full build before building the Debian packages and, even if the code is already built, it can take a minute or two to check all the dependencies. If you are sure the code has already been built, you can use make deb-only to just build the Debian packages without checking the binaries.

make deb and make deb-only can push the resulting binaries to a Debian repository server. To push to a repository server on the build machine, set the REPO_DIR environment variable to the appropriate path. To push (via scp) to a repository server on a remote machine, also set the REPO_SERVER environment variable to the user and server name.

Running Unit Tests

Homestead uses our common infrastructure to run the unit tests. How to run the UTs, and the different options available when running the UTs are described here.