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
;
30 use League\Csv\Reader
;
33 * Include class definitions
35 require_once 'api/api.php';
36 define('API_LATEST_VERSION', 3);
39 * Base class for CiviCRM unit tests
41 * This class supports two (mutually-exclusive) techniques for cleaning up test data. Subclasses
42 * may opt for one or neither:
44 * 1. quickCleanup() is a helper which truncates a series of tables. Call quickCleanup()
45 * as part of setUp() and/or tearDown(). quickCleanup() is thorough - but it can
46 * be cumbersome to use (b/c you must identify the tables to cleanup) and slow to execute.
47 * 2. useTransaction() executes the test inside a transaction. It's easier to use
48 * (because you don't need to identify specific tables), but it doesn't work for tests
49 * which manipulate schema or truncate data -- and could behave inconsistently
50 * for tests which specifically examine DB transactions.
52 * Common functions for unit tests
56 class CiviUnitTestCase
extends PHPUnit\Framework\TestCase
{
58 use \Civi\Test\Api3DocTrait
;
59 use \Civi\Test\GenericAssertionsTrait
;
60 use \Civi\Test\DbTestTrait
;
61 use \Civi\Test\ContactTestTrait
;
62 use \Civi\Test\MailingTestTrait
;
65 * Database has been initialized.
69 private static $dbInit = FALSE;
72 * Database connection.
74 * @var PHPUnit_Extensions_Database_DB_IDatabaseConnection
83 static protected $_dbName;
86 * Track tables we have modified during a test.
90 protected $_tablesToTruncate = [];
94 * Array of temporary directory names
100 * populateOnce allows to skip db resets in setUp
102 * WARNING! USE WITH CAUTION - IT'LL RENDER DATA DEPENDENCIES
103 * BETWEEN TESTS WHEN RUN IN SUITE. SUITABLE FOR LOCAL, LIMITED
106 * IF POSSIBLE, USE $this->DBResetRequired = FALSE IN YOUR TEST CASE!
108 * @see http://forum.civicrm.org/index.php/topic,18065.0.html
110 public static $populateOnce = FALSE;
113 * DBResetRequired allows skipping DB reset
114 * in specific test case. If you still need
115 * to reset single test (method) of such case, call
116 * $this->cleanDB() in the first line of this
120 public $DBResetRequired = TRUE;
123 * @var CRM_Core_Transaction|null
128 * Array of IDs created to support the test.
131 * $this->ids = ['Contact' => ['descriptive_key' => $contactID], 'Group' => [$groupID]];
138 * Class used for hooks during tests.
140 * This can be used to test hooks within tests. For example in the ACL_PermissionTrait:
142 * $this->hookClass->setHook('civicrm_aclWhereClause', array($this, 'aclWhereHookAllResults'));
144 * @var \CRM_Utils_Hook_UnitTests
146 public $hookClass = NULL;
150 * Common values to be re-used multiple times within a class - usually to create the relevant entity
152 protected $_params = [];
155 * @var CRM_Extension_System
157 protected $origExtensionSystem;
160 * Array of IDs created during test setup routine.
162 * The cleanUpSetUpIds method can be used to clear these at the end of the test.
166 public $setupIDs = [];
169 * PHPUnit Mock Method to use.
173 public $mockMethod = 'getMock';
178 * Because we are overriding the parent class constructor, we
179 * need to show the same arguments as exist in the constructor of
180 * PHPUnit_Framework_TestCase, since
181 * PHPUnit_Framework_TestSuite::createTest() creates a
182 * ReflectionClass of the Test class and checks the constructor
183 * of that class to decide how to set up the test.
185 * @param string $name
187 * @param string $dataName
189 public function __construct($name = NULL, array $data = [], $dataName = '') {
190 parent
::__construct($name, $data, $dataName);
192 // we need full error reporting
193 error_reporting(E_ALL
& ~E_NOTICE
);
195 self
::$_dbName = self
::getDBName();
197 // also load the class loader
198 require_once 'CRM/Core/ClassLoader.php';
199 CRM_Core_ClassLoader
::singleton()->register();
200 if (function_exists('_civix_phpunit_setUp')) {
201 // FIXME: loosen coupling
202 _civix_phpunit_setUp();
204 if (class_exists('PHPUnit_Runner_Version') && version_compare(\PHPUnit_Runner_Version
::id(), '5', '>=')) {
205 $this->mockMethod
= 'createMock';
207 elseif (class_exists('PHPUnit\Runner\Version') && version_compare(PHPUnit\Runner\Version
::id(), '6', '>=')) {
208 $this->mockMethod
= 'createMock';
213 * Override to run the test and assert its state.
217 * @throws \PHPUnit_Framework_IncompleteTest
218 * @throws \PHPUnit_Framework_SkippedTest
220 protected function runTest() {
222 return parent
::runTest();
224 catch (PEAR_Exception
$e) {
225 // PEAR_Exception has metadata in funny places, and PHPUnit won't log it nicely
226 throw new Exception(\CRM_Core_Error
::formatTextException($e), $e->getCode());
233 public function requireDBReset() {
234 return $this->DBResetRequired
;
240 public static function getDBName() {
241 static $dbName = NULL;
242 if ($dbName === NULL) {
243 require_once "DB.php";
244 $dsninfo = DB
::parseDSN(CIVICRM_DSN
);
245 $dbName = $dsninfo['database'];
251 * Create database connection for this instance.
253 * Initialize the test database if it hasn't been initialized
256 protected function getConnection() {
257 if (!self
::$dbInit) {
258 $dbName = self
::getDBName();
260 // install test database
261 echo PHP_EOL
. "Installing {$dbName} database" . PHP_EOL
;
263 static::_populateDB(FALSE, $this);
265 self
::$dbInit = TRUE;
271 * Required implementation of abstract method.
273 protected function getDataSet() {
277 * @param bool $perClass
278 * @param null $object
281 * TRUE if the populate logic runs; FALSE if it is skipped
283 protected static function _populateDB($perClass = FALSE, &$object = NULL) {
284 if (CIVICRM_UF
!== 'UnitTests') {
285 throw new \
RuntimeException("_populateDB requires CIVICRM_UF=UnitTests");
288 if ($perClass ||
$object == NULL) {
292 $dbreset = $object->requireDBReset();
295 if (self
::$populateOnce ||
!$dbreset) {
298 self
::$populateOnce = NULL;
300 Civi\Test
::data()->populate();
305 public static function setUpBeforeClass() {
306 static::_populateDB(TRUE);
308 // also set this global hack
309 $GLOBALS['_PEAR_ERRORSTACK_OVERRIDE_CALLBACK'] = [];
313 * Common setup functions for all unit tests.
315 protected function setUp() {
316 $session = CRM_Core_Session
::singleton();
317 $session->set('userID', NULL);
319 $this->_apiversion
= 3;
322 $this->errorScope
= CRM_Core_TemporaryErrorScope
::useException();
323 // Use a temporary file for STDIN
324 $GLOBALS['stdin'] = tmpfile();
325 if ($GLOBALS['stdin'] === FALSE) {
326 echo "Couldn't open temporary file\n";
330 // Get and save a connection to the database
331 $this->_dbconn
= $this->getConnection();
333 // reload database before each test
334 // $this->_populateDB();
336 // "initialize" CiviCRM to avoid problems when running single tests
337 // FIXME: look at it closer in second stage
339 $GLOBALS['civicrm_setting']['domain']['fatalErrorHandler'] = 'CiviUnitTestCase_fatalErrorHandler';
340 $GLOBALS['civicrm_setting']['domain']['backtrace'] = 1;
342 // disable any left-over test extensions
343 CRM_Core_DAO
::executeQuery('DELETE FROM civicrm_extension WHERE full_name LIKE "test.%"');
345 // reset all the caches
346 CRM_Utils_System
::flushCache();
348 // initialize the object once db is loaded
349 \Civi
::$statics = [];
351 $config = CRM_Core_Config
::singleton(TRUE, TRUE);
353 // when running unit tests, use mockup user framework
354 $this->hookClass
= CRM_Utils_Hook
::singleton();
356 // Make sure the DB connection is setup properly
357 $config->userSystem
->setMySQLTimeZone();
358 $env = new CRM_Utils_Check_Component_Env();
359 CRM_Utils_Check
::singleton()->assertValid($env->checkMysqlTime());
361 // clear permissions stub to not check permissions
362 $config->userPermissionClass
->permissions
= NULL;
364 //flush component settings
365 CRM_Core_Component
::getEnabledComponents(TRUE);
367 $_REQUEST = $_GET = $_POST = [];
368 error_reporting(E_ALL
);
370 $this->renameLabels();
371 $this->_sethtmlGlobals();
375 * Read everything from the datasets directory and insert into the db.
377 public function loadAllFixtures() {
378 $fixturesDir = __DIR__
. '/../../fixtures';
380 CRM_Core_DAO
::executeQuery("SET FOREIGN_KEY_CHECKS = 0;");
382 $jsonFiles = glob($fixturesDir . '/*.json');
383 foreach ($jsonFiles as $jsonFixture) {
384 $json = json_decode(file_get_contents($jsonFixture));
385 foreach ($json as $tableName => $vars) {
386 if ($tableName === 'civicrm_contact') {
387 CRM_Core_DAO
::executeQuery('DELETE c FROM civicrm_contact c LEFT JOIN civicrm_domain d ON d.contact_id = c.id WHERE d.id IS NULL');
390 CRM_Core_DAO
::executeQuery("TRUNCATE $tableName");
392 foreach ($vars as $entity) {
393 $keys = $values = [];
394 foreach ($entity as $key => $value) {
396 $values[] = is_numeric($value) ?
$value : "'{$value}'";
398 CRM_Core_DAO
::executeQuery("
399 INSERT INTO $tableName (" . implode(',', $keys) . ') VALUES(' . implode(',', $values) . ')'
406 CRM_Core_DAO
::executeQuery("SET FOREIGN_KEY_CHECKS = 1;");
410 * Load the data that used to be handled by the discontinued dbunit class.
412 * This could do with further tidy up - the initial priority is simply to get rid of
413 * the dbunity package which is no longer supported.
415 * @param string $fileName
417 protected function loadXMLDataSet($fileName) {
418 CRM_Core_DAO
::executeQuery('SET FOREIGN_KEY_CHECKS = 0');
419 $xml = json_decode(json_encode(simplexml_load_file($fileName)), TRUE);
420 foreach ($xml as $tableName => $element) {
421 if (!empty($element)) {
422 foreach ($element as $row) {
423 $keys = $values = [];
424 if (isset($row['@attributes'])) {
425 foreach ($row['@attributes'] as $key => $value) {
427 $values[] = is_numeric($value) ?
$value : "'{$value}'";
430 elseif (!empty($row)) {
431 // cos we copied it & it is inconsistent....
432 foreach ($row as $key => $value) {
434 $values[] = is_numeric($value) ?
$value : "'{$value}'";
438 if (!empty($values)) {
439 CRM_Core_DAO
::executeQuery("
440 INSERT INTO $tableName (" . implode(',', $keys) . ') VALUES(' . implode(',', $values) . ')'
446 CRM_Core_DAO
::executeQuery('SET FOREIGN_KEY_CHECKS = 1');
450 * Create default domain contacts for the two domains added during test class.
451 * database population.
453 public function createDomainContacts() {
454 $this->organizationCreate();
455 $this->organizationCreate(['organization_name' => 'Second Domain']);
459 * Common teardown functions for all unit tests.
461 protected function tearDown() {
462 $this->_apiversion
= 3;
463 $this->resetLabels();
465 error_reporting(E_ALL
& ~E_NOTICE
);
466 CRM_Utils_Hook
::singleton()->reset();
467 if ($this->hookClass
) {
468 $this->hookClass
->reset();
470 CRM_Core_Session
::singleton()->reset(1);
473 $this->tx
->rollback()->commit();
476 CRM_Core_Transaction
::forceRollbackIfEnabled();
477 \Civi\Core\Transaction\Manager
::singleton(TRUE);
480 CRM_Core_Transaction
::forceRollbackIfEnabled();
481 \Civi\Core\Transaction\Manager
::singleton(TRUE);
483 $tablesToTruncate = ['civicrm_contact', 'civicrm_uf_match'];
484 $this->quickCleanup($tablesToTruncate);
485 $this->createDomainContacts();
488 $this->cleanTempDirs();
489 $this->unsetExtensionSystem();
490 $this->assertEquals([], CRM_Core_DAO
::$_nullArray);
491 $this->assertEquals(NULL, CRM_Core_DAO
::$_nullObject);
495 * Create a batch of external API calls which can
496 * be executed concurrently.
499 * $calls = $this->createExternalAPI()
500 * ->addCall('Contact', 'get', ...)
501 * ->addCall('Contact', 'get', ...)
507 * @return \Civi\API\ExternalBatch
508 * @throws PHPUnit_Framework_SkippedTestError
510 public function createExternalAPI() {
511 global $civicrm_root;
513 'version' => $this->_apiversion
,
517 $calls = new \Civi\API\
ExternalBatch($defaultParams);
519 if (!$calls->isSupported()) {
520 $this->markTestSkipped('The test relies on Civi\API\ExternalBatch. This is unsupported in the local environment.');
527 * Create required data based on $this->entity & $this->params
528 * This is just a way to set up the test data for delete & get functions
529 * so the distinction between set
530 * up & tested functions is clearer
535 public function createTestEntity() {
536 return $entity = $this->callAPISuccess($this->entity
, 'create', $this->params
);
540 * @param int $contactTypeId
544 public function contactTypeDelete($contactTypeId) {
545 $result = CRM_Contact_BAO_ContactType
::del($contactTypeId);
547 throw new Exception('Could not delete contact type');
552 * @param array $params
556 public function membershipTypeCreate($params = []) {
557 CRM_Member_PseudoConstant
::flush('membershipType');
558 CRM_Core_Config
::clearDBCache();
559 $this->setupIDs
['contact'] = $memberOfOrganization = $this->organizationCreate();
560 $params = array_merge([
562 'duration_unit' => 'year',
563 'duration_interval' => 1,
564 'period_type' => 'rolling',
565 'member_of_contact_id' => $memberOfOrganization,
567 'financial_type_id' => 2,
570 'visibility' => 'Public',
573 $result = $this->callAPISuccess('MembershipType', 'Create', $params);
575 CRM_Member_PseudoConstant
::flush('membershipType');
576 CRM_Utils_Cache
::singleton()->flush();
578 return $result['id'];
584 * @param array $params
587 * @throws \CRM_Core_Exception
589 public function contactMembershipCreate($params) {
590 $params = array_merge([
591 'join_date' => '2007-01-21',
592 'start_date' => '2007-01-21',
593 'end_date' => '2007-12-21',
594 'source' => 'Payment',
595 'membership_type_id' => 'General',
597 if (!is_numeric($params['membership_type_id'])) {
598 $membershipTypes = $this->callAPISuccess('Membership', 'getoptions', ['action' => 'create', 'field' => 'membership_type_id']);
599 if (!in_array($params['membership_type_id'], $membershipTypes['values'], TRUE)) {
600 $this->membershipTypeCreate(['name' => $params['membership_type_id']]);
604 $result = $this->callAPISuccess('Membership', 'create', $params);
605 return $result['id'];
609 * Delete Membership Type.
611 * @param array $params
613 public function membershipTypeDelete($params) {
614 $this->callAPISuccess('MembershipType', 'Delete', $params);
618 * @param int $membershipID
620 public function membershipDelete($membershipID) {
621 $deleteParams = ['id' => $membershipID];
622 $result = $this->callAPISuccess('Membership', 'Delete', $deleteParams);
626 * @param string $name
630 * @throws \CRM_Core_Exception
632 public function membershipStatusCreate($name = 'test member status') {
633 $params['name'] = $name;
634 $params['start_event'] = 'start_date';
635 $params['end_event'] = 'end_date';
636 $params['is_current_member'] = 1;
637 $params['is_active'] = 1;
639 $result = $this->callAPISuccess('MembershipStatus', 'Create', $params);
640 CRM_Member_PseudoConstant
::flush('membershipStatus');
641 return (int) $result['id'];
645 * Delete the given membership status, deleting any memberships of the status first.
647 * @param int $membershipStatusID
649 * @throws \CRM_Core_Exception
651 public function membershipStatusDelete(int $membershipStatusID) {
652 $this->callAPISuccess('Membership', 'get', ['status_id' => $membershipStatusID, 'api.Membership.delete' => 1]);
653 $this->callAPISuccess('MembershipStatus', 'Delete', ['id' => $membershipStatusID]);
656 public function membershipRenewalDate($durationUnit, $membershipEndDate) {
657 // We only have an end_date if frequency units match, otherwise membership won't be autorenewed and dates won't be calculated.
658 $renewedMembershipEndDate = new DateTime($membershipEndDate);
659 switch ($durationUnit) {
661 $renewedMembershipEndDate->add(new DateInterval('P1Y'));
665 // We have to add 1 day first in case it's the end of the month, then subtract afterwards
666 // eg. 2018-02-28 should renew to 2018-03-31, if we just added 1 month we'd get 2018-03-28
667 $renewedMembershipEndDate->add(new DateInterval('P1D'));
668 $renewedMembershipEndDate->add(new DateInterval('P1M'));
669 $renewedMembershipEndDate->sub(new DateInterval('P1D'));
672 return $renewedMembershipEndDate->format('Y-m-d');
676 * Create a relationship type.
678 * @param array $params
682 * @throws \CRM_Core_Exception
684 public function relationshipTypeCreate($params = []) {
685 $params = array_merge([
686 'name_a_b' => 'Relation 1 for relationship type create',
687 'name_b_a' => 'Relation 2 for relationship type create',
688 'contact_type_a' => 'Individual',
689 'contact_type_b' => 'Organization',
694 $result = $this->callAPISuccess('relationship_type', 'create', $params);
695 CRM_Core_PseudoConstant
::flush('relationshipType');
697 return $result['id'];
701 * Delete Relatinship Type.
703 * @param int $relationshipTypeID
705 public function relationshipTypeDelete($relationshipTypeID) {
706 $params['id'] = $relationshipTypeID;
707 $check = $this->callAPISuccess('relationship_type', 'get', $params);
708 if (!empty($check['count'])) {
709 $this->callAPISuccess('relationship_type', 'delete', $params);
714 * @param array $params
717 * @throws \CRM_Core_Exception
719 public function paymentProcessorTypeCreate($params = NULL) {
720 if (is_null($params)) {
722 'name' => 'API_Test_PP',
723 'title' => 'API Test Payment Processor',
724 'class_name' => 'CRM_Core_Payment_APITest',
725 'billing_mode' => 'form',
731 $result = $this->callAPISuccess('payment_processor_type', 'create', $params);
733 CRM_Core_PseudoConstant
::flush('paymentProcessorType');
735 return $result['id'];
739 * Create test Authorize.net instance.
741 * @param array $params
745 public function paymentProcessorAuthorizeNetCreate($params = []) {
746 $params = array_merge([
747 'name' => 'Authorize',
748 'domain_id' => CRM_Core_Config
::domainID(),
749 'payment_processor_type_id' => 'AuthNet',
750 'title' => 'AuthNet',
755 'user_name' => '4y5BfuW7jm',
756 'password' => '4cAmW927n8uLf5J8',
757 'url_site' => 'https://test.authorize.net/gateway/transact.dll',
758 'url_recur' => 'https://apitest.authorize.net/xml/v1/request.api',
759 'class_name' => 'Payment_AuthorizeNet',
763 $result = $this->callAPISuccess('PaymentProcessor', 'create', $params);
764 return $result['id'];
768 * Create Participant.
770 * @param array $params
771 * Array of contact id and event id values.
774 * $id of participant created
776 public function participantCreate($params = []) {
777 if (empty($params['contact_id'])) {
778 $params['contact_id'] = $this->individualCreate();
780 if (empty($params['event_id'])) {
781 $event = $this->eventCreate();
782 $params['event_id'] = $event['id'];
787 'register_date' => 20070219,
788 'source' => 'Wimbeldon',
789 'event_level' => 'Payment',
793 $params = array_merge($defaults, $params);
794 $result = $this->callAPISuccess('Participant', 'create', $params);
795 return $result['id'];
799 * Create Payment Processor.
802 * Id Payment Processor
804 public function processorCreate($params = []) {
808 'payment_processor_type_id' => 'Dummy',
809 'financial_account_id' => 12,
813 'url_site' => 'http://dummy.com',
814 'url_recur' => 'http://dummy.com',
817 'payment_instrument_id' => 'Debit Card',
819 $processorParams = array_merge($processorParams, $params);
820 $processor = $this->callAPISuccess('PaymentProcessor', 'create', $processorParams);
821 return $processor['id'];
825 * Create Payment Processor.
827 * @param array $processorParams
829 * @return \CRM_Core_Payment_Dummy
830 * Instance of Dummy Payment Processor
832 * @throws \CiviCRM_API3_Exception
834 public function dummyProcessorCreate($processorParams = []) {
835 $paymentProcessorID = $this->processorCreate($processorParams);
836 // For the tests we don't need a live processor, but as core ALWAYS creates a processor in live mode and one in test mode we do need to create both
837 // Otherwise we are testing a scenario that only exists in tests (and some tests fail because the live processor has not been defined).
838 $processorParams['is_test'] = FALSE;
839 $this->processorCreate($processorParams);
840 return System
::singleton()->getById($paymentProcessorID);
844 * Create contribution page.
846 * @param array $params
849 * Array of contribution page
851 public function contributionPageCreate($params = []) {
852 $this->_pageParams
= array_merge([
853 'title' => 'Test Contribution Page',
854 'financial_type_id' => 1,
856 'financial_account_id' => 1,
858 'is_allow_other_amount' => 1,
860 'max_amount' => 1000,
862 return $this->callAPISuccess('contribution_page', 'create', $this->_pageParams
);
866 * Create a sample batch.
868 public function batchCreate() {
869 $params = $this->_params
;
870 $params['name'] = $params['title'] = 'Batch_433397';
871 $params['status_id'] = 1;
872 $result = $this->callAPISuccess('batch', 'create', $params);
873 return $result['id'];
879 * @param array $params
882 * result of created tag
884 public function tagCreate($params = []) {
886 'name' => 'New Tag3',
887 'description' => 'This is description for Our New Tag ',
890 $params = array_merge($defaults, $params);
891 $result = $this->callAPISuccess('Tag', 'create', $params);
892 return $result['values'][$result['id']];
899 * Id of the tag to be deleted.
903 public function tagDelete($tagId) {
904 require_once 'api/api.php';
908 $result = $this->callAPISuccess('Tag', 'delete', $params);
909 return $result['id'];
913 * Add entity(s) to the tag
915 * @param array $params
919 public function entityTagAdd($params) {
920 $result = $this->callAPISuccess('entity_tag', 'create', $params);
927 * @param array $params
931 * id of created pledge
933 * @throws \CRM_Core_Exception
935 public function pledgeCreate($params) {
936 $params = array_merge([
937 'pledge_create_date' => date('Ymd'),
938 'start_date' => date('Ymd'),
939 'scheduled_date' => date('Ymd'),
941 'pledge_status_id' => '2',
942 'financial_type_id' => '1',
943 'pledge_original_installment_amount' => 20,
944 'frequency_interval' => 5,
945 'frequency_unit' => 'year',
946 'frequency_day' => 15,
951 $result = $this->callAPISuccess('Pledge', 'create', $params);
952 return $result['id'];
956 * Delete contribution.
958 * @param int $pledgeId
960 * @throws \CRM_Core_Exception
962 public function pledgeDelete($pledgeId) {
964 'pledge_id' => $pledgeId,
966 $this->callAPISuccess('Pledge', 'delete', $params);
970 * Create contribution.
972 * @param array $params
973 * Array of parameters.
976 * id of created contribution
977 * @throws \CRM_Core_Exception
979 public function contributionCreate($params) {
981 $params = array_merge([
983 'receive_date' => date('Ymd'),
984 'total_amount' => 100.00,
985 'fee_amount' => 5.00,
986 'financial_type_id' => 1,
987 'payment_instrument_id' => 1,
988 'non_deductible_amount' => 10.00,
990 'contribution_status_id' => 1,
993 $result = $this->callAPISuccess('contribution', 'create', $params);
994 return $result['id'];
998 * Delete contribution.
1000 * @param int $contributionId
1003 * @throws \CRM_Core_Exception
1005 public function contributionDelete($contributionId) {
1007 'contribution_id' => $contributionId,
1009 $result = $this->callAPISuccess('contribution', 'delete', $params);
1016 * @param array $params
1017 * Name-value pair for an event.
1020 * @throws \CRM_Core_Exception
1022 public function eventCreate($params = []) {
1023 // if no contact was passed, make up a dummy event creator
1024 if (!isset($params['contact_id'])) {
1025 $params['contact_id'] = $this->_contactCreate([
1026 'contact_type' => 'Individual',
1027 'first_name' => 'Event',
1028 'last_name' => 'Creator',
1032 // set defaults for missing params
1033 $params = array_merge([
1034 'title' => 'Annual CiviCRM meet',
1035 'summary' => 'If you have any CiviCRM related issues or want to track where CiviCRM is heading, Sign up now',
1036 'description' => 'This event is intended to give brief idea about progess of CiviCRM and giving solutions to common user issues',
1037 'event_type_id' => 1,
1039 'start_date' => 20081021,
1040 'end_date' => 20081023,
1041 'is_online_registration' => 1,
1042 'registration_start_date' => 20080601,
1043 'registration_end_date' => 20081015,
1044 'max_participants' => 100,
1045 'event_full_text' => 'Sorry! We are already full',
1048 'is_show_location' => 0,
1049 'is_email_confirm' => 1,
1052 return $this->callAPISuccess('Event', 'create', $params);
1056 * Create a paid event.
1058 * @param array $params
1060 * @param array $options
1062 * @param string $key
1063 * Index for storing event ID in ids array.
1067 * @throws \CRM_Core_Exception
1069 protected function eventCreatePaid($params, $options = [['name' => 'hundy', 'amount' => 100]], $key = 'event') {
1070 $event = $this->eventCreate($params);
1071 $this->ids
['event'][$key] = (int) $event['id'];
1072 $this->priceSetID
= $this->ids
['PriceSet'][] = $this->eventPriceSetCreate(55, 0, 'Radio', $options);
1073 CRM_Price_BAO_PriceSet
::addTo('civicrm_event', $event['id'], $this->priceSetID
);
1074 $priceSet = CRM_Price_BAO_PriceSet
::getSetDetail($this->priceSetID
, TRUE, FALSE);
1075 $priceSet = $priceSet[$this->priceSetID
] ??
NULL;
1076 $this->eventFeeBlock
= $priceSet['fields'] ??
NULL;
1088 public function eventDelete($id) {
1092 return $this->callAPISuccess('event', 'delete', $params);
1096 * Delete participant.
1098 * @param int $participantID
1102 public function participantDelete($participantID) {
1104 'id' => $participantID,
1106 $check = $this->callAPISuccess('Participant', 'get', $params);
1107 if ($check['count'] > 0) {
1108 return $this->callAPISuccess('Participant', 'delete', $params);
1113 * Create participant payment.
1115 * @param int $participantID
1116 * @param int $contributionID
1119 * $id of created payment
1121 public function participantPaymentCreate($participantID, $contributionID = NULL) {
1122 //Create Participant Payment record With Values
1124 'participant_id' => $participantID,
1125 'contribution_id' => $contributionID,
1128 $result = $this->callAPISuccess('participant_payment', 'create', $params);
1129 return $result['id'];
1133 * Delete participant payment.
1135 * @param int $paymentID
1137 public function participantPaymentDelete($paymentID) {
1141 $result = $this->callAPISuccess('participant_payment', 'delete', $params);
1147 * @param int $contactID
1150 * location id of created location
1152 public function locationAdd($contactID) {
1155 'location_type' => 'New Location Type',
1157 'name' => 'Saint Helier St',
1158 'county' => 'Marin',
1159 'country' => 'UNITED STATES',
1160 'state_province' => 'Michigan',
1161 'supplemental_address_1' => 'Hallmark Ct',
1162 'supplemental_address_2' => 'Jersey Village',
1163 'supplemental_address_3' => 'My Town',
1168 'contact_id' => $contactID,
1169 'address' => $address,
1170 'location_format' => '2.0',
1171 'location_type' => 'New Location Type',
1174 $result = $this->callAPISuccess('Location', 'create', $params);
1179 * Delete Locations of contact.
1181 * @param array $params
1184 public function locationDelete($params) {
1185 $this->callAPISuccess('Location', 'delete', $params);
1189 * Add a Location Type.
1191 * @param array $params
1193 * @return CRM_Core_DAO_LocationType
1194 * location id of created location
1196 public function locationTypeCreate($params = NULL) {
1197 if ($params === NULL) {
1199 'name' => 'New Location Type',
1200 'vcard_name' => 'New Location Type',
1201 'description' => 'Location Type for Delete',
1206 $locationType = new CRM_Core_DAO_LocationType();
1207 $locationType->copyValues($params);
1208 $locationType->save();
1209 // clear getfields cache
1210 CRM_Core_PseudoConstant
::flush();
1211 $this->callAPISuccess('phone', 'getfields', ['version' => 3, 'cache_clear' => 1]);
1212 return $locationType;
1216 * Delete a Location Type.
1218 * @param int $locationTypeId
1220 public function locationTypeDelete($locationTypeId) {
1221 $locationType = new CRM_Core_DAO_LocationType();
1222 $locationType->id
= $locationTypeId;
1223 $locationType->delete();
1229 * @param array $params
1231 * @return CRM_Core_DAO_Mapping
1232 * Mapping id of created mapping
1234 public function mappingCreate($params = NULL) {
1235 if ($params === NULL) {
1237 'name' => 'Mapping name',
1238 'description' => 'Mapping description',
1239 // 'Export Contact' mapping.
1240 'mapping_type_id' => 7,
1244 $mapping = new CRM_Core_DAO_Mapping();
1245 $mapping->copyValues($params);
1247 // clear getfields cache
1248 CRM_Core_PseudoConstant
::flush();
1249 $this->callAPISuccess('mapping', 'getfields', ['version' => 3, 'cache_clear' => 1]);
1256 * @param int $mappingId
1258 public function mappingDelete($mappingId) {
1259 $mapping = new CRM_Core_DAO_Mapping();
1260 $mapping->id
= $mappingId;
1265 * Prepare class for ACLs.
1267 protected function prepareForACLs() {
1268 $config = CRM_Core_Config
::singleton();
1269 $config->userPermissionClass
->permissions
= [];
1275 protected function cleanUpAfterACLs() {
1276 CRM_Utils_Hook
::singleton()->reset();
1277 $tablesToTruncate = [
1279 'civicrm_acl_cache',
1280 'civicrm_acl_entity_role',
1281 'civicrm_acl_contact_cache',
1283 $this->quickCleanup($tablesToTruncate);
1284 $config = CRM_Core_Config
::singleton();
1285 unset($config->userPermissionClass
->permissions
);
1289 * Create a smart group.
1291 * By default it will be a group of households.
1293 * @param array $smartGroupParams
1294 * @param array $groupParams
1295 * @param string $contactType
1299 public function smartGroupCreate($smartGroupParams = [], $groupParams = [], $contactType = 'Household') {
1300 $smartGroupParams = array_merge(['form_values' => ['contact_type' => ['IN' => [$contactType]]]], $smartGroupParams);
1301 $savedSearch = CRM_Contact_BAO_SavedSearch
::create($smartGroupParams);
1303 $groupParams['saved_search_id'] = $savedSearch->id
;
1304 return $this->groupCreate($groupParams);
1310 * @param array $params
1312 public function uFFieldCreate($params = []) {
1313 $params = array_merge([
1315 'field_name' => 'first_name',
1318 'visibility' => 'Public Pages and Listings',
1319 'is_searchable' => '1',
1320 'label' => 'first_name',
1321 'field_type' => 'Individual',
1324 $this->callAPISuccess('uf_field', 'create', $params);
1328 * Add a UF Join Entry.
1330 * @param array $params
1333 * $id of created UF Join
1335 public function ufjoinCreate($params = NULL) {
1336 if ($params === NULL) {
1339 'module' => 'CiviEvent',
1340 'entity_table' => 'civicrm_event',
1346 $result = $this->callAPISuccess('uf_join', 'create', $params);
1351 * @param array $params
1352 * Optional parameters.
1353 * @param bool $reloadConfig
1354 * While enabling CiviCampaign component, we shouldn't always forcibly
1355 * reload config as this hinder hook call in test environment
1360 public function campaignCreate($params = [], $reloadConfig = TRUE) {
1361 $this->enableCiviCampaign($reloadConfig);
1362 $campaign = $this->callAPISuccess('campaign', 'create', array_merge([
1363 'name' => 'big_campaign',
1364 'title' => 'Campaign',
1366 return $campaign['id'];
1370 * Create Group for a contact.
1372 * @param int $contactId
1374 public function contactGroupCreate($contactId) {
1376 'contact_id.1' => $contactId,
1380 $this->callAPISuccess('GroupContact', 'Create', $params);
1384 * Delete Group for a contact.
1386 * @param int $contactId
1388 public function contactGroupDelete($contactId) {
1390 'contact_id.1' => $contactId,
1393 $this->civicrm_api('GroupContact', 'Delete', $params);
1399 * @param array $params
1403 * @throws \CRM_Core_Exception
1404 * @throws \CiviCRM_API3_Exception
1406 public function activityCreate($params = []) {
1407 $params = array_merge([
1408 'subject' => 'Discussion on warm beer',
1409 'activity_date_time' => date('Ymd'),
1411 'location' => 'Baker Street',
1412 'details' => 'Lets schedule a meeting',
1414 'activity_type_id' => 'Meeting',
1416 if (!isset($params['source_contact_id'])) {
1417 $params['source_contact_id'] = $this->individualCreate();
1419 if (!isset($params['target_contact_id'])) {
1420 $params['target_contact_id'] = $this->individualCreate([
1421 'first_name' => 'Julia',
1422 'last_name' => 'Anderson',
1424 'email' => 'julia_anderson@civicrm.org',
1425 'contact_type' => 'Individual',
1428 if (!isset($params['assignee_contact_id'])) {
1429 $params['assignee_contact_id'] = $params['target_contact_id'];
1432 $result = civicrm_api3('Activity', 'create', $params);
1434 $result['target_contact_id'] = $params['target_contact_id'];
1435 $result['assignee_contact_id'] = $params['assignee_contact_id'];
1440 * Create an activity type.
1442 * @param array $params
1447 public function activityTypeCreate($params) {
1448 return $this->callAPISuccess('ActivityType', 'create', $params);
1452 * Delete activity type.
1454 * @param int $activityTypeId
1455 * Id of the activity type.
1459 public function activityTypeDelete($activityTypeId) {
1460 $params['activity_type_id'] = $activityTypeId;
1461 return $this->callAPISuccess('ActivityType', 'delete', $params);
1465 * Create custom group.
1467 * @param array $params
1471 public function customGroupCreate($params = []) {
1473 'title' => 'new custom group',
1474 'extends' => 'Contact',
1476 'style' => 'Inline',
1480 $params = array_merge($defaults, $params);
1482 return $this->callAPISuccess('custom_group', 'create', $params);
1486 * Existing function doesn't allow params to be over-ridden so need a new one
1487 * this one allows you to only pass in the params you want to change
1489 * @param array $params
1493 public function CustomGroupCreateByParams($params = []) {
1495 'title' => "API Custom Group",
1496 'extends' => 'Contact',
1498 'style' => 'Inline',
1501 $params = array_merge($defaults, $params);
1502 return $this->callAPISuccess('custom_group', 'create', $params);
1506 * Create custom group with multi fields.
1508 * @param array $params
1512 public function CustomGroupMultipleCreateByParams($params = []) {
1517 $params = array_merge($defaults, $params);
1518 return $this->CustomGroupCreateByParams($params);
1522 * Create custom group with multi fields.
1524 * @param array $params
1528 public function CustomGroupMultipleCreateWithFields($params = []) {
1529 // also need to pass on $params['custom_field'] if not set but not in place yet
1531 $customGroup = $this->CustomGroupMultipleCreateByParams($params);
1532 $ids['custom_group_id'] = $customGroup['id'];
1534 $customField = $this->customFieldCreate([
1535 'custom_group_id' => $ids['custom_group_id'],
1536 'label' => 'field_1' . $ids['custom_group_id'],
1540 $ids['custom_field_id'][] = $customField['id'];
1542 $customField = $this->customFieldCreate([
1543 'custom_group_id' => $ids['custom_group_id'],
1544 'default_value' => '',
1545 'label' => 'field_2' . $ids['custom_group_id'],
1548 $ids['custom_field_id'][] = $customField['id'];
1550 $customField = $this->customFieldCreate([
1551 'custom_group_id' => $ids['custom_group_id'],
1552 'default_value' => '',
1553 'label' => 'field_3' . $ids['custom_group_id'],
1556 $ids['custom_field_id'][] = $customField['id'];
1562 * Create a custom group with a single text custom field. See
1563 * participant:testCreateWithCustom for how to use this
1565 * @param string $function
1567 * @param string $filename
1571 * ids of created objects
1573 public function entityCustomGroupWithSingleFieldCreate($function, $filename) {
1574 $params = ['title' => $function];
1575 $entity = substr(basename($filename), 0, strlen(basename($filename)) - 8);
1576 $params['extends'] = $entity ?
$entity : 'Contact';
1577 $customGroup = $this->customGroupCreate($params);
1578 $customField = $this->customFieldCreate(['custom_group_id' => $customGroup['id'], 'label' => $function]);
1579 CRM_Core_PseudoConstant
::flush();
1581 return ['custom_group_id' => $customGroup['id'], 'custom_field_id' => $customField['id']];
1585 * Create a custom group with a single text custom field, multi-select widget, with a variety of option values including upper and lower case.
1586 * See api_v3_SyntaxConformanceTest:testCustomDataGet for how to use this
1588 * @param string $function
1590 * @param string $filename
1594 * ids of created objects
1596 public function entityCustomGroupWithSingleStringMultiSelectFieldCreate($function, $filename) {
1597 $params = ['title' => $function];
1598 $entity = substr(basename($filename), 0, strlen(basename($filename)) - 8);
1599 $params['extends'] = $entity ?
$entity : 'Contact';
1600 $customGroup = $this->customGroupCreate($params);
1601 $customField = $this->customFieldCreate(['custom_group_id' => $customGroup['id'], 'label' => $function, 'html_type' => 'Multi-Select', 'default_value' => 1]);
1602 CRM_Core_PseudoConstant
::flush();
1604 'defaultValue' => 'Default Value',
1605 'lowercasevalue' => 'Lowercase Value',
1606 1 => 'Integer Value',
1609 $custom_field_params = ['sequential' => 1, 'id' => $customField['id']];
1610 $custom_field_api_result = $this->callAPISuccess('custom_field', 'get', $custom_field_params);
1611 $this->assertNotEmpty($custom_field_api_result['values'][0]['option_group_id']);
1612 $option_group_params = ['sequential' => 1, 'id' => $custom_field_api_result['values'][0]['option_group_id']];
1613 $option_group_result = $this->callAPISuccess('OptionGroup', 'get', $option_group_params);
1614 $this->assertNotEmpty($option_group_result['values'][0]['name']);
1615 foreach ($options as $option_value => $option_label) {
1616 $option_group_params = ['option_group_id' => $option_group_result['values'][0]['name'], 'value' => $option_value, 'label' => $option_label];
1617 $option_value_result = $this->callAPISuccess('OptionValue', 'create', $option_group_params);
1621 'custom_group_id' => $customGroup['id'],
1622 'custom_field_id' => $customField['id'],
1623 'custom_field_option_group_id' => $custom_field_api_result['values'][0]['option_group_id'],
1624 'custom_field_group_options' => $options,
1629 * Delete custom group.
1631 * @param int $customGroupID
1635 public function customGroupDelete($customGroupID) {
1636 $params['id'] = $customGroupID;
1637 return $this->callAPISuccess('custom_group', 'delete', $params);
1641 * Create custom field.
1643 * @param array $params
1644 * (custom_group_id) is required.
1648 public function customFieldCreate($params) {
1649 $params = array_merge([
1650 'label' => 'Custom Field',
1651 'data_type' => 'String',
1652 'html_type' => 'Text',
1653 'is_searchable' => 1,
1655 'default_value' => 'defaultValue',
1658 $result = $this->callAPISuccess('custom_field', 'create', $params);
1659 // these 2 functions are called with force to flush static caches
1660 CRM_Core_BAO_CustomField
::getTableColumnGroup($result['id'], 1);
1661 CRM_Core_Component
::getEnabledComponents(1);
1666 * Delete custom field.
1668 * @param int $customFieldID
1672 public function customFieldDelete($customFieldID) {
1674 $params['id'] = $customFieldID;
1675 return $this->callAPISuccess('custom_field', 'delete', $params);
1685 public function noteCreate($cId) {
1687 'entity_table' => 'civicrm_contact',
1688 'entity_id' => $cId,
1689 'note' => 'hello I am testing Note',
1690 'contact_id' => $cId,
1691 'modified_date' => date('Ymd'),
1692 'subject' => 'Test Note',
1695 return $this->callAPISuccess('Note', 'create', $params);
1699 * Enable CiviCampaign Component.
1701 * @param bool $reloadConfig
1702 * Force relaod config or not
1704 public function enableCiviCampaign($reloadConfig = TRUE) {
1705 CRM_Core_BAO_ConfigSetting
::enableComponent('CiviCampaign');
1706 if ($reloadConfig) {
1707 // force reload of config object
1708 $config = CRM_Core_Config
::singleton(TRUE, TRUE);
1710 //flush cache by calling with reset
1711 $activityTypes = CRM_Core_PseudoConstant
::activityType(TRUE, TRUE, TRUE, 'name', TRUE);
1715 * Create custom field with Option Values.
1717 * @param array $customGroup
1718 * @param string $name
1719 * Name of custom field.
1720 * @param array $extraParams
1721 * Additional parameters to pass through.
1725 public function customFieldOptionValueCreate($customGroup, $name, $extraParams = []) {
1727 'custom_group_id' => $customGroup['id'],
1728 'name' => 'test_custom_group',
1729 'label' => 'Country',
1730 'html_type' => 'Select',
1731 'data_type' => 'String',
1734 'is_searchable' => 0,
1740 'name' => 'option_group1',
1741 'label' => 'option_group_label1',
1745 'option_label' => ['Label1', 'Label2'],
1746 'option_value' => ['value1', 'value2'],
1747 'option_name' => [$name . '_1', $name . '_2'],
1748 'option_weight' => [1, 2],
1749 'option_status' => [1, 1],
1752 $params = array_merge($fieldParams, $optionGroup, $optionValue, $extraParams);
1754 return $this->callAPISuccess('custom_field', 'create', $params);
1762 public function confirmEntitiesDeleted($entities) {
1763 foreach ($entities as $entity) {
1765 $result = $this->callAPISuccess($entity, 'Get', []);
1766 if ($result['error'] == 1 ||
$result['count'] > 0) {
1767 // > than $entity[0] to allow a value to be passed in? e.g. domain?
1775 * Quick clean by emptying tables created for the test.
1777 * @param array $tablesToTruncate
1778 * @param bool $dropCustomValueTables
1780 * @throws \CRM_Core_Exception
1782 public function quickCleanup($tablesToTruncate, $dropCustomValueTables = FALSE) {
1784 throw new \
CRM_Core_Exception("CiviUnitTestCase: quickCleanup() is not compatible with useTransaction()");
1786 if ($dropCustomValueTables) {
1787 $optionGroupResult = CRM_Core_DAO
::executeQuery('SELECT option_group_id FROM civicrm_custom_field');
1788 while ($optionGroupResult->fetch()) {
1789 // We have a test that sets the option_group_id for a custom group to that of 'activity_type'.
1790 // Then test tearDown deletes it. This is all mildly terrifying but for the context here we can be pretty
1791 // sure the low-numbered (50 is arbitrary) option groups are not ones to 'just delete' in a
1792 // generic cleanup routine.
1793 if (!empty($optionGroupResult->option_group_id
) && $optionGroupResult->option_group_id
> 50) {
1794 CRM_Core_DAO
::executeQuery('DELETE FROM civicrm_option_group WHERE id = ' . $optionGroupResult->option_group_id
);
1797 $tablesToTruncate[] = 'civicrm_custom_group';
1798 $tablesToTruncate[] = 'civicrm_custom_field';
1801 $tablesToTruncate = array_unique(array_merge($this->_tablesToTruncate
, $tablesToTruncate));
1803 CRM_Core_DAO
::executeQuery("SET FOREIGN_KEY_CHECKS = 0;");
1804 foreach ($tablesToTruncate as $table) {
1805 $sql = "TRUNCATE TABLE $table";
1806 CRM_Core_DAO
::executeQuery($sql);
1808 CRM_Core_DAO
::executeQuery("SET FOREIGN_KEY_CHECKS = 1;");
1810 if ($dropCustomValueTables) {
1811 $dbName = self
::getDBName();
1813 SELECT TABLE_NAME as tableName
1814 FROM INFORMATION_SCHEMA.TABLES
1815 WHERE TABLE_SCHEMA = '{$dbName}'
1816 AND ( TABLE_NAME LIKE 'civicrm_value_%' )
1819 $tableDAO = CRM_Core_DAO
::executeQuery($query);
1820 while ($tableDAO->fetch()) {
1821 $sql = "DROP TABLE {$tableDAO->tableName}";
1822 CRM_Core_DAO
::executeQuery($sql);
1828 * Clean up financial entities after financial tests (so we remember to get all the tables :-))
1830 * @throws \CRM_Core_Exception
1832 public function quickCleanUpFinancialEntities() {
1833 $tablesToTruncate = [
1835 'civicrm_activity_contact',
1836 'civicrm_contribution',
1837 'civicrm_contribution_soft',
1838 'civicrm_contribution_product',
1839 'civicrm_financial_trxn',
1840 'civicrm_financial_item',
1841 'civicrm_contribution_recur',
1842 'civicrm_line_item',
1843 'civicrm_contribution_page',
1844 'civicrm_payment_processor',
1845 'civicrm_entity_financial_trxn',
1846 'civicrm_membership',
1847 'civicrm_membership_type',
1848 'civicrm_membership_payment',
1849 'civicrm_membership_log',
1850 'civicrm_membership_block',
1852 'civicrm_participant',
1853 'civicrm_participant_payment',
1855 'civicrm_pcp_block',
1857 'civicrm_pledge_block',
1858 'civicrm_pledge_payment',
1859 'civicrm_price_set_entity',
1860 'civicrm_price_field_value',
1861 'civicrm_price_field',
1863 $this->quickCleanup($tablesToTruncate);
1864 CRM_Core_DAO
::executeQuery("DELETE FROM civicrm_membership_status WHERE name NOT IN('New', 'Current', 'Grace', 'Expired', 'Pending', 'Cancelled', 'Deceased')");
1865 $this->restoreDefaultPriceSetConfig();
1866 $this->disableTaxAndInvoicing();
1867 $this->setCurrencySeparators(',');
1868 CRM_Core_PseudoConstant
::flush('taxRates');
1869 System
::singleton()->flushProcessors();
1870 // @fixme this parameter is leaking - it should not be defined as a class static
1871 // but for now we just handle in tear down.
1872 CRM_Contribute_BAO_Query
::$_contribOrSoftCredit = 'only contribs';
1876 * Reset the price set config so results exist.
1878 public function restoreDefaultPriceSetConfig() {
1879 CRM_Core_DAO
::executeQuery("DELETE FROM civicrm_price_set WHERE name NOT IN('default_contribution_amount', 'default_membership_type_amount')");
1880 CRM_Core_DAO
::executeQuery("UPDATE civicrm_price_set SET id = 1 WHERE name ='default_contribution_amount'");
1881 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)");
1882 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)");
1886 * Recreate default membership types.
1888 public function restoreMembershipTypes() {
1889 CRM_Core_DAO
::executeQuery(
1890 "REPLACE INTO civicrm_membership_type
1891 (id, domain_id, name, description, member_of_contact_id, financial_type_id, minimum_fee, duration_unit, duration_interval, period_type, fixed_period_start_day, fixed_period_rollover_day, relationship_type_id, relationship_direction, visibility, weight, is_active)
1893 (1, 1, 'General', 'Regular annual membership.', 1, 2, 100.00, 'year', 2, 'rolling', NULL, NULL, 7, 'b_a', 'Public', 1, 1),
1894 (2, 1, 'Student', 'Discount membership for full-time students.', 1, 2, 50.00, 'year', 1, 'rolling', NULL, NULL, NULL, NULL, 'Public', 2, 1),
1895 (3, 1, 'Lifetime', 'Lifetime membership.', 1, 2, 1200.00, 'lifetime', 1, 'rolling', NULL, NULL, 7, 'b_a', 'Admin', 3, 1);
1900 * Function does a 'Get' on the entity & compares the fields in the Params with those returned
1901 * Default behaviour is to also delete the entity
1902 * @param array $params
1903 * Params array to check against.
1905 * Id of the entity concerned.
1906 * @param string $entity
1907 * Name of entity concerned (e.g. membership).
1908 * @param bool $delete
1909 * Should the entity be deleted as part of this check.
1910 * @param string $errorText
1911 * Text to print on error.
1915 * @param array $params
1918 * @param int $delete
1919 * @param string $errorText
1921 * @throws CRM_Core_Exception
1923 public function getAndCheck($params, $id, $entity, $delete = 1, $errorText = '') {
1925 $result = $this->callAPISuccessGetSingle($entity, [
1930 $this->callAPISuccess($entity, 'Delete', [
1934 $dateFields = $keys = $dateTimeFields = [];
1935 $fields = $this->callAPISuccess($entity, 'getfields', ['version' => 3, 'action' => 'get']);
1936 foreach ($fields['values'] as $field => $settings) {
1937 if (array_key_exists($field, $result)) {
1938 $keys[CRM_Utils_Array
::value('name', $settings, $field)] = $field;
1941 $keys[CRM_Utils_Array
::value('name', $settings, $field)] = CRM_Utils_Array
::value('name', $settings, $field);
1943 $type = $settings['type'] ??
NULL;
1944 if ($type == CRM_Utils_Type
::T_DATE
) {
1945 $dateFields[] = $settings['name'];
1946 // we should identify both real names & unique names as dates
1947 if ($field != $settings['name']) {
1948 $dateFields[] = $field;
1951 if ($type == CRM_Utils_Type
::T_DATE + CRM_Utils_Type
::T_TIME
) {
1952 $dateTimeFields[] = $settings['name'];
1953 // we should identify both real names & unique names as dates
1954 if ($field != $settings['name']) {
1955 $dateTimeFields[] = $field;
1960 if (strtolower($entity) == 'contribution') {
1961 $params['receive_date'] = date('Y-m-d', strtotime($params['receive_date']));
1962 // this is not returned in id format
1963 unset($params['payment_instrument_id']);
1964 $params['contribution_source'] = $params['source'];
1965 unset($params['source']);
1968 foreach ($params as $key => $value) {
1969 if ($key == 'version' ||
substr($key, 0, 3) == 'api' ||
!array_key_exists($keys[$key], $result)) {
1972 if (in_array($key, $dateFields)) {
1973 $value = date('Y-m-d', strtotime($value));
1974 $result[$key] = date('Y-m-d', strtotime($result[$key]));
1976 if (in_array($key, $dateTimeFields)) {
1977 $value = date('Y-m-d H:i:s', strtotime($value));
1978 $result[$keys[$key]] = date('Y-m-d H:i:s', strtotime(CRM_Utils_Array
::value($keys[$key], $result, CRM_Utils_Array
::value($key, $result))));
1980 $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);
1985 * Get formatted values in the actual and expected result.
1987 * @param array $actual
1988 * Actual calculated values.
1989 * @param array $expected
1992 public function checkArrayEquals(&$actual, &$expected) {
1993 self
::unsetId($actual);
1994 self
::unsetId($expected);
1995 $this->assertEquals($expected, $actual);
1999 * Unset the key 'id' from the array
2001 * @param array $unformattedArray
2002 * The array from which the 'id' has to be unset.
2004 public static function unsetId(&$unformattedArray) {
2005 $formattedArray = [];
2006 if (array_key_exists('id', $unformattedArray)) {
2007 unset($unformattedArray['id']);
2009 if (!empty($unformattedArray['values']) && is_array($unformattedArray['values'])) {
2010 foreach ($unformattedArray['values'] as $key => $value) {
2011 if (is_array($value)) {
2012 foreach ($value as $k => $v) {
2018 elseif ($key == 'id') {
2019 $unformattedArray[$key];
2021 $formattedArray = [$value];
2023 $unformattedArray['values'] = $formattedArray;
2028 * Helper to enable/disable custom directory support
2030 * @param array $customDirs
2032 * 'php_path' Set to TRUE to use the default, FALSE or "" to disable support, or a string path to use another path
2033 * 'template_path' Set to TRUE to use the default, FALSE or "" to disable support, or a string path to use another path
2035 public function customDirectories($customDirs) {
2036 $config = CRM_Core_Config
::singleton();
2038 if (empty($customDirs['php_path']) ||
$customDirs['php_path'] === FALSE) {
2039 unset($config->customPHPPathDir
);
2041 elseif ($customDirs['php_path'] === TRUE) {
2042 $config->customPHPPathDir
= dirname(dirname(__FILE__
)) . '/custom_directories/php/';
2045 $config->customPHPPathDir
= $php_path;
2048 if (empty($customDirs['template_path']) ||
$customDirs['template_path'] === FALSE) {
2049 unset($config->customTemplateDir
);
2051 elseif ($customDirs['template_path'] === TRUE) {
2052 $config->customTemplateDir
= dirname(dirname(__FILE__
)) . '/custom_directories/templates/';
2055 $config->customTemplateDir
= $template_path;
2060 * Generate a temporary folder.
2062 * @param string $prefix
2066 public function createTempDir($prefix = 'test-') {
2067 $tempDir = CRM_Utils_File
::tempdir($prefix);
2068 $this->tempDirs
[] = $tempDir;
2072 public function cleanTempDirs() {
2073 if (!is_array($this->tempDirs
)) {
2074 // fix test errors where this is not set
2077 foreach ($this->tempDirs
as $tempDir) {
2078 if (is_dir($tempDir)) {
2079 CRM_Utils_File
::cleanDir($tempDir, TRUE, FALSE);
2085 * Temporarily replace the singleton extension with a different one.
2087 * @param \CRM_Extension_System $system
2089 public function setExtensionSystem(CRM_Extension_System
$system) {
2090 if ($this->origExtensionSystem
== NULL) {
2091 $this->origExtensionSystem
= CRM_Extension_System
::singleton();
2093 CRM_Extension_System
::setSingleton($this->origExtensionSystem
);
2096 public function unsetExtensionSystem() {
2097 if ($this->origExtensionSystem
!== NULL) {
2098 CRM_Extension_System
::setSingleton($this->origExtensionSystem
);
2099 $this->origExtensionSystem
= NULL;
2104 * Temporarily alter the settings-metadata to add a mock setting.
2106 * WARNING: The setting metadata will disappear on the next cache-clear.
2112 public function setMockSettingsMetaData($extras) {
2113 CRM_Utils_Hook
::singleton()
2114 ->setHook('civicrm_alterSettingsMetaData', function (&$metadata, $domainId, $profile) use ($extras) {
2115 $metadata = array_merge($metadata, $extras);
2118 Civi
::service('settings_manager')->flush();
2120 $fields = $this->callAPISuccess('setting', 'getfields', []);
2121 foreach ($extras as $key => $spec) {
2122 $this->assertNotEmpty($spec['title']);
2123 $this->assertEquals($spec['title'], $fields['values'][$key]['title']);
2128 * @param string $name
2130 public function financialAccountDelete($name) {
2131 $financialAccount = new CRM_Financial_DAO_FinancialAccount();
2132 $financialAccount->name
= $name;
2133 if ($financialAccount->find(TRUE)) {
2134 $entityFinancialType = new CRM_Financial_DAO_EntityFinancialAccount();
2135 $entityFinancialType->financial_account_id
= $financialAccount->id
;
2136 $entityFinancialType->delete();
2137 $financialAccount->delete();
2142 * FIXME: something NULLs $GLOBALS['_HTML_QuickForm_registered_rules'] when the tests are ran all together
2143 * (NB unclear if this is still required)
2145 public function _sethtmlGlobals() {
2146 $GLOBALS['_HTML_QuickForm_registered_rules'] = [
2148 'html_quickform_rule_required',
2149 'HTML/QuickForm/Rule/Required.php',
2152 'html_quickform_rule_range',
2153 'HTML/QuickForm/Rule/Range.php',
2156 'html_quickform_rule_range',
2157 'HTML/QuickForm/Rule/Range.php',
2160 'html_quickform_rule_range',
2161 'HTML/QuickForm/Rule/Range.php',
2164 'html_quickform_rule_email',
2165 'HTML/QuickForm/Rule/Email.php',
2168 'html_quickform_rule_regex',
2169 'HTML/QuickForm/Rule/Regex.php',
2172 'html_quickform_rule_regex',
2173 'HTML/QuickForm/Rule/Regex.php',
2176 'html_quickform_rule_regex',
2177 'HTML/QuickForm/Rule/Regex.php',
2180 'html_quickform_rule_regex',
2181 'HTML/QuickForm/Rule/Regex.php',
2183 'nopunctuation' => [
2184 'html_quickform_rule_regex',
2185 'HTML/QuickForm/Rule/Regex.php',
2188 'html_quickform_rule_regex',
2189 'HTML/QuickForm/Rule/Regex.php',
2192 'html_quickform_rule_callback',
2193 'HTML/QuickForm/Rule/Callback.php',
2196 'html_quickform_rule_compare',
2197 'HTML/QuickForm/Rule/Compare.php',
2200 // FIXME: …ditto for $GLOBALS['HTML_QUICKFORM_ELEMENT_TYPES']
2201 $GLOBALS['HTML_QUICKFORM_ELEMENT_TYPES'] = [
2203 'HTML/QuickForm/group.php',
2204 'HTML_QuickForm_group',
2207 'HTML/QuickForm/hidden.php',
2208 'HTML_QuickForm_hidden',
2211 'HTML/QuickForm/reset.php',
2212 'HTML_QuickForm_reset',
2215 'HTML/QuickForm/checkbox.php',
2216 'HTML_QuickForm_checkbox',
2219 'HTML/QuickForm/file.php',
2220 'HTML_QuickForm_file',
2223 'HTML/QuickForm/image.php',
2224 'HTML_QuickForm_image',
2227 'HTML/QuickForm/password.php',
2228 'HTML_QuickForm_password',
2231 'HTML/QuickForm/radio.php',
2232 'HTML_QuickForm_radio',
2235 'HTML/QuickForm/button.php',
2236 'HTML_QuickForm_button',
2239 'HTML/QuickForm/submit.php',
2240 'HTML_QuickForm_submit',
2243 'HTML/QuickForm/select.php',
2244 'HTML_QuickForm_select',
2247 'HTML/QuickForm/hiddenselect.php',
2248 'HTML_QuickForm_hiddenselect',
2251 'HTML/QuickForm/text.php',
2252 'HTML_QuickForm_text',
2255 'HTML/QuickForm/textarea.php',
2256 'HTML_QuickForm_textarea',
2259 'HTML/QuickForm/fckeditor.php',
2260 'HTML_QuickForm_FCKEditor',
2263 'HTML/QuickForm/tinymce.php',
2264 'HTML_QuickForm_TinyMCE',
2267 'HTML/QuickForm/dojoeditor.php',
2268 'HTML_QuickForm_dojoeditor',
2271 'HTML/QuickForm/link.php',
2272 'HTML_QuickForm_link',
2275 'HTML/QuickForm/advcheckbox.php',
2276 'HTML_QuickForm_advcheckbox',
2279 'HTML/QuickForm/date.php',
2280 'HTML_QuickForm_date',
2283 'HTML/QuickForm/static.php',
2284 'HTML_QuickForm_static',
2287 'HTML/QuickForm/header.php',
2288 'HTML_QuickForm_header',
2291 'HTML/QuickForm/html.php',
2292 'HTML_QuickForm_html',
2295 'HTML/QuickForm/hierselect.php',
2296 'HTML_QuickForm_hierselect',
2299 'HTML/QuickForm/autocomplete.php',
2300 'HTML_QuickForm_autocomplete',
2303 'HTML/QuickForm/xbutton.php',
2304 'HTML_QuickForm_xbutton',
2306 'advmultiselect' => [
2307 'HTML/QuickForm/advmultiselect.php',
2308 'HTML_QuickForm_advmultiselect',
2314 * Set up an acl allowing contact to see 2 specified groups
2315 * - $this->_permissionedGroup & $this->_permissionedDisabledGroup
2317 * You need to have pre-created these groups & created the user e.g
2318 * $this->createLoggedInUser();
2319 * $this->_permissionedDisabledGroup = $this->groupCreate(array('title' => 'pick-me-disabled', 'is_active' => 0, 'name' => 'pick-me-disabled'));
2320 * $this->_permissionedGroup = $this->groupCreate(array('title' => 'pick-me-active', 'is_active' => 1, 'name' => 'pick-me-active'));
2322 * @param bool $isProfile
2324 public function setupACL($isProfile = FALSE) {
2326 $_REQUEST = $this->_params
;
2328 CRM_Core_Config
::singleton()->userPermissionClass
->permissions
= ['access CiviCRM'];
2329 $optionGroupID = $this->callAPISuccessGetValue('option_group', ['return' => 'id', 'name' => 'acl_role']);
2330 $ov = new CRM_Core_DAO_OptionValue();
2331 $ov->option_group_id
= $optionGroupID;
2333 if ($ov->find(TRUE)) {
2334 CRM_Core_DAO
::executeQuery("DELETE FROM civicrm_option_value WHERE id = {$ov->id}");
2336 $optionValue = $this->callAPISuccess('option_value', 'create', [
2337 'option_group_id' => $optionGroupID,
2338 'label' => 'pick me',
2342 CRM_Core_DAO
::executeQuery("
2343 TRUNCATE civicrm_acl_cache
2346 CRM_Core_DAO
::executeQuery("
2347 TRUNCATE civicrm_acl_contact_cache
2350 CRM_Core_DAO
::executeQuery("
2351 INSERT INTO civicrm_acl_entity_role (
2352 `acl_role_id`, `entity_table`, `entity_id`, `is_active`
2353 ) VALUES (55, 'civicrm_group', {$this->_permissionedGroup}, 1);
2357 CRM_Core_DAO
::executeQuery("
2358 INSERT INTO civicrm_acl (
2359 `name`, `entity_table`, `entity_id`, `operation`, `object_table`, `object_id`, `is_active`
2362 'view picked', 'civicrm_acl_role', 55, 'Edit', 'civicrm_uf_group', 0, 1
2367 CRM_Core_DAO
::executeQuery("
2368 INSERT INTO civicrm_acl (
2369 `name`, `entity_table`, `entity_id`, `operation`, `object_table`, `object_id`, `is_active`
2372 'view picked', 'civicrm_group', $this->_permissionedGroup , 'Edit', 'civicrm_saved_search', {$this->_permissionedGroup}, 1
2376 CRM_Core_DAO
::executeQuery("
2377 INSERT INTO civicrm_acl (
2378 `name`, `entity_table`, `entity_id`, `operation`, `object_table`, `object_id`, `is_active`
2381 'view picked', 'civicrm_group', $this->_permissionedGroup, 'Edit', 'civicrm_saved_search', {$this->_permissionedDisabledGroup}, 1
2386 $this->_loggedInUser
= CRM_Core_Session
::singleton()->get('userID');
2387 $this->callAPISuccess('group_contact', 'create', [
2388 'group_id' => $this->_permissionedGroup
,
2389 'contact_id' => $this->_loggedInUser
,
2394 CRM_ACL_BAO_Cache
::resetCache();
2395 CRM_ACL_API
::groupPermission('whatever', 9999, NULL, 'civicrm_saved_search', NULL, NULL);
2400 * Alter default price set so that the field numbers are not all 1 (hiding errors)
2402 public function offsetDefaultPriceSet() {
2403 $contributionPriceSet = $this->callAPISuccess('price_set', 'getsingle', ['name' => 'default_contribution_amount']);
2404 $firstID = $contributionPriceSet['id'];
2405 $this->callAPISuccess('price_set', 'create', [
2406 'id' => $contributionPriceSet['id'],
2410 unset($contributionPriceSet['id']);
2411 $newPriceSet = $this->callAPISuccess('price_set', 'create', $contributionPriceSet);
2412 $priceField = $this->callAPISuccess('price_field', 'getsingle', [
2413 'price_set_id' => $firstID,
2414 'options' => ['limit' => 1],
2416 unset($priceField['id']);
2417 $priceField['price_set_id'] = $newPriceSet['id'];
2418 $newPriceField = $this->callAPISuccess('price_field', 'create', $priceField);
2419 $priceFieldValue = $this->callAPISuccess('price_field_value', 'getsingle', [
2420 'price_set_id' => $firstID,
2422 'options' => ['limit' => 1],
2425 unset($priceFieldValue['id']);
2426 //create some padding to use up ids
2427 $this->callAPISuccess('price_field_value', 'create', $priceFieldValue);
2428 $this->callAPISuccess('price_field_value', 'create', $priceFieldValue);
2429 $this->callAPISuccess('price_field_value', 'create', array_merge($priceFieldValue, ['price_field_id' => $newPriceField['id']]));
2433 * Create an instance of the paypal processor.
2435 * @todo this isn't a great place to put it - but really it belongs on a class that extends
2436 * this parent class & we don't have a structure for that yet
2437 * There is another function to this effect on the PaypalPro test but it appears to be silently failing
2438 * & the best protection against that is the functions this class affords
2440 * @param array $params
2442 * @return int $result['id'] payment processor id
2444 public function paymentProcessorCreate($params = []) {
2445 $params = array_merge([
2447 'domain_id' => CRM_Core_Config
::domainID(),
2448 'payment_processor_type_id' => 'PayPal',
2452 'user_name' => 'sunil._1183377782_biz_api1.webaccess.co.in',
2453 'password' => '1183377788',
2454 'signature' => 'APixCoQ-Zsaj-u3IH7mD5Do-7HUqA9loGnLSzsZga9Zr-aNmaJa3WGPH',
2455 'url_site' => 'https://www.sandbox.paypal.com/',
2456 'url_api' => 'https://api-3t.sandbox.paypal.com/',
2457 'url_button' => 'https://www.paypal.com/en_US/i/btn/btn_xpressCheckout.gif',
2458 'class_name' => 'Payment_PayPalImpl',
2459 'billing_mode' => 3,
2460 'financial_type_id' => 1,
2461 'financial_account_id' => 12,
2462 // Credit card = 1 so can pass 'by accident'.
2463 'payment_instrument_id' => 'Debit Card',
2465 if (!is_numeric($params['payment_processor_type_id'])) {
2466 // really the api should handle this through getoptions but it's not exactly api call so lets just sort it
2468 $params['payment_processor_type_id'] = $this->callAPISuccess('payment_processor_type', 'getvalue', [
2469 'name' => $params['payment_processor_type_id'],
2473 $result = $this->callAPISuccess('payment_processor', 'create', $params);
2474 return $result['id'];
2478 * Set up initial recurring payment allowing subsequent IPN payments.
2480 * @param array $recurParams (Optional)
2481 * @param array $contributionParams (Optional)
2483 * @throws \CRM_Core_Exception
2485 public function setupRecurringPaymentProcessorTransaction($recurParams = [], $contributionParams = []) {
2486 $contributionParams = array_merge([
2487 'total_amount' => '200',
2488 'invoice_id' => $this->_invoiceID
,
2489 'financial_type_id' => 'Donation',
2490 'contribution_status_id' => 'Pending',
2491 'contact_id' => $this->_contactID
,
2492 'contribution_page_id' => $this->_contributionPageID
,
2493 'payment_processor_id' => $this->_paymentProcessorID
,
2495 'receive_date' => '2019-07-25 07:34:23',
2496 'skipCleanMoney' => TRUE,
2497 ], $contributionParams);
2498 $contributionRecur = $this->callAPISuccess('contribution_recur', 'create', array_merge([
2499 'contact_id' => $this->_contactID
,
2502 'installments' => 5,
2503 'frequency_unit' => 'Month',
2504 'frequency_interval' => 1,
2505 'invoice_id' => $this->_invoiceID
,
2506 'contribution_status_id' => 2,
2507 'payment_processor_id' => $this->_paymentProcessorID
,
2508 // processor provided ID - use contact ID as proxy.
2509 'processor_id' => $this->_contactID
,
2510 'api.Order.create' => $contributionParams,
2511 ], $recurParams))['values'][0];
2512 $this->_contributionRecurID
= $contributionRecur['id'];
2513 $this->_contributionID
= $contributionRecur['api.Order.create']['id'];
2514 $this->ids
['Contribution'][0] = $this->_contributionID
;
2518 * 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
2520 * @param array $params Optionally modify params for membership/recur (duration_unit/frequency_unit)
2522 * @throws \CRM_Core_Exception
2524 public function setupMembershipRecurringPaymentProcessorTransaction($params = []) {
2525 $membershipParams = $recurParams = [];
2526 if (!empty($params['duration_unit'])) {
2527 $membershipParams['duration_unit'] = $params['duration_unit'];
2529 if (!empty($params['frequency_unit'])) {
2530 $recurParams['frequency_unit'] = $params['frequency_unit'];
2533 $this->ids
['membership_type'] = $this->membershipTypeCreate($membershipParams);
2534 //create a contribution so our membership & contribution don't both have id = 1
2535 if ($this->callAPISuccess('Contribution', 'getcount', []) === 0) {
2536 $this->contributionCreate([
2537 'contact_id' => $this->_contactID
,
2539 'financial_type_id' => 1,
2540 'invoice_id' => 'abcd',
2542 'receive_date' => '2019-07-25 07:34:23',
2546 $this->ids
['membership'] = $this->callAPISuccess('Membership', 'create', [
2547 'contact_id' => $this->_contactID
,
2548 'membership_type_id' => $this->ids
['membership_type'],
2549 'format.only_id' => TRUE,
2550 'source' => 'Payment',
2551 'skipLineItem' => TRUE,
2553 $this->setupRecurringPaymentProcessorTransaction($recurParams, [
2558 'entity_table' => 'civicrm_membership',
2559 'entity_id' => $this->ids
['membership'],
2560 'label' => 'General',
2562 'unit_price' => 200,
2563 'line_total' => 200,
2564 'financial_type_id' => 1,
2565 'price_field_id' => $this->callAPISuccess('price_field', 'getvalue', [
2567 'label' => 'Membership Amount',
2568 'options' => ['limit' => 1, 'sort' => 'id DESC'],
2570 'price_field_value_id' => $this->callAPISuccess('price_field_value', 'getvalue', [
2572 'label' => 'General',
2573 'options' => ['limit' => 1, 'sort' => 'id DESC'],
2580 $this->callAPISuccess('Membership', 'create', ['id' => $this->ids
['membership'], 'contribution_recur_id' => $this->_contributionRecurID
]);
2588 public function CiviUnitTestCase_fatalErrorHandler($message) {
2589 throw new Exception("{$message['message']}: {$message['code']}");
2593 * Wrap the entire test case in a transaction.
2595 * Only subsequent DB statements will be wrapped in TX -- this cannot
2596 * retroactively wrap old DB statements. Therefore, it makes sense to
2597 * call this at the beginning of setUp().
2599 * Note: Recall that TRUNCATE and ALTER will force-commit transactions, so
2600 * this option does not work with, e.g., custom-data.
2602 * WISHLIST: Monitor SQL queries in unit-tests and generate an exception
2603 * if TRUNCATE or ALTER is called while using a transaction.
2606 * Whether to use nesting or reference-counting.
2608 public function useTransaction($nest = TRUE) {
2610 $this->tx
= new CRM_Core_Transaction($nest);
2611 $this->tx
->rollback();
2616 * Assert the attachment exists.
2618 * @param bool $exists
2619 * @param array $apiResult
2621 protected function assertAttachmentExistence($exists, $apiResult) {
2622 $fileId = $apiResult['id'];
2623 $this->assertTrue(is_numeric($fileId));
2624 $this->assertEquals($exists, file_exists($apiResult['values'][$fileId]['path']));
2625 $this->assertDBQuery($exists ?
1 : 0, 'SELECT count(*) FROM civicrm_file WHERE id = %1', [
2626 1 => [$fileId, 'Int'],
2628 $this->assertDBQuery($exists ?
1 : 0, 'SELECT count(*) FROM civicrm_entity_file WHERE id = %1', [
2629 1 => [$fileId, 'Int'],
2634 * Assert 2 sql strings are the same, ignoring double spaces.
2636 * @param string $expectedSQL
2637 * @param string $actualSQL
2638 * @param string $message
2640 protected function assertLike($expectedSQL, $actualSQL, $message = 'different sql') {
2641 $expected = trim((preg_replace('/[ \r\n\t]+/', ' ', $expectedSQL)));
2642 $actual = trim((preg_replace('/[ \r\n\t]+/', ' ', $actualSQL)));
2643 $this->assertEquals($expected, $actual, $message);
2647 * Create a price set for an event.
2649 * @param int $feeTotal
2650 * @param int $minAmt
2651 * @param string $type
2653 * @param array $options
2657 * @throws \CRM_Core_Exception
2659 protected function eventPriceSetCreate($feeTotal, $minAmt = 0, $type = 'Text', $options = [['name' => 'hundy', 'amount' => 100]]) {
2660 // creating price set, price field
2661 $paramsSet['title'] = 'Price Set';
2662 $paramsSet['name'] = CRM_Utils_String
::titleToVar('Price Set');
2663 $paramsSet['is_active'] = FALSE;
2664 $paramsSet['extends'] = 1;
2665 $paramsSet['min_amount'] = $minAmt;
2667 $priceSet = CRM_Price_BAO_PriceSet
::create($paramsSet);
2668 $this->_ids
['price_set'] = $priceSet->id
;
2671 'label' => 'Price Field',
2672 'name' => CRM_Utils_String
::titleToVar('Price Field'),
2673 'html_type' => $type,
2674 'price' => $feeTotal,
2675 'option_label' => ['1' => 'Price Field'],
2676 'option_value' => ['1' => $feeTotal],
2677 'option_name' => ['1' => $feeTotal],
2678 'option_weight' => ['1' => 1],
2679 'option_amount' => ['1' => 1],
2680 'is_display_amounts' => 1,
2682 'options_per_line' => 1,
2683 'is_active' => ['1' => 1],
2684 'price_set_id' => $this->_ids
['price_set'],
2685 'is_enter_qty' => 1,
2686 'financial_type_id' => $this->getFinancialTypeId('Event Fee'),
2688 if ($type === 'Radio') {
2689 foreach ($options as $index => $option) {
2690 $paramsField['is_enter_qty'] = 0;
2691 $optionID = $index +
2;
2692 $paramsField['option_value'][$optionID] = $paramsField['option_weight'][$optionID] = $paramsField['option_amount'][$optionID] = $option['amount'];
2693 $paramsField['option_label'][$optionID] = $paramsField['option_name'][$optionID] = $option['name'];
2697 $this->callAPISuccess('PriceField', 'create', $paramsField);
2698 $fields = $this->callAPISuccess('PriceField', 'get', ['price_set_id' => $this->_ids
['price_set']]);
2699 $this->_ids
['price_field'] = array_keys($fields['values']);
2700 $fieldValues = $this->callAPISuccess('PriceFieldValue', 'get', ['price_field_id' => $this->_ids
['price_field'][0]]);
2701 $this->_ids
['price_field_value'] = array_keys($fieldValues['values']);
2703 return $this->_ids
['price_set'];
2707 * Add a profile to a contribution page.
2709 * @param string $name
2710 * @param int $contributionPageID
2711 * @param string $module
2713 protected function addProfile($name, $contributionPageID, $module = 'CiviContribute') {
2715 'uf_group_id' => $name,
2716 'module' => $module,
2717 'entity_table' => 'civicrm_contribution_page',
2718 'entity_id' => $contributionPageID,
2721 if ($module !== 'CiviContribute') {
2722 $params['module_data'] = [$module => []];
2724 $this->callAPISuccess('UFJoin', 'create', $params);
2728 * Add participant with contribution
2732 * @throws \CRM_Core_Exception
2734 protected function createPartiallyPaidParticipantOrder() {
2735 $orderParams = $this->getParticipantOrderParams();
2736 $orderParams['api.Payment.create'] = ['total_amount' => 150];
2737 return $this->callAPISuccess('Order', 'create', $orderParams);
2743 * @param string $component
2744 * @param int $componentId
2745 * @param array $priceFieldOptions
2749 protected function createPriceSet($component = 'contribution_page', $componentId = NULL, $priceFieldOptions = []) {
2750 $paramsSet['title'] = 'Price Set' . substr(sha1(rand()), 0, 7);
2751 $paramsSet['name'] = CRM_Utils_String
::titleToVar($paramsSet['title']);
2752 $paramsSet['is_active'] = TRUE;
2753 $paramsSet['financial_type_id'] = 'Event Fee';
2754 $paramsSet['extends'] = 1;
2755 $priceSet = $this->callAPISuccess('price_set', 'create', $paramsSet);
2756 $priceSetId = $priceSet['id'];
2757 //Checking for priceset added in the table.
2758 $this->assertDBCompareValue('CRM_Price_BAO_PriceSet', $priceSetId, 'title',
2759 'id', $paramsSet['title'], 'Check DB for created priceset'
2761 $paramsField = array_merge([
2762 'label' => 'Price Field',
2763 'name' => CRM_Utils_String
::titleToVar('Price Field'),
2764 'html_type' => 'CheckBox',
2765 'option_label' => ['1' => 'Price Field 1', '2' => 'Price Field 2'],
2766 'option_value' => ['1' => 100, '2' => 200],
2767 'option_name' => ['1' => 'Price Field 1', '2' => 'Price Field 2'],
2768 'option_weight' => ['1' => 1, '2' => 2],
2769 'option_amount' => ['1' => 100, '2' => 200],
2770 'is_display_amounts' => 1,
2772 'options_per_line' => 1,
2773 'is_active' => ['1' => 1, '2' => 1],
2774 'price_set_id' => $priceSet['id'],
2775 'is_enter_qty' => 1,
2776 'financial_type_id' => $this->getFinancialTypeId('Event Fee'),
2777 ], $priceFieldOptions);
2779 $priceField = CRM_Price_BAO_PriceField
::create($paramsField);
2781 CRM_Price_BAO_PriceSet
::addTo('civicrm_' . $component, $componentId, $priceSetId);
2783 return $this->callAPISuccess('PriceFieldValue', 'get', ['price_field_id' => $priceField->id
]);
2787 * Replace the template with a test-oriented template designed to show all the variables.
2789 * @param string $templateName
2790 * @param string $type
2792 protected function swapMessageTemplateForTestTemplate($templateName = 'contribution_online_receipt', $type = 'html') {
2793 $testTemplate = file_get_contents(__DIR__
. '/../../templates/message_templates/' . $templateName . '_' . $type . '.tpl');
2794 CRM_Core_DAO
::executeQuery(
2795 "UPDATE civicrm_option_group og
2796 LEFT JOIN civicrm_option_value ov ON ov.option_group_id = og.id
2797 LEFT JOIN civicrm_msg_template m ON m.workflow_id = ov.id
2798 SET m.msg_{$type} = %1
2799 WHERE og.name LIKE 'msg_tpl_workflow_%'
2800 AND ov.name = '{$templateName}'
2801 AND m.is_default = 1", [1 => [$testTemplate, 'String']]
2806 * Reinstate the default template.
2808 * @param string $templateName
2809 * @param string $type
2811 protected function revertTemplateToReservedTemplate($templateName = 'contribution_online_receipt', $type = 'html') {
2812 CRM_Core_DAO
::executeQuery(
2813 "UPDATE civicrm_option_group og
2814 LEFT JOIN civicrm_option_value ov ON ov.option_group_id = og.id
2815 LEFT JOIN civicrm_msg_template m ON m.workflow_id = ov.id
2816 LEFT JOIN civicrm_msg_template m2 ON m2.workflow_id = ov.id AND m2.is_reserved = 1
2817 SET m.msg_{$type} = m2.msg_{$type}
2818 WHERE og.name = 'msg_tpl_workflow_contribution'
2819 AND ov.name = '{$templateName}'
2820 AND m.is_default = 1"
2825 * Flush statics relating to financial type.
2827 protected function flushFinancialTypeStatics() {
2828 if (isset(\Civi
::$statics['CRM_Financial_BAO_FinancialType'])) {
2829 unset(\Civi
::$statics['CRM_Financial_BAO_FinancialType']);
2831 if (isset(\Civi
::$statics['CRM_Contribute_PseudoConstant'])) {
2832 unset(\Civi
::$statics['CRM_Contribute_PseudoConstant']);
2834 CRM_Contribute_PseudoConstant
::flush('financialType');
2835 CRM_Contribute_PseudoConstant
::flush('membershipType');
2836 // Pseudoconstants may be saved to the cache table.
2837 CRM_Core_DAO
::executeQuery("TRUNCATE civicrm_cache");
2838 CRM_Financial_BAO_FinancialType
::$_statusACLFt = [];
2839 CRM_Financial_BAO_FinancialType
::$_availableFinancialTypes = NULL;
2843 * Set the permissions to the supplied array.
2845 * @param array $permissions
2847 protected function setPermissions($permissions) {
2848 CRM_Core_Config
::singleton()->userPermissionClass
->permissions
= $permissions;
2849 $this->flushFinancialTypeStatics();
2853 * @param array $params
2856 public function _checkFinancialRecords($params, $context) {
2858 'entity_id' => $params['id'],
2859 'entity_table' => 'civicrm_contribution',
2861 $contribution = $this->callAPISuccess('contribution', 'getsingle', ['id' => $params['id']]);
2862 $this->assertEquals($contribution['total_amount'] - $contribution['fee_amount'], $contribution['net_amount']);
2863 if ($context == 'pending') {
2864 $trxn = CRM_Financial_BAO_FinancialItem
::retrieveEntityFinancialTrxn($entityParams);
2865 $this->assertNull($trxn, 'No Trxn to be created until IPN callback');
2868 $trxn = current(CRM_Financial_BAO_FinancialItem
::retrieveEntityFinancialTrxn($entityParams));
2870 'id' => $trxn['financial_trxn_id'],
2872 if ($context != 'online' && $context != 'payLater') {
2874 'to_financial_account_id' => 6,
2875 'total_amount' => CRM_Utils_Array
::value('total_amount', $params, 100),
2879 if ($context == 'feeAmount') {
2880 $compareParams['fee_amount'] = 50;
2882 elseif ($context == 'online') {
2884 'to_financial_account_id' => 12,
2885 'total_amount' => CRM_Utils_Array
::value('total_amount', $params, 100),
2887 'payment_instrument_id' => CRM_Utils_Array
::value('payment_instrument_id', $params, 1),
2890 elseif ($context == 'payLater') {
2892 'to_financial_account_id' => 7,
2893 'total_amount' => CRM_Utils_Array
::value('total_amount', $params, 100),
2897 $this->assertDBCompareValues('CRM_Financial_DAO_FinancialTrxn', $trxnParams, $compareParams);
2899 'financial_trxn_id' => $trxn['financial_trxn_id'],
2900 'entity_table' => 'civicrm_financial_item',
2902 $entityTrxn = current(CRM_Financial_BAO_FinancialItem
::retrieveEntityFinancialTrxn($entityParams));
2904 'id' => $entityTrxn['entity_id'],
2907 'amount' => CRM_Utils_Array
::value('total_amount', $params, 100),
2909 'financial_account_id' => CRM_Utils_Array
::value('financial_account_id', $params, 1),
2911 if ($context == 'payLater') {
2913 'amount' => CRM_Utils_Array
::value('total_amount', $params, 100),
2915 'financial_account_id' => CRM_Utils_Array
::value('financial_account_id', $params, 1),
2918 $this->assertDBCompareValues('CRM_Financial_DAO_FinancialItem', $fitemParams, $compareParams);
2919 if ($context == 'feeAmount') {
2921 'entity_id' => $params['id'],
2922 'entity_table' => 'civicrm_contribution',
2924 $maxTrxn = current(CRM_Financial_BAO_FinancialItem
::retrieveEntityFinancialTrxn($maxParams, TRUE));
2926 'id' => $maxTrxn['financial_trxn_id'],
2929 'to_financial_account_id' => 5,
2930 'from_financial_account_id' => 6,
2931 'total_amount' => 50,
2934 $trxnId = CRM_Core_BAO_FinancialTrxn
::getFinancialTrxnId($params['id'], 'DESC');
2935 $this->assertDBCompareValues('CRM_Financial_DAO_FinancialTrxn', $trxnParams, $compareParams);
2937 'entity_id' => $trxnId['financialTrxnId'],
2938 'entity_table' => 'civicrm_financial_trxn',
2943 'financial_account_id' => 5,
2945 $this->assertDBCompareValues('CRM_Financial_DAO_FinancialItem', $fitemParams, $compareParams);
2947 // This checks that empty Sales tax rows are not being created. If for any reason it needs to be removed the
2948 // line should be copied into all the functions that call this function & evaluated there
2949 // Be really careful not to remove or bypass this without ensuring stray rows do not re-appear
2950 // when calling completeTransaction or repeatTransaction.
2951 $this->callAPISuccessGetCount('FinancialItem', ['description' => 'Sales Tax', 'amount' => 0], 0);
2955 * Return financial type id on basis of name
2957 * @param string $name Financial type m/c name
2961 public function getFinancialTypeId($name) {
2962 return CRM_Core_DAO
::getFieldValue('CRM_Financial_DAO_FinancialType', $name, 'id', 'name');
2966 * Cleanup function for contents of $this->ids.
2968 * This is a best effort cleanup to use in tear downs etc.
2970 * It will not fail if the data has already been removed (some tests may do
2971 * their own cleanup).
2973 protected function cleanUpSetUpIDs() {
2974 foreach ($this->setupIDs
as $entity => $id) {
2976 civicrm_api3($entity, 'delete', ['id' => $id, 'skip_undelete' => 1]);
2978 catch (CiviCRM_API3_Exception
$e) {
2979 // This is a best-effort cleanup function, ignore.
2985 * Create Financial Type.
2987 * @param array $params
2991 protected function createFinancialType($params = []) {
2992 $params = array_merge($params,
2994 'name' => 'Financial-Type -' . substr(sha1(rand()), 0, 7),
2998 return $this->callAPISuccess('FinancialType', 'create', $params);
3002 * Create Payment Instrument.
3004 * @param array $params
3005 * @param string $financialAccountName
3009 protected function createPaymentInstrument($params = [], $financialAccountName = 'Donation') {
3010 $params = array_merge([
3011 'label' => 'Payment Instrument -' . substr(sha1(rand()), 0, 7),
3012 'option_group_id' => 'payment_instrument',
3015 $newPaymentInstrument = $this->callAPISuccess('OptionValue', 'create', $params)['id'];
3017 $relationTypeID = key(CRM_Core_PseudoConstant
::accountOptionValues('account_relationship', NULL, " AND v.name LIKE 'Asset Account is' "));
3019 $financialAccountParams = [
3020 'entity_table' => 'civicrm_option_value',
3021 'entity_id' => $newPaymentInstrument,
3022 'account_relationship' => $relationTypeID,
3023 'financial_account_id' => $this->callAPISuccess('FinancialAccount', 'getValue', ['name' => $financialAccountName, 'return' => 'id']),
3025 CRM_Financial_BAO_FinancialTypeAccount
::add($financialAccountParams);
3027 return CRM_Core_PseudoConstant
::getKey('CRM_Contribute_BAO_Contribution', 'payment_instrument_id', $params['label']);
3031 * Enable Tax and Invoicing
3033 * @param array $params
3035 * @return \Civi\Core\SettingsBag
3037 protected function enableTaxAndInvoicing($params = []) {
3038 // Enable component contribute setting
3039 $contributeSetting = array_merge($params,
3042 'invoice_prefix' => 'INV_',
3044 'due_date_period' => 'days',
3046 'is_email_pdf' => 1,
3047 'tax_term' => 'Sales Tax',
3048 'tax_display_settings' => 'Inclusive',
3051 return Civi
::settings()->set('contribution_invoice_settings', $contributeSetting);
3055 * Enable Tax and Invoicing
3057 * @throws \CRM_Core_Exception
3059 protected function disableTaxAndInvoicing() {
3060 $accounts = $this->callAPISuccess('EntityFinancialAccount', 'get', ['account_relationship' => 'Sales Tax Account is'])['values'];
3061 foreach ($accounts as $account) {
3062 $this->callAPISuccess('EntityFinancialAccount', 'delete', ['id' => $account['id']]);
3063 $this->callAPISuccess('FinancialAccount', 'delete', ['id' => $account['financial_account_id']]);
3066 if (!empty(\Civi
::$statics['CRM_Core_PseudoConstant']) && isset(\Civi
::$statics['CRM_Core_PseudoConstant']['taxRates'])) {
3067 unset(\Civi
::$statics['CRM_Core_PseudoConstant']['taxRates']);
3069 return Civi
::settings()->set('invoicing', FALSE);
3073 * Add Sales Tax relation for financial type with financial account.
3075 * @param int $financialTypeId
3079 protected function relationForFinancialTypeWithFinancialAccount($financialTypeId) {
3081 'name' => 'Sales tax account ' . substr(sha1(rand()), 0, 4),
3082 'financial_account_type_id' => key(CRM_Core_PseudoConstant
::accountOptionValues('financial_account_type', NULL, " AND v.name LIKE 'Liability' ")),
3083 'is_deductible' => 1,
3088 $account = CRM_Financial_BAO_FinancialAccount
::add($params);
3090 'entity_table' => 'civicrm_financial_type',
3091 'entity_id' => $financialTypeId,
3092 'account_relationship' => key(CRM_Core_PseudoConstant
::accountOptionValues('account_relationship', NULL, " AND v.name LIKE 'Sales Tax Account is' ")),
3095 // set tax rate (as 10) for provided financial type ID to static variable, later used to fetch tax rates of all financial types
3096 \Civi
::$statics['CRM_Core_PseudoConstant']['taxRates'][$financialTypeId] = 10;
3098 //CRM-20313: As per unique index added in civicrm_entity_financial_account table,
3099 // first check if there's any record on basis of unique key (entity_table, account_relationship, entity_id)
3100 $dao = new CRM_Financial_DAO_EntityFinancialAccount();
3101 $dao->copyValues($entityParams);
3103 if ($dao->fetch()) {
3104 $entityParams['id'] = $dao->id
;
3106 $entityParams['financial_account_id'] = $account->id
;
3108 return CRM_Financial_BAO_FinancialTypeAccount
::add($entityParams);
3112 * Create price set with contribution test for test setup.
3114 * This could be merged with 4.5 function setup in api_v3_ContributionPageTest::setUpContributionPage
3115 * on parent class at some point (fn is not in 4.4).
3118 * @param array $params
3120 public function createPriceSetWithPage($entity = NULL, $params = []) {
3121 $membershipTypeID = $this->membershipTypeCreate(['name' => 'Special']);
3122 $contributionPageResult = $this->callAPISuccess('contribution_page', 'create', [
3123 'title' => "Test Contribution Page",
3124 'financial_type_id' => 1,
3125 'currency' => 'NZD',
3126 'goal_amount' => 50,
3127 'is_pay_later' => 1,
3128 'is_monetary' => TRUE,
3129 'is_email_receipt' => FALSE,
3131 $priceSet = $this->callAPISuccess('price_set', 'create', [
3132 'is_quick_config' => 0,
3133 'extends' => 'CiviMember',
3134 'financial_type_id' => 1,
3135 'title' => 'my Page',
3137 $priceSetID = $priceSet['id'];
3139 CRM_Price_BAO_PriceSet
::addTo('civicrm_contribution_page', $contributionPageResult['id'], $priceSetID);
3140 $priceField = $this->callAPISuccess('price_field', 'create', [
3141 'price_set_id' => $priceSetID,
3142 'label' => 'Goat Breed',
3143 'html_type' => 'Radio',
3145 $priceFieldValue = $this->callAPISuccess('price_field_value', 'create', [
3146 'price_set_id' => $priceSetID,
3147 'price_field_id' => $priceField['id'],
3148 'label' => 'Long Haired Goat',
3150 'financial_type_id' => 'Donation',
3151 'membership_type_id' => $membershipTypeID,
3152 'membership_num_terms' => 1,
3154 $this->_ids
['price_field_value'] = [$priceFieldValue['id']];
3155 $priceFieldValue = $this->callAPISuccess('price_field_value', 'create', [
3156 'price_set_id' => $priceSetID,
3157 'price_field_id' => $priceField['id'],
3158 'label' => 'Shoe-eating Goat',
3160 'financial_type_id' => 'Donation',
3161 'membership_type_id' => $membershipTypeID,
3162 'membership_num_terms' => 2,
3164 $this->_ids
['price_field_value'][] = $priceFieldValue['id'];
3166 $priceFieldValue = $this->callAPISuccess('price_field_value', 'create', [
3167 'price_set_id' => $priceSetID,
3168 'price_field_id' => $priceField['id'],
3169 'label' => 'Shoe-eating Goat',
3171 'financial_type_id' => 'Donation',
3173 $this->_ids
['price_field_value']['cont'] = $priceFieldValue['id'];
3175 $this->_ids
['price_set'] = $priceSetID;
3176 $this->_ids
['contribution_page'] = $contributionPageResult['id'];
3177 $this->_ids
['price_field'] = [$priceField['id']];
3179 $this->_ids
['membership_type'] = $membershipTypeID;
3183 * Only specified contact returned.
3185 * @implements CRM_Utils_Hook::aclWhereClause
3189 * @param $whereTables
3193 public function aclWhereMultipleContacts($type, &$tables, &$whereTables, &$contactID, &$where) {
3194 $where = " contact_a.id IN (" . implode(', ', $this->allowedContacts
) . ")";
3198 * @implements CRM_Utils_Hook::selectWhereClause
3200 * @param string $entity
3201 * @param array $clauses
3203 public function selectWhereClauseHook($entity, &$clauses) {
3204 if ($entity == 'Event') {
3205 $clauses['event_type_id'][] = "IN (2, 3, 4)";
3210 * An implementation of hook_civicrm_post used with all our test cases.
3213 * @param string $objectName
3214 * @param int $objectId
3217 public function onPost($op, $objectName, $objectId, &$objectRef) {
3218 if ($op == 'create' && $objectName == 'Individual') {
3219 CRM_Core_DAO
::executeQuery(
3220 "UPDATE civicrm_contact SET nick_name = 'munged' WHERE id = %1",
3222 1 => [$objectId, 'Integer'],
3227 if ($op == 'edit' && $objectName == 'Participant') {
3229 1 => [$objectId, 'Integer'],
3231 $query = "UPDATE civicrm_participant SET source = 'Post Hook Update' WHERE id = %1";
3232 CRM_Core_DAO
::executeQuery($query, $params);
3237 * Instantiate form object.
3239 * We need to instantiate the form to run preprocess, which means we have to trick it about the request method.
3241 * @param string $class
3242 * Name of form class.
3244 * @param array $formValues
3246 * @param string $pageName
3248 * @return \CRM_Core_Form
3249 * @throws \CRM_Core_Exception
3251 public function getFormObject($class, $formValues = [], $pageName = '') {
3252 $form = new $class();
3253 $_SERVER['REQUEST_METHOD'] = 'GET';
3254 $form->controller
= new CRM_Core_Controller();
3255 $form->controller
->setStateMachine(new CRM_Core_StateMachine($form->controller
));
3256 $_SESSION['_' . $form->controller
->_name
. '_container']['values'][$pageName] = $formValues;
3261 * Get possible thousand separators.
3265 public function getThousandSeparators() {
3266 return [['.'], [',']];
3270 * Get the boolean options as a provider.
3274 public function getBooleanDataProvider() {
3275 return [[TRUE], [FALSE]];
3279 * Set the separators for thousands and decimal points.
3281 * Note that this only covers some common scenarios.
3283 * It does not cater for a situation where the thousand separator is a [space]
3284 * Latter is the Norwegian localization. At least some tests need to
3285 * use setMonetaryDecimalPoint and setMonetaryThousandSeparator directly
3286 * to provide broader coverage.
3288 * @param string $thousandSeparator
3290 protected function setCurrencySeparators($thousandSeparator) {
3291 Civi
::settings()->set('monetaryThousandSeparator', $thousandSeparator);
3292 Civi
::settings()->set('monetaryDecimalPoint', ($thousandSeparator === ',' ?
'.' : ','));
3296 * Sets the thousand separator.
3298 * If you use this function also set the decimal separator: setMonetaryDecimalSeparator
3300 * @param $thousandSeparator
3302 protected function setMonetaryThousandSeparator($thousandSeparator) {
3303 Civi
::settings()->set('monetaryThousandSeparator', $thousandSeparator);
3307 * Sets the decimal separator.
3309 * If you use this function also set the thousand separator setMonetaryDecimalPoint
3311 * @param $decimalPoint
3313 protected function setMonetaryDecimalPoint($decimalPoint) {
3314 Civi
::settings()->set('monetaryDecimalPoint', $decimalPoint);
3318 * Sets the default currency.
3322 protected function setDefaultCurrency($currency) {
3323 Civi
::settings()->set('defaultCurrency', $currency);
3327 * Format money as it would be input.
3329 * @param string $amount
3333 protected function formatMoneyInput($amount) {
3334 return CRM_Utils_Money
::format($amount, NULL, '%a');
3338 * Get the contribution object.
3340 * @param int $contributionID
3342 * @return \CRM_Contribute_BAO_Contribution
3344 protected function getContributionObject($contributionID) {
3345 $contributionObj = new CRM_Contribute_BAO_Contribution();
3346 $contributionObj->id
= $contributionID;
3347 $contributionObj->find(TRUE);
3348 return $contributionObj;
3352 * Enable multilingual.
3354 public function enableMultilingual() {
3355 $this->callAPISuccess('Setting', 'create', [
3356 'lcMessages' => 'en_US',
3357 'languageLimit' => [
3362 CRM_Core_I18n_Schema
::makeMultilingual('en_US');
3365 $dbLocale = '_en_US';
3369 * Setup or clean up SMS tests
3371 * @param bool $teardown
3373 * @throws \CiviCRM_API3_Exception
3375 public function setupForSmsTests($teardown = FALSE) {
3376 require_once 'CiviTest/CiviTestSMSProvider.php';
3378 // Option value params for CiviTestSMSProvider
3379 $groupID = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_OptionGroup', 'sms_provider_name', 'id', 'name');
3381 'option_group_id' => $groupID,
3382 'label' => 'unittestSMS',
3383 'value' => 'unit.test.sms',
3384 'name' => 'CiviTestSMSProvider',
3391 // Test completed, delete provider
3392 $providerOptionValueResult = civicrm_api3('option_value', 'get', $params);
3393 civicrm_api3('option_value', 'delete', ['id' => $providerOptionValueResult['id']]);
3397 // Create an SMS provider "CiviTestSMSProvider". Civi handles "CiviTestSMSProvider" as a special case and allows it to be instantiated
3398 // in CRM/Sms/Provider.php even though it is not an extension.
3399 return civicrm_api3('option_value', 'create', $params);
3403 * Start capturing browser output.
3405 * The starts the process of browser output being captured, setting any variables needed for e-notice prevention.
3407 protected function startCapturingOutput() {
3409 $_SERVER['HTTP_USER_AGENT'] = 'unittest';
3413 * Stop capturing browser output and return as a csv.
3415 * @param bool $isFirstRowHeaders
3417 * @return \League\Csv\Reader
3419 * @throws \League\Csv\Exception
3421 protected function captureOutputToCSV($isFirstRowHeaders = TRUE) {
3422 $output = ob_get_flush();
3423 $stream = fopen('php://memory', 'r+');
3424 fwrite($stream, $output);
3426 $this->assertEquals("\xEF\xBB\xBF", substr($output, 0, 3));
3427 $csv = Reader
::createFromString($output);
3428 if ($isFirstRowHeaders) {
3429 $csv->setHeaderOffset(0);
3436 * Rename various labels to not match the names.
3438 * Doing these mimics the fact the name != the label in international installs & triggers failures in
3439 * code that expects it to.
3441 protected function renameLabels() {
3442 $replacements = ['Pending', 'Refunded'];
3443 foreach ($replacements as $name) {
3444 CRM_Core_DAO
::executeQuery("UPDATE civicrm_option_value SET label = '{$name} Label**' where label = '{$name}' AND name = '{$name}'");
3449 * Undo any label renaming.
3451 protected function resetLabels() {
3452 CRM_Core_DAO
::executeQuery("UPDATE civicrm_option_value SET label = REPLACE(name, ' Label**', '') WHERE label LIKE '% Label**'");
3456 * Get parameters to set up a multi-line participant order.
3459 * @throws \CRM_Core_Exception
3461 protected function getParticipantOrderParams(): array {
3462 $this->_contactId
= $this->individualCreate();
3463 $event = $this->eventCreate();
3464 $this->_eventId
= $event['id'];
3466 'id' => $this->_eventId
,
3467 'financial_type_id' => 4,
3470 $this->callAPISuccess('event', 'create', $eventParams);
3471 $priceFields = $this->createPriceSet('event', $this->_eventId
);
3472 $participantParams = [
3473 'financial_type_id' => 4,
3474 'event_id' => $this->_eventId
,
3477 'fee_currency' => 'USD',
3478 'contact_id' => $this->_contactId
,
3480 $participant = $this->callAPISuccess('Participant', 'create', $participantParams);
3482 'total_amount' => 300,
3483 'currency' => 'USD',
3484 'contact_id' => $this->_contactId
,
3485 'financial_type_id' => 4,
3486 'contribution_status_id' => 'Pending',
3487 'contribution_mode' => 'participant',
3488 'participant_id' => $participant['id'],
3490 foreach ($priceFields['values'] as $key => $priceField) {
3491 $orderParams['line_items'][] = [
3494 'price_field_id' => $priceField['price_field_id'],
3495 'price_field_value_id' => $priceField['id'],
3496 'label' => $priceField['label'],
3497 'field_title' => $priceField['label'],
3499 'unit_price' => $priceField['amount'],
3500 'line_total' => $priceField['amount'],
3501 'financial_type_id' => $priceField['financial_type_id'],
3502 'entity_table' => 'civicrm_participant',
3505 'params' => $participant,
3508 return $orderParams;
3514 * @throws \CRM_Core_Exception
3516 protected function validatePayments($payments) {
3517 foreach ($payments as $payment) {
3518 $balance = CRM_Contribute_BAO_Contribution
::getContributionBalance($payment['contribution_id']);
3519 if ($balance < 0 && $balance +
$payment['total_amount'] === 0.0) {
3520 // This is an overpayment situation. there are no financial items to allocate the overpayment.
3521 // This is a pretty rough way at guessing which payment is the overpayment - but
3522 // for the test suite it should be enough.
3525 $items = $this->callAPISuccess('EntityFinancialTrxn', 'get', [
3526 'financial_trxn_id' => $payment['id'],
3527 'entity_table' => 'civicrm_financial_item',
3528 'return' => ['amount'],
3531 foreach ($items as $item) {
3532 $itemTotal +
= $item['amount'];
3534 $this->assertEquals($payment['total_amount'], $itemTotal);
3539 * Validate all created payments.
3541 * @throws \CRM_Core_Exception
3543 protected function validateAllPayments() {
3544 $payments = $this->callAPISuccess('Payment', 'get', ['options' => ['limit' => 0]])['values'];
3545 $this->validatePayments($payments);
3549 * Validate all created contributions.
3551 * @throws \CRM_Core_Exception
3553 protected function validateAllContributions() {
3554 $contributions = $this->callAPISuccess('Contribution', 'get', [])['values'];
3555 foreach ($contributions as $contribution) {
3556 $lineItems = $this->callAPISuccess('LineItem', 'get', ['contribution_id' => $contribution['id']])['values'];
3558 foreach ($lineItems as $lineItem) {
3559 $total +
= $lineItem['line_total'];
3561 $this->assertEquals($total, $contribution['total_amount']);