How to do stuff

HOW TO DO STUFF

All these commands assume that you are in the repository root directory.

Build the docs

sh ./docs/generate.sh

If you have installed composer globally you will need to modify generate.sh as follows:

if [ ! -f $BIN_FILE ]; then
    # rm composer.lock
    composer require apigen/apigen:dev-master --dev
fi

Run the unit tests

This requires PHPUnit to be installed; see http://phpunit.de

phpunit

Run the integration tests

We have developed a suite of integration tests to allow you to do a full run-through before releasing code. You execute these through a bespoke CLI tool which provides full granularity: so you can run the full suite or individual tests.

php ./tests/OpenCloud/Smoke/Runner.php

The is the main script and will run everything if you do not provide additional flags. These CLI options are available to you:

Short option	Long option	Description
-I	--include	Explicitly includes a particular test unit. So if you want to run only Swift tests, you'd use -Iobjectstore. For multiple, you delimit by comma: -Iobjectstore,compute. This will also work -Icompute -Iobjectstore.
-E	--exclude	Explicitly excludes a particular test unit. Format is identical to -I.
-A	--all	View all possible test units
-D	--debug	Enable logging so that every HTTP transaction over the wire is outputted.
-H	--help	Help screen