Utilities for building on travis-ci with OSX and Linux

A set of scripts to automate builds of OSX and manylinux1 wheels on travis-ci infrastructure.

These scripts are designed to build and test:

Dual architecture OSX wheels;
64-bit manylinux1_x86_64 wheels, both narrow and wide unicode builds;
32-bit manylinux1_i686 wheels, both narrow and wide unicode builds.

You can currently build and test against Pythons 2.6, 2.7, 3.3, 3.4, 3.5.

The small innovation here is that you can test against 32-bit builds, and both wide and narrow unicode Python 2 builds, which was not easy on the default travis-ci configurations.

How does it work?

Multibuild is a series of bash scripts that define bash functions to build and test wheels.

Configuration is by overriding the default build function, and defining a test function.

The bash scripts are layered, in the sense that they loaded in the following sequence:

OSX

See multibuild/travis_osx_steps.sh.

For build and test phases, these bash scripts get sourced one after the other, so that functions and variables defined in later scripts can overwrite functions and variables in earlier scripts:

multibuild/common_utils.sh
multibuild/osx_utils.sh
multibuild/library_builders.sh
multibuild/travis_osx_steps.sh
config.sh

See travis_osx_steps.sh to review source order.

The OSX build / test and phase are on the OSX VM started by travis-ci. Therefore any environment variable defined in the .travis.yml or bash shell scripts listed above are available for your build and test.

The build_wheel function builds the wheel, and the install_run function installs the wheel and tests it. Look in common_utils.sh for default definitions of these functions. See below for more details.

Manylinux

The build phase is in a Manylinux1 docker container, but the test phase is in a clean Ubuntu 14.04 container.

Build phase

multibuild/travis_linux_steps.sh defines the build_wheel function, which starts up the Manylinux1 docker container to run a wrapper script multibuild/docker_build_wrap.sh, that (within the container) sources the following bash scripts:

multibuild/common_utils.sh
multibuild/manylinux_utils.sh
multibuild/library_builders.sh
config.sh

See docker_build_wrap.sh to review the order of script sourcing.

See the definition of build_multilinux in multibuild/travis_linux_steps.sh for the environment variables passed from travis-ci to the Manylinux1 container.

Once in the container, after sourcing the scripts above, the wrapper runs the real build_wheel function, which now comes (by default) from multibuild/common_utils.sh.

Test phase

Testing is in an Ubuntu 14.04 docker container - see multibuild/docker_test_wrap.sh. multibuild/travis_linux_steps.sh defines the install_run function, which starts up the testing docker container with a wrapper script multibuild/docker_test_wrap.sh. The wrapper script sources the following bash scripts:

multibuild/common_utils.sh
config.sh

See docker_test_wrap.sh for script source order.

See install_run in multibuild/travis_linux_steps.sh for the environment variables passed into the container.

It then (in the container) runs the real install_run command, which comes (by default) from multibuild/common_utils.sh.

Standard build and test functions

The standard build command is build_wheel. This is a bash function. By default the function that is run on OSX, and in the Manylinux container for the build phase, is defined in multibuild/common_utils.sh. You can override the default function in the project config.sh file (see below).

If you are building a wheel from pypi, rather than from a source repository, you can use the build_index_wheel command, again defined in multibuild/common_utils.sh.

Typically, you can get away with leaving the default build_wheel / build_index_wheel functions to do their thing, but you may need to define a pre_build function in config.sh. The default build_wheel and build_index_wheel functions will call the pre_build function, if defined, before building the wheel, so pre_build is a good place to build any required libraries.

The standard test command is the bash function install_run. The version run on OSX and in the Linux testing container is also defined in multibuild/common_utils.sh. Typically, you do not override this function, but you in that case you will need to define a run_tests function, to run your tests, returning a non-zero error code for failure. The default install_run implementation calls the run_tests function, which you will likely define in config.sh. See the examples below for examples of less and more complicated builds, where the complicated builds override more of the default implementations.

To use these scripts

Make a repository for building wheels on travis-ci - e.g. https://github.com/MacPython/astropy-wheels - or in your case maybe https://github.com/your-org/your-project-wheels;

Add this (here) repository as a submodule:

git submodule add https://github.com/matthew-brett/multibuild.git

Add your own project repository as another submodule:

git submodule add https://github.com/your-org/your-project.git

Create a .travis.yml file, something like this:

env:
    global:
        - REPO_DIR=your-project
        # Commit from your-project that you want to build
        - BUILD_COMMIT=v0.1.0
        # pip dependencies to _build_ your project
        - BUILD_DEPENDS="Cython numpy"
        # pip dependencies to _test_ your project.  Include any dependencies
        # that you need, that are also specified in BUILD_DEPENDS, this will be
        # a separate install.
        - TEST_DEPENDS="numpy scipy pytest"
        - PLAT=x86_64
        - UNICODE_WIDTH=32
        - WHEELHOUSE_UPLOADER_USERNAME=travis-worker
        # Following generated with
        # travis encrypt -r your-org/your-project-wheels WHEELHOUSE_UPLOADER_SECRET=<the api key>
        # This is for Rackspace uploads.  Contact Matthew Brett, or the
        # scikit-learn team, for # permission (and the API key) to upload to
        # the Rackspace account used here, or use your own account.
        - secure:
            "MNKyBWOzu7JAUmC0Y+JhPKfytXxY/ADRmUIMEWZV977FLZPgYctqd+lqel2QIFgdHDO1CIdTSymOOFZckM9ICUXg9Ta+8oBjSvAVWO1ahDcToRM2DLq66fKg+NKimd2OfK7x597h/QmUSl4k8XyvyyXgl5jOiLg/EJxNE2r83IA="

language: python
# The travis Python version is unrelated to the version we build and test
# with.  This is set with the MB_PYTHON_VERSION variable.
python: 3.5
sudo: required
dist: trusty
services: docker

matrix:
  exclude:
    # Exclude the default Python 3.5 build
    - python: 3.5
  include:
    - os: linux
      env:
        - MB_PYTHON_VERSION=2.6
    - os: linux
      env:
        - MB_PYTHON_VERSION=2.6
        - PLAT=i686
    - os: linux
      env: MB_PYTHON_VERSION=2.7
    - os: linux
      env:
        - MB_PYTHON_VERSION=2.7
        - UNICODE_WIDTH=16
    - os: linux
      env:
        - MB_PYTHON_VERSION=2.7
        - PLAT=i686
    - os: linux
      env:
        - MB_PYTHON_VERSION=2.7
        - PLAT=i686
        - UNICODE_WIDTH=16
    - os: linux
      env:
        - MB_PYTHON_VERSION=3.3
    - os: linux
      env:
        - MB_PYTHON_VERSION=3.3
        - PLAT=i686
    - os: linux
      env:
        - MB_PYTHON_VERSION=3.4
    - os: linux
      env:
        - MB_PYTHON_VERSION=3.4
        - PLAT=i686
    - os: linux
      env:
        - MB_PYTHON_VERSION=3.5
    - os: linux
      env:
        - MB_PYTHON_VERSION=3.5
        - PLAT=i686
    - os: osx
      language: generic
      env:
        - MB_PYTHON_VERSION=2.7
    - os: osx
      language: generic
      env:
        - MB_PYTHON_VERSION=3.4
    - os: osx
      language: generic
      env:
        - MB_PYTHON_VERSION=3.5

before_install:
    - source multibuild/common_utils.sh
    - source multibuild/travis_steps.sh
    - before_install

install:
    # Maybe get and clean and patch source
    - clean_code $REPO_DIR $BUILD_COMMIT
    - build_wheel $REPO_DIR $PLAT

script:
    - install_run $PLAT

after_success:
    # Upload wheels to Rackspace container
    - pip install wheelhouse-uploader
    # This uploads the wheels to a Rackspace container owned by the
    # scikit-learn team, available at http://wheels.scipy.org.  See above
    # for information on using this account or choosing another.
    - python -m wheelhouse_uploader upload --local-folder
        ${TRAVIS_BUILD_DIR}/wheelhouse/
        --no-update-index
        wheels

The example above is for a project building from a git submodule. If you aren't building from a submodule, but want to use pip to build from a source archive on https://pypi.org or similar, replace the first few lines of the .travis.yml file with something like:

env:
    global:
        # Instead of REPO_DIR, BUILD_COMMIT
        - PROJECT_SPEC="tornado==4.1.1"

then your install section could look something like this:

install:
    - build_index_wheel $PROJECT_SPEC

Next create a config.sh for your project, that fills in any steps you need to do before building the wheel (such as building required libraries). You also need this file to specify how to run your tests:

# Define custom utilities
# Test for OSX with [ -n "$IS_OSX" ]

function pre_build {
    # Any stuff that you need to do before you start building the wheels
    # Runs in the root directory of this repository.
    :
}

function run_tests {
    # Runs tests on installed distribution from an empty directory
    python --version
    python -c 'import sys; import yourpackage; sys.exit(yourpackage.test())'
}

Make sure your project is set up to build on travis-ci, and you should now be ready (to begin the long slow debugging process, probably).

If your project depends on numpy, you will want to build against the earliest numpy that your project supports - see forward, backward numpy compatibility. See the astropy-wheels travis file for an example specifying numpy build and test dependencies.

Here are some simple example projects:

Less simple projects where there are some serious build dependencies, and / or OSX / Linux differences:

andreabedini / multibuild