berdir / drupal_ti

Drupal - Travis Integration

drupal_ti - Travis Integration for Drupal modules

Versions

Welcome!

Welcome and thanks for trying drupal_ti!

This will make it simple to use travis to test your drupal modules with simpletest and phpunit tests.

All you need is to push your drupal.org repository to Github, setup the module below, login to travis-ci.org, setup the repo and you are up and running in no time.

Setup

Copy .travis.yml.dist to your root folder as .travis.yml and customize the DRUPAL_TI_MODULE_NAME global environment variable to match the name of your module.

You will also need to activate one matrix option, based on if you have support for Simpletest, PHPUnit, Behat or all together:

env:
  matrix:
    # [[[ SELECT ANY OR MORE OPTIONS ]]]
    - DRUPAL_TI_RUNNERS="phpunit" 
    - DRUPAL_TI_RUNNERS="phpunit simpletest behat" 

This example would run phpunit as one matrix runner, which gives you results fast, then phpunit, simpletest and behat as the slow runner.

If you want to run drupal_ti with a Drupal-8 module, then you need to use:

- DRUPAL_TI_ENVIROMENT="drupal-8"

Using a different tests/ directory.

If your tests/ and composer.json are not in tests/ directory you will want to change:

before_install:
# Comment this line for different directories, e.g. composer in the root.
#  - cd ./tests

How does it work

drupal_ti provides a drupal-ti command, which is then called with each stage of travis-ci (e.g. install, before_script, ...).

By providing different runners in runners/simpletest or runners/phpunit/ the corresponding scripts are executed (e.g. runners/phpunit/script.sh).

Also diffent environments are included from environments/$DRUPAL_TI_ENVIRONMENT.sh, which makes it possible to distinguish easily between Drupal 7 and 8.

This gives you a modular travis experience and such the scripts can be very generic.

Drupal is installed in $TRAVIS_BUILD_DIR/drupal_travis/drupal and drush is available after before_script stage.

How to customize the default behavior

By using

- DRUPAL_TI_SCRIPT_DIR_BEFORE="./drupal_ti/before"
- DRUPAL_TI_SCRIPT_DIR_AFTER="./drupal_ti/after"

you can define your own scripts from your base directory, and drupal_ti will call them before and after your main scripts.

This is useful to change default environment variables, e.g. environments/drupal-7.sh defines

export DRUPAL_TI_DRUSH_VERSION="drush/drush:6.*"

but you might want a different version and also override the drupal_ti_install_drupal function (as core-quick-drupal command needs drush 6).

Theoretically you can even define multiple by just seperating them with a space or installed via composer - the possibilities are endless :).

Example:

- DRUPAL_TI_SCRIPT_DIR_BEFORE="./drupal_ti/before ./vendor/lionsad/drupal_ti_base_cool/drupal_ti/before"
- DRUPAL_TI_SCRIPT_DIR_AFTER="./drupal_ti/after  ./vendor/lionsad/drupal_ti_base_cool/drupal_ti/after"

Adding module dependencies from Github repositories

Your module may have several dependencies that are not hosted on Drupal.org. These modules can be added using a custom script and including them in the .travis.yml file.

In .travis.yml you will have a section before_script. The default command here installs drupal and the module we are testing. We can add a command drupal-ti --include [script]. This command will load the script first and then run the default drupal-ti before_script command.

.travis.yml

before_script:
  # We run our script to add module dependencies
  # This uses git clone over HTTPS because the modules don't currently
  # exist on drupal.org.
  - drupal-ti --include drupal_ti/before/before_script.sh
  - drupal-ti before_script

The script path is relative to our /tests directory since we moved to that default directory during the before_install process.

We can now create our custom script as follows,

/tests/drupal_ti/before/before_script.sh

#!/bin/bash

# Add an optional statement to see that this is running in Travis CI.
echo "running drupal_ti/before/before_script.sh"

set -e $DRUPAL_TI_DEBUG

# Ensure the right Drupal version is installed.
# The first time this is run, it will install Drupal.
# Note: This function is re-entrant.
drupal_ti_ensure_drupal

# Change to the Drupal directory
cd "$DRUPAL_TI_DRUPAL_DIR"

# Create the the module directory (only necessary for D7)
# For D7, this is sites/default/modules
# For D8, this is modules
mkdir -p "$DRUPAL_TI_DRUPAL_DIR/$DRUPAL_TI_MODULES_PATH"
cd "$DRUPAL_TI_DRUPAL_DIR/$DRUPAL_TI_MODULES_PATH"

# Manually clone the dependencies
git clone --depth 1 https://github.com/my-project/my-dependency.git
# or with a different branch
git clone --depth 1 --branch 8.x-1.x https://github.com/my-project/my-dependency.git

The directory /tests/drupal_ti/before/ can also be used to add auto-discovered scripts using a more complex pattern /tests/before/runners/[runner]/[command].sh. This will, however be limited to a specific runner, while the above include pattern will run for all runners.

Script with Composer Manager

Composer manager is a popular dependency and one that requires extra work in order to be set up.

#!/bin/bash

# Add an optional statement to see that this is running in Travis CI.
echo "running drupal_ti/before/before_script.sh"

set -e $DRUPAL_TI_DEBUG

# Ensure the right Drupal version is installed.
# The first time this is run, it will install Drupal.
# Note: This function is re-entrant.
drupal_ti_ensure_drupal

# Change to the Drupal directory
cd "$DRUPAL_TI_DRUPAL_DIR"

# Create the the module directory (only necessary for D7)
# For D7, this is sites/default/modules
# For D8, this is modules
mkdir -p "$DRUPAL_TI_DRUPAL_DIR/$DRUPAL_TI_MODULES_PATH"
cd "$DRUPAL_TI_DRUPAL_DIR/$DRUPAL_TI_MODULES_PATH"

# Manually clone the dependencies
git clone --depth 1 --branch 8.x-1.x http://git.drupal.org/project/composer_manager.git

# Initialize composer manage
php "$DRUPAL_TI_DRUPAL_DIR/$DRUPAL_TI_MODULES_PATH/composer_manager/scripts/init.php"

# Ensure the module is linked into the code base and enabled.
# Note: This function is re-entrant.
drupal_ti_ensure_module_linked

# Update composer
cd "$DRUPAL_TI_DRUPAL_DIR"
composer drupal-rebuild
composer install --prefer-source

Contributions

Contributions are welcome.

Drush

For your convenience the 'drush site-set' command is set for the Drupal installation, so any Drush commands triggered in your own scripts will be run against the test Drupal instance.