Docker Images

The Cyrus IMAP uses Docker images for testing builds and performing unit tests for, at the time of this writing, 13 (releases of) Linux distributions.

The images are configured to start running tests automatically (i.e. they have an entrypoint). To get an interactive shell, see Getting an Interactive Shell.

The results of the tests are posted to our Phabricator instance as comments to commits, or raise a concern (which in turn becomes an Audit request).

When Dr. Jenkins raises a concern with a commit, she intends to raise awareness over builds failing.

The current state of the tree is compared to the last state of the tree using the parent of the current commit.

  • If a step in current fails, but the parent also fails, Dr. Jenkins will only leave a comment – with one exception;

    If make (relaxed) fails, checking the parent is irrelevant, and a concern is raised – triggering an audit.

  • If a step in current fails, but it does not fail in the parent, it is likely the commit broke the build (or that the Dr. Jenkins script does not work). This raises a concern too.

Quick Notes

  • If the environment variables PHAB_CERT and PHAB_USER are specified, Arcanist is installed and configured.

    This enables you to run through a debugging session on a specific platform, interacting with, for example, Differential or Diffusion at https://git.cyrus.foundation.

    You can obtain your certificate, which is a very long string, from Phabricator’s Conduit.

  • To apply a Differential revision regardless, specify the DIFFERENTIAL environment variable.

    Note

    Do not specify the D in the variable, just the number.

  • The images come with vim pre-installed and pre-configured to:

    1. Remember the last position in a file you’ve opened,
    2. Employ syntax highlighting,
    3. Apply the current latest indentation policy for Cyrus IMAP.
  • In an interactive shell, PROMPT_COMMAND is set to have the terminal window you have open reflect the name of the image you are running and running multiple of them is not just a bunch of windows titled with container IDs.

Environment Variables

COMMIT

More commonly referred to as a git ref, the COMMIT environment variable is used to issue a git checkout ${COMMIT} with.

Examples:

Run against HEAD of the cyrus-imapd-2.5 branch:

$ docker run -it -e "COMMIT=cyrus-imapd-2.5" \
    cyrusimapd/maipo

Important

The images and scripts do not currently support Cyrus IMAP versions prior to 2.5.0.

CONFIGURE_OPTS

Use the options specified to run ./configure, rather then the default configure options.

Examples:

  1. Test with a yet unknown configure option added by a Differential revision (don’t forget to also set the DIFFERENTIAL environment variable):

    $ docker run -it -e "CONFIGURE_OPTS=--enable-ceph" \
        cyrusimapd/maipo
    
  2. Test an option that is otherwise known to fail:

    $ docker run -it -e "CONFIGURE_OPTS=--with-openssl=no" \
        cyrusimapd/wheezy
    

DIFFERENTIAL

Before running anything, apply the Differential revision specified.

Note

Only specify the number, not the D prefix.

Examples:

Test a Differential revision:

$ docker run -it -e "DIFFERENTIAL=9" \
    cyrusimapd/santiago

PHAB_CERT

PHAB_USER

Future Environment Variables

BUILD_ID

We intend to run the Docker containers as part of the Harbormaster and DryDock applications in Phabricator, for the purposes of continuous integration – rather than comment on commits individually.

TICKET

Report to a Maniphest ticket rather than the Diffusion commit.

Running the Tests Yourself

$ docker run -ti cyrusimapd/heisenbug

Note

Aside from specifying a PHAB_CERT environment variable, this is how tests are run when they result in a comment or concern on a commit.

Getting an Interactive Shell

$ docker run -ti --entrypoint="/bin/bash" cyrusimapd/heisenbug -s

This will give you an interactive shell.

The images are configured with an entry point of /entrypoint.sh, so maybe you want to execute that.

Functions for Your Convenience

Functions are pulled from /entrypoint.sh so you can source /functions.sh which gives you the following commands:

_make_relaxed

This command configures the build with relaxed CFLAGS, as opposed to -g -Wall -Wextra -Werror.

_make_strict

This command configures the build with strict CFLAGS, turning all warnings to errors: -g -Wall -Wextra -Werror.

Build Process Steps

./configure (maintainer mode)

If the CONFIGURE_OPTS environment variable has been specified, the following commands are run automatically:

$ ./configure --enable-maintainer-mode
$ make \
    imap/rfc822_header.c \
    imap/rfc822_header.h

These should not fail, but if they do, it’s probably your fault. See Error Message: Step pre-configure fails on (...).

Note

If CONFIGURE_OPTS is not specified, then ./configure (for real) takes care of specifying the required --enable-maintainer-mode option.

./configure (for real)

Configure is run for real, using either the defined CONFIGURE_OPTS or a default of (at the time of this writing):

./configure \
    --enable-autocreate \
    --enable-coverage \
    --enable-gssapi \
    --enable-http \
    --enable-idled \
    --enable-maintainer-mode \
    --enable-murder \
    --enable-nntp \
    --enable-replication \
    --enable-unit-tests \
    --with-ldap=/usr

If the second run of ./configure fails for whatever reason, the script checks out the parent of the current commit and tries again.

make (relaxed)

The first run of make is relaxed, meaning that CFLAGS are default.

make (strict)

The second run of make is strict, meaning that CFLAGS are default.

make check

Execute the CUnit tests in cunit..