advanced_testcase Class Reference

Inheritance diagram for advanced_testcase:

Public Member Functions
	__construct ($name=null, array $data=[], $dataname='')
	Constructs a test case with the given name.
	assertDebuggingCalled ($debugmessage=null, $debuglevel=null, $message='')
	Assert that exactly debugging was just called once.
	assertdebuggingcalledcount ($expectedcount, $debugmessages=[], $debuglevels=[], $message='')
	Asserts how many times debugging has been called.
	assertDebuggingNotCalled ($message='')
	Call when no debugging() messages expected.
	assertEqualsIgnoringWhitespace ($expected, $actual, string $message='')
	Assert that two Date/Time strings are equal.
	assertEventContextNotUsed (\core\event\base $event, $message='')
	Assert that various event methods are not using event->context.
	assertEventLegacyData ($expected, core\event\base $event, $message='')
	Assert that an event legacy data is equal to the expected value.
	assertEventLegacyLogData ($expected, core\event\base $event, $message='')
	Assert that an event legacy log data is equal to the expected value.
	assertTimeCurrent ($time, $message='')
	Assert that: start < $time < time()
	getDebuggingMessages ()
	Return debugging messages from the current test.
	getExternalTestFileUrl ($path, $https=false)
	Returns UTL of the external test file.
	mock_clock_with_frozen (?int $time=null,)
	Mock the clock with a frozen clock.
	mock_clock_with_incrementing (?int $starttime=null,)
	Mock the clock with an incrementing clock.
	preventResetByRollback ()
	Call this method from test if you want to make sure that the resetting of database is done the slow way without transaction rollback.
	recurseFolders ($path, $callback, $fileregexp='/.*/', $exclude=false, $ignorefolders=array())
	Recursively visit all the files in the source tree.
	redirectEmails ()
	Starts email redirection.
	redirectEvents ()
	Starts event redirection.
	redirectHook (string $hookname, callable $callback)
	Override hook callbacks.
	redirectMessages ()
	Starts message redirection.
	resetAfterTest ($reset=true)
	Reset everything after current test.
	resetDebugging ()
	Clear all previous debugging messages in current test and revert to default DEVELOPER_DEBUG level.
	runBare ()
	Runs the bare test sequence.
	setCurrentTimeStart ()
	Stores current time as the base for assertTimeCurrent().
	stopHookRedirections ()
	Remove all hook overrides.
	waitForSecond ()
	Wait for a second to roll over, ensures future calls to time() return a different result.

Static Public Member Functions
static	assertNotTag ($matcher, $actual, $message='', $ishtml=true)
	Note: we are overriding this method to remove the deprecated error.
static	assertTag ($matcher, $actual, $message='', $ishtml=true)
	Note: we are overriding this method to remove the deprecated error.
static	assertValidKeys (array $hash, array $validKeys)
	Validate list of keys in the associative array.
static	findNodes (DOMDocument $dom, array $options, $isHtml=true)
	Parse out the options from the tag using DOM object tree.
static	getDataGenerator ()
	Get data generator.
static	resetAllData ($detectchanges=false)
	Reset all database tables, restore global state and clear caches and optionally purge dataroot dir.
static	setAdminUser ()
	Set current $USER to admin account, reset access cache.
static	setGuestUser ()
	Set current $USER to guest account, reset access cache.
static	setTimezone ($servertimezone='Australia/Perth', $defaultphptimezone='Australia/Perth')
	Change server and default php timezones.
static	setUser ($user=null)
	Set current $USER, reset access cache.

Protected Member Functions
	add_mocked_plugin (string $plugintype, string $pluginname, string $path,)
	Add a mocked plugin to Moodle.
	add_mocked_plugintype (string $plugintype, string $path,)
	Add a mocked plugintype to Moodle.
	createArrayDataSet ()
	createCsvDataSet ()
	createXMLDataSet ()
	dataset_from_array (array $data)
	Creates a new dataset from PHP array.
	dataset_from_files (array $files)
	Creates a new dataset from CVS/XML files.
	dataset_from_string (string $content, string $type, ?string $table=null)
	Creates a new dataset from string (CSV or XML).
	loadDataSet ()
	run_all_adhoc_tasks ()
	Run adhoc tasks.
	runAdhocTasks ($matchclass='', $matchuserid=null)
	Run adhoc tasks, optionally matching the specified classname.

Static Protected Member Functions
static	getDescendants (DOMNode $node)
	Recursively get flat array of all descendants of this node.
static	getElementsByCaseInsensitiveTagName (DOMDocument $dom, $tag)
	Gets elements by case insensitive tagname.
static	getNodeText (DOMNode $node)
	Get the text value of this node's child text node.

Detailed Description

Copyright

2012 Petr Skoda

License

http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

Constructor & Destructor Documentation

__construct()

advanced_testcase::__construct ( $name = null, array $data = [], $dataname = '' )

final

Constructs a test case with the given name.

Note: use setUp() or setUpBeforeClass() in your test cases.

Parameters

string	$name
array	$data
string	$dataName

Member Function Documentation

add_mocked_plugin()

advanced_testcase::add_mocked_plugin ( string $plugintype, string $pluginname, string $path )

protected

Add a mocked plugin to Moodle.

A new plugin name must be provided with a path to the plugin's root. The plugin type must already exist (or have been mocked separately).

Please note that tests calling this method must be run in separate isolation mode. Please avoid using this if at all possible.

Parameters

string	$plugintype	The name of the plugintype
string	$pluginname	The name of the plugin
string	$path	The path to the plugin's root

add_mocked_plugintype()

advanced_testcase::add_mocked_plugintype ( string $plugintype, string $path )

protected

Add a mocked plugintype to Moodle.

A new plugintype name must be provided with a path to the plugintype's root.

Please note that tests calling this method must be run in separate isolation mode. Please avoid using this if at all possible.

Parameters

string	$plugintype	The name of the plugintype
string	$path	The path to the plugintype's root

assertDebuggingCalled()

advanced_testcase::assertDebuggingCalled	(		$debugmessage = null,
			$debuglevel = null,
			$message = '' )

Assert that exactly debugging was just called once.

Discards the debugging message if successful.

Parameters

null | string	$debugmessage	null means any
null | string	$debuglevel	null means any
string	$message

assertdebuggingcalledcount()

advanced_testcase::assertdebuggingcalledcount	(		$expectedcount,
			$debugmessages = [],
			$debuglevels = [],
			$message = '' )

Asserts how many times debugging has been called.

Parameters

int	$expectedcount	The expected number of times
array	$debugmessages	Expected debugging messages, one for each expected message.
array	$debuglevels	Expected debugging levels, one for each expected message.
string	$message

Return values

void

assertDebuggingNotCalled()

advanced_testcase::assertDebuggingNotCalled

(

$message = ''

)

Call when no debugging() messages expected.

Parameters

string

$message

assertEqualsIgnoringWhitespace()

base_testcase::assertEqualsIgnoringWhitespace ( $expected, $actual, string $message = '' )

inherited

Assert that two Date/Time strings are equal.

The strings generated by DateTime, strtotime, date, time, etc. are generated outside of our control. From time-to-time string changes are made. One such example is from ICU 72.1 which changed the time format to include a narrow-non-breaking-space (U+202F) between the time and AM/PM.

We should not update our tests to match these changes, as it is not our code that is generating the strings and they may change again. In addition, the changes are not equal amongst all systems as they depend on the version of ICU installed.

Parameters

string	$expected
string	$actual
string	$message

assertEventContextNotUsed()

advanced_testcase::assertEventContextNotUsed	(	\core\event\base	$event,
			$message = '' )

Assert that various event methods are not using event->context.

While restoring context might not be valid and it should not be used by event url or description methods.

Parameters

core\event\base	$event	the event object.
string	$message

Return values

void

assertEventLegacyData()

advanced_testcase::assertEventLegacyData	(		$expected,
		core\event\base	$event,
			$message = '' )

Assert that an event legacy data is equal to the expected value.

Parameters

mixed	$expected	expected data.
core\event\base	$event	the event object.
string	$message

Return values

void

assertEventLegacyLogData()

advanced_testcase::assertEventLegacyLogData	(		$expected,
		core\event\base	$event,
			$message = '' )

Assert that an event legacy log data is equal to the expected value.

Parameters

mixed	$expected	expected data.
core\event\base	$event	the event object.
string	$message

Return values

void

assertNotTag()

static base_testcase::assertNotTag ( $matcher, $actual, $message = '', $ishtml = true )

staticinherited

Note: we are overriding this method to remove the deprecated error.

See also

https://tracker.moodle.org/browse/MDL-47129

Parameters

array	$matcher
string	$actual
string	$message
boolean	$ishtml

Deprecated

3.0

assertTag()

static base_testcase::assertTag ( $matcher, $actual, $message = '', $ishtml = true )

staticinherited

Note: we are overriding this method to remove the deprecated error.

See also

https://tracker.moodle.org/browse/MDL-47129

Parameters

array	$matcher
string	$actual
string	$message
boolean	$ishtml

Deprecated

3.0

assertTimeCurrent()

advanced_testcase::assertTimeCurrent	(		$time,
			$message = '' )

Assert that: start < $time < time()

Parameters

int	$time
string	$message

Return values

void

assertValidKeys()

static base_testcase::assertValidKeys ( array $hash, array $validKeys )

staticinherited

Validate list of keys in the associative array.

Parameters

array	$hash
array	$validKeys

Return values

array

Exceptions

PHPUnit\Framework\Exception

createArrayDataSet()

advanced_testcase::createArrayDataSet ( )

protected

Deprecated

since Moodle 3.10 - See MDL-67673 and MDL-64600 for more info.

createCsvDataSet()

advanced_testcase::createCsvDataSet ( )

protected

Deprecated

since Moodle 3.10 - See MDL-67673 and MDL-64600 for more info.

createXMLDataSet()

advanced_testcase::createXMLDataSet ( )

protected

Deprecated

since Moodle 3.10 - See MDL-67673 and MDL-64600 for more info.

dataset_from_array()

advanced_testcase::dataset_from_array ( array $data )

protected

Creates a new dataset from PHP array.

Since

Moodle 3.10

Parameters

array

$data

array of tables, see {

See also

phpunit_dataset\from_array()} for supported formats.

Return values

phpunit_dataset

dataset_from_files()

advanced_testcase::dataset_from_files ( array $files )

protected

Creates a new dataset from CVS/XML files.

This method accepts an array of full paths to CSV or XML files to be loaded into the dataset. For CSV files, the name of the table which the file belongs to needs to be specified. Example:

$fullpaths = [ '/path/to/users.xml', 'course' => '/path/to/courses.csv', ];

Since

Moodle 3.10

Parameters

array

$files

full paths to CSV or XML files to load.

Return values

phpunit_dataset

dataset_from_string()

advanced_testcase::dataset_from_string ( string $content, string $type, ?string $table = null )

protected

Creates a new dataset from string (CSV or XML).

Since

Moodle 3.10

Parameters

string	$content	contents (CSV or XML) to load.
string	$type	format of the content to be loaded (csv or xml).
string	$table	name of the table which the file belongs to (only for CSV files).

Return values

phpunit_dataset

findNodes()

static base_testcase::findNodes ( DOMDocument $dom, array $options, $isHtml = true )

staticinherited

Parse out the options from the tag using DOM object tree.

Parameters

DOMDocument	$dom
array	$options
bool	$isHtml

Return values

array

getDataGenerator()

static advanced_testcase::getDataGenerator ( )

static

Get data generator.

Return values

testing_data_generator

getDebuggingMessages()

advanced_testcase::getDebuggingMessages

(

)

Return debugging messages from the current test.

Return values

array

with instances having 'message', 'level' and 'stacktrace' property.

getDescendants()

static base_testcase::getDescendants ( DOMNode $node )

staticprotectedinherited

Recursively get flat array of all descendants of this node.

Parameters

DOMNode

$node

Return values

array

getElementsByCaseInsensitiveTagName()

static base_testcase::getElementsByCaseInsensitiveTagName ( DOMDocument $dom, $tag )

staticprotectedinherited

Gets elements by case insensitive tagname.

Parameters

DOMDocument	$dom
string	$tag

Return values

DOMNodeList

getExternalTestFileUrl()

advanced_testcase::getExternalTestFileUrl	(		$path,
			$https = false )

Returns UTL of the external test file.

The result depends on the value of following constants:

• TEST_EXTERNAL_FILES_HTTP_URL
• TEST_EXTERNAL_FILES_HTTPS_URL

They should point to standard external test files repository, it defaults to 'http://download.moodle.org/unittest'.

False value means skip tests that require external files.

Parameters

string	$path
bool	$https	true if https required

Return values

string

url

getNodeText()

static base_testcase::getNodeText ( DOMNode $node )

staticprotectedinherited

Get the text value of this node's child text node.

Parameters

DOMNode

$node

Return values

string

loadDataSet()

advanced_testcase::loadDataSet ( )

protected

Deprecated

since Moodle 3.10 - See MDL-67673 and MDL-64600 for more info.

mock_clock_with_frozen()

advanced_testcase::mock_clock_with_frozen

(

?int

$time = null

)

Mock the clock with a frozen clock.

Parameters

null | int

$time

Return values

frozen_clock

mock_clock_with_incrementing()

advanced_testcase::mock_clock_with_incrementing

(

?int

$starttime = null

)

Mock the clock with an incrementing clock.

Parameters

null | int

$starttime

Return values

incrementing_clock

preventResetByRollback()

advanced_testcase::preventResetByRollback

(

)

Call this method from test if you want to make sure that the resetting of database is done the slow way without transaction rollback.

This is useful especially when testing stuff that is not compatible with transactions.

Return values

void

recurseFolders()

advanced_testcase::recurseFolders	(		$path,
			$callback,
			$fileregexp = '/.*/',
			$exclude = false,
			$ignorefolders = array() )

Recursively visit all the files in the source tree.

Calls the callback function with the pathname of each file found.

Parameters

string	$path	the folder to start searching from.
string	$callback	the method of this class to call with the name of each file found.
string	$fileregexp	a regexp used to filter the search (optional).
bool	$exclude	If true, pathnames that match the regexp will be ignored. If false, only files that match the regexp will be included. (default false).
array	$ignorefolders	will not go into any of these folders (optional).

Return values

void

redirectEmails()

advanced_testcase::redirectEmails

(

)

Starts email redirection.

You can verify if email were sent or not by inspecting the email array in the returned phpmailer sink instance. The redirection can be stopped by calling $sink->close();

Return values

phpunit_message_sink

redirectEvents()

advanced_testcase::redirectEvents

(

)

Starts event redirection.

You can verify if events were triggered or not by inspecting the events array in the returned event sink instance. The redirection can be stopped by calling $sink->close();

Return values

phpunit_event_sink

redirectHook()

advanced_testcase::redirectHook	(	string	$hookname,
		callable	$callback )

Override hook callbacks.

Parameters

string	$hookname
callable	$callback

Return values

void

redirectMessages()

advanced_testcase::redirectMessages

(

)

Starts message redirection.

You can verify if messages were sent or not by inspecting the messages array in the returned messaging sink instance. The redirection can be stopped by calling $sink->close();

Return values

phpunit_message_sink

resetAfterTest()

advanced_testcase::resetAfterTest

(

$reset = true

)

Reset everything after current test.

Parameters

bool

$reset

true means reset state back, false means keep all data for the next test, null means reset state and show warnings if anything changed

Return values

void

resetAllData()

static advanced_testcase::resetAllData ( $detectchanges = false )

static

Reset all database tables, restore global state and clear caches and optionally purge dataroot dir.

Parameters

bool

$detectchanges

true - changes in global state and database are reported as errors false - no errors reported null - only critical problems are reported as errors

Return values

void

runAdhocTasks()

advanced_testcase::runAdhocTasks ( $matchclass = '', $matchuserid = null )

protected

Run adhoc tasks, optionally matching the specified classname.

Parameters

string	$matchclass	The name of the class to match on.
int	$matchuserid	The userid to match.

setAdminUser()

static advanced_testcase::setAdminUser ( )

static

Set current $USER to admin account, reset access cache.

Return values

void

setCurrentTimeStart()

advanced_testcase::setCurrentTimeStart

(

)

Stores current time as the base for assertTimeCurrent().

Note: this is called automatically before calling individual test methods.

Return values

int	current time

setGuestUser()

static advanced_testcase::setGuestUser ( )

static

Set current $USER to guest account, reset access cache.

Return values

void

setTimezone()

static advanced_testcase::setTimezone ( $servertimezone = 'Australia/Perth', $defaultphptimezone = 'Australia/Perth' )

static

Change server and default php timezones.

Parameters

string	$servertimezone	timezone to set in $CFG->timezone (not validated)
string	$defaultphptimezone	timezone to fake default php timezone (must be valid)

setUser()

static advanced_testcase::setUser ( $user = null )

static

Set current $USER, reset access cache.

Parameters

null | int | stdClass

$user

user record, null or 0 means non-logged-in, positive integer means userid

Return values

void

stopHookRedirections()

advanced_testcase::stopHookRedirections

(

)

Remove all hook overrides.

Return values

void

waitForSecond()

advanced_testcase::waitForSecond

(

)

Wait for a second to roll over, ensures future calls to time() return a different result.

This is implemented instead of sleep() as we do not need to wait a full second. In some cases due to calls we may wait more than sleep() would have, on average it will be less.

---

The documentation for this class was generated from the following file:

• lib/phpunit/classes/advanced_testcase.php