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();
381 * Common setup functions for all unit tests.
383 protected function setUp() {
384 $session = CRM_Core_Session
::singleton();
385 $session->set('userID', NULL);
387 $this->errorScope
= CRM_Core_TemporaryErrorScope
::useException(); // REVERT
388 // Use a temporary file for STDIN
389 $GLOBALS['stdin'] = tmpfile();
390 if ($GLOBALS['stdin'] === FALSE) {
391 echo "Couldn't open temporary file\n";
395 // Get and save a connection to the database
396 $this->_dbconn
= $this->getConnection();
398 // reload database before each test
399 // $this->_populateDB();
401 // "initialize" CiviCRM to avoid problems when running single tests
402 // FIXME: look at it closer in second stage
404 // initialize the object once db is loaded
405 CRM_Core_Config
::$_mail = NULL;
406 $config = CRM_Core_Config
::singleton();
408 // when running unit tests, use mockup user framework
409 $config->setUserFramework('UnitTests');
410 $this->hookClass
= CRM_Utils_Hook
::singleton(TRUE);
411 // also fix the fatal error handler to throw exceptions,
413 $config->fatalErrorHandler
= 'CiviUnitTestCase_fatalErrorHandler';
415 // enable backtrace to get meaningful errors
416 $config->backtrace
= 1;
418 // disable any left-over test extensions
419 CRM_Core_DAO
::executeQuery('DELETE FROM civicrm_extension WHERE full_name LIKE "test.%"');
421 // reset all the caches
422 CRM_Utils_System
::flushCache();
424 // Make sure the DB connection is setup properly
425 $config->userSystem
->setMySQLTimeZone();
426 $env = new CRM_Utils_Check_Env();
427 CRM_Utils_Check
::singleton()->assertValid($env->checkMysqlTime());
429 // clear permissions stub to not check permissions
430 $config = CRM_Core_Config
::singleton();
431 $config->userPermissionClass
->permissions
= NULL;
433 //flush component settings
434 CRM_Core_Component
::getEnabledComponents(TRUE);
436 if ($this->_eNoticeCompliant
) {
437 error_reporting(E_ALL
);
440 error_reporting(E_ALL
& ~E_NOTICE
);
442 $this->_sethtmlGlobals();
446 * Read everything from the datasets directory and insert into the db.
448 public function loadAllFixtures() {
449 $fixturesDir = __DIR__
. '/../../fixtures';
451 $this->getConnection()->getConnection()->query("SET FOREIGN_KEY_CHECKS = 0;");
453 $xmlFiles = glob($fixturesDir . '/*.xml');
454 foreach ($xmlFiles as $xmlFixture) {
455 $op = new PHPUnit_Extensions_Database_Operation_Insert();
456 $dataset = $this->createXMLDataSet($xmlFixture);
457 $this->_tablesToTruncate
= array_merge($this->_tablesToTruncate
, $dataset->getTableNames());
458 $op->execute($this->_dbconn
, $dataset);
461 $yamlFiles = glob($fixturesDir . '/*.yaml');
462 foreach ($yamlFiles as $yamlFixture) {
463 $op = new PHPUnit_Extensions_Database_Operation_Insert();
464 $dataset = new PHPUnit_Extensions_Database_DataSet_YamlDataSet($yamlFixture);
465 $this->_tablesToTruncate
= array_merge($this->_tablesToTruncate
, $dataset->getTableNames());
466 $op->execute($this->_dbconn
, $dataset);
469 $this->getConnection()->getConnection()->query("SET FOREIGN_KEY_CHECKS = 1;");
473 * Emulate a logged in user since certain functions use that.
474 * value to store a record in the DB (like activity)
478 * Contact ID of the created user.
480 public function createLoggedInUser() {
482 'first_name' => 'Logged In',
483 'last_name' => 'User ' . rand(),
484 'contact_type' => 'Individual',
486 $contactID = $this->individualCreate($params);
487 $this->callAPISuccess('UFMatch', 'create', array(
488 'contact_id' => $contactID,
489 'uf_name' => 'superman',
493 $session = CRM_Core_Session
::singleton();
494 $session->set('userID', $contactID);
498 public function cleanDB() {
499 self
::$populateOnce = NULL;
500 $this->DBResetRequired
= TRUE;
502 $this->_dbconn
= $this->getConnection();
503 static::_populateDB();
504 $this->tempDirs
= array();
508 * Create default domain contacts for the two domains added during test class.
509 * database population.
511 public function createDomainContacts() {
512 $default_domain_contact = $this->organizationCreate();
513 $second_domain_contact = $this->organizationCreate();
517 * Common teardown functions for all unit tests.
519 protected function tearDown() {
520 error_reporting(E_ALL
& ~E_NOTICE
);
521 CRM_Utils_Hook
::singleton()->reset();
522 $this->hookClass
->reset();
523 $session = CRM_Core_Session
::singleton();
524 $session->set('userID', NULL);
527 $this->tx
->rollback()->commit();
530 CRM_Core_Transaction
::forceRollbackIfEnabled();
531 \Civi\Core\Transaction\Manager
::singleton(TRUE);
534 CRM_Core_Transaction
::forceRollbackIfEnabled();
535 \Civi\Core\Transaction\Manager
::singleton(TRUE);
537 $tablesToTruncate = array('civicrm_contact', 'civicrm_uf_match');
538 $this->quickCleanup($tablesToTruncate);
539 $this->createDomainContacts();
542 $this->cleanTempDirs();
543 $this->unsetExtensionSystem();
544 $this->clearOutputBuffer();
548 * FIXME: Maybe a better way to do it
550 public function foreignKeyChecksOff() {
551 self
::$utils = new Utils($GLOBALS['mysql_host'],
552 $GLOBALS['mysql_port'],
553 $GLOBALS['mysql_user'],
554 $GLOBALS['mysql_pass']
556 $dbName = self
::getDBName();
557 $query = "USE {$dbName};" . "SET foreign_key_checks = 1";
558 if (self
::$utils->do_query($query) === FALSE) {
560 echo 'Cannot set foreign_key_checks = 0';
566 public function foreignKeyChecksOn() {
567 // FIXME: might not be needed if previous fixme implemented
571 * Generic function to compare expected values after an api call to retrieved.
574 * @daoName string DAO Name of object we're evaluating.
575 * @id int Id of object
576 * @match array Associative array of field name => expected value. Empty if asserting
577 * that a DELETE occurred
578 * @delete boolean True if we're checking that a DELETE action occurred.
582 * @param bool $delete
583 * @throws \PHPUnit_Framework_AssertionFailedError
585 public function assertDBState($daoName, $id, $match, $delete = FALSE) {
587 // adding this here since developers forget to check for an id
588 // and hence we get the first value in the db
589 $this->fail('ID not populated. Please fix your assertDBState usage!!!');
592 $object = new $daoName();
596 // If we're asserting successful record deletion, make sure object is NOT found.
598 if ($object->find(TRUE)) {
599 $this->fail("Object not deleted by delete operation: $daoName, $id");
604 // Otherwise check matches of DAO field values against expected values in $match.
605 if ($object->find(TRUE)) {
606 $fields = &$object->fields();
607 foreach ($fields as $name => $value) {
608 $dbName = $value['name'];
609 if (isset($match[$name])) {
611 $this->assertEquals($object->$dbName, $match[$name]);
613 elseif (isset($match[$dbName])) {
615 $this->assertEquals($object->$dbName, $match[$dbName]);
620 $this->fail("Could not retrieve object: $daoName, $id");
623 $matchSize = count($match);
624 if ($verifiedCount != $matchSize) {
625 $this->fail("Did not verify all fields in match array: $daoName, $id. Verified count = $verifiedCount. Match array size = $matchSize");
630 * Request a record from the DB by seachColumn+searchValue. Success if a record is found.
631 * @param string $daoName
632 * @param $searchValue
633 * @param $returnColumn
634 * @param $searchColumn
637 * @return null|string
638 * @throws PHPUnit_Framework_AssertionFailedError
640 public function assertDBNotNull($daoName, $searchValue, $returnColumn, $searchColumn, $message) {
641 if (empty($searchValue)) {
642 $this->fail("empty value passed to assertDBNotNull");
644 $value = CRM_Core_DAO
::getFieldValue($daoName, $searchValue, $returnColumn, $searchColumn, TRUE);
645 $this->assertNotNull($value, $message);
651 * Request a record from the DB by seachColumn+searchValue. Success if returnColumn value is NULL.
652 * @param string $daoName
653 * @param $searchValue
654 * @param $returnColumn
655 * @param $searchColumn
658 public function assertDBNull($daoName, $searchValue, $returnColumn, $searchColumn, $message) {
659 $value = CRM_Core_DAO
::getFieldValue($daoName, $searchValue, $returnColumn, $searchColumn, TRUE);
660 $this->assertNull($value, $message);
664 * Request a record from the DB by id. Success if row not found.
665 * @param string $daoName
667 * @param null $message
669 public function assertDBRowNotExist($daoName, $id, $message = NULL) {
670 $message = $message ?
$message : "$daoName (#$id) should not exist";
671 $value = CRM_Core_DAO
::getFieldValue($daoName, $id, 'id', 'id', TRUE);
672 $this->assertNull($value, $message);
676 * Request a record from the DB by id. Success if row not found.
677 * @param string $daoName
679 * @param null $message
681 public function assertDBRowExist($daoName, $id, $message = NULL) {
682 $message = $message ?
$message : "$daoName (#$id) should exist";
683 $value = CRM_Core_DAO
::getFieldValue($daoName, $id, 'id', 'id', TRUE);
684 $this->assertEquals($id, $value, $message);
688 * Compare a single column value in a retrieved DB record to an expected value.
689 * @param string $daoName
690 * @param $searchValue
691 * @param $returnColumn
692 * @param $searchColumn
693 * @param $expectedValue
696 public function assertDBCompareValue(
697 $daoName, $searchValue, $returnColumn, $searchColumn,
698 $expectedValue, $message
700 $value = CRM_Core_DAO
::getFieldValue($daoName, $searchValue, $returnColumn, $searchColumn, TRUE);
701 $this->assertEquals($value, $expectedValue, $message);
705 * Compare all values in a single retrieved DB record to an array of expected values.
706 * @param string $daoName
707 * @param array $searchParams
708 * @param $expectedValues
710 public function assertDBCompareValues($daoName, $searchParams, $expectedValues) {
711 //get the values from db
713 CRM_Core_DAO
::commonRetrieve($daoName, $searchParams, $dbValues);
715 // compare db values with expected values
716 self
::assertAttributesEquals($expectedValues, $dbValues);
720 * Assert that a SQL query returns a given value.
722 * The first argument is an expected value. The remaining arguments are passed
723 * to CRM_Core_DAO::singleValueQuery
725 * Example: $this->assertSql(2, 'select count(*) from foo where foo.bar like "%1"',
726 * array(1 => array("Whiz", "String")));
729 * @param array $params
730 * @param string $message
732 public function assertDBQuery($expected, $query, $params = array(), $message = '') {
736 $actual = CRM_Core_DAO
::singleValueQuery($query, $params);
737 $this->assertEquals($expected, $actual,
738 sprintf('%sexpected=[%s] actual=[%s] query=[%s]',
739 $message, $expected, $actual, CRM_Core_DAO
::composeQuery($query, $params, FALSE)
745 * Assert that two array-trees are exactly equal, notwithstanding
746 * the sorting of keys
748 * @param array $expected
749 * @param array $actual
751 public function assertTreeEquals($expected, $actual) {
754 CRM_Utils_Array
::flatten($expected, $e, '', ':::');
755 CRM_Utils_Array
::flatten($actual, $a, '', ':::');
759 $this->assertEquals($e, $a);
763 * Assert that two numbers are approximately equal.
765 * @param int|float $expected
766 * @param int|float $actual
767 * @param int|float $tolerance
768 * @param string $message
770 public function assertApproxEquals($expected, $actual, $tolerance, $message = NULL) {
771 if ($message === NULL) {
772 $message = sprintf("approx-equals: expected=[%.3f] actual=[%.3f] tolerance=[%.3f]", $expected, $actual, $tolerance);
774 $this->assertTrue(abs($actual - $expected) < $tolerance, $message);
778 * Assert attributes are equal.
780 * @param $expectedValues
781 * @param $actualValues
782 * @param string $message
784 * @throws PHPUnit_Framework_AssertionFailedError
786 public function assertAttributesEquals($expectedValues, $actualValues, $message = NULL) {
787 foreach ($expectedValues as $paramName => $paramValue) {
788 if (isset($actualValues[$paramName])) {
789 $this->assertEquals($paramValue, $actualValues[$paramName], "Value Mismatch On $paramName - value 1 is " . print_r($paramValue, TRUE) . " value 2 is " . print_r($actualValues[$paramName], TRUE));
792 $this->fail("Attribute '$paramName' not present in actual array.");
801 public function assertArrayKeyExists($key, &$list) {
802 $result = isset($list[$key]) ?
TRUE : FALSE;
803 $this->assertTrue($result, ts("%1 element exists?",
812 public function assertArrayValueNotNull($key, &$list) {
813 $this->assertArrayKeyExists($key, $list);
815 $value = isset($list[$key]) ?
$list[$key] : NULL;
816 $this->assertTrue($value,
817 ts("%1 element not null?",
824 * Check that api returned 'is_error' => 0.
826 * @param array $apiResult
828 * @param string $prefix
829 * Extra test to add to message.
831 public function assertAPISuccess($apiResult, $prefix = '') {
832 if (!empty($prefix)) {
835 $errorMessage = empty($apiResult['error_message']) ?
'' : " " . $apiResult['error_message'];
837 if (!empty($apiResult['debug_information'])) {
838 $errorMessage .= "\n " . print_r($apiResult['debug_information'], TRUE);
840 if (!empty($apiResult['trace'])) {
841 $errorMessage .= "\n" . print_r($apiResult['trace'], TRUE);
843 $this->assertEquals(0, $apiResult['is_error'], $prefix . $errorMessage);
847 * Check that api returned 'is_error' => 1.
849 * @param array $apiResult
851 * @param string $prefix
852 * Extra test to add to message.
853 * @param null $expectedError
855 public function assertAPIFailure($apiResult, $prefix = '', $expectedError = NULL) {
856 if (!empty($prefix)) {
859 if ($expectedError && !empty($apiResult['is_error'])) {
860 $this->assertEquals($expectedError, $apiResult['error_message'], 'api error message not as expected' . $prefix);
862 $this->assertEquals(1, $apiResult['is_error'], "api call should have failed but it succeeded " . $prefix . (print_r($apiResult, TRUE)));
863 $this->assertNotEmpty($apiResult['error_message']);
869 * @param string $message
871 public function assertType($expected, $actual, $message = '') {
872 return $this->assertInternalType($expected, $actual, $message);
876 * Check that a deleted item has been deleted.
881 public function assertAPIDeleted($entity, $id) {
882 $this->callAPISuccess($entity, 'getcount', array('id' => $id), 0);
887 * Check that api returned 'is_error' => 1
888 * else provide full message
889 * @param array $result
891 * @param array $valuesToExclude
892 * @param string $prefix
893 * Extra test to add to message.
895 public function assertAPIArrayComparison($result, $expected, $valuesToExclude = array(), $prefix = '') {
896 $valuesToExclude = array_merge($valuesToExclude, array('debug', 'xdebug', 'sequential'));
897 foreach ($valuesToExclude as $value) {
898 if (isset($result[$value])) {
899 unset($result[$value]);
901 if (isset($expected[$value])) {
902 unset($expected[$value]);
905 $this->assertEquals($result, $expected, "api result array comparison failed " . $prefix . print_r($result, TRUE) . ' was compared to ' . print_r($expected, TRUE));
909 * A stub for the API interface. This can be overriden by subclasses to change how the API is called.
913 * @param array $params
916 public function civicrm_api($entity, $action, $params) {
917 return civicrm_api($entity, $action, $params);
921 * Create a batch of external API calls which can
922 * be executed concurrently.
925 * $calls = $this->createExternalAPI()
926 * ->addCall('Contact', 'get', ...)
927 * ->addCall('Contact', 'get', ...)
933 * @return \Civi\API\ExternalBatch
934 * @throws PHPUnit_Framework_SkippedTestError
936 public function createExternalAPI() {
937 global $civicrm_root;
938 $defaultParams = array(
939 'version' => $this->_apiversion
,
943 $calls = new \Civi\API\
ExternalBatch($defaultParams);
944 $calls->setSettingsPath("$civicrm_root/tests/phpunit/CiviTest/civicrm.settings.cli.php");
946 if (!$calls->isSupported()) {
947 $this->markTestSkipped('The test relies on Civi\API\ExternalBatch. This is unsupported in the local environment.');
954 * wrap api functions.
955 * so we can ensure they succeed & throw exceptions without litterering the test with checks
957 * @param string $entity
958 * @param string $action
959 * @param array $params
960 * @param mixed $checkAgainst
961 * Optional value to check result against, implemented for getvalue,.
962 * getcount, getsingle. Note that for getvalue the type is checked rather than the value
963 * for getsingle the array is compared against an array passed in - the id is not compared (for
968 public function callAPISuccess($entity, $action, $params, $checkAgainst = NULL) {
969 $params = array_merge(array(
970 'version' => $this->_apiversion
,
975 switch (strtolower($action)) {
977 return $this->callAPISuccessGetValue($entity, $params, $checkAgainst);
980 return $this->callAPISuccessGetSingle($entity, $params, $checkAgainst);
983 return $this->callAPISuccessGetCount($entity, $params, $checkAgainst);
985 $result = $this->civicrm_api($entity, $action, $params);
986 $this->assertAPISuccess($result, "Failure in api call for $entity $action");
991 * This function exists to wrap api getValue function & check the result
992 * so we can ensure they succeed & throw exceptions without litterering the test with checks
993 * There is a type check in this
995 * @param string $entity
996 * @param array $params
997 * @param string $type
998 * Per http://php.net/manual/en/function.gettype.php possible types.
1008 public function callAPISuccessGetValue($entity, $params, $type = NULL) {
1010 'version' => $this->_apiversion
,
1013 $result = $this->civicrm_api($entity, 'getvalue', $params);
1015 if ($type == 'integer') {
1016 // api seems to return integers as strings
1017 $this->assertTrue(is_numeric($result), "expected a numeric value but got " . print_r($result, 1));
1020 $this->assertType($type, $result, "returned result should have been of type $type but was ");
1027 * This function exists to wrap api getsingle function & check the result
1028 * so we can ensure they succeed & throw exceptions without litterering the test with checks
1030 * @param string $entity
1031 * @param array $params
1032 * @param array $checkAgainst
1033 * Array to compare result against.
1044 public function callAPISuccessGetSingle($entity, $params, $checkAgainst = NULL) {
1046 'version' => $this->_apiversion
,
1049 $result = $this->civicrm_api($entity, 'getsingle', $params);
1050 if (!is_array($result) ||
!empty($result['is_error']) ||
isset($result['values'])) {
1051 throw new Exception('Invalid getsingle result' . print_r($result, TRUE));
1053 if ($checkAgainst) {
1054 // @todo - have gone with the fn that unsets id? should we check id?
1055 $this->checkArrayEquals($result, $checkAgainst);
1061 * This function exists to wrap api getValue function & check the result
1062 * so we can ensure they succeed & throw exceptions without litterering the test with checks
1063 * There is a type check in this
1064 * @param string $entity
1065 * @param array $params
1066 * @param null $count
1070 public function callAPISuccessGetCount($entity, $params, $count = NULL) {
1072 'version' => $this->_apiversion
,
1075 $result = $this->civicrm_api($entity, 'getcount', $params);
1076 if (!is_int($result) ||
!empty($result['is_error']) ||
isset($result['values'])) {
1077 throw new Exception('Invalid getcount result : ' . print_r($result, TRUE) . " type :" . gettype($result));
1079 if (is_int($count)) {
1080 $this->assertEquals($count, $result, "incorrect count returned from $entity getcount");
1086 * This function exists to wrap api functions.
1087 * so we can ensure they succeed, generate and example & throw exceptions without litterering the test with checks
1089 * @param string $entity
1090 * @param string $action
1091 * @param array $params
1092 * @param string $function
1093 * Pass this in to create a generated example.
1094 * @param string $file
1095 * Pass this in to create a generated example.
1096 * @param string $description
1097 * @param string|null $exampleName
1101 public function callAPIAndDocument($entity, $action, $params, $function, $file, $description = "", $exampleName = NULL) {
1102 $params['version'] = $this->_apiversion
;
1103 $result = $this->callAPISuccess($entity, $action, $params);
1104 $this->documentMe($entity, $action, $params, $result, $function, $file, $description, $exampleName);
1109 * This function exists to wrap api functions.
1110 * so we can ensure they fail where expected & throw exceptions without litterering the test with checks
1111 * @param string $entity
1112 * @param string $action
1113 * @param array $params
1114 * @param string $expectedErrorMessage
1116 * @param null $extraOutput
1119 public function callAPIFailure($entity, $action, $params, $expectedErrorMessage = NULL, $extraOutput = NULL) {
1120 if (is_array($params)) {
1122 'version' => $this->_apiversion
,
1125 $result = $this->civicrm_api($entity, $action, $params);
1126 $this->assertAPIFailure($result, "We expected a failure for $entity $action but got a success");
1131 * Create required data based on $this->entity & $this->params
1132 * This is just a way to set up the test data for delete & get functions
1133 * so the distinction between set
1134 * up & tested functions is clearer
1139 public function createTestEntity() {
1140 return $entity = $this->callAPISuccess($this->entity
, 'create', $this->params
);
1144 * Generic function to create Organisation, to be used in test cases
1146 * @param array $params
1147 * parameters for civicrm_contact_add api function call
1149 * sequence number if creating multiple organizations
1152 * id of Organisation created
1154 public function organizationCreate($params = array(), $seq = 0) {
1158 $params = array_merge($this->sampleContact('Organization', $seq), $params);
1159 return $this->_contactCreate($params);
1163 * Generic function to create Individual, to be used in test cases
1165 * @param array $params
1166 * parameters for civicrm_contact_add api function call
1168 * sequence number if creating multiple individuals
1171 * id of Individual created
1173 public function individualCreate($params = array(), $seq = 0) {
1174 $params = array_merge($this->sampleContact('Individual', $seq), $params);
1175 return $this->_contactCreate($params);
1179 * Generic function to create Household, to be used in test cases
1181 * @param array $params
1182 * parameters for civicrm_contact_add api function call
1184 * sequence number if creating multiple households
1187 * id of Household created
1189 public function householdCreate($params = array(), $seq = 0) {
1190 $params = array_merge($this->sampleContact('Household', $seq), $params);
1191 return $this->_contactCreate($params);
1195 * Helper function for getting sample contact properties.
1197 * @param string $contact_type
1198 * enum contact type: Individual, Organization
1200 * sequence number for the values of this type
1203 * properties of sample contact (ie. $params for API call)
1205 public function sampleContact($contact_type, $seq = 0) {
1207 'Individual' => array(
1208 // The number of values in each list need to be coprime numbers to not have duplicates
1209 'first_name' => array('Anthony', 'Joe', 'Terrence', 'Lucie', 'Albert', 'Bill', 'Kim'),
1210 'middle_name' => array('J.', 'M.', 'P', 'L.', 'K.', 'A.', 'B.', 'C.', 'D', 'E.', 'Z.'),
1211 'last_name' => array('Anderson', 'Miller', 'Smith', 'Collins', 'Peterson'),
1213 'Organization' => array(
1214 'organization_name' => array(
1215 'Unit Test Organization',
1222 'Household' => array(
1223 'household_name' => array('Unit Test household'),
1226 $params = array('contact_type' => $contact_type);
1227 foreach ($samples[$contact_type] as $key => $values) {
1228 $params[$key] = $values[$seq %
count($values)];
1230 if ($contact_type == 'Individual') {
1231 $params['email'] = strtolower(
1232 $params['first_name'] . '_' . $params['last_name'] . '@civicrm.org'
1234 $params['prefix_id'] = 3;
1235 $params['suffix_id'] = 3;
1241 * Private helper function for calling civicrm_contact_add.
1243 * @param array $params
1244 * For civicrm_contact_add api function call.
1249 * id of Household created
1251 private function _contactCreate($params) {
1252 $result = $this->callAPISuccess('contact', 'create', $params);
1253 if (!empty($result['is_error']) ||
empty($result['id'])) {
1254 throw new Exception('Could not create test contact, with message: ' . CRM_Utils_Array
::value('error_message', $result) . "\nBacktrace:" . CRM_Utils_Array
::value('trace', $result));
1256 return $result['id'];
1260 * Delete contact, ensuring it is not the domain contact
1262 * @param int $contactID
1263 * Contact ID to delete
1265 public function contactDelete($contactID) {
1266 $domain = new CRM_Core_BAO_Domain();
1267 $domain->contact_id
= $contactID;
1268 if (!$domain->find(TRUE)) {
1269 $this->callAPISuccess('contact', 'delete', array(
1271 'skip_undelete' => 1,
1277 * @param int $contactTypeId
1281 public function contactTypeDelete($contactTypeId) {
1282 $result = CRM_Contact_BAO_ContactType
::del($contactTypeId);
1284 throw new Exception('Could not delete contact type');
1289 * @param array $params
1293 public function membershipTypeCreate($params = array()) {
1294 CRM_Member_PseudoConstant
::flush('membershipType');
1295 CRM_Core_Config
::clearDBCache();
1296 $memberOfOrganization = $this->organizationCreate();
1297 $params = array_merge(array(
1298 'name' => 'General',
1299 'duration_unit' => 'year',
1300 'duration_interval' => 1,
1301 'period_type' => 'rolling',
1302 'member_of_contact_id' => $memberOfOrganization,
1304 'financial_type_id' => 1,
1307 'visibility' => 'Public',
1310 $result = $this->callAPISuccess('MembershipType', 'Create', $params);
1312 CRM_Member_PseudoConstant
::flush('membershipType');
1313 CRM_Utils_Cache
::singleton()->flush();
1315 return $result['id'];
1319 * @param array $params
1323 public function contactMembershipCreate($params) {
1325 'join_date' => '2007-01-21',
1326 'start_date' => '2007-01-21',
1327 'end_date' => '2007-12-21',
1328 'source' => 'Payment',
1331 foreach ($pre as $key => $val) {
1332 if (!isset($params[$key])) {
1333 $params[$key] = $val;
1337 $result = $this->callAPISuccess('Membership', 'create', $params);
1338 return $result['id'];
1342 * Delete Membership Type.
1344 * @param array $params
1346 public function membershipTypeDelete($params) {
1347 $this->callAPISuccess('MembershipType', 'Delete', $params);
1351 * @param int $membershipID
1353 public function membershipDelete($membershipID) {
1354 $deleteParams = array('id' => $membershipID);
1355 $result = $this->callAPISuccess('Membership', 'Delete', $deleteParams);
1359 * @param string $name
1363 public function membershipStatusCreate($name = 'test member status') {
1364 $params['name'] = $name;
1365 $params['start_event'] = 'start_date';
1366 $params['end_event'] = 'end_date';
1367 $params['is_current_member'] = 1;
1368 $params['is_active'] = 1;
1370 $result = $this->callAPISuccess('MembershipStatus', 'Create', $params);
1371 CRM_Member_PseudoConstant
::flush('membershipStatus');
1372 return $result['id'];
1376 * @param int $membershipStatusID
1378 public function membershipStatusDelete($membershipStatusID) {
1379 if (!$membershipStatusID) {
1382 $result = $this->callAPISuccess('MembershipStatus', 'Delete', array('id' => $membershipStatusID));
1386 * @param array $params
1390 public function relationshipTypeCreate($params = array()) {
1391 $params = array_merge(array(
1392 'name_a_b' => 'Relation 1 for relationship type create',
1393 'name_b_a' => 'Relation 2 for relationship type create',
1394 'contact_type_a' => 'Individual',
1395 'contact_type_b' => 'Organization',
1402 $result = $this->callAPISuccess('relationship_type', 'create', $params);
1403 CRM_Core_PseudoConstant
::flush('relationshipType');
1405 return $result['id'];
1409 * Delete Relatinship Type.
1411 * @param int $relationshipTypeID
1413 public function relationshipTypeDelete($relationshipTypeID) {
1414 $params['id'] = $relationshipTypeID;
1415 $this->callAPISuccess('relationship_type', 'delete', $params);
1419 * @param array $params
1423 public function paymentProcessorTypeCreate($params = NULL) {
1424 if (is_null($params)) {
1426 'name' => 'API_Test_PP',
1427 'title' => 'API Test Payment Processor',
1428 'class_name' => 'CRM_Core_Payment_APITest',
1429 'billing_mode' => 'form',
1435 $result = $this->callAPISuccess('payment_processor_type', 'create', $params);
1437 CRM_Core_PseudoConstant
::flush('paymentProcessorType');
1439 return $result['id'];
1443 * Create Participant.
1445 * @param array $params
1446 * Array of contact id and event id values.
1449 * $id of participant created
1451 public function participantCreate($params) {
1452 if (empty($params['contact_id'])) {
1453 $params['contact_id'] = $this->individualCreate();
1455 if (empty($params['event_id'])) {
1456 $event = $this->eventCreate();
1457 $params['event_id'] = $event['id'];
1462 'register_date' => 20070219,
1463 'source' => 'Wimbeldon',
1464 'event_level' => 'Payment',
1468 $params = array_merge($defaults, $params);
1469 $result = $this->callAPISuccess('Participant', 'create', $params);
1470 return $result['id'];
1474 * Create Payment Processor.
1476 * @return CRM_Financial_DAO_PaymentProcessor
1477 * instance of Payment Processsor
1479 public function processorCreate() {
1480 $processorParams = array(
1483 'payment_processor_type_id' => 10,
1484 'financial_account_id' => 12,
1487 'url_site' => 'http://dummy.com',
1488 'url_recur' => 'http://dummy.com',
1489 'billing_mode' => 1,
1491 $paymentProcessor = CRM_Financial_BAO_PaymentProcessor
::create($processorParams);
1492 return $paymentProcessor;
1496 * Create contribution page.
1498 * @param array $params
1500 * Array of contribution page
1502 public function contributionPageCreate($params) {
1503 $this->_pageParams
= array(
1504 'title' => 'Test Contribution Page',
1505 'financial_type_id' => 1,
1506 'currency' => 'USD',
1507 'financial_account_id' => 1,
1508 'payment_processor' => $params['processor_id'],
1510 'is_allow_other_amount' => 1,
1512 'max_amount' => 1000,
1514 $contributionPage = $this->callAPISuccess('contribution_page', 'create', $this->_pageParams
);
1515 return $contributionPage;
1521 * @param array $params
1523 * result of created tag
1525 public function tagCreate($params = array()) {
1527 'name' => 'New Tag3',
1528 'description' => 'This is description for Our New Tag ',
1531 $params = array_merge($defaults, $params);
1532 $result = $this->callAPISuccess('Tag', 'create', $params);
1533 return $result['values'][$result['id']];
1540 * Id of the tag to be deleted.
1544 public function tagDelete($tagId) {
1545 require_once 'api/api.php';
1549 $result = $this->callAPISuccess('Tag', 'delete', $params);
1550 return $result['id'];
1554 * Add entity(s) to the tag
1556 * @param array $params
1560 public function entityTagAdd($params) {
1561 $result = $this->callAPISuccess('entity_tag', 'create', $params);
1566 * Create contribution.
1572 * id of created contribution
1574 public function pledgeCreate($cID) {
1576 'contact_id' => $cID,
1577 'pledge_create_date' => date('Ymd'),
1578 'start_date' => date('Ymd'),
1579 'scheduled_date' => date('Ymd'),
1581 'pledge_status_id' => '2',
1582 'financial_type_id' => '1',
1583 'pledge_original_installment_amount' => 20,
1584 'frequency_interval' => 5,
1585 'frequency_unit' => 'year',
1586 'frequency_day' => 15,
1587 'installments' => 5,
1590 $result = $this->callAPISuccess('Pledge', 'create', $params);
1591 return $result['id'];
1595 * Delete contribution.
1597 * @param int $pledgeId
1599 public function pledgeDelete($pledgeId) {
1601 'pledge_id' => $pledgeId,
1603 $this->callAPISuccess('Pledge', 'delete', $params);
1607 * Create contribution.
1611 * @param int $cTypeID
1612 * Id of financial type.
1613 * @param int $invoiceID
1614 * @param int $trxnID
1615 * @param int $paymentInstrumentID
1616 * @param bool $isFee
1619 * id of created contribution
1621 public function contributionCreate($cID, $cTypeID = 1, $invoiceID = 67890, $trxnID = 12345, $paymentInstrumentID = 1, $isFee = TRUE) {
1624 'contact_id' => $cID,
1625 'receive_date' => date('Ymd'),
1626 'total_amount' => 100.00,
1627 'financial_type_id' => empty($cTypeID) ?
1 : $cTypeID,
1628 'payment_instrument_id' => empty($paymentInstrumentID) ?
1 : $paymentInstrumentID,
1629 'non_deductible_amount' => 10.00,
1630 'trxn_id' => $trxnID,
1631 'invoice_id' => $invoiceID,
1633 'contribution_status_id' => 1,
1634 // 'note' => 'Donating for Nobel Cause', *Fixme
1638 $params['fee_amount'] = 5.00;
1639 $params['net_amount'] = 95.00;
1642 $result = $this->callAPISuccess('contribution', 'create', $params);
1643 return $result['id'];
1647 * Create online contribution.
1649 * @param array $params
1650 * @param int $financialType
1651 * Id of financial type.
1652 * @param int $invoiceID
1653 * @param int $trxnID
1656 * id of created contribution
1658 public function onlineContributionCreate($params, $financialType, $invoiceID = 67890, $trxnID = 12345) {
1659 $contribParams = array(
1660 'contact_id' => $params['contact_id'],
1661 'receive_date' => date('Ymd'),
1662 'total_amount' => 100.00,
1663 'financial_type_id' => $financialType,
1664 'contribution_page_id' => $params['contribution_page_id'],
1666 'invoice_id' => 67890,
1669 $contribParams = array_merge($contribParams, $params);
1670 $result = $this->callAPISuccess('contribution', 'create', $contribParams);
1672 return $result['id'];
1676 * Delete contribution.
1678 * @param int $contributionId
1682 public function contributionDelete($contributionId) {
1684 'contribution_id' => $contributionId,
1686 $result = $this->callAPISuccess('contribution', 'delete', $params);
1693 * @param array $params
1694 * Name-value pair for an event.
1698 public function eventCreate($params = array()) {
1699 // if no contact was passed, make up a dummy event creator
1700 if (!isset($params['contact_id'])) {
1701 $params['contact_id'] = $this->_contactCreate(array(
1702 'contact_type' => 'Individual',
1703 'first_name' => 'Event',
1704 'last_name' => 'Creator',
1708 // set defaults for missing params
1709 $params = array_merge(array(
1710 'title' => 'Annual CiviCRM meet',
1711 'summary' => 'If you have any CiviCRM related issues or want to track where CiviCRM is heading, Sign up now',
1712 'description' => 'This event is intended to give brief idea about progess of CiviCRM and giving solutions to common user issues',
1713 'event_type_id' => 1,
1715 'start_date' => 20081021,
1716 'end_date' => 20081023,
1717 'is_online_registration' => 1,
1718 'registration_start_date' => 20080601,
1719 'registration_end_date' => 20081015,
1720 'max_participants' => 100,
1721 'event_full_text' => 'Sorry! We are already full',
1724 'is_show_location' => 0,
1727 return $this->callAPISuccess('Event', 'create', $params);
1738 public function eventDelete($id) {
1742 return $this->callAPISuccess('event', 'delete', $params);
1746 * Delete participant.
1748 * @param int $participantID
1752 public function participantDelete($participantID) {
1754 'id' => $participantID,
1756 return $this->callAPISuccess('Participant', 'delete', $params);
1760 * Create participant payment.
1762 * @param int $participantID
1763 * @param int $contributionID
1765 * $id of created payment
1767 public function participantPaymentCreate($participantID, $contributionID = NULL) {
1768 //Create Participant Payment record With Values
1770 'participant_id' => $participantID,
1771 'contribution_id' => $contributionID,
1774 $result = $this->callAPISuccess('participant_payment', 'create', $params);
1775 return $result['id'];
1779 * Delete participant payment.
1781 * @param int $paymentID
1783 public function participantPaymentDelete($paymentID) {
1787 $result = $this->callAPISuccess('participant_payment', 'delete', $params);
1793 * @param int $contactID
1795 * location id of created location
1797 public function locationAdd($contactID) {
1800 'location_type' => 'New Location Type',
1802 'name' => 'Saint Helier St',
1803 'county' => 'Marin',
1804 'country' => 'United States',
1805 'state_province' => 'Michigan',
1806 'supplemental_address_1' => 'Hallmark Ct',
1807 'supplemental_address_2' => 'Jersey Village',
1812 'contact_id' => $contactID,
1813 'address' => $address,
1814 'location_format' => '2.0',
1815 'location_type' => 'New Location Type',
1818 $result = $this->callAPISuccess('Location', 'create', $params);
1823 * Delete Locations of contact.
1825 * @param array $params
1828 public function locationDelete($params) {
1829 $this->callAPISuccess('Location', 'delete', $params);
1833 * Add a Location Type.
1835 * @param array $params
1836 * @return CRM_Core_DAO_LocationType
1837 * location id of created location
1839 public function locationTypeCreate($params = NULL) {
1840 if ($params === NULL) {
1842 'name' => 'New Location Type',
1843 'vcard_name' => 'New Location Type',
1844 'description' => 'Location Type for Delete',
1849 $locationType = new CRM_Core_DAO_LocationType();
1850 $locationType->copyValues($params);
1851 $locationType->save();
1852 // clear getfields cache
1853 CRM_Core_PseudoConstant
::flush();
1854 $this->callAPISuccess('phone', 'getfields', array('version' => 3, 'cache_clear' => 1));
1855 return $locationType;
1859 * Delete a Location Type.
1861 * @param int $locationTypeId
1863 public function locationTypeDelete($locationTypeId) {
1864 $locationType = new CRM_Core_DAO_LocationType();
1865 $locationType->id
= $locationTypeId;
1866 $locationType->delete();
1872 * @param array $params
1874 * groupId of created group
1876 public function groupCreate($params = array()) {
1877 $params = array_merge(array(
1878 'name' => 'Test Group 1',
1880 'title' => 'New Test Group Created',
1881 'description' => 'New Test Group Created',
1883 'visibility' => 'Public Pages',
1884 'group_type' => array(
1890 $result = $this->callAPISuccess('Group', 'create', $params);
1891 return $result['id'];
1896 * Function to add a Group.
1898 * @params array to add group
1900 * @param int $groupID
1901 * @param int $totalCount
1903 * groupId of created group
1905 public function groupContactCreate($groupID, $totalCount = 10) {
1906 $params = array('group_id' => $groupID);
1907 for ($i = 1; $i <= $totalCount; $i++
) {
1908 $contactID = $this->individualCreate();
1910 $params +
= array('contact_id' => $contactID);
1913 $params +
= array("contact_id.$i" => $contactID);
1916 $result = $this->callAPISuccess('GroupContact', 'create', $params);
1926 public function groupDelete($gid) {
1932 $this->callAPISuccess('Group', 'delete', $params);
1937 * @param array $params
1939 public function uFFieldCreate($params = array()) {
1940 $params = array_merge(array(
1942 'field_name' => 'first_name',
1945 'visibility' => 'Public Pages and Listings',
1946 'is_searchable' => '1',
1947 'label' => 'first_name',
1948 'field_type' => 'Individual',
1951 $this->callAPISuccess('uf_field', 'create', $params);
1955 * Add a UF Join Entry.
1957 * @param array $params
1959 * $id of created UF Join
1961 public function ufjoinCreate($params = NULL) {
1962 if ($params === NULL) {
1965 'module' => 'CiviEvent',
1966 'entity_table' => 'civicrm_event',
1972 $result = $this->callAPISuccess('uf_join', 'create', $params);
1977 * Delete a UF Join Entry.
1979 * @param array $params
1980 * with missing uf_group_id
1982 public function ufjoinDelete($params = NULL) {
1983 if ($params === NULL) {
1986 'module' => 'CiviEvent',
1987 'entity_table' => 'civicrm_event',
1990 'uf_group_id' => '',
1994 crm_add_uf_join($params);
1998 * @param array $params
1999 * Optional parameters.
2004 public function campaignCreate($params = array()) {
2005 $this->enableCiviCampaign();
2006 $campaign = $this->callAPISuccess('campaign', 'create', array_merge(array(
2007 'name' => 'big_campaign',
2008 'title' => 'Campaign',
2010 return $campaign['id'];
2014 * Create Group for a contact.
2016 * @param int $contactId
2018 public function contactGroupCreate($contactId) {
2020 'contact_id.1' => $contactId,
2024 $this->callAPISuccess('GroupContact', 'Create', $params);
2028 * Delete Group for a contact.
2030 * @param int $contactId
2032 public function contactGroupDelete($contactId) {
2034 'contact_id.1' => $contactId,
2037 $this->civicrm_api('GroupContact', 'Delete', $params);
2043 * @param array $params
2046 public function activityCreate($params = NULL) {
2048 if ($params === NULL) {
2049 $individualSourceID = $this->individualCreate();
2051 $contactParams = array(
2052 'first_name' => 'Julia',
2053 'Last_name' => 'Anderson',
2055 'email' => 'julia_anderson@civicrm.org',
2056 'contact_type' => 'Individual',
2059 $individualTargetID = $this->individualCreate($contactParams);
2062 'source_contact_id' => $individualSourceID,
2063 'target_contact_id' => array($individualTargetID),
2064 'assignee_contact_id' => array($individualTargetID),
2065 'subject' => 'Discussion on warm beer',
2066 'activity_date_time' => date('Ymd'),
2067 'duration_hours' => 30,
2068 'duration_minutes' => 20,
2069 'location' => 'Baker Street',
2070 'details' => 'Lets schedule a meeting',
2072 'activity_name' => 'Meeting',
2076 $result = $this->callAPISuccess('Activity', 'create', $params);
2078 $result['target_contact_id'] = $individualTargetID;
2079 $result['assignee_contact_id'] = $individualTargetID;
2084 * Create an activity type.
2086 * @param array $params
2090 public function activityTypeCreate($params) {
2091 return $this->callAPISuccess('ActivityType', 'create', $params);
2095 * Delete activity type.
2097 * @param int $activityTypeId
2098 * Id of the activity type.
2101 public function activityTypeDelete($activityTypeId) {
2102 $params['activity_type_id'] = $activityTypeId;
2103 return $this->callAPISuccess('ActivityType', 'delete', $params);
2107 * Create custom group.
2109 * @param array $params
2112 public function customGroupCreate($params = array()) {
2114 'title' => 'new custom group',
2115 'extends' => 'Contact',
2117 'style' => 'Inline',
2121 $params = array_merge($defaults, $params);
2123 if (strlen($params['title']) > 13) {
2124 $params['title'] = substr($params['title'], 0, 13);
2127 //have a crack @ deleting it first in the hope this will prevent derailing our tests
2128 $this->callAPISuccess('custom_group', 'get', array(
2129 'title' => $params['title'],
2130 array('api.custom_group.delete' => 1),
2133 return $this->callAPISuccess('custom_group', 'create', $params);
2137 * Existing function doesn't allow params to be over-ridden so need a new one
2138 * this one allows you to only pass in the params you want to change
2139 * @param array $params
2142 public function CustomGroupCreateByParams($params = array()) {
2144 'title' => "API Custom Group",
2145 'extends' => 'Contact',
2147 'style' => 'Inline',
2150 $params = array_merge($defaults, $params);
2151 return $this->callAPISuccess('custom_group', 'create', $params);
2155 * Create custom group with multi fields.
2156 * @param array $params
2159 public function CustomGroupMultipleCreateByParams($params = array()) {
2164 $params = array_merge($defaults, $params);
2165 return $this->CustomGroupCreateByParams($params);
2169 * Create custom group with multi fields.
2170 * @param array $params
2173 public function CustomGroupMultipleCreateWithFields($params = array()) {
2174 // also need to pass on $params['custom_field'] if not set but not in place yet
2176 $customGroup = $this->CustomGroupMultipleCreateByParams($params);
2177 $ids['custom_group_id'] = $customGroup['id'];
2179 $customField = $this->customFieldCreate(array(
2180 'custom_group_id' => $ids['custom_group_id'],
2181 'label' => 'field_1' . $ids['custom_group_id'],
2184 $ids['custom_field_id'][] = $customField['id'];
2186 $customField = $this->customFieldCreate(array(
2187 'custom_group_id' => $ids['custom_group_id'],
2188 'default_value' => '',
2189 'label' => 'field_2' . $ids['custom_group_id'],
2191 $ids['custom_field_id'][] = $customField['id'];
2193 $customField = $this->customFieldCreate(array(
2194 'custom_group_id' => $ids['custom_group_id'],
2195 'default_value' => '',
2196 'label' => 'field_3' . $ids['custom_group_id'],
2198 $ids['custom_field_id'][] = $customField['id'];
2204 * Create a custom group with a single text custom field. See
2205 * participant:testCreateWithCustom for how to use this
2207 * @param string $function
2209 * @param string $filename
2213 * ids of created objects
2215 public function entityCustomGroupWithSingleFieldCreate($function, $filename) {
2216 $params = array('title' => $function);
2217 $entity = substr(basename($filename), 0, strlen(basename($filename)) - 8);
2218 $params['extends'] = $entity ?
$entity : 'Contact';
2219 $customGroup = $this->CustomGroupCreate($params);
2220 $customField = $this->customFieldCreate(array('custom_group_id' => $customGroup['id'], 'label' => $function));
2221 CRM_Core_PseudoConstant
::flush();
2223 return array('custom_group_id' => $customGroup['id'], 'custom_field_id' => $customField['id']);
2227 * Delete custom group.
2229 * @param int $customGroupID
2233 public function customGroupDelete($customGroupID) {
2234 $params['id'] = $customGroupID;
2235 return $this->callAPISuccess('custom_group', 'delete', $params);
2239 * Create custom field.
2241 * @param array $params
2242 * (custom_group_id) is required.
2245 public function customFieldCreate($params) {
2246 $params = array_merge(array(
2247 'label' => 'Custom Field',
2248 'data_type' => 'String',
2249 'html_type' => 'Text',
2250 'is_searchable' => 1,
2252 'default_value' => 'defaultValue',
2255 $result = $this->callAPISuccess('custom_field', 'create', $params);
2256 // these 2 functions are called with force to flush static caches
2257 CRM_Core_BAO_CustomField
::getTableColumnGroup($result['id'], 1);
2258 CRM_Core_Component
::getEnabledComponents(1);
2263 * Delete custom field.
2265 * @param int $customFieldID
2269 public function customFieldDelete($customFieldID) {
2271 $params['id'] = $customFieldID;
2272 return $this->callAPISuccess('custom_field', 'delete', $params);
2281 public function noteCreate($cId) {
2283 'entity_table' => 'civicrm_contact',
2284 'entity_id' => $cId,
2285 'note' => 'hello I am testing Note',
2286 'contact_id' => $cId,
2287 'modified_date' => date('Ymd'),
2288 'subject' => 'Test Note',
2291 return $this->callAPISuccess('Note', 'create', $params);
2295 * Enable CiviCampaign Component.
2297 public function enableCiviCampaign() {
2298 CRM_Core_BAO_ConfigSetting
::enableComponent('CiviCampaign');
2299 // force reload of config object
2300 $config = CRM_Core_Config
::singleton(TRUE, TRUE);
2301 //flush cache by calling with reset
2302 $activityTypes = CRM_Core_PseudoConstant
::activityType(TRUE, TRUE, TRUE, 'name', TRUE);
2306 * Create test generated example in api/v3/examples.
2308 * To turn this off (e.g. on the server) set
2309 * define(DONT_DOCUMENT_TEST_CONFIG ,1);
2310 * in your settings file
2312 * @param string $entity
2313 * @param string $action
2314 * @param array $params
2315 * Array as passed to civicrm_api function.
2316 * @param array $result
2317 * Array as received from the civicrm_api function.
2318 * @param string $testFunction
2319 * Calling function - generally __FUNCTION__.
2320 * @param string $testFile
2321 * Called from file - generally __FILE__.
2322 * @param string $description
2323 * Descriptive text for the example file.
2324 * @param string $exampleName
2325 * Name for this example file (CamelCase) - if ommitted the action name will be substituted.
2327 private function documentMe($entity, $action, $params, $result, $testFunction, $testFile, $description = "", $exampleName = NULL) {
2328 if (defined('DONT_DOCUMENT_TEST_CONFIG') && DONT_DOCUMENT_TEST_CONFIG
) {
2331 $entity = _civicrm_api_get_camel_name($entity);
2332 $action = strtolower($action);
2334 if (empty($exampleName)) {
2335 // Attempt to convert lowercase action name to CamelCase.
2336 // This is clunky/imperfect due to the convention of all lowercase actions.
2337 $exampleName = CRM_Utils_String
::convertStringToCamel($action);
2338 $knownPrefixes = array(
2345 foreach ($knownPrefixes as $prefix) {
2346 if (strpos($exampleName, $prefix) === 0 && $prefix != $exampleName) {
2347 $exampleName[strlen($prefix)] = strtoupper($exampleName[strlen($prefix)]);
2352 $this->tidyExampleResult($result);
2353 if (isset($params['version'])) {
2354 unset($params['version']);
2356 // Format multiline description as array
2358 if (is_string($description) && strlen($description)) {
2359 foreach (explode("\n", $description) as $line) {
2360 $desc[] = trim($line);
2363 $smarty = CRM_Core_Smarty
::singleton();
2364 $smarty->assign('testFunction', $testFunction);
2365 $smarty->assign('function', _civicrm_api_get_entity_name_from_camel($entity) . "_$action");
2366 $smarty->assign('params', $params);
2367 $smarty->assign('entity', $entity);
2368 $smarty->assign('testFile', basename($testFile));
2369 $smarty->assign('description', $desc);
2370 $smarty->assign('result', $result);
2371 $smarty->assign('action', $action);
2373 if (file_exists('../tests/templates/documentFunction.tpl')) {
2374 if (!is_dir("../api/v3/examples/$entity")) {
2375 mkdir("../api/v3/examples/$entity");
2377 $f = fopen("../api/v3/examples/$entity/$exampleName.php", "w+b");
2378 fwrite($f, $smarty->fetch('../tests/templates/documentFunction.tpl'));
2384 * Tidy up examples array so that fields that change often ..don't
2385 * and debug related fields are unset
2387 * @param array $result
2389 public function tidyExampleResult(&$result) {
2390 if (!is_array($result)) {
2393 $fieldsToChange = array(
2394 'hash' => '67eac7789eaee00',
2395 'modified_date' => '2012-11-14 16:02:35',
2396 'created_date' => '2013-07-28 08:49:19',
2397 'create_date' => '20120130621222105',
2398 'application_received_date' => '20130728084957',
2399 'in_date' => '2013-07-28 08:50:19',
2400 'scheduled_date' => '20130728085413',
2401 'approval_date' => '20130728085413',
2402 'pledge_start_date_high' => '20130726090416',
2403 'start_date' => '2013-07-29 00:00:00',
2404 'event_start_date' => '2013-07-29 00:00:00',
2405 'end_date' => '2013-08-04 00:00:00',
2406 'event_end_date' => '2013-08-04 00:00:00',
2407 'decision_date' => '20130805000000',
2410 $keysToUnset = array('xdebug', 'undefined_fields');
2411 foreach ($keysToUnset as $unwantedKey) {
2412 if (isset($result[$unwantedKey])) {
2413 unset($result[$unwantedKey]);
2416 if (isset($result['values'])) {
2417 if (!is_array($result['values'])) {
2420 $resultArray = &$result['values'];
2422 elseif (is_array($result)) {
2423 $resultArray = &$result;
2429 foreach ($resultArray as $index => &$values) {
2430 if (!is_array($values)) {
2433 foreach ($values as $key => &$value) {
2434 if (substr($key, 0, 3) == 'api' && is_array($value)) {
2435 if (isset($value['is_error'])) {
2436 // we have a std nested result format
2437 $this->tidyExampleResult($value);
2440 foreach ($value as &$nestedResult) {
2441 // this is an alternative syntax for nested results a keyed array of results
2442 $this->tidyExampleResult($nestedResult);
2446 if (in_array($key, $keysToUnset)) {
2447 unset($values[$key]);
2450 if (array_key_exists($key, $fieldsToChange) && !empty($value)) {
2451 $value = $fieldsToChange[$key];
2453 if (is_string($value)) {
2454 $value = addslashes($value);
2463 * @param array $params
2467 public function noteDelete($params) {
2468 return $this->callAPISuccess('Note', 'delete', $params);
2472 * Create custom field with Option Values.
2474 * @param array $customGroup
2475 * @param string $name
2476 * Name of custom field.
2480 public function customFieldOptionValueCreate($customGroup, $name) {
2481 $fieldParams = array(
2482 'custom_group_id' => $customGroup['id'],
2483 'name' => 'test_custom_group',
2484 'label' => 'Country',
2485 'html_type' => 'Select',
2486 'data_type' => 'String',
2489 'is_searchable' => 0,
2493 $optionGroup = array(
2495 'name' => 'option_group1',
2496 'label' => 'option_group_label1',
2499 $optionValue = array(
2500 'option_label' => array('Label1', 'Label2'),
2501 'option_value' => array('value1', 'value2'),
2502 'option_name' => array($name . '_1', $name . '_2'),
2503 'option_weight' => array(1, 2),
2504 'option_status' => 1,
2507 $params = array_merge($fieldParams, $optionGroup, $optionValue);
2509 return $this->callAPISuccess('custom_field', 'create', $params);
2517 public function confirmEntitiesDeleted($entities) {
2518 foreach ($entities as $entity) {
2520 $result = $this->callAPISuccess($entity, 'Get', array());
2521 if ($result['error'] == 1 ||
$result['count'] > 0) {
2522 // > than $entity[0] to allow a value to be passed in? e.g. domain?
2530 * @param $tablesToTruncate
2531 * @param bool $dropCustomValueTables
2532 * @throws \Exception
2534 public function quickCleanup($tablesToTruncate, $dropCustomValueTables = FALSE) {
2536 throw new Exception("CiviUnitTestCase: quickCleanup() is not compatible with useTransaction()");
2538 if ($dropCustomValueTables) {
2539 $tablesToTruncate[] = 'civicrm_custom_group';
2540 $tablesToTruncate[] = 'civicrm_custom_field';
2543 $tablesToTruncate = array_unique(array_merge($this->_tablesToTruncate
, $tablesToTruncate));
2545 CRM_Core_DAO
::executeQuery("SET FOREIGN_KEY_CHECKS = 0;");
2546 foreach ($tablesToTruncate as $table) {
2547 $sql = "TRUNCATE TABLE $table";
2548 CRM_Core_DAO
::executeQuery($sql);
2550 CRM_Core_DAO
::executeQuery("SET FOREIGN_KEY_CHECKS = 1;");
2552 if ($dropCustomValueTables) {
2553 $dbName = self
::getDBName();
2555 SELECT TABLE_NAME as tableName
2556 FROM INFORMATION_SCHEMA.TABLES
2557 WHERE TABLE_SCHEMA = '{$dbName}'
2558 AND ( TABLE_NAME LIKE 'civicrm_value_%' )
2561 $tableDAO = CRM_Core_DAO
::executeQuery($query);
2562 while ($tableDAO->fetch()) {
2563 $sql = "DROP TABLE {$tableDAO->tableName}";
2564 CRM_Core_DAO
::executeQuery($sql);
2570 * Clean up financial entities after financial tests (so we remember to get all the tables :-))
2572 public function quickCleanUpFinancialEntities() {
2573 $tablesToTruncate = array(
2574 'civicrm_contribution',
2575 'civicrm_contribution_soft',
2576 'civicrm_financial_trxn',
2577 'civicrm_financial_item',
2578 'civicrm_contribution_recur',
2579 'civicrm_line_item',
2580 'civicrm_contribution_page',
2581 'civicrm_payment_processor',
2582 'civicrm_entity_financial_trxn',
2583 'civicrm_membership',
2584 'civicrm_membership_type',
2585 'civicrm_membership_payment',
2586 'civicrm_membership_log',
2587 'civicrm_membership_block',
2589 'civicrm_participant',
2590 'civicrm_participant_payment',
2592 'civicrm_price_set_entity',
2593 'civicrm_price_field_value',
2594 'civicrm_price_field',
2596 $this->quickCleanup($tablesToTruncate);
2597 CRM_Core_DAO
::executeQuery("DELETE FROM civicrm_membership_status WHERE name NOT IN('New', 'Current', 'Grace', 'Expired', 'Pending', 'Cancelled', 'Deceased')");
2598 $this->restoreDefaultPriceSetConfig();
2600 CRM_Member_BAO_Membership
::createRelatedMemberships($var, $var, TRUE);
2601 Civi\Payment\System
::singleton()->flushProcessors();
2604 public function restoreDefaultPriceSetConfig() {
2605 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)");
2606 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)");
2609 * Function does a 'Get' on the entity & compares the fields in the Params with those returned
2610 * Default behaviour is to also delete the entity
2611 * @param array $params
2612 * Params array to check agains.
2614 * Id of the entity concerned.
2615 * @param string $entity
2616 * Name of entity concerned (e.g. membership).
2617 * @param bool $delete
2618 * Should the entity be deleted as part of this check.
2619 * @param string $errorText
2620 * Text to print on error.
2623 * @param array $params
2626 * @param int $delete
2627 * @param string $errorText
2631 public function getAndCheck($params, $id, $entity, $delete = 1, $errorText = '') {
2633 $result = $this->callAPISuccessGetSingle($entity, array(
2638 $this->callAPISuccess($entity, 'Delete', array(
2642 $dateFields = $keys = $dateTimeFields = array();
2643 $fields = $this->callAPISuccess($entity, 'getfields', array('version' => 3, 'action' => 'get'));
2644 foreach ($fields['values'] as $field => $settings) {
2645 if (array_key_exists($field, $result)) {
2646 $keys[CRM_Utils_Array
::Value('name', $settings, $field)] = $field;
2649 $keys[CRM_Utils_Array
::Value('name', $settings, $field)] = CRM_Utils_Array
::value('name', $settings, $field);
2651 $type = CRM_Utils_Array
::value('type', $settings);
2652 if ($type == CRM_Utils_Type
::T_DATE
) {
2653 $dateFields[] = $settings['name'];
2654 // we should identify both real names & unique names as dates
2655 if ($field != $settings['name']) {
2656 $dateFields[] = $field;
2659 if ($type == CRM_Utils_Type
::T_DATE + CRM_Utils_Type
::T_TIME
) {
2660 $dateTimeFields[] = $settings['name'];
2661 // we should identify both real names & unique names as dates
2662 if ($field != $settings['name']) {
2663 $dateTimeFields[] = $field;
2668 if (strtolower($entity) == 'contribution') {
2669 $params['receive_date'] = date('Y-m-d', strtotime($params['receive_date']));
2670 // this is not returned in id format
2671 unset($params['payment_instrument_id']);
2672 $params['contribution_source'] = $params['source'];
2673 unset($params['source']);
2676 foreach ($params as $key => $value) {
2677 if ($key == 'version' ||
substr($key, 0, 3) == 'api' ||
!array_key_exists($keys[$key], $result)) {
2680 if (in_array($key, $dateFields)) {
2681 $value = date('Y-m-d', strtotime($value));
2682 $result[$key] = date('Y-m-d', strtotime($result[$key]));
2684 if (in_array($key, $dateTimeFields)) {
2685 $value = date('Y-m-d H:i:s', strtotime($value));
2686 $result[$keys[$key]] = date('Y-m-d H:i:s', strtotime(CRM_Utils_Array
::value($keys[$key], $result, CRM_Utils_Array
::value($key, $result))));
2688 $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);
2693 * Get formatted values in the actual and expected result.
2694 * @param array $actual
2695 * Actual calculated values.
2696 * @param array $expected
2699 public function checkArrayEquals(&$actual, &$expected) {
2700 self
::unsetId($actual);
2701 self
::unsetId($expected);
2702 $this->assertEquals($actual, $expected);
2706 * Unset the key 'id' from the array
2707 * @param array $unformattedArray
2708 * The array from which the 'id' has to be unset.
2710 public static function unsetId(&$unformattedArray) {
2711 $formattedArray = array();
2712 if (array_key_exists('id', $unformattedArray)) {
2713 unset($unformattedArray['id']);
2715 if (!empty($unformattedArray['values']) && is_array($unformattedArray['values'])) {
2716 foreach ($unformattedArray['values'] as $key => $value) {
2717 if (is_array($value)) {
2718 foreach ($value as $k => $v) {
2724 elseif ($key == 'id') {
2725 $unformattedArray[$key];
2727 $formattedArray = array($value);
2729 $unformattedArray['values'] = $formattedArray;
2734 * Helper to enable/disable custom directory support
2736 * @param array $customDirs
2738 * 'php_path' Set to TRUE to use the default, FALSE or "" to disable support, or a string path to use another path
2739 * 'template_path' Set to TRUE to use the default, FALSE or "" to disable support, or a string path to use another path
2741 public function customDirectories($customDirs) {
2742 require_once 'CRM/Core/Config.php';
2743 $config = CRM_Core_Config
::singleton();
2745 if (empty($customDirs['php_path']) ||
$customDirs['php_path'] === FALSE) {
2746 unset($config->customPHPPathDir
);
2748 elseif ($customDirs['php_path'] === TRUE) {
2749 $config->customPHPPathDir
= dirname(dirname(__FILE__
)) . '/custom_directories/php/';
2752 $config->customPHPPathDir
= $php_path;
2755 if (empty($customDirs['template_path']) ||
$customDirs['template_path'] === FALSE) {
2756 unset($config->customTemplateDir
);
2758 elseif ($customDirs['template_path'] === TRUE) {
2759 $config->customTemplateDir
= dirname(dirname(__FILE__
)) . '/custom_directories/templates/';
2762 $config->customTemplateDir
= $template_path;
2767 * Generate a temporary folder.
2769 * @param string $prefix
2772 public function createTempDir($prefix = 'test-') {
2773 $tempDir = CRM_Utils_File
::tempdir($prefix);
2774 $this->tempDirs
[] = $tempDir;
2778 public function cleanTempDirs() {
2779 if (!is_array($this->tempDirs
)) {
2780 // fix test errors where this is not set
2783 foreach ($this->tempDirs
as $tempDir) {
2784 if (is_dir($tempDir)) {
2785 CRM_Utils_File
::cleanDir($tempDir, TRUE, FALSE);
2791 * Temporarily replace the singleton extension with a different one.
2792 * @param \CRM_Extension_System $system
2794 public function setExtensionSystem(CRM_Extension_System
$system) {
2795 if ($this->origExtensionSystem
== NULL) {
2796 $this->origExtensionSystem
= CRM_Extension_System
::singleton();
2798 CRM_Extension_System
::setSingleton($this->origExtensionSystem
);
2801 public function unsetExtensionSystem() {
2802 if ($this->origExtensionSystem
!== NULL) {
2803 CRM_Extension_System
::setSingleton($this->origExtensionSystem
);
2804 $this->origExtensionSystem
= NULL;
2809 * Temporarily alter the settings-metadata to add a mock setting.
2811 * WARNING: The setting metadata will disappear on the next cache-clear.
2816 public function setMockSettingsMetaData($extras) {
2817 CRM_Core_BAO_Setting
::$_cache = array();
2818 $this->callAPISuccess('system', 'flush', array());
2819 CRM_Core_BAO_Setting
::$_cache = array();
2821 CRM_Utils_Hook
::singleton()
2822 ->setHook('civicrm_alterSettingsMetaData', function (&$metadata, $domainId, $profile) use ($extras) {
2823 $metadata = array_merge($metadata, $extras);
2826 $fields = $this->callAPISuccess('setting', 'getfields', array());
2827 foreach ($extras as $key => $spec) {
2828 $this->assertNotEmpty($spec['title']);
2829 $this->assertEquals($spec['title'], $fields['values'][$key]['title']);
2834 * @param string $name
2836 public function financialAccountDelete($name) {
2837 $financialAccount = new CRM_Financial_DAO_FinancialAccount();
2838 $financialAccount->name
= $name;
2839 if ($financialAccount->find(TRUE)) {
2840 $entityFinancialType = new CRM_Financial_DAO_EntityFinancialAccount();
2841 $entityFinancialType->financial_account_id
= $financialAccount->id
;
2842 $entityFinancialType->delete();
2843 $financialAccount->delete();
2848 * FIXME: something NULLs $GLOBALS['_HTML_QuickForm_registered_rules'] when the tests are ran all together
2849 * (NB unclear if this is still required)
2851 public function _sethtmlGlobals() {
2852 $GLOBALS['_HTML_QuickForm_registered_rules'] = array(
2853 'required' => array(
2854 'html_quickform_rule_required',
2855 'HTML/QuickForm/Rule/Required.php',
2857 'maxlength' => array(
2858 'html_quickform_rule_range',
2859 'HTML/QuickForm/Rule/Range.php',
2861 'minlength' => array(
2862 'html_quickform_rule_range',
2863 'HTML/QuickForm/Rule/Range.php',
2865 'rangelength' => array(
2866 'html_quickform_rule_range',
2867 'HTML/QuickForm/Rule/Range.php',
2870 'html_quickform_rule_email',
2871 'HTML/QuickForm/Rule/Email.php',
2874 'html_quickform_rule_regex',
2875 'HTML/QuickForm/Rule/Regex.php',
2877 'lettersonly' => array(
2878 'html_quickform_rule_regex',
2879 'HTML/QuickForm/Rule/Regex.php',
2881 'alphanumeric' => array(
2882 'html_quickform_rule_regex',
2883 'HTML/QuickForm/Rule/Regex.php',
2886 'html_quickform_rule_regex',
2887 'HTML/QuickForm/Rule/Regex.php',
2889 'nopunctuation' => array(
2890 'html_quickform_rule_regex',
2891 'HTML/QuickForm/Rule/Regex.php',
2894 'html_quickform_rule_regex',
2895 'HTML/QuickForm/Rule/Regex.php',
2897 'callback' => array(
2898 'html_quickform_rule_callback',
2899 'HTML/QuickForm/Rule/Callback.php',
2902 'html_quickform_rule_compare',
2903 'HTML/QuickForm/Rule/Compare.php',
2906 // FIXME: …ditto for $GLOBALS['HTML_QUICKFORM_ELEMENT_TYPES']
2907 $GLOBALS['HTML_QUICKFORM_ELEMENT_TYPES'] = array(
2909 'HTML/QuickForm/group.php',
2910 'HTML_QuickForm_group',
2913 'HTML/QuickForm/hidden.php',
2914 'HTML_QuickForm_hidden',
2917 'HTML/QuickForm/reset.php',
2918 'HTML_QuickForm_reset',
2920 'checkbox' => array(
2921 'HTML/QuickForm/checkbox.php',
2922 'HTML_QuickForm_checkbox',
2925 'HTML/QuickForm/file.php',
2926 'HTML_QuickForm_file',
2929 'HTML/QuickForm/image.php',
2930 'HTML_QuickForm_image',
2932 'password' => array(
2933 'HTML/QuickForm/password.php',
2934 'HTML_QuickForm_password',
2937 'HTML/QuickForm/radio.php',
2938 'HTML_QuickForm_radio',
2941 'HTML/QuickForm/button.php',
2942 'HTML_QuickForm_button',
2945 'HTML/QuickForm/submit.php',
2946 'HTML_QuickForm_submit',
2949 'HTML/QuickForm/select.php',
2950 'HTML_QuickForm_select',
2952 'hiddenselect' => array(
2953 'HTML/QuickForm/hiddenselect.php',
2954 'HTML_QuickForm_hiddenselect',
2957 'HTML/QuickForm/text.php',
2958 'HTML_QuickForm_text',
2960 'textarea' => array(
2961 'HTML/QuickForm/textarea.php',
2962 'HTML_QuickForm_textarea',
2964 'fckeditor' => array(
2965 'HTML/QuickForm/fckeditor.php',
2966 'HTML_QuickForm_FCKEditor',
2969 'HTML/QuickForm/tinymce.php',
2970 'HTML_QuickForm_TinyMCE',
2972 'dojoeditor' => array(
2973 'HTML/QuickForm/dojoeditor.php',
2974 'HTML_QuickForm_dojoeditor',
2977 'HTML/QuickForm/link.php',
2978 'HTML_QuickForm_link',
2980 'advcheckbox' => array(
2981 'HTML/QuickForm/advcheckbox.php',
2982 'HTML_QuickForm_advcheckbox',
2985 'HTML/QuickForm/date.php',
2986 'HTML_QuickForm_date',
2989 'HTML/QuickForm/static.php',
2990 'HTML_QuickForm_static',
2993 'HTML/QuickForm/header.php',
2994 'HTML_QuickForm_header',
2997 'HTML/QuickForm/html.php',
2998 'HTML_QuickForm_html',
3000 'hierselect' => array(
3001 'HTML/QuickForm/hierselect.php',
3002 'HTML_QuickForm_hierselect',
3004 'autocomplete' => array(
3005 'HTML/QuickForm/autocomplete.php',
3006 'HTML_QuickForm_autocomplete',
3009 'HTML/QuickForm/xbutton.php',
3010 'HTML_QuickForm_xbutton',
3012 'advmultiselect' => array(
3013 'HTML/QuickForm/advmultiselect.php',
3014 'HTML_QuickForm_advmultiselect',
3020 * Set up an acl allowing contact to see 2 specified groups
3021 * - $this->_permissionedGroup & $this->_permissionedDisabledGroup
3023 * You need to have pre-created these groups & created the user e.g
3024 * $this->createLoggedInUser();
3025 * $this->_permissionedDisabledGroup = $this->groupCreate(array('title' => 'pick-me-disabled', 'is_active' => 0, 'name' => 'pick-me-disabled'));
3026 * $this->_permissionedGroup = $this->groupCreate(array('title' => 'pick-me-active', 'is_active' => 1, 'name' => 'pick-me-active'));
3028 public function setupACL() {
3030 $_REQUEST = $this->_params
;
3032 CRM_Core_Config
::singleton()->userPermissionClass
->permissions
= array('access CiviCRM');
3033 $optionGroupID = $this->callAPISuccessGetValue('option_group', array('return' => 'id', 'name' => 'acl_role'));
3034 $optionValue = $this->callAPISuccess('option_value', 'create', array(
3035 'option_group_id' => $optionGroupID,
3036 'label' => 'pick me',
3040 CRM_Core_DAO
::executeQuery("
3041 TRUNCATE civicrm_acl_cache
3044 CRM_Core_DAO
::executeQuery("
3045 TRUNCATE civicrm_acl_contact_cache
3048 CRM_Core_DAO
::executeQuery("
3049 INSERT INTO civicrm_acl_entity_role (
3050 `acl_role_id`, `entity_table`, `entity_id`
3051 ) VALUES (55, 'civicrm_group', {$this->_permissionedGroup});
3054 CRM_Core_DAO
::executeQuery("
3055 INSERT INTO civicrm_acl (
3056 `name`, `entity_table`, `entity_id`, `operation`, `object_table`, `object_id`, `is_active`
3059 'view picked', 'civicrm_group', $this->_permissionedGroup , 'Edit', 'civicrm_saved_search', {$this->_permissionedGroup}, 1
3063 CRM_Core_DAO
::executeQuery("
3064 INSERT INTO civicrm_acl (
3065 `name`, `entity_table`, `entity_id`, `operation`, `object_table`, `object_id`, `is_active`
3068 'view picked', 'civicrm_group', $this->_permissionedGroup, 'Edit', 'civicrm_saved_search', {$this->_permissionedDisabledGroup}, 1
3071 $this->_loggedInUser
= CRM_Core_Session
::singleton()->get('userID');
3072 $this->callAPISuccess('group_contact', 'create', array(
3073 'group_id' => $this->_permissionedGroup
,
3074 'contact_id' => $this->_loggedInUser
,
3077 CRM_ACL_BAO_Cache
::resetCache();
3078 CRM_Contact_BAO_Group
::getPermissionClause(TRUE);
3079 CRM_ACL_API
::groupPermission('whatever', 9999, NULL, 'civicrm_saved_search', NULL, NULL, TRUE);
3083 * Alter default price set so that the field numbers are not all 1 (hiding errors)
3085 public function offsetDefaultPriceSet() {
3086 $contributionPriceSet = $this->callAPISuccess('price_set', 'getsingle', array('name' => 'default_contribution_amount'));
3087 $firstID = $contributionPriceSet['id'];
3088 $this->callAPISuccess('price_set', 'create', array(
3089 'id' => $contributionPriceSet['id'],
3093 unset($contributionPriceSet['id']);
3094 $newPriceSet = $this->callAPISuccess('price_set', 'create', $contributionPriceSet);
3095 $priceField = $this->callAPISuccess('price_field', 'getsingle', array(
3096 'price_set_id' => $firstID,
3097 'options' => array('limit' => 1),
3099 unset($priceField['id']);
3100 $priceField['price_set_id'] = $newPriceSet['id'];
3101 $newPriceField = $this->callAPISuccess('price_field', 'create', $priceField);
3102 $priceFieldValue = $this->callAPISuccess('price_field_value', 'getsingle', array(
3103 'price_set_id' => $firstID,
3105 'options' => array('limit' => 1),
3108 unset($priceFieldValue['id']);
3109 //create some padding to use up ids
3110 $this->callAPISuccess('price_field_value', 'create', $priceFieldValue);
3111 $this->callAPISuccess('price_field_value', 'create', $priceFieldValue);
3112 $this->callAPISuccess('price_field_value', 'create', array_merge($priceFieldValue, array('price_field_id' => $newPriceField['id'])));
3116 * Create an instance of the paypal processor.
3117 * @todo this isn't a great place to put it - but really it belongs on a class that extends
3118 * this parent class & we don't have a structure for that yet
3119 * There is another function to this effect on the PaypalPro test but it appears to be silently failing
3120 * & the best protection agains that is the functions this class affords
3121 * @param array $params
3122 * @return int $result['id'] payment processor id
3124 public function paymentProcessorCreate($params = array()) {
3125 $params = array_merge(array(
3127 'domain_id' => CRM_Core_Config
::domainID(),
3128 'payment_processor_type_id' => 'PayPal',
3132 'user_name' => 'sunil._1183377782_biz_api1.webaccess.co.in',
3133 'password' => '1183377788',
3134 'signature' => 'APixCoQ-Zsaj-u3IH7mD5Do-7HUqA9loGnLSzsZga9Zr-aNmaJa3WGPH',
3135 'url_site' => 'https://www.sandbox.paypal.com/',
3136 'url_api' => 'https://api-3t.sandbox.paypal.com/',
3137 'url_button' => 'https://www.paypal.com/en_US/i/btn/btn_xpressCheckout.gif',
3138 'class_name' => 'Payment_PayPalImpl',
3139 'billing_mode' => 3,
3140 'financial_type_id' => 1,
3143 if (!is_numeric($params['payment_processor_type_id'])) {
3144 // really the api should handle this through getoptions but it's not exactly api call so lets just sort it
3146 $params['payment_processor_type_id'] = $this->callAPISuccess('payment_processor_type', 'getvalue', array(
3147 'name' => $params['payment_processor_type_id'],
3151 $result = $this->callAPISuccess('payment_processor', 'create', $params);
3152 return $result['id'];
3156 * Set up initial recurring payment allowing subsequent IPN payments.
3158 public function setupRecurringPaymentProcessorTransaction() {
3159 $contributionRecur = $this->callAPISuccess('contribution_recur', 'create', array(
3160 'contact_id' => $this->_contactID
,
3163 'installments' => 5,
3164 'frequency_unit' => 'Month',
3165 'frequency_interval' => 1,
3166 'invoice_id' => $this->_invoiceID
,
3167 'contribution_status_id' => 2,
3168 'processor_id' => $this->_paymentProcessorID
,
3169 'api.contribution.create' => array(
3170 'total_amount' => '200',
3171 'invoice_id' => $this->_invoiceID
,
3172 'financial_type_id' => 1,
3173 'contribution_status_id' => 'Pending',
3174 'contact_id' => $this->_contactID
,
3175 'contribution_page_id' => $this->_contributionPageID
,
3176 'payment_processor_id' => $this->_paymentProcessorID
,
3179 $this->_contributionRecurID
= $contributionRecur['id'];
3180 $this->_contributionID
= $contributionRecur['values']['0']['api.contribution.create']['id'];
3184 * 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
3186 public function setupMembershipRecurringPaymentProcessorTransaction() {
3187 $this->ids
['membership_type'] = $this->membershipTypeCreate();
3188 //create a contribution so our membership & contribution don't both have id = 1
3189 $this->contributionCreate($this->_contactID
, 1, 'abcd', '345j');
3190 $this->setupRecurringPaymentProcessorTransaction();
3192 $this->ids
['membership'] = $this->callAPISuccess('membership', 'create', array(
3193 'contact_id' => $this->_contactID
,
3194 'membership_type_id' => $this->ids
['membership_type'],
3195 'contribution_recur_id' => $this->_contributionRecurID
,
3196 'format.only_id' => TRUE,
3198 //CRM-15055 creates line items we don't want so get rid of them so we can set up our own line items
3199 CRM_Core_DAO
::executeQuery("TRUNCATE civicrm_line_item");
3201 $this->callAPISuccess('line_item', 'create', array(
3202 'entity_table' => 'civicrm_membership',
3203 'entity_id' => $this->ids
['membership'],
3204 'contribution_id' => $this->_contributionID
,
3205 'label' => 'General',
3207 'unit_price' => 200,
3208 'line_total' => 200,
3209 'financial_type_id' => 1,
3210 'price_field_id' => $this->callAPISuccess('price_field', 'getvalue', array(
3212 'label' => 'Membership Amount',
3214 'price_field_value_id' => $this->callAPISuccess('price_field_value', 'getvalue', array(
3216 'label' => 'General',
3219 $this->callAPISuccess('membership_payment', 'create', array(
3220 'contribution_id' => $this->_contributionID
,
3221 'membership_id' => $this->ids
['membership'],
3230 public function CiviUnitTestCase_fatalErrorHandler($message) {
3231 throw new Exception("{$message['message']}: {$message['code']}");
3235 * Helper function to create new mailing.
3238 public function createMailing() {
3240 'subject' => 'maild' . rand(),
3241 'body_text' => 'bdkfhdskfhduew{domain.address}{action.optOutUrl}',
3242 'name' => 'mailing name' . rand(),
3246 $result = $this->callAPISuccess('Mailing', 'create', $params);
3247 return $result['id'];
3251 * Helper function to delete mailing.
3254 public function deleteMailing($id) {
3259 $this->callAPISuccess('Mailing', 'delete', $params);
3263 * Wrap the entire test case in a transaction.
3265 * Only subsequent DB statements will be wrapped in TX -- this cannot
3266 * retroactively wrap old DB statements. Therefore, it makes sense to
3267 * call this at the beginning of setUp().
3269 * Note: Recall that TRUNCATE and ALTER will force-commit transactions, so
3270 * this option does not work with, e.g., custom-data.
3272 * WISHLIST: Monitor SQL queries in unit-tests and generate an exception
3273 * if TRUNCATE or ALTER is called while using a transaction.
3276 * Whether to use nesting or reference-counting.
3278 public function useTransaction($nest = TRUE) {
3280 $this->tx
= new CRM_Core_Transaction($nest);
3281 $this->tx
->rollback();
3285 public function clearOutputBuffer() {
3286 while (ob_get_level() > 0) {
3293 * @param array $apiResult
3295 protected function assertAttachmentExistence($exists, $apiResult) {
3296 $fileId = $apiResult['id'];
3297 $this->assertTrue(is_numeric($fileId));
3298 $this->assertEquals($exists, file_exists($apiResult['values'][$fileId]['path']));
3299 $this->assertDBQuery($exists ?
1 : 0, 'SELECT count(*) FROM civicrm_file WHERE id = %1', array(
3300 1 => array($fileId, 'Int'),
3302 $this->assertDBQuery($exists ?
1 : 0, 'SELECT count(*) FROM civicrm_entity_file WHERE id = %1', array(
3303 1 => array($fileId, 'Int'),