3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.7 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2015 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
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. |
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. |
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 +--------------------------------------------------------------------+
28 require_once 'CiviTest/CiviUnitTestCase.php';
29 require_once 'CRM/Utils/DeprecatedUtils.php';
32 * Test class for API utils
36 class api_v3_UtilsTest
extends CiviUnitTestCase
{
37 protected $_apiversion = 3;
38 public $DBResetRequired = FALSE;
40 public $_contactID = 1;
43 * Sets up the fixture, for example, opens a network connection.
45 * This method is called before a test is executed.
47 protected function setUp() {
49 $this->useTransaction(TRUE);
52 public function testAddFormattedParam() {
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);
59 public function testCheckPermissionReturn() {
60 $check = array('check_permissions' => TRUE);
61 $config = CRM_Core_Config
::singleton();
62 $config->userPermissionClass
->permissions
= array();
63 $this->assertFalse($this->runPermissionCheck('contact', 'create', $check), 'empty permissions should not be enough');
64 $config->userPermissionClass
->permissions
= array('access CiviCRM');
65 $this->assertFalse($this->runPermissionCheck('contact', 'create', $check), 'lacking permissions should not be enough');
66 $config->userPermissionClass
->permissions
= array('add contacts');
67 $this->assertFalse($this->runPermissionCheck('contact', 'create', $check), 'lacking permissions should not be enough');
69 $config->userPermissionClass
->permissions
= array('access CiviCRM', 'add contacts');
70 $this->assertTrue($this->runPermissionCheck('contact', 'create', $check), 'exact permissions should be enough');
72 $config->userPermissionClass
->permissions
= array('access CiviCRM', 'add contacts', 'import contacts');
73 $this->assertTrue($this->runPermissionCheck('contact', 'create', $check), 'overfluous permissions should be enough');
76 public function testCheckPermissionThrow() {
77 $check = array('check_permissions' => TRUE);
78 $config = CRM_Core_Config
::singleton();
80 $config->userPermissionClass
->permissions
= array('access CiviCRM');
81 $this->runPermissionCheck('contact', 'create', $check, TRUE);
83 catch (Exception
$e) {
84 $message = $e->getMessage();
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');
88 $config->userPermissionClass
->permissions
= array('access CiviCRM', 'add contacts', 'import contacts');
89 $this->assertTrue($this->runPermissionCheck('contact', 'create', $check), 'overfluous permissions should return true');
92 public function testCheckPermissionSkip() {
93 $config = CRM_Core_Config
::singleton();
94 $config->userPermissionClass
->permissions
= array('access CiviCRM');
95 $params = array('check_permissions' => TRUE);
96 $this->assertFalse($this->runPermissionCheck('contact', 'create', $params), 'lacking permissions should not be enough');
97 $params = array('check_permissions' => FALSE);
98 $this->assertTrue($this->runPermissionCheck('contact', 'create', $params), 'permission check should be skippable');
102 * @param string $entity
103 * @param string $action
104 * @param array $params
105 * @param bool $throws
106 * Whether we should pass any exceptions for authorization failures.
108 * @throws API_Exception
111 * TRUE or FALSE depending on the outcome of the authorization check
113 public function runPermissionCheck($entity, $action, $params, $throws = FALSE) {
114 $dispatcher = new \Symfony\Component\EventDispatcher\
EventDispatcher();
115 $dispatcher->addSubscriber(new \Civi\API\Subscriber\
PermissionCheck());
116 $kernel = new \Civi\API\
Kernel($dispatcher);
117 $apiRequest = \Civi\API\Request
::create($entity, $action, $params, NULL);
119 $kernel->authorize(NULL, $apiRequest);
122 catch (\API_Exception
$e) {
123 $extra = $e->getExtraParams();
124 if (!$throws && $extra['error_code'] == API_Exception
::UNAUTHORIZED
) {
134 * Test verify mandatory - includes DAO & passed as well as empty & NULL fields
136 public function testVerifyMandatory() {
137 _civicrm_api3_initialize(TRUE);
139 'entity_table' => 'civicrm_contact',
141 'contact_id' => $this->_contactID
,
142 'modified_date' => '2011-01-31',
144 'version' => $this->_apiversion
,
147 $result = civicrm_api3_verify_mandatory($params, 'CRM_Core_BAO_Note', array('note', 'subject'));
149 catch (Exception
$expected) {
150 $this->assertEquals('Mandatory key(s) missing from params array: entity_id, note, subject', $expected->getMessage());
154 $this->fail('An expected exception has not been raised.');
158 * Test verify one mandatory - includes DAO & passed as well as empty & NULL fields
160 public function testVerifyOneMandatory() {
161 _civicrm_api3_initialize(TRUE);
163 'entity_table' => 'civicrm_contact',
165 'contact_id' => $this->_contactID
,
166 'modified_date' => '2011-01-31',
168 'version' => $this->_apiversion
,
172 $result = civicrm_api3_verify_one_mandatory($params, 'CRM_Core_BAO_Note', array('note', 'subject'));
174 catch (Exception
$expected) {
175 $this->assertEquals('Mandatory key(s) missing from params array: entity_id, one of (note, subject)', $expected->getMessage());
179 $this->fail('An expected exception has not been raised.');
183 * Test verify one mandatory - includes DAO & passed as well as empty & NULL fields
185 public function testVerifyOneMandatoryOneSet() {
186 _civicrm_api3_initialize(TRUE);
189 'entity_table' => 'civicrm_contact',
191 'contact_id' => $this->_contactID
,
192 'modified_date' => '2011-01-31',
197 civicrm_api3_verify_one_mandatory($params, NULL, array('note', 'subject'));
199 catch (Exception
$expected) {
200 $this->fail('Exception raised when it shouldn\'t have been in line ' . __LINE__
);
206 * Test GET DAO function returns DAO.
208 public function testGetDAO() {
210 'civicrm_api3_custom_group_get' => 'CRM_Core_DAO_CustomGroup',
211 'custom_group' => 'CRM_Core_DAO_CustomGroup',
212 'CustomGroup' => 'CRM_Core_DAO_CustomGroup',
213 'civicrm_api3_custom_field_get' => 'CRM_Core_DAO_CustomField',
214 'civicrm_api3_survey_get' => 'CRM_Campaign_DAO_Survey',
215 'civicrm_api3_pledge_payment_get' => 'CRM_Pledge_DAO_PledgePayment',
216 'civicrm_api3_website_get' => 'CRM_Core_DAO_Website',
217 'Membership' => 'CRM_Member_DAO_Membership',
219 foreach ($params as $input => $expected) {
220 $result = _civicrm_api3_get_DAO($input);
221 $this->assertEquals($expected, $result);
226 * Test GET BAO function returns BAO when it exists.
228 public function testGetBAO() {
230 'civicrm_api3_website_get' => 'CRM_Core_BAO_Website',
231 'civicrm_api3_survey_get' => 'CRM_Campaign_BAO_Survey',
232 'civicrm_api3_pledge_payment_get' => 'CRM_Pledge_BAO_PledgePayment',
233 'Household' => 'CRM_Contact_BAO_Contact',
234 // Note this one DOES NOT have a BAO so we expect to fall back on returning the DAO
235 'mailing_group' => 'CRM_Mailing_DAO_MailingGroup',
236 // Make sure we get null back with nonexistant entities
237 'civicrm_this_does_not_exist' => NULL,
239 foreach ($params as $input => $expected) {
240 $result = _civicrm_api3_get_BAO($input);
241 $this->assertEquals($expected, $result);
245 public function test_civicrm_api3_validate_fields() {
246 $params = array('start_date' => '2010-12-20', 'end_date' => '');
247 $fields = civicrm_api3('relationship', 'getfields', array('action' => 'get'));
248 _civicrm_api3_validate_fields('relationship', 'get', $params, $fields['values']);
249 $this->assertEquals('20101220000000', $params['start_date']);
250 $this->assertEquals('', $params['end_date']);
253 public function test_civicrm_api3_validate_fields_membership() {
255 'start_date' => '2010-12-20',
257 'membership_end_date' => '0',
258 'join_date' => '2010-12-20',
259 'membership_start_date' => '2010-12-20',
261 $fields = civicrm_api3('Membership', 'getfields', array('action' => 'get'));
262 _civicrm_api3_validate_fields('Membership', 'get', $params, $fields['values']);
263 $this->assertEquals('2010-12-20', $params['start_date']);
264 $this->assertEquals('20101220000000', $params['membership_start_date']);
265 $this->assertEquals('', $params['end_date']);
266 $this->assertEquals('20101220000000', $params['join_date'], 'join_date not set in line ' . __LINE__
);
269 public function test_civicrm_api3_validate_fields_event() {
272 'registration_start_date' => 20080601,
273 'registration_end_date' => '2008-10-15',
274 'start_date' => '2010-12-20',
277 $fields = civicrm_api3('Event', 'getfields', array('action' => 'create'));
278 _civicrm_api3_validate_fields('event', 'create', $params, $fields['values']);
279 $this->assertEquals('20101220000000', $params['start_date']);
280 $this->assertEquals('20081015000000', $params['registration_end_date']);
281 $this->assertEquals('', $params['end_date']);
282 $this->assertEquals('20080601000000', $params['registration_start_date']);
285 public function test_civicrm_api3_validate_fields_exception() {
287 'join_date' => 'abc',
290 $fields = civicrm_api3('Membership', 'getfields', array('action' => 'get'));
291 _civicrm_api3_validate_fields('Membership', 'get', $params, $fields['values']);
293 catch (Exception
$expected) {
294 $this->assertEquals('join_date is not a valid date: abc', $expected->getMessage());
298 public function testGetFields() {
299 $result = $this->callAPISuccess('membership', 'getfields', array());
300 $this->assertArrayHasKey('values', $result);
301 $result = $this->callAPISuccess('relationship', 'getfields', array());
302 $this->assertArrayHasKey('values', $result);
303 $result = $this->callAPISuccess('event', 'getfields', array());
304 $this->assertArrayHasKey('values', $result);
307 public function testGetFields_AllOptions() {
308 $result = $this->callAPISuccess('contact', 'getfields', array(
310 'get_options' => 'all',
313 $this->assertEquals('Household', $result['values']['contact_type']['options']['Household']);
314 $this->assertEquals('HTML', $result['values']['preferred_mail_format']['options']['HTML']);
317 public function basicArrayCases() {
319 array('snack_id' => 'a', 'fruit' => 'apple', 'cheese' => 'swiss'),
320 array('snack_id' => 'b', 'fruit' => 'grape', 'cheese' => 'cheddar'),
321 array('snack_id' => 'c', 'fruit' => 'apple', 'cheese' => 'cheddar'),
322 array('snack_id' => 'd', 'fruit' => 'apple', 'cheese' => 'gouda'),
323 array('snack_id' => 'e', 'fruit' => 'apple', 'cheese' => 'provolone'),
328 array('version' => 3), // params
329 array('a', 'b', 'c', 'd', 'e'), // expected results
334 array('version' => 3, 'fruit' => 'apple'), // params
335 array('a', 'c', 'd', 'e'), // expected results
340 array('version' => 3, 'cheese' => 'cheddar'),
346 array('version' => 3, 'id' => 'd'),
354 * Make a basic API (Widget.get) which allows getting data out of a simple in-memory
358 * The list of all records.
360 * The filter criteria
361 * @param array $resultIds
362 * The records which are expected to match.
363 * @dataProvider basicArrayCases
365 public function testBasicArrayGet($records, $params, $resultIds) {
366 $params['version'] = 3;
368 $kernel = new \Civi\API\
Kernel(new \Symfony\Component\EventDispatcher\
EventDispatcher());
370 $provider = new \Civi\API\Provider\
AdhocProvider($params['version'], 'Widget');
371 $provider->addAction('get', 'access CiviCRM', function ($apiRequest) use ($records) {
372 return _civicrm_api3_basic_array_get('Widget', $apiRequest['params'], $records, 'snack_id', array('snack_id', 'fruit', 'cheese'));
374 $kernel->registerApiProvider($provider);
376 $r1 = $kernel->run('Widget', 'get', $params);
377 $this->assertEquals(count($resultIds), $r1['count']);
378 $this->assertEquals($resultIds, array_keys($r1['values']));
379 $this->assertEquals($resultIds, array_values(CRM_Utils_Array
::collect('snack_id', $r1['values'])));
380 $this->assertEquals($resultIds, array_values(CRM_Utils_Array
::collect('id', $r1['values'])));
382 $r2 = $kernel->run('Widget', 'get', $params +
array('sequential' => 1));
383 $this->assertEquals(count($resultIds), $r2['count']);
384 $this->assertEquals($resultIds, array_values(CRM_Utils_Array
::collect('snack_id', $r2['values'])));
385 $this->assertEquals($resultIds, array_values(CRM_Utils_Array
::collect('id', $r2['values'])));
387 $r3 = $kernel->run('Widget', 'get', $params +
array('options' => array('offset' => 1, 'limit' => 2)));
388 $slice = array_slice($resultIds, 1, 2);
389 $this->assertEquals(count($slice), $r3['count']);
390 $this->assertEquals($slice, array_values(CRM_Utils_Array
::collect('snack_id', $r3['values'])));
391 $this->assertEquals($slice, array_values(CRM_Utils_Array
::collect('id', $r3['values'])));
394 public function testBasicArrayGetReturn() {
396 array('snack_id' => 'a', 'fruit' => 'apple', 'cheese' => 'swiss'),
397 array('snack_id' => 'b', 'fruit' => 'grape', 'cheese' => 'cheddar'),
398 array('snack_id' => 'c', 'fruit' => 'apple', 'cheese' => 'cheddar'),
401 $kernel = new \Civi\API\
Kernel(new \Symfony\Component\EventDispatcher\
EventDispatcher());
402 $provider = new \Civi\API\Provider\
AdhocProvider(3, 'Widget');
403 $provider->addAction('get', 'access CiviCRM', function ($apiRequest) use ($records) {
404 return _civicrm_api3_basic_array_get('Widget', $apiRequest['params'], $records, 'snack_id', array('snack_id', 'fruit', 'cheese'));
406 $kernel->registerApiProvider($provider);
408 $r1 = $kernel->run('Widget', 'get', array(
413 $this->assertAPISuccess($r1);
414 $this->assertEquals(array('b' => array('id' => 'b', 'fruit' => 'grape')), $r1['values']);
416 $r2 = $kernel->run('Widget', 'get', array(
419 'return' => array('fruit', 'cheese'),
421 $this->assertAPISuccess($r2);
422 $this->assertEquals(array('b' => array('id' => 'b', 'fruit' => 'grape', 'cheese' => 'cheddar')), $r2['values']);
424 $r3 = $kernel->run('Widget', 'get', array(
426 'cheese' => 'cheddar',
427 'return' => array('fruit'),
429 $this->assertAPISuccess($r3);
430 $this->assertEquals(array(
431 'b' => array('id' => 'b', 'fruit' => 'grape'),
432 'c' => array('id' => 'c', 'fruit' => 'apple'),