tests/phpunit/api/v3/ReportTemplateTest.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.7                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2017                                |
   7  +--------------------------------------------------------------------+
   8  | This file is a part of CiviCRM.                                    |
   9  |                                                                    |
  10  | CiviCRM is free software; you can copy, modify, and distribute it  |
  11  | under the terms of the GNU Affero General Public License           |
  12  | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
  13  |                                                                    |
  14  | CiviCRM is distributed in the hope that it will be useful, but     |
  15  | WITHOUT ANY WARRANTY; without even the implied warranty of         |
  16  | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
  17  | See the GNU Affero General Public License for more details.        |
  18  |                                                                    |
  19  | You should have received a copy of the GNU Affero General Public   |
  20  | License and the CiviCRM Licensing Exception along                  |
  21  | with this program; if not, contact CiviCRM LLC                     |
  22  | at info[AT]civicrm[DOT]org. If you have questions about the        |
  23  | GNU Affero General Public License or the licensing of CiviCRM,     |
  24  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  25  +--------------------------------------------------------------------+
  26  */
  27
  28 /**
  29  *  Test APIv3 civicrm_report_instance_* functions
  30  *
  31  * @package CiviCRM_APIv3
  32  * @subpackage API_Report
  33  * @group headless
  34  */
  35 class api_v3_ReportTemplateTest extends CiviUnitTestCase {
  36   protected $_apiversion = 3;
  37
  38   /**
  39    * Our group reports use an alter so transaction cleanup won't work.
  40    *
  41    * @throws \Exception
  42    */
  43   public function tearDown() {
  44     $this->quickCleanUpFinancialEntities();
  45     $this->quickCleanup(array('civicrm_group', 'civicrm_saved_search', 'civicrm_group_contact', 'civicrm_group_contact_cache', 'civicrm_group'));
  46     parent::tearDown();
  47   }
  48
  49   public function testReportTemplate() {
  50     $result = $this->callAPISuccess('ReportTemplate', 'create', array(
  51       'label' => 'Example Form',
  52       'description' => 'Longish description of the example form',
  53       'class_name' => 'CRM_Report_Form_Examplez',
  54       'report_url' => 'example/path',
  55       'component' => 'CiviCase',
  56     ));
  57     $this->assertAPISuccess($result);
  58     $this->assertEquals(1, $result['count']);
  59     $entityId = $result['id'];
  60     $this->assertTrue(is_numeric($entityId));
  61     $this->assertEquals(7, $result['values'][$entityId]['component_id']);
  62     $this->assertDBQuery(1, 'SELECT count(*) FROM civicrm_option_value
  63       WHERE name = "CRM_Report_Form_Examplez"
  64       AND option_group_id IN (SELECT id from civicrm_option_group WHERE name = "report_template") ');
  65     $this->assertDBQuery(1, 'SELECT is_active FROM civicrm_option_value
  66       WHERE name = "CRM_Report_Form_Examplez"');
  67
  68     // change component to null
  69     $result = $this->callAPISuccess('ReportTemplate', 'create', array(
  70       'id' => $entityId,
  71       'component' => '',
  72     ));
  73     $this->assertAPISuccess($result);
  74     $this->assertEquals(1, $result['count']);
  75     $this->assertDBQuery(1, 'SELECT count(*) FROM civicrm_option_value
  76       WHERE name = "CRM_Report_Form_Examplez"
  77       AND option_group_id IN (SELECT id from civicrm_option_group WHERE name = "report_template") ');
  78     $this->assertDBQuery(1, 'SELECT count(*) FROM civicrm_option_value
  79       WHERE name = "CRM_Report_Form_Examplez"
  80       AND component_id IS NULL');
  81
  82     // deactivate
  83     $result = $this->callAPISuccess('ReportTemplate', 'create', array(
  84       'id' => $entityId,
  85       'is_active' => 0,
  86     ));
  87     $this->assertAPISuccess($result);
  88     $this->assertEquals(1, $result['count']);
  89     $this->assertDBQuery(1, 'SELECT count(*) FROM civicrm_option_value
  90       WHERE name = "CRM_Report_Form_Examplez"
  91       AND option_group_id IN (SELECT id from civicrm_option_group WHERE name = "report_template") ');
  92     $this->assertDBQuery(0, 'SELECT is_active FROM civicrm_option_value
  93       WHERE name = "CRM_Report_Form_Examplez"');
  94
  95     // activate
  96     $result = $this->callAPISuccess('ReportTemplate', 'create', array(
  97       'id' => $entityId,
  98       'is_active' => 1,
  99     ));
 100     $this->assertAPISuccess($result);
 101     $this->assertEquals(1, $result['count']);
 102     $this->assertDBQuery(1, 'SELECT count(*) FROM civicrm_option_value
 103       WHERE name = "CRM_Report_Form_Examplez"
 104       AND option_group_id IN (SELECT id from civicrm_option_group WHERE name = "report_template") ');
 105     $this->assertDBQuery(1, 'SELECT is_active FROM civicrm_option_value
 106       WHERE name = "CRM_Report_Form_Examplez"');
 107
 108     $result = $this->callAPISuccess('ReportTemplate', 'delete', array(
 109       'id' => $entityId,
 110     ));
 111     $this->assertAPISuccess($result);
 112     $this->assertEquals(1, $result['count']);
 113     $this->assertDBQuery(0, 'SELECT count(*) FROM civicrm_option_value
 114       WHERE name = "CRM_Report_Form_Examplez"
 115       ');
 116   }
 117
 118   /**
 119    * Test getrows on contact summary report.
 120    */
 121   public function testReportTemplateGetRowsContactSummary() {
 122     $description = "Retrieve rows from a report template (optionally providing the instance_id).";
 123     $result = $this->callAPIAndDocument('report_template', 'getrows', array(
 124       'report_id' => 'contact/summary',
 125       'options' => array('metadata' => array('labels', 'title')),
 126     ), __FUNCTION__, __FILE__, $description, 'Getrows');
 127     $this->assertEquals('Contact Name', $result['metadata']['labels']['civicrm_contact_sort_name']);
 128
 129     //the second part of this test has been commented out because it relied on the db being reset to
 130     // it's base state
 131     //wasn't able to get that to work consistently
 132     // however, when the db is in the base state the tests do pass
 133     // and because the test covers 'all' contacts we can't create our own & assume the others don't exist
 134     /*
 135     $this->assertEquals(2, $result['count']);
 136     $this->assertEquals('Default Organization', $result[0]['civicrm_contact_sort_name']);
 137     $this->assertEquals('Second Domain', $result[1]['civicrm_contact_sort_name']);
 138     $this->assertEquals('15 Main St', $result[1]['civicrm_address_street_address']);
 139      */
 140   }
 141
 142   /**
 143    * Tet api to get rows from reports.
 144    *
 145    * @dataProvider getReportTemplates
 146    *
 147    * @param $reportID
 148    *
 149    * @throws \PHPUnit_Framework_IncompleteTestError
 150    */
 151   public function testReportTemplateGetRowsAllReports($reportID) {
 152     if (stristr($reportID, 'has existing issues')) {
 153       $this->markTestIncomplete($reportID);
 154     }
 155     $this->callAPISuccess('report_template', 'getrows', array(
 156       'report_id' => $reportID,
 157     ));
 158   }
 159
 160   /**
 161    * Test get statistics.
 162    *
 163    * @dataProvider getReportTemplates
 164    *
 165    * @param $reportID
 166    *
 167    * @throws \PHPUnit_Framework_IncompleteTestError
 168    */
 169   public function testReportTemplateGetStatisticsAllReports($reportID) {
 170     if (stristr($reportID, 'has existing issues')) {
 171       $this->markTestIncomplete($reportID);
 172     }
 173     if (in_array($reportID, array('contribute/softcredit', 'contribute/bookkeeping'))) {
 174       $this->markTestIncomplete($reportID . " has non enotices when calling statistics fn");
 175     }
 176     $description = "Get Statistics from a report (note there isn't much data to get in the test DB).";
 177     $result = $this->callAPIAndDocument('report_template', 'getstatistics', array(
 178       'report_id' => $reportID,
 179     ), __FUNCTION__, __FILE__, $description, 'Getstatistics', 'getstatistics');
 180   }
 181
 182   /**
 183    * Data provider function for getting all templates.
 184    *
 185    * Note that the function needs to
 186    * be static so cannot use $this->callAPISuccess
 187    */
 188   public static function getReportTemplates() {
 189     $reportsToSkip = array(
 190       'activity' => 'does not respect function signature on from clause',
 191       'contribute/topDonor' => 'construction of query in postProcess makes inaccessible ',
 192       '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',
 193       'logging/contact/summary' => '(likely to be test related) probably logging off Undefined index: Form/Contact/LoggingSummary.php(231): PHP',
 194       'logging/contribute/summary' => '(likely to be test related) probably logging off DB Error: no such table',
 195       'contribute/history' => 'Declaration of CRM_Report_Form_Contribute_History::buildRows() should be compatible with CRM_Report_Form::buildRows($sql, &$rows)',
 196       'activitySummary' => 'We use temp tables for the main query generation and name are dynamic. These names are not available in stats() when called directly.',
 197     );
 198
 199     $reports = civicrm_api3('report_template', 'get', array('return' => 'value', 'options' => array('limit' => 500)));
 200     foreach ($reports['values'] as $report) {
 201       if (empty($reportsToSkip[$report['value']])) {
 202         $reportTemplates[] = array($report['value']);
 203       }
 204       else {
 205         $reportTemplates[] = array($report['value'] . " has existing issues :  " . $reportsToSkip[$report['value']]);
 206       }
 207     }
 208
 209     return $reportTemplates;
 210   }
 211
 212   /**
 213    * Get contribution templates that work with basic filter tests.
 214    *
 215    * These templates require minimal data config.
 216    */
 217   public static function getContributionReportTemplates() {
 218     return array(array('contribute/summary'), array('contribute/detail'), array('contribute/repeat'), array('topDonor' => 'contribute/topDonor'));
 219   }
 220
 221   /**
 222    * Get contribution templates that work with basic filter tests.
 223    *
 224    * These templates require minimal data config.
 225    */
 226   public static function getMembershipReportTemplates() {
 227     return array(array('member/detail'));
 228   }
 229
 230   public static function getMembershipAndContributionReportTemplatesForGroupTests() {
 231     $templates = array_merge(self::getContributionReportTemplates(), self::getMembershipReportTemplates());
 232     foreach ($templates as $key => $value) {
 233       if (array_key_exists('topDonor', $value)) {
 234         // Report is not standard enough to test here.
 235         unset($templates[$key]);
 236       }
 237
 238     }
 239     return $templates;
 240   }
 241
 242   /**
 243    * Test Lybunt report to check basic inclusion of a contact who gave in the year before the chosen year.
 244    */
 245   public function testLybuntReportWithData() {
 246     $inInd = $this->individualCreate();
 247     $outInd = $this->individualCreate();
 248     $this->contributionCreate(array('contact_id' => $inInd, 'receive_date' => '2014-03-01'));
 249     $this->contributionCreate(array('contact_id' => $outInd, 'receive_date' => '2015-03-01', 'trxn_id' => NULL, 'invoice_id' => NULL));
 250     $rows = $this->callAPISuccess('report_template', 'getrows', array(
 251       'report_id' => 'contribute/lybunt',
 252       'yid_value' => 2015,
 253       'yid_op' => 'calendar',
 254       'options' => array('metadata' => array('sql')),
 255     ));
 256     $this->assertEquals(1, $rows['count'], "Report failed - the sql used to generate the results was " . print_r($rows['metadata']['sql'], TRUE));
 257   }
 258
 259   /**
 260    * Test Lybunt report applies ACLs.
 261    */
 262   public function testLybuntReportWithDataAndACLFilter() {
 263     CRM_Core_Config::singleton()->userPermissionClass->permissions = array('administer CiviCRM');
 264     $inInd = $this->individualCreate();
 265     $outInd = $this->individualCreate();
 266     $this->contributionCreate(array('contact_id' => $inInd, 'receive_date' => '2014-03-01'));
 267     $this->contributionCreate(array('contact_id' => $outInd, 'receive_date' => '2015-03-01', 'trxn_id' => NULL, 'invoice_id' => NULL));
 268     $this->hookClass->setHook('civicrm_aclWhereClause', array($this, 'aclWhereHookNoResults'));
 269     $params = array(
 270       'report_id' => 'contribute/lybunt',
 271       'yid_value' => 2015,
 272       'yid_op' => 'calendar',
 273       'options' => array('metadata' => array('sql')),
 274       'check_permissions' => 1,
 275     );
 276
 277     $rows = $this->callAPISuccess('report_template', 'getrows', $params);
 278     $this->assertEquals(0, $rows['count'], "Report failed - the sql used to generate the results was " . print_r($rows['metadata']['sql'], TRUE));
 279
 280     CRM_Utils_Hook::singleton()->reset();
 281   }
 282
 283   /**
 284    * Test Lybunt report to check basic inclusion of a contact who gave in the year before the chosen year.
 285    */
 286   public function testLybuntReportWithFYData() {
 287     $inInd = $this->individualCreate();
 288     $outInd = $this->individualCreate();
 289     $this->contributionCreate(array('contact_id' => $inInd, 'receive_date' => '2014-10-01'));
 290     $this->contributionCreate(array('contact_id' => $outInd, 'receive_date' => '2015-03-01', 'trxn_id' => NULL, 'invoice_id' => NULL));
 291     $this->callAPISuccess('Setting', 'create', array('fiscalYearStart' => array('M' => 7, 'd' => 1)));
 292     $rows = $this->callAPISuccess('report_template', 'getrows', array(
 293       'report_id' => 'contribute/lybunt',
 294       'yid_value' => 2015,
 295       'yid_op' => 'fiscal',
 296       'options' => array('metadata' => array('sql')),
 297       'order_bys' => array(
 298         array(
 299           'column' => 'first_name',
 300           'order' => 'ASC',
 301         ),
 302       ),
 303     ));
 304
 305     $this->assertEquals(2, $rows['count'], "Report failed - the sql used to generate the results was " . print_r($rows['metadata']['sql'], TRUE));
 306   }
 307
 308   /**
 309    * Test Lybunt report to check basic inclusion of a contact who gave in the year before the chosen year.
 310    */
 311   public function testLybuntReportWithFYDataOrderByLastYearAmount() {
 312     $inInd = $this->individualCreate();
 313     $outInd = $this->individualCreate();
 314     $this->contributionCreate(array('contact_id' => $inInd, 'receive_date' => '2014-10-01'));
 315     $this->contributionCreate(array('contact_id' => $outInd, 'receive_date' => '2015-03-01', 'trxn_id' => NULL, 'invoice_id' => NULL));
 316     $this->callAPISuccess('Setting', 'create', array('fiscalYearStart' => array('M' => 7, 'd' => 1)));
 317     $rows = $this->callAPISuccess('report_template', 'getrows', array(
 318       'report_id' => 'contribute/lybunt',
 319       'yid_value' => 2015,
 320       'yid_op' => 'fiscal',
 321       'options' => array('metadata' => array('sql')),
 322       'fields' => array('first_name'),
 323       'order_bys' => array(
 324         array(
 325           'column' => 'last_year_total_amount',
 326           'order' => 'ASC',
 327         ),
 328       ),
 329     ));
 330
 331     $this->assertEquals(2, $rows['count'], "Report failed - the sql used to generate the results was " . print_r($rows['metadata']['sql'], TRUE));
 332   }
 333
 334   /**
 335    * Test the group filter works on the contribution summary (with a smart group).
 336    *
 337    * @dataProvider getMembershipAndContributionReportTemplatesForGroupTests
 338    *
 339    * @param string $template
 340    *   Name of the template to test.
 341    */
 342   public function testContributionSummaryWithSmartGroupFilter($template) {
 343     $groupID = $this->setUpPopulatedSmartGroup();
 344     $rows = $this->callAPISuccess('report_template', 'getrows', array(
 345       'report_id' => $template,
 346       'gid_value' => $groupID,
 347       'gid_op' => 'in',
 348       'options' => array('metadata' => array('sql')),
 349     ));
 350     $this->assertNumberOfContactsInResult(3, $rows, $template);
 351     if ($template === 'contribute/summary') {
 352       $this->assertEquals(3, $rows['values'][0]['civicrm_contribution_total_amount_count']);
 353     }
 354   }
 355
 356   /**
 357    * Test the group filter works on the contribution summary.
 358    *
 359    * @dataProvider getMembershipAndContributionReportTemplatesForGroupTests
 360    */
 361   public function testContributionSummaryWithNotINSmartGroupFilter($template) {
 362     $groupID = $this->setUpPopulatedSmartGroup();
 363     $rows = $this->callAPISuccess('report_template', 'getrows', array(
 364       'report_id' => 'contribute/summary',
 365       'gid_value' => $groupID,
 366       'gid_op' => 'notin',
 367       'options' => array('metadata' => array('sql')),
 368     ));
 369     $this->assertEquals(2, $rows['values'][0]['civicrm_contribution_total_amount_count']);
 370
 371   }
 372
 373   /**
 374    * Test the group filter works on the various reports.
 375    *
 376    * @dataProvider getMembershipAndContributionReportTemplatesForGroupTests
 377    *
 378    * @param string $template
 379    *   Report template unique identifier.
 380    */
 381   public function testReportsWithNonSmartGroupFilter($template) {
 382     $groupID = $this->setUpPopulatedGroup();
 383     $rows = $this->callAPISuccess('report_template', 'getrows', array(
 384       'report_id' => $template,
 385       'gid_value' => array($groupID),
 386       'gid_op' => 'in',
 387       'options' => array('metadata' => array('sql')),
 388     ));
 389     $this->assertNumberOfContactsInResult(1, $rows, $template);
 390   }
 391
 392   /**
 393    * Assert the included results match the expected.
 394    *
 395    * There may or may not be a group by in play so the assertion varies a little.
 396    *
 397    * @param int $numberExpected
 398    * @param array $rows
 399    *   Rows returned from the report.
 400    * @param string $template
 401    */
 402   protected function assertNumberOfContactsInResult($numberExpected, $rows, $template) {
 403     if (isset($rows['values'][0]['civicrm_contribution_total_amount_count'])) {
 404       $this->assertEquals($numberExpected, $rows['values'][0]['civicrm_contribution_total_amount_count'], 'wrong row count in ' . $template);
 405     }
 406     else {
 407       $this->assertEquals($numberExpected, count($rows['values']), 'wrong row count in ' . $template);
 408     }
 409   }
 410
 411   /**
 412    * Test the group filter works on the contribution summary when 2 groups are involved.
 413    */
 414   public function testContributionSummaryWithTwoGroups() {
 415     $groupID = $this->setUpPopulatedGroup();
 416     $groupID2 = $this->setUpPopulatedSmartGroup();
 417     $rows = $this->callAPISuccess('report_template', 'getrows', array(
 418       'report_id' => 'contribute/summary',
 419       'gid_value' => array($groupID, $groupID2),
 420       'gid_op' => 'in',
 421       'options' => array('metadata' => array('sql')),
 422     ));
 423     $this->assertEquals(4, $rows['values'][0]['civicrm_contribution_total_amount_count']);
 424   }
 425
 426   /**
 427    * CRM-20640: Test the group filter works on the contribution summary when a single contact in 2 groups.
 428    */
 429   public function testContributionSummaryWithSingleContactsInTwoGroups() {
 430     list($groupID1, $individualID) = $this->setUpPopulatedGroup(TRUE);
 431     // create second group and add the individual to it.
 432     $groupID2 = $this->groupCreate(array('name' => uniqid(), 'title' => uniqid()));
 433     $this->callAPISuccess('GroupContact', 'create', array(
 434       'group_id' => $groupID2,
 435       'contact_id' => $individualID,
 436       'status' => 'Added',
 437     ));
 438
 439     $rows = $this->callAPISuccess('report_template', 'getrows', array(
 440       'report_id' => 'contribute/summary',
 441       'gid_value' => array($groupID1, $groupID2),
 442       'gid_op' => 'in',
 443       'options' => array('metadata' => array('sql')),
 444     ));
 445     $this->assertEquals(1, $rows['count']);
 446   }
 447
 448   /**
 449    * Test the group filter works on the contribution summary when 2 groups are involved.
 450    */
 451   public function testContributionSummaryWithTwoGroupsWithIntersection() {
 452     $groups = $this->setUpIntersectingGroups();
 453
 454     $rows = $this->callAPISuccess('report_template', 'getrows', array(
 455       'report_id' => 'contribute/summary',
 456       'gid_value' => $groups,
 457       'gid_op' => 'in',
 458       'options' => array('metadata' => array('sql')),
 459     ));
 460     $this->assertEquals(7, $rows['values'][0]['civicrm_contribution_total_amount_count']);
 461   }
 462
 463   /**
 464    * Set up a smart group for testing.
 465    *
 466    * The smart group includes all Households by filter. In addition an individual
 467    * is created and hard-added and an individual is created that is not added.
 468    *
 469    * One household is hard-added as well as being in the filter.
 470    *
 471    * This gives us a range of scenarios for testing contacts are included only once
 472    * whenever they are hard-added or in the criteria.
 473    *
 474    * @return int
 475    */
 476   public function setUpPopulatedSmartGroup() {
 477     $household1ID = $this->householdCreate();
 478     $individual1ID = $this->individualCreate();
 479     $householdID = $this->householdCreate();
 480     $individualID = $this->individualCreate();
 481     $individualIDRemoved = $this->individualCreate();
 482     $groupID = $this->smartGroupCreate(array(), array('name' => uniqid(), 'title' => uniqid()));
 483     $this->callAPISuccess('GroupContact', 'create', array(
 484       'group_id' => $groupID,
 485       'contact_id' => $individualIDRemoved,
 486       'status' => 'Removed',
 487     ));
 488     $this->callAPISuccess('GroupContact', 'create', array(
 489       'group_id' => $groupID,
 490       'contact_id' => $individualID,
 491       'status' => 'Added',
 492     ));
 493     $this->callAPISuccess('GroupContact', 'create', array(
 494       'group_id' => $groupID,
 495       'contact_id' => $householdID,
 496       'status' => 'Added',
 497     ));
 498     foreach (array($household1ID, $individual1ID, $householdID, $individualID, $individualIDRemoved) as $contactID) {
 499       $this->contributionCreate(array('contact_id' => $contactID, 'invoice_id' => '', 'trxn_id' => ''));
 500       $this->contactMembershipCreate(array('contact_id' => $contactID));
 501     }
 502
 503     // Refresh the cache for test purposes. It would be better to alter to alter the GroupContact add function to add contacts to the cache.
 504     CRM_Contact_BAO_GroupContactCache::clearGroupContactCache($groupID);
 505     return $groupID;
 506   }
 507
 508   /**
 509    * Set up a static group for testing.
 510    *
 511    * An individual is created and hard-added and an individual is created that is not added.
 512    *
 513    * This gives us a range of scenarios for testing contacts are included only once
 514    * whenever they are hard-added or in the criteria.
 515    *
 516    * @param bool $returnAddedContact
 517    *
 518    * @return int
 519    */
 520   public function setUpPopulatedGroup($returnAddedContact = FALSE) {
 521     $individual1ID = $this->individualCreate();
 522     $individualID = $this->individualCreate();
 523     $individualIDRemoved = $this->individualCreate();
 524     $groupID = $this->groupCreate(array('name' => uniqid(), 'title' => uniqid()));
 525     $this->callAPISuccess('GroupContact', 'create', array(
 526       'group_id' => $groupID,
 527       'contact_id' => $individualIDRemoved,
 528       'status' => 'Removed',
 529     ));
 530     $this->callAPISuccess('GroupContact', 'create', array(
 531       'group_id' => $groupID,
 532       'contact_id' => $individualID,
 533       'status' => 'Added',
 534     ));
 535
 536     foreach (array($individual1ID, $individualID, $individualIDRemoved) as $contactID) {
 537       $this->contributionCreate(array('contact_id' => $contactID, 'invoice_id' => '', 'trxn_id' => ''));
 538       $this->contactMembershipCreate(array('contact_id' => $contactID));
 539     }
 540
 541     // Refresh the cache for test purposes. It would be better to alter to alter the GroupContact add function to add contacts to the cache.
 542     CRM_Contact_BAO_GroupContactCache::clearGroupContactCache($groupID);
 543
 544     if ($returnAddedContact) {
 545       return array($groupID, $individualID);
 546     }
 547
 548     return $groupID;
 549   }
 550
 551   /**
 552    * @return array
 553    */
 554   public function setUpIntersectingGroups() {
 555     $groupID = $this->setUpPopulatedGroup();
 556     $groupID2 = $this->setUpPopulatedSmartGroup();
 557     $addedToBothIndividualID = $this->individualCreate();
 558     $removedFromBothIndividualID = $this->individualCreate();
 559     $addedToSmartGroupRemovedFromOtherIndividualID = $this->individualCreate();
 560     $removedFromSmartGroupAddedToOtherIndividualID = $this->individualCreate();
 561     $this->callAPISuccess('GroupContact', 'create', array(
 562       'group_id' => $groupID,
 563       'contact_id' => $addedToBothIndividualID,
 564       'status' => 'Added',
 565     ));
 566     $this->callAPISuccess('GroupContact', 'create', array(
 567       'group_id' => $groupID2,
 568       'contact_id' => $addedToBothIndividualID,
 569       'status' => 'Added',
 570     ));
 571     $this->callAPISuccess('GroupContact', 'create', array(
 572       'group_id' => $groupID,
 573       'contact_id' => $removedFromBothIndividualID,
 574       'status' => 'Removed',
 575     ));
 576     $this->callAPISuccess('GroupContact', 'create', array(
 577       'group_id' => $groupID2,
 578       'contact_id' => $removedFromBothIndividualID,
 579       'status' => 'Removed',
 580     ));
 581     $this->callAPISuccess('GroupContact', 'create', array(
 582       'group_id' => $groupID2,
 583       'contact_id' => $addedToSmartGroupRemovedFromOtherIndividualID,
 584       'status' => 'Added',
 585     ));
 586     $this->callAPISuccess('GroupContact', 'create', array(
 587       'group_id' => $groupID,
 588       'contact_id' => $addedToSmartGroupRemovedFromOtherIndividualID,
 589       'status' => 'Removed',
 590     ));
 591     $this->callAPISuccess('GroupContact', 'create', array(
 592       'group_id' => $groupID,
 593       'contact_id' => $removedFromSmartGroupAddedToOtherIndividualID,
 594       'status' => 'Added',
 595     ));
 596     $this->callAPISuccess('GroupContact', 'create', array(
 597       'group_id' => $groupID2,
 598       'contact_id' => $removedFromSmartGroupAddedToOtherIndividualID,
 599       'status' => 'Removed',
 600     ));
 601
 602     foreach (array(
 603                $addedToBothIndividualID,
 604                $removedFromBothIndividualID,
 605                $addedToSmartGroupRemovedFromOtherIndividualID,
 606                $removedFromSmartGroupAddedToOtherIndividualID,
 607              ) as $contactID) {
 608       $this->contributionCreate(array(
 609         'contact_id' => $contactID,
 610         'invoice_id' => '',
 611         'trxn_id' => '',
 612       ));
 613     }
 614     return array($groupID, $groupID2);
 615   }
 616
 617   /**
 618    * Test Deferred Revenue Report.
 619    */
 620   public function testDeferredRevenueReport() {
 621     $indv1 = $this->individualCreate();
 622     $indv2 = $this->individualCreate();
 623     $params = array(
 624       'contribution_invoice_settings' => array(
 625         'deferred_revenue_enabled' => '1',
 626       ),
 627     );
 628     $this->callAPISuccess('Setting', 'create', $params);
 629     $this->contributionCreate(
 630       array(
 631         'contact_id' => $indv1,
 632         'receive_date' => '2016-10-01',
 633         'revenue_recognition_date' => date('Y-m-t', strtotime(date('ymd') . '+3 month')),
 634         'financial_type_id' => 2,
 635       )
 636     );
 637     $this->contributionCreate(
 638       array(
 639         'contact_id' => $indv1,
 640         'revenue_recognition_date' => date('Y-m-t', strtotime(date('ymd') . '+22 month')),
 641         'financial_type_id' => 4,
 642         'trxn_id' => NULL,
 643         'invoice_id' => NULL,
 644       )
 645     );
 646     $this->contributionCreate(
 647       array(
 648         'contact_id' => $indv2,
 649         'revenue_recognition_date' => date('Y-m-t', strtotime(date('ymd') . '+1 month')),
 650         'financial_type_id' => 4,
 651         'trxn_id' => NULL,
 652         'invoice_id' => NULL,
 653       )
 654     );
 655     $this->contributionCreate(
 656       array(
 657         'contact_id' => $indv2,
 658         'receive_date' => '2016-03-01',
 659         'revenue_recognition_date' => date('Y-m-t', strtotime(date('ymd') . '+4 month')),
 660         'financial_type_id' => 2,
 661         'trxn_id' => NULL,
 662         'invoice_id' => NULL,
 663       )
 664     );
 665     $rows = $this->callAPISuccess('report_template', 'getrows', array(
 666       'report_id' => 'contribute/deferredrevenue',
 667     ));
 668     $this->assertEquals(2, $rows['count'], "Report failed to get row count");
 669     $count = array(2, 1);
 670     foreach ($rows['values'] as $row) {
 671       $this->assertEquals(array_pop($count), count($row['rows']), "Report failed to get row count");
 672     }
 673   }
 674
 675 }