travis_setup.php

#!/usr/bin/env php
<?php
/**
 * Initialises a test project that can be built by travis.
 *
 * Travis downloads the module, but in order to run unit tests it needs
 * to be part of a SilverStripe "installer" project.
 * This script generates a custom composer.json with the required dependencies
 * and installs it into a separate webroot. The originally downloaded module
 * code is re-installed via composer.
 */
if (php_sapi_name() != 'cli') {
	header('HTTP/1.0 404 Not Found');
	exit;
}

require_once 'lib.php';

$defaults = array(
	// Readonly token for 'silverstripe-issues' user to increase our rate limitation.
	// Please be fair and define your own token if using for own projects.
	'GITHUB_API_TOKEN' => '2434108664388ca0199319b98a6068af8e5dc547'
);

$opts = getopt('', array(
	'source:', // required
	'target:', // required
	'config:',
	'require:'
));

// Sanity checks
if (!$opts) {
	echo "Invalid arguments specified\n";
	exit(1);
}
$requiredEnvs = array('TRAVIS_COMMIT', 'TRAVIS_BRANCH', 'CORE_RELEASE');
foreach($requiredEnvs as $requiredEnv) {
	if(!getenv($requiredEnv)) {
		echo(sprintf('Environment variable "%s" not defined', $requiredEnv) . "\n");
		exit(1);
	}
}

$dir = __DIR__;
$configPath = (isset($opts['config'])) ? $opts['config'] : null;
$targetPath = $opts['target'];
$modulePath = $opts['source'];
$moduleName = basename($modulePath);
$parent = dirname($modulePath);

// Get exact version of downloaded module so we can re-download via composer
$moduleRevision = getenv('TRAVIS_COMMIT');
$moduleBranch = getenv('TRAVIS_BRANCH');
if(preg_match('/^\d\.\d$/', $moduleBranch)) {
	// release branch
	$moduleBranchComposer = $moduleBranch . '.x-dev';
} else if(preg_match('/^\d\.\d\.\d$/', $moduleBranch)) {
	// tag
	$moduleBranchComposer = $moduleBranch;
} else {
	// pull request or "master"
	$moduleBranchComposer = 'dev-' . $moduleBranch;
}

// Identify core branch from environment data
$coreBranch = getenv('CORE_RELEASE');
if(preg_match('/^\d\.\d$/', $coreBranch)) {
	// release branch
	$coreBranchComposer = $coreBranch . '.x-dev';
} else if(preg_match('/^\d\.\d\.\d$/', $coreBranch)) {
	// tag
	$coreBranchComposer = $coreBranch;
} else {
	// pull request or "master"
	$coreBranchComposer = 'dev-' . $coreBranch;
}

// Respect branch alias in core
$frameworkPackageInfo = json_decode(file_get_contents('https://packagist.org/packages/silverstripe/framework.json'), true);
if(isset($frameworkPackageInfo['package']['versions'][$coreBranchComposer]['extra']['branch-alias'][$coreBranchComposer])) {
	$coreBranchComposer = $frameworkPackageInfo['package']['versions'][$coreBranchComposer]['extra']['branch-alias'][$coreBranchComposer];
	// Leave $coreBranch at original value, since it doesn't resolve as a git branch
	// $coreBranch = preg_replace('/\.x-dev$/', '', $coreBranchComposer);
}

// Print out some environment information.
printf("Environment:\n");
printf("  * MySQL:      %s\n", trim(`mysql --version`));

// Set up Github API token for higher rate limits (optional)
// See http://blog.simplytestable.com/creating-and-using-a-github-oauth-token-with-travis-and-composer/
if(!getenv('GITHUB_API_TOKEN')) putenv('GITHUB_API_TOKEN=' . $defaults['GITHUB_API_TOKEN']);
if(
	getenv('GITHUB_API_TOKEN') 
	// Defaults to unencrypted tokens, so we don't need to exclude pull requests
	// && (!getenv('TRAVIS_PULL_REQUEST') || getenv('TRAVIS_PULL_REQUEST') == 'false')
) {
	$composerGlobalConf = array('config' => array('github-oauth' => array('github.com' => getenv('GITHUB_API_TOKEN'))));
	$composerConfDir = getenv("HOME") . '/.composer/';
	if(!file_exists($composerConfDir)) mkdir($composerConfDir);
	file_put_contents($composerConfDir . '/config.json', json_encode($composerGlobalConf));
	echo "Using GITHUB_API_TOKEN...\n";
}

// Extract the package info from the module composer file, and build a
// custom project composer file with the local package explicitly defined.
echo "Reading composer information...\n";
if(!file_exists("$modulePath/composer.json")) {
	echo("File not found: $modulePath/composer.json");
	exit(1);
}
$package = json_decode(file_get_contents("$modulePath/composer.json"), true);

// Override the default framework requirement with the one being built.
$package = array_replace_recursive($package, array(
	'version' => $moduleBranchComposer,
	'dist' => array(
		'type' => 'tar',
		'url' => "file://$parent/$moduleName.tar"
	)
));

// Generate a custom composer file.
$composer = array(
	'repositories' => array(array('type' => 'package', 'package' => $package)),
	'require' => array_merge(
		isset($package['require']) ? $package['require'] : array(),
		array($package['name'] => $moduleBranchComposer)
	),
	'minimum-stability' => 'dev',
	'config' => array(
		'notify-on-install' => false,
		'process-timeout' => 600, // double default timeout, github archive downloads tend to be slow
	)
);

// Add a custom requirement
if(!empty($opts['require'])) $composer['require'][$opts['require']] = "*";

// Temporary workaround for removed framework dependency in 2.4 cms module
// See https://github.com/silverstripe/silverstripe-cms/commit/2713c462a26494624169e0115323e5cdd5a07d50
if(
	version_compare($coreBranch, '3.0') == -1
	&& $package['name'] == 'silverstripe/framework'
) {
	$composer['require'][$package['name']] .= ' as ' . $coreBranchComposer;
}


// Add theme based on version. Important for Behat testing.
// TODO Determine dependency based on actual composer.json in silverstripe-installer
if($coreBranch == 'master' || version_compare($coreBranch, '3.0') >= 0) {
	$composer['require']['silverstripe-themes/simple'] = '*';
} else {
	$composer['require']['silverstripe-themes/blackcandy'] = '*';
}

$composerStr = json_encode($composer);

echo "Generated composer file:\n";
echo "$composerStr\n\n";

run("cd $modulePath");

run("tar -cf $parent/$moduleName.tar .");

run("git clone --depth=100 --quiet -b $coreBranch git://github.com/silverstripe/silverstripe-installer.git $targetPath");

run("cp $dir/_ss_environment.php $targetPath/_ss_environment.php");
if($configPath) run("cp $configPath $targetPath/mysite/_config.php");

run("rm $targetPath/composer.json");
echo "Writing new composer.json to $targetPath/composer.json\n";
file_put_contents("$targetPath/composer.json", $composerStr);

if(file_exists("$targetPath/composer.lock")) {
	run("rm $targetPath/composer.lock");
}

run("composer install --prefer-dist --dev -d $targetPath");

// Installer doesn't work out of the box without cms - delete the Page class if its not required
if(
	!file_exists("$targetPath/cms") 
	&& file_exists("$targetPath/mysite/code/Page.php")
	&& ($coreBranch == 'master' || version_compare($coreBranch, '3.0') >= 0)
) {
	echo "Removing Page.php (building without 'silverstripe/cms')...\n";
	run("rm $targetPath/mysite/code/Page.php");
}