3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.6 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2014 |
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.
44 * This method is called before a test is executed.
46 protected function setUp() {
48 $this->useTransaction(TRUE);
51 public function testAddFormattedParam() {
52 $values = array('contact_type' => 'Individual');
53 $params = array('something' => 1);
54 $result = _civicrm_api3_deprecated_add_formatted_param($values, $params);
55 $this->assertTrue($result);
58 public function testCheckPermissionReturn() {
59 $check = array('check_permissions' => TRUE);
60 $config = CRM_Core_Config
::singleton();
61 $config->userPermissionClass
->permissions
= array();
62 $this->assertFalse($this->runPermissionCheck('contact', 'create', $check), 'empty permissions should not be enough');
63 $config->userPermissionClass
->permissions
= array('access CiviCRM');
64 $this->assertFalse($this->runPermissionCheck('contact', 'create', $check), 'lacking permissions should not be enough');
65 $config->userPermissionClass
->permissions
= array('add contacts');
66 $this->assertFalse($this->runPermissionCheck('contact', 'create', $check), 'lacking permissions should not be enough');
68 $config->userPermissionClass
->permissions
= array('access CiviCRM', 'add contacts');
69 $this->assertTrue($this->runPermissionCheck('contact', 'create', $check), 'exact permissions should be enough');
71 $config->userPermissionClass
->permissions
= array('access CiviCRM', 'add contacts', 'import contacts');
72 $this->assertTrue($this->runPermissionCheck('contact', 'create', $check), 'overfluous permissions should be enough');
75 public function testCheckPermissionThrow() {
76 $check = array('check_permissions' => TRUE);
77 $config = CRM_Core_Config
::singleton();
79 $config->userPermissionClass
->permissions
= array('access CiviCRM');
80 $this->runPermissionCheck('contact', 'create', $check, TRUE);
82 catch (Exception
$e) {
83 $message = $e->getMessage();
85 $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');
87 $config->userPermissionClass
->permissions
= array('access CiviCRM', 'add contacts', 'import contacts');
88 $this->assertTrue($this->runPermissionCheck('contact', 'create', $check), 'overfluous permissions should return true');
91 public function testCheckPermissionSkip() {
92 $config = CRM_Core_Config
::singleton();
93 $config->userPermissionClass
->permissions
= array('access CiviCRM');
94 $params = array('check_permissions' => TRUE);
95 $this->assertFalse($this->runPermissionCheck('contact', 'create', $params), 'lacking permissions should not be enough');
96 $params = array('check_permissions' => FALSE);
97 $this->assertTrue($this->runPermissionCheck('contact', 'create', $params), 'permission check should be skippable');
101 * @param string $entity
102 * @param string $action
103 * @param array $params
104 * @param bool $throws
105 * Whether we should pass any exceptions for authorization failures.
107 * @throws API_Exception
110 * TRUE or FALSE depending on the outcome of the authorization check
112 public function runPermissionCheck($entity, $action, $params, $throws = FALSE) {
113 $dispatcher = new \Symfony\Component\EventDispatcher\
EventDispatcher();
114 $dispatcher->addSubscriber(new \Civi\API\Subscriber\
PermissionCheck());
115 $kernel = new \Civi\API\
Kernel($dispatcher);
116 $apiRequest = \Civi\API\Request
::create($entity, $action, $params, NULL);
118 $kernel->authorize(NULL, $apiRequest);
121 catch (\API_Exception
$e) {
122 $extra = $e->getExtraParams();
123 if (!$throws && $extra['error_code'] == API_Exception
::UNAUTHORIZED
) {
133 * Test verify mandatory - includes DAO & passed as well as empty & NULL fields
135 public function testVerifyMandatory() {
136 _civicrm_api3_initialize(TRUE);
138 'entity_table' => 'civicrm_contact',
140 'contact_id' => $this->_contactID
,
141 'modified_date' => '2011-01-31',
143 'version' => $this->_apiversion
,
146 $result = civicrm_api3_verify_mandatory($params, 'CRM_Core_BAO_Note', array('note', 'subject'));
148 catch (Exception
$expected) {
149 $this->assertEquals('Mandatory key(s) missing from params array: entity_id, note, subject', $expected->getMessage());
153 $this->fail('An expected exception has not been raised.');
157 * Test verify one mandatory - includes DAO & passed as well as empty & NULL fields
159 public function testVerifyOneMandatory() {
160 _civicrm_api3_initialize(TRUE);
162 'entity_table' => 'civicrm_contact',
164 'contact_id' => $this->_contactID
,
165 'modified_date' => '2011-01-31',
167 'version' => $this->_apiversion
,
171 $result = civicrm_api3_verify_one_mandatory($params, 'CRM_Core_BAO_Note', array('note', 'subject'));
173 catch (Exception
$expected) {
174 $this->assertEquals('Mandatory key(s) missing from params array: entity_id, one of (note, subject)', $expected->getMessage());
178 $this->fail('An expected exception has not been raised.');
182 * Test verify one mandatory - includes DAO & passed as well as empty & NULL fields
184 public function testVerifyOneMandatoryOneSet() {
185 _civicrm_api3_initialize(TRUE);
188 'entity_table' => 'civicrm_contact',
190 'contact_id' => $this->_contactID
,
191 'modified_date' => '2011-01-31',
196 civicrm_api3_verify_one_mandatory($params, NULL, array('note', 'subject'));
198 catch (Exception
$expected) {
199 $this->fail('Exception raised when it shouldn\'t have been in line ' . __LINE__
);
205 * Test GET DAO function returns DAO
207 public function testGetDAO() {
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',
218 foreach ($params as $input => $expected) {
219 $result = _civicrm_api3_get_DAO($input);
220 $this->assertEquals($expected, $result);
225 * Test GET BAO function returns BAO when it exists
227 public function testGetBAO() {
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',
235 // Make sure we get null back with nonexistant entities
236 'civicrm_this_does_not_exist' => NULL,
238 foreach ($params as $input => $expected) {
239 $result = _civicrm_api3_get_BAO($input);
240 $this->assertEquals($expected, $result);
244 public function test_civicrm_api3_validate_fields() {
245 $params = array('start_date' => '2010-12-20', 'end_date' => '');
246 $fields = civicrm_api3('relationship', 'getfields', array('action' => 'get'));
247 _civicrm_api3_validate_fields('relationship', 'get', $params, $fields['values']);
248 $this->assertEquals('20101220000000', $params['start_date']);
249 $this->assertEquals('', $params['end_date']);
252 public function test_civicrm_api3_validate_fields_membership() {
254 'start_date' => '2010-12-20',
256 'membership_end_date' => '0',
257 'join_date' => '2010-12-20',
258 'membership_start_date' => '2010-12-20',
260 $fields = civicrm_api3('Membership', 'getfields', array('action' => 'get'));
261 _civicrm_api3_validate_fields('Membership', 'get', $params, $fields['values']);
262 $this->assertEquals('2010-12-20', $params['start_date']);
263 $this->assertEquals('20101220000000', $params['membership_start_date'], 'in line ' . __LINE__
);
264 $this->assertEquals('', $params['end_date']);
265 $this->assertEquals('20101220000000', $params['join_date'], 'join_date not set in line ' . __LINE__
);
268 public function test_civicrm_api3_validate_fields_event() {
271 'registration_start_date' => 20080601,
272 'registration_end_date' => '2008-10-15',
273 'start_date' => '2010-12-20',
276 $fields = civicrm_api3('Event', 'getfields', array('action' => 'create'));
277 _civicrm_api3_validate_fields('event', 'create', $params, $fields['values']);
278 $this->assertEquals('20101220000000', $params['start_date'], 'in line ' . __LINE__
);
279 $this->assertEquals('20081015000000', $params['registration_end_date'], 'in line ' . __LINE__
);
280 $this->assertEquals('', $params['end_date'], 'in line ' . __LINE__
);
281 $this->assertEquals('20080601000000', $params['registration_start_date']);
284 public function test_civicrm_api3_validate_fields_exception() {
286 'join_date' => 'abc',
289 $fields = civicrm_api3('Membership', 'getfields', array('action' => 'get'));
290 _civicrm_api3_validate_fields('Membership', 'get', $params, $fields['values']);
292 catch (Exception
$expected) {
293 $this->assertEquals('join_date is not a valid date: abc', $expected->getMessage());
297 public function testGetFields() {
298 $result = $this->callAPISuccess('membership', 'getfields', array());
299 $this->assertArrayHasKey('values', $result);
300 $result = $this->callAPISuccess('relationship', 'getfields', array());
301 $this->assertArrayHasKey('values', $result);
302 $result = $this->callAPISuccess('event', 'getfields', array());
303 $this->assertArrayHasKey('values', $result);
306 public function testGetFields_AllOptions() {
307 $result = $this->callAPISuccess('contact', 'getfields', array(
309 'get_options' => 'all',
312 $this->assertEquals('Household', $result['values']['contact_type']['options']['Household']);
313 $this->assertEquals('HTML', $result['values']['preferred_mail_format']['options']['HTML']);