3 +--------------------------------------------------------------------+
4 | Copyright CiviCRM LLC. All rights reserved. |
6 | This work is published under the GNU AGPLv3 license with some |
7 | permitted exceptions and without any warranty. For full license |
8 | and copyright information, see https://civicrm.org/licensing |
9 +--------------------------------------------------------------------+
13 * Test APIv3 civicrm_report_instance_* functions
15 * @package CiviCRM_APIv3
16 * @subpackage API_Report
19 class api_v3_ReportTemplateTest
extends CiviUnitTestCase
{
21 use CRMTraits_ACL_PermissionTrait
;
22 use CRMTraits_PCP_PCPTestTrait
;
23 use CRMTraits_Custom_CustomDataTrait
;
25 protected $contactIDs = [];
28 * Our group reports use an alter so transaction cleanup won't work.
32 public function tearDown() {
33 $this->quickCleanUpFinancialEntities();
34 $this->quickCleanup(['civicrm_group', 'civicrm_saved_search', 'civicrm_group_contact', 'civicrm_group_contact_cache', 'civicrm_group'], TRUE);
38 public function testReportTemplate() {
39 $result = $this->callAPISuccess('ReportTemplate', 'create', [
40 'label' => 'Example Form',
41 'description' => 'Longish description of the example form',
42 'class_name' => 'CRM_Report_Form_Examplez',
43 'report_url' => 'example/path',
44 'component' => 'CiviCase',
46 $this->assertAPISuccess($result);
47 $this->assertEquals(1, $result['count']);
48 $entityId = $result['id'];
49 $this->assertTrue(is_numeric($entityId));
50 $this->assertEquals(7, $result['values'][$entityId]['component_id']);
51 $this->assertDBQuery(1, 'SELECT count(*) FROM civicrm_option_value
52 WHERE name = "CRM_Report_Form_Examplez"
53 AND option_group_id IN (SELECT id from civicrm_option_group WHERE name = "report_template") ');
54 $this->assertDBQuery(1, 'SELECT is_active FROM civicrm_option_value
55 WHERE name = "CRM_Report_Form_Examplez"');
57 // change component to null
58 $result = $this->callAPISuccess('ReportTemplate', 'create', [
62 $this->assertAPISuccess($result);
63 $this->assertEquals(1, $result['count']);
64 $this->assertDBQuery(1, 'SELECT count(*) FROM civicrm_option_value
65 WHERE name = "CRM_Report_Form_Examplez"
66 AND option_group_id IN (SELECT id from civicrm_option_group WHERE name = "report_template") ');
67 $this->assertDBQuery(1, 'SELECT count(*) FROM civicrm_option_value
68 WHERE name = "CRM_Report_Form_Examplez"
69 AND component_id IS NULL');
72 $result = $this->callAPISuccess('ReportTemplate', 'create', [
76 $this->assertAPISuccess($result);
77 $this->assertEquals(1, $result['count']);
78 $this->assertDBQuery(1, 'SELECT count(*) FROM civicrm_option_value
79 WHERE name = "CRM_Report_Form_Examplez"
80 AND option_group_id IN (SELECT id from civicrm_option_group WHERE name = "report_template") ');
81 $this->assertDBQuery(0, 'SELECT is_active FROM civicrm_option_value
82 WHERE name = "CRM_Report_Form_Examplez"');
85 $result = $this->callAPISuccess('ReportTemplate', 'create', [
89 $this->assertAPISuccess($result);
90 $this->assertEquals(1, $result['count']);
91 $this->assertDBQuery(1, 'SELECT count(*) FROM civicrm_option_value
92 WHERE name = "CRM_Report_Form_Examplez"
93 AND option_group_id IN (SELECT id from civicrm_option_group WHERE name = "report_template") ');
94 $this->assertDBQuery(1, 'SELECT is_active FROM civicrm_option_value
95 WHERE name = "CRM_Report_Form_Examplez"');
97 $result = $this->callAPISuccess('ReportTemplate', 'delete', [
100 $this->assertAPISuccess($result);
101 $this->assertEquals(1, $result['count']);
102 $this->assertDBQuery(0, 'SELECT count(*) FROM civicrm_option_value
103 WHERE name = "CRM_Report_Form_Examplez"
108 * Test api to get rows from reports.
110 * @dataProvider getReportTemplatesSupportingSelectWhere
114 * @throws \PHPUnit\Framework\IncompleteTestError
116 public function testReportTemplateSelectWhere($reportID) {
117 $this->hookClass
->setHook('civicrm_selectWhereClause', [$this, 'hookSelectWhere']);
118 $result = $this->callAPISuccess('report_template', 'getrows', [
119 'report_id' => $reportID,
120 'options' => ['metadata' => ['sql']],
123 foreach ($result['metadata']['sql'] as $sql) {
124 if (strstr($sql, " = 'Organization' ")) {
128 $this->assertTrue($found, $reportID);
132 * Get templates suitable for SelectWhere test.
136 public function getReportTemplatesSupportingSelectWhere() {
137 $allTemplates = $this->getReportTemplates();
138 // Exclude all that do not work as of test being written. I have not dug into why not.
139 $currentlyExcluded = [
147 'contribute/bookkeeping',
149 'event/incomesummary',
154 'logging/contact/detail',
155 'logging/contact/summary',
157 foreach ($allTemplates as $index => $template) {
158 $reportID = $template[0];
159 if (in_array($reportID, $currentlyExcluded) ||
stristr($reportID, 'has existing issues')) {
160 unset($allTemplates[$index]);
163 return $allTemplates;
167 * @param \CRM_Core_DAO $entity
168 * @param array $clauses
170 public function hookSelectWhere($entity, &$clauses) {
171 // Restrict access to cases by type
172 if ($entity == 'Contact') {
173 $clauses['contact_type'][] = " = 'Organization' ";
178 * Test getrows on contact summary report.
180 public function testReportTemplateGetRowsContactSummary() {
181 $description = "Retrieve rows from a report template (optionally providing the instance_id).";
182 $result = $this->callAPISuccess('report_template', 'getrows', [
183 'report_id' => 'contact/summary',
184 'options' => ['metadata' => ['labels', 'title']],
185 ], __FUNCTION__
, __FILE__
, $description, 'Getrows');
186 $this->assertEquals('Contact Name', $result['metadata']['labels']['civicrm_contact_sort_name']);
188 //the second part of this test has been commented out because it relied on the db being reset to
190 //wasn't able to get that to work consistently
191 // however, when the db is in the base state the tests do pass
192 // and because the test covers 'all' contacts we can't create our own & assume the others don't exist
194 $this->assertEquals(2, $result['count']);
195 $this->assertEquals('Default Organization', $result[0]['civicrm_contact_sort_name']);
196 $this->assertEquals('Second Domain', $result[1]['civicrm_contact_sort_name']);
197 $this->assertEquals('15 Main St', $result[1]['civicrm_address_street_address']);
202 * Test getrows on Mailing Opened report.
204 public function testReportTemplateGetRowsMailingUniqueOpened() {
205 $description = "Retrieve rows from a mailing opened report template.";
206 $this->loadXMLDataSet(dirname(__FILE__
) . '/../../CRM/Mailing/BAO/queryDataset.xml');
208 // Check total rows without distinct
210 $_REQUEST['distinct'] = 0;
211 $result = $this->callAPIAndDocument('report_template', 'getrows', [
212 'report_id' => 'Mailing/opened',
213 'options' => ['metadata' => ['labels', 'title']],
214 ], __FUNCTION__
, __FILE__
, $description, 'Getrows');
215 $this->assertEquals(14, $result['count']);
217 // Check total rows with distinct
218 $_REQUEST['distinct'] = 1;
219 $result = $this->callAPIAndDocument('report_template', 'getrows', [
220 'report_id' => 'Mailing/opened',
221 'options' => ['metadata' => ['labels', 'title']],
222 ], __FUNCTION__
, __FILE__
, $description, 'Getrows');
223 $this->assertEquals(5, $result['count']);
225 // Check total rows with distinct by passing NULL value to distinct parameter
226 $_REQUEST['distinct'] = NULL;
227 $result = $this->callAPIAndDocument('report_template', 'getrows', [
228 'report_id' => 'Mailing/opened',
229 'options' => ['metadata' => ['labels', 'title']],
230 ], __FUNCTION__
, __FILE__
, $description, 'Getrows');
231 $this->assertEquals(5, $result['count']);
235 * Test api to get rows from reports.
237 * @dataProvider getReportTemplates
241 * @throws \PHPUnit\Framework\IncompleteTestError
243 public function testReportTemplateGetRowsAllReports($reportID) {
244 //$reportID = 'logging/contact/summary';
245 if (stristr($reportID, 'has existing issues')) {
246 $this->markTestIncomplete($reportID);
248 if (substr($reportID, 0, '7') === 'logging') {
249 Civi
::settings()->set('logging', 1);
252 $this->callAPISuccess('report_template', 'getrows', [
253 'report_id' => $reportID,
255 if (substr($reportID, 0, '7') === 'logging') {
256 Civi
::settings()->set('logging', 0);
261 * Test logging report when a custom data table has a table removed by hook.
263 * Here we are checking that no fatal is triggered.
265 public function testLoggingReportWithHookRemovalOfCustomDataTable() {
266 Civi
::settings()->set('logging', 1);
267 $group1 = $this->customGroupCreate();
268 $group2 = $this->customGroupCreate(['name' => 'second_one', 'title' => 'second one', 'table_name' => 'civicrm_value_second_one']);
269 $this->customFieldCreate(['custom_group_id' => $group1['id'], 'label' => 'field one']);
270 $this->customFieldCreate(['custom_group_id' => $group2['id'], 'label' => 'field two']);
271 $this->hookClass
->setHook('civicrm_alterLogTables', [$this, 'alterLogTablesRemoveCustom']);
273 $this->callAPISuccess('report_template', 'getrows', [
274 'report_id' => 'logging/contact/summary',
276 Civi
::settings()->set('logging', 0);
277 $this->customGroupDelete($group1['id']);
278 $this->customGroupDelete($group2['id']);
282 * Remove one log table from the logging spec.
284 * @param array $logTableSpec
286 public function alterLogTablesRemoveCustom(&$logTableSpec) {
287 unset($logTableSpec['civicrm_value_second_one']);
291 * Test api to get rows from reports with ACLs enabled.
293 * Checking for lack of fatal error at the moment.
295 * @dataProvider getReportTemplates
299 * @throws \PHPUnit\Framework\IncompleteTestError
301 public function testReportTemplateGetRowsAllReportsACL($reportID) {
302 if (stristr($reportID, 'has existing issues')) {
303 $this->markTestIncomplete($reportID);
305 $this->hookClass
->setHook('civicrm_aclWhereClause', [$this, 'aclWhereHookNoResults']);
306 $this->callAPISuccess('report_template', 'getrows', [
307 'report_id' => $reportID,
312 * Test get statistics.
314 * @dataProvider getReportTemplates
318 * @throws \PHPUnit\Framework\IncompleteTestError
320 public function testReportTemplateGetStatisticsAllReports($reportID) {
321 if (stristr($reportID, 'has existing issues')) {
322 $this->markTestIncomplete($reportID);
324 if (in_array($reportID, ['contribute/softcredit', 'contribute/bookkeeping'])) {
325 $this->markTestIncomplete($reportID . " has non enotices when calling statistics fn");
327 $description = "Get Statistics from a report (note there isn't much data to get in the test DB).";
328 $result = $this->callAPIAndDocument('report_template', 'getstatistics', [
329 'report_id' => $reportID,
330 ], __FUNCTION__
, __FILE__
, $description, 'Getstatistics', 'getstatistics');
334 * Data provider function for getting all templates.
336 * Note that the function needs to
337 * be static so cannot use $this->callAPISuccess
339 public static function getReportTemplates() {
341 'event/income' => 'I do no understand why but error is Call to undefined method CRM_Report_Form_Event_Income::from() in CRM/Report/Form.php on line 2120',
342 'contribute/history' => 'Declaration of CRM_Report_Form_Contribute_History::buildRows() should be compatible with CRM_Report_Form::buildRows($sql, &$rows)',
345 $reports = civicrm_api3('report_template', 'get', ['return' => 'value', 'options' => ['limit' => 500]]);
346 foreach ($reports['values'] as $report) {
347 if (empty($reportsToSkip[$report['value']])) {
348 $reportTemplates[] = [$report['value']];
351 $reportTemplates[] = [$report['value'] . " has existing issues : " . $reportsToSkip[$report['value']]];
355 return $reportTemplates;
359 * Get contribution templates that work with basic filter tests.
361 * These templates require minimal data config.
363 public static function getContributionReportTemplates() {
364 return [['contribute/summary'], ['contribute/detail'], ['contribute/repeat'], ['topDonor' => 'contribute/topDonor']];
368 * Get contribution templates that work with basic filter tests.
370 * These templates require minimal data config.
372 public static function getMembershipReportTemplates() {
373 return [['member/detail']];
377 * Get the membership and contribution reports to test.
381 public static function getMembershipAndContributionReportTemplatesForGroupTests() {
382 $templates = array_merge(self
::getContributionReportTemplates(), self
::getMembershipReportTemplates());
383 foreach ($templates as $key => $value) {
384 if (array_key_exists('topDonor', $value)) {
385 // Report is not standard enough to test here.
386 unset($templates[$key]);
394 * Test Lybunt report to check basic inclusion of a contact who gave in the year before the chosen year.
396 public function testLybuntReportWithData() {
397 $inInd = $this->individualCreate();
398 $outInd = $this->individualCreate();
399 $this->contributionCreate(['contact_id' => $inInd, 'receive_date' => '2014-03-01']);
400 $this->contributionCreate(['contact_id' => $outInd, 'receive_date' => '2015-03-01', 'trxn_id' => NULL, 'invoice_id' => NULL]);
401 $rows = $this->callAPISuccess('report_template', 'getrows', [
402 'report_id' => 'contribute/lybunt',
404 'yid_op' => 'calendar',
405 'options' => ['metadata' => ['sql']],
407 $this->assertEquals(1, $rows['count'], "Report failed - the sql used to generate the results was " . print_r($rows['metadata']['sql'], TRUE));
411 * Test Lybunt report applies ACLs.
413 public function testLybuntReportWithDataAndACLFilter() {
414 CRM_Core_Config
::singleton()->userPermissionClass
->permissions
= ['administer CiviCRM'];
415 $inInd = $this->individualCreate();
416 $outInd = $this->individualCreate();
417 $this->contributionCreate(['contact_id' => $inInd, 'receive_date' => '2014-03-01']);
418 $this->contributionCreate(['contact_id' => $outInd, 'receive_date' => '2015-03-01', 'trxn_id' => NULL, 'invoice_id' => NULL]);
419 $this->hookClass
->setHook('civicrm_aclWhereClause', [$this, 'aclWhereHookNoResults']);
421 'report_id' => 'contribute/lybunt',
423 'yid_op' => 'calendar',
424 'options' => ['metadata' => ['sql']],
425 'check_permissions' => 1,
428 $rows = $this->callAPISuccess('report_template', 'getrows', $params);
429 $this->assertEquals(0, $rows['count'], "Report failed - the sql used to generate the results was " . print_r($rows['metadata']['sql'], TRUE));
431 CRM_Utils_Hook
::singleton()->reset();
435 * Test Lybunt report to check basic inclusion of a contact who gave in the year before the chosen year.
437 public function testLybuntReportWithFYData() {
438 $inInd = $this->individualCreate();
439 $outInd = $this->individualCreate();
440 $this->contributionCreate(['contact_id' => $inInd, 'receive_date' => '2014-10-01']);
441 $this->contributionCreate(['contact_id' => $outInd, 'receive_date' => '2015-03-01', 'trxn_id' => NULL, 'invoice_id' => NULL]);
442 $this->callAPISuccess('Setting', 'create', ['fiscalYearStart' => ['M' => 7, 'd' => 1]]);
443 $rows = $this->callAPISuccess('report_template', 'getrows', [
444 'report_id' => 'contribute/lybunt',
446 'yid_op' => 'fiscal',
447 'options' => ['metadata' => ['sql']],
450 'column' => 'first_name',
456 $this->assertEquals(2, $rows['count'], "Report failed - the sql used to generate the results was " . print_r($rows['metadata']['sql'], TRUE));
458 $expected = preg_replace('/\s+/', ' ', 'DEFAULT CHARACTER SET utf8 COLLATE utf8_unicode_ci AS
459 SELECT SQL_CALC_FOUND_ROWS contact_civireport.id as cid FROM civicrm_contact contact_civireport INNER JOIN civicrm_contribution contribution_civireport USE index (received_date) ON contribution_civireport.contact_id = contact_civireport.id
460 AND contribution_civireport.is_test = 0
461 AND contribution_civireport.receive_date BETWEEN \'20140701000000\' AND \'20150630235959\'
462 WHERE contact_civireport.id NOT IN (
463 SELECT cont_exclude.contact_id
464 FROM civicrm_contribution cont_exclude
465 WHERE cont_exclude.receive_date BETWEEN \'2015-7-1\' AND \'20160630235959\')
466 AND ( contribution_civireport.contribution_status_id IN (1) )
467 GROUP BY contact_civireport.id');
468 // Exclude whitespace in comparison as we don't care if it changes & this allows us to make the above readable.
469 $whitespacelessSql = preg_replace('/\s+/', ' ', $rows['metadata']['sql'][0]);
470 $this->assertContains($expected, $whitespacelessSql);
474 * Test Lybunt report to check basic inclusion of a contact who gave in the year before the chosen year.
476 public function testLybuntReportWithFYDataOrderByLastYearAmount() {
477 $inInd = $this->individualCreate();
478 $outInd = $this->individualCreate();
479 $this->contributionCreate(['contact_id' => $inInd, 'receive_date' => '2014-10-01']);
480 $this->contributionCreate(['contact_id' => $outInd, 'receive_date' => '2015-03-01', 'trxn_id' => NULL, 'invoice_id' => NULL]);
481 $this->callAPISuccess('Setting', 'create', ['fiscalYearStart' => ['M' => 7, 'd' => 1]]);
482 $rows = $this->callAPISuccess('report_template', 'getrows', [
483 'report_id' => 'contribute/lybunt',
485 'yid_op' => 'fiscal',
486 'options' => ['metadata' => ['sql']],
487 'fields' => ['first_name'],
490 'column' => 'last_year_total_amount',
496 $this->assertEquals(2, $rows['count'], "Report failed - the sql used to generate the results was " . print_r($rows['metadata']['sql'], TRUE));
500 * Test the group filter works on the contribution summary (with a smart group).
502 * @dataProvider getMembershipAndContributionReportTemplatesForGroupTests
504 * @param string $template
505 * Name of the template to test.
507 public function testContributionSummaryWithSmartGroupFilter($template) {
508 $groupID = $this->setUpPopulatedSmartGroup();
509 $rows = $this->callAPISuccess('report_template', 'getrows', [
510 'report_id' => $template,
511 'gid_value' => $groupID,
513 'options' => ['metadata' => ['sql']],
515 $this->assertNumberOfContactsInResult(3, $rows, $template);
516 if ($template === 'contribute/summary') {
517 $this->assertEquals(3, $rows['values'][0]['civicrm_contribution_total_amount_count']);
522 * Test the group filter works on the contribution summary.
524 * @dataProvider getMembershipAndContributionReportTemplatesForGroupTests
526 public function testContributionSummaryWithNotINSmartGroupFilter($template) {
527 $groupID = $this->setUpPopulatedSmartGroup();
528 $rows = $this->callAPISuccess('report_template', 'getrows', [
529 'report_id' => 'contribute/summary',
530 'gid_value' => $groupID,
532 'options' => ['metadata' => ['sql']],
534 $this->assertEquals(2, $rows['values'][0]['civicrm_contribution_total_amount_count']);
538 * Test no fatal on order by per https://lab.civicrm.org/dev/core/issues/739
540 public function testCaseDetailsCaseTypeHeader() {
541 $this->callAPISuccess('report_template', 'getrows', [
542 'report_id' => 'case/detail',
543 'fields' => ['subject' => 1, 'client_sort_name' => 1],
546 'column' => 'case_type_title',
555 * Test the group filter works on the contribution summary.
557 public function testContributionDetailSoftCredits() {
558 $contactID = $this->individualCreate();
559 $contactID2 = $this->individualCreate();
560 $this->contributionCreate(['contact_id' => $contactID, 'api.ContributionSoft.create' => ['amount' => 5, 'contact_id' => $contactID2]]);
561 $template = 'contribute/detail';
562 $rows = $this->callAPISuccess('report_template', 'getrows', [
563 'report_id' => $template,
564 'contribution_or_soft_value' => 'contributions_only',
565 'fields' => ['soft_credits' => 1, 'contribution_or_soft' => 1, 'sort_name' => 1],
566 'options' => ['metadata' => ['sql']],
569 "<a href='/index.php?q=civicrm/contact/view&reset=1&cid=" . $contactID2 . "'>Anderson, Anthony</a> $ 5.00",
570 $rows['values'][0]['civicrm_contribution_soft_credits']
575 * Test the amount column is populated on soft credit details.
577 public function testContributionDetailSoftCreditsOnly() {
578 $contactID = $this->individualCreate();
579 $contactID2 = $this->individualCreate();
580 $this->contributionCreate(['contact_id' => $contactID, 'api.ContributionSoft.create' => ['amount' => 5, 'contact_id' => $contactID2]]);
581 $template = 'contribute/detail';
582 $rows = $this->callAPISuccess('report_template', 'getrows', [
583 'report_id' => $template,
584 'contribution_or_soft_value' => 'soft_credits_only',
588 'financial_type_id' => '1',
589 'receive_date' => '1',
590 'total_amount' => '1',
592 'options' => ['metadata' => ['sql', 'labels']],
594 foreach (array_keys($rows['metadata']['labels']) as $header) {
595 $this->assertTrue(!empty($rows['values'][0][$header]));
600 * Test the group filter works on the various reports.
602 * @dataProvider getMembershipAndContributionReportTemplatesForGroupTests
604 * @param string $template
605 * Report template unique identifier.
607 public function testReportsWithNonSmartGroupFilter($template) {
608 $groupID = $this->setUpPopulatedGroup();
609 $rows = $this->callAPISuccess('report_template', 'getrows', [
610 'report_id' => $template,
611 'gid_value' => [$groupID],
613 'options' => ['metadata' => ['sql']],
615 $this->assertNumberOfContactsInResult(1, $rows, $template);
619 * Assert the included results match the expected.
621 * There may or may not be a group by in play so the assertion varies a little.
623 * @param int $numberExpected
625 * Rows returned from the report.
626 * @param string $template
628 protected function assertNumberOfContactsInResult($numberExpected, $rows, $template) {
629 if (isset($rows['values'][0]['civicrm_contribution_total_amount_count'])) {
630 $this->assertEquals($numberExpected, $rows['values'][0]['civicrm_contribution_total_amount_count'], 'wrong row count in ' . $template);
633 $this->assertEquals($numberExpected, count($rows['values']), 'wrong row count in ' . $template);
638 * Test the group filter works on the contribution summary when 2 groups are involved.
640 public function testContributionSummaryWithTwoGroups() {
641 $groupID = $this->setUpPopulatedGroup();
642 $groupID2 = $this->setUpPopulatedSmartGroup();
643 $rows = $this->callAPISuccess('report_template', 'getrows', [
644 'report_id' => 'contribute/summary',
645 'gid_value' => [$groupID, $groupID2],
647 'options' => ['metadata' => ['sql']],
649 $this->assertEquals(4, $rows['values'][0]['civicrm_contribution_total_amount_count']);
653 * CRM-20640: Test the group filter works on the contribution summary when a single contact in 2 groups.
655 public function testContributionSummaryWithSingleContactsInTwoGroups() {
656 list($groupID1, $individualID) = $this->setUpPopulatedGroup(TRUE);
657 // create second group and add the individual to it.
658 $groupID2 = $this->groupCreate(['name' => uniqid(), 'title' => uniqid()]);
659 $this->callAPISuccess('GroupContact', 'create', [
660 'group_id' => $groupID2,
661 'contact_id' => $individualID,
665 $rows = $this->callAPISuccess('report_template', 'getrows', [
666 'report_id' => 'contribute/summary',
667 'gid_value' => [$groupID1, $groupID2],
669 'options' => ['metadata' => ['sql']],
671 $this->assertEquals(1, $rows['count']);
675 * Test the group filter works on the contribution summary when 2 groups are involved.
677 public function testContributionSummaryWithTwoGroupsWithIntersection() {
678 $groups = $this->setUpIntersectingGroups();
680 $rows = $this->callAPISuccess('report_template', 'getrows', [
681 'report_id' => 'contribute/summary',
682 'gid_value' => $groups,
684 'options' => ['metadata' => ['sql']],
686 $this->assertEquals(7, $rows['values'][0]['civicrm_contribution_total_amount_count']);
690 * Set up a smart group for testing.
692 * The smart group includes all Households by filter. In addition an individual
693 * is created and hard-added and an individual is created that is not added.
695 * One household is hard-added as well as being in the filter.
697 * This gives us a range of scenarios for testing contacts are included only once
698 * whenever they are hard-added or in the criteria.
702 public function setUpPopulatedSmartGroup() {
703 $household1ID = $this->householdCreate();
704 $individual1ID = $this->individualCreate();
705 $householdID = $this->householdCreate();
706 $individualID = $this->individualCreate();
707 $individualIDRemoved = $this->individualCreate();
708 $groupID = $this->smartGroupCreate([], ['name' => uniqid(), 'title' => uniqid()]);
709 $this->callAPISuccess('GroupContact', 'create', [
710 'group_id' => $groupID,
711 'contact_id' => $individualIDRemoved,
712 'status' => 'Removed',
714 $this->callAPISuccess('GroupContact', 'create', [
715 'group_id' => $groupID,
716 'contact_id' => $individualID,
719 $this->callAPISuccess('GroupContact', 'create', [
720 'group_id' => $groupID,
721 'contact_id' => $householdID,
724 foreach ([$household1ID, $individual1ID, $householdID, $individualID, $individualIDRemoved] as $contactID) {
725 $this->contributionCreate(['contact_id' => $contactID, 'invoice_id' => '', 'trxn_id' => '']);
726 $this->contactMembershipCreate(['contact_id' => $contactID]);
729 // Refresh the cache for test purposes. It would be better to alter to alter the GroupContact add function to add contacts to the cache.
730 CRM_Contact_BAO_GroupContactCache
::clearGroupContactCache($groupID);
735 * Set up a static group for testing.
737 * An individual is created and hard-added and an individual is created that is not added.
739 * This gives us a range of scenarios for testing contacts are included only once
740 * whenever they are hard-added or in the criteria.
742 * @param bool $returnAddedContact
746 public function setUpPopulatedGroup($returnAddedContact = FALSE) {
747 $individual1ID = $this->individualCreate();
748 $individualID = $this->individualCreate();
749 $individualIDRemoved = $this->individualCreate();
750 $groupID = $this->groupCreate(['name' => uniqid(), 'title' => uniqid()]);
751 $this->callAPISuccess('GroupContact', 'create', [
752 'group_id' => $groupID,
753 'contact_id' => $individualIDRemoved,
754 'status' => 'Removed',
756 $this->callAPISuccess('GroupContact', 'create', [
757 'group_id' => $groupID,
758 'contact_id' => $individualID,
762 foreach ([$individual1ID, $individualID, $individualIDRemoved] as $contactID) {
763 $this->contributionCreate(['contact_id' => $contactID, 'invoice_id' => '', 'trxn_id' => '']);
764 $this->contactMembershipCreate(['contact_id' => $contactID]);
767 // Refresh the cache for test purposes. It would be better to alter to alter the GroupContact add function to add contacts to the cache.
768 CRM_Contact_BAO_GroupContactCache
::clearGroupContactCache($groupID);
770 if ($returnAddedContact) {
771 return [$groupID, $individualID];
780 public function setUpIntersectingGroups() {
781 $groupID = $this->setUpPopulatedGroup();
782 $groupID2 = $this->setUpPopulatedSmartGroup();
783 $addedToBothIndividualID = $this->individualCreate();
784 $removedFromBothIndividualID = $this->individualCreate();
785 $addedToSmartGroupRemovedFromOtherIndividualID = $this->individualCreate();
786 $removedFromSmartGroupAddedToOtherIndividualID = $this->individualCreate();
787 $this->callAPISuccess('GroupContact', 'create', [
788 'group_id' => $groupID,
789 'contact_id' => $addedToBothIndividualID,
792 $this->callAPISuccess('GroupContact', 'create', [
793 'group_id' => $groupID2,
794 'contact_id' => $addedToBothIndividualID,
797 $this->callAPISuccess('GroupContact', 'create', [
798 'group_id' => $groupID,
799 'contact_id' => $removedFromBothIndividualID,
800 'status' => 'Removed',
802 $this->callAPISuccess('GroupContact', 'create', [
803 'group_id' => $groupID2,
804 'contact_id' => $removedFromBothIndividualID,
805 'status' => 'Removed',
807 $this->callAPISuccess('GroupContact', 'create', [
808 'group_id' => $groupID2,
809 'contact_id' => $addedToSmartGroupRemovedFromOtherIndividualID,
812 $this->callAPISuccess('GroupContact', 'create', [
813 'group_id' => $groupID,
814 'contact_id' => $addedToSmartGroupRemovedFromOtherIndividualID,
815 'status' => 'Removed',
817 $this->callAPISuccess('GroupContact', 'create', [
818 'group_id' => $groupID,
819 'contact_id' => $removedFromSmartGroupAddedToOtherIndividualID,
822 $this->callAPISuccess('GroupContact', 'create', [
823 'group_id' => $groupID2,
824 'contact_id' => $removedFromSmartGroupAddedToOtherIndividualID,
825 'status' => 'Removed',
829 $addedToBothIndividualID,
830 $removedFromBothIndividualID,
831 $addedToSmartGroupRemovedFromOtherIndividualID,
832 $removedFromSmartGroupAddedToOtherIndividualID,
834 $this->contributionCreate([
835 'contact_id' => $contactID,
840 return [$groupID, $groupID2];
844 * Test Deferred Revenue Report.
846 public function testDeferredRevenueReport() {
847 $indv1 = $this->individualCreate();
848 $indv2 = $this->individualCreate();
850 'contribution_invoice_settings' => [
851 'deferred_revenue_enabled' => '1',
854 $this->callAPISuccess('Setting', 'create', $params);
855 $this->contributionCreate(
857 'contact_id' => $indv1,
858 'receive_date' => '2016-10-01',
859 'revenue_recognition_date' => date('Y-m-t', strtotime(date('ymd') . '+3 month')),
860 'financial_type_id' => 2,
863 $this->contributionCreate(
865 'contact_id' => $indv1,
866 'revenue_recognition_date' => date('Y-m-t', strtotime(date('ymd') . '+22 month')),
867 'financial_type_id' => 4,
869 'invoice_id' => NULL,
872 $this->contributionCreate(
874 'contact_id' => $indv2,
875 'revenue_recognition_date' => date('Y-m-t', strtotime(date('ymd') . '+1 month')),
876 'financial_type_id' => 4,
878 'invoice_id' => NULL,
881 $this->contributionCreate(
883 'contact_id' => $indv2,
884 'receive_date' => '2016-03-01',
885 'revenue_recognition_date' => date('Y-m-t', strtotime(date('ymd') . '+4 month')),
886 'financial_type_id' => 2,
888 'invoice_id' => NULL,
891 $rows = $this->callAPISuccess('report_template', 'getrows', [
892 'report_id' => 'contribute/deferredrevenue',
894 $this->assertEquals(2, $rows['count'], "Report failed to get row count");
896 foreach ($rows['values'] as $row) {
897 $this->assertEquals(array_pop($count), count($row['rows']), "Report failed to get row count");
902 * Test the custom data order by works when not in select.
904 * @dataProvider getMembershipAndContributionReportTemplatesForGroupTests
906 * @param string $template
907 * Report template unique identifier.
909 * @throws \CRM_Core_Exception
911 public function testReportsCustomDataOrderBy($template) {
912 $this->entity
= 'Contact';
913 $this->createCustomGroupWithFieldOfType();
914 $this->callAPISuccess('report_template', 'getrows', [
915 'report_id' => $template,
916 'contribution_or_soft_value' => 'contributions_only',
917 'order_bys' => [['column' => 'custom_' . $this->ids
['CustomField']['text'], 'order' => 'ASC']],
922 * Test the group filter works on the various reports.
924 * @dataProvider getMembershipAndContributionReportTemplatesForGroupTests
926 * @param string $template
927 * Report template unique identifier.
929 public function testReportsWithNoTInSmartGroupFilter($template) {
930 $groupID = $this->setUpPopulatedGroup();
931 $rows = $this->callAPISuccess('report_template', 'getrows', [
932 'report_id' => $template,
933 'gid_value' => [$groupID],
935 'options' => ['metadata' => ['sql']],
937 $this->assertNumberOfContactsInResult(2, $rows, $template);
941 * Test activity details report - requiring all current fields to be output.
943 public function testActivityDetails() {
944 $this->createContactsWithActivities();
946 'contact_source' => '1',
947 'contact_assignee' => '1',
948 'contact_target' => '1',
949 'contact_source_email' => '1',
950 'contact_assignee_email' => '1',
951 'contact_target_email' => '1',
952 'contact_source_phone' => '1',
953 'contact_assignee_phone' => '1',
954 'contact_target_phone' => '1',
955 'activity_type_id' => '1',
956 'activity_subject' => '1',
957 'activity_date_time' => '1',
962 'priority_id' => '1',
964 'engagement_level' => '1',
965 'address_name' => '1',
966 'street_address' => '1',
967 'supplemental_address_1' => '1',
968 'supplemental_address_2' => '1',
969 'supplemental_address_3' => '1',
970 'street_number' => '1',
971 'street_name' => '1',
972 'street_unit' => '1',
974 'postal_code' => '1',
975 'postal_code_suffix' => '1',
977 'state_province_id' => '1',
982 'current_user_op' => 'eq',
983 'current_user_value' => '0',
984 'include_case_activities_op' => 'eq',
985 'include_case_activities_value' => 0,
987 1 => ['column' => 'activity_date_time', 'order' => 'ASC'],
988 2 => ['column' => 'activity_type_id', 'order' => 'ASC'],
992 $params['report_id'] = 'Activity';
994 $rows = $this->callAPISuccess('report_template', 'getrows', $params)['values'];
996 'civicrm_contact_contact_source' => 'Łąchowski-Roberts, Anthony',
997 'civicrm_contact_contact_assignee' => '<a title=\'View Contact Summary for this Contact\' href=\'/index.php?q=civicrm/contact/view&reset=1&cid=4\'>Łąchowski-Roberts, Anthony</a>',
998 'civicrm_contact_contact_target' => '<a title=\'View Contact Summary for this Contact\' href=\'/index.php?q=civicrm/contact/view&reset=1&cid=3\'>Brzęczysław, Anthony</a>; <a title=\'View Contact Summary for this Contact\' href=\'/index.php?q=civicrm/contact/view&reset=1&cid=4\'>Łąchowski-Roberts, Anthony</a>',
999 'civicrm_contact_contact_source_id' => $this->contactIDs
[2],
1000 'civicrm_contact_contact_assignee_id' => $this->contactIDs
[1],
1001 'civicrm_contact_contact_target_id' => $this->contactIDs
[0] . ';' . $this->contactIDs
[1],
1002 'civicrm_email_contact_source_email' => 'anthony_anderson@civicrm.org',
1003 'civicrm_email_contact_assignee_email' => 'anthony_anderson@civicrm.org',
1004 'civicrm_email_contact_target_email' => 'techo@spying.com;anthony_anderson@civicrm.org',
1005 'civicrm_phone_contact_source_phone' => NULL,
1006 'civicrm_phone_contact_assignee_phone' => NULL,
1007 'civicrm_phone_contact_target_phone' => NULL,
1008 'civicrm_activity_id' => '1',
1009 'civicrm_activity_source_record_id' => NULL,
1010 'civicrm_activity_activity_type_id' => 'Meeting',
1011 'civicrm_activity_activity_subject' => 'Very secret meeting',
1012 'civicrm_activity_activity_date_time' => date('Y-m-d 23:59:58', strtotime('now')),
1013 'civicrm_activity_status_id' => 'Scheduled',
1014 'civicrm_activity_duration' => '120',
1015 'civicrm_activity_location' => 'Pennsylvania',
1016 'civicrm_activity_details' => 'a test activity',
1017 'civicrm_activity_priority_id' => 'Normal',
1018 'civicrm_address_address_name' => NULL,
1019 'civicrm_address_street_address' => NULL,
1020 'civicrm_address_supplemental_address_1' => NULL,
1021 'civicrm_address_supplemental_address_2' => NULL,
1022 'civicrm_address_supplemental_address_3' => NULL,
1023 'civicrm_address_street_number' => NULL,
1024 'civicrm_address_street_name' => NULL,
1025 'civicrm_address_street_unit' => NULL,
1026 'civicrm_address_city' => NULL,
1027 'civicrm_address_postal_code' => NULL,
1028 'civicrm_address_postal_code_suffix' => NULL,
1029 'civicrm_address_country_id' => NULL,
1030 'civicrm_address_state_province_id' => NULL,
1031 'civicrm_address_county_id' => NULL,
1032 'civicrm_contact_contact_source_link' => '/index.php?q=civicrm/contact/view&reset=1&cid=' . $this->contactIDs
[2],
1033 'civicrm_contact_contact_source_hover' => 'View Contact Summary for this Contact',
1034 'civicrm_activity_activity_type_id_hover' => 'View Activity Record',
1037 // This link is not relative - skip for now
1038 unset($row['civicrm_activity_activity_type_id_link']);
1039 if ($row['civicrm_email_contact_target_email'] === 'anthony_anderson@civicrm.org;techo@spying.com') {
1040 // order is unpredictable
1041 $expected['civicrm_email_contact_target_email'] = 'anthony_anderson@civicrm.org;techo@spying.com';
1044 $this->assertEquals($expected, $row);
1048 * Set up some activity data..... use some chars that challenge our utf handling.
1050 public function createContactsWithActivities() {
1051 $this->contactIDs
[] = $this->individualCreate(['last_name' => 'Brzęczysław', 'email' => 'techo@spying.com']);
1052 $this->contactIDs
[] = $this->individualCreate(['last_name' => 'Łąchowski-Roberts']);
1053 $this->contactIDs
[] = $this->individualCreate(['last_name' => 'Łąchowski-Roberts']);
1055 $this->callAPISuccess('Activity', 'create', [
1056 'subject' => 'Very secret meeting',
1057 'activity_date_time' => date('Y-m-d 23:59:58', strtotime('now')),
1059 'location' => 'Pennsylvania',
1060 'details' => 'a test activity',
1062 'activity_type_id' => 'Meeting',
1063 'source_contact_id' => $this->contactIDs
[2],
1064 'target_contact_id' => [$this->contactIDs
[0], $this->contactIDs
[1]],
1065 'assignee_contact_id' => $this->contactIDs
[1],
1070 * Test the group filter works on the contribution summary.
1072 public function testContributionDetailTotalHeader() {
1073 $contactID = $this->individualCreate();
1074 $contactID2 = $this->individualCreate();
1075 $this->contributionCreate(['contact_id' => $contactID, 'api.ContributionSoft.create' => ['amount' => 5, 'contact_id' => $contactID2]]);
1076 $template = 'contribute/detail';
1077 $rows = $this->callAPISuccess('report_template', 'getrows', [
1078 'report_id' => $template,
1079 'contribution_or_soft_value' => 'contributions_only',
1085 'financial_type_id' => '1',
1086 'receive_date' => '1',
1087 'total_amount' => '1',
1089 'order_bys' => [['column' => 'sort_name', 'order' => 'ASC', 'section' => '1']],
1090 'options' => ['metadata' => ['sql']],
1095 * Test contact subtype filter on grant report.
1097 public function testGrantReportSeparatedFilter() {
1098 $contactID = $this->individualCreate(['contact_sub_type' => ['Student', 'Parent']]);
1099 $contactID2 = $this->individualCreate();
1100 $this->callAPISuccess('Grant', 'create', ['contact_id' => $contactID, 'status_id' => 1, 'grant_type_id' => 1, 'amount_total' => 1]);
1101 $this->callAPISuccess('Grant', 'create', ['contact_id' => $contactID2, 'status_id' => 1, 'grant_type_id' => 1, 'amount_total' => 1]);
1102 $rows = $this->callAPISuccess('report_template', 'getrows', [
1103 'report_id' => 'grant/detail',
1104 'contact_sub_type_op' => 'in',
1105 'contact_sub_type_value' => ['Student'],
1107 $this->assertEquals(1, $rows['count']);
1111 * Test contact subtype filter on summary report.
1113 * @throws \CRM_Core_Exception
1115 public function testContactSubtypeNotNull() {
1116 $this->individualCreate(['contact_sub_type' => ['Student', 'Parent']]);
1117 $this->individualCreate();
1119 $rows = $this->callAPISuccess('report_template', 'getrows', [
1120 'report_id' => 'contact/summary',
1121 'contact_sub_type_op' => 'nnll',
1122 'contact_sub_type_value' => [],
1123 'contact_type_op' => 'eq',
1124 'contact_type_value' => 'Individual',
1126 $this->assertEquals(1, $rows['count']);
1130 * Test contact subtype filter on summary report.
1132 * @throws \CRM_Core_Exception
1134 public function testContactSubtypeNull() {
1135 $this->individualCreate(['contact_sub_type' => ['Student', 'Parent']]);
1136 $this->individualCreate();
1138 $rows = $this->callAPISuccess('report_template', 'getrows', [
1139 'report_id' => 'contact/summary',
1140 'contact_sub_type_op' => 'nll',
1141 'contact_sub_type_value' => [],
1142 'contact_type_op' => 'eq',
1143 'contact_type_value' => 'Individual',
1145 $this->assertEquals(1, $rows['count']);
1149 * Test PCP report to ensure total donors and total committed is accurate.
1151 public function testPcpReportTotals() {
1152 $donor1ContactId = $this->individualCreate();
1153 $donor2ContactId = $this->individualCreate();
1154 $donor3ContactId = $this->individualCreate();
1156 // We are going to create two PCP pages. We will create two contributions
1157 // on the first PCP page and one contribution on the second PCP page.
1159 // Then, we will ensure that the first PCP page reports a total of both
1160 // contributions (but not the contribution made on the second PCP page).
1162 // A PCP page requires three components:
1163 // 1. A contribution page
1167 // pcpBLockParams creates a contribution page and returns the parameters
1168 // necessary to create a PBP Block.
1169 $blockParams = $this->pcpBlockParams();
1170 $pcpBlock = CRM_PCP_BAO_PCPBlock
::create($blockParams);
1172 // Keep track of the contribution page id created. We will use this
1173 // contribution page id for all the PCP pages.
1174 $contribution_page_id = $pcpBlock->entity_id
;
1176 // pcpParams returns the parameters needed to create a PCP page.
1177 $pcpParams = $this->pcpParams();
1178 // Keep track of the owner of the page so we can properly apply the
1180 $pcpOwnerContact1Id = $pcpParams['contact_id'];
1181 $pcpParams['pcp_block_id'] = $pcpBlock->id
;
1182 $pcpParams['page_id'] = $contribution_page_id;
1183 $pcpParams['page_type'] = 'contribute';
1184 $pcp1 = CRM_PCP_BAO_PCP
::create($pcpParams);
1186 // Nice work. Now, let's create a second PCP page.
1187 $pcpParams = $this->pcpParams();
1188 // Keep track of the owner of the page.
1189 $pcpOwnerContact2Id = $pcpParams['contact_id'];
1190 // We're using the same pcpBlock id and contribution page that we created above.
1191 $pcpParams['pcp_block_id'] = $pcpBlock->id
;
1192 $pcpParams['page_id'] = $contribution_page_id;
1193 $pcpParams['page_type'] = 'contribute';
1194 $pcp2 = CRM_PCP_BAO_PCP
::create($pcpParams);
1196 // Get soft credit types, with the name column as the key.
1197 $soft_credit_types = CRM_Contribute_BAO_ContributionSoft
::buildOptions("soft_credit_type_id", NULL, ["flip" => TRUE, 'labelColumn' => 'name']);
1198 $pcp_soft_credit_type_id = $soft_credit_types['pcp'];
1200 // Create two contributions assigned to this contribution page and
1201 // assign soft credits appropriately.
1203 $contribution1params = [
1204 'contact_id' => $donor1ContactId,
1205 'contribution_page_id' => $contribution_page_id,
1206 'total_amount' => '75.00',
1208 $c1 = $this->contributionCreate($contribution1params);
1209 // Now the soft contribution.
1211 'contribution_id' => $c1,
1212 'pcp_id' => $pcp1->id
,
1213 'contact_id' => $pcpOwnerContact1Id,
1215 'currency' => 'USD',
1216 'soft_credit_type_id' => $pcp_soft_credit_type_id,
1218 $this->callAPISuccess('contribution_soft', 'create', $p);
1220 $contribution2params = [
1221 'contact_id' => $donor2ContactId,
1222 'contribution_page_id' => $contribution_page_id,
1223 'total_amount' => '25.00',
1225 $c2 = $this->contributionCreate($contribution2params);
1226 // Now the soft contribution.
1228 'contribution_id' => $c2,
1229 'pcp_id' => $pcp1->id
,
1230 'contact_id' => $pcpOwnerContact1Id,
1232 'currency' => 'USD',
1233 'soft_credit_type_id' => $pcp_soft_credit_type_id,
1235 $this->callAPISuccess('contribution_soft', 'create', $p);
1237 // Create one contributions assigned to the second PCP page
1238 $contribution3params = [
1239 'contact_id' => $donor3ContactId,
1240 'contribution_page_id' => $contribution_page_id,
1241 'total_amount' => '200.00',
1243 $c3 = $this->contributionCreate($contribution3params);
1244 // Now the soft contribution.
1246 'contribution_id' => $c3,
1247 'pcp_id' => $pcp2->id
,
1248 'contact_id' => $pcpOwnerContact2Id,
1250 'currency' => 'USD',
1251 'soft_credit_type_id' => $pcp_soft_credit_type_id,
1253 $this->callAPISuccess('contribution_soft', 'create', $p);
1255 $template = 'contribute/pcp';
1256 $rows = $this->callAPISuccess('report_template', 'getrows', [
1257 'report_id' => $template,
1258 'title' => 'My PCP',
1264 $values = $rows['values'][0];
1265 $this->assertEquals(100.00, $values['civicrm_contribution_soft_amount_1_sum'], "Total commited should be $100");
1266 $this->assertEquals(2, $values['civicrm_contribution_soft_soft_id_count'], "Total donors should be 2");
1270 * Test a report that uses getAddressColumns();
1272 public function testGetAddressColumns() {
1273 $template = 'event/participantlisting';
1274 $this->callAPISuccess('report_template', 'getrows', [
1275 'report_id' => $template,
1278 'street_address' => '1',