| 1 | <?php |
| 2 | /* |
| 3 | +--------------------------------------------------------------------+ |
| 4 | | CiviCRM version 4.6 | |
| 5 | +--------------------------------------------------------------------+ |
| 6 | | Copyright CiviCRM LLC (c) 2004-2015 | |
| 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 | class api_v3_ReportTemplateTest extends CiviUnitTestCase { |
| 38 | protected $_apiversion = 3; |
| 39 | |
| 40 | public function setUp() { |
| 41 | parent::setUp(); |
| 42 | $this->useTransaction(TRUE); |
| 43 | } |
| 44 | |
| 45 | public function testReportTemplate() { |
| 46 | $result = $this->callAPISuccess('ReportTemplate', 'create', array( |
| 47 | 'label' => 'Example Form', |
| 48 | 'description' => 'Longish description of the example form', |
| 49 | 'class_name' => 'CRM_Report_Form_Examplez', |
| 50 | 'report_url' => 'example/path', |
| 51 | 'component' => 'CiviCase', |
| 52 | )); |
| 53 | $this->assertAPISuccess($result); |
| 54 | $this->assertEquals(1, $result['count']); |
| 55 | $entityId = $result['id']; |
| 56 | $this->assertTrue(is_numeric($entityId)); |
| 57 | $this->assertEquals(7, $result['values'][$entityId]['component_id']); |
| 58 | $this->assertDBQuery(1, 'SELECT count(*) FROM civicrm_option_value |
| 59 | WHERE name = "CRM_Report_Form_Examplez" |
| 60 | AND option_group_id IN (SELECT id from civicrm_option_group WHERE name = "report_template") '); |
| 61 | $this->assertDBQuery(1, 'SELECT is_active FROM civicrm_option_value |
| 62 | WHERE name = "CRM_Report_Form_Examplez"'); |
| 63 | |
| 64 | // change component to null |
| 65 | $result = $this->callAPISuccess('ReportTemplate', 'create', array( |
| 66 | 'id' => $entityId, |
| 67 | 'component' => '', |
| 68 | )); |
| 69 | $this->assertAPISuccess($result); |
| 70 | $this->assertEquals(1, $result['count']); |
| 71 | $this->assertDBQuery(1, 'SELECT count(*) FROM civicrm_option_value |
| 72 | WHERE name = "CRM_Report_Form_Examplez" |
| 73 | AND option_group_id IN (SELECT id from civicrm_option_group WHERE name = "report_template") '); |
| 74 | $this->assertDBQuery(1, 'SELECT count(*) FROM civicrm_option_value |
| 75 | WHERE name = "CRM_Report_Form_Examplez" |
| 76 | AND component_id IS NULL'); |
| 77 | |
| 78 | // deactivate |
| 79 | $result = $this->callAPISuccess('ReportTemplate', 'create', array( |
| 80 | 'id' => $entityId, |
| 81 | 'is_active' => 0, |
| 82 | )); |
| 83 | $this->assertAPISuccess($result); |
| 84 | $this->assertEquals(1, $result['count']); |
| 85 | $this->assertDBQuery(1, 'SELECT count(*) FROM civicrm_option_value |
| 86 | WHERE name = "CRM_Report_Form_Examplez" |
| 87 | AND option_group_id IN (SELECT id from civicrm_option_group WHERE name = "report_template") '); |
| 88 | $this->assertDBQuery(0, 'SELECT is_active FROM civicrm_option_value |
| 89 | WHERE name = "CRM_Report_Form_Examplez"'); |
| 90 | |
| 91 | // activate |
| 92 | $result = $this->callAPISuccess('ReportTemplate', 'create', array( |
| 93 | 'id' => $entityId, |
| 94 | 'is_active' => 1, |
| 95 | )); |
| 96 | $this->assertAPISuccess($result); |
| 97 | $this->assertEquals(1, $result['count']); |
| 98 | $this->assertDBQuery(1, 'SELECT count(*) FROM civicrm_option_value |
| 99 | WHERE name = "CRM_Report_Form_Examplez" |
| 100 | AND option_group_id IN (SELECT id from civicrm_option_group WHERE name = "report_template") '); |
| 101 | $this->assertDBQuery(1, 'SELECT is_active FROM civicrm_option_value |
| 102 | WHERE name = "CRM_Report_Form_Examplez"'); |
| 103 | |
| 104 | $result = $this->callAPISuccess('ReportTemplate', 'delete', array( |
| 105 | 'id' => $entityId, |
| 106 | )); |
| 107 | $this->assertAPISuccess($result); |
| 108 | $this->assertEquals(1, $result['count']); |
| 109 | $this->assertDBQuery(0, 'SELECT count(*) FROM civicrm_option_value |
| 110 | WHERE name = "CRM_Report_Form_Examplez" |
| 111 | '); |
| 112 | } |
| 113 | |
| 114 | /** |
| 115 | * Test getrows on contact summary report. |
| 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 | * Tet api to get rows from reports. |
| 140 | * |
| 141 | * @dataProvider getReportTemplates |
| 142 | * |
| 143 | * @param $reportID |
| 144 | * |
| 145 | * @throws \PHPUnit_Framework_IncompleteTestError |
| 146 | */ |
| 147 | public function testReportTemplateGetRowsAllReports($reportID) { |
| 148 | if (stristr($reportID, 'has existing issues')) { |
| 149 | $this->markTestIncomplete($reportID); |
| 150 | } |
| 151 | $this->callAPISuccess('report_template', 'getrows', array( |
| 152 | 'report_id' => $reportID, |
| 153 | )); |
| 154 | } |
| 155 | |
| 156 | /** |
| 157 | * Test get statistics. |
| 158 | * |
| 159 | * @dataProvider getReportTemplates |
| 160 | * |
| 161 | * @param $reportID |
| 162 | * |
| 163 | * @throws \PHPUnit_Framework_IncompleteTestError |
| 164 | */ |
| 165 | public function testReportTemplateGetStatisticsAllReports($reportID) { |
| 166 | if (stristr($reportID, 'has existing issues')) { |
| 167 | $this->markTestIncomplete($reportID); |
| 168 | } |
| 169 | if (in_array($reportID, array('contribute/softcredit', 'contribute/bookkeeping'))) { |
| 170 | $this->markTestIncomplete($reportID . " has non enotices when calling statistics fn"); |
| 171 | } |
| 172 | $description = "Get Statistics from a report (note there isn't much data to get in the test DB)."; |
| 173 | $result = $this->callAPIAndDocument('report_template', 'getstatistics', array( |
| 174 | 'report_id' => $reportID, |
| 175 | ), __FUNCTION__, __FILE__, $description, 'Getstatistics', 'getstatistics'); |
| 176 | } |
| 177 | |
| 178 | /** |
| 179 | * Data provider function for getting all templates. |
| 180 | * |
| 181 | * Note that the function needs to |
| 182 | * be static so cannot use $this->callAPISuccess |
| 183 | */ |
| 184 | public static function getReportTemplates() { |
| 185 | $reportsToSkip = array( |
| 186 | 'activity' => 'does not respect function signature on from clause', |
| 187 | 'walklist' => 'Notice: Undefined index: type in CRM_Report_Form_Walklist_Walklist line 155.(suspect the select function should be removed in favour of the parent (state province field) also, type should be added to state province & others? & potentially getAddressColumns fn should be used per other reports', |
| 188 | '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', |
| 189 | 'contribute/topDonor' => 'construction of query in postProcess makes inaccessible ', |
| 190 | 'contribute/sybunt' => 'e notice - (ui gives fatal error at civicrm/report/contribute/sybunt&reset=1&force=1 e-notice is on yid_valueContribute/Sybunt.php(214) because at the force url "yid_relative" not "yid_value" is defined', |
| 191 | 'contribute/lybunt' => 'same as sybunt - fatals on force url & test identifies why', |
| 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 | 'contact/relationship' => '(see contribute/repeat), property declaration issue, Undefined property: CRM_Report_Form_Contact_Relationship::$relationType in /Contact/Relationship.php(486):', |
| 194 | 'logging/contact/summary' => '(likely to be test related) probably logging off Undefined index: Form/Contact/LoggingSummary.php(231): PHP', |
| 195 | 'logging/contact/detail' => '(likely to be test related) probably logging off DB Error: no such table', |
| 196 | 'logging/contribute/summary' => '(likely to be test related) probably logging off DB Error: no such table', |
| 197 | 'logging/contribute/detail' => '(likely to be test related) probably logging off DB Error: no such table', |
| 198 | 'survey/detail' => '(likely to be test related) Undefined index: CiviCampaign civicrm CRM/Core/Component.php(196)', |
| 199 | 'contribute/history' => 'Declaration of CRM_Report_Form_Contribute_History::buildRows() should be compatible with CRM_Report_Form::buildRows($sql, &$rows)', |
| 200 | ); |
| 201 | |
| 202 | $reports = civicrm_api3('report_template', 'get', array('return' => 'value', 'options' => array('limit' => 500))); |
| 203 | foreach ($reports['values'] as $report) { |
| 204 | if (empty($reportsToSkip[$report['value']])) { |
| 205 | $reportTemplates[] = array($report['value']); |
| 206 | } |
| 207 | else { |
| 208 | $reportTemplates[] = array($report['value'] . " has existing issues : " . $reportsToSkip[$report['value']]); |
| 209 | } |
| 210 | } |
| 211 | |
| 212 | return $reportTemplates; |
| 213 | } |
| 214 | |
| 215 | } |