MediaWiki  REL1_31
DatabaseTestHelper.php
Go to the documentation of this file.
1 <?php
2 
6 
12 
17  protected $testName = [];
18 
24  protected $lastSqls = [];
25 
27  protected $nextResult = [];
28 
30  protected $nextError = null;
32  protected $lastError = null;
33 
38  protected $tablesExists;
39 
43  protected $unionSupportsOrderAndLimit = true;
44 
45  public function __construct( $testName, array $opts = [] ) {
46  $this->testName = $testName;
47 
48  $this->profiler = new ProfilerStub( [] );
49  $this->trxProfiler = new TransactionProfiler();
50  $this->cliMode = isset( $opts['cliMode'] ) ? $opts['cliMode'] : true;
51  $this->connLogger = new \Psr\Log\NullLogger();
52  $this->queryLogger = new \Psr\Log\NullLogger();
53  $this->errorLogger = function ( Exception $e ) {
54  wfWarn( get_class( $e ) . ": {$e->getMessage()}" );
55  };
56  $this->deprecationLogger = function ( $msg ) {
57  wfWarn( $msg );
58  };
59  $this->currentDomain = DatabaseDomain::newUnspecified();
60  $this->open( 'localhost', 'testuser', 'password', 'testdb' );
61  }
62 
68  public function getLastSqls() {
69  $lastSqls = implode( '; ', $this->lastSqls );
70  $this->lastSqls = [];
71 
72  return $lastSqls;
73  }
74 
75  public function setExistingTables( $tablesExists ) {
76  $this->tablesExists = (array)$tablesExists;
77  }
78 
82  public function forceNextResult( $res ) {
83  $this->nextResult = $res;
84  }
85 
92  public function forceNextQueryError( $errno, $error, $options = [] ) {
93  $this->nextError = [ 'errno' => $errno, 'error' => $error ] + $options;
94  }
95 
96  protected function addSql( $sql ) {
97  // clean up spaces before and after some words and the whole string
98  $this->lastSqls[] = trim( preg_replace(
99  '/\s{2,}(?=FROM|WHERE|GROUP BY|ORDER BY|LIMIT)|(?<=SELECT|INSERT|UPDATE)\s{2,}/',
100  ' ', $sql
101  ) );
102  }
103 
104  protected function checkFunctionName( $fname ) {
105  if ( $fname === 'Wikimedia\\Rdbms\\Database::close' ) {
106  return; // no $fname parameter
107  }
108 
109  // Handle some internal calls from the Database class
110  $check = $fname;
111  if ( preg_match( '/^Wikimedia\\\\Rdbms\\\\Database::query \‍((.+)\‍)$/', $fname, $m ) ) {
112  $check = $m[1];
113  }
114 
115  if ( substr( $check, 0, strlen( $this->testName ) ) !== $this->testName ) {
116  throw new MWException( 'function name does not start with test class. ' .
117  $fname . ' vs. ' . $this->testName . '. ' .
118  'Please provide __METHOD__ to database methods.' );
119  }
120  }
121 
122  function strencode( $s ) {
123  // Choose apos to avoid handling of escaping double quotes in quoted text
124  return str_replace( "'", "\'", $s );
125  }
126 
127  public function addIdentifierQuotes( $s ) {
128  // no escaping to avoid handling of double quotes in quoted text
129  return $s;
130  }
131 
132  public function query( $sql, $fname = '', $tempIgnore = false ) {
133  $this->checkFunctionName( $fname );
134 
135  return parent::query( $sql, $fname, $tempIgnore );
136  }
137 
138  public function tableExists( $table, $fname = __METHOD__ ) {
139  $tableRaw = $this->tableName( $table, 'raw' );
140  if ( isset( $this->sessionTempTables[$tableRaw] ) ) {
141  return true; // already known to exist
142  }
143 
144  $this->checkFunctionName( $fname );
145 
146  return in_array( $table, (array)$this->tablesExists );
147  }
148 
149  // Redeclare parent method to make it public
150  public function nativeReplace( $table, $rows, $fname ) {
151  return parent::nativeReplace( $table, $rows, $fname );
152  }
153 
154  function getType() {
155  return 'test';
156  }
157 
158  function open( $server, $user, $password, $dbName ) {
159  $this->conn = (object)[ 'test' ];
160 
161  return true;
162  }
163 
164  function fetchObject( $res ) {
165  return false;
166  }
167 
168  function fetchRow( $res ) {
169  return false;
170  }
171 
172  function numRows( $res ) {
173  return -1;
174  }
175 
176  function numFields( $res ) {
177  return -1;
178  }
179 
180  function fieldName( $res, $n ) {
181  return 'test';
182  }
183 
184  function insertId() {
185  return -1;
186  }
187 
188  function dataSeek( $res, $row ) {
189  /* nop */
190  }
191 
192  function lastErrno() {
193  return $this->lastError ? $this->lastError['errno'] : -1;
194  }
195 
196  function lastError() {
197  return $this->lastError ? $this->lastError['error'] : 'test';
198  }
199 
200  protected function wasKnownStatementRollbackError() {
201  return isset( $this->lastError['wasKnownStatementRollbackError'] )
202  ? $this->lastError['wasKnownStatementRollbackError']
203  : false;
204  }
205 
206  function fieldInfo( $table, $field ) {
207  return false;
208  }
209 
210  function indexInfo( $table, $index, $fname = 'Database::indexInfo' ) {
211  return false;
212  }
213 
215  return -1;
216  }
217 
218  function getSoftwareLink() {
219  return 'test';
220  }
221 
222  function getServerVersion() {
223  return 'test';
224  }
225 
226  function getServerInfo() {
227  return 'test';
228  }
229 
230  function isOpen() {
231  return $this->conn ? true : false;
232  }
233 
234  function ping( &$rtt = null ) {
235  $rtt = 0.0;
236  return true;
237  }
238 
239  protected function closeConnection() {
240  return true;
241  }
242 
243  protected function doQuery( $sql ) {
244  $sql = preg_replace( '< /\* .+? \*/>', '', $sql );
245  $this->addSql( $sql );
246 
247  if ( $this->nextError ) {
248  $this->lastError = $this->nextError;
249  $this->nextError = null;
250  return false;
251  }
252 
254  $this->nextResult = [];
255  $this->lastError = null;
256 
257  return new FakeResultWrapper( $res );
258  }
259 
260  public function unionSupportsOrderAndLimit() {
262  }
263 
264  public function setUnionSupportsOrderAndLimit( $v ) {
265  $this->unionSupportsOrderAndLimit = (bool)$v;
266  }
267 }
DatabaseTestHelper\$testName
$testName
CLASS of the test suite, used to determine, if the function name is passed every time to query()
Definition: DatabaseTestHelper.php:17
DatabaseTestHelper\getType
getType()
Get the type of the DBMS, as it appears in $wgDBtype.
Definition: DatabaseTestHelper.php:154
DatabaseTestHelper\setUnionSupportsOrderAndLimit
setUnionSupportsOrderAndLimit( $v)
Definition: DatabaseTestHelper.php:264
Wikimedia\Rdbms\Database
Relational database abstraction object.
Definition: Database.php:48
object
globals will be eliminated from MediaWiki replaced by an application object which would be passed to constructors Whether that would be an convenient solution remains to be but certainly PHP makes such object oriented programming models easier than they were in previous versions For the time being MediaWiki programmers will have to work in an environment with some global context At the time of globals were initialised on startup by MediaWiki of these were configuration which are documented in DefaultSettings php There is no comprehensive documentation for the remaining however some of the most important ones are listed below They are typically initialised either in index php or in Setup php For a description of the see design txt $wgTitle Title object created from the request URL $wgOut OutputPage object for HTTP response $wgUser User object for the user associated with the current request $wgLang Language object selected by user preferences $wgContLang Language object associated with the wiki being viewed $wgParser Parser object Parser extensions register their hooks here $wgRequest WebRequest object
Definition: globals.txt:64
use
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
Definition: APACHE-LICENSE-2.0.txt:10
$rows
do that in ParserLimitReportFormat instead use this to modify the parameters of the image all existing parser cache entries will be invalid To avoid you ll need to handle that somehow(e.g. with the RejectParserCacheValue hook) because MediaWiki won 't do it for you. & $defaults also a ContextSource after deleting those rows but within the same transaction $rows
Definition: hooks.txt:2783
DatabaseTestHelper\isOpen
isOpen()
Is a connection to the database open?
Definition: DatabaseTestHelper.php:230
array
the array() calling protocol came about after MediaWiki 1.4rc1.
DatabaseTestHelper\numFields
numFields( $res)
Get the number of fields in a result object.
Definition: DatabaseTestHelper.php:176
DatabaseTestHelper\fieldInfo
fieldInfo( $table, $field)
mysql_fetch_field() wrapper Returns false if the field doesn't exist
Definition: DatabaseTestHelper.php:206
Wikimedia\Rdbms\Database\$password
string $password
Password used to establish the current connection.
Definition: Database.php:83
DatabaseTestHelper\getLastSqls
getLastSqls()
Returns SQL queries grouped by '; ' Clear the list of queries that have been done so far.
Definition: DatabaseTestHelper.php:68
ProfilerStub
Stub profiler that does nothing.
Definition: ProfilerStub.php:29
$s
$s
Definition: mergeMessageFileList.php:187
DatabaseTestHelper\$nextError
array null $nextError
Definition: DatabaseTestHelper.php:30
$res
$res
Definition: database.txt:21
DatabaseTestHelper\doQuery
doQuery( $sql)
Run a query and return a DBMS-dependent wrapper (that has all IResultWrapper methods)
Definition: DatabaseTestHelper.php:243
true
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped noclasses just before the function returns a value If you return true
Definition: hooks.txt:2006
php
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition: injection.txt:37
DatabaseTestHelper\nativeReplace
nativeReplace( $table, $rows, $fname)
REPLACE query wrapper for MySQL and SQLite, which have a native REPLACE statement.
Definition: DatabaseTestHelper.php:150
DatabaseTestHelper\$nextResult
array $nextResult
List of row arrays.
Definition: DatabaseTestHelper.php:27
DatabaseTestHelper\fetchRow
fetchRow( $res)
Fetch the next row from the given result object, in associative array form.
Definition: DatabaseTestHelper.php:168
DatabaseTestHelper\$lastError
array null $lastError
Definition: DatabaseTestHelper.php:32
DatabaseTestHelper\wasKnownStatementRollbackError
wasKnownStatementRollbackError()
Definition: DatabaseTestHelper.php:200
DatabaseTestHelper\tableExists
tableExists( $table, $fname=__METHOD__)
Query whether a given table exists.
Definition: DatabaseTestHelper.php:138
DatabaseTestHelper\forceNextQueryError
forceNextQueryError( $errno, $error, $options=[])
Definition: DatabaseTestHelper.php:92
DatabaseTestHelper\getSoftwareLink
getSoftwareLink()
Returns a wikitext link to the DB's website, e.g., return "[https://www.mysql.com/ MySQL]"; Should at...
Definition: DatabaseTestHelper.php:218
MWException
MediaWiki exception.
Definition: MWException.php:26
DatabaseTestHelper\strencode
strencode( $s)
Wrapper for addslashes()
Definition: DatabaseTestHelper.php:122
DatabaseTestHelper\unionSupportsOrderAndLimit
unionSupportsOrderAndLimit()
Returns true if current database backend supports ORDER BY or LIMIT for separate subqueries within th...
Definition: DatabaseTestHelper.php:260
DatabaseTestHelper\lastError
lastError()
Get a description of the last error.
Definition: DatabaseTestHelper.php:196
Wikimedia\Rdbms\Database\$user
string $user
User that this instance is currently connected under the name of.
Definition: Database.php:81
DatabaseTestHelper\$tablesExists
$tablesExists
Array of tables to be considered as existing by tableExist() Use setExistingTables() to alter.
Definition: DatabaseTestHelper.php:38
DatabaseTestHelper\setExistingTables
setExistingTables( $tablesExists)
Definition: DatabaseTestHelper.php:75
query
For a write query
Definition: database.txt:26
DatabaseTestHelper\query
query( $sql, $fname='', $tempIgnore=false)
Run an SQL query and return the result.
Definition: DatabaseTestHelper.php:132
$fname
if(defined( 'MW_SETUP_CALLBACK')) $fname
Customization point after all loading (constants, functions, classes, DefaultSettings,...
Definition: Setup.php:112
$options
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped & $options
Definition: hooks.txt:2001
DatabaseTestHelper\ping
ping(&$rtt=null)
Ping the server and try to reconnect if it there is no connection.
Definition: DatabaseTestHelper.php:234
DatabaseTestHelper\numRows
numRows( $res)
Get the number of rows in a result object.
Definition: DatabaseTestHelper.php:172
DatabaseTestHelper\getServerInfo
getServerInfo()
A string describing the current software version, and possibly other details in a user-friendly way.
Definition: DatabaseTestHelper.php:226
DatabaseTestHelper\getServerVersion
getServerVersion()
A string describing the current software version, like from mysql_get_server_info().
Definition: DatabaseTestHelper.php:222
DatabaseTestHelper\addIdentifierQuotes
addIdentifierQuotes( $s)
Quotes an identifier using backticks or "double quotes" depending on the database type.
Definition: DatabaseTestHelper.php:127
Wikimedia\Rdbms\Database\tableName
tableName( $name, $format='quoted')
Format a table name ready for use in constructing an SQL query.
Definition: Database.php:2212
DatabaseTestHelper\insertId
insertId()
Get the inserted value of an auto-increment row.
Definition: DatabaseTestHelper.php:184
DatabaseTestHelper\checkFunctionName
checkFunctionName( $fname)
Definition: DatabaseTestHelper.php:104
DatabaseTestHelper\fetchAffectedRowCount
fetchAffectedRowCount()
Definition: DatabaseTestHelper.php:214
DatabaseTestHelper\dataSeek
dataSeek( $res, $row)
Change the position of the cursor in a result object.
Definition: DatabaseTestHelper.php:188
DatabaseTestHelper
Helper for testing the methods from the Database class.
Definition: DatabaseTestHelper.php:11
DatabaseTestHelper\fieldName
fieldName( $res, $n)
Get a field name in a result object.
Definition: DatabaseTestHelper.php:180
DatabaseTestHelper\addSql
addSql( $sql)
Definition: DatabaseTestHelper.php:96
DatabaseTestHelper\indexInfo
indexInfo( $table, $index, $fname='Database::indexInfo')
Get information about an index into an object.
Definition: DatabaseTestHelper.php:210
DatabaseTestHelper\$lastSqls
$lastSqls
Array of lastSqls passed to query(), This is an array since some methods in Database can do more than...
Definition: DatabaseTestHelper.php:24
DatabaseTestHelper\forceNextResult
forceNextResult( $res)
Definition: DatabaseTestHelper.php:82
Wikimedia\Rdbms\Database\$server
string $server
Server that this instance is currently connected to.
Definition: Database.php:79
DatabaseTestHelper\open
open( $server, $user, $password, $dbName)
Open a new connection to the database (closing any existing one)
Definition: DatabaseTestHelper.php:158
DatabaseTestHelper\closeConnection
closeConnection()
Closes underlying database connection.
Definition: DatabaseTestHelper.php:239
DatabaseTestHelper\$unionSupportsOrderAndLimit
$unionSupportsOrderAndLimit
Value to return from unionSupportsOrderAndLimit()
Definition: DatabaseTestHelper.php:43
wfWarn
wfWarn( $msg, $callerOffset=1, $level=E_USER_NOTICE)
Send a warning either to the debug log or in a PHP error depending on $wgDevelopmentWarnings.
Definition: GlobalFunctions.php:1137
DatabaseTestHelper\fetchObject
fetchObject( $res)
Fetch the next row from the given result object, in object form.
Definition: DatabaseTestHelper.php:164
DatabaseTestHelper\__construct
__construct( $testName, array $opts=[])
Definition: DatabaseTestHelper.php:45
Wikimedia\Rdbms\DatabaseDomain
Class to handle database/prefix specification for IDatabase domains.
Definition: DatabaseDomain.php:28
Wikimedia\Rdbms\TransactionProfiler
Helper class that detects high-contention DB queries via profiling calls.
Definition: TransactionProfiler.php:38
DatabaseTestHelper\lastErrno
lastErrno()
Get the last error number.
Definition: DatabaseTestHelper.php:192
$e
div flags Integer display flags(NO_ACTION_LINK, NO_EXTRA_USER_LINKS) 'LogException' returning false will NOT prevent logging $e
Definition: hooks.txt:2171
Wikimedia\Rdbms\Database\$dbName
string $dbName
Database that this instance is currently connected to.
Definition: Database.php:85