From e386c6a1534f1184bbf9480e67294eb910a1fa5c Mon Sep 17 00:00:00 2001
From: Damian Mooyman <damian@silverstripe.com>
Date: Fri, 28 Oct 2016 10:53:11 +1300
Subject: [PATCH] FIX: Refactor bootstrap.php to allow for code sharing with
 cms bootstrap

---
 .travis.yml                       |   3 +-
 tests/behat/serve-bootstrap.php   |  48 +-----------
 tests/bootstrap.php               | 125 ++----------------------------
 tests/bootstrap/_manifest_exclude |   0
 tests/bootstrap/cli.php           |  33 ++++++++
 tests/bootstrap/environment.php   |  34 ++++++++
 tests/bootstrap/init.php          |  21 +++++
 tests/bootstrap/mysite.php        |  10 +++
 tests/bootstrap/phpunit.php       |  29 +++++++
 9 files changed, 137 insertions(+), 166 deletions(-)
 create mode 100644 tests/bootstrap/_manifest_exclude
 create mode 100644 tests/bootstrap/cli.php
 create mode 100644 tests/bootstrap/environment.php
 create mode 100644 tests/bootstrap/init.php
 create mode 100644 tests/bootstrap/mysite.php
 create mode 100644 tests/bootstrap/phpunit.php

diff --git a/.travis.yml b/.travis.yml
index a1dcb461f..5d0be1997 100644
--- a/.travis.yml
+++ b/.travis.yml
@@ -54,7 +54,8 @@ before_script:
  - "if [ \"$NPM_TEST\" = \"1\" ]; then nvm install $TRAVIS_NODE_VERSION && npm install; fi"
  - "if [ \"$BEHAT_TEST\" = \"1\" ]; then sh -e /etc/init.d/xvfb start; sleep 3; fi"
  - "if [ \"$BEHAT_TEST\" = \"1\" ]; then (vendor/bin/selenium-server-standalone > selenium.log 2>&1 &); fi"
- - "if [ \"$BEHAT_TEST\" = \"1\" ]; then (vendor/bin/serve --bootstrap-file tests/behat/serve-bootstrap.php &> serve.log &); fi"
+ - "if [ \"$BEHAT_TEST\" = \"1\" ] && [ \"$CMS_TEST\" = \"\" ]; then (vendor/bin/serve --bootstrap-file tests/behat/serve-bootstrap.php &> serve.log &); fi"
+ - "if [ \"$BEHAT_TEST\" = \"1\" ] && [ \"$CMS_TEST\" = \"1\" ]; then (vendor/bin/serve --bootstrap-file cms/tests/behat/serve-bootstrap.php &> serve.log &); fi"
 script:
  - "if [ \"$PHPUNIT_TEST\" = \"1\" ] && [ \"$CMS_TEST\" = \"\" ]; then vendor/bin/phpunit; fi"
  - "if [ \"$PHPUNIT_TEST\" = \"1\" ] && [ \"$CMS_TEST\" = \"1\" ]; then vendor/bin/phpunit cms/tests; fi"
diff --git a/tests/behat/serve-bootstrap.php b/tests/behat/serve-bootstrap.php
index 700c813f3..e392dfd9e 100644
--- a/tests/behat/serve-bootstrap.php
+++ b/tests/behat/serve-bootstrap.php
@@ -1,47 +1,5 @@
 <?php
 
-// Asset folder
-if(!file_exists(BASE_PATH . '/assets')) {
-	mkdir(BASE_PATH . '/assets', 02775);
-}
-
-// DATABASE BOOTSTRAP
-if (!defined('SS_ENVIRONMENT_TYPE')) {
-	define('SS_ENVIRONMENT_TYPE', 'dev');
-}
-
-if (!defined('SS_DATABASE_CLASS') && !defined('SS_DATABASE_USERNAME')) {
-	// The default settings let us define the database config via environment vars
-	// Database connection, including PDO and legacy ORM support
-	switch(getenv('DB')) {
-	case "PGSQL";
-		define('SS_DATABASE_CLASS', getenv('PDO') ? 'PostgrePDODatabase' : 'PostgreSQLDatabase');
-		define('SS_DATABASE_USERNAME', 'postgres');
-		define('SS_DATABASE_PASSWORD', '');
-		break;
-
-	case "SQLITE":
-		define('SS_DATABASE_CLASS', getenv('PDO') ? 'SQLite3PDODatabase' : 'SQLite3Database');
-		define('SS_DATABASE_USERNAME', 'root');
-		define('SS_DATABASE_PASSWORD', '');
-		define('SS_SQLITE_DATABASE_PATH', ':memory:');
-		break;
-
-	default:
-		define('SS_DATABASE_CLASS', getenv('PDO') ? 'MySQLPDODatabase' : 'MySQLDatabase');
-		define('SS_DATABASE_USERNAME', 'root');
-		define('SS_DATABASE_PASSWORD', '');
-	}
-
-	define('SS_DATABASE_SERVER', '127.0.0.1');
-	define('SS_DATABASE_CHOOSE_NAME', true);
-}
-
-// Default database settings
-global $database;
-$database = '';
-
-require_once(__DIR__ . '/../../conf/ConfigureFromEnv.php');
-
-class Page extends SilverStripe\View\ViewableData {}
-class Page_Controller extends SilverStripe\Control\Controller {}
+require __DIR__ . '/../bootstrap/init.php';
+require __DIR__ . '/../bootstrap/environment.php';
+require __DIR__ . '/../bootstrap/mysite.php';
diff --git a/tests/bootstrap.php b/tests/bootstrap.php
index 2bf3ee722..e6135d83a 100644
--- a/tests/bootstrap.php
+++ b/tests/bootstrap.php
@@ -1,122 +1,7 @@
 <?php
 
-use SilverStripe\ORM\DB;
-use SilverStripe\Dev\SapphireTest;
-
-if(!defined('BASE_PATH')) {
-	echo "BASE_PATH hasn't been defined. This probably means that framework/Core/Constants.php hasn't been " .
-		"included by Composer's autoloader.\n" .
-		"Make sure the you are running your tests via vendor/bin/phpunit and your autoloader is up to date.\n";
-	exit(1);
-}
-
-
-/**
- * This bootstraps the SilverStripe system so that phpunit can be run directly on SilverStripe tests.
- */
-
-// Make sure display_errors is on
-ini_set('display_errors', 1);
-
-// Fake the script name and base
-global $_SERVER;
-if (!$_SERVER) $_SERVER = array();
-
-$frameworkPath = dirname(dirname(__FILE__));
-$frameworkDir = basename($frameworkPath);
-
-$_SERVER['SCRIPT_FILENAME'] = $frameworkPath . DIRECTORY_SEPARATOR . 'cli-script.php';
-$_SERVER['SCRIPT_NAME'] = '.' . DIRECTORY_SEPARATOR . $frameworkDir . DIRECTORY_SEPARATOR . 'cli-script.php';
-
-// Copied from cli-script.php, to enable same behaviour through phpunit runner.
-if(isset($_SERVER['argv'][2])) {
-	$args = array_slice($_SERVER['argv'],2);
-	if(!isset($_GET)) $_GET = array();
-	if(!isset($_REQUEST)) $_REQUEST = array();
-	foreach($args as $arg) {
-		if(strpos($arg,'=') == false) {
-			$_GET['args'][] = $arg;
-		} else {
-			$newItems = array();
-			parse_str( (substr($arg,0,2) == '--') ? substr($arg,2) : $arg, $newItems );
-			$_GET = array_merge($_GET, $newItems);
-		}
-	}
-	$_REQUEST = array_merge($_REQUEST, $_GET);
-}
-
-// DATABASE BOOTSTRAP
-
-if (!defined('SS_ENVIRONMENT_TYPE')) {
-	define('SS_ENVIRONMENT_TYPE', 'dev');
-}
-
-if (!defined('SS_DATABASE_CLASS') && !defined('SS_DATABASE_USERNAME')) {
-	// The default settings let us define the database config via environment vars
-	// Database connection, including PDO and legacy ORM support
-	switch(getenv('DB')) {
-	case "PGSQL";
-		define('SS_DATABASE_CLASS', getenv('PDO') ? 'PostgrePDODatabase' : 'PostgreSQLDatabase');
-		define('SS_DATABASE_USERNAME', 'postgres');
-		define('SS_DATABASE_PASSWORD', '');
-		break;
-
-	case "SQLITE":
-		define('SS_DATABASE_CLASS', getenv('PDO') ? 'SQLite3PDODatabase' : 'SQLite3Database');
-		define('SS_DATABASE_USERNAME', 'root');
-		define('SS_DATABASE_PASSWORD', '');
-		define('SS_SQLITE_DATABASE_PATH', ':memory:');
-		break;
-
-	default:
-		define('SS_DATABASE_CLASS', getenv('PDO') ? 'MySQLPDODatabase' : 'MySQLDatabase');
-		define('SS_DATABASE_USERNAME', 'root');
-		define('SS_DATABASE_PASSWORD', '');
-	}
-
-	define('SS_DATABASE_SERVER', '127.0.0.1');
-	define('SS_DATABASE_CHOOSE_NAME', true);
-}
-
-// Ensure Director::protocolAndHost() works
-if (empty($_SERVER['HTTP_HOST'])) {
-	$_SERVER['HTTP_HOST'] = 'localhost';
-}
-
-// Asset folder
-if(!file_exists(BASE_PATH . '/assets')) {
-	mkdir(BASE_PATH . '/assets', 02775);
-}
-
-// Default database settings
-global $project;
-$project = 'mysite';
-
-global $database;
-$database = '';
-
-require_once(__DIR__ . '/../conf/ConfigureFromEnv.php');
-
-// Connect to database
-require_once $frameworkPath . '/Core/Core.php';
-require_once $frameworkPath . '/tests/FakeController.php';
-
-global $databaseConfig;
-DB::connect($databaseConfig);
-
-// Now set a fake REQUEST_URI
-$_SERVER['REQUEST_URI'] = BASE_URL;
-
-// Fake a session
-$_SESSION = null;
-
-// Prepare manifest autoloader
-$controller = new FakeController();
-
-SapphireTest::use_test_manifest();
-
-SapphireTest::set_is_running_test(true);
-
-// Remove the error handler so that PHPUnit can add its own
-restore_error_handler();
-
+require __DIR__ . '/bootstrap/init.php';
+require __DIR__ . '/bootstrap/cli.php';
+require __DIR__ . '/bootstrap/environment.php';
+require __DIR__ . '/bootstrap/mysite.php';
+require __DIR__ . '/bootstrap/phpunit.php';
diff --git a/tests/bootstrap/_manifest_exclude b/tests/bootstrap/_manifest_exclude
new file mode 100644
index 000000000..e69de29bb
diff --git a/tests/bootstrap/cli.php b/tests/bootstrap/cli.php
new file mode 100644
index 000000000..711627e4d
--- /dev/null
+++ b/tests/bootstrap/cli.php
@@ -0,0 +1,33 @@
+<?php
+
+// Fake the script name and base
+global $_SERVER;
+if (!$_SERVER) $_SERVER = array();
+
+$frameworkPath = dirname(dirname(__FILE__));
+$frameworkDir = basename($frameworkPath);
+
+$_SERVER['SCRIPT_FILENAME'] = $frameworkPath . DIRECTORY_SEPARATOR . 'cli-script.php';
+$_SERVER['SCRIPT_NAME'] = '.' . DIRECTORY_SEPARATOR . $frameworkDir . DIRECTORY_SEPARATOR . 'cli-script.php';
+
+// Copied from cli-script.php, to enable same behaviour through phpunit runner.
+if(isset($_SERVER['argv'][2])) {
+	$args = array_slice($_SERVER['argv'],2);
+	if(!isset($_GET)) $_GET = array();
+	if(!isset($_REQUEST)) $_REQUEST = array();
+	foreach($args as $arg) {
+		if(strpos($arg,'=') == false) {
+			$_GET['args'][] = $arg;
+		} else {
+			$newItems = array();
+			parse_str( (substr($arg,0,2) == '--') ? substr($arg,2) : $arg, $newItems );
+			$_GET = array_merge($_GET, $newItems);
+		}
+	}
+	$_REQUEST = array_merge($_REQUEST, $_GET);
+}
+
+// Ensure Director::protocolAndHost() works
+if (empty($_SERVER['HTTP_HOST'])) {
+	$_SERVER['HTTP_HOST'] = 'localhost';
+}
diff --git a/tests/bootstrap/environment.php b/tests/bootstrap/environment.php
new file mode 100644
index 000000000..7794f2a15
--- /dev/null
+++ b/tests/bootstrap/environment.php
@@ -0,0 +1,34 @@
+<?php
+
+// Bootstrap _ss_environment.php
+
+if (!defined('SS_ENVIRONMENT_TYPE')) {
+	define('SS_ENVIRONMENT_TYPE', 'dev');
+}
+
+if (!defined('SS_DATABASE_CLASS') && !defined('SS_DATABASE_USERNAME')) {
+	// The default settings let us define the database config via environment vars
+	// Database connection, including PDO and legacy ORM support
+	switch(getenv('DB')) {
+	case "PGSQL";
+		define('SS_DATABASE_CLASS', getenv('PDO') ? 'PostgrePDODatabase' : 'PostgreSQLDatabase');
+		define('SS_DATABASE_USERNAME', 'postgres');
+		define('SS_DATABASE_PASSWORD', '');
+		break;
+
+	case "SQLITE":
+		define('SS_DATABASE_CLASS', getenv('PDO') ? 'SQLite3PDODatabase' : 'SQLite3Database');
+		define('SS_DATABASE_USERNAME', 'root');
+		define('SS_DATABASE_PASSWORD', '');
+		define('SS_SQLITE_DATABASE_PATH', ':memory:');
+		break;
+
+	default:
+		define('SS_DATABASE_CLASS', getenv('PDO') ? 'MySQLPDODatabase' : 'MySQLDatabase');
+		define('SS_DATABASE_USERNAME', 'root');
+		define('SS_DATABASE_PASSWORD', '');
+	}
+
+	define('SS_DATABASE_SERVER', '127.0.0.1');
+	define('SS_DATABASE_CHOOSE_NAME', true);
+}
diff --git a/tests/bootstrap/init.php b/tests/bootstrap/init.php
new file mode 100644
index 000000000..be75f5a90
--- /dev/null
+++ b/tests/bootstrap/init.php
@@ -0,0 +1,21 @@
+<?php
+
+if(!defined('BASE_PATH')) {
+	echo "BASE_PATH hasn't been defined. This probably means that framework/Core/Constants.php hasn't been " .
+		"included by Composer's autoloader.\n" .
+		"Make sure the you are running your tests via vendor/bin/phpunit and your autoloader is up to date.\n";
+	exit(1);
+}
+
+
+/**
+ * This bootstraps the SilverStripe system so that phpunit can be run directly on SilverStripe tests.
+ */
+
+// Make sure display_errors is on
+ini_set('display_errors', 1);
+
+// Asset folder
+if(!file_exists(BASE_PATH . '/assets')) {
+	mkdir(BASE_PATH . '/assets', 02775);
+}
diff --git a/tests/bootstrap/mysite.php b/tests/bootstrap/mysite.php
new file mode 100644
index 000000000..d1b3092a4
--- /dev/null
+++ b/tests/bootstrap/mysite.php
@@ -0,0 +1,10 @@
+<?php
+
+// Default database settings
+global $project;
+$project = 'mysite';
+
+global $database;
+$database = '';
+
+require_once(__DIR__ . '/../../conf/ConfigureFromEnv.php');
diff --git a/tests/bootstrap/phpunit.php b/tests/bootstrap/phpunit.php
new file mode 100644
index 000000000..588eef4f0
--- /dev/null
+++ b/tests/bootstrap/phpunit.php
@@ -0,0 +1,29 @@
+<?php
+
+// Bootstrap for running SapphireTests
+
+// Connect to database
+use SilverStripe\Dev\SapphireTest;
+use SilverStripe\ORM\DB;
+
+require_once __DIR__ . '/../../Core/Core.php';
+require_once __DIR__ . '/../FakeController.php';
+
+global $databaseConfig;
+DB::connect($databaseConfig);
+
+// Now set a fake REQUEST_URI
+$_SERVER['REQUEST_URI'] = BASE_URL;
+
+// Fake a session
+$_SESSION = null;
+
+// Prepare manifest autoloader
+$controller = new FakeController();
+
+SapphireTest::use_test_manifest();
+
+SapphireTest::set_is_running_test(true);
+
+// Remove the error handler so that PHPUnit can add its own
+restore_error_handler();