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)
477 public function createLoggedInUser() {
479 'first_name' => 'Logged In',
480 'last_name' => 'User ' . rand(),
481 'contact_type' => 'Individual',
483 $contactID = $this->individualCreate($params);
485 $session = CRM_Core_Session
::singleton();
486 $session->set('userID', $contactID);
489 public function cleanDB() {
490 self
::$populateOnce = NULL;
491 $this->DBResetRequired
= TRUE;
493 $this->_dbconn
= $this->getConnection();
494 static::_populateDB();
495 $this->tempDirs
= array();
499 * Create default domain contacts for the two domains added during test class.
500 * database population.
502 public function createDomainContacts() {
503 $default_domain_contact = $this->organizationCreate();
504 $second_domain_contact = $this->organizationCreate();
508 * Common teardown functions for all unit tests.
510 protected function tearDown() {
511 error_reporting(E_ALL
& ~E_NOTICE
);
512 CRM_Utils_Hook
::singleton()->reset();
513 $this->hookClass
->reset();
514 $session = CRM_Core_Session
::singleton();
515 $session->set('userID', NULL);
518 $this->tx
->rollback()->commit();
521 CRM_Core_Transaction
::forceRollbackIfEnabled();
522 \Civi\Core\Transaction\Manager
::singleton(TRUE);
525 CRM_Core_Transaction
::forceRollbackIfEnabled();
526 \Civi\Core\Transaction\Manager
::singleton(TRUE);
528 $tablesToTruncate = array('civicrm_contact');
529 $this->quickCleanup($tablesToTruncate);
530 $this->createDomainContacts();
533 $this->cleanTempDirs();
534 $this->unsetExtensionSystem();
535 $this->clearOutputBuffer();
539 * FIXME: Maybe a better way to do it
541 public function foreignKeyChecksOff() {
542 self
::$utils = new Utils($GLOBALS['mysql_host'],
543 $GLOBALS['mysql_port'],
544 $GLOBALS['mysql_user'],
545 $GLOBALS['mysql_pass']
547 $dbName = self
::getDBName();
548 $query = "USE {$dbName};" . "SET foreign_key_checks = 1";
549 if (self
::$utils->do_query($query) === FALSE) {
551 echo 'Cannot set foreign_key_checks = 0';
557 public function foreignKeyChecksOn() {
558 // FIXME: might not be needed if previous fixme implemented
562 * Generic function to compare expected values after an api call to retrieved.
565 * @daoName string DAO Name of object we're evaluating.
566 * @id int Id of object
567 * @match array Associative array of field name => expected value. Empty if asserting
568 * that a DELETE occurred
569 * @delete boolean True if we're checking that a DELETE action occurred.
573 * @param bool $delete
574 * @throws \PHPUnit_Framework_AssertionFailedError
576 public function assertDBState($daoName, $id, $match, $delete = FALSE) {
578 // adding this here since developers forget to check for an id
579 // and hence we get the first value in the db
580 $this->fail('ID not populated. Please fix your assertDBState usage!!!');
583 $object = new $daoName();
587 // If we're asserting successful record deletion, make sure object is NOT found.
589 if ($object->find(TRUE)) {
590 $this->fail("Object not deleted by delete operation: $daoName, $id");
595 // Otherwise check matches of DAO field values against expected values in $match.
596 if ($object->find(TRUE)) {
597 $fields = &$object->fields();
598 foreach ($fields as $name => $value) {
599 $dbName = $value['name'];
600 if (isset($match[$name])) {
602 $this->assertEquals($object->$dbName, $match[$name]);
604 elseif (isset($match[$dbName])) {
606 $this->assertEquals($object->$dbName, $match[$dbName]);
611 $this->fail("Could not retrieve object: $daoName, $id");
614 $matchSize = count($match);
615 if ($verifiedCount != $matchSize) {
616 $this->fail("Did not verify all fields in match array: $daoName, $id. Verified count = $verifiedCount. Match array size = $matchSize");
621 * Request a record from the DB by seachColumn+searchValue. Success if a record is found.
622 * @param string $daoName
623 * @param $searchValue
624 * @param $returnColumn
625 * @param $searchColumn
628 * @return null|string
629 * @throws PHPUnit_Framework_AssertionFailedError
631 public function assertDBNotNull($daoName, $searchValue, $returnColumn, $searchColumn, $message) {
632 if (empty($searchValue)) {
633 $this->fail("empty value passed to assertDBNotNull");
635 $value = CRM_Core_DAO
::getFieldValue($daoName, $searchValue, $returnColumn, $searchColumn, TRUE);
636 $this->assertNotNull($value, $message);
642 * Request a record from the DB by seachColumn+searchValue. Success if returnColumn value is NULL.
643 * @param string $daoName
644 * @param $searchValue
645 * @param $returnColumn
646 * @param $searchColumn
649 public function assertDBNull($daoName, $searchValue, $returnColumn, $searchColumn, $message) {
650 $value = CRM_Core_DAO
::getFieldValue($daoName, $searchValue, $returnColumn, $searchColumn, TRUE);
651 $this->assertNull($value, $message);
655 * Request a record from the DB by id. Success if row not found.
656 * @param string $daoName
658 * @param null $message
660 public function assertDBRowNotExist($daoName, $id, $message = NULL) {
661 $message = $message ?
$message : "$daoName (#$id) should not exist";
662 $value = CRM_Core_DAO
::getFieldValue($daoName, $id, 'id', 'id', TRUE);
663 $this->assertNull($value, $message);
667 * Request a record from the DB by id. Success if row not found.
668 * @param string $daoName
670 * @param null $message
672 public function assertDBRowExist($daoName, $id, $message = NULL) {
673 $message = $message ?
$message : "$daoName (#$id) should exist";
674 $value = CRM_Core_DAO
::getFieldValue($daoName, $id, 'id', 'id', TRUE);
675 $this->assertEquals($id, $value, $message);
679 * Compare a single column value in a retrieved DB record to an expected value.
680 * @param string $daoName
681 * @param $searchValue
682 * @param $returnColumn
683 * @param $searchColumn
684 * @param $expectedValue
687 public function assertDBCompareValue(
688 $daoName, $searchValue, $returnColumn, $searchColumn,
689 $expectedValue, $message
691 $value = CRM_Core_DAO
::getFieldValue($daoName, $searchValue, $returnColumn, $searchColumn, TRUE);
692 $this->assertEquals($value, $expectedValue, $message);
696 * Compare all values in a single retrieved DB record to an array of expected values.
697 * @param string $daoName
698 * @param array $searchParams
699 * @param $expectedValues
701 public function assertDBCompareValues($daoName, $searchParams, $expectedValues) {
702 //get the values from db
704 CRM_Core_DAO
::commonRetrieve($daoName, $searchParams, $dbValues);
706 // compare db values with expected values
707 self
::assertAttributesEquals($expectedValues, $dbValues);
711 * Assert that a SQL query returns a given value.
713 * The first argument is an expected value. The remaining arguments are passed
714 * to CRM_Core_DAO::singleValueQuery
716 * Example: $this->assertSql(2, 'select count(*) from foo where foo.bar like "%1"',
717 * array(1 => array("Whiz", "String")));
720 * @param array $params
721 * @param string $message
723 public function assertDBQuery($expected, $query, $params = array(), $message = '') {
727 $actual = CRM_Core_DAO
::singleValueQuery($query, $params);
728 $this->assertEquals($expected, $actual,
729 sprintf('%sexpected=[%s] actual=[%s] query=[%s]',
730 $message, $expected, $actual, CRM_Core_DAO
::composeQuery($query, $params, FALSE)
736 * Assert that two array-trees are exactly equal, notwithstanding
737 * the sorting of keys
739 * @param array $expected
740 * @param array $actual
742 public function assertTreeEquals($expected, $actual) {
745 CRM_Utils_Array
::flatten($expected, $e, '', ':::');
746 CRM_Utils_Array
::flatten($actual, $a, '', ':::');
750 $this->assertEquals($e, $a);
754 * Assert that two numbers are approximately equal.
756 * @param int|float $expected
757 * @param int|float $actual
758 * @param int|float $tolerance
759 * @param string $message
761 public function assertApproxEquals($expected, $actual, $tolerance, $message = NULL) {
762 if ($message === NULL) {
763 $message = sprintf("approx-equals: expected=[%.3f] actual=[%.3f] tolerance=[%.3f]", $expected, $actual, $tolerance);
765 $this->assertTrue(abs($actual - $expected) < $tolerance, $message);
769 * Assert attributes are equal.
771 * @param $expectedValues
772 * @param $actualValues
773 * @param string $message
775 * @throws PHPUnit_Framework_AssertionFailedError
777 public function assertAttributesEquals($expectedValues, $actualValues, $message = NULL) {
778 foreach ($expectedValues as $paramName => $paramValue) {
779 if (isset($actualValues[$paramName])) {
780 $this->assertEquals($paramValue, $actualValues[$paramName], "Value Mismatch On $paramName - value 1 is " . print_r($paramValue, TRUE) . " value 2 is " . print_r($actualValues[$paramName], TRUE));
783 $this->fail("Attribute '$paramName' not present in actual array.");
792 public function assertArrayKeyExists($key, &$list) {
793 $result = isset($list[$key]) ?
TRUE : FALSE;
794 $this->assertTrue($result, ts("%1 element exists?",
803 public function assertArrayValueNotNull($key, &$list) {
804 $this->assertArrayKeyExists($key, $list);
806 $value = isset($list[$key]) ?
$list[$key] : NULL;
807 $this->assertTrue($value,
808 ts("%1 element not null?",
815 * Check that api returned 'is_error' => 0.
817 * @param array $apiResult
819 * @param string $prefix
820 * Extra test to add to message.
822 public function assertAPISuccess($apiResult, $prefix = '') {
823 if (!empty($prefix)) {
826 $errorMessage = empty($apiResult['error_message']) ?
'' : " " . $apiResult['error_message'];
828 if (!empty($apiResult['debug_information'])) {
829 $errorMessage .= "\n " . print_r($apiResult['debug_information'], TRUE);
831 if (!empty($apiResult['trace'])) {
832 $errorMessage .= "\n" . print_r($apiResult['trace'], TRUE);
834 $this->assertEquals(0, $apiResult['is_error'], $prefix . $errorMessage);
838 * Check that api returned 'is_error' => 1.
840 * @param array $apiResult
842 * @param string $prefix
843 * Extra test to add to message.
844 * @param null $expectedError
846 public function assertAPIFailure($apiResult, $prefix = '', $expectedError = NULL) {
847 if (!empty($prefix)) {
850 if ($expectedError && !empty($apiResult['is_error'])) {
851 $this->assertEquals($expectedError, $apiResult['error_message'], 'api error message not as expected' . $prefix);
853 $this->assertEquals(1, $apiResult['is_error'], "api call should have failed but it succeeded " . $prefix . (print_r($apiResult, TRUE)));
854 $this->assertNotEmpty($apiResult['error_message']);
860 * @param string $message
862 public function assertType($expected, $actual, $message = '') {
863 return $this->assertInternalType($expected, $actual, $message);
867 * Check that a deleted item has been deleted.
872 public function assertAPIDeleted($entity, $id) {
873 $this->callAPISuccess($entity, 'getcount', array('id' => $id), 0);
878 * Check that api returned 'is_error' => 1
879 * else provide full message
880 * @param array $result
882 * @param array $valuesToExclude
883 * @param string $prefix
884 * Extra test to add to message.
886 public function assertAPIArrayComparison($result, $expected, $valuesToExclude = array(), $prefix = '') {
887 $valuesToExclude = array_merge($valuesToExclude, array('debug', 'xdebug', 'sequential'));
888 foreach ($valuesToExclude as $value) {
889 if (isset($result[$value])) {
890 unset($result[$value]);
892 if (isset($expected[$value])) {
893 unset($expected[$value]);
896 $this->assertEquals($result, $expected, "api result array comparison failed " . $prefix . print_r($result, TRUE) . ' was compared to ' . print_r($expected, TRUE));
900 * A stub for the API interface. This can be overriden by subclasses to change how the API is called.
904 * @param array $params
907 public function civicrm_api($entity, $action, $params) {
908 return civicrm_api($entity, $action, $params);
912 * wrap api functions.
913 * so we can ensure they succeed & throw exceptions without litterering the test with checks
915 * @param string $entity
916 * @param string $action
917 * @param array $params
918 * @param mixed $checkAgainst
919 * Optional value to check result against, implemented for getvalue,.
920 * getcount, getsingle. Note that for getvalue the type is checked rather than the value
921 * for getsingle the array is compared against an array passed in - the id is not compared (for
926 public function callAPISuccess($entity, $action, $params, $checkAgainst = NULL) {
927 $params = array_merge(array(
928 'version' => $this->_apiversion
,
933 switch (strtolower($action)) {
935 return $this->callAPISuccessGetValue($entity, $params, $checkAgainst);
938 return $this->callAPISuccessGetSingle($entity, $params, $checkAgainst);
941 return $this->callAPISuccessGetCount($entity, $params, $checkAgainst);
943 $result = $this->civicrm_api($entity, $action, $params);
944 $this->assertAPISuccess($result, "Failure in api call for $entity $action");
949 * This function exists to wrap api getValue function & check the result
950 * so we can ensure they succeed & throw exceptions without litterering the test with checks
951 * There is a type check in this
953 * @param string $entity
954 * @param array $params
955 * @param string $type
956 * Per http://php.net/manual/en/function.gettype.php possible types.
966 public function callAPISuccessGetValue($entity, $params, $type = NULL) {
968 'version' => $this->_apiversion
,
971 $result = $this->civicrm_api($entity, 'getvalue', $params);
973 if ($type == 'integer') {
974 // api seems to return integers as strings
975 $this->assertTrue(is_numeric($result), "expected a numeric value but got " . print_r($result, 1));
978 $this->assertType($type, $result, "returned result should have been of type $type but was ");
985 * This function exists to wrap api getsingle function & check the result
986 * so we can ensure they succeed & throw exceptions without litterering the test with checks
988 * @param string $entity
989 * @param array $params
990 * @param array $checkAgainst
991 * Array to compare result against.
1002 public function callAPISuccessGetSingle($entity, $params, $checkAgainst = NULL) {
1004 'version' => $this->_apiversion
,
1007 $result = $this->civicrm_api($entity, 'getsingle', $params);
1008 if (!is_array($result) ||
!empty($result['is_error']) ||
isset($result['values'])) {
1009 throw new Exception('Invalid getsingle result' . print_r($result, TRUE));
1011 if ($checkAgainst) {
1012 // @todo - have gone with the fn that unsets id? should we check id?
1013 $this->checkArrayEquals($result, $checkAgainst);
1019 * This function exists to wrap api getValue function & check the result
1020 * so we can ensure they succeed & throw exceptions without litterering the test with checks
1021 * There is a type check in this
1022 * @param string $entity
1023 * @param array $params
1024 * @param null $count
1028 public function callAPISuccessGetCount($entity, $params, $count = NULL) {
1030 'version' => $this->_apiversion
,
1033 $result = $this->civicrm_api($entity, 'getcount', $params);
1034 if (!is_int($result) ||
!empty($result['is_error']) ||
isset($result['values'])) {
1035 throw new Exception('Invalid getcount result : ' . print_r($result, TRUE) . " type :" . gettype($result));
1037 if (is_int($count)) {
1038 $this->assertEquals($count, $result, "incorrect count returned from $entity getcount");
1044 * This function exists to wrap api functions.
1045 * so we can ensure they succeed, generate and example & throw exceptions without litterering the test with checks
1047 * @param string $entity
1048 * @param string $action
1049 * @param array $params
1050 * @param string $function
1051 * Pass this in to create a generated example.
1052 * @param string $file
1053 * Pass this in to create a generated example.
1054 * @param string $description
1055 * @param string|null $exampleName
1059 public function callAPIAndDocument($entity, $action, $params, $function, $file, $description = "", $exampleName = NULL) {
1060 $params['version'] = $this->_apiversion
;
1061 $result = $this->callAPISuccess($entity, $action, $params);
1062 $this->documentMe($entity, $action, $params, $result, $function, $file, $description, $exampleName);
1067 * This function exists to wrap api functions.
1068 * so we can ensure they fail where expected & throw exceptions without litterering the test with checks
1069 * @param string $entity
1070 * @param string $action
1071 * @param array $params
1072 * @param string $expectedErrorMessage
1074 * @param null $extraOutput
1077 public function callAPIFailure($entity, $action, $params, $expectedErrorMessage = NULL, $extraOutput = NULL) {
1078 if (is_array($params)) {
1080 'version' => $this->_apiversion
,
1083 $result = $this->civicrm_api($entity, $action, $params);
1084 $this->assertAPIFailure($result, "We expected a failure for $entity $action but got a success");
1089 * Create required data based on $this->entity & $this->params
1090 * This is just a way to set up the test data for delete & get functions
1091 * so the distinction between set
1092 * up & tested functions is clearer
1097 public function createTestEntity() {
1098 return $entity = $this->callAPISuccess($this->entity
, 'create', $this->params
);
1102 * Generic function to create Organisation, to be used in test cases
1104 * @param array $params
1105 * parameters for civicrm_contact_add api function call
1107 * sequence number if creating multiple organizations
1110 * id of Organisation created
1112 public function organizationCreate($params = array(), $seq = 0) {
1116 $params = array_merge($this->sampleContact('Organization', $seq), $params);
1117 return $this->_contactCreate($params);
1121 * Generic function to create Individual, to be used in test cases
1123 * @param array $params
1124 * parameters for civicrm_contact_add api function call
1126 * sequence number if creating multiple individuals
1129 * id of Individual created
1131 public function individualCreate($params = array(), $seq = 0) {
1132 $params = array_merge($this->sampleContact('Individual', $seq), $params);
1133 return $this->_contactCreate($params);
1137 * Generic function to create Household, to be used in test cases
1139 * @param array $params
1140 * parameters for civicrm_contact_add api function call
1142 * sequence number if creating multiple households
1145 * id of Household created
1147 public function householdCreate($params = array(), $seq = 0) {
1148 $params = array_merge($this->sampleContact('Household', $seq), $params);
1149 return $this->_contactCreate($params);
1153 * Helper function for getting sample contact properties.
1155 * @param string $contact_type
1156 * enum contact type: Individual, Organization
1158 * sequence number for the values of this type
1161 * properties of sample contact (ie. $params for API call)
1163 public function sampleContact($contact_type, $seq = 0) {
1165 'Individual' => array(
1166 // The number of values in each list need to be coprime numbers to not have duplicates
1167 'first_name' => array('Anthony', 'Joe', 'Terrence', 'Lucie', 'Albert', 'Bill', 'Kim'),
1168 'middle_name' => array('J.', 'M.', 'P', 'L.', 'K.', 'A.', 'B.', 'C.', 'D', 'E.', 'Z.'),
1169 'last_name' => array('Anderson', 'Miller', 'Smith', 'Collins', 'Peterson'),
1171 'Organization' => array(
1172 'organization_name' => array(
1173 'Unit Test Organization',
1180 'Household' => array(
1181 'household_name' => array('Unit Test household'),
1184 $params = array('contact_type' => $contact_type);
1185 foreach ($samples[$contact_type] as $key => $values) {
1186 $params[$key] = $values[$seq %
count($values)];
1188 if ($contact_type == 'Individual') {
1189 $params['email'] = strtolower(
1190 $params['first_name'] . '_' . $params['last_name'] . '@civicrm.org'
1192 $params['prefix_id'] = 3;
1193 $params['suffix_id'] = 3;
1199 * Private helper function for calling civicrm_contact_add.
1201 * @param array $params
1202 * For civicrm_contact_add api function call.
1207 * id of Household created
1209 private function _contactCreate($params) {
1210 $result = $this->callAPISuccess('contact', 'create', $params);
1211 if (!empty($result['is_error']) ||
empty($result['id'])) {
1212 throw new Exception('Could not create test contact, with message: ' . CRM_Utils_Array
::value('error_message', $result) . "\nBacktrace:" . CRM_Utils_Array
::value('trace', $result));
1214 return $result['id'];
1218 * Delete contact, ensuring it is not the domain contact
1220 * @param int $contactID
1221 * Contact ID to delete
1223 public function contactDelete($contactID) {
1224 $domain = new CRM_Core_BAO_Domain();
1225 $domain->contact_id
= $contactID;
1226 if (!$domain->find(TRUE)) {
1227 $this->callAPISuccess('contact', 'delete', array(
1229 'skip_undelete' => 1,
1235 * @param int $contactTypeId
1239 public function contactTypeDelete($contactTypeId) {
1240 $result = CRM_Contact_BAO_ContactType
::del($contactTypeId);
1242 throw new Exception('Could not delete contact type');
1247 * @param array $params
1251 public function membershipTypeCreate($params = array()) {
1252 CRM_Member_PseudoConstant
::flush('membershipType');
1253 CRM_Core_Config
::clearDBCache();
1254 $memberOfOrganization = $this->organizationCreate();
1255 $params = array_merge(array(
1256 'name' => 'General',
1257 'duration_unit' => 'year',
1258 'duration_interval' => 1,
1259 'period_type' => 'rolling',
1260 'member_of_contact_id' => $memberOfOrganization,
1262 'financial_type_id' => 1,
1265 'visibility' => 'Public',
1268 $result = $this->callAPISuccess('MembershipType', 'Create', $params);
1270 CRM_Member_PseudoConstant
::flush('membershipType');
1271 CRM_Utils_Cache
::singleton()->flush();
1273 return $result['id'];
1277 * @param array $params
1281 public function contactMembershipCreate($params) {
1283 'join_date' => '2007-01-21',
1284 'start_date' => '2007-01-21',
1285 'end_date' => '2007-12-21',
1286 'source' => 'Payment',
1289 foreach ($pre as $key => $val) {
1290 if (!isset($params[$key])) {
1291 $params[$key] = $val;
1295 $result = $this->callAPISuccess('Membership', 'create', $params);
1296 return $result['id'];
1300 * Delete Membership Type.
1302 * @param array $params
1304 public function membershipTypeDelete($params) {
1305 $this->callAPISuccess('MembershipType', 'Delete', $params);
1309 * @param int $membershipID
1311 public function membershipDelete($membershipID) {
1312 $deleteParams = array('id' => $membershipID);
1313 $result = $this->callAPISuccess('Membership', 'Delete', $deleteParams);
1317 * @param string $name
1321 public function membershipStatusCreate($name = 'test member status') {
1322 $params['name'] = $name;
1323 $params['start_event'] = 'start_date';
1324 $params['end_event'] = 'end_date';
1325 $params['is_current_member'] = 1;
1326 $params['is_active'] = 1;
1328 $result = $this->callAPISuccess('MembershipStatus', 'Create', $params);
1329 CRM_Member_PseudoConstant
::flush('membershipStatus');
1330 return $result['id'];
1334 * @param int $membershipStatusID
1336 public function membershipStatusDelete($membershipStatusID) {
1337 if (!$membershipStatusID) {
1340 $result = $this->callAPISuccess('MembershipStatus', 'Delete', array('id' => $membershipStatusID));
1344 * @param array $params
1348 public function relationshipTypeCreate($params = array()) {
1349 $params = array_merge(array(
1350 'name_a_b' => 'Relation 1 for relationship type create',
1351 'name_b_a' => 'Relation 2 for relationship type create',
1352 'contact_type_a' => 'Individual',
1353 'contact_type_b' => 'Organization',
1360 $result = $this->callAPISuccess('relationship_type', 'create', $params);
1361 CRM_Core_PseudoConstant
::flush('relationshipType');
1363 return $result['id'];
1367 * Delete Relatinship Type.
1369 * @param int $relationshipTypeID
1371 public function relationshipTypeDelete($relationshipTypeID) {
1372 $params['id'] = $relationshipTypeID;
1373 $this->callAPISuccess('relationship_type', 'delete', $params);
1377 * @param array $params
1381 public function paymentProcessorTypeCreate($params = NULL) {
1382 if (is_null($params)) {
1384 'name' => 'API_Test_PP',
1385 'title' => 'API Test Payment Processor',
1386 'class_name' => 'CRM_Core_Payment_APITest',
1387 'billing_mode' => 'form',
1393 $result = $this->callAPISuccess('payment_processor_type', 'create', $params);
1395 CRM_Core_PseudoConstant
::flush('paymentProcessorType');
1397 return $result['id'];
1401 * Create Participant.
1403 * @param array $params
1404 * Array of contact id and event id values.
1407 * $id of participant created
1409 public function participantCreate($params) {
1410 if (empty($params['contact_id'])) {
1411 $params['contact_id'] = $this->individualCreate();
1413 if (empty($params['event_id'])) {
1414 $event = $this->eventCreate();
1415 $params['event_id'] = $event['id'];
1420 'register_date' => 20070219,
1421 'source' => 'Wimbeldon',
1422 'event_level' => 'Payment',
1426 $params = array_merge($defaults, $params);
1427 $result = $this->callAPISuccess('Participant', 'create', $params);
1428 return $result['id'];
1432 * Create Payment Processor.
1434 * @return CRM_Financial_DAO_PaymentProcessor
1435 * instance of Payment Processsor
1437 public function processorCreate() {
1438 $processorParams = array(
1441 'payment_processor_type_id' => 10,
1442 'financial_account_id' => 12,
1445 'url_site' => 'http://dummy.com',
1446 'url_recur' => 'http://dummy.com',
1447 'billing_mode' => 1,
1449 $paymentProcessor = CRM_Financial_BAO_PaymentProcessor
::create($processorParams);
1450 return $paymentProcessor;
1454 * Create contribution page.
1456 * @param array $params
1458 * Array of contribution page
1460 public function contributionPageCreate($params) {
1461 $this->_pageParams
= array(
1462 'title' => 'Test Contribution Page',
1463 'financial_type_id' => 1,
1464 'currency' => 'USD',
1465 'financial_account_id' => 1,
1466 'payment_processor' => $params['processor_id'],
1468 'is_allow_other_amount' => 1,
1470 'max_amount' => 1000,
1472 $contributionPage = $this->callAPISuccess('contribution_page', 'create', $this->_pageParams
);
1473 return $contributionPage;
1479 * @param array $params
1481 * result of created tag
1483 public function tagCreate($params = array()) {
1485 'name' => 'New Tag3',
1486 'description' => 'This is description for Our New Tag ',
1489 $params = array_merge($defaults, $params);
1490 $result = $this->callAPISuccess('Tag', 'create', $params);
1491 return $result['values'][$result['id']];
1498 * Id of the tag to be deleted.
1502 public function tagDelete($tagId) {
1503 require_once 'api/api.php';
1507 $result = $this->callAPISuccess('Tag', 'delete', $params);
1508 return $result['id'];
1512 * Add entity(s) to the tag
1514 * @param array $params
1518 public function entityTagAdd($params) {
1519 $result = $this->callAPISuccess('entity_tag', 'create', $params);
1524 * Create contribution.
1530 * id of created contribution
1532 public function pledgeCreate($cID) {
1534 'contact_id' => $cID,
1535 'pledge_create_date' => date('Ymd'),
1536 'start_date' => date('Ymd'),
1537 'scheduled_date' => date('Ymd'),
1539 'pledge_status_id' => '2',
1540 'financial_type_id' => '1',
1541 'pledge_original_installment_amount' => 20,
1542 'frequency_interval' => 5,
1543 'frequency_unit' => 'year',
1544 'frequency_day' => 15,
1545 'installments' => 5,
1548 $result = $this->callAPISuccess('Pledge', 'create', $params);
1549 return $result['id'];
1553 * Delete contribution.
1555 * @param int $pledgeId
1557 public function pledgeDelete($pledgeId) {
1559 'pledge_id' => $pledgeId,
1561 $this->callAPISuccess('Pledge', 'delete', $params);
1565 * Create contribution.
1569 * @param int $cTypeID
1570 * Id of financial type.
1571 * @param int $invoiceID
1572 * @param int $trxnID
1573 * @param int $paymentInstrumentID
1574 * @param bool $isFee
1577 * id of created contribution
1579 public function contributionCreate($cID, $cTypeID = 1, $invoiceID = 67890, $trxnID = 12345, $paymentInstrumentID = 1, $isFee = TRUE) {
1582 'contact_id' => $cID,
1583 'receive_date' => date('Ymd'),
1584 'total_amount' => 100.00,
1585 'financial_type_id' => empty($cTypeID) ?
1 : $cTypeID,
1586 'payment_instrument_id' => empty($paymentInstrumentID) ?
1 : $paymentInstrumentID,
1587 'non_deductible_amount' => 10.00,
1588 'trxn_id' => $trxnID,
1589 'invoice_id' => $invoiceID,
1591 'contribution_status_id' => 1,
1592 // 'note' => 'Donating for Nobel Cause', *Fixme
1596 $params['fee_amount'] = 5.00;
1597 $params['net_amount'] = 95.00;
1600 $result = $this->callAPISuccess('contribution', 'create', $params);
1601 return $result['id'];
1605 * Create online contribution.
1607 * @param array $params
1608 * @param int $financialType
1609 * Id of financial type.
1610 * @param int $invoiceID
1611 * @param int $trxnID
1614 * id of created contribution
1616 public function onlineContributionCreate($params, $financialType, $invoiceID = 67890, $trxnID = 12345) {
1617 $contribParams = array(
1618 'contact_id' => $params['contact_id'],
1619 'receive_date' => date('Ymd'),
1620 'total_amount' => 100.00,
1621 'financial_type_id' => $financialType,
1622 'contribution_page_id' => $params['contribution_page_id'],
1624 'invoice_id' => 67890,
1627 $contribParams = array_merge($contribParams, $params);
1628 $result = $this->callAPISuccess('contribution', 'create', $contribParams);
1630 return $result['id'];
1634 * Delete contribution.
1636 * @param int $contributionId
1640 public function contributionDelete($contributionId) {
1642 'contribution_id' => $contributionId,
1644 $result = $this->callAPISuccess('contribution', 'delete', $params);
1651 * @param array $params
1652 * Name-value pair for an event.
1656 public function eventCreate($params = array()) {
1657 // if no contact was passed, make up a dummy event creator
1658 if (!isset($params['contact_id'])) {
1659 $params['contact_id'] = $this->_contactCreate(array(
1660 'contact_type' => 'Individual',
1661 'first_name' => 'Event',
1662 'last_name' => 'Creator',
1666 // set defaults for missing params
1667 $params = array_merge(array(
1668 'title' => 'Annual CiviCRM meet',
1669 'summary' => 'If you have any CiviCRM related issues or want to track where CiviCRM is heading, Sign up now',
1670 'description' => 'This event is intended to give brief idea about progess of CiviCRM and giving solutions to common user issues',
1671 'event_type_id' => 1,
1673 'start_date' => 20081021,
1674 'end_date' => 20081023,
1675 'is_online_registration' => 1,
1676 'registration_start_date' => 20080601,
1677 'registration_end_date' => 20081015,
1678 'max_participants' => 100,
1679 'event_full_text' => 'Sorry! We are already full',
1682 'is_show_location' => 0,
1685 return $this->callAPISuccess('Event', 'create', $params);
1696 public function eventDelete($id) {
1700 return $this->callAPISuccess('event', 'delete', $params);
1704 * Delete participant.
1706 * @param int $participantID
1710 public function participantDelete($participantID) {
1712 'id' => $participantID,
1714 return $this->callAPISuccess('Participant', 'delete', $params);
1718 * Create participant payment.
1720 * @param int $participantID
1721 * @param int $contributionID
1723 * $id of created payment
1725 public function participantPaymentCreate($participantID, $contributionID = NULL) {
1726 //Create Participant Payment record With Values
1728 'participant_id' => $participantID,
1729 'contribution_id' => $contributionID,
1732 $result = $this->callAPISuccess('participant_payment', 'create', $params);
1733 return $result['id'];
1737 * Delete participant payment.
1739 * @param int $paymentID
1741 public function participantPaymentDelete($paymentID) {
1745 $result = $this->callAPISuccess('participant_payment', 'delete', $params);
1751 * @param int $contactID
1753 * location id of created location
1755 public function locationAdd($contactID) {
1758 'location_type' => 'New Location Type',
1760 'name' => 'Saint Helier St',
1761 'county' => 'Marin',
1762 'country' => 'United States',
1763 'state_province' => 'Michigan',
1764 'supplemental_address_1' => 'Hallmark Ct',
1765 'supplemental_address_2' => 'Jersey Village',
1770 'contact_id' => $contactID,
1771 'address' => $address,
1772 'location_format' => '2.0',
1773 'location_type' => 'New Location Type',
1776 $result = $this->callAPISuccess('Location', 'create', $params);
1781 * Delete Locations of contact.
1783 * @param array $params
1786 public function locationDelete($params) {
1787 $this->callAPISuccess('Location', 'delete', $params);
1791 * Add a Location Type.
1793 * @param array $params
1794 * @return CRM_Core_DAO_LocationType
1795 * location id of created location
1797 public function locationTypeCreate($params = NULL) {
1798 if ($params === NULL) {
1800 'name' => 'New Location Type',
1801 'vcard_name' => 'New Location Type',
1802 'description' => 'Location Type for Delete',
1807 $locationType = new CRM_Core_DAO_LocationType();
1808 $locationType->copyValues($params);
1809 $locationType->save();
1810 // clear getfields cache
1811 CRM_Core_PseudoConstant
::flush();
1812 $this->callAPISuccess('phone', 'getfields', array('version' => 3, 'cache_clear' => 1));
1813 return $locationType;
1817 * Delete a Location Type.
1819 * @param int $locationTypeId
1821 public function locationTypeDelete($locationTypeId) {
1822 $locationType = new CRM_Core_DAO_LocationType();
1823 $locationType->id
= $locationTypeId;
1824 $locationType->delete();
1830 * @param array $params
1832 * groupId of created group
1834 public function groupCreate($params = array()) {
1835 $params = array_merge(array(
1836 'name' => 'Test Group 1',
1838 'title' => 'New Test Group Created',
1839 'description' => 'New Test Group Created',
1841 'visibility' => 'Public Pages',
1842 'group_type' => array(
1848 $result = $this->callAPISuccess('Group', 'create', $params);
1849 return $result['id'];
1854 * Function to add a Group.
1856 * @params array to add group
1858 * @param int $groupID
1859 * @param int $totalCount
1861 * groupId of created group
1863 public function groupContactCreate($groupID, $totalCount = 10) {
1864 $params = array('group_id' => $groupID);
1865 for ($i = 1; $i <= $totalCount; $i++
) {
1866 $contactID = $this->individualCreate();
1868 $params +
= array('contact_id' => $contactID);
1871 $params +
= array("contact_id.$i" => $contactID);
1874 $result = $this->callAPISuccess('GroupContact', 'create', $params);
1884 public function groupDelete($gid) {
1890 $this->callAPISuccess('Group', 'delete', $params);
1895 * @param array $params
1897 public function uFFieldCreate($params = array()) {
1898 $params = array_merge(array(
1900 'field_name' => 'first_name',
1903 'visibility' => 'Public Pages and Listings',
1904 'is_searchable' => '1',
1905 'label' => 'first_name',
1906 'field_type' => 'Individual',
1909 $this->callAPISuccess('uf_field', 'create', $params);
1913 * Add a UF Join Entry.
1915 * @param array $params
1917 * $id of created UF Join
1919 public function ufjoinCreate($params = NULL) {
1920 if ($params === NULL) {
1923 'module' => 'CiviEvent',
1924 'entity_table' => 'civicrm_event',
1930 $result = $this->callAPISuccess('uf_join', 'create', $params);
1935 * Delete a UF Join Entry.
1937 * @param array $params
1938 * with missing uf_group_id
1940 public function ufjoinDelete($params = NULL) {
1941 if ($params === NULL) {
1944 'module' => 'CiviEvent',
1945 'entity_table' => 'civicrm_event',
1948 'uf_group_id' => '',
1952 crm_add_uf_join($params);
1956 * @param array $params
1957 * Optional parameters.
1962 public function campaignCreate($params = array()) {
1963 $this->enableCiviCampaign();
1964 $campaign = $this->callAPISuccess('campaign', 'create', array_merge(array(
1965 'name' => 'big_campaign',
1966 'title' => 'Campaign',
1968 return $campaign['id'];
1972 * Create Group for a contact.
1974 * @param int $contactId
1976 public function contactGroupCreate($contactId) {
1978 'contact_id.1' => $contactId,
1982 $this->callAPISuccess('GroupContact', 'Create', $params);
1986 * Delete Group for a contact.
1988 * @param int $contactId
1990 public function contactGroupDelete($contactId) {
1992 'contact_id.1' => $contactId,
1995 $this->civicrm_api('GroupContact', 'Delete', $params);
2001 * @param array $params
2004 public function activityCreate($params = NULL) {
2006 if ($params === NULL) {
2007 $individualSourceID = $this->individualCreate();
2009 $contactParams = array(
2010 'first_name' => 'Julia',
2011 'Last_name' => 'Anderson',
2013 'email' => 'julia_anderson@civicrm.org',
2014 'contact_type' => 'Individual',
2017 $individualTargetID = $this->individualCreate($contactParams);
2020 'source_contact_id' => $individualSourceID,
2021 'target_contact_id' => array($individualTargetID),
2022 'assignee_contact_id' => array($individualTargetID),
2023 'subject' => 'Discussion on warm beer',
2024 'activity_date_time' => date('Ymd'),
2025 'duration_hours' => 30,
2026 'duration_minutes' => 20,
2027 'location' => 'Baker Street',
2028 'details' => 'Lets schedule a meeting',
2030 'activity_name' => 'Meeting',
2034 $result = $this->callAPISuccess('Activity', 'create', $params);
2036 $result['target_contact_id'] = $individualTargetID;
2037 $result['assignee_contact_id'] = $individualTargetID;
2042 * Create an activity type.
2044 * @param array $params
2048 public function activityTypeCreate($params) {
2049 return $this->callAPISuccess('ActivityType', 'create', $params);
2053 * Delete activity type.
2055 * @param int $activityTypeId
2056 * Id of the activity type.
2059 public function activityTypeDelete($activityTypeId) {
2060 $params['activity_type_id'] = $activityTypeId;
2061 return $this->callAPISuccess('ActivityType', 'delete', $params);
2065 * Create custom group.
2067 * @param array $params
2070 public function customGroupCreate($params = array()) {
2072 'title' => 'new custom group',
2073 'extends' => 'Contact',
2075 'style' => 'Inline',
2079 $params = array_merge($defaults, $params);
2081 if (strlen($params['title']) > 13) {
2082 $params['title'] = substr($params['title'], 0, 13);
2085 //have a crack @ deleting it first in the hope this will prevent derailing our tests
2086 $this->callAPISuccess('custom_group', 'get', array(
2087 'title' => $params['title'],
2088 array('api.custom_group.delete' => 1),
2091 return $this->callAPISuccess('custom_group', 'create', $params);
2095 * Existing function doesn't allow params to be over-ridden so need a new one
2096 * this one allows you to only pass in the params you want to change
2097 * @param array $params
2100 public function CustomGroupCreateByParams($params = array()) {
2102 'title' => "API Custom Group",
2103 'extends' => 'Contact',
2105 'style' => 'Inline',
2108 $params = array_merge($defaults, $params);
2109 return $this->callAPISuccess('custom_group', 'create', $params);
2113 * Create custom group with multi fields.
2114 * @param array $params
2117 public function CustomGroupMultipleCreateByParams($params = array()) {
2122 $params = array_merge($defaults, $params);
2123 return $this->CustomGroupCreateByParams($params);
2127 * Create custom group with multi fields.
2128 * @param array $params
2131 public function CustomGroupMultipleCreateWithFields($params = array()) {
2132 // also need to pass on $params['custom_field'] if not set but not in place yet
2134 $customGroup = $this->CustomGroupMultipleCreateByParams($params);
2135 $ids['custom_group_id'] = $customGroup['id'];
2137 $customField = $this->customFieldCreate(array(
2138 'custom_group_id' => $ids['custom_group_id'],
2139 'label' => 'field_1' . $ids['custom_group_id'],
2142 $ids['custom_field_id'][] = $customField['id'];
2144 $customField = $this->customFieldCreate(array(
2145 'custom_group_id' => $ids['custom_group_id'],
2146 'default_value' => '',
2147 'label' => 'field_2' . $ids['custom_group_id'],
2149 $ids['custom_field_id'][] = $customField['id'];
2151 $customField = $this->customFieldCreate(array(
2152 'custom_group_id' => $ids['custom_group_id'],
2153 'default_value' => '',
2154 'label' => 'field_3' . $ids['custom_group_id'],
2156 $ids['custom_field_id'][] = $customField['id'];
2162 * Create a custom group with a single text custom field. See
2163 * participant:testCreateWithCustom for how to use this
2165 * @param string $function
2167 * @param string $filename
2171 * ids of created objects
2173 public function entityCustomGroupWithSingleFieldCreate($function, $filename) {
2174 $params = array('title' => $function);
2175 $entity = substr(basename($filename), 0, strlen(basename($filename)) - 8);
2176 $params['extends'] = $entity ?
$entity : 'Contact';
2177 $customGroup = $this->CustomGroupCreate($params);
2178 $customField = $this->customFieldCreate(array('custom_group_id' => $customGroup['id'], 'label' => $function));
2179 CRM_Core_PseudoConstant
::flush();
2181 return array('custom_group_id' => $customGroup['id'], 'custom_field_id' => $customField['id']);
2185 * Delete custom group.
2187 * @param int $customGroupID
2191 public function customGroupDelete($customGroupID) {
2192 $params['id'] = $customGroupID;
2193 return $this->callAPISuccess('custom_group', 'delete', $params);
2197 * Create custom field.
2199 * @param array $params
2200 * (custom_group_id) is required.
2203 public function customFieldCreate($params) {
2204 $params = array_merge(array(
2205 'label' => 'Custom Field',
2206 'data_type' => 'String',
2207 'html_type' => 'Text',
2208 'is_searchable' => 1,
2210 'default_value' => 'defaultValue',
2213 $result = $this->callAPISuccess('custom_field', 'create', $params);
2214 // these 2 functions are called with force to flush static caches
2215 CRM_Core_BAO_CustomField
::getTableColumnGroup($result['id'], 1);
2216 CRM_Core_Component
::getEnabledComponents(1);
2221 * Delete custom field.
2223 * @param int $customFieldID
2227 public function customFieldDelete($customFieldID) {
2229 $params['id'] = $customFieldID;
2230 return $this->callAPISuccess('custom_field', 'delete', $params);
2239 public function noteCreate($cId) {
2241 'entity_table' => 'civicrm_contact',
2242 'entity_id' => $cId,
2243 'note' => 'hello I am testing Note',
2244 'contact_id' => $cId,
2245 'modified_date' => date('Ymd'),
2246 'subject' => 'Test Note',
2249 return $this->callAPISuccess('Note', 'create', $params);
2253 * Enable CiviCampaign Component.
2255 public function enableCiviCampaign() {
2256 CRM_Core_BAO_ConfigSetting
::enableComponent('CiviCampaign');
2257 // force reload of config object
2258 $config = CRM_Core_Config
::singleton(TRUE, TRUE);
2259 //flush cache by calling with reset
2260 $activityTypes = CRM_Core_PseudoConstant
::activityType(TRUE, TRUE, TRUE, 'name', TRUE);
2264 * Create test generated example in api/v3/examples.
2266 * To turn this off (e.g. on the server) set
2267 * define(DONT_DOCUMENT_TEST_CONFIG ,1);
2268 * in your settings file
2270 * @param string $entity
2271 * @param string $action
2272 * @param array $params
2273 * Array as passed to civicrm_api function.
2274 * @param array $result
2275 * Array as received from the civicrm_api function.
2276 * @param string $testFunction
2277 * Calling function - generally __FUNCTION__.
2278 * @param string $testFile
2279 * Called from file - generally __FILE__.
2280 * @param string $description
2281 * Descriptive text for the example file.
2282 * @param string $exampleName
2283 * Name for this example file (CamelCase) - if omitted the action name will be substituted.
2285 private function documentMe($entity, $action, $params, $result, $testFunction, $testFile, $description = "", $exampleName = NULL) {
2286 if (defined('DONT_DOCUMENT_TEST_CONFIG') && DONT_DOCUMENT_TEST_CONFIG
) {
2289 $entity = _civicrm_api_get_camel_name($entity);
2290 $action = strtolower($action);
2292 if (empty($exampleName)) {
2293 // Attempt to convert lowercase action name to CamelCase.
2294 // This is clunky/imperfect due to the convention of all lowercase actions.
2295 $exampleName = CRM_Utils_String
::convertStringToCamel($action);
2296 $knownPrefixes = array(
2303 foreach ($knownPrefixes as $prefix) {
2304 if (strpos($exampleName, $prefix) === 0 && $prefix != $exampleName) {
2305 $exampleName[strlen($prefix)] = strtoupper($exampleName[strlen($prefix)]);
2310 $this->tidyExampleResult($result);
2311 if (isset($params['version'])) {
2312 unset($params['version']);
2314 // Format multiline description as array
2316 if (is_string($description) && strlen($description)) {
2317 foreach (explode("\n", $description) as $line) {
2318 $desc[] = trim($line);
2321 $smarty = CRM_Core_Smarty
::singleton();
2322 $smarty->assign('testFunction', $testFunction);
2323 $smarty->assign('function', _civicrm_api_get_entity_name_from_camel($entity) . "_$action");
2324 $smarty->assign('params', $params);
2325 $smarty->assign('entity', $entity);
2326 $smarty->assign('testFile', basename($testFile));
2327 $smarty->assign('description', $desc);
2328 $smarty->assign('result', $result);
2329 $smarty->assign('action', $action);
2331 if (file_exists('../tests/templates/documentFunction.tpl')) {
2332 if (!is_dir("../api/v3/examples/$entity")) {
2333 mkdir("../api/v3/examples/$entity");
2335 $f = fopen("../api/v3/examples/$entity/$exampleName.php", "w+b");
2336 fwrite($f, $smarty->fetch('../tests/templates/documentFunction.tpl'));
2342 * Tidy up examples array so that fields that change often ..don't
2343 * and debug related fields are unset
2345 * @param array $result
2347 public function tidyExampleResult(&$result) {
2348 if (!is_array($result)) {
2351 $fieldsToChange = array(
2352 'hash' => '67eac7789eaee00',
2353 'modified_date' => '2012-11-14 16:02:35',
2354 'created_date' => '2013-07-28 08:49:19',
2355 'create_date' => '20120130621222105',
2356 'application_received_date' => '20130728084957',
2357 'in_date' => '2013-07-28 08:50:19',
2358 'scheduled_date' => '20130728085413',
2359 'approval_date' => '20130728085413',
2360 'pledge_start_date_high' => '20130726090416',
2361 'start_date' => '2013-07-29 00:00:00',
2362 'event_start_date' => '2013-07-29 00:00:00',
2363 'end_date' => '2013-08-04 00:00:00',
2364 'event_end_date' => '2013-08-04 00:00:00',
2365 'decision_date' => '20130805000000',
2368 $keysToUnset = array('xdebug', 'undefined_fields');
2369 foreach ($keysToUnset as $unwantedKey) {
2370 if (isset($result[$unwantedKey])) {
2371 unset($result[$unwantedKey]);
2374 if (isset($result['values'])) {
2375 if (!is_array($result['values'])) {
2378 $resultArray = &$result['values'];
2380 elseif (is_array($result)) {
2381 $resultArray = &$result;
2387 foreach ($resultArray as $index => &$values) {
2388 if (!is_array($values)) {
2391 foreach ($values as $key => &$value) {
2392 if (substr($key, 0, 3) == 'api' && is_array($value)) {
2393 if (isset($value['is_error'])) {
2394 // we have a std nested result format
2395 $this->tidyExampleResult($value);
2398 foreach ($value as &$nestedResult) {
2399 // this is an alternative syntax for nested results a keyed array of results
2400 $this->tidyExampleResult($nestedResult);
2404 if (in_array($key, $keysToUnset)) {
2405 unset($values[$key]);
2408 if (array_key_exists($key, $fieldsToChange) && !empty($value)) {
2409 $value = $fieldsToChange[$key];
2411 if (is_string($value)) {
2412 $value = addslashes($value);
2421 * @param array $params
2425 public function noteDelete($params) {
2426 return $this->callAPISuccess('Note', 'delete', $params);
2430 * Create custom field with Option Values.
2432 * @param array $customGroup
2433 * @param string $name
2434 * Name of custom field.
2438 public function customFieldOptionValueCreate($customGroup, $name) {
2439 $fieldParams = array(
2440 'custom_group_id' => $customGroup['id'],
2441 'name' => 'test_custom_group',
2442 'label' => 'Country',
2443 'html_type' => 'Select',
2444 'data_type' => 'String',
2447 'is_searchable' => 0,
2451 $optionGroup = array(
2453 'name' => 'option_group1',
2454 'label' => 'option_group_label1',
2457 $optionValue = array(
2458 'option_label' => array('Label1', 'Label2'),
2459 'option_value' => array('value1', 'value2'),
2460 'option_name' => array($name . '_1', $name . '_2'),
2461 'option_weight' => array(1, 2),
2462 'option_status' => 1,
2465 $params = array_merge($fieldParams, $optionGroup, $optionValue);
2467 return $this->callAPISuccess('custom_field', 'create', $params);
2475 public function confirmEntitiesDeleted($entities) {
2476 foreach ($entities as $entity) {
2478 $result = $this->callAPISuccess($entity, 'Get', array());
2479 if ($result['error'] == 1 ||
$result['count'] > 0) {
2480 // > than $entity[0] to allow a value to be passed in? e.g. domain?
2488 * @param $tablesToTruncate
2489 * @param bool $dropCustomValueTables
2490 * @throws \Exception
2492 public function quickCleanup($tablesToTruncate, $dropCustomValueTables = FALSE) {
2494 throw new Exception("CiviUnitTestCase: quickCleanup() is not compatible with useTransaction()");
2496 if ($dropCustomValueTables) {
2497 $tablesToTruncate[] = 'civicrm_custom_group';
2498 $tablesToTruncate[] = 'civicrm_custom_field';
2501 $tablesToTruncate = array_unique(array_merge($this->_tablesToTruncate
, $tablesToTruncate));
2503 CRM_Core_DAO
::executeQuery("SET FOREIGN_KEY_CHECKS = 0;");
2504 foreach ($tablesToTruncate as $table) {
2505 $sql = "TRUNCATE TABLE $table";
2506 CRM_Core_DAO
::executeQuery($sql);
2508 CRM_Core_DAO
::executeQuery("SET FOREIGN_KEY_CHECKS = 1;");
2510 if ($dropCustomValueTables) {
2511 $dbName = self
::getDBName();
2513 SELECT TABLE_NAME as tableName
2514 FROM INFORMATION_SCHEMA.TABLES
2515 WHERE TABLE_SCHEMA = '{$dbName}'
2516 AND ( TABLE_NAME LIKE 'civicrm_value_%' )
2519 $tableDAO = CRM_Core_DAO
::executeQuery($query);
2520 while ($tableDAO->fetch()) {
2521 $sql = "DROP TABLE {$tableDAO->tableName}";
2522 CRM_Core_DAO
::executeQuery($sql);
2528 * Clean up financial entities after financial tests (so we remember to get all the tables :-))
2530 public function quickCleanUpFinancialEntities() {
2531 $tablesToTruncate = array(
2532 'civicrm_contribution',
2533 'civicrm_contribution_soft',
2534 'civicrm_contribution_product',
2535 'civicrm_financial_trxn',
2536 'civicrm_financial_item',
2537 'civicrm_contribution_recur',
2538 'civicrm_line_item',
2539 'civicrm_contribution_page',
2540 'civicrm_payment_processor',
2541 'civicrm_entity_financial_trxn',
2542 'civicrm_membership',
2543 'civicrm_membership_type',
2544 'civicrm_membership_payment',
2545 'civicrm_membership_log',
2546 'civicrm_membership_block',
2548 'civicrm_participant',
2549 'civicrm_participant_payment',
2551 'civicrm_price_set_entity',
2552 'civicrm_price_field_value',
2553 'civicrm_price_field',
2555 $this->quickCleanup($tablesToTruncate);
2556 CRM_Core_DAO
::executeQuery("DELETE FROM civicrm_membership_status WHERE name NOT IN('New', 'Current', 'Grace', 'Expired', 'Pending', 'Cancelled', 'Deceased')");
2557 $this->restoreDefaultPriceSetConfig();
2559 CRM_Member_BAO_Membership
::createRelatedMemberships($var, $var, TRUE);
2560 Civi\Payment\System
::singleton()->flushProcessors();
2563 public function restoreDefaultPriceSetConfig() {
2564 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)");
2565 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)");
2568 * Function does a 'Get' on the entity & compares the fields in the Params with those returned
2569 * Default behaviour is to also delete the entity
2570 * @param array $params
2571 * Params array to check against.
2573 * Id of the entity concerned.
2574 * @param string $entity
2575 * Name of entity concerned (e.g. membership).
2576 * @param bool $delete
2577 * Should the entity be deleted as part of this check.
2578 * @param string $errorText
2579 * Text to print on error.
2582 * @param array $params
2585 * @param int $delete
2586 * @param string $errorText
2590 public function getAndCheck($params, $id, $entity, $delete = 1, $errorText = '') {
2592 $result = $this->callAPISuccessGetSingle($entity, array(
2597 $this->callAPISuccess($entity, 'Delete', array(
2601 $dateFields = $keys = $dateTimeFields = array();
2602 $fields = $this->callAPISuccess($entity, 'getfields', array('version' => 3, 'action' => 'get'));
2603 foreach ($fields['values'] as $field => $settings) {
2604 if (array_key_exists($field, $result)) {
2605 $keys[CRM_Utils_Array
::Value('name', $settings, $field)] = $field;
2608 $keys[CRM_Utils_Array
::Value('name', $settings, $field)] = CRM_Utils_Array
::value('name', $settings, $field);
2610 $type = CRM_Utils_Array
::value('type', $settings);
2611 if ($type == CRM_Utils_Type
::T_DATE
) {
2612 $dateFields[] = $settings['name'];
2613 // we should identify both real names & unique names as dates
2614 if ($field != $settings['name']) {
2615 $dateFields[] = $field;
2618 if ($type == CRM_Utils_Type
::T_DATE + CRM_Utils_Type
::T_TIME
) {
2619 $dateTimeFields[] = $settings['name'];
2620 // we should identify both real names & unique names as dates
2621 if ($field != $settings['name']) {
2622 $dateTimeFields[] = $field;
2627 if (strtolower($entity) == 'contribution') {
2628 $params['receive_date'] = date('Y-m-d', strtotime($params['receive_date']));
2629 // this is not returned in id format
2630 unset($params['payment_instrument_id']);
2631 $params['contribution_source'] = $params['source'];
2632 unset($params['source']);
2635 foreach ($params as $key => $value) {
2636 if ($key == 'version' ||
substr($key, 0, 3) == 'api' ||
!array_key_exists($keys[$key], $result)) {
2639 if (in_array($key, $dateFields)) {
2640 $value = date('Y-m-d', strtotime($value));
2641 $result[$key] = date('Y-m-d', strtotime($result[$key]));
2643 if (in_array($key, $dateTimeFields)) {
2644 $value = date('Y-m-d H:i:s', strtotime($value));
2645 $result[$keys[$key]] = date('Y-m-d H:i:s', strtotime(CRM_Utils_Array
::value($keys[$key], $result, CRM_Utils_Array
::value($key, $result))));
2647 $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);
2652 * Get formatted values in the actual and expected result.
2653 * @param array $actual
2654 * Actual calculated values.
2655 * @param array $expected
2658 public function checkArrayEquals(&$actual, &$expected) {
2659 self
::unsetId($actual);
2660 self
::unsetId($expected);
2661 $this->assertEquals($actual, $expected);
2665 * Unset the key 'id' from the array
2666 * @param array $unformattedArray
2667 * The array from which the 'id' has to be unset.
2669 public static function unsetId(&$unformattedArray) {
2670 $formattedArray = array();
2671 if (array_key_exists('id', $unformattedArray)) {
2672 unset($unformattedArray['id']);
2674 if (!empty($unformattedArray['values']) && is_array($unformattedArray['values'])) {
2675 foreach ($unformattedArray['values'] as $key => $value) {
2676 if (is_array($value)) {
2677 foreach ($value as $k => $v) {
2683 elseif ($key == 'id') {
2684 $unformattedArray[$key];
2686 $formattedArray = array($value);
2688 $unformattedArray['values'] = $formattedArray;
2693 * Helper to enable/disable custom directory support
2695 * @param array $customDirs
2697 * 'php_path' Set to TRUE to use the default, FALSE or "" to disable support, or a string path to use another path
2698 * 'template_path' Set to TRUE to use the default, FALSE or "" to disable support, or a string path to use another path
2700 public function customDirectories($customDirs) {
2701 require_once 'CRM/Core/Config.php';
2702 $config = CRM_Core_Config
::singleton();
2704 if (empty($customDirs['php_path']) ||
$customDirs['php_path'] === FALSE) {
2705 unset($config->customPHPPathDir
);
2707 elseif ($customDirs['php_path'] === TRUE) {
2708 $config->customPHPPathDir
= dirname(dirname(__FILE__
)) . '/custom_directories/php/';
2711 $config->customPHPPathDir
= $php_path;
2714 if (empty($customDirs['template_path']) ||
$customDirs['template_path'] === FALSE) {
2715 unset($config->customTemplateDir
);
2717 elseif ($customDirs['template_path'] === TRUE) {
2718 $config->customTemplateDir
= dirname(dirname(__FILE__
)) . '/custom_directories/templates/';
2721 $config->customTemplateDir
= $template_path;
2726 * Generate a temporary folder.
2728 * @param string $prefix
2731 public function createTempDir($prefix = 'test-') {
2732 $tempDir = CRM_Utils_File
::tempdir($prefix);
2733 $this->tempDirs
[] = $tempDir;
2737 public function cleanTempDirs() {
2738 if (!is_array($this->tempDirs
)) {
2739 // fix test errors where this is not set
2742 foreach ($this->tempDirs
as $tempDir) {
2743 if (is_dir($tempDir)) {
2744 CRM_Utils_File
::cleanDir($tempDir, TRUE, FALSE);
2750 * Temporarily replace the singleton extension with a different one.
2751 * @param \CRM_Extension_System $system
2753 public function setExtensionSystem(CRM_Extension_System
$system) {
2754 if ($this->origExtensionSystem
== NULL) {
2755 $this->origExtensionSystem
= CRM_Extension_System
::singleton();
2757 CRM_Extension_System
::setSingleton($this->origExtensionSystem
);
2760 public function unsetExtensionSystem() {
2761 if ($this->origExtensionSystem
!== NULL) {
2762 CRM_Extension_System
::setSingleton($this->origExtensionSystem
);
2763 $this->origExtensionSystem
= NULL;
2768 * Temporarily alter the settings-metadata to add a mock setting.
2770 * WARNING: The setting metadata will disappear on the next cache-clear.
2775 public function setMockSettingsMetaData($extras) {
2776 CRM_Core_BAO_Setting
::$_cache = array();
2777 $this->callAPISuccess('system', 'flush', array());
2778 CRM_Core_BAO_Setting
::$_cache = array();
2780 CRM_Utils_Hook
::singleton()
2781 ->setHook('civicrm_alterSettingsMetaData', function (&$metadata, $domainId, $profile) use ($extras) {
2782 $metadata = array_merge($metadata, $extras);
2785 $fields = $this->callAPISuccess('setting', 'getfields', array());
2786 foreach ($extras as $key => $spec) {
2787 $this->assertNotEmpty($spec['title']);
2788 $this->assertEquals($spec['title'], $fields['values'][$key]['title']);
2793 * @param string $name
2795 public function financialAccountDelete($name) {
2796 $financialAccount = new CRM_Financial_DAO_FinancialAccount();
2797 $financialAccount->name
= $name;
2798 if ($financialAccount->find(TRUE)) {
2799 $entityFinancialType = new CRM_Financial_DAO_EntityFinancialAccount();
2800 $entityFinancialType->financial_account_id
= $financialAccount->id
;
2801 $entityFinancialType->delete();
2802 $financialAccount->delete();
2807 * FIXME: something NULLs $GLOBALS['_HTML_QuickForm_registered_rules'] when the tests are ran all together
2808 * (NB unclear if this is still required)
2810 public function _sethtmlGlobals() {
2811 $GLOBALS['_HTML_QuickForm_registered_rules'] = array(
2812 'required' => array(
2813 'html_quickform_rule_required',
2814 'HTML/QuickForm/Rule/Required.php',
2816 'maxlength' => array(
2817 'html_quickform_rule_range',
2818 'HTML/QuickForm/Rule/Range.php',
2820 'minlength' => array(
2821 'html_quickform_rule_range',
2822 'HTML/QuickForm/Rule/Range.php',
2824 'rangelength' => array(
2825 'html_quickform_rule_range',
2826 'HTML/QuickForm/Rule/Range.php',
2829 'html_quickform_rule_email',
2830 'HTML/QuickForm/Rule/Email.php',
2833 'html_quickform_rule_regex',
2834 'HTML/QuickForm/Rule/Regex.php',
2836 'lettersonly' => array(
2837 'html_quickform_rule_regex',
2838 'HTML/QuickForm/Rule/Regex.php',
2840 'alphanumeric' => array(
2841 'html_quickform_rule_regex',
2842 'HTML/QuickForm/Rule/Regex.php',
2845 'html_quickform_rule_regex',
2846 'HTML/QuickForm/Rule/Regex.php',
2848 'nopunctuation' => array(
2849 'html_quickform_rule_regex',
2850 'HTML/QuickForm/Rule/Regex.php',
2853 'html_quickform_rule_regex',
2854 'HTML/QuickForm/Rule/Regex.php',
2856 'callback' => array(
2857 'html_quickform_rule_callback',
2858 'HTML/QuickForm/Rule/Callback.php',
2861 'html_quickform_rule_compare',
2862 'HTML/QuickForm/Rule/Compare.php',
2865 // FIXME: …ditto for $GLOBALS['HTML_QUICKFORM_ELEMENT_TYPES']
2866 $GLOBALS['HTML_QUICKFORM_ELEMENT_TYPES'] = array(
2868 'HTML/QuickForm/group.php',
2869 'HTML_QuickForm_group',
2872 'HTML/QuickForm/hidden.php',
2873 'HTML_QuickForm_hidden',
2876 'HTML/QuickForm/reset.php',
2877 'HTML_QuickForm_reset',
2879 'checkbox' => array(
2880 'HTML/QuickForm/checkbox.php',
2881 'HTML_QuickForm_checkbox',
2884 'HTML/QuickForm/file.php',
2885 'HTML_QuickForm_file',
2888 'HTML/QuickForm/image.php',
2889 'HTML_QuickForm_image',
2891 'password' => array(
2892 'HTML/QuickForm/password.php',
2893 'HTML_QuickForm_password',
2896 'HTML/QuickForm/radio.php',
2897 'HTML_QuickForm_radio',
2900 'HTML/QuickForm/button.php',
2901 'HTML_QuickForm_button',
2904 'HTML/QuickForm/submit.php',
2905 'HTML_QuickForm_submit',
2908 'HTML/QuickForm/select.php',
2909 'HTML_QuickForm_select',
2911 'hiddenselect' => array(
2912 'HTML/QuickForm/hiddenselect.php',
2913 'HTML_QuickForm_hiddenselect',
2916 'HTML/QuickForm/text.php',
2917 'HTML_QuickForm_text',
2919 'textarea' => array(
2920 'HTML/QuickForm/textarea.php',
2921 'HTML_QuickForm_textarea',
2923 'fckeditor' => array(
2924 'HTML/QuickForm/fckeditor.php',
2925 'HTML_QuickForm_FCKEditor',
2928 'HTML/QuickForm/tinymce.php',
2929 'HTML_QuickForm_TinyMCE',
2931 'dojoeditor' => array(
2932 'HTML/QuickForm/dojoeditor.php',
2933 'HTML_QuickForm_dojoeditor',
2936 'HTML/QuickForm/link.php',
2937 'HTML_QuickForm_link',
2939 'advcheckbox' => array(
2940 'HTML/QuickForm/advcheckbox.php',
2941 'HTML_QuickForm_advcheckbox',
2944 'HTML/QuickForm/date.php',
2945 'HTML_QuickForm_date',
2948 'HTML/QuickForm/static.php',
2949 'HTML_QuickForm_static',
2952 'HTML/QuickForm/header.php',
2953 'HTML_QuickForm_header',
2956 'HTML/QuickForm/html.php',
2957 'HTML_QuickForm_html',
2959 'hierselect' => array(
2960 'HTML/QuickForm/hierselect.php',
2961 'HTML_QuickForm_hierselect',
2963 'autocomplete' => array(
2964 'HTML/QuickForm/autocomplete.php',
2965 'HTML_QuickForm_autocomplete',
2968 'HTML/QuickForm/xbutton.php',
2969 'HTML_QuickForm_xbutton',
2971 'advmultiselect' => array(
2972 'HTML/QuickForm/advmultiselect.php',
2973 'HTML_QuickForm_advmultiselect',
2979 * Set up an acl allowing contact to see 2 specified groups
2980 * - $this->_permissionedGroup & $this->_permissionedDisabledGroup
2982 * You need to have pre-created these groups & created the user e.g
2983 * $this->createLoggedInUser();
2984 * $this->_permissionedDisabledGroup = $this->groupCreate(array('title' => 'pick-me-disabled', 'is_active' => 0, 'name' => 'pick-me-disabled'));
2985 * $this->_permissionedGroup = $this->groupCreate(array('title' => 'pick-me-active', 'is_active' => 1, 'name' => 'pick-me-active'));
2987 public function setupACL() {
2989 $_REQUEST = $this->_params
;
2991 CRM_Core_Config
::singleton()->userPermissionClass
->permissions
= array('access CiviCRM');
2992 $optionGroupID = $this->callAPISuccessGetValue('option_group', array('return' => 'id', 'name' => 'acl_role'));
2993 $optionValue = $this->callAPISuccess('option_value', 'create', array(
2994 'option_group_id' => $optionGroupID,
2995 'label' => 'pick me',
2999 CRM_Core_DAO
::executeQuery("
3000 TRUNCATE civicrm_acl_cache
3003 CRM_Core_DAO
::executeQuery("
3004 TRUNCATE civicrm_acl_contact_cache
3007 CRM_Core_DAO
::executeQuery("
3008 INSERT INTO civicrm_acl_entity_role (
3009 `acl_role_id`, `entity_table`, `entity_id`
3010 ) VALUES (55, 'civicrm_group', {$this->_permissionedGroup});
3013 CRM_Core_DAO
::executeQuery("
3014 INSERT INTO civicrm_acl (
3015 `name`, `entity_table`, `entity_id`, `operation`, `object_table`, `object_id`, `is_active`
3018 'view picked', 'civicrm_group', $this->_permissionedGroup , 'Edit', 'civicrm_saved_search', {$this->_permissionedGroup}, 1
3022 CRM_Core_DAO
::executeQuery("
3023 INSERT INTO civicrm_acl (
3024 `name`, `entity_table`, `entity_id`, `operation`, `object_table`, `object_id`, `is_active`
3027 'view picked', 'civicrm_group', $this->_permissionedGroup, 'Edit', 'civicrm_saved_search', {$this->_permissionedDisabledGroup}, 1
3030 $this->_loggedInUser
= CRM_Core_Session
::singleton()->get('userID');
3031 $this->callAPISuccess('group_contact', 'create', array(
3032 'group_id' => $this->_permissionedGroup
,
3033 'contact_id' => $this->_loggedInUser
,
3036 CRM_ACL_BAO_Cache
::resetCache();
3037 CRM_Contact_BAO_Group
::getPermissionClause(TRUE);
3038 CRM_ACL_API
::groupPermission('whatever', 9999, NULL, 'civicrm_saved_search', NULL, NULL, TRUE);
3042 * Alter default price set so that the field numbers are not all 1 (hiding errors)
3044 public function offsetDefaultPriceSet() {
3045 $contributionPriceSet = $this->callAPISuccess('price_set', 'getsingle', array('name' => 'default_contribution_amount'));
3046 $firstID = $contributionPriceSet['id'];
3047 $this->callAPISuccess('price_set', 'create', array(
3048 'id' => $contributionPriceSet['id'],
3052 unset($contributionPriceSet['id']);
3053 $newPriceSet = $this->callAPISuccess('price_set', 'create', $contributionPriceSet);
3054 $priceField = $this->callAPISuccess('price_field', 'getsingle', array(
3055 'price_set_id' => $firstID,
3056 'options' => array('limit' => 1),
3058 unset($priceField['id']);
3059 $priceField['price_set_id'] = $newPriceSet['id'];
3060 $newPriceField = $this->callAPISuccess('price_field', 'create', $priceField);
3061 $priceFieldValue = $this->callAPISuccess('price_field_value', 'getsingle', array(
3062 'price_set_id' => $firstID,
3064 'options' => array('limit' => 1),
3067 unset($priceFieldValue['id']);
3068 //create some padding to use up ids
3069 $this->callAPISuccess('price_field_value', 'create', $priceFieldValue);
3070 $this->callAPISuccess('price_field_value', 'create', $priceFieldValue);
3071 $this->callAPISuccess('price_field_value', 'create', array_merge($priceFieldValue, array('price_field_id' => $newPriceField['id'])));
3075 * Create an instance of the paypal processor.
3076 * @todo this isn't a great place to put it - but really it belongs on a class that extends
3077 * this parent class & we don't have a structure for that yet
3078 * There is another function to this effect on the PaypalPro test but it appears to be silently failing
3079 * & the best protection against that is the functions this class affords
3080 * @param array $params
3081 * @return int $result['id'] payment processor id
3083 public function paymentProcessorCreate($params = array()) {
3084 $params = array_merge(array(
3086 'domain_id' => CRM_Core_Config
::domainID(),
3087 'payment_processor_type_id' => 'PayPal',
3091 'user_name' => 'sunil._1183377782_biz_api1.webaccess.co.in',
3092 'password' => '1183377788',
3093 'signature' => 'APixCoQ-Zsaj-u3IH7mD5Do-7HUqA9loGnLSzsZga9Zr-aNmaJa3WGPH',
3094 'url_site' => 'https://www.sandbox.paypal.com/',
3095 'url_api' => 'https://api-3t.sandbox.paypal.com/',
3096 'url_button' => 'https://www.paypal.com/en_US/i/btn/btn_xpressCheckout.gif',
3097 'class_name' => 'Payment_PayPalImpl',
3098 'billing_mode' => 3,
3099 'financial_type_id' => 1,
3102 if (!is_numeric($params['payment_processor_type_id'])) {
3103 // really the api should handle this through getoptions but it's not exactly api call so lets just sort it
3105 $params['payment_processor_type_id'] = $this->callAPISuccess('payment_processor_type', 'getvalue', array(
3106 'name' => $params['payment_processor_type_id'],
3110 $result = $this->callAPISuccess('payment_processor', 'create', $params);
3111 return $result['id'];
3115 * Set up initial recurring payment allowing subsequent IPN payments.
3117 public function setupRecurringPaymentProcessorTransaction() {
3118 $contributionRecur = $this->callAPISuccess('contribution_recur', 'create', array(
3119 'contact_id' => $this->_contactID
,
3122 'installments' => 5,
3123 'frequency_unit' => 'Month',
3124 'frequency_interval' => 1,
3125 'invoice_id' => $this->_invoiceID
,
3126 'contribution_status_id' => 2,
3127 'processor_id' => $this->_paymentProcessorID
,
3128 'api.contribution.create' => array(
3129 'total_amount' => '200',
3130 'invoice_id' => $this->_invoiceID
,
3131 'financial_type_id' => 1,
3132 'contribution_status_id' => 'Pending',
3133 'contact_id' => $this->_contactID
,
3134 'contribution_page_id' => $this->_contributionPageID
,
3135 'payment_processor_id' => $this->_paymentProcessorID
,
3138 $this->_contributionRecurID
= $contributionRecur['id'];
3139 $this->_contributionID
= $contributionRecur['values']['0']['api.contribution.create']['id'];
3143 * 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
3145 public function setupMembershipRecurringPaymentProcessorTransaction() {
3146 $this->ids
['membership_type'] = $this->membershipTypeCreate();
3147 //create a contribution so our membership & contribution don't both have id = 1
3148 $this->contributionCreate($this->_contactID
, 1, 'abcd', '345j');
3149 $this->setupRecurringPaymentProcessorTransaction();
3151 $this->ids
['membership'] = $this->callAPISuccess('membership', 'create', array(
3152 'contact_id' => $this->_contactID
,
3153 'membership_type_id' => $this->ids
['membership_type'],
3154 'contribution_recur_id' => $this->_contributionRecurID
,
3155 'format.only_id' => TRUE,
3157 //CRM-15055 creates line items we don't want so get rid of them so we can set up our own line items
3158 CRM_Core_DAO
::executeQuery("TRUNCATE civicrm_line_item");
3160 $this->callAPISuccess('line_item', 'create', array(
3161 'entity_table' => 'civicrm_membership',
3162 'entity_id' => $this->ids
['membership'],
3163 'contribution_id' => $this->_contributionID
,
3164 'label' => 'General',
3166 'unit_price' => 200,
3167 'line_total' => 200,
3168 'financial_type_id' => 1,
3169 'price_field_id' => $this->callAPISuccess('price_field', 'getvalue', array(
3171 'label' => 'Membership Amount',
3173 'price_field_value_id' => $this->callAPISuccess('price_field_value', 'getvalue', array(
3175 'label' => 'General',
3178 $this->callAPISuccess('membership_payment', 'create', array(
3179 'contribution_id' => $this->_contributionID
,
3180 'membership_id' => $this->ids
['membership'],
3189 public function CiviUnitTestCase_fatalErrorHandler($message) {
3190 throw new Exception("{$message['message']}: {$message['code']}");
3194 * Helper function to create new mailing.
3197 public function createMailing() {
3199 'subject' => 'maild' . rand(),
3200 'body_text' => 'bdkfhdskfhduew{domain.address}{action.optOutUrl}',
3201 'name' => 'mailing name' . rand(),
3205 $result = $this->callAPISuccess('Mailing', 'create', $params);
3206 return $result['id'];
3210 * Helper function to delete mailing.
3213 public function deleteMailing($id) {
3218 $this->callAPISuccess('Mailing', 'delete', $params);
3222 * Wrap the entire test case in a transaction.
3224 * Only subsequent DB statements will be wrapped in TX -- this cannot
3225 * retroactively wrap old DB statements. Therefore, it makes sense to
3226 * call this at the beginning of setUp().
3228 * Note: Recall that TRUNCATE and ALTER will force-commit transactions, so
3229 * this option does not work with, e.g., custom-data.
3231 * WISHLIST: Monitor SQL queries in unit-tests and generate an exception
3232 * if TRUNCATE or ALTER is called while using a transaction.
3235 * Whether to use nesting or reference-counting.
3237 public function useTransaction($nest = TRUE) {
3239 $this->tx
= new CRM_Core_Transaction($nest);
3240 $this->tx
->rollback();
3244 public function clearOutputBuffer() {
3245 while (ob_get_level() > 0) {
3252 * @param array $apiResult
3254 protected function assertAttachmentExistence($exists, $apiResult) {
3255 $fileId = $apiResult['id'];
3256 $this->assertTrue(is_numeric($fileId));
3257 $this->assertEquals($exists, file_exists($apiResult['values'][$fileId]['path']));
3258 $this->assertDBQuery($exists ?
1 : 0, 'SELECT count(*) FROM civicrm_file WHERE id = %1', array(
3259 1 => array($fileId, 'Int'),
3261 $this->assertDBQuery($exists ?
1 : 0, 'SELECT count(*) FROM civicrm_entity_file WHERE id = %1', array(
3262 1 => array($fileId, 'Int'),