4 * Class CRM_Core_DAOTest
7 class CRM_Core_DAOTest
extends CiviUnitTestCase
{
9 const ABORTED_SQL
= "_aborted_sql_";
11 public function testGetReferenceColumns() {
12 // choose CRM_Core_DAO_Email as an arbitrary example
13 $emailRefs = CRM_Core_DAO_Email
::getReferenceColumns();
14 $refsByTarget = array();
15 foreach ($emailRefs as $refSpec) {
16 $refsByTarget[$refSpec->getTargetTable()] = $refSpec;
18 $this->assertTrue(array_key_exists('civicrm_contact', $refsByTarget));
19 $contactRef = $refsByTarget['civicrm_contact'];
20 $this->assertEquals('contact_id', $contactRef->getReferenceKey());
21 $this->assertEquals('id', $contactRef->getTargetKey());
22 $this->assertEquals('CRM_Core_Reference_Basic', get_class($contactRef));
25 public function testGetReferencesToTable() {
26 $refs = CRM_Core_DAO
::getReferencesToTable(CRM_Financial_DAO_FinancialType
::getTableName());
27 $refsBySource = array();
28 foreach ($refs as $refSpec) {
29 $refsBySource[$refSpec->getReferenceTable()] = $refSpec;
31 $this->assertTrue(array_key_exists('civicrm_entity_financial_account', $refsBySource));
32 $genericRef = $refsBySource['civicrm_entity_financial_account'];
33 $this->assertEquals('entity_id', $genericRef->getReferenceKey());
34 $this->assertEquals('entity_table', $genericRef->getTypeColumn());
35 $this->assertEquals('id', $genericRef->getTargetKey());
36 $this->assertEquals('CRM_Core_Reference_Dynamic', get_class($genericRef));
39 public function testFindReferences() {
41 'first_name' => 'Testy',
42 'last_name' => 'McScallion',
43 'contact_type' => 'Individual',
46 $contact = CRM_Contact_BAO_Contact
::add($params);
47 $this->assertNotNull($contact->id
);
50 'email' => 'spam@dev.null',
51 'contact_id' => $contact->id
,
53 'location_type_id' => 1,
56 $email = CRM_Core_BAO_Email
::add($params);
58 $refs = $contact->findReferences();
59 $refsByTable = array();
60 foreach ($refs as $refObj) {
61 $refsByTable[$refObj->__table
] = $refObj;
64 $this->assertTrue(array_key_exists('civicrm_email', $refsByTable));
65 $refDao = $refsByTable['civicrm_email'];
67 $this->assertEquals($contact->id
, $refDao->contact_id
);
73 public function composeQueryExamples() {
75 // $cases[] = array('Input-SQL', 'Input-Params', 'Expected-SQL');
77 $cases[0] = array('UPDATE civicrm_foo SET bar = %1', array(1 => array('', 'String')), 'UPDATE civicrm_foo SET bar = \'\'');
78 $cases[1] = array('UPDATE civicrm_foo SET bar = %1', array(1 => array('the text', 'String')), 'UPDATE civicrm_foo SET bar = \'the text\'');
79 $cases[2] = array('UPDATE civicrm_foo SET bar = %1', array(1 => array(NULL, 'String')), self
::ABORTED_SQL
);
80 $cases[3] = array('UPDATE civicrm_foo SET bar = %1', array(1 => array('null', 'String')), 'UPDATE civicrm_foo SET bar = NULL');
82 $cases[3] = array('UPDATE civicrm_foo SET bar = %1', array(1 => array('', 'Float')), self
::ABORTED_SQL
);
83 $cases[4] = array('UPDATE civicrm_foo SET bar = %1', array(1 => array('1.23', 'Float')), 'UPDATE civicrm_foo SET bar = 1.23');
84 $cases[5] = array('UPDATE civicrm_foo SET bar = %1', array(1 => array(NULL, 'Float')), self
::ABORTED_SQL
);
85 $cases[6] = array('UPDATE civicrm_foo SET bar = %1', array(1 => array('null', 'Float')), self
::ABORTED_SQL
);
87 $cases[11] = array('UPDATE civicrm_foo SET bar = %1', array(1 => array('', 'Money')), self
::ABORTED_SQL
);
88 $cases[12] = array('UPDATE civicrm_foo SET bar = %1', array(1 => array('1.23', 'Money')), 'UPDATE civicrm_foo SET bar = 1.23');
89 $cases[13] = array('UPDATE civicrm_foo SET bar = %1', array(1 => array(NULL, 'Money')), self
::ABORTED_SQL
);
90 $cases[14] = array('UPDATE civicrm_foo SET bar = %1', array(1 => array('null', 'Money')), self
::ABORTED_SQL
);
92 $cases[15] = array('UPDATE civicrm_foo SET bar = %1', array(1 => array('', 'Int')), self
::ABORTED_SQL
);
93 $cases[16] = array('UPDATE civicrm_foo SET bar = %1', array(1 => array('123', 'Int')), 'UPDATE civicrm_foo SET bar = 123');
94 $cases[17] = array('UPDATE civicrm_foo SET bar = %1', array(1 => array(NULL, 'Int')), self
::ABORTED_SQL
);
95 $cases[18] = array('UPDATE civicrm_foo SET bar = %1', array(1 => array('null', 'Int')), self
::ABORTED_SQL
);
97 $cases[19] = array('UPDATE civicrm_foo SET bar = %1', array(1 => array('', 'Timestamp')), 'UPDATE civicrm_foo SET bar = null');
98 $cases[20] = array('UPDATE civicrm_foo SET bar = %1', array(1 => array('20150102030405', 'Timestamp')), 'UPDATE civicrm_foo SET bar = 20150102030405');
99 $cases[21] = array('UPDATE civicrm_foo SET bar = %1', array(1 => array(NULL, 'Timestamp')), 'UPDATE civicrm_foo SET bar = null');
100 $cases[22] = array('UPDATE civicrm_foo SET bar = %1', array(1 => array('null', 'Timestamp')), self
::ABORTED_SQL
);
103 $cases[1000] = array(
104 'SELECT * FROM whatever',
106 'SELECT * FROM whatever',
109 // CASE: Integer param
110 $cases[1001] = array(
111 'SELECT * FROM whatever WHERE id = %1',
113 1 => array(10, 'Integer'),
115 'SELECT * FROM whatever WHERE id = 10',
118 // CASE: String param
119 $cases[1002] = array(
120 'SELECT * FROM whatever WHERE name = %1',
122 1 => array('Alice', 'String'),
124 'SELECT * FROM whatever WHERE name = \'Alice\'',
128 $cases[1003] = array(
129 'SELECT * FROM whatever WHERE name = %1 AND title = %2',
131 1 => array('Alice', 'String'),
132 2 => array('Bob', 'String'),
134 'SELECT * FROM whatever WHERE name = \'Alice\' AND title = \'Bob\'',
137 // CASE: Two params with special character (%1)
138 $cases[1004] = array(
139 'SELECT * FROM whatever WHERE name = %1 AND title = %2',
141 1 => array('Alice %2', 'String'),
142 2 => array('Bob', 'String'),
144 'SELECT * FROM whatever WHERE name = \'Alice %2\' AND title = \'Bob\'',
147 // CASE: Two params with special character ($1)
148 $cases[1005] = array(
149 'SELECT * FROM whatever WHERE name = %1 AND title = %2',
151 1 => array('Alice $1', 'String'),
152 2 => array('Bob', 'String'),
154 'SELECT * FROM whatever WHERE name = \'Alice $1\' AND title = \'Bob\'',
161 * @dataProvider composeQueryExamples
163 * @param $inputParams
166 public function testComposeQuery($inputSql, $inputParams, $expectSql) {
167 $scope = CRM_Core_TemporaryErrorScope
::useException();
169 $actualSql = CRM_Core_DAO
::composeQuery($inputSql, $inputParams);
171 catch (Exception
$e) {
172 $actualSql = self
::ABORTED_SQL
;
174 $this->assertEquals($expectSql, $actualSql);
178 * CASE: Two params where the %2 is already present in the query
179 * NOTE: This case should rightly FAIL, as using strstr in the replace mechanism will turn
180 * the query into: SELECT * FROM whatever WHERE name = 'Alice' AND title = 'Bob' AND year LIKE ''Bob'012'
181 * So, to avoid such ERROR, the query should be framed like:
182 * 'SELECT * FROM whatever WHERE name = %1 AND title = %3 AND year LIKE '%2012'
183 * $params[3] = array('Bob', 'String');
184 * i.e. the place holder should be unique and should not contain in any other operational use in query
186 public function testComposeQueryFailure() {
188 'SELECT * FROM whatever WHERE name = %1 AND title = %2 AND year LIKE \'%2012\' ',
190 1 => array('Alice', 'String'),
191 2 => array('Bob', 'String'),
193 'SELECT * FROM whatever WHERE name = \'Alice\' AND title = \'Bob\' AND year LIKE \'%2012\' ',
195 list($inputSql, $inputParams, $expectSql) = $cases[0];
196 $actualSql = CRM_Core_DAO
::composeQuery($inputSql, $inputParams);
197 $this->assertFalse(($expectSql == $actualSql));
204 public function sqlNameDataProvider() {
206 array('this is a long string', 30, FALSE, 'this is a long string'),
208 'this is an even longer string which is exactly 60 character',
211 'this is an even longer string which is exactly 60 character',
214 'this is an even longer string which is exactly 60 character',
217 'this is an even longer string which is exactly 60 character',
220 'this is an even longer string which is a bit more than 60 character',
223 'this is an even longer string which is a bit more than 60 ch',
226 'this is an even longer string which is a bit more than 60 character',
229 'this is an even longer string which is a bit more th_c1cbd519',
235 * @dataProvider sqlNameDataProvider
239 * @param $expectedResult
241 public function testShortenSQLName($inputData, $length, $makeRandom, $expectedResult) {
242 $this->assertEquals($expectedResult, CRM_Core_DAO
::shortenSQLName($inputData, $length, $makeRandom));
245 public function testFindById() {
246 $params = $this->sampleContact('Individual', 4);
247 $existing_contact = CRM_Contact_BAO_Contact
::add($params);
248 $contact = CRM_Contact_BAO_Contact
::findById($existing_contact->id
);
249 $this->assertEquals($existing_contact->id
, $contact->id
);
250 $deleted_contact_id = $existing_contact->id
;
251 CRM_Contact_BAO_Contact
::deleteContact($contact->id
, FALSE, TRUE);
252 $exception_thrown = FALSE;
254 $deleted_contact = CRM_Contact_BAO_Contact
::findById($deleted_contact_id);
256 catch (Exception
$e) {
257 $exception_thrown = TRUE;
259 $this->assertTrue($exception_thrown);
263 * requireSafeDBName() method (to check valid database name)
265 public function testRequireSafeDBName() {
271 'test12db34' => TRUE,
272 'test_12_db34' => TRUE,
276 'testdb;Delete test' => FALSE,
278 'test#$%^&*' => FALSE,
280 $testDetails = array();
281 foreach ($databases as $database => $val) {
282 $this->assertEquals(CRM_Core_DAO
::requireSafeDBName($database), $val);
287 * Test the function designed to find myIsam tables.
289 public function testMyISAMCheck() {
290 // Cleanup previous, failed tests.
291 CRM_Core_DAO
::executeQuery('DROP TABLE IF EXISTS civicrm_my_isam');
293 // A manually created MyISAM table should raise a redflag.
294 $this->assertEquals(0, CRM_Core_DAO
::isDBMyISAM());
295 CRM_Core_DAO
::executeQuery('CREATE TABLE civicrm_my_isam (`id` int(10) unsigned NOT NULL) ENGINE = MyISAM');
296 $this->assertEquals(1, CRM_Core_DAO
::isDBMyISAM());
297 CRM_Core_DAO
::executeQuery('DROP TABLE civicrm_my_isam');
299 // A temp table should not raise flag (static naming).
300 $tempName = CRM_Core_DAO
::createTempTableName('civicrm', FALSE);
301 $this->assertEquals(0, CRM_Core_DAO
::isDBMyISAM());
302 CRM_Core_DAO
::executeQuery("CREATE TABLE $tempName (`id` int(10) unsigned NOT NULL) ENGINE = MyISAM");
303 // Ignore temp tables
304 $this->assertEquals(0, CRM_Core_DAO
::isDBMyISAM());
305 CRM_Core_DAO
::executeQuery("DROP TABLE $tempName");
307 // A temp table should not raise flag (randomized naming).
308 $tempName = CRM_Core_DAO
::createTempTableName('civicrm', TRUE);
309 $this->assertEquals(0, CRM_Core_DAO
::isDBMyISAM());
310 CRM_Core_DAO
::executeQuery("CREATE TABLE $tempName (`id` int(10) unsigned NOT NULL) ENGINE = MyISAM");
311 // Ignore temp tables
312 $this->assertEquals(0, CRM_Core_DAO
::isDBMyISAM());
313 CRM_Core_DAO
::executeQuery("DROP TABLE $tempName");
317 * CRM-19930: Test toArray() function with $format param
319 public function testDAOtoArray() {
320 $format = 'user[%s]';
322 'first_name' => 'Testy',
323 'last_name' => 'McScallion',
324 'contact_type' => 'Individual',
327 $dao = CRM_Contact_BAO_Contact
::add($params);
328 $query = "SELECT contact_type, display_name FROM civicrm_contact WHERE id={$dao->id}";
330 'contact_type' => 'Individual',
331 'display_name' => 'Testy McScallion',
333 $modifiedKeyArray = array();
334 foreach ($toArray as $k => $v) {
335 $modifiedKeyArray[sprintf($format, $k)] = $v;
338 $dao = CRM_Core_DAO
::executeQuery($query);
339 while ($dao->fetch()) {
340 $daoToArray = $dao->toArray();
341 $this->checkArrayEquals($toArray, $daoToArray);
342 $daoToArray = $dao->toArray($format);
343 $this->checkArrayEquals($modifiedKeyArray, $daoToArray);
348 * CRM-17748: Test internal DAO options
350 public function testDBOptions() {
351 $contactIDs = array();
352 for ($i = 0; $i < 10; $i++
) {
353 $contactIDs[] = $this->individualCreate(array(
354 'first_name' => 'Alan' . substr(sha1(rand()), 0, 7),
355 'last_name' => 'Smith' . substr(sha1(rand()), 0, 4),
359 // Test option 'result_buffering'
360 $this->_testMemoryUsageForUnbufferedQuery();
363 foreach ($contactIDs as $contactID) {
364 $this->callAPISuccess('Contact', 'delete', array('id' => $contactID));
369 * Helper function to test result of buffered and unbuffered query
371 public function _testMemoryUsageForUnbufferedQuery() {
372 $sql = "SELECT * FROM civicrm_contact WHERE first_name LIKE 'Alan%' AND last_name LIKE 'Smith%' ";
374 $dao = CRM_Core_DAO
::executeQuery($sql);
375 $contactsFetchedFromBufferedQuery = $dao->fetchAll();
377 $dao = CRM_Core_DAO
::executeUnbufferedQuery($sql);
378 $contactsFetchedFromUnbufferedQuery = $dao->fetchAll();
380 $this->checkArrayEquals($contactsFetchedFromBufferedQuery, $contactsFetchedFromUnbufferedQuery);
384 * Test that known sql modes are present in session.
386 public function testSqlModePresent() {
387 $sqlModes = CRM_Utils_SQL
::getSqlModes();
388 // assert we have strict trans
389 $this->assertContains('STRICT_TRANS_TABLES', $sqlModes);
390 if (CRM_Utils_SQL
::supportsFullGroupBy()) {
391 $this->assertContains('ONLY_FULL_GROUP_BY', $sqlModes);
398 public function serializationMethods() {
399 $constants = array();
402 array('Foo', 'Bar', '3', '4', '5'),
406 $complexData = array(
409 'baz' => array('1', '2', '3', array('one', 'two')),
413 $daoInfo = new ReflectionClass('CRM_Core_DAO');
414 foreach ($daoInfo->getConstants() as $constant => $val) {
415 if ($constant == 'SERIALIZE_JSON' ||
$constant == 'SERIALIZE_PHP') {
416 $constants[] = array($val, array_merge($simpleData, $complexData));
418 elseif (strpos($constant, 'SERIALIZE_') === 0) {
419 $constants[] = array($val, $simpleData);
425 public function testFetchGeneratorDao() {
426 $this->individualCreate([], 0);
427 $this->individualCreate([], 1);
428 $this->individualCreate([], 2);
430 $g = CRM_Core_DAO
::executeQuery('SELECT contact_type FROM civicrm_contact WHERE contact_type = "Individual" LIMIT 3')
432 foreach ($g as $row) {
433 $this->assertEquals('Individual', $row->contact_type
);
436 $this->assertEquals(3, $count);
439 public function testFetchGeneratorArray() {
440 $this->individualCreate([], 0);
441 $this->individualCreate([], 1);
442 $this->individualCreate([], 2);
444 $g = CRM_Core_DAO
::executeQuery('SELECT contact_type FROM civicrm_contact WHERE contact_type = "Individual" LIMIT 3')
445 ->fetchGenerator('array');
446 foreach ($g as $row) {
447 $this->assertEquals('Individual', $row['contact_type']);
450 $this->assertEquals(3, $count);
454 * @dataProvider serializationMethods
456 public function testFieldSerialization($method, $sampleData) {
457 foreach ($sampleData as $value) {
458 $serialized = CRM_Core_DAO
::serializeField($value, $method);
459 $newValue = CRM_Core_DAO
::unSerializeField($serialized, $method);
460 $this->assertEquals($value, $newValue);
465 * Test the DAO cloning method does not hit issues with freeing the result.
467 public function testCloneDAO() {
468 $dao = CRM_Core_DAO
::executeQuery('SELECT * FROM civicrm_domain');
470 while ($dao->fetch()) {
472 $cloned = clone($dao);
475 $this->assertEquals(2, $i);