Moodle APIs  3.8
Moodle 3.8.6 (Build: 20201109)
Public Member Functions | Static Public Member Functions | Protected Member Functions | Static Protected Member Functions | List of all members
externallib_advanced_testcase Class Reference

Helper base class for external tests. More...

Inheritance diagram for externallib_advanced_testcase:
advanced_testcase base_testcase

Public Member Functions

 assertDebuggingCalled ($debugmessage=null, $debuglevel=null, $message='')
 Assert that exactly debugging was just called once. More...
 
 assertDebuggingCalledCount ($expectedcount, $debugmessages=array(), $debuglevels=array(), $message='')
 Asserts how many times debugging has been called. More...
 
 assertDebuggingNotCalled ($message='')
 Call when no debugging() messages expected. More...
 
 assertEventContextNotUsed (\core\event\base $event, $message='')
 Assert that an event is not using event->contxet. More...
 
 assertEventLegacyData ($expected, core\event\base $event, $message='')
 Assert that an event legacy data is equal to the expected value. More...
 
 assertEventLegacyLogData ($expected, core\event\base $event, $message='')
 Assert that an event legacy log data is equal to the expected value. More...
 
 assertTimeCurrent ($time, $message='')
 Assert that: start < $time < time() More...
 
 getDebuggingMessages ()
 Return debugging messages from the current test. More...
 
 getExternalTestFileUrl ($path, $https=false)
 Returns UTL of the external test file. More...
 
 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. More...
 
 recurseFolders ($path, $callback, $fileregexp='/.*/', $exclude=false, $ignorefolders=array())
 Recursively visit all the files in the source tree. More...
 
 redirectEmails ()
 Starts email redirection. More...
 
 redirectEvents ()
 Starts event redirection. More...
 
 redirectMessages ()
 Starts message redirection. More...
 
 resetAfterTest ($reset=true)
 Reset everything after current test. More...
 
 resetDebugging ()
 Clear all previous debugging messages in current test and revert to default DEVELOPER_DEBUG level.
 
 runBare ()
 Runs the bare test sequence. More...
 
 setCurrentTimeStart ()
 Stores current time as the base for assertTimeCurrent(). More...
 
 waitForSecond ()
 Wait for a second to roll over, ensures future calls to time() return a different result. More...
 

Static Public Member Functions

static assertNotTag ($matcher, $actual, $message='', $ishtml=true)
 Note: we are overriding this method to remove the deprecated error. More...
 
static assertTag ($matcher, $actual, $message='', $ishtml=true)
 Note: we are overriding this method to remove the deprecated error. More...
 
static assertValidKeys (array $hash, array $validKeys)
 Validate list of keys in the associative array. More...
 
static assignUserCapability ($capability, $contextid, $roleid=null)
 Assign a capability to $USER The function creates a student $USER if $USER->id is empty. More...
 
static configure_filters ($filters)
 Configure some filters for external tests. More...
 
static findNodes (DOMDocument $dom, array $options, $isHtml=true)
 Parse out the options from the tag using DOM object tree. More...
 
static getDataGenerator ()
 Get data generator. More...
 
static resetAllData ($detectchanges=false)
 Reset all database tables, restore global state and clear caches and optionally purge dataroot dir. More...
 
static setAdminUser ()
 Set current $USER to admin account, reset access cache. More...
 
static setGuestUser ()
 Set current $USER to guest account, reset access cache. More...
 
static setTimezone ($servertimezone='Australia/Perth', $defaultphptimezone='Australia/Perth')
 Change server and default php timezones. More...
 
static setUser ($user=null)
 Set current $USER, reset access cache. More...
 
static unassignUserCapability ($capability, $contextid=null, $roleid=null, $courseid=null, $enrol='manual')
 Unassign a capability to $USER. More...
 

Protected Member Functions

 createArrayDataSet (array $data)
 Creates new ArrayDataSet from given array. More...
 
 createCsvDataSet ($files, $delimiter=',', $enclosure='"', $escape = '"')
 Creates a new CsvDataSet from the given array of csv files. More...
 
 createFlatXMLDataSet ($xmlFile)
 Creates a new FlatXmlDataSet with the given $xmlFile. More...
 
 createXMLDataSet ($xmlFile)
 Creates a new XMLDataSet with the given $xmlFile. More...
 
 loadDataSet (PHPUnit\DbUnit\DataSet\IDataSet $dataset)
 Load date into moodle database tables from standard PHPUnit data set. More...
 
 runAdhocTasks ($matchclass='', $matchuserid=null)
 Run adhoc tasks, optionally matching the specified classname. More...
 

Static Protected Member Functions

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

Detailed Description

Helper base class for external tests.

Helpfull to test capabilities.

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

Member Function Documentation

◆ assertDebuggingCalled()

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

Assert that exactly debugging was just called once.

Discards the debugging message if successful.

Parameters
null | string$debugmessagenull means any
null | string$debuglevelnull means any
string$message

◆ assertDebuggingCalledCount()

advanced_testcase::assertDebuggingCalledCount (   $expectedcount,
  $debugmessages = array(),
  $debuglevels = array(),
  $message = '' 
)
inherited

Asserts how many times debugging has been called.

Parameters
int$expectedcountThe expected number of times
array$debugmessagesExpected debugging messages, one for each expected message.
array$debuglevelsExpected debugging levels, one for each expected message.
string$message
Return values
void

◆ assertDebuggingNotCalled()

advanced_testcase::assertDebuggingNotCalled (   $message = '')
inherited

Call when no debugging() messages expected.

Parameters
string$message

◆ assertEventContextNotUsed()

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

Assert that an event is not using event->contxet.

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

Parameters
core\event\base$eventthe event object.
string$message
Return values
void

◆ assertEventLegacyData()

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

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

Parameters
mixed$expectedexpected data.
core\event\base$eventthe event object.
string$message
Return values
void

◆ assertEventLegacyLogData()

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

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

Parameters
mixed$expectedexpected data.
core\event\base$eventthe 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 = '' 
)
inherited

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

◆ assignUserCapability()

static externallib_advanced_testcase::assignUserCapability (   $capability,
  $contextid,
  $roleid = null 
)
static

Assign a capability to $USER The function creates a student $USER if $USER->id is empty.

Parameters
string$capabilitycapability name
int$contextid
int$roleid
Return values
intthe role id - mainly returned for creation, so calling function can reuse it

◆ configure_filters()

static externallib_advanced_testcase::configure_filters (   $filters)
static

Configure some filters for external tests.

Parameters
array$filtersFilters to enable. Each filter should contain:
  • name: name of the filter.
  • state: the state of the filter.
  • move: -1 means up, 0 means the same, 1 means down.
  • applytostrings: true to apply the filter to content and headings, false for just content.

◆ createArrayDataSet()

advanced_testcase::createArrayDataSet ( array  $data)
protectedinherited

Creates new ArrayDataSet from given array.

Parameters
array$dataarray of tables, first row in each table is columns
Return values
phpunit_ArrayDataSet

◆ createCsvDataSet()

advanced_testcase::createCsvDataSet (   $files,
  $delimiter = ',',
  $enclosure = '"',
  $escape = '"' 
)
protectedinherited

Creates a new CsvDataSet from the given array of csv files.

(absolute paths.)

Parameters
array$filesarray tablename=>cvsfile
string$delimiter
string$enclosure
string$escape
Return values
PHPUnit

◆ createFlatXMLDataSet()

advanced_testcase::createFlatXMLDataSet (   $xmlFile)
protectedinherited

Creates a new FlatXmlDataSet with the given $xmlFile.

(absolute path.)

Parameters
string$xmlFile
Return values
PHPUnit

◆ createXMLDataSet()

advanced_testcase::createXMLDataSet (   $xmlFile)
protectedinherited

Creates a new XMLDataSet with the given $xmlFile.

(absolute path.)

Parameters
string$xmlFile
Return values
PHPUnit

◆ 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 ( )
staticinherited

Get data generator.

Return values
testing_data_generator

◆ getDebuggingMessages()

advanced_testcase::getDebuggingMessages ( )
inherited

Return debugging messages from the current test.

Return values
arraywith 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 
)
inherited

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$httpstrue if https required
Return values
stringurl

◆ 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 ( PHPUnit\DbUnit\DataSet\IDataSet  $dataset)
protectedinherited

Load date into moodle database tables from standard PHPUnit data set.

Note: it is usually better to use data generators

Parameters
PHPUnit\DbUnit\DataSet\IDataSet$dataset
Return values
void

◆ preventResetByRollback()

advanced_testcase::preventResetByRollback ( )
inherited

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() 
)
inherited

Recursively visit all the files in the source tree.

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

Parameters
string$paththe folder to start searching from.
string$callbackthe method of this class to call with the name of each file found.
string$fileregexpa regexp used to filter the search (optional).
bool$excludeIf true, pathnames that match the regexp will be ignored. If false, only files that match the regexp will be included. (default false).
array$ignorefolderswill not go into any of these folders (optional).
Return values
void

◆ redirectEmails()

advanced_testcase::redirectEmails ( )
inherited

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 ( )
inherited

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

◆ redirectMessages()

advanced_testcase::redirectMessages ( )
inherited

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)
inherited

Reset everything after current test.

Parameters
bool$resettrue 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)
staticinherited

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

Parameters
bool$detectchangestrue - 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 
)
protectedinherited

Run adhoc tasks, optionally matching the specified classname.

Parameters
string$matchclassThe name of the class to match on.
int$matchuseridThe userid to match.

◆ runBare()

advanced_testcase::runBare ( )
finalinherited

Runs the bare test sequence.

Return values
void

◆ setAdminUser()

static advanced_testcase::setAdminUser ( )
staticinherited

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

Return values
void

◆ setCurrentTimeStart()

advanced_testcase::setCurrentTimeStart ( )
inherited

Stores current time as the base for assertTimeCurrent().

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

Return values
intcurrent time

◆ setGuestUser()

static advanced_testcase::setGuestUser ( )
staticinherited

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

Return values
void

◆ setTimezone()

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

Change server and default php timezones.

Parameters
string$servertimezonetimezone to set in $CFG->timezone (not validated)
string$defaultphptimezonetimezone to fake default php timezone (must be valid)

◆ setUser()

static advanced_testcase::setUser (   $user = null)
staticinherited

Set current $USER, reset access cache.

Parameters
null | int | stdClass$useruser record, null or 0 means non-logged-in, positive integer means userid
Return values
void

◆ unassignUserCapability()

static externallib_advanced_testcase::unassignUserCapability (   $capability,
  $contextid = null,
  $roleid = null,
  $courseid = null,
  $enrol = 'manual' 
)
static

Unassign a capability to $USER.

Parameters
string$capabilitycapability name.
int$contextidset the context id if you used assignUserCapability.
int$roleidset the role id if you used assignUserCapability.
int$courseidset the course id if you used getDataGenerator->enrol_users.
string$enrolset the enrol plugin name if you used getDataGenerator->enrol_users with a different plugin than 'manual'.

◆ waitForSecond()

advanced_testcase::waitForSecond ( )
inherited

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: