class SapphireTest extends PHPUnit_Framework_TestCase (View source)

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.

Properties

protected static string|array $fixture_file

Path to fixture data for this test run.

protected FixtureFactory $fixtureFactory
protected bool $skipTest
protected bool $usesDatabase
protected deprecated $originalMailer
protected $originalMemberPasswordValidator
protected $originalRequirements
protected $originalIsRunningTest
protected $originalTheme
protected $originalNestedURLsState
protected $originalMemoryLimit
protected $mailer
protected static $regular_manifest

Pointer to the manifest that isn't a test manifest

protected static bool $is_running_test
protected static $test_class_manifest
protected $requireDefaultRecordsFrom

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 $illegalExtensions

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.

protected $requiredExtensions

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.

protected $extraDataObjects

By default, the test database won't contain any DataObjects that have the interface TestOnly.

protected $backupGlobals

We need to disabling backing up of globals to avoid overriding the few globals SilverStripe relies on, like $lang for the i18n subsystem.

protected deprecated array $fixtures
protected $model
protected $cache_generatedMembers

Cache for logInWithPermission()

Methods

public static 
bool
is_running_test()

Determines if unit tests are currently run (via TestRunner).

public static 
set_is_running_test($bool)

No description

public static 
set_test_class_manifest($manifest)

Set the manifest to be used to look up test classes by helper functions

public static 
get_test_class_manifest()

Return the manifest being used to look up test classes by helper functions

public static 
string
get_fixture_file()

No description

public
setUp()

No description

public
setUpOnce()

Called once per test case (SapphireTest subclass).

public
tearDownOnce()

tearDown method that's called once per test class rather once per test method.

public
getFixtureFactory()

No description

public
setFixtureFactory(FixtureFactory $factory)

No description

protected
int
idFromFixture($className, $identifier)

Get the ID of an object from the fixture.

protected
array
allFixtureIDs(string $className)

Return all of the IDs in the fixture of a particular class name.

protected
objFromFixture(string $className, string $identifier)

Get an object from the fixture.

public
loadFixture($fixtureFile)

Load a YAML fixture file into the database.

public
clearFixtures()

Clear all fixtures which were previously loaded through loadFixture()

protected
string
getCurrentAbsolutePath()

Useful for writing unit tests without hardcoding folder structures.

protected
string
getCurrentRelativePath()

No description

public
tearDown()

No description

public static 
assertContains($needle, $haystack, $message = '', $ignoreCase = FALSE, $checkForObjectIdentity = TRUE, $checkForNonObjectIdentity = false)

No description

public static 
assertNotContains($needle, $haystack, $message = '', $ignoreCase = FALSE, $checkForObjectIdentity = TRUE, $checkForNonObjectIdentity = false)

No description

public
clearEmails()

Clear the log of emails sent

public
array
findEmail($to, $from = null, $subject = null, $content = null)

Search for an email that was sent.

public
array
assertEmailSent($to, $from = null, $subject = null, $content = null)

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.

public
assertDOSContains($matches, $dataObjectSet)

Assert that the given SS_List includes DataObjects matching the given key-value pairs. Each match must correspond to 1 distinct record.

public
assertDOSEquals($matches, $dataObjectSet)

Assert that the given SS_List includes only DataObjects matching the given key-value pairs. Each match must correspond to 1 distinct record.

public
assertDOSAllMatch($match, $dataObjectSet)

Assert that the every record in the given SS_List matches the given key-value pairs.

protected
string
normaliseSQL(string $sql)

Removes sequences of repeated whitespace characters from SQL queries making them suitable for string comparison

public
assertSQLEquals(string $expectedSQL, string $actualSQL, string $message = '', float $delta = 0, int $maxDepth = 10, bool $canonicalize = false, bool $ignoreCase = false)

Asserts that two SQL queries are equivalent

public
assertSQLContains(string $needleSQL, string $haystackSQL, string $message = '', bool $ignoreCase = false, bool $checkForObjectIdentity = true)

Asserts that a SQL query contains a SQL fragment

public
assertSQLNotContains(string $needleSQL, string $haystackSQL, string $message = '', bool $ignoreCase = false, bool $checkForObjectIdentity = true)

Asserts that a SQL query contains a SQL fragment

public static 
using_temp_db()

Returns true if we are currently using a temporary database

public static 
kill_temp_db()

No description

public static 
empty_temp_db()

Remove all content from the temporary database.

public static 
create_temp_db()

No description

public static 
delete_all_temp_dbs()

No description

public
resetDBSchema($includeExtraDataObjects = false)

Reset the testing database's schema.

public
logInWithPermission($permCode = "ADMIN")

Create a member and group with the given permission code, and log in with it.

protected
useTestTheme($themeBaseDir, $theme, $callback)

Test against a theme.

Details

static bool is_running_test()

Determines if unit tests are currently run (via 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 Value

bool

static set_is_running_test($bool)

No description

Parameters

$bool

static set_test_class_manifest($manifest)

Set the manifest to be used to look up test classes by helper functions

Parameters

$manifest

static get_test_class_manifest()

Return the manifest being used to look up test classes by helper functions

static string get_fixture_file()

No description

Return Value

string

setUp()

No description

setUpOnce()

Called once per test case (SapphireTest subclass).

This is different to 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 tearDownOnce() for tearing down the state again.

tearDownOnce()

tearDown method that's called once per test class rather once per test method.

FixtureFactory getFixtureFactory()

No description

Return Value

FixtureFactory

setFixtureFactory(FixtureFactory $factory)

No description

Parameters

FixtureFactory $factory

protected int idFromFixture($className, $identifier)

Get the ID of an object from the fixture.

Parameters

$className

The data class, as specified in your fixture file. Parent classes won't work

$identifier

The identifier string, as provided in your fixture file

Return Value

int

protected array allFixtureIDs(string $className)

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.

Parameters

string $className

Return Value

array

A map of fixture-identifier => object-id

protected DataObject objFromFixture(string $className, string $identifier)

Get an object from the fixture.

Parameters

string $className

The data class, as specified in your fixture file. Parent classes won't work

string $identifier

The identifier string, as provided in your fixture file

Return Value

DataObject

loadFixture($fixtureFile)

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.

Parameters

$fixtureFile

The location of the .yml fixture file, relative to the site base dir

clearFixtures()

Clear all fixtures which were previously loaded through loadFixture()

protected string getCurrentAbsolutePath()

Useful for writing unit tests without hardcoding folder structures.

Return Value

string

Absolute path to current class.

protected string getCurrentRelativePath()

No description

Return Value

string

File path relative to webroot

tearDown()

No description

static assertContains($needle, $haystack, $message = '', $ignoreCase = FALSE, $checkForObjectIdentity = TRUE, $checkForNonObjectIdentity = false)

No description

Parameters

$needle
$haystack
$message
$ignoreCase
$checkForObjectIdentity
$checkForNonObjectIdentity

static assertNotContains($needle, $haystack, $message = '', $ignoreCase = FALSE, $checkForObjectIdentity = TRUE, $checkForNonObjectIdentity = false)

No description

Parameters

$needle
$haystack
$message
$ignoreCase
$checkForObjectIdentity
$checkForNonObjectIdentity

clearEmails()

Clear the log of emails sent

array findEmail($to, $from = null, $subject = null, $content = null)

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.

Parameters

$to
$from
$subject
$content

Return Value

array

Contains keys: 'type', 'to', 'from', 'subject','content', 'plainContent', 'attachedFiles', 'customHeaders', 'htmlContent', 'inlineImages'

array assertEmailSent($to, $from = null, $subject = null, $content = null)

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.

Parameters

$to
$from
$subject
$content

Return Value

array

Contains the keys: 'type', 'to', 'from', 'subject', 'content', 'plainContent', 'attachedFiles', 'customHeaders', 'htmlContent', inlineImages'

assertDOSContains($matches, $dataObjectSet)

Assert that the given SS_List includes DataObjects matching the given key-value pairs. Each match must correspond to 1 distinct record.

Parameters

$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.

$dataObjectSet

The SS_List to test.

Examples

Check that $members includes an entry with Email = [email protected]: $this->assertDOSContains(array('Email' => '[email protected]'), $members);

Check that $members includes entries with Email = [email protected] and with Email = [email protected]: $this->assertDOSContains(array( array('Email' => '[email protected]'), array('Email' => '[email protected]'), ), $members);

assertDOSEquals($matches, $dataObjectSet)

Assert that the given SS_List includes only DataObjects matching the given key-value pairs. Each match must correspond to 1 distinct record.

Parameters

$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.

$dataObjectSet

The 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);

assertDOSAllMatch($match, $dataObjectSet)

Assert that the every record in the given SS_List matches the given key-value pairs.

Parameters

$match

The pattern to match. The pattern is a map of key-value pairs.

$dataObjectSet

The SS_List to test.

Example

Check that every entry in $members has a Status of 'Active': $this->assertDOSAllMatch(array('Status' => 'Active'), $members);

protected string normaliseSQL(string $sql)

Removes sequences of repeated whitespace characters from SQL queries making them suitable for string comparison

Parameters

string $sql

Return Value

string

The cleaned and normalised SQL string

assertSQLEquals(string $expectedSQL, string $actualSQL, string $message = '', float $delta = 0, int $maxDepth = 10, bool $canonicalize = false, bool $ignoreCase = false)

Asserts that two SQL queries are equivalent

Parameters

string $expectedSQL
string $actualSQL
string $message
float $delta
int $maxDepth
bool $canonicalize
bool $ignoreCase

assertSQLContains(string $needleSQL, string $haystackSQL, string $message = '', bool $ignoreCase = false, bool $checkForObjectIdentity = true)

Asserts that a SQL query contains a SQL fragment

Parameters

string $needleSQL
string $haystackSQL
string $message
bool $ignoreCase
bool $checkForObjectIdentity

assertSQLNotContains(string $needleSQL, string $haystackSQL, string $message = '', bool $ignoreCase = false, bool $checkForObjectIdentity = true)

Asserts that a SQL query contains a SQL fragment

Parameters

string $needleSQL
string $haystackSQL
string $message
bool $ignoreCase
bool $checkForObjectIdentity

static using_temp_db()

Returns true if we are currently using a temporary database

static kill_temp_db()

No description

static empty_temp_db()

Remove all content from the temporary database.

static create_temp_db()

No description

static delete_all_temp_dbs()

No description

resetDBSchema($includeExtraDataObjects = false)

Reset the testing database's schema.

Parameters

$includeExtraDataObjects

If true, the extraDataObjects tables will also be included

logInWithPermission($permCode = "ADMIN")

Create a member and group with the given permission code, and log in with it.

Returns the member ID.

Parameters

$permCode

protected useTestTheme($themeBaseDir, $theme, $callback)

Test against a theme.

Parameters

$themeBaseDir

string - themes directory

$theme

string - theme name

$callback Closure