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/>.
30 * Include configuration
32 define('CIVICRM_SETTINGS_PATH', __DIR__
. '/civicrm.settings.dist.php');
33 define('CIVICRM_SETTINGS_LOCAL_PATH', __DIR__
. '/civicrm.settings.local.php');
35 if (file_exists(CIVICRM_SETTINGS_LOCAL_PATH
)) {
36 require_once CIVICRM_SETTINGS_LOCAL_PATH
;
38 require_once CIVICRM_SETTINGS_PATH
;
40 * Include class definitions
42 require_once 'PHPUnit/Extensions/Database/TestCase.php';
43 require_once 'PHPUnit/Framework/TestResult.php';
44 require_once 'PHPUnit/Extensions/Database/DataSet/FlatXmlDataSet.php';
45 require_once 'PHPUnit/Extensions/Database/DataSet/XmlDataSet.php';
46 require_once 'PHPUnit/Extensions/Database/DataSet/QueryDataSet.php';
47 require_once 'tests/phpunit/Utils.php';
48 require_once 'api/api.php';
49 require_once 'CRM/Financial/BAO/FinancialType.php';
50 define('API_LATEST_VERSION', 3);
53 * Base class for CiviCRM unit tests
55 * Common functions for unit tests
58 class CiviUnitTestCase
extends PHPUnit_Extensions_Database_TestCase
{
61 * api version - easier to override than just a defin
63 protected $_apiversion = API_LATEST_VERSION
;
65 * Database has been initialized
69 private static $dbInit = FALSE;
74 * @var PHPUnit_Extensions_Database_DB_IDatabaseConnection
83 static protected $_dbName;
86 * Track tables we have modified during a test
88 protected $_tablesToTruncate = array();
91 * @var array of temporary directory names
101 * @var boolean populateOnce allows to skip db resets in setUp
103 * WARNING! USE WITH CAUTION - IT'LL RENDER DATA DEPENDENCIES
104 * BETWEEN TESTS WHEN RUN IN SUITE. SUITABLE FOR LOCAL, LIMITED
107 * IF POSSIBLE, USE $this->DBResetRequired = FALSE IN YOUR TEST CASE!
109 * see also: http://forum.civicrm.org/index.php/topic,18065.0.html
111 public static $populateOnce = FALSE;
114 * Allow classes to state E-notice compliance
116 public $_eNoticeCompliant = TRUE;
119 * @var boolean DBResetRequired allows skipping DB reset
120 * in specific test case. If you still need
121 * to reset single test (method) of such case, call
122 * $this->cleanDB() in the first line of this
125 public $DBResetRequired = TRUE;
130 * Because we are overriding the parent class constructor, we
131 * need to show the same arguments as exist in the constructor of
132 * PHPUnit_Framework_TestCase, since
133 * PHPUnit_Framework_TestSuite::createTest() creates a
134 * ReflectionClass of the Test class and checks the constructor
135 * of that class to decide how to set up the test.
137 * @param string $name
139 * @param string $dataName
141 function __construct($name = NULL, array$data = array(), $dataName = '') {
142 parent
::__construct($name, $data, $dataName);
144 // we need full error reporting
145 error_reporting(E_ALL
& ~E_NOTICE
);
147 if (!empty($GLOBALS['mysql_db'])) {
148 self
::$_dbName = $GLOBALS['mysql_db'];
151 self
::$_dbName = 'civicrm_tests_dev';
154 // create test database
155 self
::$utils = new Utils($GLOBALS['mysql_host'],
156 $GLOBALS['mysql_port'],
157 $GLOBALS['mysql_user'],
158 $GLOBALS['mysql_pass']
161 // also load the class loader
162 require_once 'CRM/Core/ClassLoader.php';
163 CRM_Core_ClassLoader
::singleton()->register();
164 if (function_exists('_civix_phpunit_setUp')) { // FIXME: loosen coupling
165 _civix_phpunit_setUp();
172 function requireDBReset() {
173 return $this->DBResetRequired
;
179 static function getDBName() {
180 $dbName = !empty($GLOBALS['mysql_db']) ?
$GLOBALS['mysql_db'] : 'civicrm_tests_dev';
185 * Create database connection for this instance
187 * Initialize the test database if it hasn't been initialized
189 * @return PHPUnit_Extensions_Database_DB_IDatabaseConnection connection
191 protected function getConnection() {
192 $dbName = self
::$_dbName;
193 if (!self
::$dbInit) {
194 $dbName = self
::getDBName();
196 // install test database
197 echo PHP_EOL
. "Installing {$dbName} database" . PHP_EOL
;
199 static::_populateDB(FALSE, $this);
201 self
::$dbInit = TRUE;
203 return $this->createDefaultDBConnection(self
::$utils->pdo
, $dbName);
207 * Required implementation of abstract method
209 protected function getDataSet() {
213 * @param bool $perClass
214 * @param null $object
215 * @return bool TRUE if the populate logic runs; FALSE if it is skipped
217 protected static function _populateDB($perClass = FALSE, &$object = NULL) {
219 if ($perClass ||
$object == NULL) {
223 $dbreset = $object->requireDBReset();
226 if (self
::$populateOnce ||
!$dbreset) {
229 self
::$populateOnce = NULL;
231 $dbName = self
::getDBName();
232 $pdo = self
::$utils->pdo
;
233 // only consider real tables and not views
234 $tables = $pdo->query("SELECT table_name FROM INFORMATION_SCHEMA.TABLES
235 WHERE TABLE_SCHEMA = '{$dbName}' AND TABLE_TYPE = 'BASE TABLE'");
237 $truncates = array();
239 foreach ($tables as $table) {
241 if (substr($table['table_name'], 0, 4) == 'log_') {
245 // don't change list of installed extensions
246 if ($table['table_name'] == 'civicrm_extension') {
250 if (substr($table['table_name'], 0, 14) == 'civicrm_value_') {
251 $drops[] = 'DROP TABLE ' . $table['table_name'] . ';';
254 $truncates[] = 'TRUNCATE ' . $table['table_name'] . ';';
260 "SET foreign_key_checks = 0",
261 // SQL mode needs to be strict, that's our standard
262 "SET SQL_MODE='STRICT_ALL_TABLES';",
263 "SET global innodb_flush_log_at_trx_commit = 2;",
265 $queries = array_merge($queries, $truncates);
266 $queries = array_merge($queries, $drops);
267 foreach ($queries as $query) {
268 if (self
::$utils->do_query($query) === FALSE) {
269 // failed to create test database
270 echo "failed to create test db.";
275 // initialize test database
276 $sql_file2 = dirname(dirname(dirname(dirname(__FILE__
)))) . "/sql/civicrm_data.mysql";
277 $sql_file3 = dirname(dirname(dirname(dirname(__FILE__
)))) . "/sql/test_data.mysql";
278 $sql_file4 = dirname(dirname(dirname(dirname(__FILE__
)))) . "/sql/test_data_second_domain.mysql";
280 $query2 = file_get_contents($sql_file2);
281 $query3 = file_get_contents($sql_file3);
282 $query4 = file_get_contents($sql_file4);
283 if (self
::$utils->do_query($query2) === FALSE) {
284 echo "Cannot load civicrm_data.mysql. Aborting.";
287 if (self
::$utils->do_query($query3) === FALSE) {
288 echo "Cannot load test_data.mysql. Aborting.";
291 if (self
::$utils->do_query($query4) === FALSE) {
292 echo "Cannot load test_data.mysql. Aborting.";
296 // done with all the loading, get transactions back
297 if (self
::$utils->do_query("set global innodb_flush_log_at_trx_commit = 1;") === FALSE) {
298 echo "Cannot set global? Huh?";
302 if (self
::$utils->do_query("SET foreign_key_checks = 1") === FALSE) {
303 echo "Cannot get foreign keys back? Huh?";
307 unset($query, $query2, $query3);
310 civicrm_api('system', 'flush', array('version' => 3, 'triggers' => 1));
315 public static function setUpBeforeClass() {
316 static::_populateDB(TRUE);
318 // also set this global hack
319 $GLOBALS['_PEAR_ERRORSTACK_OVERRIDE_CALLBACK'] = array();
321 $env = new CRM_Utils_Check_Env();
322 CRM_Utils_Check
::singleton()->assertValid($env->checkMysqlTime());
326 * Common setup functions for all unit tests
328 protected function setUp() {
329 CRM_Utils_Hook
::singleton(TRUE);
330 $this->errorScope
= CRM_Core_TemporaryErrorScope
::useException(); // REVERT
331 // Use a temporary file for STDIN
332 $GLOBALS['stdin'] = tmpfile();
333 if ($GLOBALS['stdin'] === FALSE) {
334 echo "Couldn't open temporary file\n";
338 // Get and save a connection to the database
339 $this->_dbconn
= $this->getConnection();
341 // reload database before each test
342 // $this->_populateDB();
344 // "initialize" CiviCRM to avoid problems when running single tests
345 // FIXME: look at it closer in second stage
347 // initialize the object once db is loaded
348 CRM_Core_Config
::$_mail = NULL;
349 $config = CRM_Core_Config
::singleton();
351 // when running unit tests, use mockup user framework
352 $config->setUserFramework('UnitTests');
354 // also fix the fatal error handler to throw exceptions,
356 $config->fatalErrorHandler
= 'CiviUnitTestCase_fatalErrorHandler';
358 // enable backtrace to get meaningful errors
359 $config->backtrace
= 1;
361 // disable any left-over test extensions
362 CRM_Core_DAO
::executeQuery('DELETE FROM civicrm_extension WHERE full_name LIKE "test.%"');
364 // reset all the caches
365 CRM_Utils_System
::flushCache();
367 // clear permissions stub to not check permissions
368 $config = CRM_Core_Config
::singleton();
369 $config->userPermissionClass
->permissions
= NULL;
371 //flush component settings
372 CRM_Core_Component
::getEnabledComponents(TRUE);
374 if ($this->_eNoticeCompliant
) {
375 error_reporting(E_ALL
);
378 error_reporting(E_ALL
& ~E_NOTICE
);
383 * Read everything from the datasets directory and insert into the db
385 public function loadAllFixtures() {
386 $fixturesDir = __DIR__
. '/../../fixtures';
388 $this->getConnection()->getConnection()->query("SET FOREIGN_KEY_CHECKS = 0;");
390 $xmlFiles = glob($fixturesDir . '/*.xml');
391 foreach ($xmlFiles as $xmlFixture) {
392 $op = new PHPUnit_Extensions_Database_Operation_Insert();
393 $dataset = new PHPUnit_Extensions_Database_DataSet_XMLDataSet($xmlFixture);
394 $this->_tablesToTruncate
= array_merge($this->_tablesToTruncate
, $dataset->getTableNames());
395 $op->execute($this->_dbconn
, $dataset);
398 $yamlFiles = glob($fixturesDir . '/*.yaml');
399 foreach ($yamlFiles as $yamlFixture) {
400 $op = new PHPUnit_Extensions_Database_Operation_Insert();
401 $dataset = new PHPUnit_Extensions_Database_DataSet_YamlDataSet($yamlFixture);
402 $this->_tablesToTruncate
= array_merge($this->_tablesToTruncate
, $dataset->getTableNames());
403 $op->execute($this->_dbconn
, $dataset);
406 $this->getConnection()->getConnection()->query("SET FOREIGN_KEY_CHECKS = 1;");
410 * emulate a logged in user since certain functions use that
411 * value to store a record in the DB (like activity)
414 public function createLoggedInUser() {
416 'first_name' => 'Logged In',
417 'last_name' => 'User ' . rand(),
418 'contact_type' => 'Individual',
420 $contactID = $this->individualCreate($params);
422 $session = CRM_Core_Session
::singleton();
423 $session->set('userID', $contactID);
426 public function cleanDB() {
427 self
::$populateOnce = NULL;
428 $this->DBResetRequired
= TRUE;
430 $this->_dbconn
= $this->getConnection();
431 static::_populateDB();
432 $this->tempDirs
= array();
436 * Common teardown functions for all unit tests
438 protected function tearDown() {
439 error_reporting(E_ALL
& ~E_NOTICE
);
440 $tablesToTruncate = array('civicrm_contact');
441 $this->quickCleanup($tablesToTruncate);
442 $this->cleanTempDirs();
443 $this->unsetExtensionSystem();
447 * FIXME: Maybe a better way to do it
449 function foreignKeyChecksOff() {
450 self
::$utils = new Utils($GLOBALS['mysql_host'],
451 $GLOBALS['mysql_port'],
452 $GLOBALS['mysql_user'],
453 $GLOBALS['mysql_pass']
455 $dbName = self
::getDBName();
456 $query = "USE {$dbName};" . "SET foreign_key_checks = 1";
457 if (self
::$utils->do_query($query) === FALSE) {
459 echo 'Cannot set foreign_key_checks = 0';
465 function foreignKeyChecksOn() {
466 // FIXME: might not be needed if previous fixme implemented
470 * Generic function to compare expected values after an api call to retrieved
473 * @daoName string DAO Name of object we're evaluating.
474 * @id int Id of object
475 * @match array Associative array of field name => expected value. Empty if asserting
476 * that a DELETE occurred
477 * @delete boolean True if we're checking that a DELETE action occurred.
479 function assertDBState($daoName, $id, $match, $delete = FALSE) {
481 // adding this here since developers forget to check for an id
482 // and hence we get the first value in the db
483 $this->fail('ID not populated. Please fix your assertDBState usage!!!');
486 $object = new $daoName();
490 // If we're asserting successful record deletion, make sure object is NOT found.
492 if ($object->find(TRUE)) {
493 $this->fail("Object not deleted by delete operation: $daoName, $id");
498 // Otherwise check matches of DAO field values against expected values in $match.
499 if ($object->find(TRUE)) {
500 $fields = & $object->fields();
501 foreach ($fields as $name => $value) {
502 $dbName = $value['name'];
503 if (isset($match[$name])) {
505 $this->assertEquals($object->$dbName, $match[$name]);
507 elseif (isset($match[$dbName])) {
509 $this->assertEquals($object->$dbName, $match[$dbName]);
514 $this->fail("Could not retrieve object: $daoName, $id");
517 $matchSize = count($match);
518 if ($verifiedCount != $matchSize) {
519 $this->fail("Did not verify all fields in match array: $daoName, $id. Verified count = $verifiedCount. Match array size = $matchSize");
523 // Request a record from the DB by seachColumn+searchValue. Success if a record is found.
526 * @param $searchValue
527 * @param $returnColumn
528 * @param $searchColumn
531 * @return null|string
532 * @throws PHPUnit_Framework_AssertionFailedError
534 function assertDBNotNull($daoName, $searchValue, $returnColumn, $searchColumn, $message) {
535 if (empty($searchValue)) {
536 $this->fail("empty value passed to assertDBNotNull");
538 $value = CRM_Core_DAO
::getFieldValue($daoName, $searchValue, $returnColumn, $searchColumn, TRUE);
539 $this->assertNotNull($value, $message);
544 // Request a record from the DB by seachColumn+searchValue. Success if returnColumn value is NULL.
547 * @param $searchValue
548 * @param $returnColumn
549 * @param $searchColumn
552 function assertDBNull($daoName, $searchValue, $returnColumn, $searchColumn, $message) {
553 $value = CRM_Core_DAO
::getFieldValue($daoName, $searchValue, $returnColumn, $searchColumn, TRUE);
554 $this->assertNull($value, $message);
557 // Request a record from the DB by id. Success if row not found.
561 * @param null $message
563 function assertDBRowNotExist($daoName, $id, $message = NULL) {
564 $message = $message ?
$message : "$daoName (#$id) should not exist";
565 $value = CRM_Core_DAO
::getFieldValue($daoName, $id, 'id', 'id', TRUE);
566 $this->assertNull($value, $message);
569 // Request a record from the DB by id. Success if row not found.
573 * @param null $message
575 function assertDBRowExist($daoName, $id, $message = NULL) {
576 $message = $message ?
$message : "$daoName (#$id) should exist";
577 $value = CRM_Core_DAO
::getFieldValue($daoName, $id, 'id', 'id', TRUE);
578 $this->assertEquals($id, $value, $message);
581 // Compare a single column value in a retrieved DB record to an expected value
584 * @param $searchValue
585 * @param $returnColumn
586 * @param $searchColumn
587 * @param $expectedValue
590 function assertDBCompareValue($daoName, $searchValue, $returnColumn, $searchColumn,
591 $expectedValue, $message
593 $value = CRM_Core_DAO
::getFieldValue($daoName, $searchValue, $returnColumn, $searchColumn, TRUE);
594 $this->assertEquals($value, $expectedValue, $message);
597 // Compare all values in a single retrieved DB record to an array of expected values
600 * @param $searchParams
601 * @param $expectedValues
603 function assertDBCompareValues($daoName, $searchParams, $expectedValues) {
604 //get the values from db
606 CRM_Core_DAO
::commonRetrieve($daoName, $searchParams, $dbValues);
608 // compare db values with expected values
609 self
::assertAttributesEquals($expectedValues, $dbValues);
613 * Assert that a SQL query returns a given value
615 * The first argument is an expected value. The remaining arguments are passed
616 * to CRM_Core_DAO::singleValueQuery
618 * Example: $this->assertSql(2, 'select count(*) from foo where foo.bar like "%1"',
619 * array(1 => array("Whiz", "String")));
621 function assertDBQuery($expected, $query, $params = array()) {
622 $actual = CRM_Core_DAO
::singleValueQuery($query, $params);
623 $this->assertEquals($expected, $actual,
624 sprintf('expected=[%s] actual=[%s] query=[%s]',
625 $expected, $actual, CRM_Core_DAO
::composeQuery($query, $params, FALSE)
631 * Assert that two array-trees are exactly equal, notwithstanding
632 * the sorting of keys
634 * @param array $expected
635 * @param array $actual
637 function assertTreeEquals($expected, $actual) {
640 CRM_Utils_Array
::flatten($expected, $e, '', ':::');
641 CRM_Utils_Array
::flatten($actual, $a, '', ':::');
645 $this->assertEquals($e, $a);
649 * Assert that two numbers are approximately equal
651 * @param int|float $expected
652 * @param int|float $actual
653 * @param int|float $tolerance
654 * @param string $message
656 function assertApproxEquals($expected, $actual, $tolerance, $message = NULL) {
657 if ($message === NULL) {
658 $message = sprintf("approx-equals: expected=[%.3f] actual=[%.3f] tolerance=[%.3f]", $expected, $actual, $tolerance);
660 $this->assertTrue(abs($actual - $expected) < $tolerance, $message);
664 * @param $expectedValues
665 * @param $actualValues
666 * @param null $message
668 * @throws PHPUnit_Framework_AssertionFailedError
670 function assertAttributesEquals($expectedValues, $actualValues, $message = NULL) {
671 foreach ($expectedValues as $paramName => $paramValue) {
672 if (isset($actualValues[$paramName])) {
673 $this->assertEquals($paramValue, $actualValues[$paramName], "Value Mismatch On $paramName - value 1 is " . print_r($paramValue, TRUE) . " value 2 is " . print_r($actualValues[$paramName], TRUE) );
676 $this->fail("Attribute '$paramName' not present in actual array.");
685 function assertArrayKeyExists($key, &$list) {
686 $result = isset($list[$key]) ?
TRUE : FALSE;
687 $this->assertTrue($result, ts("%1 element exists?",
696 function assertArrayValueNotNull($key, &$list) {
697 $this->assertArrayKeyExists($key, $list);
699 $value = isset($list[$key]) ?
$list[$key] : NULL;
700 $this->assertTrue($value,
701 ts("%1 element not null?",
708 * check that api returned 'is_error' => 0
709 * else provide full message
710 * @param array $apiResult api result
711 * @param string $prefix extra test to add to message
713 function assertAPISuccess($apiResult, $prefix = '') {
714 if (!empty($prefix)) {
717 $errorMessage = empty($apiResult['error_message']) ?
'' : " " . $apiResult['error_message'];
719 if(!empty($apiResult['debug_information'])) {
720 $errorMessage .= "\n " . print_r($apiResult['debug_information'], TRUE);
722 if(!empty($apiResult['trace'])){
723 $errorMessage .= "\n" . print_r($apiResult['trace'], TRUE);
725 $this->assertEquals(0, $apiResult['is_error'], $prefix . $errorMessage);
729 * check that api returned 'is_error' => 1
730 * else provide full message
732 * @param array $apiResult api result
733 * @param string $prefix extra test to add to message
734 * @param null $expectedError
736 function assertAPIFailure($apiResult, $prefix = '', $expectedError = NULL) {
737 if (!empty($prefix)) {
740 if($expectedError && !empty($apiResult['is_error'])){
741 $this->assertEquals($expectedError, $apiResult['error_message'], 'api error message not as expected' . $prefix );
743 $this->assertEquals(1, $apiResult['is_error'], "api call should have failed but it succeeded " . $prefix . (print_r($apiResult, TRUE)));
744 $this->assertNotEmpty($apiResult['error_message']);
750 * @param string $message
752 function assertType($expected, $actual, $message = '') {
753 return $this->assertInternalType($expected, $actual, $message);
757 * check that a deleted item has been deleted
759 function assertAPIDeleted($entity, $id) {
760 $this->callAPISuccess($entity, 'getcount', array('id' => $id), 0);
765 * check that api returned 'is_error' => 1
766 * else provide full message
769 * @param array $valuesToExclude
770 * @param string $prefix extra test to add to message
771 * @internal param array $apiResult api result
773 function assertAPIArrayComparison($result, $expected, $valuesToExclude = array(), $prefix = '') {
774 $valuesToExclude = array_merge($valuesToExclude, array('debug', 'xdebug', 'sequential'));
775 foreach ($valuesToExclude as $value) {
776 if(isset($result[$value])) {
777 unset($result[$value]);
779 if(isset($expected[$value])) {
780 unset($expected[$value]);
783 $this->assertEquals($result, $expected, "api result array comparison failed " . $prefix . print_r($result, TRUE) . ' was compared to ' . print_r($expected, TRUE));
787 * A stub for the API interface. This can be overriden by subclasses to change how the API is called.
794 function civicrm_api($entity, $action, $params) {
795 return civicrm_api($entity, $action, $params);
799 * This function exists to wrap api functions
800 * so we can ensure they succeed & throw exceptions without litterering the test with checks
802 * @param string $entity
803 * @param string $action
804 * @param array $params
805 * @param mixed $checkAgainst optional value to check result against, implemented for getvalue,
806 * getcount, getsingle. Note that for getvalue the type is checked rather than the value
807 * for getsingle the array is compared against an array passed in - the id is not compared (for
812 function callAPISuccess($entity, $action, $params, $checkAgainst = NULL) {
813 $params = array_merge(array(
814 'version' => $this->_apiversion
,
819 switch (strtolower($action)) {
821 return $this->callAPISuccessGetValue($entity, $params, $checkAgainst);
823 return $this->callAPISuccessGetSingle($entity, $params, $checkAgainst);
825 return $this->callAPISuccessGetCount($entity, $params, $checkAgainst);
827 $result = $this->civicrm_api($entity, $action, $params);
828 $this->assertAPISuccess($result, "Failure in api call for $entity $action");
833 * This function exists to wrap api getValue function & check the result
834 * so we can ensure they succeed & throw exceptions without litterering the test with checks
835 * There is a type check in this
837 * @param string $entity
838 * @param array $params
839 * @param string $type - per http://php.net/manual/en/function.gettype.php possible types
849 function callAPISuccessGetValue($entity, $params, $type = NULL) {
851 'version' => $this->_apiversion
,
854 $result = $this->civicrm_api($entity, 'getvalue', $params);
856 if($type == 'integer'){
857 // api seems to return integers as strings
858 $this->assertTrue(is_numeric($result), "expected a numeric value but got " . print_r($result, 1));
861 $this->assertType($type, $result, "returned result should have been of type $type but was " );
868 * This function exists to wrap api getsingle function & check the result
869 * so we can ensure they succeed & throw exceptions without litterering the test with checks
871 * @param string $entity
872 * @param array $params
873 * @param array $checkAgainst - array to compare result against
884 function callAPISuccessGetSingle($entity, $params, $checkAgainst = NULL) {
886 'version' => $this->_apiversion
,
889 $result = $this->civicrm_api($entity, 'getsingle', $params);
890 if(!is_array($result) ||
!empty($result['is_error']) ||
isset($result['values'])) {
891 throw new Exception('Invalid getsingle result' . print_r($result, TRUE));
894 // @todo - have gone with the fn that unsets id? should we check id?
895 $this->checkArrayEquals($result, $checkAgainst);
901 * This function exists to wrap api getValue function & check the result
902 * so we can ensure they succeed & throw exceptions without litterering the test with checks
903 * There is a type check in this
904 * @param string $entity
905 * @param array $params
909 * @internal param string $type - per http://php.net/manual/en/function.gettype.php possible types
917 function callAPISuccessGetCount($entity, $params, $count = NULL) {
919 'version' => $this->_apiversion
,
922 $result = $this->civicrm_api($entity, 'getcount', $params);
923 if(!is_integer($result) ||
!empty($result['is_error']) ||
isset($result['values'])) {
924 throw new Exception('Invalid getcount result : ' . print_r($result, TRUE) . " type :" . gettype($result));
927 $this->assertEquals($count, $result, "incorect count returned from $entity getcount");
933 * This function exists to wrap api functions
934 * so we can ensure they succeed, generate and example & throw exceptions without litterering the test with checks
936 * @param string $entity
937 * @param string $action
938 * @param array $params
939 * @param string $function - pass this in to create a generated example
940 * @param string $file - pass this in to create a generated example
941 * @param string $description
942 * @param string|null $subfile
943 * @param string|null $actionName
946 function callAPIAndDocument($entity, $action, $params, $function, $file, $description = "", $subfile = NULL, $actionName = NULL){
947 $params['version'] = $this->_apiversion
;
948 $result = $this->callAPISuccess($entity, $action, $params);
949 $this->documentMe($params, $result, $function, $file, $description, $subfile, $actionName);
954 * This function exists to wrap api functions
955 * so we can ensure they fail where expected & throw exceptions without litterering the test with checks
956 * @param string $entity
957 * @param string $action
958 * @param array $params
959 * @param string $expectedErrorMessage error
960 * @param null $extraOutput
963 function callAPIFailure($entity, $action, $params, $expectedErrorMessage = NULL, $extraOutput = NULL) {
964 if (is_array($params)) {
966 'version' => $this->_apiversion
,
969 $result = $this->civicrm_api($entity, $action, $params);
970 $this->assertAPIFailure($result, "We expected a failure for $entity $action but got a success");
975 * Create required data based on $this->entity & $this->params
976 * This is just a way to set up the test data for delete & get functions
977 * so the distinction between set
978 * up & tested functions is clearer
980 * @return array api Result
982 public function createTestEntity(){
983 return $entity = $this->callAPISuccess($this->entity
, 'create', $this->params
);
987 * Generic function to create Organisation, to be used in test cases
989 * @param array parameters for civicrm_contact_add api function call
991 * @return int id of Organisation created
993 function organizationCreate($params = array()) {
998 'organization_name' => 'Unit Test Organization',
999 'contact_type' => 'Organization',
1001 return $this->_contactCreate(array_merge($orgParams, $params));
1005 * Generic function to create Individual, to be used in test cases
1007 * @param array parameters for civicrm_contact_add api function call
1009 * @return int id of Individual created
1011 function individualCreate($params = array()) {
1012 $params = array_merge(array(
1013 'first_name' => 'Anthony',
1014 'middle_name' => 'J.',
1015 'last_name' => 'Anderson',
1018 'email' => 'anthony_anderson@civicrm.org',
1019 'contact_type' => 'Individual',
1022 return $this->_contactCreate($params);
1026 * Generic function to create Household, to be used in test cases
1028 * @param array parameters for civicrm_contact_add api function call
1030 * @return int id of Household created
1032 function householdCreate($params = array()) {
1033 $params = array_merge(array(
1034 'household_name' => 'Unit Test household',
1035 'contact_type' => 'Household',
1037 return $this->_contactCreate($params);
1041 * Private helper function for calling civicrm_contact_add
1046 * @internal param \parameters $array for civicrm_contact_add api function call
1048 * @return int id of Household created
1050 private function _contactCreate($params) {
1051 $result = $this->callAPISuccess('contact', 'create', $params);
1052 if (!empty($result['is_error']) ||
empty($result['id'])) {
1053 throw new Exception('Could not create test contact, with message: ' . CRM_Utils_Array
::value('error_message', $result) . "\nBacktrace:" . CRM_Utils_Array
::value('trace', $result));
1055 return $result['id'];
1063 function contactDelete($contactID) {
1066 'skip_undelete' => 1,
1069 $domain = new CRM_Core_BAO_Domain
;
1070 $domain->contact_id
= $contactID;
1071 if ($domain->find(TRUE)) {
1072 // we are finding tests trying to delete the domain contact in cleanup
1073 //since this is mainly for cleanup lets put a safeguard here
1076 $result = $this->callAPISuccess('contact', 'delete', $params);
1081 * @param $contactTypeId
1085 function contactTypeDelete($contactTypeId) {
1086 require_once 'CRM/Contact/BAO/ContactType.php';
1087 $result = CRM_Contact_BAO_ContactType
::del($contactTypeId);
1089 throw new Exception('Could not delete contact type');
1094 * @param array $params
1098 function membershipTypeCreate($params = array()) {
1099 CRM_Member_PseudoConstant
::flush('membershipType');
1100 CRM_Core_Config
::clearDBCache();
1101 $memberOfOrganization = $this->organizationCreate();
1102 $params = array_merge(array(
1103 'name' => 'General',
1104 'duration_unit' => 'year',
1105 'duration_interval' => 1,
1106 'period_type' => 'rolling',
1107 'member_of_contact_id' => $memberOfOrganization,
1109 'financial_type_id' => 1,
1112 'visibility' => 'Public',
1115 $result = $this->callAPISuccess('MembershipType', 'Create', $params);
1117 CRM_Member_PseudoConstant
::flush('membershipType');
1118 CRM_Utils_Cache
::singleton()->flush();
1120 return $result['id'];
1128 function contactMembershipCreate($params) {
1130 'join_date' => '2007-01-21',
1131 'start_date' => '2007-01-21',
1132 'end_date' => '2007-12-21',
1133 'source' => 'Payment',
1136 foreach ($pre as $key => $val) {
1137 if (!isset($params[$key])) {
1138 $params[$key] = $val;
1142 $result = $this->callAPISuccess('Membership', 'create', $params);
1143 return $result['id'];
1147 * Function to delete Membership Type
1150 * @internal param int $membershipTypeID
1152 function membershipTypeDelete($params) {
1153 $this->callAPISuccess('MembershipType', 'Delete', $params);
1157 * @param $membershipID
1159 function membershipDelete($membershipID) {
1160 $deleteParams = array('id' => $membershipID);
1161 $result = $this->callAPISuccess('Membership', 'Delete', $deleteParams);
1166 * @param string $name
1170 function membershipStatusCreate($name = 'test member status') {
1171 $params['name'] = $name;
1172 $params['start_event'] = 'start_date';
1173 $params['end_event'] = 'end_date';
1174 $params['is_current_member'] = 1;
1175 $params['is_active'] = 1;
1177 $result = $this->callAPISuccess('MembershipStatus', 'Create', $params);
1178 CRM_Member_PseudoConstant
::flush('membershipStatus');
1179 return $result['id'];
1183 * @param $membershipStatusID
1185 function membershipStatusDelete($membershipStatusID) {
1186 if (!$membershipStatusID) {
1189 $result = $this->callAPISuccess('MembershipStatus', 'Delete', array('id' => $membershipStatusID));
1194 * @param array $params
1198 function relationshipTypeCreate($params = array()) {
1199 $params = array_merge(array(
1200 'name_a_b' => 'Relation 1 for relationship type create',
1201 'name_b_a' => 'Relation 2 for relationship type create',
1202 'contact_type_a' => 'Individual',
1203 'contact_type_b' => 'Organization',
1210 $result = $this->callAPISuccess('relationship_type', 'create', $params);
1211 CRM_Core_PseudoConstant
::flush('relationshipType');
1213 return $result['id'];
1217 * Function to delete Relatinship Type
1219 * @param int $relationshipTypeID
1221 function relationshipTypeDelete($relationshipTypeID) {
1222 $params['id'] = $relationshipTypeID;
1223 $this->callAPISuccess('relationship_type', 'delete', $params);
1227 * @param null $params
1231 function paymentProcessorTypeCreate($params = NULL) {
1232 if (is_null($params)) {
1234 'name' => 'API_Test_PP',
1235 'title' => 'API Test Payment Processor',
1236 'class_name' => 'CRM_Core_Payment_APITest',
1237 'billing_mode' => 'form',
1243 $result = $this->callAPISuccess('payment_processor_type', 'create', $params);
1245 CRM_Core_PseudoConstant
::flush('paymentProcessorType');
1247 return $result['id'];
1251 * Function to create Participant
1253 * @param array $params array of contact id and event id values
1255 * @return int $id of participant created
1257 function participantCreate($params) {
1258 if(empty($params['contact_id'])){
1259 $params['contact_id'] = $this->individualCreate();
1261 if(empty($params['event_id'])){
1262 $event = $this->eventCreate();
1263 $params['event_id'] = $event['id'];
1268 'register_date' => 20070219,
1269 'source' => 'Wimbeldon',
1270 'event_level' => 'Payment',
1274 $params = array_merge($defaults, $params);
1275 $result = $this->callAPISuccess('Participant', 'create', $params);
1276 return $result['id'];
1280 * Function to create Payment Processor
1282 * @return object of Payment Processsor
1284 function processorCreate() {
1285 $processorParams = array(
1288 'payment_processor_type_id' => 10,
1289 'financial_account_id' => 12,
1292 'url_site' => 'http://dummy.com',
1293 'url_recur' => 'http://dummy.com',
1294 'billing_mode' => 1,
1296 $paymentProcessor = CRM_Financial_BAO_PaymentProcessor
::create($processorParams);
1297 return $paymentProcessor;
1301 * Function to create contribution page
1304 * @return object of contribution page
1306 function contributionPageCreate($params) {
1307 $this->_pageParams
= array(
1308 'title' => 'Test Contribution Page',
1309 'financial_type_id' => 1,
1310 'currency' => 'USD',
1311 'financial_account_id' => 1,
1312 'payment_processor' => $params['processor_id'],
1314 'is_allow_other_amount' => 1,
1316 'max_amount' => 1000,
1318 $contributionPage = $this->callAPISuccess('contribution_page', 'create', $this->_pageParams
);
1319 return $contributionPage;
1323 * Function to create Tag
1325 * @param array $params
1326 * @return array result of created tag
1328 function tagCreate($params = array()) {
1330 'name' => 'New Tag3',
1331 'description' => 'This is description for Our New Tag ',
1334 $params = array_merge($defaults, $params);
1335 $result = $this->callAPISuccess('Tag', 'create', $params);
1336 return $result['values'][$result['id']];
1340 * Function to delete Tag
1342 * @param int $tagId id of the tag to be deleted
1344 function tagDelete($tagId) {
1345 require_once 'api/api.php';
1349 $result = $this->callAPISuccess('Tag', 'delete', $params);
1350 return $result['id'];
1354 * Add entity(s) to the tag
1356 * @param array $params
1360 function entityTagAdd($params) {
1361 $result = $this->callAPISuccess('entity_tag', 'create', $params);
1366 * Function to create contribution
1368 * @param int $cID contact_id
1370 * @internal param int $cTypeID id of financial type
1372 * @return int id of created contribution
1374 function pledgeCreate($cID) {
1376 'contact_id' => $cID,
1377 'pledge_create_date' => date('Ymd'),
1378 'start_date' => date('Ymd'),
1379 'scheduled_date' => date('Ymd'),
1381 'pledge_status_id' => '2',
1382 'financial_type_id' => '1',
1383 'pledge_original_installment_amount' => 20,
1384 'frequency_interval' => 5,
1385 'frequency_unit' => 'year',
1386 'frequency_day' => 15,
1387 'installments' => 5,
1390 $result = $this->callAPISuccess('Pledge', 'create', $params);
1391 return $result['id'];
1395 * Function to delete contribution
1398 * @internal param int $contributionId
1400 function pledgeDelete($pledgeId) {
1402 'pledge_id' => $pledgeId,
1404 $this->callAPISuccess('Pledge', 'delete', $params);
1408 * Function to create contribution
1410 * @param int $cID contact_id
1411 * @param int $cTypeID id of financial type
1413 * @param int $invoiceID
1414 * @param int $trxnID
1415 * @param int $paymentInstrumentID
1416 * @param bool $isFee
1417 * @return int id of created contribution
1419 function contributionCreate($cID, $cTypeID = 1, $invoiceID = 67890, $trxnID = 12345, $paymentInstrumentID = 1, $isFee = TRUE) {
1422 'contact_id' => $cID,
1423 'receive_date' => date('Ymd'),
1424 'total_amount' => 100.00,
1425 'financial_type_id' => empty($cTypeID) ?
1 : $cTypeID,
1426 'payment_instrument_id' => empty($paymentInstrumentID) ?
1 : $paymentInstrumentID,
1427 'non_deductible_amount' => 10.00,
1428 'trxn_id' => $trxnID,
1429 'invoice_id' => $invoiceID,
1431 'contribution_status_id' => 1,
1432 // 'note' => 'Donating for Nobel Cause', *Fixme
1436 $params['fee_amount'] = 5.00;
1437 $params['net_amount'] = 95.00;
1440 $result = $this->callAPISuccess('contribution', 'create', $params);
1441 return $result['id'];
1445 * Function to create online contribution
1448 * @param int $financialType id of financial type
1450 * @param int $invoiceID
1451 * @param int $trxnID
1452 * @return int id of created contribution
1454 function onlineContributionCreate($params, $financialType, $invoiceID = 67890, $trxnID = 12345) {
1455 $contribParams = array(
1456 'contact_id' => $params['contact_id'],
1457 'receive_date' => date('Ymd'),
1458 'total_amount' => 100.00,
1459 'financial_type_id' => $financialType,
1460 'contribution_page_id' => $params['contribution_page_id'],
1462 'invoice_id' => 67890,
1465 $contribParams = array_merge($contribParams, $params);
1466 $result = $this->callAPISuccess('contribution', 'create', $contribParams);
1468 return $result['id'];
1472 * Function to delete contribution
1474 * @param int $contributionId
1478 function contributionDelete($contributionId) {
1480 'contribution_id' => $contributionId,
1482 $result = $this->callAPISuccess('contribution', 'delete', $params);
1487 * Function to create an Event
1489 * @param array $params name-value pair for an event
1491 * @return array $event
1493 function eventCreate($params = array()) {
1494 // if no contact was passed, make up a dummy event creator
1495 if (!isset($params['contact_id'])) {
1496 $params['contact_id'] = $this->_contactCreate(array(
1497 'contact_type' => 'Individual',
1498 'first_name' => 'Event',
1499 'last_name' => 'Creator',
1503 // set defaults for missing params
1504 $params = array_merge(array(
1505 'title' => 'Annual CiviCRM meet',
1506 'summary' => 'If you have any CiviCRM related issues or want to track where CiviCRM is heading, Sign up now',
1507 'description' => 'This event is intended to give brief idea about progess of CiviCRM and giving solutions to common user issues',
1508 'event_type_id' => 1,
1510 'start_date' => 20081021,
1511 'end_date' => 20081023,
1512 'is_online_registration' => 1,
1513 'registration_start_date' => 20080601,
1514 'registration_end_date' => 20081015,
1515 'max_participants' => 100,
1516 'event_full_text' => 'Sorry! We are already full',
1519 'is_show_location' => 0,
1522 return $this->callAPISuccess('Event', 'create', $params);
1526 * Function to delete event
1528 * @param int $id ID of the event
1532 function eventDelete($id) {
1536 return $this->callAPISuccess('event', 'delete', $params);
1540 * Function to delete participant
1542 * @param int $participantID
1546 function participantDelete($participantID) {
1548 'id' => $participantID,
1550 return $this->callAPISuccess('Participant', 'delete', $params);
1554 * Function to create participant payment
1556 * @param $participantID
1557 * @param null $contributionID
1558 * @return int $id of created payment
1560 function participantPaymentCreate($participantID, $contributionID = NULL) {
1561 //Create Participant Payment record With Values
1563 'participant_id' => $participantID,
1564 'contribution_id' => $contributionID,
1567 $result = $this->callAPISuccess('participant_payment', 'create', $params);
1568 return $result['id'];
1572 * Function to delete participant payment
1574 * @param int $paymentID
1576 function participantPaymentDelete($paymentID) {
1580 $result = $this->callAPISuccess('participant_payment', 'delete', $params);
1584 * Function to add a Location
1587 * @return int location id of created location
1589 function locationAdd($contactID) {
1592 'location_type' => 'New Location Type',
1594 'name' => 'Saint Helier St',
1595 'county' => 'Marin',
1596 'country' => 'United States',
1597 'state_province' => 'Michigan',
1598 'supplemental_address_1' => 'Hallmark Ct',
1599 'supplemental_address_2' => 'Jersey Village',
1604 'contact_id' => $contactID,
1605 'address' => $address,
1606 'location_format' => '2.0',
1607 'location_type' => 'New Location Type',
1610 $result = $this->callAPISuccess('Location', 'create', $params);
1615 * Function to delete Locations of contact
1617 * @params array $pamars parameters
1619 function locationDelete($params) {
1620 $result = $this->callAPISuccess('Location', 'delete', $params);
1624 * Function to add a Location Type
1626 * @param null $params
1627 * @return int location id of created location
1629 function locationTypeCreate($params = NULL) {
1630 if ($params === NULL) {
1632 'name' => 'New Location Type',
1633 'vcard_name' => 'New Location Type',
1634 'description' => 'Location Type for Delete',
1639 $locationType = new CRM_Core_DAO_LocationType();
1640 $locationType->copyValues($params);
1641 $locationType->save();
1642 // clear getfields cache
1643 CRM_Core_PseudoConstant
::flush();
1644 $this->callAPISuccess('phone', 'getfields', array('version' => 3, 'cache_clear' => 1));
1645 return $locationType;
1649 * Function to delete a Location Type
1651 * @param int location type id
1653 function locationTypeDelete($locationTypeId) {
1654 $locationType = new CRM_Core_DAO_LocationType();
1655 $locationType->id
= $locationTypeId;
1656 $locationType->delete();
1660 * Function to add a Group
1662 * @params array to add group
1664 * @param array $params
1665 * @return int groupId of created group
1667 function groupCreate($params = array()) {
1668 $params = array_merge(array(
1669 'name' => 'Test Group 1',
1671 'title' => 'New Test Group Created',
1672 'description' => 'New Test Group Created',
1674 'visibility' => 'Public Pages',
1675 'group_type' => array(
1681 $result = $this->callAPISuccess('Group', 'create', $params);
1682 return $result['id'];
1686 * Function to delete a Group
1689 * @internal param int $id
1691 function groupDelete($gid) {
1697 $this->callAPISuccess('Group', 'delete', $params);
1702 * @param array $params
1704 function uFFieldCreate($params = array()) {
1705 $params = array_merge(array(
1707 'field_name' => 'first_name',
1710 'visibility' => 'Public Pages and Listings',
1711 'is_searchable' => '1',
1712 'label' => 'first_name',
1713 'field_type' => 'Individual',
1716 $this->callAPISuccess('uf_field', 'create', $params);
1720 * Function to add a UF Join Entry
1722 * @param null $params
1723 * @return int $id of created UF Join
1725 function ufjoinCreate($params = NULL) {
1726 if ($params === NULL) {
1729 'module' => 'CiviEvent',
1730 'entity_table' => 'civicrm_event',
1736 $result = $this->callAPISuccess('uf_join', 'create', $params);
1741 * Function to delete a UF Join Entry
1743 * @param array with missing uf_group_id
1745 function ufjoinDelete($params = NULL) {
1746 if ($params === NULL) {
1749 'module' => 'CiviEvent',
1750 'entity_table' => 'civicrm_event',
1753 'uf_group_id' => '',
1757 crm_add_uf_join($params);
1761 * Function to create Group for a contact
1763 * @param int $contactId
1765 function contactGroupCreate($contactId) {
1767 'contact_id.1' => $contactId,
1771 $this->callAPISuccess('GroupContact', 'Create', $params);
1775 * Function to delete Group for a contact
1778 * @internal param array $params
1780 function contactGroupDelete($contactId) {
1782 'contact_id.1' => $contactId,
1785 $this->civicrm_api('GroupContact', 'Delete', $params);
1789 * Function to create Activity
1791 * @param null $params
1793 * @internal param int $contactId
1795 function activityCreate($params = NULL) {
1797 if ($params === NULL) {
1798 $individualSourceID = $this->individualCreate();
1800 $contactParams = array(
1801 'first_name' => 'Julia',
1802 'Last_name' => 'Anderson',
1804 'email' => 'julia_anderson@civicrm.org',
1805 'contact_type' => 'Individual',
1808 $individualTargetID = $this->individualCreate($contactParams);
1811 'source_contact_id' => $individualSourceID,
1812 'target_contact_id' => array($individualTargetID),
1813 'assignee_contact_id' => array($individualTargetID),
1814 'subject' => 'Discussion on warm beer',
1815 'activity_date_time' => date('Ymd'),
1816 'duration_hours' => 30,
1817 'duration_minutes' => 20,
1818 'location' => 'Baker Street',
1819 'details' => 'Lets schedule a meeting',
1821 'activity_name' => 'Meeting',
1825 $result = $this->callAPISuccess('Activity', 'create', $params);
1827 $result['target_contact_id'] = $individualTargetID;
1828 $result['assignee_contact_id'] = $individualTargetID;
1833 * Function to create an activity type
1835 * @params array $params parameters
1837 function activityTypeCreate($params) {
1838 $result = $this->callAPISuccess('ActivityType', 'create', $params);
1843 * Function to delete activity type
1845 * @params Integer $activityTypeId id of the activity type
1847 function activityTypeDelete($activityTypeId) {
1848 $params['activity_type_id'] = $activityTypeId;
1849 $result = $this->callAPISuccess('ActivityType', 'delete', $params);
1854 * Function to create custom group
1856 * @param array $params
1858 * @internal param string $className
1859 * @internal param string $title name of custom group
1861 function customGroupCreate($params = array()) {
1863 'title' => 'new custom group',
1864 'extends' => 'Contact',
1866 'style' => 'Inline',
1870 $params = array_merge($defaults, $params);
1872 if (strlen($params['title']) > 13) {
1873 $params['title'] = substr($params['title'], 0, 13);
1876 //have a crack @ deleting it first in the hope this will prevent derailing our tests
1877 $check = $this->callAPISuccess('custom_group', 'get', array('title' => $params['title'], array('api.custom_group.delete' => 1)));
1879 return $this->callAPISuccess('custom_group', 'create', $params);
1883 * existing function doesn't allow params to be over-ridden so need a new one
1884 * this one allows you to only pass in the params you want to change
1886 function CustomGroupCreateByParams($params = array()) {
1888 'title' => "API Custom Group",
1889 'extends' => 'Contact',
1891 'style' => 'Inline',
1894 $params = array_merge($defaults, $params);
1895 return $this->callAPISuccess('custom_group', 'create', $params);
1899 * Create custom group with multi fields
1901 function CustomGroupMultipleCreateByParams($params = array()) {
1906 $params = array_merge($defaults, $params);
1907 return $this->CustomGroupCreateByParams($params);
1911 * Create custom group with multi fields
1913 function CustomGroupMultipleCreateWithFields($params = array()) {
1914 // also need to pass on $params['custom_field'] if not set but not in place yet
1916 $customGroup = $this->CustomGroupMultipleCreateByParams($params);
1917 $ids['custom_group_id'] = $customGroup['id'];
1919 $customField = $this->customFieldCreate(array('custom_group_id' => $ids['custom_group_id'], 'label' => 'field_1' . $ids['custom_group_id']));
1921 $ids['custom_field_id'][] = $customField['id'];
1923 $customField = $this->customFieldCreate(array('custom_group_id' => $ids['custom_group_id'], 'default_value' => '', 'label' => 'field_2' . $ids['custom_group_id']));
1924 $ids['custom_field_id'][] = $customField['id'];
1926 $customField = $this->customFieldCreate(array('custom_group_id' => $ids['custom_group_id'], 'default_value' => '', 'label' => 'field_3' . $ids['custom_group_id']));
1927 $ids['custom_field_id'][] = $customField['id'];
1933 * Create a custom group with a single text custom field. See
1934 * participant:testCreateWithCustom for how to use this
1936 * @param string $function __FUNCTION__
1938 * @internal param string $file __FILE__
1940 * @return array $ids ids of created objects
1942 function entityCustomGroupWithSingleFieldCreate($function, $filename) {
1943 $params = array('title' => $function);
1944 $entity = substr(basename($filename), 0, strlen(basename($filename)) - 8);
1945 $params['extends'] = $entity ?
$entity : 'Contact';
1946 $customGroup = $this->CustomGroupCreate($params);
1947 $customField = $this->customFieldCreate(array('custom_group_id' => $customGroup['id'], 'label' => $function));
1948 CRM_Core_PseudoConstant
::flush();
1950 return array('custom_group_id' => $customGroup['id'], 'custom_field_id' => $customField['id']);
1954 * Function to delete custom group
1956 * @param int $customGroupID
1960 function customGroupDelete($customGroupID) {
1961 $params['id'] = $customGroupID;
1962 return $this->callAPISuccess('custom_group', 'delete', $params);
1966 * Function to create custom field
1968 * @param array $params (custom_group_id) is required
1970 * @internal param string $name name of custom field
1971 * @internal param int $apiversion API version to use
1973 function customFieldCreate($params) {
1974 $params = array_merge(array(
1975 'label' => 'Custom Field',
1976 'data_type' => 'String',
1977 'html_type' => 'Text',
1978 'is_searchable' => 1,
1980 'default_value' => 'defaultValue',
1983 $result = $this->callAPISuccess('custom_field', 'create', $params);
1985 if ($result['is_error'] == 0 && isset($result['id'])) {
1986 CRM_Core_BAO_CustomField
::getTableColumnGroup($result['id'], 1);
1987 // force reset of enabled components to help grab custom fields
1988 CRM_Core_Component
::getEnabledComponents(1);
1994 * Function to delete custom field
1996 * @param int $customFieldID
2000 function customFieldDelete($customFieldID) {
2002 $params['id'] = $customFieldID;
2003 return $this->callAPISuccess('custom_field', 'delete', $params);
2007 * Function to create note
2009 * @params array $params name-value pair for an event
2012 * @return array $note
2014 function noteCreate($cId) {
2016 'entity_table' => 'civicrm_contact',
2017 'entity_id' => $cId,
2018 'note' => 'hello I am testing Note',
2019 'contact_id' => $cId,
2020 'modified_date' => date('Ymd'),
2021 'subject' => 'Test Note',
2024 return $this->callAPISuccess('Note', 'create', $params);
2028 * Enable CiviCampaign Component
2030 function enableCiviCampaign() {
2031 CRM_Core_BAO_ConfigSetting
::enableComponent('CiviCampaign');
2032 // force reload of config object
2033 $config = CRM_Core_Config
::singleton(TRUE, TRUE);
2034 //flush cache by calling with reset
2035 $activityTypes = CRM_Core_PseudoConstant
::activityType(TRUE, TRUE, TRUE, 'name', TRUE);
2039 * Create test generated example in api/v3/examples.
2040 * To turn this off (e.g. on the server) set
2041 * define(DONT_DOCUMENT_TEST_CONFIG ,1);
2042 * in your settings file
2043 * @param array $params array as passed to civicrm_api function
2044 * @param array $result array as received from the civicrm_api function
2045 * @param string $function calling function - generally __FUNCTION__
2046 * @param string $filename called from file - generally __FILE__
2047 * @param string $description descriptive text for the example file
2048 * @param string $subfile name for subfile - if this is completed the example will be put in a subfolder (named by the entity)
2049 * @param string $action - optional action - otherwise taken from function name
2051 function documentMe($params, $result, $function, $filename, $description = "", $subfile = NULL, $action = NULL) {
2052 if (defined('DONT_DOCUMENT_TEST_CONFIG')) {
2055 $entity = substr(basename($filename), 0, strlen(basename($filename)) - 8);
2056 //todo - this is a bit cludgey
2057 if (empty($action)) {
2058 if (strstr($function, 'Create')) {
2059 $action = empty($action) ?
'create' : $action;
2060 $entityAction = 'Create';
2062 elseif (strstr($function, 'GetSingle')) {
2063 $action = empty($action) ?
'getsingle' : $action;
2064 $entityAction = 'GetSingle';
2066 elseif (strstr($function, 'GetValue')) {
2067 $action = empty($action) ?
'getvalue' : $action;
2068 $entityAction = 'GetValue';
2070 elseif (strstr($function, 'GetCount')) {
2071 $action = empty($action) ?
'getcount' : $action;
2072 $entityAction = 'GetCount';
2074 elseif (strstr($function, 'GetFields')) {
2075 $action = empty($action) ?
'getfields' : $action;
2076 $entityAction = 'GetFields';
2078 elseif (strstr($function, 'GetList')) {
2079 $action = empty($action) ?
'getlist' : $action;
2080 $entityAction = 'GetList';
2082 elseif (strstr($function, 'Get')) {
2083 $action = empty($action) ?
'get' : $action;
2084 $entityAction = 'Get';
2086 elseif (strstr($function, 'Delete')) {
2087 $action = empty($action) ?
'delete' : $action;
2088 $entityAction = 'Delete';
2090 elseif (strstr($function, 'Update')) {
2091 $action = empty($action) ?
'update' : $action;
2092 $entityAction = 'Update';
2094 elseif (strstr($function, 'Subscribe')) {
2095 $action = empty($action) ?
'subscribe' : $action;
2096 $entityAction = 'Subscribe';
2098 elseif (strstr($function, 'Submit')) {
2099 $action = empty($action) ?
'submit' : $action;
2100 $entityAction = 'Submit';
2102 elseif (strstr($function, 'Apply')) {
2103 $action = empty($action) ?
'apply' : $action;
2104 $entityAction = 'Apply';
2106 elseif (strstr($function, 'Replace')) {
2107 $action = empty($action) ?
'replace' : $action;
2108 $entityAction = 'Replace';
2112 $entityAction = ucwords($action);
2115 $this->tidyExampleResult($result);
2116 if(isset($params['version'])) {
2117 unset($params['version']);
2119 // a cleverer person than me would do it in a single regex
2120 if (strstr($entity, 'UF')) {
2121 $fnPrefix = strtolower(preg_replace('/(?<! )(?<!^)(?<=UF)[A-Z]/', '_$0', $entity));
2124 $fnPrefix = strtolower(preg_replace('/(?<! )(?<!^)[A-Z]/', '_$0', $entity));
2126 $smarty = CRM_Core_Smarty
::singleton();
2127 $smarty->assign('testfunction', $function);
2128 $function = $fnPrefix . "_" . strtolower($action);
2129 $smarty->assign('function', $function);
2130 $smarty->assign('fnPrefix', $fnPrefix);
2131 $smarty->assign('params', $params);
2132 $smarty->assign('entity', $entity);
2133 $smarty->assign('filename', basename($filename));
2134 $smarty->assign('description', $description);
2135 $smarty->assign('result', $result);
2137 $smarty->assign('action', $action);
2138 if (empty($subfile)) {
2139 $subfile = $entityAction;
2141 if (file_exists('../tests/templates/documentFunction.tpl')) {
2142 if (!is_dir("../api/v3/examples/$entity")) {
2143 mkdir("../api/v3/examples/$entity");
2145 $f = fopen("../api/v3/examples/$entity/$subfile.php", "w+b");
2146 fwrite($f, $smarty->fetch('../tests/templates/documentFunction.tpl'));
2152 * Tidy up examples array so that fields that change often ..don't
2153 * and debug related fields are unset
2157 * @internal param array $params
2159 function tidyExampleResult(&$result){
2160 if(!is_array($result)) {
2163 $fieldsToChange = array(
2164 'hash' => '67eac7789eaee00',
2165 'modified_date' => '2012-11-14 16:02:35',
2166 'created_date' => '2013-07-28 08:49:19',
2167 'create_date' => '20120130621222105',
2168 'application_received_date' => '20130728084957',
2169 'in_date' => '2013-07-28 08:50:19',
2170 'scheduled_date' => '20130728085413',
2171 'approval_date' => '20130728085413',
2172 'pledge_start_date_high' => '20130726090416',
2173 'start_date' => '2013-07-29 00:00:00',
2174 'event_start_date' => '2013-07-29 00:00:00',
2175 'end_date' => '2013-08-04 00:00:00',
2176 'event_end_date' => '2013-08-04 00:00:00',
2177 'decision_date' => '20130805000000',
2180 $keysToUnset = array('xdebug', 'undefined_fields',);
2181 foreach ($keysToUnset as $unwantedKey) {
2182 if(isset($result[$unwantedKey])) {
2183 unset($result[$unwantedKey]);
2186 if (isset($result['values'])) {
2187 if(!is_array($result['values'])) {
2190 $resultArray = &$result['values'];
2192 elseif(is_array($result)) {
2193 $resultArray = &$result;
2199 foreach ($resultArray as $index => &$values) {
2200 if(!is_array($values)) {
2203 foreach($values as $key => &$value) {
2204 if(substr($key, 0, 3) == 'api' && is_array($value)) {
2205 if(isset($value['is_error'])) {
2206 // we have a std nested result format
2207 $this->tidyExampleResult($value);
2210 foreach ($value as &$nestedResult) {
2211 // this is an alternative syntax for nested results a keyed array of results
2212 $this->tidyExampleResult($nestedResult);
2216 if(in_array($key, $keysToUnset)) {
2217 unset($values[$key]);
2220 if(array_key_exists($key, $fieldsToChange) && !empty($value)) {
2221 $value = $fieldsToChange[$key];
2223 if(is_string($value)) {
2224 $value = addslashes($value);
2231 * Function to delete note
2233 * @params int $noteID
2236 function noteDelete($params) {
2237 return $this->callAPISuccess('Note', 'delete', $params);
2241 * Function to create custom field with Option Values
2243 * @param array $customGroup
2244 * @param string $name name of custom field
2248 function customFieldOptionValueCreate($customGroup, $name) {
2249 $fieldParams = array(
2250 'custom_group_id' => $customGroup['id'],
2251 'name' => 'test_custom_group',
2252 'label' => 'Country',
2253 'html_type' => 'Select',
2254 'data_type' => 'String',
2257 'is_searchable' => 0,
2261 $optionGroup = array(
2263 'name' => 'option_group1',
2264 'label' => 'option_group_label1',
2267 $optionValue = array(
2268 'option_label' => array('Label1', 'Label2'),
2269 'option_value' => array('value1', 'value2'),
2270 'option_name' => array($name . '_1', $name . '_2'),
2271 'option_weight' => array(1, 2),
2272 'option_status' => 1,
2275 $params = array_merge($fieldParams, $optionGroup, $optionValue);
2277 return $this->callAPISuccess('custom_field', 'create', $params);
2285 function confirmEntitiesDeleted($entities) {
2286 foreach ($entities as $entity) {
2288 $result = $this->callAPISuccess($entity, 'Get', array());
2289 if ($result['error'] == 1 ||
$result['count'] > 0) {
2290 // > than $entity[0] to allow a value to be passed in? e.g. domain?
2297 * @param $tablesToTruncate
2298 * @param bool $dropCustomValueTables
2300 function quickCleanup($tablesToTruncate, $dropCustomValueTables = FALSE) {
2301 if ($dropCustomValueTables) {
2302 $tablesToTruncate[] = 'civicrm_custom_group';
2303 $tablesToTruncate[] = 'civicrm_custom_field';
2306 $tablesToTruncate = array_unique(array_merge($this->_tablesToTruncate
, $tablesToTruncate));
2308 CRM_Core_DAO
::executeQuery("SET FOREIGN_KEY_CHECKS = 0;");
2309 foreach ($tablesToTruncate as $table) {
2310 $sql = "TRUNCATE TABLE $table";
2311 CRM_Core_DAO
::executeQuery($sql);
2313 CRM_Core_DAO
::executeQuery("SET FOREIGN_KEY_CHECKS = 1;");
2315 if ($dropCustomValueTables) {
2316 $dbName = self
::getDBName();
2318 SELECT TABLE_NAME as tableName
2319 FROM INFORMATION_SCHEMA.TABLES
2320 WHERE TABLE_SCHEMA = '{$dbName}'
2321 AND ( TABLE_NAME LIKE 'civicrm_value_%' )
2324 $tableDAO = CRM_Core_DAO
::executeQuery($query);
2325 while ($tableDAO->fetch()) {
2326 $sql = "DROP TABLE {$tableDAO->tableName}";
2327 CRM_Core_DAO
::executeQuery($sql);
2333 * Clean up financial entities after financial tests (so we remember to get all the tables :-))
2335 function quickCleanUpFinancialEntities() {
2336 $tablesToTruncate = array(
2337 'civicrm_contribution',
2338 'civicrm_financial_trxn',
2339 'civicrm_contribution_recur',
2340 'civicrm_line_item',
2341 'civicrm_contribution_page',
2342 'civicrm_payment_processor',
2343 'civicrm_entity_financial_trxn',
2344 'civicrm_membership',
2345 'civicrm_membership_type',
2346 'civicrm_membership_payment',
2347 'civicrm_membership_log',
2348 'civicrm_membership_status',
2350 'civicrm_participant',
2351 'civicrm_participant_payment',
2354 $this->quickCleanup($tablesToTruncate);
2357 * Function does a 'Get' on the entity & compares the fields in the Params with those returned
2358 * Default behaviour is to also delete the entity
2359 * @param array $params params array to check agains
2360 * @param int $id id of the entity concerned
2361 * @param string $entity name of entity concerned (e.g. membership)
2362 * @param bool $delete should the entity be deleted as part of this check
2363 * @param string $errorText text to print on error
2370 * @param int $delete
2371 * @param string $errorText
2375 function getAndCheck($params, $id, $entity, $delete = 1, $errorText = '') {
2377 $result = $this->callAPISuccessGetSingle($entity, array(
2382 $this->callAPISuccess($entity, 'Delete', array(
2386 $dateFields = $keys = $dateTimeFields = array();
2387 $fields = $this->callAPISuccess($entity, 'getfields', array('version' => 3, 'action' => 'get'));
2388 foreach ($fields['values'] as $field => $settings) {
2389 if (array_key_exists($field, $result)) {
2390 $keys[CRM_Utils_Array
::Value('name', $settings, $field)] = $field;
2393 $keys[CRM_Utils_Array
::Value('name', $settings, $field)] = CRM_Utils_Array
::value('name', $settings, $field);
2395 $type = CRM_Utils_Array
::value('type', $settings);
2396 if ($type == CRM_Utils_Type
::T_DATE
) {
2397 $dateFields[] = $settings['name'];
2398 // we should identify both real names & unique names as dates
2399 if($field != $settings['name']) {
2400 $dateFields[] = $field;
2403 if($type == CRM_Utils_Type
::T_DATE + CRM_Utils_Type
::T_TIME
) {
2404 $dateTimeFields[] = $settings['name'];
2405 // we should identify both real names & unique names as dates
2406 if($field != $settings['name']) {
2407 $dateTimeFields[] = $field;
2412 if (strtolower($entity) == 'contribution') {
2413 $params['receive_date'] = date('Y-m-d', strtotime($params['receive_date']));
2414 // this is not returned in id format
2415 unset($params['payment_instrument_id']);
2416 $params['contribution_source'] = $params['source'];
2417 unset($params['source']);
2420 foreach ($params as $key => $value) {
2421 if ($key == 'version' ||
substr($key, 0, 3) == 'api' ||
!array_key_exists($keys[$key], $result)) {
2424 if (in_array($key, $dateFields)) {
2425 $value = date('Y-m-d', strtotime($value));
2426 $result[$key] = date('Y-m-d', strtotime($result[$key]));
2428 if (in_array($key, $dateTimeFields)) {
2429 $value = date('Y-m-d H:i:s', strtotime($value));
2430 $result[$keys[$key]] = date('Y-m-d H:i:s', strtotime(CRM_Utils_Array
::value($keys[$key], $result, CRM_Utils_Array
::value($key, $result))));
2432 $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);
2437 * Function to get formatted values in the actual and expected result
2438 * @param array $actual actual calculated values
2439 * @param array $expected expected values
2442 function checkArrayEquals(&$actual, &$expected) {
2443 self
::unsetId($actual);
2444 self
::unsetId($expected);
2445 $this->assertEquals($actual, $expected);
2449 * Function to unset the key 'id' from the array
2450 * @param array $unformattedArray The array from which the 'id' has to be unset
2453 static function unsetId(&$unformattedArray) {
2454 $formattedArray = array();
2455 if (array_key_exists('id', $unformattedArray)) {
2456 unset($unformattedArray['id']);
2458 if (!empty($unformattedArray['values']) && is_array($unformattedArray['values'])) {
2459 foreach ($unformattedArray['values'] as $key => $value) {
2460 if (is_Array($value)) {
2461 foreach ($value as $k => $v) {
2467 elseif ($key == 'id') {
2468 $unformattedArray[$key];
2470 $formattedArray = array($value);
2472 $unformattedArray['values'] = $formattedArray;
2477 * Helper to enable/disable custom directory support
2479 * @param array $customDirs with members:
2480 * 'php_path' Set to TRUE to use the default, FALSE or "" to disable support, or a string path to use another path
2481 * 'template_path' Set to TRUE to use the default, FALSE or "" to disable support, or a string path to use another path
2483 function customDirectories($customDirs) {
2484 require_once 'CRM/Core/Config.php';
2485 $config = CRM_Core_Config
::singleton();
2487 if (empty($customDirs['php_path']) ||
$customDirs['php_path'] === FALSE) {
2488 unset($config->customPHPPathDir
);
2490 elseif ($customDirs['php_path'] === TRUE) {
2491 $config->customPHPPathDir
= dirname(dirname(__FILE__
)) . '/custom_directories/php/';
2494 $config->customPHPPathDir
= $php_path;
2497 if (empty($customDirs['template_path']) ||
$customDirs['template_path'] === FALSE) {
2498 unset($config->customTemplateDir
);
2500 elseif ($customDirs['template_path'] === TRUE) {
2501 $config->customTemplateDir
= dirname(dirname(__FILE__
)) . '/custom_directories/templates/';
2504 $config->customTemplateDir
= $template_path;
2509 * Generate a temporary folder
2511 * @param string $prefix
2512 * @return string $string
2514 function createTempDir($prefix = 'test-') {
2515 $tempDir = CRM_Utils_File
::tempdir($prefix);
2516 $this->tempDirs
[] = $tempDir;
2520 function cleanTempDirs() {
2521 if (!is_array($this->tempDirs
)) {
2522 // fix test errors where this is not set
2525 foreach ($this->tempDirs
as $tempDir) {
2526 if (is_dir($tempDir)) {
2527 CRM_Utils_File
::cleanDir($tempDir, TRUE, FALSE);
2533 * Temporarily replace the singleton extension with a different one
2535 function setExtensionSystem(CRM_Extension_System
$system) {
2536 if ($this->origExtensionSystem
== NULL) {
2537 $this->origExtensionSystem
= CRM_Extension_System
::singleton();
2539 CRM_Extension_System
::setSingleton($this->origExtensionSystem
);
2542 function unsetExtensionSystem() {
2543 if ($this->origExtensionSystem
!== NULL) {
2544 CRM_Extension_System
::setSingleton($this->origExtensionSystem
);
2545 $this->origExtensionSystem
= NULL;
2550 * Temporarily alter the settings-metadata to add a mock setting.
2552 * WARNING: The setting metadata will disappear on the next cache-clear.
2557 function setMockSettingsMetaData($extras) {
2558 CRM_Core_BAO_Setting
::$_cache = array();
2559 $this->callAPISuccess('system','flush', array());
2560 CRM_Core_BAO_Setting
::$_cache = array();
2562 CRM_Utils_Hook
::singleton()->setHook('civicrm_alterSettingsMetaData', function (&$metadata, $domainId, $profile) use ($extras) {
2563 $metadata = array_merge($metadata, $extras);
2566 $fields = $this->callAPISuccess('setting', 'getfields', array());
2567 foreach ($extras as $key => $spec) {
2568 $this->assertNotEmpty($spec['title']);
2569 $this->assertEquals($spec['title'], $fields['values'][$key]['title']);
2576 function financialAccountDelete($name) {
2577 $financialAccount = new CRM_Financial_DAO_FinancialAccount();
2578 $financialAccount->name
= $name;
2579 if($financialAccount->find(TRUE)) {
2580 $entityFinancialType = new CRM_Financial_DAO_EntityFinancialAccount();
2581 $entityFinancialType->financial_account_id
= $financialAccount->id
;
2582 $entityFinancialType->delete();
2583 $financialAccount->delete();
2588 * Use $ids as an instruction to do test cleanup
2590 function deleteFromIDSArray() {
2591 foreach ($this->ids
as $entity => $ids) {
2592 foreach ($ids as $id) {
2593 $this->callAPISuccess($entity, 'delete', array('id' => $id));
2599 * FIXME: something NULLs $GLOBALS['_HTML_QuickForm_registered_rules'] when the tests are ran all together
2600 * (NB unclear if this is still required)
2602 function _sethtmlGlobals() {
2603 $GLOBALS['_HTML_QuickForm_registered_rules'] = array(
2604 'required' => array(
2605 'html_quickform_rule_required',
2606 'HTML/QuickForm/Rule/Required.php'
2608 'maxlength' => array(
2609 'html_quickform_rule_range',
2610 'HTML/QuickForm/Rule/Range.php'
2612 'minlength' => array(
2613 'html_quickform_rule_range',
2614 'HTML/QuickForm/Rule/Range.php'
2616 'rangelength' => array(
2617 'html_quickform_rule_range',
2618 'HTML/QuickForm/Rule/Range.php'
2621 'html_quickform_rule_email',
2622 'HTML/QuickForm/Rule/Email.php'
2625 'html_quickform_rule_regex',
2626 'HTML/QuickForm/Rule/Regex.php'
2628 'lettersonly' => array(
2629 'html_quickform_rule_regex',
2630 'HTML/QuickForm/Rule/Regex.php'
2632 'alphanumeric' => array(
2633 'html_quickform_rule_regex',
2634 'HTML/QuickForm/Rule/Regex.php'
2637 'html_quickform_rule_regex',
2638 'HTML/QuickForm/Rule/Regex.php'
2640 'nopunctuation' => array(
2641 'html_quickform_rule_regex',
2642 'HTML/QuickForm/Rule/Regex.php'
2645 'html_quickform_rule_regex',
2646 'HTML/QuickForm/Rule/Regex.php'
2648 'callback' => array(
2649 'html_quickform_rule_callback',
2650 'HTML/QuickForm/Rule/Callback.php'
2653 'html_quickform_rule_compare',
2654 'HTML/QuickForm/Rule/Compare.php'
2657 // FIXME: …ditto for $GLOBALS['HTML_QUICKFORM_ELEMENT_TYPES']
2658 $GLOBALS['HTML_QUICKFORM_ELEMENT_TYPES'] = array(
2660 'HTML/QuickForm/group.php',
2661 'HTML_QuickForm_group'
2664 'HTML/QuickForm/hidden.php',
2665 'HTML_QuickForm_hidden'
2668 'HTML/QuickForm/reset.php',
2669 'HTML_QuickForm_reset'
2671 'checkbox' => array(
2672 'HTML/QuickForm/checkbox.php',
2673 'HTML_QuickForm_checkbox'
2676 'HTML/QuickForm/file.php',
2677 'HTML_QuickForm_file'
2680 'HTML/QuickForm/image.php',
2681 'HTML_QuickForm_image'
2683 'password' => array(
2684 'HTML/QuickForm/password.php',
2685 'HTML_QuickForm_password'
2688 'HTML/QuickForm/radio.php',
2689 'HTML_QuickForm_radio'
2692 'HTML/QuickForm/button.php',
2693 'HTML_QuickForm_button'
2696 'HTML/QuickForm/submit.php',
2697 'HTML_QuickForm_submit'
2700 'HTML/QuickForm/select.php',
2701 'HTML_QuickForm_select'
2703 'hiddenselect' => array(
2704 'HTML/QuickForm/hiddenselect.php',
2705 'HTML_QuickForm_hiddenselect'
2708 'HTML/QuickForm/text.php',
2709 'HTML_QuickForm_text'
2711 'textarea' => array(
2712 'HTML/QuickForm/textarea.php',
2713 'HTML_QuickForm_textarea'
2715 'fckeditor' => array(
2716 'HTML/QuickForm/fckeditor.php',
2717 'HTML_QuickForm_FCKEditor'
2720 'HTML/QuickForm/tinymce.php',
2721 'HTML_QuickForm_TinyMCE'
2723 'dojoeditor' => array(
2724 'HTML/QuickForm/dojoeditor.php',
2725 'HTML_QuickForm_dojoeditor'
2728 'HTML/QuickForm/link.php',
2729 'HTML_QuickForm_link'
2731 'advcheckbox' => array(
2732 'HTML/QuickForm/advcheckbox.php',
2733 'HTML_QuickForm_advcheckbox'
2736 'HTML/QuickForm/date.php',
2737 'HTML_QuickForm_date'
2740 'HTML/QuickForm/static.php',
2741 'HTML_QuickForm_static'
2744 'HTML/QuickForm/header.php',
2745 'HTML_QuickForm_header'
2748 'HTML/QuickForm/html.php',
2749 'HTML_QuickForm_html'
2751 'hierselect' => array(
2752 'HTML/QuickForm/hierselect.php',
2753 'HTML_QuickForm_hierselect'
2755 'autocomplete' => array(
2756 'HTML/QuickForm/autocomplete.php',
2757 'HTML_QuickForm_autocomplete'
2760 'HTML/QuickForm/xbutton.php',
2761 'HTML_QuickForm_xbutton'
2763 'advmultiselect' => array(
2764 'HTML/QuickForm/advmultiselect.php',
2765 'HTML_QuickForm_advmultiselect'
2771 * Set up an acl allowing contact to see 2 specified groups
2772 * - $this->_permissionedGroup & $this->_permissionedDisbaledGroup
2774 * You need to have precreated these groups & created the user e.g
2775 * $this->createLoggedInUser();
2776 * $this->_permissionedDisabledGroup = $this->groupCreate(array('title' => 'pick-me-disabled', 'is_active' => 0, 'name' => 'pick-me-disabled'));
2777 * $this->_permissionedGroup = $this->groupCreate(array('title' => 'pick-me-active', 'is_active' => 1, 'name' => 'pick-me-active'));
2780 function setupACL() {
2782 $_REQUEST = $this->_params
;
2783 CRM_Core_Config
::singleton()->userPermissionClass
->permissions
= array('access CiviCRM');
2784 $optionGroupID = $this->callAPISuccessGetValue('option_group', array('return' => 'id', 'name' => 'acl_role'));
2785 $optionValue = $this->callAPISuccess('option_value', 'create', array('option_group_id' => $optionGroupID,
2786 'label' => 'pick me',
2791 CRM_Core_DAO
::executeQuery("
2792 TRUNCATE civicrm_acl_cache
2795 CRM_Core_DAO
::executeQuery("
2796 TRUNCATE civicrm_acl_contact_cache
2800 CRM_Core_DAO
::executeQuery("
2801 INSERT INTO civicrm_acl_entity_role (
2802 `acl_role_id`, `entity_table`, `entity_id`
2803 ) VALUES (55, 'civicrm_group', {$this->_permissionedGroup});
2806 CRM_Core_DAO
::executeQuery("
2807 INSERT INTO civicrm_acl (
2808 `name`, `entity_table`, `entity_id`, `operation`, `object_table`, `object_id`, `is_active`
2811 'view picked', 'civicrm_group', $this->_permissionedGroup , 'Edit', 'civicrm_saved_search', {$this->_permissionedGroup}, 1
2815 CRM_Core_DAO
::executeQuery("
2816 INSERT INTO civicrm_acl (
2817 `name`, `entity_table`, `entity_id`, `operation`, `object_table`, `object_id`, `is_active`
2820 'view picked', 'civicrm_group', $this->_permissionedGroup, 'Edit', 'civicrm_saved_search', {$this->_permissionedDisabledGroup}, 1
2823 $this->_loggedInUser
= CRM_Core_Session
::singleton()->get('userID');
2824 $this->callAPISuccess('group_contact', 'create', array(
2825 'group_id' => $this->_permissionedGroup
,
2826 'contact_id' => $this->_loggedInUser
,
2829 CRM_ACL_BAO_Cache
::resetCache();
2830 CRM_Contact_BAO_Group
::getPermissionClause(TRUE);
2831 CRM_ACL_API
::groupPermission('whatever', 9999, NULL, 'civicrm_saved_search', NULL, NULL, TRUE);
2835 * alter default price set so that the field numbers are not all 1 (hiding errors)
2837 function offsetDefaultPriceSet() {
2838 $contributionPriceSet = $this->callAPISuccess('price_set', 'getsingle', array('name' => 'default_contribution_amount'));
2839 $firstID = $contributionPriceSet['id'];
2840 $this->callAPISuccess('price_set', 'create', array('id' => $contributionPriceSet['id'], 'is_active' => 0, 'name' => 'old'));
2841 unset($contributionPriceSet['id']);
2842 $newPriceSet = $this->callAPISuccess('price_set', 'create', $contributionPriceSet);
2843 $priceField = $this->callAPISuccess('price_field', 'getsingle', array('price_set_id' => $firstID, 'options' => array('limit' => 1)));
2844 unset($priceField['id']);
2845 $priceField['price_set_id'] = $newPriceSet['id'];
2846 $newPriceField = $this->callAPISuccess('price_field', 'create', $priceField);
2847 $priceFieldValue = $this->callAPISuccess('price_field_value', 'getsingle', array('price_set_id' => $firstID, 'sequential' => 1, 'options' => array('limit' => 1)));
2849 unset($priceFieldValue['id']);
2850 //create some padding to use up ids
2851 $this->callAPISuccess('price_field_value', 'create', $priceFieldValue);
2852 $this->callAPISuccess('price_field_value', 'create', $priceFieldValue);
2853 $this->callAPISuccess('price_field_value', 'create', array_merge($priceFieldValue, array('price_field_id' => $newPriceField['id'])));
2858 * Create an instance of the paypal processor
2859 * @todo this isn't a great place to put it - but really it belongs on a class that extends
2860 * this parent class & we don't have a structure for that yet
2861 * There is another function to this effect on the PaypalPro test but it appears to be silently failing
2862 * & the best protection agains that is the functions this class affords
2864 function paymentProcessorCreate($params = array()) {
2865 $params = array_merge(array(
2867 'domain_id' => CRM_Core_Config
::domainID(),
2868 'payment_processor_type_id' => 'PayPal',
2872 'user_name' => 'sunil._1183377782_biz_api1.webaccess.co.in',
2873 'password' => '1183377788',
2874 'signature' => 'APixCoQ-Zsaj-u3IH7mD5Do-7HUqA9loGnLSzsZga9Zr-aNmaJa3WGPH',
2875 'url_site' => 'https://www.sandbox.paypal.com/',
2876 'url_api' => 'https://api-3t.sandbox.paypal.com/',
2877 'url_button' => 'https://www.paypal.com/en_US/i/btn/btn_xpressCheckout.gif',
2878 'class_name' => 'Payment_PayPalImpl',
2879 'billing_mode' => 3,
2880 'financial_type_id' => 1,
2883 if(!is_numeric($params['payment_processor_type_id'])) {
2884 // really the api should handle this through getoptions but it's not exactly api call so lets just sort it
2886 $params['payment_processor_type_id'] = $this->callAPISuccess('payment_processor_type', 'getvalue', array(
2887 'name' => $params['payment_processor_type_id'],
2891 $result = $this->callAPISuccess('payment_processor', 'create', $params);
2892 return $result['id'];
2900 */function CiviUnitTestCase_fatalErrorHandler($message) {
2901 throw new Exception("{$message['message']}: {$message['code']}");