SapphireTest
abstract class SapphireTest extends TestCase implements TestOnly (View source)
Test case class for the Silverstripe 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.
This class should not be used anywhere outside of unit tests, as phpunit may not be installed in production sites.
Methods
No description
Gets illegal extensions for this class
Gets required extensions for this class
No description
No description
No description
No description
Called once per test case ({@link SapphireTest} subclass).
tearDown method that's called once per test class rather once per test method.
Clear all fixtures which were previously loaded through {@link loadFixture()}
Clear the log of emails sent
Search for an email that was sent.
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.
Assert that the given {@link SS_List} includes DataObjects matching the given key-value pairs. Each match must correspond to 1 distinct record.
Asserts that no items in a given list appear in the given dataobject list
Assert that the given {@link SS_List} includes only DataObjects matching the given key-value pairs. Each match must correspond to 1 distinct record.
Assert that the every record in the given {@link SS_List} matches the given key-value pairs.
Asserts that two SQL queries are equivalent
Asserts that a SQL query contains a SQL fragment
Asserts that a SQL query contains a SQL fragment
Start test environment
Reset the testing database's schema, but only if it is active
A wrapper for automatically performing callbacks as a user with a specific permission
Create a member and group with the given permission code, and log in with it.
Log out the current user
Return all extra objects to scaffold for this test
Get additional controller classes to register routes for
Reimplementation of phpunit5 PHPUnit_Util_InvalidArgumentHelper::factory()
Returns the annotations for this test.
Details
static TempDatabase
tempDB()
static array
getIllegalExtensions()
Gets illegal extensions for this class
static array
getRequiredExtensions()
Gets required extensions for this class
static string
get_fixture_file()
bool
getUsesDatabase()
bool
getUsesTransactions()
array
getRequireDefaultRecordsFrom()
static void
setUpBeforeClass()
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 teardownAfterClass()} for tearing down the state again.
Always sets up in order:
- Reset php state
- Nest
- Custom state helpers
User code should call parent::setUpBeforeClass() before custom setup code
static void
tearDownAfterClass()
tearDown method that's called once per test class rather once per test method.
Always sets up in order:
- Custom state helpers
- Unnest
- Reset php state
User code should call parent::tearDownAfterClass() after custom tear down code
clearFixtures()
Clear all fixtures which were previously loaded through {@link loadFixture()}
bool
clearEmails()
Clear the log of emails sent
static array|null
findEmail(string $to, string $from = null, string $subject = null, string $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.
static
assertEmailSent(string $to, string $from = null, string $subject = null, string $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.
static
assertListContains(SS_List|array $matches, SS_List $list, string $message = '')
Assert that the given {@link SS_List} includes DataObjects matching the given key-value pairs. Each match must correspond to 1 distinct record.
static
assertListNotContains(SS_List|array $matches, SS_List $list, string $message = '')
Asserts that no items in a given list appear in the given dataobject list
static
assertListEquals(mixed $matches, SS_List $list, string $message = '')
Assert that the given {@link SS_List} includes only DataObjects matching the given key-value pairs. Each match must correspond to 1 distinct record.
Example
Check that only the entries Sam Minnee and Ingo Schommer exist in $members. Order doesn't matter: $this->assertListEquals([ ['FirstName' =>'Sam', 'Surname' => 'Minnee'], ['FirstName' => 'Ingo', 'Surname' => 'Schommer'], ], $members);
static
assertListAllMatch(mixed $match, SS_List $list, string $message = '')
Assert that the every record in the given {@link SS_List} matches the given key-value pairs.
Example
Check that every entry in $members has a Status of 'Active': $this->assertListAllMatch(['Status' => 'Active'], $members);
static
assertSQLEquals(string $expectedSQL, string $actualSQL, string $message = '')
Asserts that two SQL queries are equivalent
static
assertSQLContains(string $needleSQL, string $haystackSQL, string $message = '')
Asserts that a SQL query contains a SQL fragment
static
assertSQLNotContains(string $needleSQL, string $haystackSQL, string $message = '')
Asserts that a SQL query contains a SQL fragment
static
start()
Start test environment
static
resetDBSchema(bool $includeExtraDataObjects = false, bool $forceCreate = false)
Reset the testing database's schema, but only if it is active
mixed
actWithPermission(string|array $permCode, callable $callback)
A wrapper for automatically performing callbacks as a user with a specific permission
int
logInWithPermission(string|array $permCode = 'ADMIN')
Create a member and group with the given permission code, and log in with it.
Returns the member ID.
logInAs(Member|int|string $member)
Log in as the given member
logOut()
Log out the current user
static array
getExtraDataObjects()
Return all extra objects to scaffold for this test
static array
getExtraControllers()
Get additional controller classes to register routes for
static
createInvalidArgumentException($argument, $type, $value = null)
Reimplementation of phpunit5 PHPUnit_Util_InvalidArgumentHelper::factory()
array
getAnnotations()
Returns the annotations for this test.