Search moodle.org's
Developer Documentation

See Release Notes

  • Bug fixes for general core bugs in 4.2.x will end 22 April 2024 (12 months).
  • Bug fixes for security issues in 4.2.x will end 7 October 2024 (18 months).
  • PHP version: minimum PHP 8.0.0 Note: minimum PHP version has increased since Moodle 4.1. PHP 8.1.x is supported too.

Differences Between: [Versions 310 and 402] [Versions 311 and 402] [Versions 39 and 402] [Versions 400 and 402] [Versions 401 and 402] [Versions 402 and 403]

DML layer tests.

Copyright: 2008 Nicolas Connault
License: http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
File Size: 6419 lines (299 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 3 classes

dml_test:: (116 methods):
  setUp()
  get_test_table()
  unix_to_os_dirsep()
  test_diagnose()
  test_get_server_info()
  test_get_in_or_equal()
  test_fix_table_names()
  test_fix_sql_params()
  test_add_sql_debugging()
  test_sql_debugging_anon_class()
  get_site()
  test_strtok()
  test_tweak_param_names()
  test_get_tables()
  test_get_indexes()
  test_get_indexes_unique_mixed_nullability()
  test_get_columns()
  test_get_manager()
  test_setup_is_unicodedb()
  test_set_debug()
  test_execute()
  test_get_recordset()
  test_get_recordset_static()
  test_get_recordset_iterator_keys()
  test_get_recordset_list()
  test_get_recordset_select()
  test_get_recordset_sql()
  test_export_table_recordset()
  test_get_records()
  test_get_records_list()
  test_get_records_sql()
  test_get_records_menu()
  test_get_records_select_menu()
  test_get_records_sql_menu()
  test_get_record()
  test_get_record_select()
  test_get_record_sql()
  test_get_field()
  test_get_field_select()
  test_get_field_sql()
  test_get_fieldset_select()
  test_get_fieldset_sql()
  test_insert_record_raw()
  test_insert_record()
  test_insert_records()
  test_insert_record_with_nullable_unique_index()
  test_import_record()
  test_update_record_raw()
  test_update_record()
  test_set_field()
  test_set_field_select()
  test_count_records()
  test_count_records_select()
  test_count_records_sql()
  test_record_exists()
  test_record_exists_select()
  test_record_exists_sql()
  test_recordset_locks_delete()
  test_recordset_locks_update()
  test_delete_records()
  test_delete_records_select()
  test_delete_records_subquery()
  test_delete_records_list()
  test_object_params()
  test_sql_null_from_clause()
  test_sql_bitand()
  test_sql_bitnot()
  test_sql_bitor()
  test_sql_bitxor()
  test_sql_modulo()
  test_sql_ceil()
  test_cast_to_char()
  test_cast_char2int()
  test_cast_char2real()
  test_sql_compare_text()
  test_unique_index_collation_trouble()
  test_sql_equal()
  test_sql_like()
  test_sql_like_escape()
  test_coalesce()
  test_sql_concat()
  sql_concat_join_provider()
  test_concat_join()
  test_group_concat()
  test_group_concat_join_tables()
  test_sql_fullname()
  test_sql_order_by_text()
  test_sql_order_by_null()
  test_sql_substring()
  test_sql_length()
  test_sql_position()
  test_sql_empty()
  test_sql_isempty()
  test_sql_isnotempty()
  test_sql_regex()
  test_set_field_select_complicated()
  test_get_records_sql_complicated()
  test_replace_all_text()
  test_onelevel_commit()
  test_transaction_ignore_error_trouble()
  test_onelevel_rollback()
  test_nested_transactions()
  test_transactions_forbidden()
  test_wrong_transactions()
  test_concurent_transactions()
  test_session_locks()
  test_bound_param_types()
  test_bound_param_reserved()
  test_limits_and_offsets()
  test_invalid_limits_debugging()
  test_queries_counter()
  test_sql_intersect()
  test_four_byte_character_insertion()
  test_get_server_info_mysql()
  get_server_info_mysql_provider()
  test_get_server_info_dbfamily_mysql()

moodle_database_for_testing:: (36 methods):
  public_fix_table_names()
  driver_installed()
  get_dbfamily()
  get_dbtype()
  get_dblibrary()
  get_name()
  get_configuration_help()
  connect()
  get_server_info()
  allowed_param_types()
  get_last_error()
  get_tables()
  get_indexes()
  fetch_columns()
  normalise_value()
  set_debug()
  get_debug()
  change_database_structure()
  execute()
  get_recordset_sql()
  get_records_sql()
  get_fieldset_sql()
  insert_record_raw()
  insert_record()
  import_record()
  update_record_raw()
  update_record()
  set_field_select()
  delete_records_select()
  sql_concat()
  sql_concat_join()
  sql_group_concat()
  sql_substr()
  begin_transaction()
  commit_transaction()
  rollback_transaction()

dml_test_object_one:: (1 method):
  __toString()


Class: dml_test  - X-Ref

DML layer tests.

setUp()   X-Ref
No description

get_test_table($suffix = '')   X-Ref
Get a xmldb_table object for testing, deleting any existing table
of the same name, for example if one was left over from a previous test
run that crashed.

param: string $suffix table name suffix, use if you need more test tables
return: xmldb_table the table object.

unix_to_os_dirsep(string $source)   X-Ref
Convert a unix string to a OS (dir separator) dependent string.

param: string $source the original srting, using unix dir separators and newlines.
return: string the resulting string, using current OS dir separators newlines.

test_diagnose()   X-Ref
No description

test_get_server_info()   X-Ref
No description

test_get_in_or_equal()   X-Ref
No description

test_fix_table_names()   X-Ref
No description

test_fix_sql_params()   X-Ref
No description

test_add_sql_debugging()   X-Ref
Test the database debugging as SQL comment.


test_sql_debugging_anon_class()   X-Ref
Test the database debugging as SQL comment in anon class


get_site()   X-Ref
Just a test log function


test_strtok()   X-Ref
No description

test_tweak_param_names()   X-Ref
No description

test_get_tables()   X-Ref
No description

test_get_indexes()   X-Ref
No description

test_get_indexes_unique_mixed_nullability()   X-Ref
Let's verify get_indexes() when we mix null and not null columns in unique indexes.

Some databases, for unique indexes of this type, need to create function indexes to
provide cross-db behaviour. Here we check that those indexes don't break get_indexes().

Note that, strictly speaking, unique indexes on null columns are far from ideal. Both
conceptually and also in practice, because they cause DBs to use full scans in a
number of situations. But if we support them, we need to ensure get_indexes() work on them.

test_get_columns()   X-Ref
No description

test_get_manager()   X-Ref
No description

test_setup_is_unicodedb()   X-Ref
No description

test_set_debug()   X-Ref
No description

test_execute()   X-Ref
No description

test_get_recordset()   X-Ref
No description

test_get_recordset_static()   X-Ref
No description

test_get_recordset_iterator_keys()   X-Ref
No description

test_get_recordset_list()   X-Ref
No description

test_get_recordset_select()   X-Ref
No description

test_get_recordset_sql()   X-Ref
No description

test_export_table_recordset()   X-Ref
No description

test_get_records()   X-Ref
No description

test_get_records_list()   X-Ref
No description

test_get_records_sql()   X-Ref
No description

test_get_records_menu()   X-Ref
No description

test_get_records_select_menu()   X-Ref
No description

test_get_records_sql_menu()   X-Ref
No description

test_get_record()   X-Ref
No description

test_get_record_select()   X-Ref
No description

test_get_record_sql()   X-Ref
No description

test_get_field()   X-Ref
No description

test_get_field_select()   X-Ref
No description

test_get_field_sql()   X-Ref
No description

test_get_fieldset_select()   X-Ref
No description

test_get_fieldset_sql()   X-Ref
No description

test_insert_record_raw()   X-Ref
No description

test_insert_record()   X-Ref
No description

test_insert_records()   X-Ref
No description

test_insert_record_with_nullable_unique_index()   X-Ref
No description

test_import_record()   X-Ref
No description

test_update_record_raw()   X-Ref
No description

test_update_record()   X-Ref
No description

test_set_field()   X-Ref
No description

test_set_field_select()   X-Ref
No description

test_count_records()   X-Ref
No description

test_count_records_select()   X-Ref
No description

test_count_records_sql()   X-Ref
No description

test_record_exists()   X-Ref
No description

test_record_exists_select()   X-Ref
No description

test_record_exists_sql()   X-Ref
No description

test_recordset_locks_delete()   X-Ref
No description

test_recordset_locks_update()   X-Ref
No description

test_delete_records()   X-Ref
No description

test_delete_records_select()   X-Ref
No description

test_delete_records_subquery()   X-Ref
No description

test_delete_records_list()   X-Ref
No description

test_object_params()   X-Ref
No description

test_sql_null_from_clause()   X-Ref
No description

test_sql_bitand()   X-Ref
No description

test_sql_bitnot()   X-Ref
No description

test_sql_bitor()   X-Ref
No description

test_sql_bitxor()   X-Ref
No description

test_sql_modulo()   X-Ref
No description

test_sql_ceil()   X-Ref
No description

test_cast_to_char()   X-Ref
Test DML libraries sql_cast_to_char method


test_cast_char2int()   X-Ref
No description

test_cast_char2real()   X-Ref
No description

test_sql_compare_text()   X-Ref
No description

test_unique_index_collation_trouble()   X-Ref
No description

test_sql_equal()   X-Ref
No description

test_sql_like()   X-Ref
No description

test_sql_like_escape()   X-Ref
Test DML libraries sql_like_escape method


test_coalesce()   X-Ref
No description

test_sql_concat()   X-Ref
No description

sql_concat_join_provider()   X-Ref
No description

test_concat_join($concat, $fields, $params, $expected)   X-Ref

param: string $concat The string to use when concatanating.
param: array $fields The fields to concatanate
param: array $params Any parameters to provide to the query
param: @string $expected The expected result

test_group_concat()   X-Ref
Test DML libraries sql_group_contact method


test_group_concat_join_tables()   X-Ref
Test DML libraries sql_group_contact method joining tables, aggregating data from each


test_sql_fullname()   X-Ref
No description

test_sql_order_by_text()   X-Ref
No description

test_sql_order_by_null()   X-Ref
Test DML libraries sql_order_by_null method


test_sql_substring()   X-Ref
No description

test_sql_length()   X-Ref
No description

test_sql_position()   X-Ref
No description

test_sql_empty()   X-Ref
No description

test_sql_isempty()   X-Ref
No description

test_sql_isnotempty()   X-Ref
No description

test_sql_regex()   X-Ref
No description

test_set_field_select_complicated()   X-Ref
Test some complicated variations of set_field_select.


test_get_records_sql_complicated()   X-Ref
Test some more complex SQL syntax which moodle uses and depends on to work
useful to determine if new database libraries can be supported.


test_replace_all_text()   X-Ref
No description

test_onelevel_commit()   X-Ref
No description

test_transaction_ignore_error_trouble()   X-Ref
No description

test_onelevel_rollback()   X-Ref
No description

test_nested_transactions()   X-Ref
No description

test_transactions_forbidden()   X-Ref
No description

test_wrong_transactions()   X-Ref
No description

test_concurent_transactions()   X-Ref
No description

test_session_locks()   X-Ref
No description

test_bound_param_types()   X-Ref
No description

test_bound_param_reserved()   X-Ref
No description

test_limits_and_offsets()   X-Ref
No description

test_invalid_limits_debugging()   X-Ref
Test debugging messages about invalid limit number values.


test_queries_counter()   X-Ref
No description

test_sql_intersect()   X-Ref
No description

test_four_byte_character_insertion()   X-Ref
Test that the database has full utf8 support (4 bytes).


test_get_server_info_mysql(string $mysqliserverinfo, string $versionfromdb, bool $cfgversionfromdb, string $expecteddbversion)   X-Ref
Mock the methods used by {@see \mysqli_native_moodle_database::get_server_info()}.

Mocking allows to test it without the need of an actual MySQL-ish running DB server.

param: string $mysqliserverinfo A string representing the server info as provided by the MySQLi extension.
param: string $versionfromdb A string representing the result of VERSION function.
param: bool $cfgversionfromdb A boolean representing !empty($CFG->dboptions['versionfromdb']).
param: string $expecteddbversion A string representing the expected DB version.

get_server_info_mysql_provider()   X-Ref
Data provider to test {@see \mysqli_native_moodle_database::get_server_info} when mocking
the results of a connection to the DB server.

The set of the data is represented by the following array items:
- a string representing the server info as provided by the MySQLi extension
- a string representing the result of VERSION function
- a boolean representing !empty($CFG->dboptions['versionfromdb'])
- a string representing the expected DB version

return: array[]

test_get_server_info_dbfamily_mysql()   X-Ref
Test {@see \mysqli_native_moodle_database::get_server_info()} with the actual DB Server.


Class: moodle_database_for_testing  - X-Ref

This class is not a proper subclass of moodle_database. It is
intended to be used only in unit tests, in order to gain access to the
protected methods of moodle_database, and unit test them.

public_fix_table_names($sql)   X-Ref
No description

driver_installed()   X-Ref
No description

get_dbfamily()   X-Ref
No description

get_dbtype()   X-Ref
No description

get_dblibrary()   X-Ref
No description

get_name()   X-Ref
No description

get_configuration_help()   X-Ref
No description

connect($dbhost, $dbuser, $dbpass, $dbname, $prefix, array $dboptions=null)   X-Ref
No description

get_server_info()   X-Ref
No description

allowed_param_types()   X-Ref
No description

get_last_error()   X-Ref
No description

get_tables($usecache=true)   X-Ref
No description

get_indexes($table)   X-Ref
No description

fetch_columns(string $table)   X-Ref
No description

normalise_value($column, $value)   X-Ref
No description

set_debug($state)   X-Ref
No description

get_debug()   X-Ref
No description

change_database_structure($sql, $tablenames = null)   X-Ref
No description

execute($sql, array $params=null)   X-Ref
No description

get_recordset_sql($sql, array $params=null, $limitfrom=0, $limitnum=0)   X-Ref
No description

get_records_sql($sql, array $params=null, $limitfrom=0, $limitnum=0)   X-Ref
No description

get_fieldset_sql($sql, array $params=null)   X-Ref
No description

insert_record_raw($table, $params, $returnid=true, $bulk=false, $customsequence=false)   X-Ref
No description

insert_record($table, $dataobject, $returnid=true, $bulk=false)   X-Ref
No description

import_record($table, $dataobject)   X-Ref
No description

update_record_raw($table, $params, $bulk=false)   X-Ref
No description

update_record($table, $dataobject, $bulk=false)   X-Ref
No description

set_field_select($table, $newfield, $newvalue, $select, array $params=null)   X-Ref
No description

delete_records_select($table, $select, array $params=null)   X-Ref
No description

sql_concat()   X-Ref
No description

sql_concat_join($separator="' '", $elements=array()   X-Ref
No description

sql_group_concat(string $field, string $separator = ', ', string $sort = '')   X-Ref
No description

sql_substr($expr, $start, $length=false)   X-Ref
No description

begin_transaction()   X-Ref
No description

commit_transaction()   X-Ref
No description

rollback_transaction()   X-Ref
No description

Class: dml_test_object_one  - X-Ref

Dumb test class with toString() returning 1.

__toString()   X-Ref
No description