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 class definitions
34 require_once 'api/api.php';
35 define('API_LATEST_VERSION', 3);
38 * Base class for CiviCRM unit tests
40 * This class supports two (mutually-exclusive) techniques for cleaning up test data. Subclasses
41 * may opt for one or neither:
43 * 1. quickCleanup() is a helper which truncates a series of tables. Call quickCleanup()
44 * as part of setUp() and/or tearDown(). quickCleanup() is thorough - but it can
45 * be cumbersome to use (b/c you must identify the tables to cleanup) and slow to execute.
46 * 2. useTransaction() executes the test inside a transaction. It's easier to use
47 * (because you don't need to identify specific tables), but it doesn't work for tests
48 * which manipulate schema or truncate data -- and could behave inconsistently
49 * for tests which specifically examine DB transactions.
51 * Common functions for unit tests
54 class CiviUnitTestCase
extends PHPUnit_Extensions_Database_TestCase
{
57 * Api version - easier to override than just a define
59 protected $_apiversion = API_LATEST_VERSION
;
61 * Database has been initialized.
65 private static $dbInit = FALSE;
68 * Database connection.
70 * @var PHPUnit_Extensions_Database_DB_IDatabaseConnection
79 static protected $_dbName;
82 * Track tables we have modified during a test.
84 protected $_tablesToTruncate = array();
87 * @var array of temporary directory names
92 * @var boolean populateOnce allows to skip db resets in setUp
94 * WARNING! USE WITH CAUTION - IT'LL RENDER DATA DEPENDENCIES
95 * BETWEEN TESTS WHEN RUN IN SUITE. SUITABLE FOR LOCAL, LIMITED
98 * IF POSSIBLE, USE $this->DBResetRequired = FALSE IN YOUR TEST CASE!
100 * see also: http://forum.civicrm.org/index.php/topic,18065.0.html
102 public static $populateOnce = FALSE;
105 * @var boolean DBResetRequired allows skipping DB reset
106 * in specific test case. If you still need
107 * to reset single test (method) of such case, call
108 * $this->cleanDB() in the first line of this
111 public $DBResetRequired = TRUE;
114 * @var CRM_Core_Transaction|NULL
119 * @var CRM_Utils_Hook_UnitTests hookClass
120 * example of setting a method for a hook
121 * $this->hookClass->setHook('civicrm_aclWhereClause', array($this, 'aclWhereHookAllResults'));
123 public $hookClass = NULL;
126 * @var array common values to be re-used multiple times within a class - usually to create the relevant entity
128 protected $_params = array();
131 * @var CRM_Extension_System
133 protected $origExtensionSystem;
136 * Array of IDs created during test setup routine.
138 * The cleanUpSetUpIds method can be used to clear these at the end of the test.
142 public $setupIDs = array();
147 * Because we are overriding the parent class constructor, we
148 * need to show the same arguments as exist in the constructor of
149 * PHPUnit_Framework_TestCase, since
150 * PHPUnit_Framework_TestSuite::createTest() creates a
151 * ReflectionClass of the Test class and checks the constructor
152 * of that class to decide how to set up the test.
154 * @param string $name
156 * @param string $dataName
158 public function __construct($name = NULL, array$data = array(), $dataName = '') {
159 parent
::__construct($name, $data, $dataName);
161 // we need full error reporting
162 error_reporting(E_ALL
& ~E_NOTICE
);
164 self
::$_dbName = self
::getDBName();
166 // also load the class loader
167 require_once 'CRM/Core/ClassLoader.php';
168 CRM_Core_ClassLoader
::singleton()->register();
169 if (function_exists('_civix_phpunit_setUp')) {
170 // FIXME: loosen coupling
171 _civix_phpunit_setUp();
176 * Override to run the test and assert its state.
179 * @throws \PHPUnit_Framework_IncompleteTest
180 * @throws \PHPUnit_Framework_SkippedTest
182 protected function runTest() {
184 return parent
::runTest();
186 catch (PEAR_Exception
$e) {
187 // PEAR_Exception has metadata in funny places, and PHPUnit won't log it nicely
188 throw new Exception(\CRM_Core_Error
::formatTextException($e), $e->getCode());
195 public function requireDBReset() {
196 return $this->DBResetRequired
;
202 public static function getDBName() {
203 static $dbName = NULL;
204 if ($dbName === NULL) {
205 require_once "DB.php";
206 $dsninfo = DB
::parseDSN(CIVICRM_DSN
);
207 $dbName = $dsninfo['database'];
213 * Create database connection for this instance.
215 * Initialize the test database if it hasn't been initialized
217 * @return PHPUnit_Extensions_Database_DB_IDatabaseConnection connection
219 protected function getConnection() {
220 $dbName = self
::$_dbName;
221 if (!self
::$dbInit) {
222 $dbName = self
::getDBName();
224 // install test database
225 echo PHP_EOL
. "Installing {$dbName} database" . PHP_EOL
;
227 static::_populateDB(FALSE, $this);
229 self
::$dbInit = TRUE;
232 return $this->createDefaultDBConnection(Civi\Test
::pdo(), $dbName);
236 * Required implementation of abstract method.
238 protected function getDataSet() {
242 * @param bool $perClass
243 * @param null $object
245 * TRUE if the populate logic runs; FALSE if it is skipped
247 protected static function _populateDB($perClass = FALSE, &$object = NULL) {
248 if (CIVICRM_UF
!== 'UnitTests') {
249 throw new \
RuntimeException("_populateDB requires CIVICRM_UF=UnitTests");
252 if ($perClass ||
$object == NULL) {
256 $dbreset = $object->requireDBReset();
259 if (self
::$populateOnce ||
!$dbreset) {
262 self
::$populateOnce = NULL;
264 Civi\Test
::data()->populate();
269 public static function setUpBeforeClass() {
270 static::_populateDB(TRUE);
272 // also set this global hack
273 $GLOBALS['_PEAR_ERRORSTACK_OVERRIDE_CALLBACK'] = array();
277 * Common setup functions for all unit tests.
279 protected function setUp() {
280 $session = CRM_Core_Session
::singleton();
281 $session->set('userID', NULL);
283 $this->errorScope
= CRM_Core_TemporaryErrorScope
::useException(); // REVERT
284 // Use a temporary file for STDIN
285 $GLOBALS['stdin'] = tmpfile();
286 if ($GLOBALS['stdin'] === FALSE) {
287 echo "Couldn't open temporary file\n";
291 // Get and save a connection to the database
292 $this->_dbconn
= $this->getConnection();
294 // reload database before each test
295 // $this->_populateDB();
297 // "initialize" CiviCRM to avoid problems when running single tests
298 // FIXME: look at it closer in second stage
300 $GLOBALS['civicrm_setting']['domain']['fatalErrorHandler'] = 'CiviUnitTestCase_fatalErrorHandler';
301 $GLOBALS['civicrm_setting']['domain']['backtrace'] = 1;
303 // disable any left-over test extensions
304 CRM_Core_DAO
::executeQuery('DELETE FROM civicrm_extension WHERE full_name LIKE "test.%"');
306 // reset all the caches
307 CRM_Utils_System
::flushCache();
309 // initialize the object once db is loaded
311 $config = CRM_Core_Config
::singleton(TRUE, TRUE); // ugh, performance
313 // when running unit tests, use mockup user framework
314 $this->hookClass
= CRM_Utils_Hook
::singleton();
316 // Make sure the DB connection is setup properly
317 $config->userSystem
->setMySQLTimeZone();
318 $env = new CRM_Utils_Check_Component_Env();
319 CRM_Utils_Check
::singleton()->assertValid($env->checkMysqlTime());
321 // clear permissions stub to not check permissions
322 $config->userPermissionClass
->permissions
= NULL;
324 //flush component settings
325 CRM_Core_Component
::getEnabledComponents(TRUE);
327 error_reporting(E_ALL
);
329 $this->_sethtmlGlobals();
333 * Read everything from the datasets directory and insert into the db.
335 public function loadAllFixtures() {
336 $fixturesDir = __DIR__
. '/../../fixtures';
338 $this->getConnection()->getConnection()->query("SET FOREIGN_KEY_CHECKS = 0;");
340 $xmlFiles = glob($fixturesDir . '/*.xml');
341 foreach ($xmlFiles as $xmlFixture) {
342 $op = new PHPUnit_Extensions_Database_Operation_Insert();
343 $dataset = $this->createXMLDataSet($xmlFixture);
344 $this->_tablesToTruncate
= array_merge($this->_tablesToTruncate
, $dataset->getTableNames());
345 $op->execute($this->_dbconn
, $dataset);
348 $yamlFiles = glob($fixturesDir . '/*.yaml');
349 foreach ($yamlFiles as $yamlFixture) {
350 $op = new PHPUnit_Extensions_Database_Operation_Insert();
351 $dataset = new PHPUnit_Extensions_Database_DataSet_YamlDataSet($yamlFixture);
352 $this->_tablesToTruncate
= array_merge($this->_tablesToTruncate
, $dataset->getTableNames());
353 $op->execute($this->_dbconn
, $dataset);
356 $this->getConnection()->getConnection()->query("SET FOREIGN_KEY_CHECKS = 1;");
360 * Emulate a logged in user since certain functions use that.
361 * value to store a record in the DB (like activity)
365 * Contact ID of the created user.
367 public function createLoggedInUser() {
369 'first_name' => 'Logged In',
370 'last_name' => 'User ' . rand(),
371 'contact_type' => 'Individual',
373 $contactID = $this->individualCreate($params);
374 $this->callAPISuccess('UFMatch', 'create', array(
375 'contact_id' => $contactID,
376 'uf_name' => 'superman',
380 $session = CRM_Core_Session
::singleton();
381 $session->set('userID', $contactID);
386 * Create default domain contacts for the two domains added during test class.
387 * database population.
389 public function createDomainContacts() {
390 $this->organizationCreate();
391 $this->organizationCreate(array('organization_name' => 'Second Domain'));
395 * Common teardown functions for all unit tests.
397 protected function tearDown() {
398 error_reporting(E_ALL
& ~E_NOTICE
);
399 CRM_Utils_Hook
::singleton()->reset();
400 $this->hookClass
->reset();
401 $session = CRM_Core_Session
::singleton();
402 $session->set('userID', NULL);
405 $this->tx
->rollback()->commit();
408 CRM_Core_Transaction
::forceRollbackIfEnabled();
409 \Civi\Core\Transaction\Manager
::singleton(TRUE);
412 CRM_Core_Transaction
::forceRollbackIfEnabled();
413 \Civi\Core\Transaction\Manager
::singleton(TRUE);
415 $tablesToTruncate = array('civicrm_contact', 'civicrm_uf_match');
416 $this->quickCleanup($tablesToTruncate);
417 $this->createDomainContacts();
420 $this->cleanTempDirs();
421 $this->unsetExtensionSystem();
425 * Generic function to compare expected values after an api call to retrieved.
428 * @daoName string DAO Name of object we're evaluating.
429 * @id int Id of object
430 * @match array Associative array of field name => expected value. Empty if asserting
431 * that a DELETE occurred
432 * @delete boolean True if we're checking that a DELETE action occurred.
436 * @param bool $delete
437 * @throws \PHPUnit_Framework_AssertionFailedError
439 public function assertDBState($daoName, $id, $match, $delete = FALSE) {
441 // adding this here since developers forget to check for an id
442 // and hence we get the first value in the db
443 $this->fail('ID not populated. Please fix your assertDBState usage!!!');
446 $object = new $daoName();
450 // If we're asserting successful record deletion, make sure object is NOT found.
452 if ($object->find(TRUE)) {
453 $this->fail("Object not deleted by delete operation: $daoName, $id");
458 // Otherwise check matches of DAO field values against expected values in $match.
459 if ($object->find(TRUE)) {
460 $fields = &$object->fields();
461 foreach ($fields as $name => $value) {
462 $dbName = $value['name'];
463 if (isset($match[$name])) {
465 $this->assertEquals($object->$dbName, $match[$name]);
467 elseif (isset($match[$dbName])) {
469 $this->assertEquals($object->$dbName, $match[$dbName]);
474 $this->fail("Could not retrieve object: $daoName, $id");
477 $matchSize = count($match);
478 if ($verifiedCount != $matchSize) {
479 $this->fail("Did not verify all fields in match array: $daoName, $id. Verified count = $verifiedCount. Match array size = $matchSize");
484 * Request a record from the DB by seachColumn+searchValue. Success if a record is found.
485 * @param string $daoName
486 * @param $searchValue
487 * @param $returnColumn
488 * @param $searchColumn
491 * @return null|string
492 * @throws PHPUnit_Framework_AssertionFailedError
494 public function assertDBNotNull($daoName, $searchValue, $returnColumn, $searchColumn, $message) {
495 if (empty($searchValue)) {
496 $this->fail("empty value passed to assertDBNotNull");
498 $value = CRM_Core_DAO
::getFieldValue($daoName, $searchValue, $returnColumn, $searchColumn, TRUE);
499 $this->assertNotNull($value, $message);
505 * Request a record from the DB by seachColumn+searchValue. Success if returnColumn value is NULL.
506 * @param string $daoName
507 * @param $searchValue
508 * @param $returnColumn
509 * @param $searchColumn
512 public function assertDBNull($daoName, $searchValue, $returnColumn, $searchColumn, $message) {
513 $value = CRM_Core_DAO
::getFieldValue($daoName, $searchValue, $returnColumn, $searchColumn, TRUE);
514 $this->assertNull($value, $message);
518 * Request a record from the DB by id. Success if row not found.
519 * @param string $daoName
521 * @param null $message
523 public function assertDBRowNotExist($daoName, $id, $message = NULL) {
524 $message = $message ?
$message : "$daoName (#$id) should not exist";
525 $value = CRM_Core_DAO
::getFieldValue($daoName, $id, 'id', 'id', TRUE);
526 $this->assertNull($value, $message);
530 * Request a record from the DB by id. Success if row not found.
531 * @param string $daoName
533 * @param null $message
535 public function assertDBRowExist($daoName, $id, $message = NULL) {
536 $message = $message ?
$message : "$daoName (#$id) should exist";
537 $value = CRM_Core_DAO
::getFieldValue($daoName, $id, 'id', 'id', TRUE);
538 $this->assertEquals($id, $value, $message);
542 * Compare a single column value in a retrieved DB record to an expected value.
543 * @param string $daoName
544 * @param $searchValue
545 * @param $returnColumn
546 * @param $searchColumn
547 * @param $expectedValue
550 public function assertDBCompareValue(
551 $daoName, $searchValue, $returnColumn, $searchColumn,
552 $expectedValue, $message
554 $value = CRM_Core_DAO
::getFieldValue($daoName, $searchValue, $returnColumn, $searchColumn, TRUE);
555 $this->assertEquals($value, $expectedValue, $message);
559 * Compare all values in a single retrieved DB record to an array of expected values.
560 * @param string $daoName
561 * @param array $searchParams
562 * @param $expectedValues
564 public function assertDBCompareValues($daoName, $searchParams, $expectedValues) {
565 //get the values from db
567 CRM_Core_DAO
::commonRetrieve($daoName, $searchParams, $dbValues);
569 // compare db values with expected values
570 self
::assertAttributesEquals($expectedValues, $dbValues);
574 * Assert that a SQL query returns a given value.
576 * The first argument is an expected value. The remaining arguments are passed
577 * to CRM_Core_DAO::singleValueQuery
579 * Example: $this->assertSql(2, 'select count(*) from foo where foo.bar like "%1"',
580 * array(1 => array("Whiz", "String")));
583 * @param array $params
584 * @param string $message
586 public function assertDBQuery($expected, $query, $params = array(), $message = '') {
590 $actual = CRM_Core_DAO
::singleValueQuery($query, $params);
591 $this->assertEquals($expected, $actual,
592 sprintf('%sexpected=[%s] actual=[%s] query=[%s]',
593 $message, $expected, $actual, CRM_Core_DAO
::composeQuery($query, $params, FALSE)
599 * Assert that two array-trees are exactly equal, notwithstanding
600 * the sorting of keys
602 * @param array $expected
603 * @param array $actual
605 public function assertTreeEquals($expected, $actual) {
608 CRM_Utils_Array
::flatten($expected, $e, '', ':::');
609 CRM_Utils_Array
::flatten($actual, $a, '', ':::');
613 $this->assertEquals($e, $a);
617 * Assert that two numbers are approximately equal.
619 * @param int|float $expected
620 * @param int|float $actual
621 * @param int|float $tolerance
622 * @param string $message
624 public function assertApproxEquals($expected, $actual, $tolerance, $message = NULL) {
625 if ($message === NULL) {
626 $message = sprintf("approx-equals: expected=[%.3f] actual=[%.3f] tolerance=[%.3f]", $expected, $actual, $tolerance);
628 $this->assertTrue(abs($actual - $expected) < $tolerance, $message);
632 * Assert attributes are equal.
634 * @param $expectedValues
635 * @param $actualValues
636 * @param string $message
638 * @throws PHPUnit_Framework_AssertionFailedError
640 public function assertAttributesEquals($expectedValues, $actualValues, $message = NULL) {
641 foreach ($expectedValues as $paramName => $paramValue) {
642 if (isset($actualValues[$paramName])) {
643 $this->assertEquals($paramValue, $actualValues[$paramName], "Value Mismatch On $paramName - value 1 is " . print_r($paramValue, TRUE) . " value 2 is " . print_r($actualValues[$paramName], TRUE));
646 $this->assertNull($expectedValues[$paramName], "Attribute '$paramName' not present in actual array and we expected it to be " . $expectedValues[$paramName]);
655 public function assertArrayKeyExists($key, &$list) {
656 $result = isset($list[$key]) ?
TRUE : FALSE;
657 $this->assertTrue($result, ts("%1 element exists?",
666 public function assertArrayValueNotNull($key, &$list) {
667 $this->assertArrayKeyExists($key, $list);
669 $value = isset($list[$key]) ?
$list[$key] : NULL;
670 $this->assertTrue($value,
671 ts("%1 element not null?",
678 * Check that api returned 'is_error' => 0.
680 * @param array $apiResult
682 * @param string $prefix
683 * Extra test to add to message.
685 public function assertAPISuccess($apiResult, $prefix = '') {
686 if (!empty($prefix)) {
689 $errorMessage = empty($apiResult['error_message']) ?
'' : " " . $apiResult['error_message'];
691 if (!empty($apiResult['debug_information'])) {
692 $errorMessage .= "\n " . print_r($apiResult['debug_information'], TRUE);
694 if (!empty($apiResult['trace'])) {
695 $errorMessage .= "\n" . print_r($apiResult['trace'], TRUE);
697 $this->assertEquals(0, $apiResult['is_error'], $prefix . $errorMessage);
701 * Check that api returned 'is_error' => 1.
703 * @param array $apiResult
705 * @param string $prefix
706 * Extra test to add to message.
707 * @param null $expectedError
709 public function assertAPIFailure($apiResult, $prefix = '', $expectedError = NULL) {
710 if (!empty($prefix)) {
713 if ($expectedError && !empty($apiResult['is_error'])) {
714 $this->assertEquals($expectedError, $apiResult['error_message'], 'api error message not as expected' . $prefix);
716 $this->assertEquals(1, $apiResult['is_error'], "api call should have failed but it succeeded " . $prefix . (print_r($apiResult, TRUE)));
717 $this->assertNotEmpty($apiResult['error_message']);
723 * @param string $message
725 public function assertType($expected, $actual, $message = '') {
726 return $this->assertInternalType($expected, $actual, $message);
730 * Check that a deleted item has been deleted.
735 public function assertAPIDeleted($entity, $id) {
736 $this->callAPISuccess($entity, 'getcount', array('id' => $id), 0);
741 * Check that api returned 'is_error' => 1
742 * else provide full message
743 * @param array $result
745 * @param array $valuesToExclude
746 * @param string $prefix
747 * Extra test to add to message.
749 public function assertAPIArrayComparison($result, $expected, $valuesToExclude = array(), $prefix = '') {
750 $valuesToExclude = array_merge($valuesToExclude, array('debug', 'xdebug', 'sequential'));
751 foreach ($valuesToExclude as $value) {
752 if (isset($result[$value])) {
753 unset($result[$value]);
755 if (isset($expected[$value])) {
756 unset($expected[$value]);
759 $this->assertEquals($result, $expected, "api result array comparison failed " . $prefix . print_r($result, TRUE) . ' was compared to ' . print_r($expected, TRUE));
763 * A stub for the API interface. This can be overriden by subclasses to change how the API is called.
767 * @param array $params
770 public function civicrm_api($entity, $action, $params) {
771 return civicrm_api($entity, $action, $params);
775 * Create a batch of external API calls which can
776 * be executed concurrently.
779 * $calls = $this->createExternalAPI()
780 * ->addCall('Contact', 'get', ...)
781 * ->addCall('Contact', 'get', ...)
787 * @return \Civi\API\ExternalBatch
788 * @throws PHPUnit_Framework_SkippedTestError
790 public function createExternalAPI() {
791 global $civicrm_root;
792 $defaultParams = array(
793 'version' => $this->_apiversion
,
797 $calls = new \Civi\API\
ExternalBatch($defaultParams);
799 if (!$calls->isSupported()) {
800 $this->markTestSkipped('The test relies on Civi\API\ExternalBatch. This is unsupported in the local environment.');
807 * wrap api functions.
808 * so we can ensure they succeed & throw exceptions without litterering the test with checks
810 * @param string $entity
811 * @param string $action
812 * @param array $params
813 * @param mixed $checkAgainst
814 * Optional value to check result against, implemented for getvalue,.
815 * getcount, getsingle. Note that for getvalue the type is checked rather than the value
816 * for getsingle the array is compared against an array passed in - the id is not compared (for
821 public function callAPISuccess($entity, $action, $params, $checkAgainst = NULL) {
822 $params = array_merge(array(
823 'version' => $this->_apiversion
,
828 switch (strtolower($action)) {
830 return $this->callAPISuccessGetValue($entity, $params, $checkAgainst);
833 return $this->callAPISuccessGetSingle($entity, $params, $checkAgainst);
836 return $this->callAPISuccessGetCount($entity, $params, $checkAgainst);
838 $result = $this->civicrm_api($entity, $action, $params);
839 $this->assertAPISuccess($result, "Failure in api call for $entity $action");
844 * This function exists to wrap api getValue function & check the result
845 * so we can ensure they succeed & throw exceptions without litterering the test with checks
846 * There is a type check in this
848 * @param string $entity
849 * @param array $params
850 * @param string $type
851 * Per http://php.net/manual/en/function.gettype.php possible types.
861 public function callAPISuccessGetValue($entity, $params, $type = NULL) {
863 'version' => $this->_apiversion
,
866 $result = $this->civicrm_api($entity, 'getvalue', $params);
868 if ($type == 'integer') {
869 // api seems to return integers as strings
870 $this->assertTrue(is_numeric($result), "expected a numeric value but got " . print_r($result, 1));
873 $this->assertType($type, $result, "returned result should have been of type $type but was ");
880 * This function exists to wrap api getsingle function & check the result
881 * so we can ensure they succeed & throw exceptions without litterering the test with checks
883 * @param string $entity
884 * @param array $params
885 * @param array $checkAgainst
886 * Array to compare result against.
897 public function callAPISuccessGetSingle($entity, $params, $checkAgainst = NULL) {
899 'version' => $this->_apiversion
,
902 $result = $this->civicrm_api($entity, 'getsingle', $params);
903 if (!is_array($result) ||
!empty($result['is_error']) ||
isset($result['values'])) {
904 throw new Exception('Invalid getsingle result' . print_r($result, TRUE));
907 // @todo - have gone with the fn that unsets id? should we check id?
908 $this->checkArrayEquals($result, $checkAgainst);
914 * This function exists to wrap api getValue function & check the result
915 * so we can ensure they succeed & throw exceptions without litterering the test with checks
916 * There is a type check in this
917 * @param string $entity
918 * @param array $params
923 public function callAPISuccessGetCount($entity, $params, $count = NULL) {
925 'version' => $this->_apiversion
,
928 $result = $this->civicrm_api($entity, 'getcount', $params);
929 if (!is_int($result) ||
!empty($result['is_error']) ||
isset($result['values'])) {
930 throw new Exception('Invalid getcount result : ' . print_r($result, TRUE) . " type :" . gettype($result));
932 if (is_int($count)) {
933 $this->assertEquals($count, $result, "incorrect count returned from $entity getcount");
939 * This function exists to wrap api functions.
940 * so we can ensure they succeed, generate and example & throw exceptions without litterering the test with checks
942 * @param string $entity
943 * @param string $action
944 * @param array $params
945 * @param string $function
946 * Pass this in to create a generated example.
947 * @param string $file
948 * Pass this in to create a generated example.
949 * @param string $description
950 * @param string|null $exampleName
954 public function callAPIAndDocument($entity, $action, $params, $function, $file, $description = "", $exampleName = NULL) {
955 $params['version'] = $this->_apiversion
;
956 $result = $this->callAPISuccess($entity, $action, $params);
957 $this->documentMe($entity, $action, $params, $result, $function, $file, $description, $exampleName);
962 * This function exists to wrap api functions.
963 * so we can ensure they fail where expected & throw exceptions without litterering the test with checks
964 * @param string $entity
965 * @param string $action
966 * @param array $params
967 * @param string $expectedErrorMessage
969 * @param null $extraOutput
972 public function callAPIFailure($entity, $action, $params, $expectedErrorMessage = NULL, $extraOutput = NULL) {
973 if (is_array($params)) {
975 'version' => $this->_apiversion
,
978 $result = $this->civicrm_api($entity, $action, $params);
979 $this->assertAPIFailure($result, "We expected a failure for $entity $action but got a success", $expectedErrorMessage);
984 * Create required data based on $this->entity & $this->params
985 * This is just a way to set up the test data for delete & get functions
986 * so the distinction between set
987 * up & tested functions is clearer
992 public function createTestEntity() {
993 return $entity = $this->callAPISuccess($this->entity
, 'create', $this->params
);
997 * Generic function to create Organisation, to be used in test cases
999 * @param array $params
1000 * parameters for civicrm_contact_add api function call
1002 * sequence number if creating multiple organizations
1005 * id of Organisation created
1007 public function organizationCreate($params = array(), $seq = 0) {
1011 $params = array_merge($this->sampleContact('Organization', $seq), $params);
1012 return $this->_contactCreate($params);
1016 * Generic function to create Individual, to be used in test cases
1018 * @param array $params
1019 * parameters for civicrm_contact_add api function call
1021 * sequence number if creating multiple individuals
1024 * id of Individual created
1026 public function individualCreate($params = array(), $seq = 0) {
1027 $params = array_merge($this->sampleContact('Individual', $seq), $params);
1028 return $this->_contactCreate($params);
1032 * Generic function to create Household, to be used in test cases
1034 * @param array $params
1035 * parameters for civicrm_contact_add api function call
1037 * sequence number if creating multiple households
1040 * id of Household created
1042 public function householdCreate($params = array(), $seq = 0) {
1043 $params = array_merge($this->sampleContact('Household', $seq), $params);
1044 return $this->_contactCreate($params);
1048 * Helper function for getting sample contact properties.
1050 * @param string $contact_type
1051 * enum contact type: Individual, Organization
1053 * sequence number for the values of this type
1056 * properties of sample contact (ie. $params for API call)
1058 public function sampleContact($contact_type, $seq = 0) {
1060 'Individual' => array(
1061 // The number of values in each list need to be coprime numbers to not have duplicates
1062 'first_name' => array('Anthony', 'Joe', 'Terrence', 'Lucie', 'Albert', 'Bill', 'Kim'),
1063 'middle_name' => array('J.', 'M.', 'P', 'L.', 'K.', 'A.', 'B.', 'C.', 'D', 'E.', 'Z.'),
1064 'last_name' => array('Anderson', 'Miller', 'Smith', 'Collins', 'Peterson'),
1066 'Organization' => array(
1067 'organization_name' => array(
1068 'Unit Test Organization',
1075 'Household' => array(
1076 'household_name' => array('Unit Test household'),
1079 $params = array('contact_type' => $contact_type);
1080 foreach ($samples[$contact_type] as $key => $values) {
1081 $params[$key] = $values[$seq %
count($values)];
1083 if ($contact_type == 'Individual') {
1084 $params['email'] = strtolower(
1085 $params['first_name'] . '_' . $params['last_name'] . '@civicrm.org'
1087 $params['prefix_id'] = 3;
1088 $params['suffix_id'] = 3;
1094 * Private helper function for calling civicrm_contact_add.
1096 * @param array $params
1097 * For civicrm_contact_add api function call.
1102 * id of Household created
1104 private function _contactCreate($params) {
1105 $result = $this->callAPISuccess('contact', 'create', $params);
1106 if (!empty($result['is_error']) ||
empty($result['id'])) {
1107 throw new Exception('Could not create test contact, with message: ' . CRM_Utils_Array
::value('error_message', $result) . "\nBacktrace:" . CRM_Utils_Array
::value('trace', $result));
1109 return $result['id'];
1113 * Delete contact, ensuring it is not the domain contact
1115 * @param int $contactID
1116 * Contact ID to delete
1118 public function contactDelete($contactID) {
1119 $domain = new CRM_Core_BAO_Domain();
1120 $domain->contact_id
= $contactID;
1121 if (!$domain->find(TRUE)) {
1122 $this->callAPISuccess('contact', 'delete', array(
1124 'skip_undelete' => 1,
1130 * @param int $contactTypeId
1134 public function contactTypeDelete($contactTypeId) {
1135 $result = CRM_Contact_BAO_ContactType
::del($contactTypeId);
1137 throw new Exception('Could not delete contact type');
1142 * @param array $params
1146 public function membershipTypeCreate($params = array()) {
1147 CRM_Member_PseudoConstant
::flush('membershipType');
1148 CRM_Core_Config
::clearDBCache();
1149 $this->setupIDs
['contact'] = $memberOfOrganization = $this->organizationCreate();
1150 $params = array_merge(array(
1151 'name' => 'General',
1152 'duration_unit' => 'year',
1153 'duration_interval' => 1,
1154 'period_type' => 'rolling',
1155 'member_of_contact_id' => $memberOfOrganization,
1157 'financial_type_id' => 2,
1160 'visibility' => 'Public',
1163 $result = $this->callAPISuccess('MembershipType', 'Create', $params);
1165 CRM_Member_PseudoConstant
::flush('membershipType');
1166 CRM_Utils_Cache
::singleton()->flush();
1168 return $result['id'];
1172 * @param array $params
1176 public function contactMembershipCreate($params) {
1177 $params = array_merge(array(
1178 'join_date' => '2007-01-21',
1179 'start_date' => '2007-01-21',
1180 'end_date' => '2007-12-21',
1181 'source' => 'Payment',
1182 'membership_type_id' => 'General',
1184 if (!is_numeric($params['membership_type_id'])) {
1185 $membershipTypes = $this->callAPISuccess('Membership', 'getoptions', array('action' => 'create', 'field' => 'membership_type_id'));
1186 if (!in_array($params['membership_type_id'], $membershipTypes['values'])) {
1187 $this->membershipTypeCreate(array('name' => $params['membership_type_id']));
1191 $result = $this->callAPISuccess('Membership', 'create', $params);
1192 return $result['id'];
1196 * Delete Membership Type.
1198 * @param array $params
1200 public function membershipTypeDelete($params) {
1201 $this->callAPISuccess('MembershipType', 'Delete', $params);
1205 * @param int $membershipID
1207 public function membershipDelete($membershipID) {
1208 $deleteParams = array('id' => $membershipID);
1209 $result = $this->callAPISuccess('Membership', 'Delete', $deleteParams);
1213 * @param string $name
1217 public function membershipStatusCreate($name = 'test member status') {
1218 $params['name'] = $name;
1219 $params['start_event'] = 'start_date';
1220 $params['end_event'] = 'end_date';
1221 $params['is_current_member'] = 1;
1222 $params['is_active'] = 1;
1224 $result = $this->callAPISuccess('MembershipStatus', 'Create', $params);
1225 CRM_Member_PseudoConstant
::flush('membershipStatus');
1226 return $result['id'];
1230 * @param int $membershipStatusID
1232 public function membershipStatusDelete($membershipStatusID) {
1233 if (!$membershipStatusID) {
1236 $result = $this->callAPISuccess('MembershipStatus', 'Delete', array('id' => $membershipStatusID));
1240 * @param array $params
1244 public function relationshipTypeCreate($params = array()) {
1245 $params = array_merge(array(
1246 'name_a_b' => 'Relation 1 for relationship type create',
1247 'name_b_a' => 'Relation 2 for relationship type create',
1248 'contact_type_a' => 'Individual',
1249 'contact_type_b' => 'Organization',
1256 $result = $this->callAPISuccess('relationship_type', 'create', $params);
1257 CRM_Core_PseudoConstant
::flush('relationshipType');
1259 return $result['id'];
1263 * Delete Relatinship Type.
1265 * @param int $relationshipTypeID
1267 public function relationshipTypeDelete($relationshipTypeID) {
1268 $params['id'] = $relationshipTypeID;
1269 $check = $this->callAPISuccess('relationship_type', 'get', $params);
1270 if (!empty($check['count'])) {
1271 $this->callAPISuccess('relationship_type', 'delete', $params);
1276 * @param array $params
1280 public function paymentProcessorTypeCreate($params = NULL) {
1281 if (is_null($params)) {
1283 'name' => 'API_Test_PP',
1284 'title' => 'API Test Payment Processor',
1285 'class_name' => 'CRM_Core_Payment_APITest',
1286 'billing_mode' => 'form',
1292 $result = $this->callAPISuccess('payment_processor_type', 'create', $params);
1294 CRM_Core_PseudoConstant
::flush('paymentProcessorType');
1296 return $result['id'];
1300 * Create test Authorize.net instance.
1302 * @param array $params
1306 public function paymentProcessorAuthorizeNetCreate($params = array()) {
1307 $params = array_merge(array(
1308 'name' => 'Authorize',
1309 'domain_id' => CRM_Core_Config
::domainID(),
1310 'payment_processor_type_id' => 'AuthNet',
1311 'title' => 'AuthNet',
1316 'user_name' => '4y5BfuW7jm',
1317 'password' => '4cAmW927n8uLf5J8',
1318 'url_site' => 'https://test.authorize.net/gateway/transact.dll',
1319 'url_recur' => 'https://apitest.authorize.net/xml/v1/request.api',
1320 'class_name' => 'Payment_AuthorizeNet',
1321 'billing_mode' => 1,
1324 $result = $this->callAPISuccess('PaymentProcessor', 'create', $params);
1325 return $result['id'];
1329 * Create Participant.
1331 * @param array $params
1332 * Array of contact id and event id values.
1335 * $id of participant created
1337 public function participantCreate($params) {
1338 if (empty($params['contact_id'])) {
1339 $params['contact_id'] = $this->individualCreate();
1341 if (empty($params['event_id'])) {
1342 $event = $this->eventCreate();
1343 $params['event_id'] = $event['id'];
1348 'register_date' => 20070219,
1349 'source' => 'Wimbeldon',
1350 'event_level' => 'Payment',
1354 $params = array_merge($defaults, $params);
1355 $result = $this->callAPISuccess('Participant', 'create', $params);
1356 return $result['id'];
1360 * Create Payment Processor.
1363 * Id Payment Processor
1365 public function processorCreate($params = array()) {
1366 $processorParams = array(
1369 'payment_processor_type_id' => 'Dummy',
1370 'financial_account_id' => 12,
1374 'url_site' => 'http://dummy.com',
1375 'url_recur' => 'http://dummy.com',
1376 'billing_mode' => 1,
1378 'payment_instrument_id' => 'Debit Card',
1380 $processorParams = array_merge($processorParams, $params);
1381 $processor = $this->callAPISuccess('PaymentProcessor', 'create', $processorParams);
1382 return $processor['id'];
1386 * Create Payment Processor.
1388 * @param array $processorParams
1390 * @return \CRM_Core_Payment_Dummy
1391 * Instance of Dummy Payment Processor
1393 public function dummyProcessorCreate($processorParams = array()) {
1394 $paymentProcessorID = $this->processorCreate($processorParams);
1395 return System
::singleton()->getById($paymentProcessorID);
1399 * Create contribution page.
1401 * @param array $params
1403 * Array of contribution page
1405 public function contributionPageCreate($params = array()) {
1406 $this->_pageParams
= array_merge(array(
1407 'title' => 'Test Contribution Page',
1408 'financial_type_id' => 1,
1409 'currency' => 'USD',
1410 'financial_account_id' => 1,
1412 'is_allow_other_amount' => 1,
1414 'max_amount' => 1000,
1416 return $this->callAPISuccess('contribution_page', 'create', $this->_pageParams
);
1420 * Create a sample batch.
1422 public function batchCreate() {
1423 $params = $this->_params
;
1424 $params['name'] = $params['title'] = 'Batch_433397';
1425 $params['status_id'] = 1;
1426 $result = $this->callAPISuccess('batch', 'create', $params);
1427 return $result['id'];
1433 * @param array $params
1435 * result of created tag
1437 public function tagCreate($params = array()) {
1439 'name' => 'New Tag3',
1440 'description' => 'This is description for Our New Tag ',
1443 $params = array_merge($defaults, $params);
1444 $result = $this->callAPISuccess('Tag', 'create', $params);
1445 return $result['values'][$result['id']];
1452 * Id of the tag to be deleted.
1456 public function tagDelete($tagId) {
1457 require_once 'api/api.php';
1461 $result = $this->callAPISuccess('Tag', 'delete', $params);
1462 return $result['id'];
1466 * Add entity(s) to the tag
1468 * @param array $params
1472 public function entityTagAdd($params) {
1473 $result = $this->callAPISuccess('entity_tag', 'create', $params);
1480 * @param array $params
1484 * id of created pledge
1486 public function pledgeCreate($params) {
1487 $params = array_merge(array(
1488 'pledge_create_date' => date('Ymd'),
1489 'start_date' => date('Ymd'),
1490 'scheduled_date' => date('Ymd'),
1492 'pledge_status_id' => '2',
1493 'financial_type_id' => '1',
1494 'pledge_original_installment_amount' => 20,
1495 'frequency_interval' => 5,
1496 'frequency_unit' => 'year',
1497 'frequency_day' => 15,
1498 'installments' => 5,
1502 $result = $this->callAPISuccess('Pledge', 'create', $params);
1503 return $result['id'];
1507 * Delete contribution.
1509 * @param int $pledgeId
1511 public function pledgeDelete($pledgeId) {
1513 'pledge_id' => $pledgeId,
1515 $this->callAPISuccess('Pledge', 'delete', $params);
1519 * Create contribution.
1521 * @param array $params
1522 * Array of parameters.
1525 * id of created contribution
1527 public function contributionCreate($params) {
1529 $params = array_merge(array(
1531 'receive_date' => date('Ymd'),
1532 'total_amount' => 100.00,
1533 'fee_amount' => 5.00,
1534 'financial_type_id' => 1,
1535 'payment_instrument_id' => 1,
1536 'non_deductible_amount' => 10.00,
1538 'invoice_id' => 67890,
1540 'contribution_status_id' => 1,
1543 $result = $this->callAPISuccess('contribution', 'create', $params);
1544 return $result['id'];
1548 * Delete contribution.
1550 * @param int $contributionId
1554 public function contributionDelete($contributionId) {
1556 'contribution_id' => $contributionId,
1558 $result = $this->callAPISuccess('contribution', 'delete', $params);
1565 * @param array $params
1566 * Name-value pair for an event.
1570 public function eventCreate($params = array()) {
1571 // if no contact was passed, make up a dummy event creator
1572 if (!isset($params['contact_id'])) {
1573 $params['contact_id'] = $this->_contactCreate(array(
1574 'contact_type' => 'Individual',
1575 'first_name' => 'Event',
1576 'last_name' => 'Creator',
1580 // set defaults for missing params
1581 $params = array_merge(array(
1582 'title' => 'Annual CiviCRM meet',
1583 'summary' => 'If you have any CiviCRM related issues or want to track where CiviCRM is heading, Sign up now',
1584 'description' => 'This event is intended to give brief idea about progess of CiviCRM and giving solutions to common user issues',
1585 'event_type_id' => 1,
1587 'start_date' => 20081021,
1588 'end_date' => 20081023,
1589 'is_online_registration' => 1,
1590 'registration_start_date' => 20080601,
1591 'registration_end_date' => 20081015,
1592 'max_participants' => 100,
1593 'event_full_text' => 'Sorry! We are already full',
1596 'is_show_location' => 0,
1599 return $this->callAPISuccess('Event', 'create', $params);
1610 public function eventDelete($id) {
1614 return $this->callAPISuccess('event', 'delete', $params);
1618 * Delete participant.
1620 * @param int $participantID
1624 public function participantDelete($participantID) {
1626 'id' => $participantID,
1628 $check = $this->callAPISuccess('Participant', 'get', $params);
1629 if ($check['count'] > 0) {
1630 return $this->callAPISuccess('Participant', 'delete', $params);
1635 * Create participant payment.
1637 * @param int $participantID
1638 * @param int $contributionID
1640 * $id of created payment
1642 public function participantPaymentCreate($participantID, $contributionID = NULL) {
1643 //Create Participant Payment record With Values
1645 'participant_id' => $participantID,
1646 'contribution_id' => $contributionID,
1649 $result = $this->callAPISuccess('participant_payment', 'create', $params);
1650 return $result['id'];
1654 * Delete participant payment.
1656 * @param int $paymentID
1658 public function participantPaymentDelete($paymentID) {
1662 $result = $this->callAPISuccess('participant_payment', 'delete', $params);
1668 * @param int $contactID
1670 * location id of created location
1672 public function locationAdd($contactID) {
1675 'location_type' => 'New Location Type',
1677 'name' => 'Saint Helier St',
1678 'county' => 'Marin',
1679 'country' => 'UNITED STATES',
1680 'state_province' => 'Michigan',
1681 'supplemental_address_1' => 'Hallmark Ct',
1682 'supplemental_address_2' => 'Jersey Village',
1683 'supplemental_address_3' => 'My Town',
1688 'contact_id' => $contactID,
1689 'address' => $address,
1690 'location_format' => '2.0',
1691 'location_type' => 'New Location Type',
1694 $result = $this->callAPISuccess('Location', 'create', $params);
1699 * Delete Locations of contact.
1701 * @param array $params
1704 public function locationDelete($params) {
1705 $this->callAPISuccess('Location', 'delete', $params);
1709 * Add a Location Type.
1711 * @param array $params
1712 * @return CRM_Core_DAO_LocationType
1713 * location id of created location
1715 public function locationTypeCreate($params = NULL) {
1716 if ($params === NULL) {
1718 'name' => 'New Location Type',
1719 'vcard_name' => 'New Location Type',
1720 'description' => 'Location Type for Delete',
1725 $locationType = new CRM_Core_DAO_LocationType();
1726 $locationType->copyValues($params);
1727 $locationType->save();
1728 // clear getfields cache
1729 CRM_Core_PseudoConstant
::flush();
1730 $this->callAPISuccess('phone', 'getfields', array('version' => 3, 'cache_clear' => 1));
1731 return $locationType;
1735 * Delete a Location Type.
1737 * @param int $locationTypeId
1739 public function locationTypeDelete($locationTypeId) {
1740 $locationType = new CRM_Core_DAO_LocationType();
1741 $locationType->id
= $locationTypeId;
1742 $locationType->delete();
1748 * @param array $params
1749 * @return CRM_Core_DAO_Mapping
1750 * Mapping id of created mapping
1752 public function mappingCreate($params = NULL) {
1753 if ($params === NULL) {
1755 'name' => 'Mapping name',
1756 'description' => 'Mapping description',
1757 // 'Export Contact' mapping.
1758 'mapping_type_id' => 7,
1762 $mapping = new CRM_Core_DAO_Mapping();
1763 $mapping->copyValues($params);
1765 // clear getfields cache
1766 CRM_Core_PseudoConstant
::flush();
1767 $this->callAPISuccess('mapping', 'getfields', array('version' => 3, 'cache_clear' => 1));
1774 * @param int $mappingId
1776 public function mappingDelete($mappingId) {
1777 $mapping = new CRM_Core_DAO_Mapping();
1778 $mapping->id
= $mappingId;
1785 * @param array $params
1787 * groupId of created group
1789 public function groupCreate($params = array()) {
1790 $params = array_merge(array(
1791 'name' => 'Test Group 1',
1793 'title' => 'New Test Group Created',
1794 'description' => 'New Test Group Created',
1796 'visibility' => 'Public Pages',
1797 'group_type' => array(
1803 $result = $this->callAPISuccess('Group', 'create', $params);
1804 return $result['id'];
1808 * Create a smart group.
1810 * By default it will be a group of households.
1812 * @param array $smartGroupParams
1813 * @param array $groupParams
1816 public function smartGroupCreate($smartGroupParams = array(), $groupParams = array()) {
1817 $smartGroupParams = array_merge(array(
1818 'formValues' => array('contact_type' => array('IN' => array('Household'))),
1821 $savedSearch = CRM_Contact_BAO_SavedSearch
::create($smartGroupParams);
1823 $groupParams['saved_search_id'] = $savedSearch->id
;
1824 return $this->groupCreate($groupParams);
1828 * Function to add a Group.
1830 * @params array to add group
1832 * @param int $groupID
1833 * @param int $totalCount
1835 * groupId of created group
1837 public function groupContactCreate($groupID, $totalCount = 10) {
1838 $params = array('group_id' => $groupID);
1839 for ($i = 1; $i <= $totalCount; $i++
) {
1840 $contactID = $this->individualCreate();
1842 $params +
= array('contact_id' => $contactID);
1845 $params +
= array("contact_id.$i" => $contactID);
1848 $result = $this->callAPISuccess('GroupContact', 'create', $params);
1858 public function groupDelete($gid) {
1864 $this->callAPISuccess('Group', 'delete', $params);
1869 * @param array $params
1871 public function uFFieldCreate($params = array()) {
1872 $params = array_merge(array(
1874 'field_name' => 'first_name',
1877 'visibility' => 'Public Pages and Listings',
1878 'is_searchable' => '1',
1879 'label' => 'first_name',
1880 'field_type' => 'Individual',
1883 $this->callAPISuccess('uf_field', 'create', $params);
1887 * Add a UF Join Entry.
1889 * @param array $params
1891 * $id of created UF Join
1893 public function ufjoinCreate($params = NULL) {
1894 if ($params === NULL) {
1897 'module' => 'CiviEvent',
1898 'entity_table' => 'civicrm_event',
1904 $result = $this->callAPISuccess('uf_join', 'create', $params);
1909 * Delete a UF Join Entry.
1911 * @param array $params
1912 * with missing uf_group_id
1914 public function ufjoinDelete($params = NULL) {
1915 if ($params === NULL) {
1918 'module' => 'CiviEvent',
1919 'entity_table' => 'civicrm_event',
1922 'uf_group_id' => '',
1926 crm_add_uf_join($params);
1930 * @param array $params
1931 * Optional parameters.
1936 public function campaignCreate($params = array()) {
1937 $this->enableCiviCampaign();
1938 $campaign = $this->callAPISuccess('campaign', 'create', array_merge(array(
1939 'name' => 'big_campaign',
1940 'title' => 'Campaign',
1942 return $campaign['id'];
1946 * Create Group for a contact.
1948 * @param int $contactId
1950 public function contactGroupCreate($contactId) {
1952 'contact_id.1' => $contactId,
1956 $this->callAPISuccess('GroupContact', 'Create', $params);
1960 * Delete Group for a contact.
1962 * @param int $contactId
1964 public function contactGroupDelete($contactId) {
1966 'contact_id.1' => $contactId,
1969 $this->civicrm_api('GroupContact', 'Delete', $params);
1975 * @param array $params
1978 public function activityCreate($params = array()) {
1979 $params = array_merge(array(
1980 'subject' => 'Discussion on warm beer',
1981 'activity_date_time' => date('Ymd'),
1982 'duration_hours' => 30,
1983 'duration_minutes' => 20,
1984 'location' => 'Baker Street',
1985 'details' => 'Lets schedule a meeting',
1987 'activity_name' => 'Meeting',
1989 if (!isset($params['source_contact_id'])) {
1990 $params['source_contact_id'] = $this->individualCreate();
1992 if (!isset($params['target_contact_id'])) {
1993 $params['target_contact_id'] = $this->individualCreate(array(
1994 'first_name' => 'Julia',
1995 'Last_name' => 'Anderson',
1997 'email' => 'julia_anderson@civicrm.org',
1998 'contact_type' => 'Individual',
2001 if (!isset($params['assignee_contact_id'])) {
2002 $params['assignee_contact_id'] = $params['target_contact_id'];
2005 $result = $this->callAPISuccess('Activity', 'create', $params);
2007 $result['target_contact_id'] = $params['target_contact_id'];
2008 $result['assignee_contact_id'] = $params['assignee_contact_id'];
2013 * Create an activity type.
2015 * @param array $params
2019 public function activityTypeCreate($params) {
2020 return $this->callAPISuccess('ActivityType', 'create', $params);
2024 * Delete activity type.
2026 * @param int $activityTypeId
2027 * Id of the activity type.
2030 public function activityTypeDelete($activityTypeId) {
2031 $params['activity_type_id'] = $activityTypeId;
2032 return $this->callAPISuccess('ActivityType', 'delete', $params);
2036 * Create custom group.
2038 * @param array $params
2041 public function customGroupCreate($params = array()) {
2043 'title' => 'new custom group',
2044 'extends' => 'Contact',
2046 'style' => 'Inline',
2050 $params = array_merge($defaults, $params);
2052 if (strlen($params['title']) > 13) {
2053 $params['title'] = substr($params['title'], 0, 13);
2056 //have a crack @ deleting it first in the hope this will prevent derailing our tests
2057 $this->callAPISuccess('custom_group', 'get', array(
2058 'title' => $params['title'],
2059 array('api.custom_group.delete' => 1),
2062 return $this->callAPISuccess('custom_group', 'create', $params);
2066 * Existing function doesn't allow params to be over-ridden so need a new one
2067 * this one allows you to only pass in the params you want to change
2068 * @param array $params
2071 public function CustomGroupCreateByParams($params = array()) {
2073 'title' => "API Custom Group",
2074 'extends' => 'Contact',
2076 'style' => 'Inline',
2079 $params = array_merge($defaults, $params);
2080 return $this->callAPISuccess('custom_group', 'create', $params);
2084 * Create custom group with multi fields.
2085 * @param array $params
2088 public function CustomGroupMultipleCreateByParams($params = array()) {
2093 $params = array_merge($defaults, $params);
2094 return $this->CustomGroupCreateByParams($params);
2098 * Create custom group with multi fields.
2099 * @param array $params
2102 public function CustomGroupMultipleCreateWithFields($params = array()) {
2103 // also need to pass on $params['custom_field'] if not set but not in place yet
2105 $customGroup = $this->CustomGroupMultipleCreateByParams($params);
2106 $ids['custom_group_id'] = $customGroup['id'];
2108 $customField = $this->customFieldCreate(array(
2109 'custom_group_id' => $ids['custom_group_id'],
2110 'label' => 'field_1' . $ids['custom_group_id'],
2114 $ids['custom_field_id'][] = $customField['id'];
2116 $customField = $this->customFieldCreate(array(
2117 'custom_group_id' => $ids['custom_group_id'],
2118 'default_value' => '',
2119 'label' => 'field_2' . $ids['custom_group_id'],
2122 $ids['custom_field_id'][] = $customField['id'];
2124 $customField = $this->customFieldCreate(array(
2125 'custom_group_id' => $ids['custom_group_id'],
2126 'default_value' => '',
2127 'label' => 'field_3' . $ids['custom_group_id'],
2130 $ids['custom_field_id'][] = $customField['id'];
2136 * Create a custom group with a single text custom field. See
2137 * participant:testCreateWithCustom for how to use this
2139 * @param string $function
2141 * @param string $filename
2145 * ids of created objects
2147 public function entityCustomGroupWithSingleFieldCreate($function, $filename) {
2148 $params = array('title' => $function);
2149 $entity = substr(basename($filename), 0, strlen(basename($filename)) - 8);
2150 $params['extends'] = $entity ?
$entity : 'Contact';
2151 $customGroup = $this->CustomGroupCreate($params);
2152 $customField = $this->customFieldCreate(array('custom_group_id' => $customGroup['id'], 'label' => $function));
2153 CRM_Core_PseudoConstant
::flush();
2155 return array('custom_group_id' => $customGroup['id'], 'custom_field_id' => $customField['id']);
2159 * Delete custom group.
2161 * @param int $customGroupID
2165 public function customGroupDelete($customGroupID) {
2166 $params['id'] = $customGroupID;
2167 return $this->callAPISuccess('custom_group', 'delete', $params);
2171 * Create custom field.
2173 * @param array $params
2174 * (custom_group_id) is required.
2177 public function customFieldCreate($params) {
2178 $params = array_merge(array(
2179 'label' => 'Custom Field',
2180 'data_type' => 'String',
2181 'html_type' => 'Text',
2182 'is_searchable' => 1,
2184 'default_value' => 'defaultValue',
2187 $result = $this->callAPISuccess('custom_field', 'create', $params);
2188 // these 2 functions are called with force to flush static caches
2189 CRM_Core_BAO_CustomField
::getTableColumnGroup($result['id'], 1);
2190 CRM_Core_Component
::getEnabledComponents(1);
2195 * Delete custom field.
2197 * @param int $customFieldID
2201 public function customFieldDelete($customFieldID) {
2203 $params['id'] = $customFieldID;
2204 return $this->callAPISuccess('custom_field', 'delete', $params);
2213 public function noteCreate($cId) {
2215 'entity_table' => 'civicrm_contact',
2216 'entity_id' => $cId,
2217 'note' => 'hello I am testing Note',
2218 'contact_id' => $cId,
2219 'modified_date' => date('Ymd'),
2220 'subject' => 'Test Note',
2223 return $this->callAPISuccess('Note', 'create', $params);
2227 * Enable CiviCampaign Component.
2229 public function enableCiviCampaign() {
2230 CRM_Core_BAO_ConfigSetting
::enableComponent('CiviCampaign');
2231 // force reload of config object
2232 $config = CRM_Core_Config
::singleton(TRUE, TRUE);
2233 //flush cache by calling with reset
2234 $activityTypes = CRM_Core_PseudoConstant
::activityType(TRUE, TRUE, TRUE, 'name', TRUE);
2238 * Create test generated example in api/v3/examples.
2240 * To turn this off (e.g. on the server) set
2241 * define(DONT_DOCUMENT_TEST_CONFIG ,1);
2242 * in your settings file
2244 * @param string $entity
2245 * @param string $action
2246 * @param array $params
2247 * Array as passed to civicrm_api function.
2248 * @param array $result
2249 * Array as received from the civicrm_api function.
2250 * @param string $testFunction
2251 * Calling function - generally __FUNCTION__.
2252 * @param string $testFile
2253 * Called from file - generally __FILE__.
2254 * @param string $description
2255 * Descriptive text for the example file.
2256 * @param string $exampleName
2257 * Name for this example file (CamelCase) - if omitted the action name will be substituted.
2259 private function documentMe($entity, $action, $params, $result, $testFunction, $testFile, $description = "", $exampleName = NULL) {
2260 if (defined('DONT_DOCUMENT_TEST_CONFIG') && DONT_DOCUMENT_TEST_CONFIG
) {
2263 $entity = _civicrm_api_get_camel_name($entity);
2264 $action = strtolower($action);
2266 if (empty($exampleName)) {
2267 // Attempt to convert lowercase action name to CamelCase.
2268 // This is clunky/imperfect due to the convention of all lowercase actions.
2269 $exampleName = CRM_Utils_String
::convertStringToCamel($action);
2270 $knownPrefixes = array(
2277 foreach ($knownPrefixes as $prefix) {
2278 if (strpos($exampleName, $prefix) === 0 && $prefix != $exampleName) {
2279 $exampleName[strlen($prefix)] = strtoupper($exampleName[strlen($prefix)]);
2284 $this->tidyExampleResult($result);
2285 if (isset($params['version'])) {
2286 unset($params['version']);
2288 // Format multiline description as array
2290 if (is_string($description) && strlen($description)) {
2291 foreach (explode("\n", $description) as $line) {
2292 $desc[] = trim($line);
2295 $smarty = CRM_Core_Smarty
::singleton();
2296 $smarty->assign('testFunction', $testFunction);
2297 $smarty->assign('function', _civicrm_api_get_entity_name_from_camel($entity) . "_$action");
2298 foreach ($params as $index => $param) {
2299 if (is_string($param)) {
2300 $params[$index] = addslashes($param);
2303 $smarty->assign('params', $params);
2304 $smarty->assign('entity', $entity);
2305 $smarty->assign('testFile', basename($testFile));
2306 $smarty->assign('description', $desc);
2307 $smarty->assign('result', $result);
2308 $smarty->assign('action', $action);
2310 global $civicrm_root;
2311 if (file_exists($civicrm_root . '/tests/templates/documentFunction.tpl')) {
2312 if (!is_dir($civicrm_root . "/api/v3/examples/$entity")) {
2313 mkdir($civicrm_root . "/api/v3/examples/$entity");
2315 $f = fopen($civicrm_root . "/api/v3/examples/$entity/$exampleName.php", "w+b");
2316 fwrite($f, $smarty->fetch($civicrm_root . '/tests/templates/documentFunction.tpl'));
2322 * Tidy up examples array so that fields that change often ..don't
2323 * and debug related fields are unset
2325 * @param array $result
2327 public function tidyExampleResult(&$result) {
2328 if (!is_array($result)) {
2331 $fieldsToChange = array(
2332 'hash' => '67eac7789eaee00',
2333 'modified_date' => '2012-11-14 16:02:35',
2334 'created_date' => '2013-07-28 08:49:19',
2335 'create_date' => '20120130621222105',
2336 'application_received_date' => '20130728084957',
2337 'in_date' => '2013-07-28 08:50:19',
2338 'scheduled_date' => '20130728085413',
2339 'approval_date' => '20130728085413',
2340 'pledge_start_date_high' => '20130726090416',
2341 'start_date' => '2013-07-29 00:00:00',
2342 'event_start_date' => '2013-07-29 00:00:00',
2343 'end_date' => '2013-08-04 00:00:00',
2344 'event_end_date' => '2013-08-04 00:00:00',
2345 'decision_date' => '20130805000000',
2348 $keysToUnset = array('xdebug', 'undefined_fields');
2349 foreach ($keysToUnset as $unwantedKey) {
2350 if (isset($result[$unwantedKey])) {
2351 unset($result[$unwantedKey]);
2354 if (isset($result['values'])) {
2355 if (!is_array($result['values'])) {
2358 $resultArray = &$result['values'];
2360 elseif (is_array($result)) {
2361 $resultArray = &$result;
2367 foreach ($resultArray as $index => &$values) {
2368 if (!is_array($values)) {
2371 foreach ($values as $key => &$value) {
2372 if (substr($key, 0, 3) == 'api' && is_array($value)) {
2373 if (isset($value['is_error'])) {
2374 // we have a std nested result format
2375 $this->tidyExampleResult($value);
2378 foreach ($value as &$nestedResult) {
2379 // this is an alternative syntax for nested results a keyed array of results
2380 $this->tidyExampleResult($nestedResult);
2384 if (in_array($key, $keysToUnset)) {
2385 unset($values[$key]);
2388 if (array_key_exists($key, $fieldsToChange) && !empty($value)) {
2389 $value = $fieldsToChange[$key];
2391 if (is_string($value)) {
2392 $value = addslashes($value);
2399 * Create custom field with Option Values.
2401 * @param array $customGroup
2402 * @param string $name
2403 * Name of custom field.
2407 public function customFieldOptionValueCreate($customGroup, $name) {
2408 $fieldParams = array(
2409 'custom_group_id' => $customGroup['id'],
2410 'name' => 'test_custom_group',
2411 'label' => 'Country',
2412 'html_type' => 'Select',
2413 'data_type' => 'String',
2416 'is_searchable' => 0,
2420 $optionGroup = array(
2422 'name' => 'option_group1',
2423 'label' => 'option_group_label1',
2426 $optionValue = array(
2427 'option_label' => array('Label1', 'Label2'),
2428 'option_value' => array('value1', 'value2'),
2429 'option_name' => array($name . '_1', $name . '_2'),
2430 'option_weight' => array(1, 2),
2431 'option_status' => 1,
2434 $params = array_merge($fieldParams, $optionGroup, $optionValue);
2436 return $this->callAPISuccess('custom_field', 'create', $params);
2444 public function confirmEntitiesDeleted($entities) {
2445 foreach ($entities as $entity) {
2447 $result = $this->callAPISuccess($entity, 'Get', array());
2448 if ($result['error'] == 1 ||
$result['count'] > 0) {
2449 // > than $entity[0] to allow a value to be passed in? e.g. domain?
2457 * Quick clean by emptying tables created for the test.
2459 * @param array $tablesToTruncate
2460 * @param bool $dropCustomValueTables
2461 * @throws \Exception
2463 public function quickCleanup($tablesToTruncate, $dropCustomValueTables = FALSE) {
2465 throw new Exception("CiviUnitTestCase: quickCleanup() is not compatible with useTransaction()");
2467 if ($dropCustomValueTables) {
2468 $optionGroupResult = CRM_Core_DAO
::executeQuery('SELECT option_group_id FROM civicrm_custom_field');
2469 while ($optionGroupResult->fetch()) {
2470 if (!empty($optionGroupResult->option_group_id
)) {
2471 CRM_Core_DAO
::executeQuery('DELETE FROM civicrm_option_group WHERE id = ' . $optionGroupResult->option_group_id
);
2474 $tablesToTruncate[] = 'civicrm_custom_group';
2475 $tablesToTruncate[] = 'civicrm_custom_field';
2478 $tablesToTruncate = array_unique(array_merge($this->_tablesToTruncate
, $tablesToTruncate));
2480 CRM_Core_DAO
::executeQuery("SET FOREIGN_KEY_CHECKS = 0;");
2481 foreach ($tablesToTruncate as $table) {
2482 $sql = "TRUNCATE TABLE $table";
2483 CRM_Core_DAO
::executeQuery($sql);
2485 CRM_Core_DAO
::executeQuery("SET FOREIGN_KEY_CHECKS = 1;");
2487 if ($dropCustomValueTables) {
2488 $dbName = self
::getDBName();
2490 SELECT TABLE_NAME as tableName
2491 FROM INFORMATION_SCHEMA.TABLES
2492 WHERE TABLE_SCHEMA = '{$dbName}'
2493 AND ( TABLE_NAME LIKE 'civicrm_value_%' )
2496 $tableDAO = CRM_Core_DAO
::executeQuery($query);
2497 while ($tableDAO->fetch()) {
2498 $sql = "DROP TABLE {$tableDAO->tableName}";
2499 CRM_Core_DAO
::executeQuery($sql);
2505 * Clean up financial entities after financial tests (so we remember to get all the tables :-))
2507 public function quickCleanUpFinancialEntities() {
2508 $tablesToTruncate = array(
2510 'civicrm_activity_contact',
2511 'civicrm_contribution',
2512 'civicrm_contribution_soft',
2513 'civicrm_contribution_product',
2514 'civicrm_financial_trxn',
2515 'civicrm_financial_item',
2516 'civicrm_contribution_recur',
2517 'civicrm_line_item',
2518 'civicrm_contribution_page',
2519 'civicrm_payment_processor',
2520 'civicrm_entity_financial_trxn',
2521 'civicrm_membership',
2522 'civicrm_membership_type',
2523 'civicrm_membership_payment',
2524 'civicrm_membership_log',
2525 'civicrm_membership_block',
2527 'civicrm_participant',
2528 'civicrm_participant_payment',
2530 'civicrm_pledge_payment',
2531 'civicrm_price_set_entity',
2532 'civicrm_price_field_value',
2533 'civicrm_price_field',
2535 $this->quickCleanup($tablesToTruncate);
2536 CRM_Core_DAO
::executeQuery("DELETE FROM civicrm_membership_status WHERE name NOT IN('New', 'Current', 'Grace', 'Expired', 'Pending', 'Cancelled', 'Deceased')");
2537 $this->restoreDefaultPriceSetConfig();
2539 CRM_Member_BAO_Membership
::createRelatedMemberships($var, $var, TRUE);
2540 System
::singleton()->flushProcessors();
2543 public function restoreDefaultPriceSetConfig() {
2544 CRM_Core_DAO
::executeQuery('DELETE FROM civicrm_price_set WHERE id > 2');
2545 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)");
2546 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`, `non_deductible_amount`) VALUES (1, 1, 'contribution_amount', 'Contribution Amount', NULL, '1', NULL, NULL, 1, NULL, NULL, 0, 1, 1, 0.00)");
2549 * Function does a 'Get' on the entity & compares the fields in the Params with those returned
2550 * Default behaviour is to also delete the entity
2551 * @param array $params
2552 * Params array to check against.
2554 * Id of the entity concerned.
2555 * @param string $entity
2556 * Name of entity concerned (e.g. membership).
2557 * @param bool $delete
2558 * Should the entity be deleted as part of this check.
2559 * @param string $errorText
2560 * Text to print on error.
2563 * @param array $params
2566 * @param int $delete
2567 * @param string $errorText
2571 public function getAndCheck($params, $id, $entity, $delete = 1, $errorText = '') {
2573 $result = $this->callAPISuccessGetSingle($entity, array(
2578 $this->callAPISuccess($entity, 'Delete', array(
2582 $dateFields = $keys = $dateTimeFields = array();
2583 $fields = $this->callAPISuccess($entity, 'getfields', array('version' => 3, 'action' => 'get'));
2584 foreach ($fields['values'] as $field => $settings) {
2585 if (array_key_exists($field, $result)) {
2586 $keys[CRM_Utils_Array
::Value('name', $settings, $field)] = $field;
2589 $keys[CRM_Utils_Array
::Value('name', $settings, $field)] = CRM_Utils_Array
::value('name', $settings, $field);
2591 $type = CRM_Utils_Array
::value('type', $settings);
2592 if ($type == CRM_Utils_Type
::T_DATE
) {
2593 $dateFields[] = $settings['name'];
2594 // we should identify both real names & unique names as dates
2595 if ($field != $settings['name']) {
2596 $dateFields[] = $field;
2599 if ($type == CRM_Utils_Type
::T_DATE + CRM_Utils_Type
::T_TIME
) {
2600 $dateTimeFields[] = $settings['name'];
2601 // we should identify both real names & unique names as dates
2602 if ($field != $settings['name']) {
2603 $dateTimeFields[] = $field;
2608 if (strtolower($entity) == 'contribution') {
2609 $params['receive_date'] = date('Y-m-d', strtotime($params['receive_date']));
2610 // this is not returned in id format
2611 unset($params['payment_instrument_id']);
2612 $params['contribution_source'] = $params['source'];
2613 unset($params['source']);
2616 foreach ($params as $key => $value) {
2617 if ($key == 'version' ||
substr($key, 0, 3) == 'api' ||
!array_key_exists($keys[$key], $result)) {
2620 if (in_array($key, $dateFields)) {
2621 $value = date('Y-m-d', strtotime($value));
2622 $result[$key] = date('Y-m-d', strtotime($result[$key]));
2624 if (in_array($key, $dateTimeFields)) {
2625 $value = date('Y-m-d H:i:s', strtotime($value));
2626 $result[$keys[$key]] = date('Y-m-d H:i:s', strtotime(CRM_Utils_Array
::value($keys[$key], $result, CRM_Utils_Array
::value($key, $result))));
2628 $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);
2633 * Get formatted values in the actual and expected result.
2634 * @param array $actual
2635 * Actual calculated values.
2636 * @param array $expected
2639 public function checkArrayEquals(&$actual, &$expected) {
2640 self
::unsetId($actual);
2641 self
::unsetId($expected);
2642 $this->assertEquals($actual, $expected);
2646 * Unset the key 'id' from the array
2647 * @param array $unformattedArray
2648 * The array from which the 'id' has to be unset.
2650 public static function unsetId(&$unformattedArray) {
2651 $formattedArray = array();
2652 if (array_key_exists('id', $unformattedArray)) {
2653 unset($unformattedArray['id']);
2655 if (!empty($unformattedArray['values']) && is_array($unformattedArray['values'])) {
2656 foreach ($unformattedArray['values'] as $key => $value) {
2657 if (is_array($value)) {
2658 foreach ($value as $k => $v) {
2664 elseif ($key == 'id') {
2665 $unformattedArray[$key];
2667 $formattedArray = array($value);
2669 $unformattedArray['values'] = $formattedArray;
2674 * Helper to enable/disable custom directory support
2676 * @param array $customDirs
2678 * 'php_path' Set to TRUE to use the default, FALSE or "" to disable support, or a string path to use another path
2679 * 'template_path' Set to TRUE to use the default, FALSE or "" to disable support, or a string path to use another path
2681 public function customDirectories($customDirs) {
2682 $config = CRM_Core_Config
::singleton();
2684 if (empty($customDirs['php_path']) ||
$customDirs['php_path'] === FALSE) {
2685 unset($config->customPHPPathDir
);
2687 elseif ($customDirs['php_path'] === TRUE) {
2688 $config->customPHPPathDir
= dirname(dirname(__FILE__
)) . '/custom_directories/php/';
2691 $config->customPHPPathDir
= $php_path;
2694 if (empty($customDirs['template_path']) ||
$customDirs['template_path'] === FALSE) {
2695 unset($config->customTemplateDir
);
2697 elseif ($customDirs['template_path'] === TRUE) {
2698 $config->customTemplateDir
= dirname(dirname(__FILE__
)) . '/custom_directories/templates/';
2701 $config->customTemplateDir
= $template_path;
2706 * Generate a temporary folder.
2708 * @param string $prefix
2711 public function createTempDir($prefix = 'test-') {
2712 $tempDir = CRM_Utils_File
::tempdir($prefix);
2713 $this->tempDirs
[] = $tempDir;
2717 public function cleanTempDirs() {
2718 if (!is_array($this->tempDirs
)) {
2719 // fix test errors where this is not set
2722 foreach ($this->tempDirs
as $tempDir) {
2723 if (is_dir($tempDir)) {
2724 CRM_Utils_File
::cleanDir($tempDir, TRUE, FALSE);
2730 * Temporarily replace the singleton extension with a different one.
2731 * @param \CRM_Extension_System $system
2733 public function setExtensionSystem(CRM_Extension_System
$system) {
2734 if ($this->origExtensionSystem
== NULL) {
2735 $this->origExtensionSystem
= CRM_Extension_System
::singleton();
2737 CRM_Extension_System
::setSingleton($this->origExtensionSystem
);
2740 public function unsetExtensionSystem() {
2741 if ($this->origExtensionSystem
!== NULL) {
2742 CRM_Extension_System
::setSingleton($this->origExtensionSystem
);
2743 $this->origExtensionSystem
= NULL;
2748 * Temporarily alter the settings-metadata to add a mock setting.
2750 * WARNING: The setting metadata will disappear on the next cache-clear.
2755 public function setMockSettingsMetaData($extras) {
2756 Civi
::service('settings_manager')->flush();
2758 CRM_Utils_Hook
::singleton()
2759 ->setHook('civicrm_alterSettingsMetaData', function (&$metadata, $domainId, $profile) use ($extras) {
2760 $metadata = array_merge($metadata, $extras);
2763 $fields = $this->callAPISuccess('setting', 'getfields', array());
2764 foreach ($extras as $key => $spec) {
2765 $this->assertNotEmpty($spec['title']);
2766 $this->assertEquals($spec['title'], $fields['values'][$key]['title']);
2771 * @param string $name
2773 public function financialAccountDelete($name) {
2774 $financialAccount = new CRM_Financial_DAO_FinancialAccount();
2775 $financialAccount->name
= $name;
2776 if ($financialAccount->find(TRUE)) {
2777 $entityFinancialType = new CRM_Financial_DAO_EntityFinancialAccount();
2778 $entityFinancialType->financial_account_id
= $financialAccount->id
;
2779 $entityFinancialType->delete();
2780 $financialAccount->delete();
2785 * FIXME: something NULLs $GLOBALS['_HTML_QuickForm_registered_rules'] when the tests are ran all together
2786 * (NB unclear if this is still required)
2788 public function _sethtmlGlobals() {
2789 $GLOBALS['_HTML_QuickForm_registered_rules'] = array(
2790 'required' => array(
2791 'html_quickform_rule_required',
2792 'HTML/QuickForm/Rule/Required.php',
2794 'maxlength' => array(
2795 'html_quickform_rule_range',
2796 'HTML/QuickForm/Rule/Range.php',
2798 'minlength' => array(
2799 'html_quickform_rule_range',
2800 'HTML/QuickForm/Rule/Range.php',
2802 'rangelength' => array(
2803 'html_quickform_rule_range',
2804 'HTML/QuickForm/Rule/Range.php',
2807 'html_quickform_rule_email',
2808 'HTML/QuickForm/Rule/Email.php',
2811 'html_quickform_rule_regex',
2812 'HTML/QuickForm/Rule/Regex.php',
2814 'lettersonly' => array(
2815 'html_quickform_rule_regex',
2816 'HTML/QuickForm/Rule/Regex.php',
2818 'alphanumeric' => array(
2819 'html_quickform_rule_regex',
2820 'HTML/QuickForm/Rule/Regex.php',
2823 'html_quickform_rule_regex',
2824 'HTML/QuickForm/Rule/Regex.php',
2826 'nopunctuation' => array(
2827 'html_quickform_rule_regex',
2828 'HTML/QuickForm/Rule/Regex.php',
2831 'html_quickform_rule_regex',
2832 'HTML/QuickForm/Rule/Regex.php',
2834 'callback' => array(
2835 'html_quickform_rule_callback',
2836 'HTML/QuickForm/Rule/Callback.php',
2839 'html_quickform_rule_compare',
2840 'HTML/QuickForm/Rule/Compare.php',
2843 // FIXME: …ditto for $GLOBALS['HTML_QUICKFORM_ELEMENT_TYPES']
2844 $GLOBALS['HTML_QUICKFORM_ELEMENT_TYPES'] = array(
2846 'HTML/QuickForm/group.php',
2847 'HTML_QuickForm_group',
2850 'HTML/QuickForm/hidden.php',
2851 'HTML_QuickForm_hidden',
2854 'HTML/QuickForm/reset.php',
2855 'HTML_QuickForm_reset',
2857 'checkbox' => array(
2858 'HTML/QuickForm/checkbox.php',
2859 'HTML_QuickForm_checkbox',
2862 'HTML/QuickForm/file.php',
2863 'HTML_QuickForm_file',
2866 'HTML/QuickForm/image.php',
2867 'HTML_QuickForm_image',
2869 'password' => array(
2870 'HTML/QuickForm/password.php',
2871 'HTML_QuickForm_password',
2874 'HTML/QuickForm/radio.php',
2875 'HTML_QuickForm_radio',
2878 'HTML/QuickForm/button.php',
2879 'HTML_QuickForm_button',
2882 'HTML/QuickForm/submit.php',
2883 'HTML_QuickForm_submit',
2886 'HTML/QuickForm/select.php',
2887 'HTML_QuickForm_select',
2889 'hiddenselect' => array(
2890 'HTML/QuickForm/hiddenselect.php',
2891 'HTML_QuickForm_hiddenselect',
2894 'HTML/QuickForm/text.php',
2895 'HTML_QuickForm_text',
2897 'textarea' => array(
2898 'HTML/QuickForm/textarea.php',
2899 'HTML_QuickForm_textarea',
2901 'fckeditor' => array(
2902 'HTML/QuickForm/fckeditor.php',
2903 'HTML_QuickForm_FCKEditor',
2906 'HTML/QuickForm/tinymce.php',
2907 'HTML_QuickForm_TinyMCE',
2909 'dojoeditor' => array(
2910 'HTML/QuickForm/dojoeditor.php',
2911 'HTML_QuickForm_dojoeditor',
2914 'HTML/QuickForm/link.php',
2915 'HTML_QuickForm_link',
2917 'advcheckbox' => array(
2918 'HTML/QuickForm/advcheckbox.php',
2919 'HTML_QuickForm_advcheckbox',
2922 'HTML/QuickForm/date.php',
2923 'HTML_QuickForm_date',
2926 'HTML/QuickForm/static.php',
2927 'HTML_QuickForm_static',
2930 'HTML/QuickForm/header.php',
2931 'HTML_QuickForm_header',
2934 'HTML/QuickForm/html.php',
2935 'HTML_QuickForm_html',
2937 'hierselect' => array(
2938 'HTML/QuickForm/hierselect.php',
2939 'HTML_QuickForm_hierselect',
2941 'autocomplete' => array(
2942 'HTML/QuickForm/autocomplete.php',
2943 'HTML_QuickForm_autocomplete',
2946 'HTML/QuickForm/xbutton.php',
2947 'HTML_QuickForm_xbutton',
2949 'advmultiselect' => array(
2950 'HTML/QuickForm/advmultiselect.php',
2951 'HTML_QuickForm_advmultiselect',
2957 * Set up an acl allowing contact to see 2 specified groups
2958 * - $this->_permissionedGroup & $this->_permissionedDisabledGroup
2960 * You need to have pre-created these groups & created the user e.g
2961 * $this->createLoggedInUser();
2962 * $this->_permissionedDisabledGroup = $this->groupCreate(array('title' => 'pick-me-disabled', 'is_active' => 0, 'name' => 'pick-me-disabled'));
2963 * $this->_permissionedGroup = $this->groupCreate(array('title' => 'pick-me-active', 'is_active' => 1, 'name' => 'pick-me-active'));
2965 * @param bool $isProfile
2967 public function setupACL($isProfile = FALSE) {
2969 $_REQUEST = $this->_params
;
2971 CRM_Core_Config
::singleton()->userPermissionClass
->permissions
= array('access CiviCRM');
2972 $optionGroupID = $this->callAPISuccessGetValue('option_group', array('return' => 'id', 'name' => 'acl_role'));
2973 $optionValue = $this->callAPISuccess('option_value', 'create', array(
2974 'option_group_id' => $optionGroupID,
2975 'label' => 'pick me',
2979 CRM_Core_DAO
::executeQuery("
2980 TRUNCATE civicrm_acl_cache
2983 CRM_Core_DAO
::executeQuery("
2984 TRUNCATE civicrm_acl_contact_cache
2987 CRM_Core_DAO
::executeQuery("
2988 INSERT INTO civicrm_acl_entity_role (
2989 `acl_role_id`, `entity_table`, `entity_id`, `is_active`
2990 ) VALUES (55, 'civicrm_group', {$this->_permissionedGroup}, 1);
2994 CRM_Core_DAO
::executeQuery("
2995 INSERT INTO civicrm_acl (
2996 `name`, `entity_table`, `entity_id`, `operation`, `object_table`, `object_id`, `is_active`
2999 'view picked', 'civicrm_acl_role', 55, 'Edit', 'civicrm_uf_group', 0, 1
3004 CRM_Core_DAO
::executeQuery("
3005 INSERT INTO civicrm_acl (
3006 `name`, `entity_table`, `entity_id`, `operation`, `object_table`, `object_id`, `is_active`
3009 'view picked', 'civicrm_group', $this->_permissionedGroup , 'Edit', 'civicrm_saved_search', {$this->_permissionedGroup}, 1
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->_permissionedDisabledGroup}, 1
3023 $this->_loggedInUser
= CRM_Core_Session
::singleton()->get('userID');
3024 $this->callAPISuccess('group_contact', 'create', array(
3025 'group_id' => $this->_permissionedGroup
,
3026 'contact_id' => $this->_loggedInUser
,
3031 CRM_ACL_BAO_Cache
::resetCache();
3032 CRM_Contact_BAO_Group
::getPermissionClause(TRUE);
3033 CRM_ACL_API
::groupPermission('whatever', 9999, NULL, 'civicrm_saved_search', NULL, NULL, TRUE);
3038 * Alter default price set so that the field numbers are not all 1 (hiding errors)
3040 public function offsetDefaultPriceSet() {
3041 $contributionPriceSet = $this->callAPISuccess('price_set', 'getsingle', array('name' => 'default_contribution_amount'));
3042 $firstID = $contributionPriceSet['id'];
3043 $this->callAPISuccess('price_set', 'create', array(
3044 'id' => $contributionPriceSet['id'],
3048 unset($contributionPriceSet['id']);
3049 $newPriceSet = $this->callAPISuccess('price_set', 'create', $contributionPriceSet);
3050 $priceField = $this->callAPISuccess('price_field', 'getsingle', array(
3051 'price_set_id' => $firstID,
3052 'options' => array('limit' => 1),
3054 unset($priceField['id']);
3055 $priceField['price_set_id'] = $newPriceSet['id'];
3056 $newPriceField = $this->callAPISuccess('price_field', 'create', $priceField);
3057 $priceFieldValue = $this->callAPISuccess('price_field_value', 'getsingle', array(
3058 'price_set_id' => $firstID,
3060 'options' => array('limit' => 1),
3063 unset($priceFieldValue['id']);
3064 //create some padding to use up ids
3065 $this->callAPISuccess('price_field_value', 'create', $priceFieldValue);
3066 $this->callAPISuccess('price_field_value', 'create', $priceFieldValue);
3067 $this->callAPISuccess('price_field_value', 'create', array_merge($priceFieldValue, array('price_field_id' => $newPriceField['id'])));
3071 * Create an instance of the paypal processor.
3072 * @todo this isn't a great place to put it - but really it belongs on a class that extends
3073 * this parent class & we don't have a structure for that yet
3074 * There is another function to this effect on the PaypalPro test but it appears to be silently failing
3075 * & the best protection against that is the functions this class affords
3076 * @param array $params
3077 * @return int $result['id'] payment processor id
3079 public function paymentProcessorCreate($params = array()) {
3080 $params = array_merge(array(
3082 'domain_id' => CRM_Core_Config
::domainID(),
3083 'payment_processor_type_id' => 'PayPal',
3087 'user_name' => 'sunil._1183377782_biz_api1.webaccess.co.in',
3088 'password' => '1183377788',
3089 'signature' => 'APixCoQ-Zsaj-u3IH7mD5Do-7HUqA9loGnLSzsZga9Zr-aNmaJa3WGPH',
3090 'url_site' => 'https://www.sandbox.paypal.com/',
3091 'url_api' => 'https://api-3t.sandbox.paypal.com/',
3092 'url_button' => 'https://www.paypal.com/en_US/i/btn/btn_xpressCheckout.gif',
3093 'class_name' => 'Payment_PayPalImpl',
3094 'billing_mode' => 3,
3095 'financial_type_id' => 1,
3096 'financial_account_id' => 12,
3097 // Credit card = 1 so can pass 'by accident'.
3098 'payment_instrument_id' => 'Debit Card',
3101 if (!is_numeric($params['payment_processor_type_id'])) {
3102 // really the api should handle this through getoptions but it's not exactly api call so lets just sort it
3104 $params['payment_processor_type_id'] = $this->callAPISuccess('payment_processor_type', 'getvalue', array(
3105 'name' => $params['payment_processor_type_id'],
3109 $result = $this->callAPISuccess('payment_processor', 'create', $params);
3110 return $result['id'];
3114 * Set up initial recurring payment allowing subsequent IPN payments.
3116 public function setupRecurringPaymentProcessorTransaction($params = array()) {
3117 $contributionRecur = $this->callAPISuccess('contribution_recur', 'create', array_merge(array(
3118 'contact_id' => $this->_contactID
,
3121 'installments' => 5,
3122 'frequency_unit' => 'Month',
3123 'frequency_interval' => 1,
3124 'invoice_id' => $this->_invoiceID
,
3125 'contribution_status_id' => 2,
3126 'payment_processor_id' => $this->_paymentProcessorID
,
3127 // processor provided ID - use contact ID as proxy.
3128 'processor_id' => $this->_contactID
,
3129 'api.contribution.create' => array(
3130 'total_amount' => '200',
3131 'invoice_id' => $this->_invoiceID
,
3132 'financial_type_id' => 1,
3133 'contribution_status_id' => 'Pending',
3134 'contact_id' => $this->_contactID
,
3135 'contribution_page_id' => $this->_contributionPageID
,
3136 'payment_processor_id' => $this->_paymentProcessorID
,
3140 $this->_contributionRecurID
= $contributionRecur['id'];
3141 $this->_contributionID
= $contributionRecur['values']['0']['api.contribution.create']['id'];
3145 * 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
3147 public function setupMembershipRecurringPaymentProcessorTransaction() {
3148 $this->ids
['membership_type'] = $this->membershipTypeCreate();
3149 //create a contribution so our membership & contribution don't both have id = 1
3150 if ($this->callAPISuccess('Contribution', 'getcount', array()) == 0) {
3151 $this->contributionCreate(array(
3152 'contact_id' => $this->_contactID
,
3154 'financial_type_id' => 1,
3155 'invoice_id' => 'abcd',
3159 $this->setupRecurringPaymentProcessorTransaction();
3161 $this->ids
['membership'] = $this->callAPISuccess('membership', 'create', array(
3162 'contact_id' => $this->_contactID
,
3163 'membership_type_id' => $this->ids
['membership_type'],
3164 'contribution_recur_id' => $this->_contributionRecurID
,
3165 'format.only_id' => TRUE,
3167 //CRM-15055 creates line items we don't want so get rid of them so we can set up our own line items
3168 CRM_Core_DAO
::executeQuery("TRUNCATE civicrm_line_item");
3170 $this->callAPISuccess('line_item', 'create', array(
3171 'entity_table' => 'civicrm_membership',
3172 'entity_id' => $this->ids
['membership'],
3173 'contribution_id' => $this->_contributionID
,
3174 'label' => 'General',
3176 'unit_price' => 200,
3177 'line_total' => 200,
3178 'financial_type_id' => 1,
3179 'price_field_id' => $this->callAPISuccess('price_field', 'getvalue', array(
3181 'label' => 'Membership Amount',
3182 'options' => array('limit' => 1, 'sort' => 'id DESC'),
3184 'price_field_value_id' => $this->callAPISuccess('price_field_value', 'getvalue', array(
3186 'label' => 'General',
3187 'options' => array('limit' => 1, 'sort' => 'id DESC'),
3190 $this->callAPISuccess('membership_payment', 'create', array(
3191 'contribution_id' => $this->_contributionID
,
3192 'membership_id' => $this->ids
['membership'],
3201 public function CiviUnitTestCase_fatalErrorHandler($message) {
3202 throw new Exception("{$message['message']}: {$message['code']}");
3206 * Helper function to create new mailing.
3208 * @param array $params
3212 public function createMailing($params = array()) {
3213 $params = array_merge(array(
3214 'subject' => 'maild' . rand(),
3215 'body_text' => 'bdkfhdskfhduew{domain.address}{action.optOutUrl}',
3216 'name' => 'mailing name' . rand(),
3220 $result = $this->callAPISuccess('Mailing', 'create', $params);
3221 return $result['id'];
3225 * Helper function to delete mailing.
3228 public function deleteMailing($id) {
3233 $this->callAPISuccess('Mailing', 'delete', $params);
3237 * Wrap the entire test case in a transaction.
3239 * Only subsequent DB statements will be wrapped in TX -- this cannot
3240 * retroactively wrap old DB statements. Therefore, it makes sense to
3241 * call this at the beginning of setUp().
3243 * Note: Recall that TRUNCATE and ALTER will force-commit transactions, so
3244 * this option does not work with, e.g., custom-data.
3246 * WISHLIST: Monitor SQL queries in unit-tests and generate an exception
3247 * if TRUNCATE or ALTER is called while using a transaction.
3250 * Whether to use nesting or reference-counting.
3252 public function useTransaction($nest = TRUE) {
3254 $this->tx
= new CRM_Core_Transaction($nest);
3255 $this->tx
->rollback();
3260 * Assert the attachment exists.
3262 * @param bool $exists
3263 * @param array $apiResult
3265 protected function assertAttachmentExistence($exists, $apiResult) {
3266 $fileId = $apiResult['id'];
3267 $this->assertTrue(is_numeric($fileId));
3268 $this->assertEquals($exists, file_exists($apiResult['values'][$fileId]['path']));
3269 $this->assertDBQuery($exists ?
1 : 0, 'SELECT count(*) FROM civicrm_file WHERE id = %1', array(
3270 1 => array($fileId, 'Int'),
3272 $this->assertDBQuery($exists ?
1 : 0, 'SELECT count(*) FROM civicrm_entity_file WHERE id = %1', array(
3273 1 => array($fileId, 'Int'),
3278 * Create a price set for an event.
3280 * @param int $feeTotal
3281 * @param int $minAmt
3286 protected function eventPriceSetCreate($feeTotal, $minAmt = 0) {
3287 // creating price set, price field
3288 $paramsSet['title'] = 'Price Set';
3289 $paramsSet['name'] = CRM_Utils_String
::titleToVar('Price Set');
3290 $paramsSet['is_active'] = FALSE;
3291 $paramsSet['extends'] = 1;
3292 $paramsSet['min_amount'] = $minAmt;
3294 $priceset = CRM_Price_BAO_PriceSet
::create($paramsSet);
3295 $priceSetId = $priceset->id
;
3297 //Checking for priceset added in the table.
3298 $this->assertDBCompareValue('CRM_Price_BAO_PriceSet', $priceSetId, 'title',
3299 'id', $paramsSet['title'], 'Check DB for created priceset'
3301 $paramsField = array(
3302 'label' => 'Price Field',
3303 'name' => CRM_Utils_String
::titleToVar('Price Field'),
3304 'html_type' => 'Text',
3305 'price' => $feeTotal,
3306 'option_label' => array('1' => 'Price Field'),
3307 'option_value' => array('1' => $feeTotal),
3308 'option_name' => array('1' => $feeTotal),
3309 'option_weight' => array('1' => 1),
3310 'option_amount' => array('1' => 1),
3311 'is_display_amounts' => 1,
3313 'options_per_line' => 1,
3314 'is_active' => array('1' => 1),
3315 'price_set_id' => $priceset->id
,
3316 'is_enter_qty' => 1,
3317 'financial_type_id' => $this->getFinancialTypeId('Event Fee'),
3319 CRM_Price_BAO_PriceField
::create($paramsField);
3325 * Add a profile to a contribution page.
3327 * @param string $name
3328 * @param int $contributionPageID
3330 protected function addProfile($name, $contributionPageID) {
3331 $this->callAPISuccess('UFJoin', 'create', array(
3332 'uf_group_id' => $name,
3333 'module' => 'CiviContribute',
3334 'entity_table' => 'civicrm_contribution_page',
3335 'entity_id' => $contributionPageID,
3341 * Add participant with contribution
3345 protected function createParticipantWithContribution() {
3346 // creating price set, price field
3347 $this->_contactId
= $this->individualCreate();
3348 $event = $this->eventCreate();
3349 $this->_eventId
= $event['id'];
3350 $eventParams = array(
3351 'id' => $this->_eventId
,
3352 'financial_type_id' => 4,
3355 $this->callAPISuccess('event', 'create', $eventParams);
3356 $priceFields = $this->createPriceSet('event', $this->_eventId
);
3357 $participantParams = array(
3358 'financial_type_id' => 4,
3359 'event_id' => $this->_eventId
,
3362 'fee_currency' => 'USD',
3363 'contact_id' => $this->_contactId
,
3365 $participant = $this->callAPISuccess('Participant', 'create', $participantParams);
3366 $contributionParams = array(
3367 'total_amount' => 150,
3368 'currency' => 'USD',
3369 'contact_id' => $this->_contactId
,
3370 'financial_type_id' => 4,
3371 'contribution_status_id' => 1,
3372 'partial_payment_total' => 300.00,
3373 'partial_amount_pay' => 150,
3374 'contribution_mode' => 'participant',
3375 'participant_id' => $participant['id'],
3377 foreach ($priceFields['values'] as $key => $priceField) {
3378 $lineItems[1][$key] = array(
3379 'price_field_id' => $priceField['price_field_id'],
3380 'price_field_value_id' => $priceField['id'],
3381 'label' => $priceField['label'],
3382 'field_title' => $priceField['label'],
3384 'unit_price' => $priceField['amount'],
3385 'line_total' => $priceField['amount'],
3386 'financial_type_id' => $priceField['financial_type_id'],
3389 $contributionParams['line_item'] = $lineItems;
3390 $contribution = $this->callAPISuccess('Contribution', 'create', $contributionParams);
3391 $paymentParticipant = array(
3392 'participant_id' => $participant['id'],
3393 'contribution_id' => $contribution['id'],
3395 $this->callAPISuccess('ParticipantPayment', 'create', $paymentParticipant);
3396 return array($lineItems, $contribution);
3402 * @param string $component
3403 * @param int $componentId
3407 protected function createPriceSet($component = 'contribution_page', $componentId = NULL, $priceFieldOptions = array()) {
3408 $paramsSet['title'] = 'Price Set' . substr(sha1(rand()), 0, 7);
3409 $paramsSet['name'] = CRM_Utils_String
::titleToVar($paramsSet['title']);
3410 $paramsSet['is_active'] = TRUE;
3411 $paramsSet['financial_type_id'] = 4;
3412 $paramsSet['extends'] = 1;
3413 $priceSet = $this->callAPISuccess('price_set', 'create', $paramsSet);
3414 $priceSetId = $priceSet['id'];
3415 //Checking for priceset added in the table.
3416 $this->assertDBCompareValue('CRM_Price_BAO_PriceSet', $priceSetId, 'title',
3417 'id', $paramsSet['title'], 'Check DB for created priceset'
3419 $paramsField = array_merge(array(
3420 'label' => 'Price Field',
3421 'name' => CRM_Utils_String
::titleToVar('Price Field'),
3422 'html_type' => 'CheckBox',
3423 'option_label' => array('1' => 'Price Field 1', '2' => 'Price Field 2'),
3424 'option_value' => array('1' => 100, '2' => 200),
3425 'option_name' => array('1' => 'Price Field 1', '2' => 'Price Field 2'),
3426 'option_weight' => array('1' => 1, '2' => 2),
3427 'option_amount' => array('1' => 100, '2' => 200),
3428 'is_display_amounts' => 1,
3430 'options_per_line' => 1,
3431 'is_active' => array('1' => 1, '2' => 1),
3432 'price_set_id' => $priceSet['id'],
3433 'is_enter_qty' => 1,
3434 'financial_type_id' => $this->getFinancialTypeId('Event Fee'),
3435 ), $priceFieldOptions);
3437 $priceField = CRM_Price_BAO_PriceField
::create($paramsField);
3439 CRM_Price_BAO_PriceSet
::addTo('civicrm_' . $component, $componentId, $priceSetId);
3441 return $this->callAPISuccess('PriceFieldValue', 'get', array('price_field_id' => $priceField->id
));
3445 * Replace the template with a test-oriented template designed to show all the variables.
3447 * @param string $templateName
3449 protected function swapMessageTemplateForTestTemplate($templateName = 'contribution_online_receipt') {
3450 $testTemplate = file_get_contents(__DIR__
. '/../../templates/message_templates/' . $templateName . '_html.tpl');
3451 CRM_Core_DAO
::executeQuery(
3452 "UPDATE civicrm_option_group og
3453 LEFT JOIN civicrm_option_value ov ON ov.option_group_id = og.id
3454 LEFT JOIN civicrm_msg_template m ON m.workflow_id = ov.id
3455 SET m.msg_html = '{$testTemplate}'
3456 WHERE og.name = 'msg_tpl_workflow_contribution'
3457 AND ov.name = '{$templateName}'
3458 AND m.is_default = 1"
3463 * Reinstate the default template.
3465 * @param string $templateName
3467 protected function revertTemplateToReservedTemplate($templateName = 'contribution_online_receipt') {
3468 CRM_Core_DAO
::executeQuery(
3469 "UPDATE civicrm_option_group og
3470 LEFT JOIN civicrm_option_value ov ON ov.option_group_id = og.id
3471 LEFT JOIN civicrm_msg_template m ON m.workflow_id = ov.id
3472 LEFT JOIN civicrm_msg_template m2 ON m2.workflow_id = ov.id AND m2.is_reserved = 1
3473 SET m.msg_html = m2.msg_html
3474 WHERE og.name = 'msg_tpl_workflow_contribution'
3475 AND ov.name = '{$templateName}'
3476 AND m.is_default = 1"
3481 * Flush statics relating to financial type.
3483 protected function flushFinancialTypeStatics() {
3484 if (isset(\Civi
::$statics['CRM_Financial_BAO_FinancialType'])) {
3485 unset(\Civi
::$statics['CRM_Financial_BAO_FinancialType']);
3487 if (isset(\Civi
::$statics['CRM_Contribute_PseudoConstant'])) {
3488 unset(\Civi
::$statics['CRM_Contribute_PseudoConstant']);
3490 CRM_Contribute_PseudoConstant
::flush('financialType');
3491 CRM_Contribute_PseudoConstant
::flush('membershipType');
3492 // Pseudoconstants may be saved to the cache table.
3493 CRM_Core_DAO
::executeQuery("TRUNCATE civicrm_cache");
3494 CRM_Financial_BAO_FinancialType
::$_statusACLFt = array();
3495 CRM_Financial_BAO_FinancialType
::$_availableFinancialTypes = NULL;
3499 * Set the permissions to the supplied array.
3501 * @param array $permissions
3503 protected function setPermissions($permissions) {
3504 CRM_Core_Config
::singleton()->userPermissionClass
->permissions
= $permissions;
3505 $this->flushFinancialTypeStatics();
3506 CRM_Contact_BAO_Group
::getPermissionClause(TRUE);
3510 * @param array $params
3513 public function _checkFinancialRecords($params, $context) {
3514 $entityParams = array(
3515 'entity_id' => $params['id'],
3516 'entity_table' => 'civicrm_contribution',
3518 $contribution = $this->callAPISuccess('contribution', 'getsingle', array('id' => $params['id']));
3519 $this->assertEquals($contribution['total_amount'] - $contribution['fee_amount'], $contribution['net_amount']);
3520 if ($context == 'pending') {
3521 $trxn = CRM_Financial_BAO_FinancialItem
::retrieveEntityFinancialTrxn($entityParams);
3522 $this->assertNull($trxn, 'No Trxn to be created until IPN callback');
3525 $trxn = current(CRM_Financial_BAO_FinancialItem
::retrieveEntityFinancialTrxn($entityParams));
3526 $trxnParams = array(
3527 'id' => $trxn['financial_trxn_id'],
3529 if ($context != 'online' && $context != 'payLater') {
3530 $compareParams = array(
3531 'to_financial_account_id' => 6,
3532 'total_amount' => CRM_Utils_Array
::value('total_amount', $params, 100),
3536 if ($context == 'feeAmount') {
3537 $compareParams['fee_amount'] = 50;
3539 elseif ($context == 'online') {
3540 $compareParams = array(
3541 'to_financial_account_id' => 12,
3542 'total_amount' => CRM_Utils_Array
::value('total_amount', $params, 100),
3544 'payment_instrument_id' => CRM_Utils_Array
::value('payment_instrument_id', $params, 1),
3547 elseif ($context == 'payLater') {
3548 $compareParams = array(
3549 'to_financial_account_id' => 7,
3550 'total_amount' => CRM_Utils_Array
::value('total_amount', $params, 100),
3554 $this->assertDBCompareValues('CRM_Financial_DAO_FinancialTrxn', $trxnParams, $compareParams);
3555 $entityParams = array(
3556 'financial_trxn_id' => $trxn['financial_trxn_id'],
3557 'entity_table' => 'civicrm_financial_item',
3559 $entityTrxn = current(CRM_Financial_BAO_FinancialItem
::retrieveEntityFinancialTrxn($entityParams));
3560 $fitemParams = array(
3561 'id' => $entityTrxn['entity_id'],
3563 $compareParams = array(
3564 'amount' => CRM_Utils_Array
::value('total_amount', $params, 100),
3566 'financial_account_id' => CRM_Utils_Array
::value('financial_account_id', $params, 1),
3568 if ($context == 'payLater') {
3569 $compareParams = array(
3570 'amount' => CRM_Utils_Array
::value('total_amount', $params, 100),
3572 'financial_account_id' => CRM_Utils_Array
::value('financial_account_id', $params, 1),
3575 $this->assertDBCompareValues('CRM_Financial_DAO_FinancialItem', $fitemParams, $compareParams);
3576 if ($context == 'feeAmount') {
3578 'entity_id' => $params['id'],
3579 'entity_table' => 'civicrm_contribution',
3581 $maxTrxn = current(CRM_Financial_BAO_FinancialItem
::retrieveEntityFinancialTrxn($maxParams, TRUE));
3582 $trxnParams = array(
3583 'id' => $maxTrxn['financial_trxn_id'],
3585 $compareParams = array(
3586 'to_financial_account_id' => 5,
3587 'from_financial_account_id' => 6,
3588 'total_amount' => 50,
3591 $trxnId = CRM_Core_BAO_FinancialTrxn
::getFinancialTrxnId($params['id'], 'DESC');
3592 $this->assertDBCompareValues('CRM_Financial_DAO_FinancialTrxn', $trxnParams, $compareParams);
3593 $fitemParams = array(
3594 'entity_id' => $trxnId['financialTrxnId'],
3595 'entity_table' => 'civicrm_financial_trxn',
3597 $compareParams = array(
3600 'financial_account_id' => 5,
3602 $this->assertDBCompareValues('CRM_Financial_DAO_FinancialItem', $fitemParams, $compareParams);
3604 // This checks that empty Sales tax rows are not being created. If for any reason it needs to be removed the
3605 // line should be copied into all the functions that call this function & evaluated there
3606 // Be really careful not to remove or bypass this without ensuring stray rows do not re-appear
3607 // when calling completeTransaction or repeatTransaction.
3608 $this->callAPISuccessGetCount('FinancialItem', array('description' => 'Sales Tax', 'amount' => 0), 0);
3612 * Return financial type id on basis of name
3614 * @param string $name Financial type m/c name
3618 public function getFinancialTypeId($name) {
3619 return CRM_Core_DAO
::getFieldValue('CRM_Financial_DAO_FinancialType', $name, 'id', 'name');
3623 * Cleanup function for contents of $this->ids.
3625 * This is a best effort cleanup to use in tear downs etc.
3627 * It will not fail if the data has already been removed (some tests may do
3628 * their own cleanup).
3630 protected function cleanUpSetUpIDs() {
3631 foreach ($this->setupIDs
as $entity => $id) {
3633 civicrm_api3($entity, 'delete', array('id' => $id, 'skip_undelete' => 1));
3635 catch (CiviCRM_API3_Exception
$e) {
3636 // This is a best-effort cleanup function, ignore.
3642 * Create Financial Type.
3644 * @param array $params
3648 protected function createFinancialType($params = array()) {
3649 $params = array_merge($params,
3651 'name' => 'Financial-Type -' . substr(sha1(rand()), 0, 7),
3655 return $this->callAPISuccess('FinancialType', 'create', $params);
3659 * Enable Tax and Invoicing
3661 protected function enableTaxAndInvoicing($params = array()) {
3662 // Enable component contribute setting
3663 $contributeSetting = array_merge($params,
3666 'invoice_prefix' => 'INV_',
3667 'credit_notes_prefix' => 'CN_',
3669 'due_date_period' => 'days',
3671 'is_email_pdf' => 1,
3672 'tax_term' => 'Sales Tax',
3673 'tax_display_settings' => 'Inclusive',
3676 return Civi
::settings()->set('contribution_invoice_settings', $contributeSetting);
3680 * Add Sales Tax relation for financial type with financial account.
3682 * @param int $financialTypeId
3686 protected function relationForFinancialTypeWithFinancialAccount($financialTypeId) {
3688 'name' => 'Sales tax account ' . substr(sha1(rand()), 0, 4),
3689 'financial_account_type_id' => key(CRM_Core_PseudoConstant
::accountOptionValues('financial_account_type', NULL, " AND v.name LIKE 'Liability' ")),
3690 'is_deductible' => 1,
3695 $account = CRM_Financial_BAO_FinancialAccount
::add($params);
3696 $entityParams = array(
3697 'entity_table' => 'civicrm_financial_type',
3698 'entity_id' => $financialTypeId,
3699 'account_relationship' => key(CRM_Core_PseudoConstant
::accountOptionValues('account_relationship', NULL, " AND v.name LIKE 'Sales Tax Account is' ")),
3702 //CRM-20313: As per unique index added in civicrm_entity_financial_account table,
3703 // first check if there's any record on basis of unique key (entity_table, account_relationship, entity_id)
3704 $dao = new CRM_Financial_DAO_EntityFinancialAccount();
3705 $dao->copyValues($entityParams);
3707 if ($dao->fetch()) {
3708 $entityParams['id'] = $dao->id
;
3710 $entityParams['financial_account_id'] = $account->id
;
3712 return CRM_Financial_BAO_FinancialTypeAccount
::add($entityParams);
3716 * Create price set with contribution test for test setup.
3718 * This could be merged with 4.5 function setup in api_v3_ContributionPageTest::setUpContributionPage
3719 * on parent class at some point (fn is not in 4.4).
3722 * @param array $params
3724 public function createPriceSetWithPage($entity = NULL, $params = array()) {
3725 $membershipTypeID = $this->membershipTypeCreate(array('name' => 'Special'));
3726 $contributionPageResult = $this->callAPISuccess('contribution_page', 'create', array(
3727 'title' => "Test Contribution Page",
3728 'financial_type_id' => 1,
3729 'currency' => 'NZD',
3730 'goal_amount' => 50,
3731 'is_pay_later' => 1,
3732 'is_monetary' => TRUE,
3733 'is_email_receipt' => FALSE,
3735 $priceSet = $this->callAPISuccess('price_set', 'create', array(
3736 'is_quick_config' => 0,
3737 'extends' => 'CiviMember',
3738 'financial_type_id' => 1,
3739 'title' => 'my Page',
3741 $priceSetID = $priceSet['id'];
3743 CRM_Price_BAO_PriceSet
::addTo('civicrm_contribution_page', $contributionPageResult['id'], $priceSetID);
3744 $priceField = $this->callAPISuccess('price_field', 'create', array(
3745 'price_set_id' => $priceSetID,
3746 'label' => 'Goat Breed',
3747 'html_type' => 'Radio',
3749 $priceFieldValue = $this->callAPISuccess('price_field_value', 'create', array(
3750 'price_set_id' => $priceSetID,
3751 'price_field_id' => $priceField['id'],
3752 'label' => 'Long Haired Goat',
3754 'financial_type_id' => 'Donation',
3755 'membership_type_id' => $membershipTypeID,
3756 'membership_num_terms' => 1,
3759 $this->_ids
['price_field_value'] = array($priceFieldValue['id']);
3760 $priceFieldValue = $this->callAPISuccess('price_field_value', 'create', array(
3761 'price_set_id' => $priceSetID,
3762 'price_field_id' => $priceField['id'],
3763 'label' => 'Shoe-eating Goat',
3765 'financial_type_id' => 'Donation',
3766 'membership_type_id' => $membershipTypeID,
3767 'membership_num_terms' => 2,
3770 $this->_ids
['price_field_value'][] = $priceFieldValue['id'];
3772 $priceFieldValue = $this->callAPISuccess('price_field_value', 'create', array(
3773 'price_set_id' => $priceSetID,
3774 'price_field_id' => $priceField['id'],
3775 'label' => 'Shoe-eating Goat',
3777 'financial_type_id' => 'Donation',
3780 $this->_ids
['price_field_value']['cont'] = $priceFieldValue['id'];
3782 $this->_ids
['price_set'] = $priceSetID;
3783 $this->_ids
['contribution_page'] = $contributionPageResult['id'];
3784 $this->_ids
['price_field'] = array($priceField['id']);
3786 $this->_ids
['membership_type'] = $membershipTypeID;
3790 * No results returned.
3792 * @implements CRM_Utils_Hook::aclWhereClause
3794 * @param string $type
3795 * @param array $tables
3796 * @param array $whereTables
3797 * @param int $contactID
3798 * @param string $where
3800 public function aclWhereHookNoResults($type, &$tables, &$whereTables, &$contactID, &$where) {