CHICKEN Flight Test
This is a test harness for CHICKEN Scheme, designed to help check for build problems across the various platforms it supports. It's stitched together from Vagrant, shell scripts, and an assortment of virtual machines found on the Vagrant Cloud.
vagrant status # list available platforms vagrant test # test chicken on all platforms vagrant test <machine> ... # test chicken on specific platforms
There is a separate virtual machine for each build platform and
architecture. You can list all of them with
To create a test machine, run
vagrant up <machine>. When started for
the first time, it will fetch and install all of CHICKEN's build
dependencies. This may take some time. If anything goes wrong, you can
vagrant provision <machine> to try again.
Once a machine has been created, it can be used to test CHICKEN. The test process is broken down into three steps:
fetch- Fetches two copies of CHICKEN: one from a release tarball and one from the core Git repository.
reset- Removes build artifacts from any previous test runs and resets the Git checkout to the correct revision.
check- Builds and tests CHICKEN: first the release version, then a bootstrap build from Git, then a full install from Git using the bootstrap build, and finally the test suite.
To run these steps in order, run
vagrant test <machine>. See
test --help for details about the supported options. Test output is
saved to the
logs directory, named according to the build platform.
If a file called
Vagrantfile.local exists, it will be loaded and any
changes it makes to the
Test::Env hash will be put into effect. This
hash controls the test script's environment variables, and can also be
used to adjust the following build variables:
RELEASE- The release tarball to use for bootstrapping.
REPOSITORY- The Git repository from which to fetch CHICKEN.
REFERENCE- The Git reference to build (e.g. "master").
BOOTSTRAP- Whether to build via bootstrap compiler ("0" or "1").
For example, to test a specific branch or commit, you can set the value
Test::Env[:REFERENCE] = 'amazing-feature-branch'
It's possible to test on Windows, but you'll need to provide the Vagrant boxes yourself. You can create these from the boxcutter project's templates for Windows with the following commands[^1]:
git clone git://github.com/boxcutter/windows.git boxcutter/windows cd boxcutter/windows make virtualbox/eval-win10x86-enterprise-ssh make virtualbox/eval-win10x64-enterprise-ssh
Building these boxes will take a long time and use a lot of disk space, but once they have been created you'll be able to use them for testing.
[^1]: The commands to create the boxes may have changed since time of writing, so refer to the project's README for more details.
Patches are very welcome, especially those that add support for more test platforms.
When setting up a new platform, there are a few things to note:
- GNU Make must be referred to as
gmakesomewhere on the PATH.
- Box names generally follow a
flavouris used to look up platform-specific configuration files under the
- Try not to rely on anything but an SSH connection and a shell. This includes Vagrant niceties like shared folders.
Send questions, comments, and patches to Evan Hanson email@example.com.