Merge pull request #7797 from JKingsnorth/CRM-17977
[civicrm-core.git] / tests / phpunit / api / v3 / UtilsTest.php
CommitLineData
6a488035 1<?php
6a488035
TO
2/*
3 +--------------------------------------------------------------------+
81621fee 4 | CiviCRM version 4.7 |
6a488035 5 +--------------------------------------------------------------------+
fa938177 6 | Copyright CiviCRM LLC (c) 2004-2016 |
6a488035
TO
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 +--------------------------------------------------------------------+
d25dd0ee 26 */
6a488035 27
6a488035
TO
28require_once 'CRM/Utils/DeprecatedUtils.php';
29
30/**
31 * Test class for API utils
32 *
33 * @package CiviCRM
acb109b7 34 * @group headless
6a488035
TO
35 */
36class api_v3_UtilsTest extends CiviUnitTestCase {
ca985406 37 protected $_apiversion = 3;
6a488035 38 public $DBResetRequired = FALSE;
b7c9bc4c 39
6a488035
TO
40 public $_contactID = 1;
41
42 /**
43 * Sets up the fixture, for example, opens a network connection.
fe482240 44 *
6a488035 45 * This method is called before a test is executed.
6a488035
TO
46 */
47 protected function setUp() {
48 parent::setUp();
d1e734a5 49 $this->useTransaction(TRUE);
6a488035
TO
50 }
51
00be9182 52 public function testAddFormattedParam() {
6a488035
TO
53 $values = array('contact_type' => 'Individual');
54 $params = array('something' => 1);
55 $result = _civicrm_api3_deprecated_add_formatted_param($values, $params);
56 $this->assertTrue($result);
57 }
58
00be9182 59 public function testCheckPermissionReturn() {
6a488035
TO
60 $check = array('check_permissions' => TRUE);
61 $config = CRM_Core_Config::singleton();
62 $config->userPermissionClass->permissions = array();
d0c9daa4 63 $this->assertFalse($this->runPermissionCheck('contact', 'create', $check), 'empty permissions should not be enough');
6a488035 64 $config->userPermissionClass->permissions = array('access CiviCRM');
d0c9daa4 65 $this->assertFalse($this->runPermissionCheck('contact', 'create', $check), 'lacking permissions should not be enough');
6a488035 66 $config->userPermissionClass->permissions = array('add contacts');
d0c9daa4 67 $this->assertFalse($this->runPermissionCheck('contact', 'create', $check), 'lacking permissions should not be enough');
6a488035
TO
68
69 $config->userPermissionClass->permissions = array('access CiviCRM', 'add contacts');
d0c9daa4 70 $this->assertTrue($this->runPermissionCheck('contact', 'create', $check), 'exact permissions should be enough');
6a488035
TO
71
72 $config->userPermissionClass->permissions = array('access CiviCRM', 'add contacts', 'import contacts');
d0c9daa4 73 $this->assertTrue($this->runPermissionCheck('contact', 'create', $check), 'overfluous permissions should be enough');
6a488035
TO
74 }
75
00be9182 76 public function testCheckPermissionThrow() {
6a488035
TO
77 $check = array('check_permissions' => TRUE);
78 $config = CRM_Core_Config::singleton();
79 try {
80 $config->userPermissionClass->permissions = array('access CiviCRM');
d0c9daa4 81 $this->runPermissionCheck('contact', 'create', $check, TRUE);
6a488035 82 }
92915c55 83 catch (Exception $e) {
6a488035
TO
84 $message = $e->getMessage();
85 }
1644b908 86 $this->assertEquals($message, 'API permission check failed for Contact/create call; insufficient permission: require access CiviCRM and add contacts', 'lacking permissions should throw an exception');
6a488035
TO
87
88 $config->userPermissionClass->permissions = array('access CiviCRM', 'add contacts', 'import contacts');
d0c9daa4 89 $this->assertTrue($this->runPermissionCheck('contact', 'create', $check), 'overfluous permissions should return true');
6a488035
TO
90 }
91
00be9182 92 public function testCheckPermissionSkip() {
6a488035
TO
93 $config = CRM_Core_Config::singleton();
94 $config->userPermissionClass->permissions = array('access CiviCRM');
95 $params = array('check_permissions' => TRUE);
d0c9daa4 96 $this->assertFalse($this->runPermissionCheck('contact', 'create', $params), 'lacking permissions should not be enough');
6a488035 97 $params = array('check_permissions' => FALSE);
d0c9daa4
TO
98 $this->assertTrue($this->runPermissionCheck('contact', 'create', $params), 'permission check should be skippable');
99 }
100
101 /**
102 * @param string $entity
103 * @param string $action
104 * @param array $params
e16033b4
TO
105 * @param bool $throws
106 * Whether we should pass any exceptions for authorization failures.
cbdcc634
EM
107 *
108 * @throws API_Exception
109 * @throws Exception
a6c01b45
CW
110 * @return bool
111 * TRUE or FALSE depending on the outcome of the authorization check
d0c9daa4 112 */
00be9182 113 public function runPermissionCheck($entity, $action, $params, $throws = FALSE) {
d0c9daa4
TO
114 $dispatcher = new \Symfony\Component\EventDispatcher\EventDispatcher();
115 $dispatcher->addSubscriber(new \Civi\API\Subscriber\PermissionCheck());
116 $kernel = new \Civi\API\Kernel($dispatcher);
cde12543 117 $apiRequest = \Civi\API\Request::create($entity, $action, $params, NULL);
d0c9daa4
TO
118 try {
119 $kernel->authorize(NULL, $apiRequest);
120 return TRUE;
0db6c3e1
TO
121 }
122 catch (\API_Exception $e) {
d0c9daa4
TO
123 $extra = $e->getExtraParams();
124 if (!$throws && $extra['error_code'] == API_Exception::UNAUTHORIZED) {
125 return FALSE;
0db6c3e1
TO
126 }
127 else {
d0c9daa4
TO
128 throw $e;
129 }
130 }
6a488035
TO
131 }
132
c490a46a
CW
133 /**
134 * Test verify mandatory - includes DAO & passed as well as empty & NULL fields
135 */
00be9182 136 public function testVerifyMandatory() {
6a488035
TO
137 _civicrm_api3_initialize(TRUE);
138 $params = array(
139 'entity_table' => 'civicrm_contact',
140 'note' => '',
141 'contact_id' => $this->_contactID,
142 'modified_date' => '2011-01-31',
143 'subject' => NULL,
21dfd5f5 144 'version' => $this->_apiversion,
6a488035
TO
145 );
146 try {
147 $result = civicrm_api3_verify_mandatory($params, 'CRM_Core_BAO_Note', array('note', 'subject'));
148 }
92915c55 149 catch (Exception $expected) {
6a488035
TO
150 $this->assertEquals('Mandatory key(s) missing from params array: entity_id, note, subject', $expected->getMessage());
151 return;
152 }
153
154 $this->fail('An expected exception has not been raised.');
155 }
156
c490a46a
CW
157 /**
158 * Test verify one mandatory - includes DAO & passed as well as empty & NULL fields
159 */
00be9182 160 public function testVerifyOneMandatory() {
6a488035
TO
161 _civicrm_api3_initialize(TRUE);
162 $params = array(
163 'entity_table' => 'civicrm_contact',
164 'note' => '',
165 'contact_id' => $this->_contactID,
166 'modified_date' => '2011-01-31',
167 'subject' => NULL,
168 'version' => $this->_apiversion,
169 );
170
171 try {
172 $result = civicrm_api3_verify_one_mandatory($params, 'CRM_Core_BAO_Note', array('note', 'subject'));
173 }
92915c55 174 catch (Exception $expected) {
6a488035
TO
175 $this->assertEquals('Mandatory key(s) missing from params array: entity_id, one of (note, subject)', $expected->getMessage());
176 return;
177 }
178
179 $this->fail('An expected exception has not been raised.');
180 }
181
c490a46a
CW
182 /**
183 * Test verify one mandatory - includes DAO & passed as well as empty & NULL fields
184 */
00be9182 185 public function testVerifyOneMandatoryOneSet() {
6a488035 186 _civicrm_api3_initialize(TRUE);
92915c55
TO
187 $params = array(
188 'version' => 3,
189 'entity_table' => 'civicrm_contact',
190 'note' => 'note',
191 'contact_id' => $this->_contactID,
192 'modified_date' => '2011-01-31',
389bcebf 193 'subject' => NULL,
92915c55 194 );
6a488035
TO
195
196 try {
197 civicrm_api3_verify_one_mandatory($params, NULL, array('note', 'subject'));
198 }
92915c55 199 catch (Exception$expected) {
6a488035
TO
200 $this->fail('Exception raised when it shouldn\'t have been in line ' . __LINE__);
201 }
202 }
203
c490a46a 204 /**
eceb18cc 205 * Test GET DAO function returns DAO.
b6708aeb 206 */
00be9182 207 public function testGetDAO() {
49e101d0
CW
208 $params = array(
209 'civicrm_api3_custom_group_get' => 'CRM_Core_DAO_CustomGroup',
210 'custom_group' => 'CRM_Core_DAO_CustomGroup',
211 'CustomGroup' => 'CRM_Core_DAO_CustomGroup',
212 'civicrm_api3_custom_field_get' => 'CRM_Core_DAO_CustomField',
213 'civicrm_api3_survey_get' => 'CRM_Campaign_DAO_Survey',
214 'civicrm_api3_pledge_payment_get' => 'CRM_Pledge_DAO_PledgePayment',
215 'civicrm_api3_website_get' => 'CRM_Core_DAO_Website',
216 'Membership' => 'CRM_Member_DAO_Membership',
217 );
218 foreach ($params as $input => $expected) {
219 $result = _civicrm_api3_get_DAO($input);
220 $this->assertEquals($expected, $result);
221 }
6a488035 222 }
c490a46a
CW
223
224 /**
eceb18cc 225 * Test GET BAO function returns BAO when it exists.
b6708aeb 226 */
00be9182 227 public function testGetBAO() {
49e101d0
CW
228 $params = array(
229 'civicrm_api3_website_get' => 'CRM_Core_BAO_Website',
230 'civicrm_api3_survey_get' => 'CRM_Campaign_BAO_Survey',
231 'civicrm_api3_pledge_payment_get' => 'CRM_Pledge_BAO_PledgePayment',
232 'Household' => 'CRM_Contact_BAO_Contact',
233 // Note this one DOES NOT have a BAO so we expect to fall back on returning the DAO
234 'mailing_group' => 'CRM_Mailing_DAO_MailingGroup',
5c1174d3
CW
235 // Make sure we get null back with nonexistant entities
236 'civicrm_this_does_not_exist' => NULL,
49e101d0
CW
237 );
238 foreach ($params as $input => $expected) {
239 $result = _civicrm_api3_get_BAO($input);
240 $this->assertEquals($expected, $result);
241 }
6a488035
TO
242 }
243
00be9182 244 public function test_civicrm_api3_validate_fields() {
6a488035 245 $params = array('start_date' => '2010-12-20', 'end_date' => '');
7f8c98cd
E
246 $fields = civicrm_api3('relationship', 'getfields', array('action' => 'get'));
247 _civicrm_api3_validate_fields('relationship', 'get', $params, $fields['values']);
6a488035
TO
248 $this->assertEquals('20101220000000', $params['start_date']);
249 $this->assertEquals('', $params['end_date']);
250 }
251
00be9182 252 public function test_civicrm_api3_validate_fields_membership() {
92915c55
TO
253 $params = array(
254 'start_date' => '2010-12-20',
255 'end_date' => '',
256 'membership_end_date' => '0',
257 'join_date' => '2010-12-20',
389bcebf 258 'membership_start_date' => '2010-12-20',
92915c55 259 );
7f8c98cd
E
260 $fields = civicrm_api3('Membership', 'getfields', array('action' => 'get'));
261 _civicrm_api3_validate_fields('Membership', 'get', $params, $fields['values']);
903d0d38 262 $this->assertEquals('2010-12-20', $params['start_date']);
ba4a1892 263 $this->assertEquals('20101220000000', $params['membership_start_date']);
6a488035
TO
264 $this->assertEquals('', $params['end_date']);
265 $this->assertEquals('20101220000000', $params['join_date'], 'join_date not set in line ' . __LINE__);
266 }
267
00be9182 268 public function test_civicrm_api3_validate_fields_event() {
6a488035
TO
269
270 $params = array(
271 'registration_start_date' => 20080601,
6c6e6187 272 'registration_end_date' => '2008-10-15',
92915c55
TO
273 'start_date' => '2010-12-20',
274 'end_date' => '',
6a488035 275 );
7f8c98cd
E
276 $fields = civicrm_api3('Event', 'getfields', array('action' => 'create'));
277 _civicrm_api3_validate_fields('event', 'create', $params, $fields['values']);
ba4a1892
TM
278 $this->assertEquals('20101220000000', $params['start_date']);
279 $this->assertEquals('20081015000000', $params['registration_end_date']);
280 $this->assertEquals('', $params['end_date']);
6a488035
TO
281 $this->assertEquals('20080601000000', $params['registration_start_date']);
282 }
283
00be9182 284 public function test_civicrm_api3_validate_fields_exception() {
6a488035
TO
285 $params = array(
286 'join_date' => 'abc',
287 );
288 try {
7f8c98cd
E
289 $fields = civicrm_api3('Membership', 'getfields', array('action' => 'get'));
290 _civicrm_api3_validate_fields('Membership', 'get', $params, $fields['values']);
6a488035 291 }
92915c55 292 catch (Exception$expected) {
6a488035
TO
293 $this->assertEquals('join_date is not a valid date: abc', $expected->getMessage());
294 }
295 }
296
00be9182 297 public function testGetFields() {
ca985406 298 $result = $this->callAPISuccess('membership', 'getfields', array());
6a488035 299 $this->assertArrayHasKey('values', $result);
ca985406 300 $result = $this->callAPISuccess('relationship', 'getfields', array());
6a488035 301 $this->assertArrayHasKey('values', $result);
ca985406 302 $result = $this->callAPISuccess('event', 'getfields', array());
6a488035
TO
303 $this->assertArrayHasKey('values', $result);
304 }
41d89fcb 305
00be9182 306 public function testGetFields_AllOptions() {
ca985406 307 $result = $this->callAPISuccess('contact', 'getfields', array(
41d89fcb
TO
308 'options' => array(
309 'get_options' => 'all',
310 ),
41d89fcb 311 ));
41d89fcb
TO
312 $this->assertEquals('Household', $result['values']['contact_type']['options']['Household']);
313 $this->assertEquals('HTML', $result['values']['preferred_mail_format']['options']['HTML']);
314 }
96025800 315
5bc7c754
TO
316 public function basicArrayCases() {
317 $records = array(
318 array('snack_id' => 'a', 'fruit' => 'apple', 'cheese' => 'swiss'),
319 array('snack_id' => 'b', 'fruit' => 'grape', 'cheese' => 'cheddar'),
320 array('snack_id' => 'c', 'fruit' => 'apple', 'cheese' => 'cheddar'),
321 array('snack_id' => 'd', 'fruit' => 'apple', 'cheese' => 'gouda'),
322 array('snack_id' => 'e', 'fruit' => 'apple', 'cheese' => 'provolone'),
323 );
324
325 $cases[] = array(
326 $records,
327 array('version' => 3), // params
328 array('a', 'b', 'c', 'd', 'e'), // expected results
329 );
330
331 $cases[] = array(
332 $records,
333 array('version' => 3, 'fruit' => 'apple'), // params
334 array('a', 'c', 'd', 'e'), // expected results
335 );
336
337 $cases[] = array(
338 $records,
339 array('version' => 3, 'cheese' => 'cheddar'),
340 array('b', 'c'),
341 );
342
a066deea
TO
343 $cases[] = array(
344 $records,
345 array('version' => 3, 'id' => 'd'),
346 array('d'),
347 );
348
5bc7c754
TO
349 return $cases;
350 }
351
352 /**
353 * Make a basic API (Widget.get) which allows getting data out of a simple in-memory
354 * list of records.
355 *
356 * @param $records
357 * The list of all records.
358 * @param $params
359 * The filter criteria
360 * @param array $resultIds
361 * The records which are expected to match.
362 * @dataProvider basicArrayCases
363 */
364 public function testBasicArrayGet($records, $params, $resultIds) {
365 $params['version'] = 3;
366
367 $kernel = new \Civi\API\Kernel(new \Symfony\Component\EventDispatcher\EventDispatcher());
368
369 $provider = new \Civi\API\Provider\AdhocProvider($params['version'], 'Widget');
370 $provider->addAction('get', 'access CiviCRM', function ($apiRequest) use ($records) {
371 return _civicrm_api3_basic_array_get('Widget', $apiRequest['params'], $records, 'snack_id', array('snack_id', 'fruit', 'cheese'));
372 });
373 $kernel->registerApiProvider($provider);
374
375 $r1 = $kernel->run('Widget', 'get', $params);
376 $this->assertEquals(count($resultIds), $r1['count']);
377 $this->assertEquals($resultIds, array_keys($r1['values']));
378 $this->assertEquals($resultIds, array_values(CRM_Utils_Array::collect('snack_id', $r1['values'])));
379 $this->assertEquals($resultIds, array_values(CRM_Utils_Array::collect('id', $r1['values'])));
380
381 $r2 = $kernel->run('Widget', 'get', $params + array('sequential' => 1));
382 $this->assertEquals(count($resultIds), $r2['count']);
383 $this->assertEquals($resultIds, array_values(CRM_Utils_Array::collect('snack_id', $r2['values'])));
384 $this->assertEquals($resultIds, array_values(CRM_Utils_Array::collect('id', $r2['values'])));
385
386 $r3 = $kernel->run('Widget', 'get', $params + array('options' => array('offset' => 1, 'limit' => 2)));
387 $slice = array_slice($resultIds, 1, 2);
388 $this->assertEquals(count($slice), $r3['count']);
389 $this->assertEquals($slice, array_values(CRM_Utils_Array::collect('snack_id', $r3['values'])));
390 $this->assertEquals($slice, array_values(CRM_Utils_Array::collect('id', $r3['values'])));
391 }
392
393 public function testBasicArrayGetReturn() {
394 $records = array(
395 array('snack_id' => 'a', 'fruit' => 'apple', 'cheese' => 'swiss'),
396 array('snack_id' => 'b', 'fruit' => 'grape', 'cheese' => 'cheddar'),
397 array('snack_id' => 'c', 'fruit' => 'apple', 'cheese' => 'cheddar'),
398 );
399
400 $kernel = new \Civi\API\Kernel(new \Symfony\Component\EventDispatcher\EventDispatcher());
401 $provider = new \Civi\API\Provider\AdhocProvider(3, 'Widget');
402 $provider->addAction('get', 'access CiviCRM', function ($apiRequest) use ($records) {
403 return _civicrm_api3_basic_array_get('Widget', $apiRequest['params'], $records, 'snack_id', array('snack_id', 'fruit', 'cheese'));
404 });
405 $kernel->registerApiProvider($provider);
406
407 $r1 = $kernel->run('Widget', 'get', array(
408 'version' => 3,
409 'snack_id' => 'b',
410 'return' => 'fruit',
411 ));
412 $this->assertAPISuccess($r1);
413 $this->assertEquals(array('b' => array('id' => 'b', 'fruit' => 'grape')), $r1['values']);
414
415 $r2 = $kernel->run('Widget', 'get', array(
416 'version' => 3,
417 'snack_id' => 'b',
418 'return' => array('fruit', 'cheese'),
419 ));
420 $this->assertAPISuccess($r2);
421 $this->assertEquals(array('b' => array('id' => 'b', 'fruit' => 'grape', 'cheese' => 'cheddar')), $r2['values']);
422
423 $r3 = $kernel->run('Widget', 'get', array(
424 'version' => 3,
425 'cheese' => 'cheddar',
426 'return' => array('fruit'),
427 ));
428 $this->assertAPISuccess($r3);
429 $this->assertEquals(array(
430 'b' => array('id' => 'b', 'fruit' => 'grape'),
431 'c' => array('id' => 'c', 'fruit' => 'apple'),
432 ), $r3['values']);
433 }
434
6a488035 435}