mirror of
https://github.com/silverstripe/silverstripe-framework
synced 2024-10-22 14:05:37 +02:00
1014 lines
31 KiB
PHP
1014 lines
31 KiB
PHP
<?php
|
|
require_once 'TestRunner.php';
|
|
|
|
/**
|
|
* Test case class for the Sapphire framework.
|
|
* Sapphire unit testing is based on PHPUnit, but provides a number of hooks into our data model that make it easier
|
|
* to work with.
|
|
*
|
|
* @package framework
|
|
* @subpackage testing
|
|
*/
|
|
class SapphireTest extends PHPUnit_Framework_TestCase {
|
|
|
|
/** @config */
|
|
private static $dependencies = array(
|
|
'fixtureFactory' => '%$FixtureFactory',
|
|
);
|
|
|
|
/**
|
|
* Path to fixture data for this test run.
|
|
* If passed as an array, multiple fixture files will be loaded.
|
|
* Please note that you won't be able to refer with "=>" notation
|
|
* between the fixtures, they act independent of each other.
|
|
*
|
|
* @var string|array
|
|
*/
|
|
protected static $fixture_file = null;
|
|
|
|
/**
|
|
* @var FixtureFactory
|
|
*/
|
|
protected $fixtureFactory;
|
|
|
|
/**
|
|
* @var bool Set whether to include this test in the TestRunner or to skip this.
|
|
*/
|
|
protected $skipTest = false;
|
|
|
|
/**
|
|
* @var Boolean If set to TRUE, this will force a test database to be generated
|
|
* in {@link setUp()}. Note that this flag is overruled by the presence of a
|
|
* {@link $fixture_file}, which always forces a database build.
|
|
*/
|
|
protected $usesDatabase = null;
|
|
|
|
/**
|
|
* @deprecated since version 4.0
|
|
*/
|
|
protected $originalMailer;
|
|
|
|
protected $originalMemberPasswordValidator;
|
|
protected $originalRequirements;
|
|
protected $originalIsRunningTest;
|
|
protected $originalTheme;
|
|
protected $originalNestedURLsState;
|
|
protected $originalMemoryLimit;
|
|
|
|
protected $mailer;
|
|
|
|
/**
|
|
* Pointer to the manifest that isn't a test manifest
|
|
*/
|
|
protected static $regular_manifest;
|
|
|
|
/**
|
|
* @var boolean
|
|
*/
|
|
protected static $is_running_test = false;
|
|
|
|
protected static $test_class_manifest;
|
|
|
|
/**
|
|
* By default, setUp() does not require default records. Pass
|
|
* class names in here, and the require/augment default records
|
|
* function will be called on them.
|
|
*/
|
|
protected $requireDefaultRecordsFrom = array();
|
|
|
|
|
|
/**
|
|
* A list of extensions that can't be applied during the execution of this run. If they are
|
|
* applied, they will be temporarily removed and a database migration called.
|
|
*
|
|
* The keys of the are the classes that the extensions can't be applied the extensions to, and
|
|
* the values are an array of illegal extensions on that class.
|
|
*/
|
|
protected $illegalExtensions = array(
|
|
);
|
|
|
|
/**
|
|
* A list of extensions that must be applied during the execution of this run. If they are
|
|
* not applied, they will be temporarily added and a database migration called.
|
|
*
|
|
* The keys of the are the classes to apply the extensions to, and the values are an array
|
|
* of required extensions on that class.
|
|
*
|
|
* Example:
|
|
* <code>
|
|
* array("MyTreeDataObject" => array("Versioned", "Hierarchy"))
|
|
* </code>
|
|
*/
|
|
protected $requiredExtensions = array(
|
|
);
|
|
|
|
/**
|
|
* By default, the test database won't contain any DataObjects that have the interface TestOnly.
|
|
* This variable lets you define additional TestOnly DataObjects to set up for this test.
|
|
* Set it to an array of DataObject subclass names.
|
|
*/
|
|
protected $extraDataObjects = array();
|
|
|
|
/**
|
|
* We need to disabling backing up of globals to avoid overriding
|
|
* the few globals SilverStripe relies on, like $lang for the i18n subsystem.
|
|
*
|
|
* @see http://sebastian-bergmann.de/archives/797-Global-Variables-and-PHPUnit.html
|
|
*/
|
|
protected $backupGlobals = FALSE;
|
|
|
|
/**
|
|
* Helper arrays for illegalExtensions/requiredExtensions code
|
|
*/
|
|
private $extensionsToReapply = array(), $extensionsToRemove = array();
|
|
|
|
|
|
/**
|
|
* Determines if unit tests are currently run (via {@link TestRunner}).
|
|
* This is used as a cheap replacement for fully mockable state
|
|
* in certain contiditions (e.g. access checks).
|
|
* Caution: When set to FALSE, certain controllers might bypass
|
|
* access checks, so this is a very security sensitive setting.
|
|
*
|
|
* @return boolean
|
|
*/
|
|
public static function is_running_test() {
|
|
return self::$is_running_test;
|
|
}
|
|
|
|
public static function set_is_running_test($bool) {
|
|
self::$is_running_test = $bool;
|
|
}
|
|
|
|
/**
|
|
* Set the manifest to be used to look up test classes by helper functions
|
|
*/
|
|
public static function set_test_class_manifest($manifest) {
|
|
self::$test_class_manifest = $manifest;
|
|
}
|
|
|
|
/**
|
|
* Return the manifest being used to look up test classes by helper functions
|
|
*/
|
|
public static function get_test_class_manifest() {
|
|
return self::$test_class_manifest;
|
|
}
|
|
|
|
/**
|
|
* @return String
|
|
*/
|
|
public static function get_fixture_file() {
|
|
return static::$fixture_file;
|
|
}
|
|
|
|
/**
|
|
* @var array $fixtures Array of {@link YamlFixture} instances
|
|
* @deprecated 3.1 Use $fixtureFactory instad
|
|
*/
|
|
protected $fixtures = array();
|
|
|
|
protected $model;
|
|
|
|
public function setUp() {
|
|
|
|
if (!defined('FRAMEWORK_PATH')) {
|
|
trigger_error(
|
|
'Missing constants, did you remember to include the test bootstrap in your phpunit.xml file?',
|
|
E_USER_WARNING
|
|
);
|
|
}
|
|
|
|
//nest config and injector for each test so they are effectively sandboxed per test
|
|
Config::nest();
|
|
Injector::nest();
|
|
|
|
// We cannot run the tests on this abstract class.
|
|
if(get_class($this) == "SapphireTest") $this->skipTest = true;
|
|
|
|
if($this->skipTest) {
|
|
$this->markTestSkipped(sprintf(
|
|
'Skipping %s ', get_class($this)
|
|
));
|
|
|
|
return;
|
|
}
|
|
|
|
// Mark test as being run
|
|
$this->originalIsRunningTest = self::$is_running_test;
|
|
self::$is_running_test = true;
|
|
|
|
// i18n needs to be set to the defaults or tests fail
|
|
i18n::set_locale(i18n::default_locale());
|
|
|
|
// Set default timezone consistently to avoid NZ-specific dependencies
|
|
date_default_timezone_set('UTC');
|
|
|
|
// Remove password validation
|
|
$this->originalMemberPasswordValidator = Member::password_validator();
|
|
$this->originalRequirements = Requirements::backend();
|
|
Member::set_password_validator(null);
|
|
Config::inst()->update('Cookie', 'report_errors', false);
|
|
|
|
if(class_exists('RootURLController')) RootURLController::reset();
|
|
if(class_exists('Translatable')) Translatable::reset();
|
|
Versioned::reset();
|
|
DataObject::reset();
|
|
if(class_exists('SiteTree')) SiteTree::reset();
|
|
Hierarchy::reset();
|
|
if(Controller::has_curr()) Controller::curr()->setSession(Injector::inst()->create('Session', array()));
|
|
Security::$database_is_ready = null;
|
|
|
|
// Add controller-name auto-routing
|
|
Config::inst()->update('Director', 'rules', array(
|
|
'$Controller//$Action/$ID/$OtherID' => '*'
|
|
));
|
|
|
|
$fixtureFile = static::get_fixture_file();
|
|
|
|
$prefix = defined('SS_DATABASE_PREFIX') ? SS_DATABASE_PREFIX : 'ss_';
|
|
|
|
// Todo: this could be a special test model
|
|
$this->model = DataModel::inst();
|
|
|
|
// Set up fixture
|
|
if($fixtureFile || $this->usesDatabase) {
|
|
if (!self::using_temp_db()) {
|
|
self::create_temp_db();
|
|
}
|
|
|
|
singleton('DataObject')->flushCache();
|
|
|
|
self::empty_temp_db();
|
|
|
|
foreach($this->requireDefaultRecordsFrom as $className) {
|
|
$instance = singleton($className);
|
|
if (method_exists($instance, 'requireDefaultRecords')) $instance->requireDefaultRecords();
|
|
if (method_exists($instance, 'augmentDefaultRecords')) $instance->augmentDefaultRecords();
|
|
}
|
|
|
|
if($fixtureFile) {
|
|
$pathForClass = $this->getCurrentAbsolutePath();
|
|
$fixtureFiles = (is_array($fixtureFile)) ? $fixtureFile : array($fixtureFile);
|
|
|
|
$i = 0;
|
|
foreach($fixtureFiles as $fixtureFilePath) {
|
|
// Support fixture paths relative to the test class, rather than relative to webroot
|
|
// String checking is faster than file_exists() calls.
|
|
$isRelativeToFile = (strpos('/', $fixtureFilePath) === false
|
|
|| preg_match('/^\.\./', $fixtureFilePath));
|
|
|
|
if($isRelativeToFile) {
|
|
$resolvedPath = realpath($pathForClass . '/' . $fixtureFilePath);
|
|
if($resolvedPath) $fixtureFilePath = $resolvedPath;
|
|
}
|
|
|
|
$fixture = Injector::inst()->create('YamlFixture', $fixtureFilePath);
|
|
$fixture->writeInto($this->getFixtureFactory());
|
|
$this->fixtures[] = $fixture;
|
|
|
|
// backwards compatibility: Load first fixture into $this->fixture
|
|
if($i == 0) $this->fixture = $fixture;
|
|
$i++;
|
|
}
|
|
}
|
|
|
|
$this->logInWithPermission("ADMIN");
|
|
}
|
|
|
|
// Preserve memory settings
|
|
$this->originalMemoryLimit = ini_get('memory_limit');
|
|
|
|
// turn off template debugging
|
|
Config::inst()->update('SSViewer', 'source_file_comments', false);
|
|
|
|
// Clear requirements
|
|
Requirements::clear();
|
|
|
|
// Set up email
|
|
$this->originalMailer = Email::mailer();
|
|
$this->mailer = new TestMailer();
|
|
Injector::inst()->registerService($this->mailer, 'Mailer');
|
|
Config::inst()->remove('Email', 'send_all_emails_to');
|
|
}
|
|
|
|
/**
|
|
* Called once per test case ({@link SapphireTest} subclass).
|
|
* This is different to {@link setUp()}, which gets called once
|
|
* per method. Useful to initialize expensive operations which
|
|
* don't change state for any called method inside the test,
|
|
* e.g. dynamically adding an extension. See {@link tearDownOnce()}
|
|
* for tearing down the state again.
|
|
*/
|
|
public function setUpOnce() {
|
|
|
|
//nest config and injector for each suite so they are effectively sandboxed
|
|
Config::nest();
|
|
Injector::nest();
|
|
$isAltered = false;
|
|
|
|
if(!Director::isDev()) {
|
|
user_error('Tests can only run in "dev" mode', E_USER_ERROR);
|
|
}
|
|
|
|
// Remove any illegal extensions that are present
|
|
foreach($this->illegalExtensions as $class => $extensions) {
|
|
foreach($extensions as $extension) {
|
|
if ($class::has_extension($extension)) {
|
|
if(!isset($this->extensionsToReapply[$class])) $this->extensionsToReapply[$class] = array();
|
|
$this->extensionsToReapply[$class][] = $extension;
|
|
$class::remove_extension($extension);
|
|
$isAltered = true;
|
|
}
|
|
}
|
|
}
|
|
|
|
// Add any required extensions that aren't present
|
|
foreach($this->requiredExtensions as $class => $extensions) {
|
|
$this->extensionsToRemove[$class] = array();
|
|
foreach($extensions as $extension) {
|
|
if(!$class::has_extension($extension)) {
|
|
if(!isset($this->extensionsToRemove[$class])) $this->extensionsToReapply[$class] = array();
|
|
$this->extensionsToRemove[$class][] = $extension;
|
|
$class::add_extension($extension);
|
|
$isAltered = true;
|
|
}
|
|
}
|
|
}
|
|
|
|
// If we have made changes to the extensions present, then migrate the database schema.
|
|
if($isAltered || $this->extensionsToReapply || $this->extensionsToRemove || $this->extraDataObjects) {
|
|
if(!self::using_temp_db()) self::create_temp_db();
|
|
$this->resetDBSchema(true);
|
|
}
|
|
// clear singletons, they're caching old extension info
|
|
// which is used in DatabaseAdmin->doBuild()
|
|
Injector::inst()->unregisterAllObjects();
|
|
|
|
// Set default timezone consistently to avoid NZ-specific dependencies
|
|
date_default_timezone_set('UTC');
|
|
}
|
|
|
|
/**
|
|
* tearDown method that's called once per test class rather once per test method.
|
|
*/
|
|
public function tearDownOnce() {
|
|
// If we have made changes to the extensions present, then migrate the database schema.
|
|
if($this->extensionsToReapply || $this->extensionsToRemove) {
|
|
// @todo: This isn't strictly necessary to restore extensions, but only to ensure that
|
|
// Object::$extra_methods is properly flushed. This should be replaced with a simple
|
|
// flush mechanism for each $class.
|
|
//
|
|
// Remove extensions added for testing
|
|
foreach($this->extensionsToRemove as $class => $extensions) {
|
|
foreach($extensions as $extension) {
|
|
$class::remove_extension($extension);
|
|
}
|
|
}
|
|
|
|
// Reapply ones removed
|
|
foreach($this->extensionsToReapply as $class => $extensions) {
|
|
foreach($extensions as $extension) {
|
|
$class::add_extension($extension);
|
|
}
|
|
}
|
|
}
|
|
|
|
//unnest injector / config now that the test suite is over
|
|
// this will reset all the extensions on the object too (see setUpOnce)
|
|
Injector::unnest();
|
|
Config::unnest();
|
|
|
|
if(!empty($this->extensionsToReapply) || !empty($this->extensionsToRemove) || !empty($this->extraDataObjects)) {
|
|
$this->resetDBSchema();
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @return FixtureFactory
|
|
*/
|
|
public function getFixtureFactory() {
|
|
if(!$this->fixtureFactory) $this->fixtureFactory = Injector::inst()->create('FixtureFactory');
|
|
return $this->fixtureFactory;
|
|
}
|
|
|
|
public function setFixtureFactory(FixtureFactory $factory) {
|
|
$this->fixtureFactory = $factory;
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Get the ID of an object from the fixture.
|
|
*
|
|
* @param $className The data class, as specified in your fixture file. Parent classes won't work
|
|
* @param $identifier The identifier string, as provided in your fixture file
|
|
* @return int
|
|
*/
|
|
protected function idFromFixture($className, $identifier) {
|
|
$id = $this->getFixtureFactory()->getId($className, $identifier);
|
|
|
|
if(!$id) {
|
|
user_error(sprintf(
|
|
"Couldn't find object '%s' (class: %s)",
|
|
$identifier,
|
|
$className
|
|
), E_USER_ERROR);
|
|
}
|
|
|
|
return $id;
|
|
}
|
|
|
|
/**
|
|
* Return all of the IDs in the fixture of a particular class name.
|
|
* Will collate all IDs form all fixtures if multiple fixtures are provided.
|
|
*
|
|
* @param string $className
|
|
* @return array A map of fixture-identifier => object-id
|
|
*/
|
|
protected function allFixtureIDs($className) {
|
|
return $this->getFixtureFactory()->getIds($className);
|
|
}
|
|
|
|
/**
|
|
* Get an object from the fixture.
|
|
*
|
|
* @param string $className The data class, as specified in your fixture file. Parent classes won't work
|
|
* @param string $identifier The identifier string, as provided in your fixture file
|
|
*
|
|
* @return DataObject
|
|
*/
|
|
protected function objFromFixture($className, $identifier) {
|
|
$obj = $this->getFixtureFactory()->get($className, $identifier);
|
|
|
|
if(!$obj) {
|
|
user_error(sprintf(
|
|
"Couldn't find object '%s' (class: %s)",
|
|
$identifier,
|
|
$className
|
|
), E_USER_ERROR);
|
|
}
|
|
|
|
return $obj;
|
|
}
|
|
|
|
/**
|
|
* Load a YAML fixture file into the database.
|
|
* Once loaded, you can use idFromFixture() and objFromFixture() to get items from the fixture.
|
|
* Doesn't clear existing fixtures.
|
|
*
|
|
* @param $fixtureFile The location of the .yml fixture file, relative to the site base dir
|
|
*/
|
|
public function loadFixture($fixtureFile) {
|
|
$fixture = Injector::inst()->create('YamlFixture', $fixtureFile);
|
|
$fixture->writeInto($this->getFixtureFactory());
|
|
$this->fixtures[] = $fixture;
|
|
}
|
|
|
|
/**
|
|
* Clear all fixtures which were previously loaded through
|
|
* {@link loadFixture()}
|
|
*/
|
|
public function clearFixtures() {
|
|
$this->fixtures = array();
|
|
$this->getFixtureFactory()->clear();
|
|
}
|
|
|
|
/**
|
|
* Useful for writing unit tests without hardcoding folder structures.
|
|
*
|
|
* @return String Absolute path to current class.
|
|
*/
|
|
protected function getCurrentAbsolutePath() {
|
|
$filename = self::$test_class_manifest->getItemPath(get_class($this));
|
|
if(!$filename) throw new LogicException("getItemPath returned null for " . get_class($this));
|
|
return dirname($filename);
|
|
}
|
|
|
|
/**
|
|
* @return String File path relative to webroot
|
|
*/
|
|
protected function getCurrentRelativePath() {
|
|
$base = Director::baseFolder();
|
|
$path = $this->getCurrentAbsolutePath();
|
|
if(substr($path,0,strlen($base)) == $base) $path = preg_replace('/^\/*/', '', substr($path,strlen($base)));
|
|
return $path;
|
|
}
|
|
|
|
public function tearDown() {
|
|
// Preserve memory settings
|
|
ini_set('memory_limit', ($this->originalMemoryLimit) ? $this->originalMemoryLimit : -1);
|
|
|
|
// Restore email configuration
|
|
$this->originalMailer = null;
|
|
$this->mailer = null;
|
|
|
|
// Restore password validation
|
|
if($this->originalMemberPasswordValidator) {
|
|
Member::set_password_validator($this->originalMemberPasswordValidator);
|
|
}
|
|
|
|
// Restore requirements
|
|
if($this->originalRequirements) {
|
|
Requirements::set_backend($this->originalRequirements);
|
|
}
|
|
|
|
// Mark test as no longer being run - we use originalIsRunningTest to allow for nested SapphireTest calls
|
|
self::$is_running_test = $this->originalIsRunningTest;
|
|
$this->originalIsRunningTest = null;
|
|
|
|
// Reset mocked datetime
|
|
SS_Datetime::clear_mock_now();
|
|
|
|
// Stop the redirection that might have been requested in the test.
|
|
// Note: Ideally a clean Controller should be created for each test.
|
|
// Now all tests executed in a batch share the same controller.
|
|
$controller = Controller::has_curr() ? Controller::curr() : null;
|
|
if ( $controller && $controller->response && $controller->response->getHeader('Location') ) {
|
|
$controller->response->setStatusCode(200);
|
|
$controller->response->removeHeader('Location');
|
|
}
|
|
//unnest injector / config now that tests are over
|
|
Injector::unnest();
|
|
Config::unnest();
|
|
}
|
|
|
|
public static function assertContains(
|
|
$needle,
|
|
$haystack,
|
|
$message = '',
|
|
$ignoreCase = FALSE,
|
|
$checkForObjectIdentity = TRUE,
|
|
$checkForNonObjectIdentity = false
|
|
) {
|
|
if ($haystack instanceof DBField) $haystack = (string)$haystack;
|
|
parent::assertContains($needle, $haystack, $message, $ignoreCase, $checkForObjectIdentity, $checkForNonObjectIdentity);
|
|
}
|
|
|
|
public static function assertNotContains(
|
|
$needle,
|
|
$haystack,
|
|
$message = '',
|
|
$ignoreCase = FALSE,
|
|
$checkForObjectIdentity = TRUE,
|
|
$checkForNonObjectIdentity = false
|
|
) {
|
|
if ($haystack instanceof DBField) $haystack = (string)$haystack;
|
|
parent::assertNotContains($needle, $haystack, $message, $ignoreCase, $checkForObjectIdentity, $checkForNonObjectIdentity);
|
|
}
|
|
|
|
/**
|
|
* Clear the log of emails sent
|
|
*/
|
|
public function clearEmails() {
|
|
return $this->mailer->clearEmails();
|
|
}
|
|
|
|
/**
|
|
* Search for an email that was sent.
|
|
* All of the parameters can either be a string, or, if they start with "/", a PREG-compatible regular expression.
|
|
* @param $to
|
|
* @param $from
|
|
* @param $subject
|
|
* @param $content
|
|
* @return array Contains keys: 'type', 'to', 'from', 'subject','content', 'plainContent', 'attachedFiles',
|
|
* 'customHeaders', 'htmlContent', 'inlineImages'
|
|
*/
|
|
public function findEmail($to, $from = null, $subject = null, $content = null) {
|
|
return $this->mailer->findEmail($to, $from, $subject, $content);
|
|
}
|
|
|
|
/**
|
|
* Assert that the matching email was sent since the last call to clearEmails()
|
|
* All of the parameters can either be a string, or, if they start with "/", a PREG-compatible regular expression.
|
|
* @param $to
|
|
* @param $from
|
|
* @param $subject
|
|
* @param $content
|
|
* @return array Contains the keys: 'type', 'to', 'from', 'subject', 'content', 'plainContent', 'attachedFiles',
|
|
* 'customHeaders', 'htmlContent', inlineImages'
|
|
*/
|
|
public function assertEmailSent($to, $from = null, $subject = null, $content = null) {
|
|
$found = (bool)$this->findEmail($to, $from, $subject, $content);
|
|
|
|
$infoParts = "";
|
|
$withParts = array();
|
|
if($to) $infoParts .= " to '$to'";
|
|
if($from) $infoParts .= " from '$from'";
|
|
if($subject) $withParts[] = "subject '$subject'";
|
|
if($content) $withParts[] = "content '$content'";
|
|
if($withParts) $infoParts .= " with " . implode(" and ", $withParts);
|
|
|
|
$this->assertTrue(
|
|
$found,
|
|
"Failed asserting that an email was sent$infoParts."
|
|
);
|
|
}
|
|
|
|
|
|
/**
|
|
* Assert that the given {@link SS_List} includes DataObjects matching the given key-value
|
|
* pairs. Each match must correspond to 1 distinct record.
|
|
*
|
|
* @param $matches The patterns to match. Each pattern is a map of key-value pairs. You can
|
|
* either pass a single pattern or an array of patterns.
|
|
* @param $dataObjectSet The {@link SS_List} to test.
|
|
*
|
|
* Examples
|
|
* --------
|
|
* Check that $members includes an entry with Email = sam@example.com:
|
|
* $this->assertDOSContains(array('Email' => '...@example.com'), $members);
|
|
*
|
|
* Check that $members includes entries with Email = sam@example.com and with
|
|
* Email = ingo@example.com:
|
|
* $this->assertDOSContains(array(
|
|
* array('Email' => '...@example.com'),
|
|
* array('Email' => 'i...@example.com'),
|
|
* ), $members);
|
|
*/
|
|
public function assertDOSContains($matches, $dataObjectSet) {
|
|
$extracted = array();
|
|
foreach($dataObjectSet as $item) $extracted[] = $item->toMap();
|
|
|
|
foreach($matches as $match) {
|
|
$matched = false;
|
|
foreach($extracted as $i => $item) {
|
|
if($this->dataObjectArrayMatch($item, $match)) {
|
|
// Remove it from $extracted so that we don't get duplicate mapping.
|
|
unset($extracted[$i]);
|
|
$matched = true;
|
|
break;
|
|
}
|
|
}
|
|
|
|
// We couldn't find a match - assertion failed
|
|
$this->assertTrue(
|
|
$matched,
|
|
"Failed asserting that the SS_List contains an item matching "
|
|
. var_export($match, true) . "\n\nIn the following SS_List:\n"
|
|
. $this->DOSSummaryForMatch($dataObjectSet, $match)
|
|
);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Assert that the given {@link SS_List} includes only DataObjects matching the given
|
|
* key-value pairs. Each match must correspond to 1 distinct record.
|
|
*
|
|
* @param $matches The patterns to match. Each pattern is a map of key-value pairs. You can
|
|
* either pass a single pattern or an array of patterns.
|
|
* @param $dataObjectSet The {@link SS_List} to test.
|
|
*
|
|
* Example
|
|
* --------
|
|
* Check that *only* the entries Sam Minnee and Ingo Schommer exist in $members. Order doesn't
|
|
* matter:
|
|
* $this->assertDOSEquals(array(
|
|
* array('FirstName' =>'Sam', 'Surname' => 'Minnee'),
|
|
* array('FirstName' => 'Ingo', 'Surname' => 'Schommer'),
|
|
* ), $members);
|
|
*/
|
|
public function assertDOSEquals($matches, $dataObjectSet) {
|
|
if(!$dataObjectSet) return false;
|
|
|
|
$extracted = array();
|
|
foreach($dataObjectSet as $item) $extracted[] = $item->toMap();
|
|
|
|
foreach($matches as $match) {
|
|
$matched = false;
|
|
foreach($extracted as $i => $item) {
|
|
if($this->dataObjectArrayMatch($item, $match)) {
|
|
// Remove it from $extracted so that we don't get duplicate mapping.
|
|
unset($extracted[$i]);
|
|
$matched = true;
|
|
break;
|
|
}
|
|
}
|
|
|
|
// We couldn't find a match - assertion failed
|
|
$this->assertTrue(
|
|
$matched,
|
|
"Failed asserting that the SS_List contains an item matching "
|
|
. var_export($match, true) . "\n\nIn the following SS_List:\n"
|
|
. $this->DOSSummaryForMatch($dataObjectSet, $match)
|
|
);
|
|
}
|
|
|
|
// If we have leftovers than the DOS has extra data that shouldn't be there
|
|
$this->assertTrue(
|
|
(count($extracted) == 0),
|
|
// If we didn't break by this point then we couldn't find a match
|
|
"Failed asserting that the SS_List contained only the given items, the "
|
|
. "following items were left over:\n" . var_export($extracted, true)
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Assert that the every record in the given {@link SS_List} matches the given key-value
|
|
* pairs.
|
|
*
|
|
* @param $match The pattern to match. The pattern is a map of key-value pairs.
|
|
* @param $dataObjectSet The {@link SS_List} to test.
|
|
*
|
|
* Example
|
|
* --------
|
|
* Check that every entry in $members has a Status of 'Active':
|
|
* $this->assertDOSAllMatch(array('Status' => 'Active'), $members);
|
|
*/
|
|
public function assertDOSAllMatch($match, $dataObjectSet) {
|
|
$extracted = array();
|
|
foreach($dataObjectSet as $item) $extracted[] = $item->toMap();
|
|
|
|
foreach($extracted as $i => $item) {
|
|
$this->assertTrue(
|
|
$this->dataObjectArrayMatch($item, $match),
|
|
"Failed asserting that the the following item matched "
|
|
. var_export($match, true) . ": " . var_export($item, true)
|
|
);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Removes sequences of repeated whitespace characters from SQL queries
|
|
* making them suitable for string comparison
|
|
*
|
|
* @param string $sql
|
|
* @return string The cleaned and normalised SQL string
|
|
*/
|
|
protected function normaliseSQL($sql) {
|
|
return trim(preg_replace('/\s+/m', ' ', $sql));
|
|
}
|
|
|
|
/**
|
|
* Asserts that two SQL queries are equivalent
|
|
*
|
|
* @param string $expectedSQL
|
|
* @param string $actualSQL
|
|
* @param string $message
|
|
* @param float $delta
|
|
* @param integer $maxDepth
|
|
* @param boolean $canonicalize
|
|
* @param boolean $ignoreCase
|
|
*/
|
|
public function assertSQLEquals($expectedSQL, $actualSQL, $message = '', $delta = 0, $maxDepth = 10,
|
|
$canonicalize = false, $ignoreCase = false
|
|
) {
|
|
// Normalise SQL queries to remove patterns of repeating whitespace
|
|
$expectedSQL = $this->normaliseSQL($expectedSQL);
|
|
$actualSQL = $this->normaliseSQL($actualSQL);
|
|
|
|
$this->assertEquals($expectedSQL, $actualSQL, $message, $delta, $maxDepth, $canonicalize, $ignoreCase);
|
|
}
|
|
|
|
/**
|
|
* Asserts that a SQL query contains a SQL fragment
|
|
*
|
|
* @param string $needleSQL
|
|
* @param string $haystackSQL
|
|
* @param string $message
|
|
* @param boolean $ignoreCase
|
|
* @param boolean $checkForObjectIdentity
|
|
*/
|
|
public function assertSQLContains($needleSQL, $haystackSQL, $message = '', $ignoreCase = false,
|
|
$checkForObjectIdentity = true
|
|
) {
|
|
$needleSQL = $this->normaliseSQL($needleSQL);
|
|
$haystackSQL = $this->normaliseSQL($haystackSQL);
|
|
|
|
$this->assertContains($needleSQL, $haystackSQL, $message, $ignoreCase, $checkForObjectIdentity);
|
|
}
|
|
|
|
/**
|
|
* Asserts that a SQL query contains a SQL fragment
|
|
*
|
|
* @param string $needleSQL
|
|
* @param string $haystackSQL
|
|
* @param string $message
|
|
* @param boolean $ignoreCase
|
|
* @param boolean $checkForObjectIdentity
|
|
*/
|
|
public function assertSQLNotContains($needleSQL, $haystackSQL, $message = '', $ignoreCase = false,
|
|
$checkForObjectIdentity = true
|
|
) {
|
|
$needleSQL = $this->normaliseSQL($needleSQL);
|
|
$haystackSQL = $this->normaliseSQL($haystackSQL);
|
|
|
|
$this->assertNotContains($needleSQL, $haystackSQL, $message, $ignoreCase, $checkForObjectIdentity);
|
|
}
|
|
/**
|
|
* Helper function for the DOS matchers
|
|
*/
|
|
private function dataObjectArrayMatch($item, $match) {
|
|
foreach($match as $k => $v) {
|
|
if(!array_key_exists($k, $item) || $item[$k] != $v) return false;
|
|
}
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* Helper function for the DOS matchers
|
|
*/
|
|
private function DOSSummaryForMatch($dataObjectSet, $match) {
|
|
$extracted = array();
|
|
foreach($dataObjectSet as $item) $extracted[] = array_intersect_key($item->toMap(), $match);
|
|
return var_export($extracted, true);
|
|
}
|
|
|
|
/**
|
|
* Returns true if we are currently using a temporary database
|
|
*/
|
|
public static function using_temp_db() {
|
|
$dbConn = DB::get_conn();
|
|
$prefix = defined('SS_DATABASE_PREFIX') ? SS_DATABASE_PREFIX : 'ss_';
|
|
return $dbConn && (substr($dbConn->getSelectedDatabase(), 0, strlen($prefix) + 5)
|
|
== strtolower(sprintf('%stmpdb', $prefix)));
|
|
}
|
|
|
|
public static function kill_temp_db() {
|
|
// Delete our temporary database
|
|
if(self::using_temp_db()) {
|
|
$dbConn = DB::get_conn();
|
|
$dbName = $dbConn->getSelectedDatabase();
|
|
if($dbName && DB::get_conn()->databaseExists($dbName)) {
|
|
// Some DataExtensions keep a static cache of information that needs to
|
|
// be reset whenever the database is killed
|
|
foreach(ClassInfo::subclassesFor('DataExtension') as $class) {
|
|
$toCall = array($class, 'on_db_reset');
|
|
if(is_callable($toCall)) call_user_func($toCall);
|
|
}
|
|
|
|
// echo "Deleted temp database " . $dbConn->currentDatabase() . "\n";
|
|
$dbConn->dropSelectedDatabase();
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Remove all content from the temporary database.
|
|
*/
|
|
public static function empty_temp_db() {
|
|
if(self::using_temp_db()) {
|
|
DB::get_conn()->clearAllData();
|
|
|
|
// Some DataExtensions keep a static cache of information that needs to
|
|
// be reset whenever the database is cleaned out
|
|
$classes = array_merge(ClassInfo::subclassesFor('DataExtension'), ClassInfo::subclassesFor('DataObject'));
|
|
foreach($classes as $class) {
|
|
$toCall = array($class, 'on_db_reset');
|
|
if(is_callable($toCall)) call_user_func($toCall);
|
|
}
|
|
}
|
|
}
|
|
|
|
public static function create_temp_db() {
|
|
// Disable PHPUnit error handling
|
|
restore_error_handler();
|
|
|
|
// Create a temporary database, and force the connection to use UTC for time
|
|
global $databaseConfig;
|
|
$databaseConfig['timezone'] = '+0:00';
|
|
DB::connect($databaseConfig);
|
|
$dbConn = DB::get_conn();
|
|
$prefix = defined('SS_DATABASE_PREFIX') ? SS_DATABASE_PREFIX : 'ss_';
|
|
$dbname = strtolower(sprintf('%stmpdb', $prefix)) . rand(1000000,9999999);
|
|
while(!$dbname || $dbConn->databaseExists($dbname)) {
|
|
$dbname = strtolower(sprintf('%stmpdb', $prefix)) . rand(1000000,9999999);
|
|
}
|
|
|
|
$dbConn->selectDatabase($dbname, true);
|
|
|
|
$st = Injector::inst()->create('SapphireTest');
|
|
$st->resetDBSchema();
|
|
|
|
// Reinstate PHPUnit error handling
|
|
set_error_handler(array('PHPUnit_Util_ErrorHandler', 'handleError'));
|
|
|
|
return $dbname;
|
|
}
|
|
|
|
public static function delete_all_temp_dbs() {
|
|
$prefix = defined('SS_DATABASE_PREFIX') ? SS_DATABASE_PREFIX : 'ss_';
|
|
foreach(DB::get_schema()->databaseList() as $dbName) {
|
|
if(preg_match(sprintf('/^%stmpdb[0-9]+$/', $prefix), $dbName)) {
|
|
DB::get_schema()->dropDatabase($dbName);
|
|
if(Director::is_cli()) {
|
|
echo "Dropped database \"$dbName\"" . PHP_EOL;
|
|
} else {
|
|
echo "<li>Dropped database \"$dbName\"</li>" . PHP_EOL;
|
|
}
|
|
flush();
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Reset the testing database's schema.
|
|
* @param $includeExtraDataObjects If true, the extraDataObjects tables will also be included
|
|
*/
|
|
public function resetDBSchema($includeExtraDataObjects = false) {
|
|
if(self::using_temp_db()) {
|
|
DataObject::reset();
|
|
|
|
// clear singletons, they're caching old extension info which is used in DatabaseAdmin->doBuild()
|
|
Injector::inst()->unregisterAllObjects();
|
|
|
|
$dataClasses = ClassInfo::subclassesFor('DataObject');
|
|
array_shift($dataClasses);
|
|
|
|
DB::quiet();
|
|
$schema = DB::get_schema();
|
|
$extraDataObjects = $includeExtraDataObjects ? $this->extraDataObjects : null;
|
|
$schema->schemaUpdate(function() use($dataClasses, $extraDataObjects){
|
|
foreach($dataClasses as $dataClass) {
|
|
// Check if class exists before trying to instantiate - this sidesteps any manifest weirdness
|
|
if(class_exists($dataClass)) {
|
|
$SNG = singleton($dataClass);
|
|
if(!($SNG instanceof TestOnly)) $SNG->requireTable();
|
|
}
|
|
}
|
|
|
|
// If we have additional dataobjects which need schema, do so here:
|
|
if($extraDataObjects) {
|
|
foreach($extraDataObjects as $dataClass) {
|
|
$SNG = singleton($dataClass);
|
|
if(singleton($dataClass) instanceof DataObject) $SNG->requireTable();
|
|
}
|
|
}
|
|
});
|
|
|
|
ClassInfo::reset_db_cache();
|
|
singleton('DataObject')->flushCache();
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Create a member and group with the given permission code, and log in with it.
|
|
* Returns the member ID.
|
|
*/
|
|
public function logInWithPermission($permCode = "ADMIN") {
|
|
if(!isset($this->cache_generatedMembers[$permCode])) {
|
|
$group = Injector::inst()->create('Group');
|
|
$group->Title = "$permCode group";
|
|
$group->write();
|
|
|
|
$permission = Injector::inst()->create('Permission');
|
|
$permission->Code = $permCode;
|
|
$permission->write();
|
|
$group->Permissions()->add($permission);
|
|
|
|
$member = DataObject::get_one('Member', array(
|
|
'"Member"."Email"' => "$permCode@example.org"
|
|
));
|
|
if(!$member) $member = Injector::inst()->create('Member');
|
|
|
|
$member->FirstName = $permCode;
|
|
$member->Surname = "User";
|
|
$member->Email = "$permCode@example.org";
|
|
$member->write();
|
|
$group->Members()->add($member);
|
|
|
|
$this->cache_generatedMembers[$permCode] = $member;
|
|
}
|
|
|
|
$this->cache_generatedMembers[$permCode]->logIn();
|
|
return $this->cache_generatedMembers[$permCode]->ID;
|
|
}
|
|
|
|
/**
|
|
* Cache for logInWithPermission()
|
|
*/
|
|
protected $cache_generatedMembers = array();
|
|
|
|
|
|
/**
|
|
* Test against a theme.
|
|
*
|
|
* @param $themeBaseDir string - themes directory
|
|
* @param $theme string - theme name
|
|
* @param $callback Closure
|
|
*/
|
|
protected function useTestTheme($themeBaseDir, $theme, $callback) {
|
|
Config::nest();
|
|
global $project;
|
|
|
|
$manifest = new SS_TemplateManifest($themeBaseDir, $project, true, true);
|
|
|
|
SS_TemplateLoader::instance()->pushManifest($manifest);
|
|
|
|
Config::inst()->update('SSViewer', 'theme', $theme);
|
|
|
|
$e = null;
|
|
|
|
try { $callback(); }
|
|
catch (Exception $e) { /* NOP for now, just save $e */ }
|
|
|
|
// Remove all the test themes we created
|
|
SS_TemplateLoader::instance()->popManifest();
|
|
|
|
Config::unnest();
|
|
|
|
if ($e) throw $e;
|
|
}
|
|
|
|
}
|
|
|
|
|