tests/phpunit/api/v3/ReportTemplateTest.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.6                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2014                                |
   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 require_once 'CiviTest/CiviUnitTestCase.php';
  29
  30
  31 /**
  32  *  Test APIv3 civicrm_report_instance_* functions
  33  *
  34  * @package CiviCRM_APIv3
  35  * @subpackage API_Report
  36  */
  37
  38 class api_v3_ReportTemplateTest extends CiviUnitTestCase {
  39   protected $_apiversion = 3;
  40
  41   public function setUp() {
  42     parent::setUp();
  43     $this->useTransaction(TRUE);
  44   }
  45
  46   public function testReportTemplate() {
  47     $result = $this->callAPISuccess('ReportTemplate', 'create', array(
  48       'label' => 'Example Form',
  49       'description' => 'Longish description of the example form',
  50       'class_name' => 'CRM_Report_Form_Examplez',
  51       'report_url' => 'example/path',
  52       'component' => 'CiviCase',
  53     ));
  54     $this->assertAPISuccess($result);
  55     $this->assertEquals(1, $result['count'], 'In line ' . __LINE__);
  56     $entityId = $result['id'];
  57     $this->assertTrue(is_numeric($entityId), 'In line ' . __LINE__);
  58     $this->assertEquals(7, $result['values'][$entityId]['component_id'], 'In line ' . __LINE__);
  59     $this->assertDBQuery(1, 'SELECT count(*) FROM civicrm_option_value
  60       WHERE name = "CRM_Report_Form_Examplez"
  61       AND option_group_id IN (SELECT id from civicrm_option_group WHERE name = "report_template") ');
  62     $this->assertDBQuery(1, 'SELECT is_active FROM civicrm_option_value
  63       WHERE name = "CRM_Report_Form_Examplez"');
  64
  65     // change component to null
  66     $result = $this->callAPISuccess('ReportTemplate', 'create', array(
  67     'id' => $entityId,
  68       'component' => '',
  69     ));
  70     $this->assertAPISuccess($result);
  71     $this->assertEquals(1, $result['count'], 'In line ' . __LINE__);
  72     $this->assertDBQuery(1, 'SELECT count(*) FROM civicrm_option_value
  73       WHERE name = "CRM_Report_Form_Examplez"
  74       AND option_group_id IN (SELECT id from civicrm_option_group WHERE name = "report_template") ');
  75     $this->assertDBQuery(1, 'SELECT count(*) FROM civicrm_option_value
  76       WHERE name = "CRM_Report_Form_Examplez"
  77       AND component_id IS NULL');
  78
  79     // deactivate
  80     $result = $this->callAPISuccess('ReportTemplate', 'create', array(
  81     'id' => $entityId,
  82       'is_active' => 0,
  83     ));
  84     $this->assertAPISuccess($result);
  85     $this->assertEquals(1, $result['count'], 'In line ' . __LINE__);
  86     $this->assertDBQuery(1, 'SELECT count(*) FROM civicrm_option_value
  87       WHERE name = "CRM_Report_Form_Examplez"
  88       AND option_group_id IN (SELECT id from civicrm_option_group WHERE name = "report_template") ');
  89     $this->assertDBQuery(0, 'SELECT is_active FROM civicrm_option_value
  90       WHERE name = "CRM_Report_Form_Examplez"');
  91
  92     // activate
  93     $result = $this->callAPISuccess('ReportTemplate', 'create', array(
  94     'id' => $entityId,
  95       'is_active' => 1,
  96     ));
  97     $this->assertAPISuccess($result);
  98     $this->assertEquals(1, $result['count'], 'In line ' . __LINE__);
  99     $this->assertDBQuery(1, 'SELECT count(*) FROM civicrm_option_value
 100       WHERE name = "CRM_Report_Form_Examplez"
 101       AND option_group_id IN (SELECT id from civicrm_option_group WHERE name = "report_template") ');
 102     $this->assertDBQuery(1, 'SELECT is_active FROM civicrm_option_value
 103       WHERE name = "CRM_Report_Form_Examplez"');
 104
 105     $result = $this->callAPISuccess('ReportTemplate', 'delete', array(      'id' => $entityId,
 106     ));
 107     $this->assertAPISuccess($result);
 108     $this->assertEquals(1, $result['count'], 'In line ' . __LINE__);
 109     $this->assertDBQuery(0, 'SELECT count(*) FROM civicrm_option_value
 110       WHERE name = "CRM_Report_Form_Examplez"
 111       ');
 112   }
 113
 114   /**
 115    *
 116    */
 117   public function testReportTemplateGetRowsContactSummary() {
 118     $description = "Retrieve rows from a report template (optionally providing the instance_id)";
 119     $result = $this->callAPIAndDocument('report_template', 'getrows', array(
 120       'report_id' => 'contact/summary',
 121       'options' => array('metadata' => array('labels', 'title'))
 122     ), __FUNCTION__, __FILE__, $description, 'Getrows', 'getrows');
 123     $this->assertEquals('Contact Name', $result['metadata']['labels']['civicrm_contact_sort_name']);
 124
 125     //the second part of this test has been commented out because it relied on the db being reset to
 126     // it's base state
 127     //wasn't able to get that to work consistently
 128     // however, when the db is in the base state the tests do pass
 129     // and because the test covers 'all' contacts we can't create our own & assume the others don't exist
 130     /*
 131     $this->assertEquals(2, $result['count']);
 132     $this->assertEquals('Default Organization', $result[0]['civicrm_contact_sort_name']);
 133     $this->assertEquals('Second Domain', $result[1]['civicrm_contact_sort_name']);
 134     $this->assertEquals('15 Main St', $result[1]['civicrm_address_street_address']);
 135     */
 136   }
 137
 138   /**
 139    * @dataProvider getReportTemplates
 140    */
 141   public function testReportTemplateGetRowsAllReports($reportID) {
 142     if (stristr($reportID, 'has existing issues')) {
 143       $this->markTestIncomplete($reportID);
 144     }
 145     $result = $this->callAPISuccess('report_template', 'getrows', array(
 146        'report_id' => $reportID,
 147     ));
 148   }
 149
 150   /**
 151    * @dataProvider getReportTemplates
 152    */
 153   public function testReportTemplateGetStatisticsAllReports($reportID) {
 154     if (stristr($reportID, 'has existing issues')) {
 155       $this->markTestIncomplete($reportID);
 156     }
 157     if (in_array($reportID, array('contribute/softcredit', 'contribute/bookkeeping'))) {
 158       $this->markTestIncomplete($reportID . " has non enotices when calling statistics fn");
 159     }
 160     $description = "Get Statistics from a report (note there isn't much data to get in the test DB :-(";
 161     $result = $this->callAPIAndDocument('report_template', 'getstatistics', array(
 162       'report_id' => $reportID,
 163     ), __FUNCTION__, __FILE__, $description, 'Getstatistics', 'getstatistics');
 164   }
 165
 166   /**
 167    * Data provider function for getting all templates, note that the function needs to
 168    * be static so cannot use $this->callAPISuccess
 169    */
 170   public static function getReportTemplates() {
 171     $reportsToSkip = array(
 172         'activity' => 'does not respect function signature on from clause',
 173         'walklist' => 'Notice: Undefined index: type in CRM_Report_Form_Walklist_Walklist line 155.
 174                        (suspect the select function should be removed in favour of the parent (state province field)
 175                       also, type should be added to state province & others? & potentially getAddressColumns fn should be
 176                       used per other reports',
 177         'contribute/repeat' => 'Reports with important functionality in postProcess are not callable via the api. For variable setting recommend beginPostProcessCommon, for temp table creation recommend From fn',
 178         'contribute/topDonor' => 'construction of query in postProcess makes inaccessible ',
 179         'contribute/sybunt' => 'e notice - (ui gives fatal error at civicrm/report/contribute/sybunt&reset=1&force=1
 180                                 e-notice is on yid_valueContribute/Sybunt.php(214) because at the force url "yid_relative" not "yid_value" is defined',
 181         'contribute/lybunt' => 'same as sybunt - fatals on force url & test identifies why',
 182         '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',
 183         'contact/relationship' => '(see contribute/repeat), property declaration issue, Undefined property: CRM_Report_Form_Contact_Relationship::$relationType in /Contact/Relationship.php(486):',
 184         'logging/contact/summary' => '(likely to be test related) probably logging off Undefined index: Form/Contact/LoggingSummary.php(231): PHP',
 185         'logging/contact/detail' => '(likely to be test related) probably logging off  DB Error: no such table',
 186         'logging/contribute/summary' => '(likely to be test related) probably logging off DB Error: no such table',
 187         'logging/contribute/detail' => '(likely to be test related) probably logging off DB Error: no such table',
 188         'survey/detail' => '(likely to be test related)  Undefined index: CiviCampaign civicrm CRM/Core/Component.php(196)',
 189         'contribute/history' => 'Declaration of CRM_Report_Form_Contribute_History::buildRows() should be compatible with CRM_Report_Form::buildRows($sql, &$rows)',
 190     );
 191
 192     $reports = civicrm_api3('report_template', 'get', array('return' => 'value', 'options' => array('limit' => 500)));
 193     foreach ($reports['values'] as $report) {
 194       if (empty($reportsToSkip[$report['value']])) {
 195         $reportTemplates[] = array($report['value']);
 196       }
 197       else {
 198         $reportTemplates[] = array($report['value']. " has existing issues :  " . $reportsToSkip[$report['value']]);
 199       }
 200     }
 201
 202     return $reportTemplates;
 203   }
 204 }