Special test case for testing of DML drivers and DDL layer. More...

Inheritance diagram for database_driver_testcase:

Public Member Functions
	__construct ($name=null)
	Constructs a test case with the given name.

	assertDebuggingCalled ($debugmessage=null, $debuglevel=null, $message='')
	Assert that exactly debugging was just called once.

	assertDebuggingNotCalled ($message='')
	Call when no debugging() messages expected.

	assertEqualsIgnoringWhitespace ($expected, $actual, string $message='')
	Assert that two Date/Time strings are equal.

	check_debugging ()

	getDebuggingMessages ()
	Return debugging messages from the current test.

	isInIsolation ()
	Determine whether the test is running in isolation.

	resetDebugging ()
	Clear all previous debugging messages in current test.

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	loadHTML (string $actual)
	Load HTML into a DomDocument.

static	setUpBeforeClass ()

static	tearDownAfterClass ()

Protected Member Functions
	setup_extradb ()

	teardown_extradb ()

Static Protected Member Functions
static	get_invokable ()
	Get an invokable object for testing.

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	getInvocationCount (InvocationOrder $counter)
	Helper to get the count of invocation.

static	getNodeText (DOMNode $node)
	Get the text value of this node's child text node.

Protected Attributes
moodle_database	$tdb
	used in these tests

Detailed Description

Special test case for testing of DML drivers and DDL layer.

Copyright: 2012 Petr Skoda

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

Note: Use only 'test_table*' names when creating new tables.

For DML/DDL developers: you can add following settings to config.php if you want to test different driver than the main one, the reason is to allow testing of incomplete drivers that do not allow full PHPUnit environment initialisation (the database can be empty). $CFG->phpunit_extra_drivers = array( 1=>array('dbtype'=>'mysqli', 'dbhost'=>'localhost', 'dbname'=>'moodle', 'dbuser'=>'root', 'dbpass'=>'', 'prefix'=>'phpu2_'), 2=>array('dbtype'=>'pgsql', 'dbhost'=>'localhost', 'dbname'=>'moodle', 'dbuser'=>'postgres', 'dbpass'=>'', 'prefix'=>'phpu2_'), 3=>array('dbtype'=>'sqlsrv', 'dbhost'=>'127.0.0.1', 'dbname'=>'moodle', 'dbuser'=>'sa', 'dbpass'=>'', 'prefix'=>'phpu2_'), ); define('PHPUNIT_TEST_DRIVER')=1; //number is index in the previous array

Copyright: 2012 Petr Skoda

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

Constructor & Destructor Documentation

◆ __construct()

database_driver_testcase::__construct ( $name = null )

final

Constructs a test case with the given name.

Parameters

string $name

Member Function Documentation

◆ assertDebuggingCalled()

database_driver_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

◆ assertDebuggingNotCalled()

database_driver_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

◆ 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

◆ 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

◆ 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

◆ get_invokable()

static base_testcase::get_invokable ( )

staticprotectedinherited

Get an invokable object for testing.

This is a helper method to create an invokable object for testing which can be used to track invocations, including arguments provided.

This can be useful for modifications to the error handler.

Return values

object

◆ getDebuggingMessages()

database_driver_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

◆ getInvocationCount()

static base_testcase::getInvocationCount ( InvocationOrder $counter )

staticprotectedinherited

Helper to get the count of invocation.

This is required because the method to use changed names in PHPUnit 10.0 in a breaking change.

Parameters

PHPUnit::Framework::MockObject::Rule::InvocationOrder $counter

Return values

int

◆ 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

◆ isInIsolation()

base_testcase::isInIsolation ( )

inherited

Determine whether the test is running in isolation.

Note: This was previously a public method of the TestCase, but as removed in PHPUnit 10. There is no direct replacement, but we can use reflection to access the protected property.

Return values

bool

◆ loadHTML()

static base_testcase::loadHTML ( string $actual )

staticinherited

Load HTML into a DomDocument.

Note: THis is a replacement for functionality removed from PHPUnit 10.

Parameters

string $actual

Exceptions

PHPUnit::Util::Xml::XmlException

Return values

DOMDocument

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

lib/phpunit/classes/database_driver_testcase.php

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ assertDebuggingCalled()

◆ assertDebuggingNotCalled()

◆ assertEqualsIgnoringWhitespace()

◆ assertNotTag()

◆ assertTag()

◆ assertValidKeys()

◆ findNodes()

◆ get_invokable()

◆ getDebuggingMessages()

◆ getDescendants()

◆ getElementsByCaseInsensitiveTagName()

◆ getInvocationCount()

◆ getNodeText()

◆ isInIsolation()

◆ loadHTML()