SapphireTest
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
| static private | $dependencies |
Methods
Determines if unit tests are currently run (via {@link TestRunner}).
No description
Set the manifest to be used to look up test classes by helper functions
Return the manifest being used to look up test classes by helper functions
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.
No description
Load a YAML fixture file into the database.
Clear all fixtures which were previously loaded through {@link loadFixture()}
No description
No description
No description
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.
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
Returns true if we are currently using a temporary database
No description
Remove all content from the temporary database.
No description
No description
Reset the testing database's schema.
Create a member and group with the given permission code, and log in with it.
Details
static bool
is_running_test()
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.
static
set_is_running_test($bool)
static
set_test_class_manifest($manifest)
Set the manifest to be used to look up test classes by helper functions
static
get_test_class_manifest()
Return the manifest being used to look up test classes by helper functions
static string
get_fixture_file()
setUp()
setUpOnce()
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.
tearDownOnce()
tearDown method that's called once per test class rather once per test method.
FixtureFactory
getFixtureFactory()
setFixtureFactory(FixtureFactory $factory)
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.
clearFixtures()
Clear all fixtures which were previously loaded through {@link loadFixture()}
tearDown()
static
assertContains($needle, $haystack, $message = '', $ignoreCase = FALSE, $checkForObjectIdentity = TRUE, $checkForNonObjectIdentity = false)
static
assertNotContains($needle, $haystack, $message = '', $ignoreCase = FALSE, $checkForObjectIdentity = TRUE, $checkForNonObjectIdentity = false)
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.
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.
assertDOSContains($matches, $dataObjectSet)
Assert that the given {@link SS_List} includes DataObjects matching the given key-value pairs. Each match must correspond to 1 distinct record.
assertDOSEquals($matches, $dataObjectSet)
Assert that the given {@link SS_List} includes only DataObjects matching the given key-value pairs. Each match must correspond to 1 distinct record.
assertDOSAllMatch($match, $dataObjectSet)
Assert that the every record in the given {@link SS_List} matches the given key-value pairs.
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
assertSQLContains(string $needleSQL, string $haystackSQL, string $message = '', bool $ignoreCase = false, bool $checkForObjectIdentity = true)
Asserts that a SQL query contains a SQL fragment
assertSQLNotContains(string $needleSQL, string $haystackSQL, string $message = '', bool $ignoreCase = false, bool $checkForObjectIdentity = true)
Asserts that a SQL query contains a SQL fragment
static
using_temp_db()
Returns true if we are currently using a temporary database
static
kill_temp_db()
static
empty_temp_db()
Remove all content from the temporary database.
static
create_temp_db()
static
delete_all_temp_dbs()
resetDBSchema($includeExtraDataObjects = false)
Reset the testing database's schema.
logInWithPermission($permCode = "ADMIN")
Create a member and group with the given permission code, and log in with it.
Returns the member ID.