3 * File for the CiviUnitTestCase class
7 * @copyright Copyright CiviCRM LLC (C) 2009
8 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html
9 * GNU Affero General Public License version 3
12 * This file is part of CiviCRM
14 * CiviCRM is free software; you can redistribute it and/or
15 * modify it under the terms of the GNU Affero General Public License
16 * as published by the Free Software Foundation; either version 3 of
17 * the License, or (at your option) any later version.
19 * CiviCRM is distributed in the hope that it will be useful,
20 * but WITHOUT ANY WARRANTY; without even the implied warranty of
21 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
22 * GNU Affero General Public License for more details.
24 * You should have received a copy of the GNU Affero General Public
25 * License along with this program. If not, see
26 * <http://www.gnu.org/licenses/>.
29 use Civi\Payment\System
;
32 * Include configuration
34 define('CIVICRM_SETTINGS_PATH', __DIR__
. '/civicrm.settings.dist.php');
35 define('CIVICRM_SETTINGS_LOCAL_PATH', __DIR__
. '/civicrm.settings.local.php');
37 if (file_exists(CIVICRM_SETTINGS_LOCAL_PATH
)) {
38 require_once CIVICRM_SETTINGS_LOCAL_PATH
;
40 require_once CIVICRM_SETTINGS_PATH
;
42 * Include class definitions
44 require_once 'tests/phpunit/Utils.php';
45 require_once 'api/api.php';
46 require_once 'CRM/Financial/BAO/FinancialType.php';
47 define('API_LATEST_VERSION', 3);
50 * Base class for CiviCRM unit tests
52 * This class supports two (mutually-exclusive) techniques for cleaning up test data. Subclasses
53 * may opt for one or neither:
55 * 1. quickCleanup() is a helper which truncates a series of tables. Call quickCleanup()
56 * as part of setUp() and/or tearDown(). quickCleanup() is thorough - but it can
57 * be cumbersome to use (b/c you must identify the tables to cleanup) and slow to execute.
58 * 2. useTransaction() executes the test inside a transaction. It's easier to use
59 * (because you don't need to identify specific tables), but it doesn't work for tests
60 * which manipulate schema or truncate data -- and could behave inconsistently
61 * for tests which specifically examine DB transactions.
63 * Common functions for unit tests
66 class CiviUnitTestCase
extends PHPUnit_Extensions_Database_TestCase
{
69 * Api version - easier to override than just a define
71 protected $_apiversion = API_LATEST_VERSION
;
73 * Database has been initialized.
77 private static $dbInit = FALSE;
80 * Database connection.
82 * @var PHPUnit_Extensions_Database_DB_IDatabaseConnection
91 static protected $_dbName;
94 * Track tables we have modified during a test.
96 protected $_tablesToTruncate = array();
99 * @var array of temporary directory names
104 * @var Utils instance
106 public static $utils;
109 * @var boolean populateOnce allows to skip db resets in setUp
111 * WARNING! USE WITH CAUTION - IT'LL RENDER DATA DEPENDENCIES
112 * BETWEEN TESTS WHEN RUN IN SUITE. SUITABLE FOR LOCAL, LIMITED
115 * IF POSSIBLE, USE $this->DBResetRequired = FALSE IN YOUR TEST CASE!
117 * see also: http://forum.civicrm.org/index.php/topic,18065.0.html
119 public static $populateOnce = FALSE;
122 * Allow classes to state E-notice compliance
124 public $_eNoticeCompliant = TRUE;
127 * @var boolean DBResetRequired allows skipping DB reset
128 * in specific test case. If you still need
129 * to reset single test (method) of such case, call
130 * $this->cleanDB() in the first line of this
133 public $DBResetRequired = TRUE;
136 * @var CRM_Core_Transaction|NULL
141 * @var CRM_Utils_Hook_UnitTests hookClass
142 * example of setting a method for a hook
143 * $this->hookClass->setHook('civicrm_aclWhereClause', array($this, 'aclWhereHookAllResults'));
145 public $hookClass = NULL;
148 * @var array common values to be re-used multiple times within a class - usually to create the relevant entity
150 protected $_params = array();
153 * @var CRM_Extension_System
155 protected $origExtensionSystem;
160 * Because we are overriding the parent class constructor, we
161 * need to show the same arguments as exist in the constructor of
162 * PHPUnit_Framework_TestCase, since
163 * PHPUnit_Framework_TestSuite::createTest() creates a
164 * ReflectionClass of the Test class and checks the constructor
165 * of that class to decide how to set up the test.
167 * @param string $name
169 * @param string $dataName
171 public function __construct($name = NULL, array$data = array(), $dataName = '') {
172 parent
::__construct($name, $data, $dataName);
174 // we need full error reporting
175 error_reporting(E_ALL
& ~E_NOTICE
);
177 if (!empty($GLOBALS['mysql_db'])) {
178 self
::$_dbName = $GLOBALS['mysql_db'];
181 self
::$_dbName = 'civicrm_tests_dev';
184 // create test database
185 self
::$utils = new Utils($GLOBALS['mysql_host'],
186 $GLOBALS['mysql_port'],
187 $GLOBALS['mysql_user'],
188 $GLOBALS['mysql_pass']
191 // also load the class loader
192 require_once 'CRM/Core/ClassLoader.php';
193 CRM_Core_ClassLoader
::singleton()->register();
194 if (function_exists('_civix_phpunit_setUp')) {
195 // FIXME: loosen coupling
196 _civix_phpunit_setUp();
201 * Override to run the test and assert its state.
204 * @throws \PHPUnit_Framework_IncompleteTest
205 * @throws \PHPUnit_Framework_SkippedTest
207 protected function runTest() {
209 return parent
::runTest();
211 catch (PEAR_Exception
$e) {
212 // PEAR_Exception has metadata in funny places, and PHPUnit won't log it nicely
213 throw new Exception(\CRM_Core_Error
::formatTextException($e), $e->getCode());
220 public function requireDBReset() {
221 return $this->DBResetRequired
;
227 public static function getDBName() {
228 $dbName = !empty($GLOBALS['mysql_db']) ?
$GLOBALS['mysql_db'] : 'civicrm_tests_dev';
233 * Create database connection for this instance.
235 * Initialize the test database if it hasn't been initialized
237 * @return PHPUnit_Extensions_Database_DB_IDatabaseConnection connection
239 protected function getConnection() {
240 $dbName = self
::$_dbName;
241 if (!self
::$dbInit) {
242 $dbName = self
::getDBName();
244 // install test database
245 echo PHP_EOL
. "Installing {$dbName} database" . PHP_EOL
;
247 static::_populateDB(FALSE, $this);
249 self
::$dbInit = TRUE;
251 return $this->createDefaultDBConnection(self
::$utils->pdo
, $dbName);
255 * Required implementation of abstract method.
257 protected function getDataSet() {
261 * @param bool $perClass
262 * @param null $object
264 * TRUE if the populate logic runs; FALSE if it is skipped
266 protected static function _populateDB($perClass = FALSE, &$object = NULL) {
268 if ($perClass ||
$object == NULL) {
272 $dbreset = $object->requireDBReset();
275 if (self
::$populateOnce ||
!$dbreset) {
278 self
::$populateOnce = NULL;
280 $dbName = self
::getDBName();
281 $pdo = self
::$utils->pdo
;
282 // only consider real tables and not views
283 $tables = $pdo->query("SELECT table_name FROM INFORMATION_SCHEMA.TABLES
284 WHERE TABLE_SCHEMA = '{$dbName}' AND TABLE_TYPE = 'BASE TABLE'");
286 $truncates = array();
288 foreach ($tables as $table) {
290 if (substr($table['table_name'], 0, 4) == 'log_') {
294 // don't change list of installed extensions
295 if ($table['table_name'] == 'civicrm_extension') {
299 if (substr($table['table_name'], 0, 14) == 'civicrm_value_') {
300 $drops[] = 'DROP TABLE ' . $table['table_name'] . ';';
303 $truncates[] = 'TRUNCATE ' . $table['table_name'] . ';';
309 "SET foreign_key_checks = 0",
310 // SQL mode needs to be strict, that's our standard
311 "SET SQL_MODE='STRICT_ALL_TABLES';",
312 "SET global innodb_flush_log_at_trx_commit = 2;",
314 $queries = array_merge($queries, $truncates);
315 $queries = array_merge($queries, $drops);
316 foreach ($queries as $query) {
317 if (self
::$utils->do_query($query) === FALSE) {
318 // failed to create test database
319 echo "failed to create test db.";
324 // initialize test database
325 $sql_file2 = dirname(dirname(dirname(dirname(__FILE__
)))) . "/sql/civicrm_data.mysql";
326 $sql_file3 = dirname(dirname(dirname(dirname(__FILE__
)))) . "/sql/test_data.mysql";
327 $sql_file4 = dirname(dirname(dirname(dirname(__FILE__
)))) . "/sql/test_data_second_domain.mysql";
329 $query2 = file_get_contents($sql_file2);
330 $query3 = file_get_contents($sql_file3);
331 $query4 = file_get_contents($sql_file4);
332 if (self
::$utils->do_query($query2) === FALSE) {
333 echo "Cannot load civicrm_data.mysql. Aborting.";
336 if (self
::$utils->do_query($query3) === FALSE) {
337 echo "Cannot load test_data.mysql. Aborting.";
340 if (self
::$utils->do_query($query4) === FALSE) {
341 echo "Cannot load test_data.mysql. Aborting.";
345 // done with all the loading, get transactions back
346 if (self
::$utils->do_query("set global innodb_flush_log_at_trx_commit = 1;") === FALSE) {
347 echo "Cannot set global? Huh?";
351 if (self
::$utils->do_query("SET foreign_key_checks = 1") === FALSE) {
352 echo "Cannot get foreign keys back? Huh?";
356 unset($query, $query2, $query3);
359 civicrm_api('system', 'flush', array('version' => 3, 'triggers' => 1));
361 CRM_Core_BAO_ConfigSetting
::setEnabledComponents(array(
373 public static function setUpBeforeClass() {
374 static::_populateDB(TRUE);
376 // also set this global hack
377 $GLOBALS['_PEAR_ERRORSTACK_OVERRIDE_CALLBACK'] = array();
379 $env = new CRM_Utils_Check_Env();
380 CRM_Utils_Check
::singleton()->assertValid($env->checkMysqlTime());
384 * Common setup functions for all unit tests.
386 protected function setUp() {
387 $session = CRM_Core_Session
::singleton();
388 $session->set('userID', NULL);
390 $this->errorScope
= CRM_Core_TemporaryErrorScope
::useException(); // REVERT
391 // Use a temporary file for STDIN
392 $GLOBALS['stdin'] = tmpfile();
393 if ($GLOBALS['stdin'] === FALSE) {
394 echo "Couldn't open temporary file\n";
398 // Get and save a connection to the database
399 $this->_dbconn
= $this->getConnection();
401 // reload database before each test
402 // $this->_populateDB();
404 // "initialize" CiviCRM to avoid problems when running single tests
405 // FIXME: look at it closer in second stage
407 // initialize the object once db is loaded
408 CRM_Core_Config
::$_mail = NULL;
409 $config = CRM_Core_Config
::singleton();
411 // when running unit tests, use mockup user framework
412 $config->setUserFramework('UnitTests');
413 $this->hookClass
= CRM_Utils_Hook
::singleton(TRUE);
414 // also fix the fatal error handler to throw exceptions,
416 $config->fatalErrorHandler
= 'CiviUnitTestCase_fatalErrorHandler';
418 // enable backtrace to get meaningful errors
419 $config->backtrace
= 1;
421 // disable any left-over test extensions
422 CRM_Core_DAO
::executeQuery('DELETE FROM civicrm_extension WHERE full_name LIKE "test.%"');
424 // reset all the caches
425 CRM_Utils_System
::flushCache();
427 // clear permissions stub to not check permissions
428 $config = CRM_Core_Config
::singleton();
429 $config->userPermissionClass
->permissions
= NULL;
431 //flush component settings
432 CRM_Core_Component
::getEnabledComponents(TRUE);
434 if ($this->_eNoticeCompliant
) {
435 error_reporting(E_ALL
);
438 error_reporting(E_ALL
& ~E_NOTICE
);
440 $this->_sethtmlGlobals();
444 * Read everything from the datasets directory and insert into the db.
446 public function loadAllFixtures() {
447 $fixturesDir = __DIR__
. '/../../fixtures';
449 $this->getConnection()->getConnection()->query("SET FOREIGN_KEY_CHECKS = 0;");
451 $xmlFiles = glob($fixturesDir . '/*.xml');
452 foreach ($xmlFiles as $xmlFixture) {
453 $op = new PHPUnit_Extensions_Database_Operation_Insert();
454 $dataset = $this->createXMLDataSet($xmlFixture);
455 $this->_tablesToTruncate
= array_merge($this->_tablesToTruncate
, $dataset->getTableNames());
456 $op->execute($this->_dbconn
, $dataset);
459 $yamlFiles = glob($fixturesDir . '/*.yaml');
460 foreach ($yamlFiles as $yamlFixture) {
461 $op = new PHPUnit_Extensions_Database_Operation_Insert();
462 $dataset = new PHPUnit_Extensions_Database_DataSet_YamlDataSet($yamlFixture);
463 $this->_tablesToTruncate
= array_merge($this->_tablesToTruncate
, $dataset->getTableNames());
464 $op->execute($this->_dbconn
, $dataset);
467 $this->getConnection()->getConnection()->query("SET FOREIGN_KEY_CHECKS = 1;");
471 * Emulate a logged in user since certain functions use that.
472 * value to store a record in the DB (like activity)
475 public function createLoggedInUser() {
477 'first_name' => 'Logged In',
478 'last_name' => 'User ' . rand(),
479 'contact_type' => 'Individual',
481 $contactID = $this->individualCreate($params);
483 $session = CRM_Core_Session
::singleton();
484 $session->set('userID', $contactID);
487 public function cleanDB() {
488 self
::$populateOnce = NULL;
489 $this->DBResetRequired
= TRUE;
491 $this->_dbconn
= $this->getConnection();
492 static::_populateDB();
493 $this->tempDirs
= array();
497 * Create default domain contacts for the two domains added during test class.
498 * database population.
500 public function createDomainContacts() {
501 $default_domain_contact = $this->organizationCreate();
502 $second_domain_contact = $this->organizationCreate();
506 * Common teardown functions for all unit tests.
508 protected function tearDown() {
509 error_reporting(E_ALL
& ~E_NOTICE
);
510 CRM_Utils_Hook
::singleton()->reset();
511 $this->hookClass
->reset();
512 $session = CRM_Core_Session
::singleton();
513 $session->set('userID', NULL);
516 $this->tx
->rollback()->commit();
519 CRM_Core_Transaction
::forceRollbackIfEnabled();
520 \Civi\Core\Transaction\Manager
::singleton(TRUE);
523 CRM_Core_Transaction
::forceRollbackIfEnabled();
524 \Civi\Core\Transaction\Manager
::singleton(TRUE);
526 $tablesToTruncate = array('civicrm_contact');
527 $this->quickCleanup($tablesToTruncate);
528 $this->createDomainContacts();
531 $this->cleanTempDirs();
532 $this->unsetExtensionSystem();
533 $this->clearOutputBuffer();
537 * FIXME: Maybe a better way to do it
539 public function foreignKeyChecksOff() {
540 self
::$utils = new Utils($GLOBALS['mysql_host'],
541 $GLOBALS['mysql_port'],
542 $GLOBALS['mysql_user'],
543 $GLOBALS['mysql_pass']
545 $dbName = self
::getDBName();
546 $query = "USE {$dbName};" . "SET foreign_key_checks = 1";
547 if (self
::$utils->do_query($query) === FALSE) {
549 echo 'Cannot set foreign_key_checks = 0';
555 public function foreignKeyChecksOn() {
556 // FIXME: might not be needed if previous fixme implemented
560 * Generic function to compare expected values after an api call to retrieved.
563 * @daoName string DAO Name of object we're evaluating.
564 * @id int Id of object
565 * @match array Associative array of field name => expected value. Empty if asserting
566 * that a DELETE occurred
567 * @delete boolean True if we're checking that a DELETE action occurred.
571 * @param bool $delete
572 * @throws \PHPUnit_Framework_AssertionFailedError
574 public function assertDBState($daoName, $id, $match, $delete = FALSE) {
576 // adding this here since developers forget to check for an id
577 // and hence we get the first value in the db
578 $this->fail('ID not populated. Please fix your assertDBState usage!!!');
581 $object = new $daoName();
585 // If we're asserting successful record deletion, make sure object is NOT found.
587 if ($object->find(TRUE)) {
588 $this->fail("Object not deleted by delete operation: $daoName, $id");
593 // Otherwise check matches of DAO field values against expected values in $match.
594 if ($object->find(TRUE)) {
595 $fields = &$object->fields();
596 foreach ($fields as $name => $value) {
597 $dbName = $value['name'];
598 if (isset($match[$name])) {
600 $this->assertEquals($object->$dbName, $match[$name]);
602 elseif (isset($match[$dbName])) {
604 $this->assertEquals($object->$dbName, $match[$dbName]);
609 $this->fail("Could not retrieve object: $daoName, $id");
612 $matchSize = count($match);
613 if ($verifiedCount != $matchSize) {
614 $this->fail("Did not verify all fields in match array: $daoName, $id. Verified count = $verifiedCount. Match array size = $matchSize");
619 * Request a record from the DB by seachColumn+searchValue. Success if a record is found.
620 * @param string $daoName
621 * @param $searchValue
622 * @param $returnColumn
623 * @param $searchColumn
626 * @return null|string
627 * @throws PHPUnit_Framework_AssertionFailedError
629 public function assertDBNotNull($daoName, $searchValue, $returnColumn, $searchColumn, $message) {
630 if (empty($searchValue)) {
631 $this->fail("empty value passed to assertDBNotNull");
633 $value = CRM_Core_DAO
::getFieldValue($daoName, $searchValue, $returnColumn, $searchColumn, TRUE);
634 $this->assertNotNull($value, $message);
640 * Request a record from the DB by seachColumn+searchValue. Success if returnColumn value is NULL.
641 * @param string $daoName
642 * @param $searchValue
643 * @param $returnColumn
644 * @param $searchColumn
647 public function assertDBNull($daoName, $searchValue, $returnColumn, $searchColumn, $message) {
648 $value = CRM_Core_DAO
::getFieldValue($daoName, $searchValue, $returnColumn, $searchColumn, TRUE);
649 $this->assertNull($value, $message);
653 * Request a record from the DB by id. Success if row not found.
654 * @param string $daoName
656 * @param null $message
658 public function assertDBRowNotExist($daoName, $id, $message = NULL) {
659 $message = $message ?
$message : "$daoName (#$id) should not exist";
660 $value = CRM_Core_DAO
::getFieldValue($daoName, $id, 'id', 'id', TRUE);
661 $this->assertNull($value, $message);
665 * Request a record from the DB by id. Success if row not found.
666 * @param string $daoName
668 * @param null $message
670 public function assertDBRowExist($daoName, $id, $message = NULL) {
671 $message = $message ?
$message : "$daoName (#$id) should exist";
672 $value = CRM_Core_DAO
::getFieldValue($daoName, $id, 'id', 'id', TRUE);
673 $this->assertEquals($id, $value, $message);
677 * Compare a single column value in a retrieved DB record to an expected value.
678 * @param string $daoName
679 * @param $searchValue
680 * @param $returnColumn
681 * @param $searchColumn
682 * @param $expectedValue
685 public function assertDBCompareValue(
686 $daoName, $searchValue, $returnColumn, $searchColumn,
687 $expectedValue, $message
689 $value = CRM_Core_DAO
::getFieldValue($daoName, $searchValue, $returnColumn, $searchColumn, TRUE);
690 $this->assertEquals($value, $expectedValue, $message);
694 * Compare all values in a single retrieved DB record to an array of expected values.
695 * @param string $daoName
696 * @param array $searchParams
697 * @param $expectedValues
699 public function assertDBCompareValues($daoName, $searchParams, $expectedValues) {
700 //get the values from db
702 CRM_Core_DAO
::commonRetrieve($daoName, $searchParams, $dbValues);
704 // compare db values with expected values
705 self
::assertAttributesEquals($expectedValues, $dbValues);
709 * Assert that a SQL query returns a given value.
711 * The first argument is an expected value. The remaining arguments are passed
712 * to CRM_Core_DAO::singleValueQuery
714 * Example: $this->assertSql(2, 'select count(*) from foo where foo.bar like "%1"',
715 * array(1 => array("Whiz", "String")));
718 * @param array $params
719 * @param string $message
721 public function assertDBQuery($expected, $query, $params = array(), $message = '') {
725 $actual = CRM_Core_DAO
::singleValueQuery($query, $params);
726 $this->assertEquals($expected, $actual,
727 sprintf('%sexpected=[%s] actual=[%s] query=[%s]',
728 $message, $expected, $actual, CRM_Core_DAO
::composeQuery($query, $params, FALSE)
734 * Assert that two array-trees are exactly equal, notwithstanding
735 * the sorting of keys
737 * @param array $expected
738 * @param array $actual
740 public function assertTreeEquals($expected, $actual) {
743 CRM_Utils_Array
::flatten($expected, $e, '', ':::');
744 CRM_Utils_Array
::flatten($actual, $a, '', ':::');
748 $this->assertEquals($e, $a);
752 * Assert that two numbers are approximately equal.
754 * @param int|float $expected
755 * @param int|float $actual
756 * @param int|float $tolerance
757 * @param string $message
759 public function assertApproxEquals($expected, $actual, $tolerance, $message = NULL) {
760 if ($message === NULL) {
761 $message = sprintf("approx-equals: expected=[%.3f] actual=[%.3f] tolerance=[%.3f]", $expected, $actual, $tolerance);
763 $this->assertTrue(abs($actual - $expected) < $tolerance, $message);
767 * Assert attributes are equal.
769 * @param $expectedValues
770 * @param $actualValues
771 * @param string $message
773 * @throws PHPUnit_Framework_AssertionFailedError
775 public function assertAttributesEquals($expectedValues, $actualValues, $message = NULL) {
776 foreach ($expectedValues as $paramName => $paramValue) {
777 if (isset($actualValues[$paramName])) {
778 $this->assertEquals($paramValue, $actualValues[$paramName], "Value Mismatch On $paramName - value 1 is " . print_r($paramValue, TRUE) . " value 2 is " . print_r($actualValues[$paramName], TRUE));
781 $this->fail("Attribute '$paramName' not present in actual array.");
790 public function assertArrayKeyExists($key, &$list) {
791 $result = isset($list[$key]) ?
TRUE : FALSE;
792 $this->assertTrue($result, ts("%1 element exists?",
801 public function assertArrayValueNotNull($key, &$list) {
802 $this->assertArrayKeyExists($key, $list);
804 $value = isset($list[$key]) ?
$list[$key] : NULL;
805 $this->assertTrue($value,
806 ts("%1 element not null?",
813 * Check that api returned 'is_error' => 0.
815 * @param array $apiResult
817 * @param string $prefix
818 * Extra test to add to message.
820 public function assertAPISuccess($apiResult, $prefix = '') {
821 if (!empty($prefix)) {
824 $errorMessage = empty($apiResult['error_message']) ?
'' : " " . $apiResult['error_message'];
826 if (!empty($apiResult['debug_information'])) {
827 $errorMessage .= "\n " . print_r($apiResult['debug_information'], TRUE);
829 if (!empty($apiResult['trace'])) {
830 $errorMessage .= "\n" . print_r($apiResult['trace'], TRUE);
832 $this->assertEquals(0, $apiResult['is_error'], $prefix . $errorMessage);
836 * Check that api returned 'is_error' => 1.
838 * @param array $apiResult
840 * @param string $prefix
841 * Extra test to add to message.
842 * @param null $expectedError
844 public function assertAPIFailure($apiResult, $prefix = '', $expectedError = NULL) {
845 if (!empty($prefix)) {
848 if ($expectedError && !empty($apiResult['is_error'])) {
849 $this->assertEquals($expectedError, $apiResult['error_message'], 'api error message not as expected' . $prefix);
851 $this->assertEquals(1, $apiResult['is_error'], "api call should have failed but it succeeded " . $prefix . (print_r($apiResult, TRUE)));
852 $this->assertNotEmpty($apiResult['error_message']);
858 * @param string $message
860 public function assertType($expected, $actual, $message = '') {
861 return $this->assertInternalType($expected, $actual, $message);
865 * Check that a deleted item has been deleted.
870 public function assertAPIDeleted($entity, $id) {
871 $this->callAPISuccess($entity, 'getcount', array('id' => $id), 0);
876 * Check that api returned 'is_error' => 1
877 * else provide full message
878 * @param array $result
880 * @param array $valuesToExclude
881 * @param string $prefix
882 * Extra test to add to message.
884 public function assertAPIArrayComparison($result, $expected, $valuesToExclude = array(), $prefix = '') {
885 $valuesToExclude = array_merge($valuesToExclude, array('debug', 'xdebug', 'sequential'));
886 foreach ($valuesToExclude as $value) {
887 if (isset($result[$value])) {
888 unset($result[$value]);
890 if (isset($expected[$value])) {
891 unset($expected[$value]);
894 $this->assertEquals($result, $expected, "api result array comparison failed " . $prefix . print_r($result, TRUE) . ' was compared to ' . print_r($expected, TRUE));
898 * A stub for the API interface. This can be overriden by subclasses to change how the API is called.
902 * @param array $params
905 public function civicrm_api($entity, $action, $params) {
906 return civicrm_api($entity, $action, $params);
910 * wrap api functions.
911 * so we can ensure they succeed & throw exceptions without litterering the test with checks
913 * @param string $entity
914 * @param string $action
915 * @param array $params
916 * @param mixed $checkAgainst
917 * Optional value to check result against, implemented for getvalue,.
918 * getcount, getsingle. Note that for getvalue the type is checked rather than the value
919 * for getsingle the array is compared against an array passed in - the id is not compared (for
924 public function callAPISuccess($entity, $action, $params, $checkAgainst = NULL) {
925 $params = array_merge(array(
926 'version' => $this->_apiversion
,
931 switch (strtolower($action)) {
933 return $this->callAPISuccessGetValue($entity, $params, $checkAgainst);
936 return $this->callAPISuccessGetSingle($entity, $params, $checkAgainst);
939 return $this->callAPISuccessGetCount($entity, $params, $checkAgainst);
941 $result = $this->civicrm_api($entity, $action, $params);
942 $this->assertAPISuccess($result, "Failure in api call for $entity $action");
947 * This function exists to wrap api getValue function & check the result
948 * so we can ensure they succeed & throw exceptions without litterering the test with checks
949 * There is a type check in this
951 * @param string $entity
952 * @param array $params
953 * @param string $type
954 * Per http://php.net/manual/en/function.gettype.php possible types.
964 public function callAPISuccessGetValue($entity, $params, $type = NULL) {
966 'version' => $this->_apiversion
,
969 $result = $this->civicrm_api($entity, 'getvalue', $params);
971 if ($type == 'integer') {
972 // api seems to return integers as strings
973 $this->assertTrue(is_numeric($result), "expected a numeric value but got " . print_r($result, 1));
976 $this->assertType($type, $result, "returned result should have been of type $type but was ");
983 * This function exists to wrap api getsingle function & check the result
984 * so we can ensure they succeed & throw exceptions without litterering the test with checks
986 * @param string $entity
987 * @param array $params
988 * @param array $checkAgainst
989 * Array to compare result against.
1000 public function callAPISuccessGetSingle($entity, $params, $checkAgainst = NULL) {
1002 'version' => $this->_apiversion
,
1005 $result = $this->civicrm_api($entity, 'getsingle', $params);
1006 if (!is_array($result) ||
!empty($result['is_error']) ||
isset($result['values'])) {
1007 throw new Exception('Invalid getsingle result' . print_r($result, TRUE));
1009 if ($checkAgainst) {
1010 // @todo - have gone with the fn that unsets id? should we check id?
1011 $this->checkArrayEquals($result, $checkAgainst);
1017 * This function exists to wrap api getValue function & check the result
1018 * so we can ensure they succeed & throw exceptions without litterering the test with checks
1019 * There is a type check in this
1020 * @param string $entity
1021 * @param array $params
1022 * @param null $count
1026 public function callAPISuccessGetCount($entity, $params, $count = NULL) {
1028 'version' => $this->_apiversion
,
1031 $result = $this->civicrm_api($entity, 'getcount', $params);
1032 if (!is_int($result) ||
!empty($result['is_error']) ||
isset($result['values'])) {
1033 throw new Exception('Invalid getcount result : ' . print_r($result, TRUE) . " type :" . gettype($result));
1035 if (is_int($count)) {
1036 $this->assertEquals($count, $result, "incorrect count returned from $entity getcount");
1042 * This function exists to wrap api functions.
1043 * so we can ensure they succeed, generate and example & throw exceptions without litterering the test with checks
1045 * @param string $entity
1046 * @param string $action
1047 * @param array $params
1048 * @param string $function
1049 * Pass this in to create a generated example.
1050 * @param string $file
1051 * Pass this in to create a generated example.
1052 * @param string $description
1053 * @param string|null $subfile
1054 * @param string|null $actionName
1057 public function callAPIAndDocument($entity, $action, $params, $function, $file, $description = "", $subfile = NULL, $actionName = NULL) {
1058 $params['version'] = $this->_apiversion
;
1059 $result = $this->callAPISuccess($entity, $action, $params);
1060 $this->documentMe($params, $result, $function, $file, $description, $subfile, $actionName);
1065 * This function exists to wrap api functions.
1066 * so we can ensure they fail where expected & throw exceptions without litterering the test with checks
1067 * @param string $entity
1068 * @param string $action
1069 * @param array $params
1070 * @param string $expectedErrorMessage
1072 * @param null $extraOutput
1075 public function callAPIFailure($entity, $action, $params, $expectedErrorMessage = NULL, $extraOutput = NULL) {
1076 if (is_array($params)) {
1078 'version' => $this->_apiversion
,
1081 $result = $this->civicrm_api($entity, $action, $params);
1082 $this->assertAPIFailure($result, "We expected a failure for $entity $action but got a success");
1087 * Create required data based on $this->entity & $this->params
1088 * This is just a way to set up the test data for delete & get functions
1089 * so the distinction between set
1090 * up & tested functions is clearer
1095 public function createTestEntity() {
1096 return $entity = $this->callAPISuccess($this->entity
, 'create', $this->params
);
1100 * Generic function to create Organisation, to be used in test cases
1102 * @param array $params
1103 * parameters for civicrm_contact_add api function call
1105 * sequence number if creating multiple organizations
1108 * id of Organisation created
1110 public function organizationCreate($params = array(), $seq = 0) {
1114 $params = array_merge($this->sampleContact('Organization', $seq), $params);
1115 return $this->_contactCreate($params);
1119 * Generic function to create Individual, to be used in test cases
1121 * @param array $params
1122 * parameters for civicrm_contact_add api function call
1124 * sequence number if creating multiple individuals
1127 * id of Individual created
1129 public function individualCreate($params = array(), $seq = 0) {
1130 $params = array_merge($this->sampleContact('Individual', $seq), $params);
1131 return $this->_contactCreate($params);
1135 * Generic function to create Household, to be used in test cases
1137 * @param array $params
1138 * parameters for civicrm_contact_add api function call
1140 * sequence number if creating multiple households
1143 * id of Household created
1145 public function householdCreate($params = array(), $seq = 0) {
1146 $params = array_merge($this->sampleContact('Household', $seq), $params);
1147 return $this->_contactCreate($params);
1151 * Helper function for getting sample contact properties.
1153 * @param string $contact_type
1154 * enum contact type: Individual, Organization
1156 * sequence number for the values of this type
1159 * properties of sample contact (ie. $params for API call)
1161 public function sampleContact($contact_type, $seq = 0) {
1163 'Individual' => array(
1164 // The number of values in each list need to be coprime numbers to not have duplicates
1165 'first_name' => array('Anthony', 'Joe', 'Terrence', 'Lucie', 'Albert', 'Bill', 'Kim'),
1166 'middle_name' => array('J.', 'M.', 'P', 'L.', 'K.', 'A.', 'B.', 'C.', 'D', 'E.', 'Z.'),
1167 'last_name' => array('Anderson', 'Miller', 'Smith', 'Collins', 'Peterson'),
1169 'Organization' => array(
1170 'organization_name' => array(
1171 'Unit Test Organization',
1178 'Household' => array(
1179 'household_name' => array('Unit Test household'),
1182 $params = array('contact_type' => $contact_type);
1183 foreach ($samples[$contact_type] as $key => $values) {
1184 $params[$key] = $values[$seq %
count($values)];
1186 if ($contact_type == 'Individual') {
1187 $params['email'] = strtolower(
1188 $params['first_name'] . '_' . $params['last_name'] . '@civicrm.org'
1190 $params['prefix_id'] = 3;
1191 $params['suffix_id'] = 3;
1197 * Private helper function for calling civicrm_contact_add.
1199 * @param array $params
1200 * For civicrm_contact_add api function call.
1205 * id of Household created
1207 private function _contactCreate($params) {
1208 $result = $this->callAPISuccess('contact', 'create', $params);
1209 if (!empty($result['is_error']) ||
empty($result['id'])) {
1210 throw new Exception('Could not create test contact, with message: ' . CRM_Utils_Array
::value('error_message', $result) . "\nBacktrace:" . CRM_Utils_Array
::value('trace', $result));
1212 return $result['id'];
1216 * Delete contact, ensuring it is not the domain contact
1218 * @param int $contactID
1219 * Contact ID to delete
1221 public function contactDelete($contactID) {
1222 $domain = new CRM_Core_BAO_Domain();
1223 $domain->contact_id
= $contactID;
1224 if (!$domain->find(TRUE)) {
1225 $this->callAPISuccess('contact', 'delete', array(
1227 'skip_undelete' => 1,
1233 * @param int $contactTypeId
1237 public function contactTypeDelete($contactTypeId) {
1238 $result = CRM_Contact_BAO_ContactType
::del($contactTypeId);
1240 throw new Exception('Could not delete contact type');
1245 * @param array $params
1249 public function membershipTypeCreate($params = array()) {
1250 CRM_Member_PseudoConstant
::flush('membershipType');
1251 CRM_Core_Config
::clearDBCache();
1252 $memberOfOrganization = $this->organizationCreate();
1253 $params = array_merge(array(
1254 'name' => 'General',
1255 'duration_unit' => 'year',
1256 'duration_interval' => 1,
1257 'period_type' => 'rolling',
1258 'member_of_contact_id' => $memberOfOrganization,
1260 'financial_type_id' => 1,
1263 'visibility' => 'Public',
1266 $result = $this->callAPISuccess('MembershipType', 'Create', $params);
1268 CRM_Member_PseudoConstant
::flush('membershipType');
1269 CRM_Utils_Cache
::singleton()->flush();
1271 return $result['id'];
1275 * @param array $params
1279 public function contactMembershipCreate($params) {
1281 'join_date' => '2007-01-21',
1282 'start_date' => '2007-01-21',
1283 'end_date' => '2007-12-21',
1284 'source' => 'Payment',
1287 foreach ($pre as $key => $val) {
1288 if (!isset($params[$key])) {
1289 $params[$key] = $val;
1293 $result = $this->callAPISuccess('Membership', 'create', $params);
1294 return $result['id'];
1298 * Delete Membership Type.
1300 * @param array $params
1302 public function membershipTypeDelete($params) {
1303 $this->callAPISuccess('MembershipType', 'Delete', $params);
1307 * @param int $membershipID
1309 public function membershipDelete($membershipID) {
1310 $deleteParams = array('id' => $membershipID);
1311 $result = $this->callAPISuccess('Membership', 'Delete', $deleteParams);
1315 * @param string $name
1319 public function membershipStatusCreate($name = 'test member status') {
1320 $params['name'] = $name;
1321 $params['start_event'] = 'start_date';
1322 $params['end_event'] = 'end_date';
1323 $params['is_current_member'] = 1;
1324 $params['is_active'] = 1;
1326 $result = $this->callAPISuccess('MembershipStatus', 'Create', $params);
1327 CRM_Member_PseudoConstant
::flush('membershipStatus');
1328 return $result['id'];
1332 * @param int $membershipStatusID
1334 public function membershipStatusDelete($membershipStatusID) {
1335 if (!$membershipStatusID) {
1338 $result = $this->callAPISuccess('MembershipStatus', 'Delete', array('id' => $membershipStatusID));
1342 * @param array $params
1346 public function relationshipTypeCreate($params = array()) {
1347 $params = array_merge(array(
1348 'name_a_b' => 'Relation 1 for relationship type create',
1349 'name_b_a' => 'Relation 2 for relationship type create',
1350 'contact_type_a' => 'Individual',
1351 'contact_type_b' => 'Organization',
1358 $result = $this->callAPISuccess('relationship_type', 'create', $params);
1359 CRM_Core_PseudoConstant
::flush('relationshipType');
1361 return $result['id'];
1365 * Delete Relatinship Type.
1367 * @param int $relationshipTypeID
1369 public function relationshipTypeDelete($relationshipTypeID) {
1370 $params['id'] = $relationshipTypeID;
1371 $this->callAPISuccess('relationship_type', 'delete', $params);
1375 * @param array $params
1379 public function paymentProcessorTypeCreate($params = NULL) {
1380 if (is_null($params)) {
1382 'name' => 'API_Test_PP',
1383 'title' => 'API Test Payment Processor',
1384 'class_name' => 'CRM_Core_Payment_APITest',
1385 'billing_mode' => 'form',
1391 $result = $this->callAPISuccess('payment_processor_type', 'create', $params);
1393 CRM_Core_PseudoConstant
::flush('paymentProcessorType');
1395 return $result['id'];
1399 * Create Participant.
1401 * @param array $params
1402 * Array of contact id and event id values.
1405 * $id of participant created
1407 public function participantCreate($params) {
1408 if (empty($params['contact_id'])) {
1409 $params['contact_id'] = $this->individualCreate();
1411 if (empty($params['event_id'])) {
1412 $event = $this->eventCreate();
1413 $params['event_id'] = $event['id'];
1418 'register_date' => 20070219,
1419 'source' => 'Wimbeldon',
1420 'event_level' => 'Payment',
1424 $params = array_merge($defaults, $params);
1425 $result = $this->callAPISuccess('Participant', 'create', $params);
1426 return $result['id'];
1430 * Create Payment Processor.
1432 * @return CRM_Financial_DAO_PaymentProcessor
1433 * instance of Payment Processsor
1435 public function processorCreate() {
1436 $processorParams = array(
1439 'payment_processor_type_id' => 10,
1440 'financial_account_id' => 12,
1443 'url_site' => 'http://dummy.com',
1444 'url_recur' => 'http://dummy.com',
1445 'billing_mode' => 1,
1447 $paymentProcessor = CRM_Financial_BAO_PaymentProcessor
::create($processorParams);
1448 return $paymentProcessor;
1452 * Create contribution page.
1454 * @param array $params
1456 * Array of contribution page
1458 public function contributionPageCreate($params) {
1459 $this->_pageParams
= array(
1460 'title' => 'Test Contribution Page',
1461 'financial_type_id' => 1,
1462 'currency' => 'USD',
1463 'financial_account_id' => 1,
1464 'payment_processor' => $params['processor_id'],
1466 'is_allow_other_amount' => 1,
1468 'max_amount' => 1000,
1470 $contributionPage = $this->callAPISuccess('contribution_page', 'create', $this->_pageParams
);
1471 return $contributionPage;
1477 * @param array $params
1479 * result of created tag
1481 public function tagCreate($params = array()) {
1483 'name' => 'New Tag3',
1484 'description' => 'This is description for Our New Tag ',
1487 $params = array_merge($defaults, $params);
1488 $result = $this->callAPISuccess('Tag', 'create', $params);
1489 return $result['values'][$result['id']];
1496 * Id of the tag to be deleted.
1500 public function tagDelete($tagId) {
1501 require_once 'api/api.php';
1505 $result = $this->callAPISuccess('Tag', 'delete', $params);
1506 return $result['id'];
1510 * Add entity(s) to the tag
1512 * @param array $params
1516 public function entityTagAdd($params) {
1517 $result = $this->callAPISuccess('entity_tag', 'create', $params);
1522 * Create contribution.
1528 * id of created contribution
1530 public function pledgeCreate($cID) {
1532 'contact_id' => $cID,
1533 'pledge_create_date' => date('Ymd'),
1534 'start_date' => date('Ymd'),
1535 'scheduled_date' => date('Ymd'),
1537 'pledge_status_id' => '2',
1538 'financial_type_id' => '1',
1539 'pledge_original_installment_amount' => 20,
1540 'frequency_interval' => 5,
1541 'frequency_unit' => 'year',
1542 'frequency_day' => 15,
1543 'installments' => 5,
1546 $result = $this->callAPISuccess('Pledge', 'create', $params);
1547 return $result['id'];
1551 * Delete contribution.
1553 * @param int $pledgeId
1555 public function pledgeDelete($pledgeId) {
1557 'pledge_id' => $pledgeId,
1559 $this->callAPISuccess('Pledge', 'delete', $params);
1563 * Create contribution.
1567 * @param int $cTypeID
1568 * Id of financial type.
1569 * @param int $invoiceID
1570 * @param int $trxnID
1571 * @param int $paymentInstrumentID
1572 * @param bool $isFee
1575 * id of created contribution
1577 public function contributionCreate($cID, $cTypeID = 1, $invoiceID = 67890, $trxnID = 12345, $paymentInstrumentID = 1, $isFee = TRUE) {
1580 'contact_id' => $cID,
1581 'receive_date' => date('Ymd'),
1582 'total_amount' => 100.00,
1583 'financial_type_id' => empty($cTypeID) ?
1 : $cTypeID,
1584 'payment_instrument_id' => empty($paymentInstrumentID) ?
1 : $paymentInstrumentID,
1585 'non_deductible_amount' => 10.00,
1586 'trxn_id' => $trxnID,
1587 'invoice_id' => $invoiceID,
1589 'contribution_status_id' => 1,
1590 // 'note' => 'Donating for Nobel Cause', *Fixme
1594 $params['fee_amount'] = 5.00;
1595 $params['net_amount'] = 95.00;
1598 $result = $this->callAPISuccess('contribution', 'create', $params);
1599 return $result['id'];
1603 * Create online contribution.
1605 * @param array $params
1606 * @param int $financialType
1607 * Id of financial type.
1608 * @param int $invoiceID
1609 * @param int $trxnID
1612 * id of created contribution
1614 public function onlineContributionCreate($params, $financialType, $invoiceID = 67890, $trxnID = 12345) {
1615 $contribParams = array(
1616 'contact_id' => $params['contact_id'],
1617 'receive_date' => date('Ymd'),
1618 'total_amount' => 100.00,
1619 'financial_type_id' => $financialType,
1620 'contribution_page_id' => $params['contribution_page_id'],
1622 'invoice_id' => 67890,
1625 $contribParams = array_merge($contribParams, $params);
1626 $result = $this->callAPISuccess('contribution', 'create', $contribParams);
1628 return $result['id'];
1632 * Delete contribution.
1634 * @param int $contributionId
1638 public function contributionDelete($contributionId) {
1640 'contribution_id' => $contributionId,
1642 $result = $this->callAPISuccess('contribution', 'delete', $params);
1649 * @param array $params
1650 * Name-value pair for an event.
1654 public function eventCreate($params = array()) {
1655 // if no contact was passed, make up a dummy event creator
1656 if (!isset($params['contact_id'])) {
1657 $params['contact_id'] = $this->_contactCreate(array(
1658 'contact_type' => 'Individual',
1659 'first_name' => 'Event',
1660 'last_name' => 'Creator',
1664 // set defaults for missing params
1665 $params = array_merge(array(
1666 'title' => 'Annual CiviCRM meet',
1667 'summary' => 'If you have any CiviCRM related issues or want to track where CiviCRM is heading, Sign up now',
1668 'description' => 'This event is intended to give brief idea about progess of CiviCRM and giving solutions to common user issues',
1669 'event_type_id' => 1,
1671 'start_date' => 20081021,
1672 'end_date' => 20081023,
1673 'is_online_registration' => 1,
1674 'registration_start_date' => 20080601,
1675 'registration_end_date' => 20081015,
1676 'max_participants' => 100,
1677 'event_full_text' => 'Sorry! We are already full',
1680 'is_show_location' => 0,
1683 return $this->callAPISuccess('Event', 'create', $params);
1694 public function eventDelete($id) {
1698 return $this->callAPISuccess('event', 'delete', $params);
1702 * Delete participant.
1704 * @param int $participantID
1708 public function participantDelete($participantID) {
1710 'id' => $participantID,
1712 return $this->callAPISuccess('Participant', 'delete', $params);
1716 * Create participant payment.
1718 * @param int $participantID
1719 * @param int $contributionID
1721 * $id of created payment
1723 public function participantPaymentCreate($participantID, $contributionID = NULL) {
1724 //Create Participant Payment record With Values
1726 'participant_id' => $participantID,
1727 'contribution_id' => $contributionID,
1730 $result = $this->callAPISuccess('participant_payment', 'create', $params);
1731 return $result['id'];
1735 * Delete participant payment.
1737 * @param int $paymentID
1739 public function participantPaymentDelete($paymentID) {
1743 $result = $this->callAPISuccess('participant_payment', 'delete', $params);
1749 * @param int $contactID
1751 * location id of created location
1753 public function locationAdd($contactID) {
1756 'location_type' => 'New Location Type',
1758 'name' => 'Saint Helier St',
1759 'county' => 'Marin',
1760 'country' => 'United States',
1761 'state_province' => 'Michigan',
1762 'supplemental_address_1' => 'Hallmark Ct',
1763 'supplemental_address_2' => 'Jersey Village',
1768 'contact_id' => $contactID,
1769 'address' => $address,
1770 'location_format' => '2.0',
1771 'location_type' => 'New Location Type',
1774 $result = $this->callAPISuccess('Location', 'create', $params);
1779 * Delete Locations of contact.
1781 * @param array $params
1784 public function locationDelete($params) {
1785 $this->callAPISuccess('Location', 'delete', $params);
1789 * Add a Location Type.
1791 * @param array $params
1792 * @return CRM_Core_DAO_LocationType
1793 * location id of created location
1795 public function locationTypeCreate($params = NULL) {
1796 if ($params === NULL) {
1798 'name' => 'New Location Type',
1799 'vcard_name' => 'New Location Type',
1800 'description' => 'Location Type for Delete',
1805 $locationType = new CRM_Core_DAO_LocationType();
1806 $locationType->copyValues($params);
1807 $locationType->save();
1808 // clear getfields cache
1809 CRM_Core_PseudoConstant
::flush();
1810 $this->callAPISuccess('phone', 'getfields', array('version' => 3, 'cache_clear' => 1));
1811 return $locationType;
1815 * Delete a Location Type.
1817 * @param int $locationTypeId
1819 public function locationTypeDelete($locationTypeId) {
1820 $locationType = new CRM_Core_DAO_LocationType();
1821 $locationType->id
= $locationTypeId;
1822 $locationType->delete();
1828 * @param array $params
1830 * groupId of created group
1832 public function groupCreate($params = array()) {
1833 $params = array_merge(array(
1834 'name' => 'Test Group 1',
1836 'title' => 'New Test Group Created',
1837 'description' => 'New Test Group Created',
1839 'visibility' => 'Public Pages',
1840 'group_type' => array(
1846 $result = $this->callAPISuccess('Group', 'create', $params);
1847 return $result['id'];
1852 * Function to add a Group.
1854 * @params array to add group
1856 * @param int $groupID
1857 * @param int $totalCount
1859 * groupId of created group
1861 public function groupContactCreate($groupID, $totalCount = 10) {
1862 $params = array('group_id' => $groupID);
1863 for ($i = 1; $i <= $totalCount; $i++
) {
1864 $contactID = $this->individualCreate();
1866 $params +
= array('contact_id' => $contactID);
1869 $params +
= array("contact_id.$i" => $contactID);
1872 $result = $this->callAPISuccess('GroupContact', 'create', $params);
1882 public function groupDelete($gid) {
1888 $this->callAPISuccess('Group', 'delete', $params);
1893 * @param array $params
1895 public function uFFieldCreate($params = array()) {
1896 $params = array_merge(array(
1898 'field_name' => 'first_name',
1901 'visibility' => 'Public Pages and Listings',
1902 'is_searchable' => '1',
1903 'label' => 'first_name',
1904 'field_type' => 'Individual',
1907 $this->callAPISuccess('uf_field', 'create', $params);
1911 * Add a UF Join Entry.
1913 * @param array $params
1915 * $id of created UF Join
1917 public function ufjoinCreate($params = NULL) {
1918 if ($params === NULL) {
1921 'module' => 'CiviEvent',
1922 'entity_table' => 'civicrm_event',
1928 $result = $this->callAPISuccess('uf_join', 'create', $params);
1933 * Delete a UF Join Entry.
1935 * @param array $params
1936 * with missing uf_group_id
1938 public function ufjoinDelete($params = NULL) {
1939 if ($params === NULL) {
1942 'module' => 'CiviEvent',
1943 'entity_table' => 'civicrm_event',
1946 'uf_group_id' => '',
1950 crm_add_uf_join($params);
1954 * Create Group for a contact.
1956 * @param int $contactId
1958 public function contactGroupCreate($contactId) {
1960 'contact_id.1' => $contactId,
1964 $this->callAPISuccess('GroupContact', 'Create', $params);
1968 * Delete Group for a contact.
1970 * @param int $contactId
1972 public function contactGroupDelete($contactId) {
1974 'contact_id.1' => $contactId,
1977 $this->civicrm_api('GroupContact', 'Delete', $params);
1983 * @param array $params
1986 public function activityCreate($params = NULL) {
1988 if ($params === NULL) {
1989 $individualSourceID = $this->individualCreate();
1991 $contactParams = array(
1992 'first_name' => 'Julia',
1993 'Last_name' => 'Anderson',
1995 'email' => 'julia_anderson@civicrm.org',
1996 'contact_type' => 'Individual',
1999 $individualTargetID = $this->individualCreate($contactParams);
2002 'source_contact_id' => $individualSourceID,
2003 'target_contact_id' => array($individualTargetID),
2004 'assignee_contact_id' => array($individualTargetID),
2005 'subject' => 'Discussion on warm beer',
2006 'activity_date_time' => date('Ymd'),
2007 'duration_hours' => 30,
2008 'duration_minutes' => 20,
2009 'location' => 'Baker Street',
2010 'details' => 'Lets schedule a meeting',
2012 'activity_name' => 'Meeting',
2016 $result = $this->callAPISuccess('Activity', 'create', $params);
2018 $result['target_contact_id'] = $individualTargetID;
2019 $result['assignee_contact_id'] = $individualTargetID;
2024 * Create an activity type.
2026 * @param array $params
2030 public function activityTypeCreate($params) {
2031 return $this->callAPISuccess('ActivityType', 'create', $params);
2035 * Delete activity type.
2037 * @param int $activityTypeId
2038 * Id of the activity type.
2041 public function activityTypeDelete($activityTypeId) {
2042 $params['activity_type_id'] = $activityTypeId;
2043 return $this->callAPISuccess('ActivityType', 'delete', $params);
2047 * Create custom group.
2049 * @param array $params
2052 public function customGroupCreate($params = array()) {
2054 'title' => 'new custom group',
2055 'extends' => 'Contact',
2057 'style' => 'Inline',
2061 $params = array_merge($defaults, $params);
2063 if (strlen($params['title']) > 13) {
2064 $params['title'] = substr($params['title'], 0, 13);
2067 //have a crack @ deleting it first in the hope this will prevent derailing our tests
2068 $this->callAPISuccess('custom_group', 'get', array(
2069 'title' => $params['title'],
2070 array('api.custom_group.delete' => 1),
2073 return $this->callAPISuccess('custom_group', 'create', $params);
2077 * Existing function doesn't allow params to be over-ridden so need a new one
2078 * this one allows you to only pass in the params you want to change
2079 * @param array $params
2082 public function CustomGroupCreateByParams($params = array()) {
2084 'title' => "API Custom Group",
2085 'extends' => 'Contact',
2087 'style' => 'Inline',
2090 $params = array_merge($defaults, $params);
2091 return $this->callAPISuccess('custom_group', 'create', $params);
2095 * Create custom group with multi fields.
2096 * @param array $params
2099 public function CustomGroupMultipleCreateByParams($params = array()) {
2104 $params = array_merge($defaults, $params);
2105 return $this->CustomGroupCreateByParams($params);
2109 * Create custom group with multi fields.
2110 * @param array $params
2113 public function CustomGroupMultipleCreateWithFields($params = array()) {
2114 // also need to pass on $params['custom_field'] if not set but not in place yet
2116 $customGroup = $this->CustomGroupMultipleCreateByParams($params);
2117 $ids['custom_group_id'] = $customGroup['id'];
2119 $customField = $this->customFieldCreate(array(
2120 'custom_group_id' => $ids['custom_group_id'],
2121 'label' => 'field_1' . $ids['custom_group_id'],
2124 $ids['custom_field_id'][] = $customField['id'];
2126 $customField = $this->customFieldCreate(array(
2127 'custom_group_id' => $ids['custom_group_id'],
2128 'default_value' => '',
2129 'label' => 'field_2' . $ids['custom_group_id'],
2131 $ids['custom_field_id'][] = $customField['id'];
2133 $customField = $this->customFieldCreate(array(
2134 'custom_group_id' => $ids['custom_group_id'],
2135 'default_value' => '',
2136 'label' => 'field_3' . $ids['custom_group_id'],
2138 $ids['custom_field_id'][] = $customField['id'];
2144 * Create a custom group with a single text custom field. See
2145 * participant:testCreateWithCustom for how to use this
2147 * @param string $function
2149 * @param string $filename
2153 * ids of created objects
2155 public function entityCustomGroupWithSingleFieldCreate($function, $filename) {
2156 $params = array('title' => $function);
2157 $entity = substr(basename($filename), 0, strlen(basename($filename)) - 8);
2158 $params['extends'] = $entity ?
$entity : 'Contact';
2159 $customGroup = $this->CustomGroupCreate($params);
2160 $customField = $this->customFieldCreate(array('custom_group_id' => $customGroup['id'], 'label' => $function));
2161 CRM_Core_PseudoConstant
::flush();
2163 return array('custom_group_id' => $customGroup['id'], 'custom_field_id' => $customField['id']);
2167 * Delete custom group.
2169 * @param int $customGroupID
2173 public function customGroupDelete($customGroupID) {
2174 $params['id'] = $customGroupID;
2175 return $this->callAPISuccess('custom_group', 'delete', $params);
2179 * Create custom field.
2181 * @param array $params
2182 * (custom_group_id) is required.
2185 public function customFieldCreate($params) {
2186 $params = array_merge(array(
2187 'label' => 'Custom Field',
2188 'data_type' => 'String',
2189 'html_type' => 'Text',
2190 'is_searchable' => 1,
2192 'default_value' => 'defaultValue',
2195 $result = $this->callAPISuccess('custom_field', 'create', $params);
2196 // these 2 functions are called with force to flush static caches
2197 CRM_Core_BAO_CustomField
::getTableColumnGroup($result['id'], 1);
2198 CRM_Core_Component
::getEnabledComponents(1);
2203 * Delete custom field.
2205 * @param int $customFieldID
2209 public function customFieldDelete($customFieldID) {
2211 $params['id'] = $customFieldID;
2212 return $this->callAPISuccess('custom_field', 'delete', $params);
2221 public function noteCreate($cId) {
2223 'entity_table' => 'civicrm_contact',
2224 'entity_id' => $cId,
2225 'note' => 'hello I am testing Note',
2226 'contact_id' => $cId,
2227 'modified_date' => date('Ymd'),
2228 'subject' => 'Test Note',
2231 return $this->callAPISuccess('Note', 'create', $params);
2235 * Enable CiviCampaign Component.
2237 public function enableCiviCampaign() {
2238 CRM_Core_BAO_ConfigSetting
::enableComponent('CiviCampaign');
2239 // force reload of config object
2240 $config = CRM_Core_Config
::singleton(TRUE, TRUE);
2241 //flush cache by calling with reset
2242 $activityTypes = CRM_Core_PseudoConstant
::activityType(TRUE, TRUE, TRUE, 'name', TRUE);
2246 * Create test generated example in api/v3/examples.
2248 * To turn this off (e.g. on the server) set
2249 * define(DONT_DOCUMENT_TEST_CONFIG ,1);
2250 * in your settings file
2252 * @param array $params
2253 * Array as passed to civicrm_api function.
2254 * @param array $result
2255 * Array as received from the civicrm_api function.
2256 * @param string $function
2257 * Calling function - generally __FUNCTION__.
2258 * @param string $filename
2259 * Called from file - generally __FILE__.
2260 * @param string $description
2261 * Descriptive text for the example file.
2262 * @param string $subfile
2263 * Name for subfile - if this is completed the example will be put in a subfolder (named by the entity).
2264 * @param string $action
2265 * Optional action - otherwise taken from function name.
2267 public function documentMe($params, $result, $function, $filename, $description = "", $subfile = NULL, $action = NULL) {
2268 if (defined('DONT_DOCUMENT_TEST_CONFIG') && DONT_DOCUMENT_TEST_CONFIG
) {
2271 $entity = substr(basename($filename), 0, strlen(basename($filename)) - 8);
2272 //todo - this is a bit cludgey
2273 if (empty($action)) {
2274 if (strstr($function, 'Create')) {
2275 $action = empty($action) ?
'create' : $action;
2276 $entityAction = 'Create';
2278 elseif (strstr($function, 'GetSingle')) {
2279 $action = empty($action) ?
'getsingle' : $action;
2280 $entityAction = 'GetSingle';
2282 elseif (strstr($function, 'GetValue')) {
2283 $action = empty($action) ?
'getvalue' : $action;
2284 $entityAction = 'GetValue';
2286 elseif (strstr($function, 'GetCount')) {
2287 $action = empty($action) ?
'getcount' : $action;
2288 $entityAction = 'GetCount';
2290 elseif (strstr($function, 'GetFields')) {
2291 $action = empty($action) ?
'getfields' : $action;
2292 $entityAction = 'GetFields';
2294 elseif (strstr($function, 'GetList')) {
2295 $action = empty($action) ?
'getlist' : $action;
2296 $entityAction = 'GetList';
2298 elseif (strstr($function, 'GetActions')) {
2299 $action = empty($action) ?
'getactions' : $action;
2300 $entityAction = 'GetActions';
2302 elseif (strstr($function, 'Get')) {
2303 $action = empty($action) ?
'get' : $action;
2304 $entityAction = 'Get';
2306 elseif (strstr($function, 'Delete')) {
2307 $action = empty($action) ?
'delete' : $action;
2308 $entityAction = 'Delete';
2310 elseif (strstr($function, 'Update')) {
2311 $action = empty($action) ?
'update' : $action;
2312 $entityAction = 'Update';
2314 elseif (strstr($function, 'Subscribe')) {
2315 $action = empty($action) ?
'subscribe' : $action;
2316 $entityAction = 'Subscribe';
2318 elseif (strstr($function, 'Submit')) {
2319 $action = empty($action) ?
'submit' : $action;
2320 $entityAction = 'Submit';
2322 elseif (strstr($function, 'Apply')) {
2323 $action = empty($action) ?
'apply' : $action;
2324 $entityAction = 'Apply';
2326 elseif (strstr($function, 'Replace')) {
2327 $action = empty($action) ?
'replace' : $action;
2328 $entityAction = 'Replace';
2332 $entityAction = ucwords($action);
2335 $this->tidyExampleResult($result);
2336 if (isset($params['version'])) {
2337 unset($params['version']);
2339 // a cleverer person than me would do it in a single regex
2340 if (strstr($entity, 'UF')) {
2341 $fnPrefix = strtolower(preg_replace('/(?<! )(?<!^)(?<=UF)[A-Z]/', '_$0', $entity));
2344 $fnPrefix = strtolower(preg_replace('/(?<! )(?<!^)[A-Z]/', '_$0', $entity));
2346 $smarty = CRM_Core_Smarty
::singleton();
2347 $smarty->assign('testfunction', $function);
2348 $function = $fnPrefix . "_" . strtolower($action);
2349 $smarty->assign('function', $function);
2350 $smarty->assign('fnPrefix', $fnPrefix);
2351 $smarty->assign('params', $params);
2352 $smarty->assign('entity', $entity);
2353 $smarty->assign('filename', basename($filename));
2354 $smarty->assign('description', $description);
2355 $smarty->assign('result', $result);
2357 $smarty->assign('action', $action);
2358 if (empty($subfile)) {
2359 $subfile = $entityAction;
2361 if (file_exists('../tests/templates/documentFunction.tpl')) {
2362 if (!is_dir("../api/v3/examples/$entity")) {
2363 mkdir("../api/v3/examples/$entity");
2365 $f = fopen("../api/v3/examples/$entity/$subfile.php", "w+b");
2366 fwrite($f, $smarty->fetch('../tests/templates/documentFunction.tpl'));
2372 * Tidy up examples array so that fields that change often ..don't
2373 * and debug related fields are unset
2375 * @param array $result
2377 public function tidyExampleResult(&$result) {
2378 if (!is_array($result)) {
2381 $fieldsToChange = array(
2382 'hash' => '67eac7789eaee00',
2383 'modified_date' => '2012-11-14 16:02:35',
2384 'created_date' => '2013-07-28 08:49:19',
2385 'create_date' => '20120130621222105',
2386 'application_received_date' => '20130728084957',
2387 'in_date' => '2013-07-28 08:50:19',
2388 'scheduled_date' => '20130728085413',
2389 'approval_date' => '20130728085413',
2390 'pledge_start_date_high' => '20130726090416',
2391 'start_date' => '2013-07-29 00:00:00',
2392 'event_start_date' => '2013-07-29 00:00:00',
2393 'end_date' => '2013-08-04 00:00:00',
2394 'event_end_date' => '2013-08-04 00:00:00',
2395 'decision_date' => '20130805000000',
2398 $keysToUnset = array('xdebug', 'undefined_fields');
2399 foreach ($keysToUnset as $unwantedKey) {
2400 if (isset($result[$unwantedKey])) {
2401 unset($result[$unwantedKey]);
2404 if (isset($result['values'])) {
2405 if (!is_array($result['values'])) {
2408 $resultArray = &$result['values'];
2410 elseif (is_array($result)) {
2411 $resultArray = &$result;
2417 foreach ($resultArray as $index => &$values) {
2418 if (!is_array($values)) {
2421 foreach ($values as $key => &$value) {
2422 if (substr($key, 0, 3) == 'api' && is_array($value)) {
2423 if (isset($value['is_error'])) {
2424 // we have a std nested result format
2425 $this->tidyExampleResult($value);
2428 foreach ($value as &$nestedResult) {
2429 // this is an alternative syntax for nested results a keyed array of results
2430 $this->tidyExampleResult($nestedResult);
2434 if (in_array($key, $keysToUnset)) {
2435 unset($values[$key]);
2438 if (array_key_exists($key, $fieldsToChange) && !empty($value)) {
2439 $value = $fieldsToChange[$key];
2441 if (is_string($value)) {
2442 $value = addslashes($value);
2451 * @param array $params
2455 public function noteDelete($params) {
2456 return $this->callAPISuccess('Note', 'delete', $params);
2460 * Create custom field with Option Values.
2462 * @param array $customGroup
2463 * @param string $name
2464 * Name of custom field.
2468 public function customFieldOptionValueCreate($customGroup, $name) {
2469 $fieldParams = array(
2470 'custom_group_id' => $customGroup['id'],
2471 'name' => 'test_custom_group',
2472 'label' => 'Country',
2473 'html_type' => 'Select',
2474 'data_type' => 'String',
2477 'is_searchable' => 0,
2481 $optionGroup = array(
2483 'name' => 'option_group1',
2484 'label' => 'option_group_label1',
2487 $optionValue = array(
2488 'option_label' => array('Label1', 'Label2'),
2489 'option_value' => array('value1', 'value2'),
2490 'option_name' => array($name . '_1', $name . '_2'),
2491 'option_weight' => array(1, 2),
2492 'option_status' => 1,
2495 $params = array_merge($fieldParams, $optionGroup, $optionValue);
2497 return $this->callAPISuccess('custom_field', 'create', $params);
2505 public function confirmEntitiesDeleted($entities) {
2506 foreach ($entities as $entity) {
2508 $result = $this->callAPISuccess($entity, 'Get', array());
2509 if ($result['error'] == 1 ||
$result['count'] > 0) {
2510 // > than $entity[0] to allow a value to be passed in? e.g. domain?
2518 * @param $tablesToTruncate
2519 * @param bool $dropCustomValueTables
2520 * @throws \Exception
2522 public function quickCleanup($tablesToTruncate, $dropCustomValueTables = FALSE) {
2524 throw new Exception("CiviUnitTestCase: quickCleanup() is not compatible with useTransaction()");
2526 if ($dropCustomValueTables) {
2527 $tablesToTruncate[] = 'civicrm_custom_group';
2528 $tablesToTruncate[] = 'civicrm_custom_field';
2531 $tablesToTruncate = array_unique(array_merge($this->_tablesToTruncate
, $tablesToTruncate));
2533 CRM_Core_DAO
::executeQuery("SET FOREIGN_KEY_CHECKS = 0;");
2534 foreach ($tablesToTruncate as $table) {
2535 $sql = "TRUNCATE TABLE $table";
2536 CRM_Core_DAO
::executeQuery($sql);
2538 CRM_Core_DAO
::executeQuery("SET FOREIGN_KEY_CHECKS = 1;");
2540 if ($dropCustomValueTables) {
2541 $dbName = self
::getDBName();
2543 SELECT TABLE_NAME as tableName
2544 FROM INFORMATION_SCHEMA.TABLES
2545 WHERE TABLE_SCHEMA = '{$dbName}'
2546 AND ( TABLE_NAME LIKE 'civicrm_value_%' )
2549 $tableDAO = CRM_Core_DAO
::executeQuery($query);
2550 while ($tableDAO->fetch()) {
2551 $sql = "DROP TABLE {$tableDAO->tableName}";
2552 CRM_Core_DAO
::executeQuery($sql);
2558 * Clean up financial entities after financial tests (so we remember to get all the tables :-))
2560 public function quickCleanUpFinancialEntities() {
2561 $tablesToTruncate = array(
2562 'civicrm_contribution',
2563 'civicrm_contribution_soft',
2564 'civicrm_financial_trxn',
2565 'civicrm_financial_item',
2566 'civicrm_contribution_recur',
2567 'civicrm_line_item',
2568 'civicrm_contribution_page',
2569 'civicrm_payment_processor',
2570 'civicrm_entity_financial_trxn',
2571 'civicrm_membership',
2572 'civicrm_membership_type',
2573 'civicrm_membership_payment',
2574 'civicrm_membership_log',
2575 'civicrm_membership_block',
2577 'civicrm_participant',
2578 'civicrm_participant_payment',
2580 'civicrm_price_set_entity',
2581 'civicrm_price_field_value',
2582 'civicrm_price_field',
2584 $this->quickCleanup($tablesToTruncate);
2585 CRM_Core_DAO
::executeQuery("DELETE FROM civicrm_membership_status WHERE name NOT IN('New', 'Current', 'Grace', 'Expired', 'Pending', 'Cancelled', 'Deceased')");
2586 $this->restoreDefaultPriceSetConfig();
2588 CRM_Member_BAO_Membership
::createRelatedMemberships($var, $var, TRUE);
2589 Civi\Payment\System
::singleton()->flushProcessors();
2592 public function restoreDefaultPriceSetConfig() {
2593 CRM_Core_DAO
::executeQuery("INSERT INTO `civicrm_price_field` (`id`, `price_set_id`, `name`, `label`, `html_type`, `is_enter_qty`, `help_pre`, `help_post`, `weight`, `is_display_amounts`, `options_per_line`, `is_active`, `is_required`, `active_on`, `expire_on`, `javascript`, `visibility_id`) VALUES (1, 1, 'contribution_amount', 'Contribution Amount', 'Text', 0, NULL, NULL, 1, 1, 1, 1, 1, NULL, NULL, NULL, 1)");
2594 CRM_Core_DAO
::executeQuery("INSERT INTO `civicrm_price_field_value` (`id`, `price_field_id`, `name`, `label`, `description`, `amount`, `count`, `max_value`, `weight`, `membership_type_id`, `membership_num_terms`, `is_default`, `is_active`, `financial_type_id`, `deductible_amount`) VALUES (1, 1, 'contribution_amount', 'Contribution Amount', NULL, '1', NULL, NULL, 1, NULL, NULL, 0, 1, 1, 0.00)");
2597 * Function does a 'Get' on the entity & compares the fields in the Params with those returned
2598 * Default behaviour is to also delete the entity
2599 * @param array $params
2600 * Params array to check agains.
2602 * Id of the entity concerned.
2603 * @param string $entity
2604 * Name of entity concerned (e.g. membership).
2605 * @param bool $delete
2606 * Should the entity be deleted as part of this check.
2607 * @param string $errorText
2608 * Text to print on error.
2611 * @param array $params
2614 * @param int $delete
2615 * @param string $errorText
2619 public function getAndCheck($params, $id, $entity, $delete = 1, $errorText = '') {
2621 $result = $this->callAPISuccessGetSingle($entity, array(
2626 $this->callAPISuccess($entity, 'Delete', array(
2630 $dateFields = $keys = $dateTimeFields = array();
2631 $fields = $this->callAPISuccess($entity, 'getfields', array('version' => 3, 'action' => 'get'));
2632 foreach ($fields['values'] as $field => $settings) {
2633 if (array_key_exists($field, $result)) {
2634 $keys[CRM_Utils_Array
::Value('name', $settings, $field)] = $field;
2637 $keys[CRM_Utils_Array
::Value('name', $settings, $field)] = CRM_Utils_Array
::value('name', $settings, $field);
2639 $type = CRM_Utils_Array
::value('type', $settings);
2640 if ($type == CRM_Utils_Type
::T_DATE
) {
2641 $dateFields[] = $settings['name'];
2642 // we should identify both real names & unique names as dates
2643 if ($field != $settings['name']) {
2644 $dateFields[] = $field;
2647 if ($type == CRM_Utils_Type
::T_DATE + CRM_Utils_Type
::T_TIME
) {
2648 $dateTimeFields[] = $settings['name'];
2649 // we should identify both real names & unique names as dates
2650 if ($field != $settings['name']) {
2651 $dateTimeFields[] = $field;
2656 if (strtolower($entity) == 'contribution') {
2657 $params['receive_date'] = date('Y-m-d', strtotime($params['receive_date']));
2658 // this is not returned in id format
2659 unset($params['payment_instrument_id']);
2660 $params['contribution_source'] = $params['source'];
2661 unset($params['source']);
2664 foreach ($params as $key => $value) {
2665 if ($key == 'version' ||
substr($key, 0, 3) == 'api' ||
!array_key_exists($keys[$key], $result)) {
2668 if (in_array($key, $dateFields)) {
2669 $value = date('Y-m-d', strtotime($value));
2670 $result[$key] = date('Y-m-d', strtotime($result[$key]));
2672 if (in_array($key, $dateTimeFields)) {
2673 $value = date('Y-m-d H:i:s', strtotime($value));
2674 $result[$keys[$key]] = date('Y-m-d H:i:s', strtotime(CRM_Utils_Array
::value($keys[$key], $result, CRM_Utils_Array
::value($key, $result))));
2676 $this->assertEquals($value, $result[$keys[$key]], $key . " GetandCheck function determines that for key {$key} value: $value doesn't match " . print_r($result[$keys[$key]], TRUE) . $errorText);
2681 * Get formatted values in the actual and expected result.
2682 * @param array $actual
2683 * Actual calculated values.
2684 * @param array $expected
2687 public function checkArrayEquals(&$actual, &$expected) {
2688 self
::unsetId($actual);
2689 self
::unsetId($expected);
2690 $this->assertEquals($actual, $expected);
2694 * Unset the key 'id' from the array
2695 * @param array $unformattedArray
2696 * The array from which the 'id' has to be unset.
2698 public static function unsetId(&$unformattedArray) {
2699 $formattedArray = array();
2700 if (array_key_exists('id', $unformattedArray)) {
2701 unset($unformattedArray['id']);
2703 if (!empty($unformattedArray['values']) && is_array($unformattedArray['values'])) {
2704 foreach ($unformattedArray['values'] as $key => $value) {
2705 if (is_array($value)) {
2706 foreach ($value as $k => $v) {
2712 elseif ($key == 'id') {
2713 $unformattedArray[$key];
2715 $formattedArray = array($value);
2717 $unformattedArray['values'] = $formattedArray;
2722 * Helper to enable/disable custom directory support
2724 * @param array $customDirs
2726 * 'php_path' Set to TRUE to use the default, FALSE or "" to disable support, or a string path to use another path
2727 * 'template_path' Set to TRUE to use the default, FALSE or "" to disable support, or a string path to use another path
2729 public function customDirectories($customDirs) {
2730 require_once 'CRM/Core/Config.php';
2731 $config = CRM_Core_Config
::singleton();
2733 if (empty($customDirs['php_path']) ||
$customDirs['php_path'] === FALSE) {
2734 unset($config->customPHPPathDir
);
2736 elseif ($customDirs['php_path'] === TRUE) {
2737 $config->customPHPPathDir
= dirname(dirname(__FILE__
)) . '/custom_directories/php/';
2740 $config->customPHPPathDir
= $php_path;
2743 if (empty($customDirs['template_path']) ||
$customDirs['template_path'] === FALSE) {
2744 unset($config->customTemplateDir
);
2746 elseif ($customDirs['template_path'] === TRUE) {
2747 $config->customTemplateDir
= dirname(dirname(__FILE__
)) . '/custom_directories/templates/';
2750 $config->customTemplateDir
= $template_path;
2755 * Generate a temporary folder.
2757 * @param string $prefix
2760 public function createTempDir($prefix = 'test-') {
2761 $tempDir = CRM_Utils_File
::tempdir($prefix);
2762 $this->tempDirs
[] = $tempDir;
2766 public function cleanTempDirs() {
2767 if (!is_array($this->tempDirs
)) {
2768 // fix test errors where this is not set
2771 foreach ($this->tempDirs
as $tempDir) {
2772 if (is_dir($tempDir)) {
2773 CRM_Utils_File
::cleanDir($tempDir, TRUE, FALSE);
2779 * Temporarily replace the singleton extension with a different one.
2780 * @param \CRM_Extension_System $system
2782 public function setExtensionSystem(CRM_Extension_System
$system) {
2783 if ($this->origExtensionSystem
== NULL) {
2784 $this->origExtensionSystem
= CRM_Extension_System
::singleton();
2786 CRM_Extension_System
::setSingleton($this->origExtensionSystem
);
2789 public function unsetExtensionSystem() {
2790 if ($this->origExtensionSystem
!== NULL) {
2791 CRM_Extension_System
::setSingleton($this->origExtensionSystem
);
2792 $this->origExtensionSystem
= NULL;
2797 * Temporarily alter the settings-metadata to add a mock setting.
2799 * WARNING: The setting metadata will disappear on the next cache-clear.
2804 public function setMockSettingsMetaData($extras) {
2805 CRM_Core_BAO_Setting
::$_cache = array();
2806 $this->callAPISuccess('system', 'flush', array());
2807 CRM_Core_BAO_Setting
::$_cache = array();
2809 CRM_Utils_Hook
::singleton()
2810 ->setHook('civicrm_alterSettingsMetaData', function (&$metadata, $domainId, $profile) use ($extras) {
2811 $metadata = array_merge($metadata, $extras);
2814 $fields = $this->callAPISuccess('setting', 'getfields', array());
2815 foreach ($extras as $key => $spec) {
2816 $this->assertNotEmpty($spec['title']);
2817 $this->assertEquals($spec['title'], $fields['values'][$key]['title']);
2822 * @param string $name
2824 public function financialAccountDelete($name) {
2825 $financialAccount = new CRM_Financial_DAO_FinancialAccount();
2826 $financialAccount->name
= $name;
2827 if ($financialAccount->find(TRUE)) {
2828 $entityFinancialType = new CRM_Financial_DAO_EntityFinancialAccount();
2829 $entityFinancialType->financial_account_id
= $financialAccount->id
;
2830 $entityFinancialType->delete();
2831 $financialAccount->delete();
2836 * FIXME: something NULLs $GLOBALS['_HTML_QuickForm_registered_rules'] when the tests are ran all together
2837 * (NB unclear if this is still required)
2839 public function _sethtmlGlobals() {
2840 $GLOBALS['_HTML_QuickForm_registered_rules'] = array(
2841 'required' => array(
2842 'html_quickform_rule_required',
2843 'HTML/QuickForm/Rule/Required.php',
2845 'maxlength' => array(
2846 'html_quickform_rule_range',
2847 'HTML/QuickForm/Rule/Range.php',
2849 'minlength' => array(
2850 'html_quickform_rule_range',
2851 'HTML/QuickForm/Rule/Range.php',
2853 'rangelength' => array(
2854 'html_quickform_rule_range',
2855 'HTML/QuickForm/Rule/Range.php',
2858 'html_quickform_rule_email',
2859 'HTML/QuickForm/Rule/Email.php',
2862 'html_quickform_rule_regex',
2863 'HTML/QuickForm/Rule/Regex.php',
2865 'lettersonly' => array(
2866 'html_quickform_rule_regex',
2867 'HTML/QuickForm/Rule/Regex.php',
2869 'alphanumeric' => array(
2870 'html_quickform_rule_regex',
2871 'HTML/QuickForm/Rule/Regex.php',
2874 'html_quickform_rule_regex',
2875 'HTML/QuickForm/Rule/Regex.php',
2877 'nopunctuation' => array(
2878 'html_quickform_rule_regex',
2879 'HTML/QuickForm/Rule/Regex.php',
2882 'html_quickform_rule_regex',
2883 'HTML/QuickForm/Rule/Regex.php',
2885 'callback' => array(
2886 'html_quickform_rule_callback',
2887 'HTML/QuickForm/Rule/Callback.php',
2890 'html_quickform_rule_compare',
2891 'HTML/QuickForm/Rule/Compare.php',
2894 // FIXME: …ditto for $GLOBALS['HTML_QUICKFORM_ELEMENT_TYPES']
2895 $GLOBALS['HTML_QUICKFORM_ELEMENT_TYPES'] = array(
2897 'HTML/QuickForm/group.php',
2898 'HTML_QuickForm_group',
2901 'HTML/QuickForm/hidden.php',
2902 'HTML_QuickForm_hidden',
2905 'HTML/QuickForm/reset.php',
2906 'HTML_QuickForm_reset',
2908 'checkbox' => array(
2909 'HTML/QuickForm/checkbox.php',
2910 'HTML_QuickForm_checkbox',
2913 'HTML/QuickForm/file.php',
2914 'HTML_QuickForm_file',
2917 'HTML/QuickForm/image.php',
2918 'HTML_QuickForm_image',
2920 'password' => array(
2921 'HTML/QuickForm/password.php',
2922 'HTML_QuickForm_password',
2925 'HTML/QuickForm/radio.php',
2926 'HTML_QuickForm_radio',
2929 'HTML/QuickForm/button.php',
2930 'HTML_QuickForm_button',
2933 'HTML/QuickForm/submit.php',
2934 'HTML_QuickForm_submit',
2937 'HTML/QuickForm/select.php',
2938 'HTML_QuickForm_select',
2940 'hiddenselect' => array(
2941 'HTML/QuickForm/hiddenselect.php',
2942 'HTML_QuickForm_hiddenselect',
2945 'HTML/QuickForm/text.php',
2946 'HTML_QuickForm_text',
2948 'textarea' => array(
2949 'HTML/QuickForm/textarea.php',
2950 'HTML_QuickForm_textarea',
2952 'fckeditor' => array(
2953 'HTML/QuickForm/fckeditor.php',
2954 'HTML_QuickForm_FCKEditor',
2957 'HTML/QuickForm/tinymce.php',
2958 'HTML_QuickForm_TinyMCE',
2960 'dojoeditor' => array(
2961 'HTML/QuickForm/dojoeditor.php',
2962 'HTML_QuickForm_dojoeditor',
2965 'HTML/QuickForm/link.php',
2966 'HTML_QuickForm_link',
2968 'advcheckbox' => array(
2969 'HTML/QuickForm/advcheckbox.php',
2970 'HTML_QuickForm_advcheckbox',
2973 'HTML/QuickForm/date.php',
2974 'HTML_QuickForm_date',
2977 'HTML/QuickForm/static.php',
2978 'HTML_QuickForm_static',
2981 'HTML/QuickForm/header.php',
2982 'HTML_QuickForm_header',
2985 'HTML/QuickForm/html.php',
2986 'HTML_QuickForm_html',
2988 'hierselect' => array(
2989 'HTML/QuickForm/hierselect.php',
2990 'HTML_QuickForm_hierselect',
2992 'autocomplete' => array(
2993 'HTML/QuickForm/autocomplete.php',
2994 'HTML_QuickForm_autocomplete',
2997 'HTML/QuickForm/xbutton.php',
2998 'HTML_QuickForm_xbutton',
3000 'advmultiselect' => array(
3001 'HTML/QuickForm/advmultiselect.php',
3002 'HTML_QuickForm_advmultiselect',
3008 * Set up an acl allowing contact to see 2 specified groups
3009 * - $this->_permissionedGroup & $this->_permissionedDisabledGroup
3011 * You need to have pre-created these groups & created the user e.g
3012 * $this->createLoggedInUser();
3013 * $this->_permissionedDisabledGroup = $this->groupCreate(array('title' => 'pick-me-disabled', 'is_active' => 0, 'name' => 'pick-me-disabled'));
3014 * $this->_permissionedGroup = $this->groupCreate(array('title' => 'pick-me-active', 'is_active' => 1, 'name' => 'pick-me-active'));
3016 public function setupACL() {
3018 $_REQUEST = $this->_params
;
3020 CRM_Core_Config
::singleton()->userPermissionClass
->permissions
= array('access CiviCRM');
3021 $optionGroupID = $this->callAPISuccessGetValue('option_group', array('return' => 'id', 'name' => 'acl_role'));
3022 $optionValue = $this->callAPISuccess('option_value', 'create', array(
3023 'option_group_id' => $optionGroupID,
3024 'label' => 'pick me',
3028 CRM_Core_DAO
::executeQuery("
3029 TRUNCATE civicrm_acl_cache
3032 CRM_Core_DAO
::executeQuery("
3033 TRUNCATE civicrm_acl_contact_cache
3036 CRM_Core_DAO
::executeQuery("
3037 INSERT INTO civicrm_acl_entity_role (
3038 `acl_role_id`, `entity_table`, `entity_id`
3039 ) VALUES (55, 'civicrm_group', {$this->_permissionedGroup});
3042 CRM_Core_DAO
::executeQuery("
3043 INSERT INTO civicrm_acl (
3044 `name`, `entity_table`, `entity_id`, `operation`, `object_table`, `object_id`, `is_active`
3047 'view picked', 'civicrm_group', $this->_permissionedGroup , 'Edit', 'civicrm_saved_search', {$this->_permissionedGroup}, 1
3051 CRM_Core_DAO
::executeQuery("
3052 INSERT INTO civicrm_acl (
3053 `name`, `entity_table`, `entity_id`, `operation`, `object_table`, `object_id`, `is_active`
3056 'view picked', 'civicrm_group', $this->_permissionedGroup, 'Edit', 'civicrm_saved_search', {$this->_permissionedDisabledGroup}, 1
3059 $this->_loggedInUser
= CRM_Core_Session
::singleton()->get('userID');
3060 $this->callAPISuccess('group_contact', 'create', array(
3061 'group_id' => $this->_permissionedGroup
,
3062 'contact_id' => $this->_loggedInUser
,
3065 CRM_ACL_BAO_Cache
::resetCache();
3066 CRM_Contact_BAO_Group
::getPermissionClause(TRUE);
3067 CRM_ACL_API
::groupPermission('whatever', 9999, NULL, 'civicrm_saved_search', NULL, NULL, TRUE);
3071 * Alter default price set so that the field numbers are not all 1 (hiding errors)
3073 public function offsetDefaultPriceSet() {
3074 $contributionPriceSet = $this->callAPISuccess('price_set', 'getsingle', array('name' => 'default_contribution_amount'));
3075 $firstID = $contributionPriceSet['id'];
3076 $this->callAPISuccess('price_set', 'create', array(
3077 'id' => $contributionPriceSet['id'],
3081 unset($contributionPriceSet['id']);
3082 $newPriceSet = $this->callAPISuccess('price_set', 'create', $contributionPriceSet);
3083 $priceField = $this->callAPISuccess('price_field', 'getsingle', array(
3084 'price_set_id' => $firstID,
3085 'options' => array('limit' => 1),
3087 unset($priceField['id']);
3088 $priceField['price_set_id'] = $newPriceSet['id'];
3089 $newPriceField = $this->callAPISuccess('price_field', 'create', $priceField);
3090 $priceFieldValue = $this->callAPISuccess('price_field_value', 'getsingle', array(
3091 'price_set_id' => $firstID,
3093 'options' => array('limit' => 1),
3096 unset($priceFieldValue['id']);
3097 //create some padding to use up ids
3098 $this->callAPISuccess('price_field_value', 'create', $priceFieldValue);
3099 $this->callAPISuccess('price_field_value', 'create', $priceFieldValue);
3100 $this->callAPISuccess('price_field_value', 'create', array_merge($priceFieldValue, array('price_field_id' => $newPriceField['id'])));
3104 * Create an instance of the paypal processor.
3105 * @todo this isn't a great place to put it - but really it belongs on a class that extends
3106 * this parent class & we don't have a structure for that yet
3107 * There is another function to this effect on the PaypalPro test but it appears to be silently failing
3108 * & the best protection agains that is the functions this class affords
3109 * @param array $params
3110 * @return int $result['id'] payment processor id
3112 public function paymentProcessorCreate($params = array()) {
3113 $params = array_merge(array(
3115 'domain_id' => CRM_Core_Config
::domainID(),
3116 'payment_processor_type_id' => 'PayPal',
3120 'user_name' => 'sunil._1183377782_biz_api1.webaccess.co.in',
3121 'password' => '1183377788',
3122 'signature' => 'APixCoQ-Zsaj-u3IH7mD5Do-7HUqA9loGnLSzsZga9Zr-aNmaJa3WGPH',
3123 'url_site' => 'https://www.sandbox.paypal.com/',
3124 'url_api' => 'https://api-3t.sandbox.paypal.com/',
3125 'url_button' => 'https://www.paypal.com/en_US/i/btn/btn_xpressCheckout.gif',
3126 'class_name' => 'Payment_PayPalImpl',
3127 'billing_mode' => 3,
3128 'financial_type_id' => 1,
3131 if (!is_numeric($params['payment_processor_type_id'])) {
3132 // really the api should handle this through getoptions but it's not exactly api call so lets just sort it
3134 $params['payment_processor_type_id'] = $this->callAPISuccess('payment_processor_type', 'getvalue', array(
3135 'name' => $params['payment_processor_type_id'],
3139 $result = $this->callAPISuccess('payment_processor', 'create', $params);
3140 return $result['id'];
3144 * Set up initial recurring payment allowing subsequent IPN payments.
3146 public function setupRecurringPaymentProcessorTransaction() {
3147 $contributionRecur = $this->callAPISuccess('contribution_recur', 'create', array(
3148 'contact_id' => $this->_contactID
,
3151 'installments' => 5,
3152 'frequency_unit' => 'Month',
3153 'frequency_interval' => 1,
3154 'invoice_id' => $this->_invoiceID
,
3155 'contribution_status_id' => 2,
3156 'processor_id' => $this->_paymentProcessorID
,
3157 'api.contribution.create' => array(
3158 'total_amount' => '200',
3159 'invoice_id' => $this->_invoiceID
,
3160 'financial_type_id' => 1,
3161 'contribution_status_id' => 'Pending',
3162 'contact_id' => $this->_contactID
,
3163 'contribution_page_id' => $this->_contributionPageID
,
3164 'payment_processor_id' => $this->_paymentProcessorID
,
3167 $this->_contributionRecurID
= $contributionRecur['id'];
3168 $this->_contributionID
= $contributionRecur['values']['0']['api.contribution.create']['id'];
3172 * We don't have a good way to set up a recurring contribution with a membership so let's just do one then alter it
3174 public function setupMembershipRecurringPaymentProcessorTransaction() {
3175 $this->ids
['membership_type'] = $this->membershipTypeCreate();
3176 //create a contribution so our membership & contribution don't both have id = 1
3177 $this->contributionCreate($this->_contactID
, 1, 'abcd', '345j');
3178 $this->setupRecurringPaymentProcessorTransaction();
3180 $this->ids
['membership'] = $this->callAPISuccess('membership', 'create', array(
3181 'contact_id' => $this->_contactID
,
3182 'membership_type_id' => $this->ids
['membership_type'],
3183 'contribution_recur_id' => $this->_contributionRecurID
,
3184 'format.only_id' => TRUE,
3186 //CRM-15055 creates line items we don't want so get rid of them so we can set up our own line items
3187 CRM_Core_DAO
::executeQuery("TRUNCATE civicrm_line_item");
3189 $this->callAPISuccess('line_item', 'create', array(
3190 'entity_table' => 'civicrm_membership',
3191 'entity_id' => $this->ids
['membership'],
3192 'contribution_id' => $this->_contributionID
,
3193 'label' => 'General',
3195 'unit_price' => 200,
3196 'line_total' => 200,
3197 'financial_type_id' => 1,
3198 'price_field_id' => $this->callAPISuccess('price_field', 'getvalue', array(
3200 'label' => 'Membership Amount',
3202 'price_field_value_id' => $this->callAPISuccess('price_field_value', 'getvalue', array(
3204 'label' => 'General',
3207 $this->callAPISuccess('membership_payment', 'create', array(
3208 'contribution_id' => $this->_contributionID
,
3209 'membership_id' => $this->ids
['membership'],
3218 public function CiviUnitTestCase_fatalErrorHandler($message) {
3219 throw new Exception("{$message['message']}: {$message['code']}");
3223 * Helper function to create new mailing.
3226 public function createMailing() {
3228 'subject' => 'maild' . rand(),
3229 'body_text' => 'bdkfhdskfhduew',
3230 'name' => 'mailing name' . rand(),
3232 'api.mailing_job.create' => 0,
3235 $result = $this->callAPISuccess('Mailing', 'create', $params);
3236 return $result['id'];
3240 * Helper function to delete mailing.
3243 public function deleteMailing($id) {
3248 $this->callAPISuccess('Mailing', 'delete', $params);
3252 * Wrap the entire test case in a transaction.
3254 * Only subsequent DB statements will be wrapped in TX -- this cannot
3255 * retroactively wrap old DB statements. Therefore, it makes sense to
3256 * call this at the beginning of setUp().
3258 * Note: Recall that TRUNCATE and ALTER will force-commit transactions, so
3259 * this option does not work with, e.g., custom-data.
3261 * WISHLIST: Monitor SQL queries in unit-tests and generate an exception
3262 * if TRUNCATE or ALTER is called while using a transaction.
3265 * Whether to use nesting or reference-counting.
3267 public function useTransaction($nest = TRUE) {
3269 $this->tx
= new CRM_Core_Transaction($nest);
3270 $this->tx
->rollback();
3274 public function clearOutputBuffer() {
3275 while (ob_get_level() > 0) {
3282 * @param array $apiResult
3284 protected function assertAttachmentExistence($exists, $apiResult) {
3285 $fileId = $apiResult['id'];
3286 $this->assertTrue(is_numeric($fileId));
3287 $this->assertEquals($exists, file_exists($apiResult['values'][$fileId]['path']));
3288 $this->assertDBQuery($exists ?
1 : 0, 'SELECT count(*) FROM civicrm_file WHERE id = %1', array(
3289 1 => array($fileId, 'Int'),
3291 $this->assertDBQuery($exists ?
1 : 0, 'SELECT count(*) FROM civicrm_entity_file WHERE id = %1', array(
3292 1 => array($fileId, 'Int'),