3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.4 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2013 |
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;
39 public $_eNoticeCompliant = TRUE;
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.
48 protected function setUp() {
53 * Tears down the fixture, for example, closes a network connection.
54 * This method is called after a test is executed.
58 protected function tearDown() {}
60 function testAddFormattedParam() {
61 $values = array('contact_type' => 'Individual');
62 $params = array('something' => 1);
63 $result = _civicrm_api3_deprecated_add_formatted_param($values, $params);
64 $this->assertTrue($result);
67 function testCheckPermissionReturn() {
68 $check = array('check_permissions' => TRUE);
69 $config = CRM_Core_Config
::singleton();
70 $config->userPermissionClass
->permissions
= array();
71 $this->assertFalse(_civicrm_api3_api_check_permission('contact', 'create', $check, FALSE), 'empty permissions should not be enough');
72 $config->userPermissionClass
->permissions
= array('access CiviCRM');
73 $this->assertFalse(_civicrm_api3_api_check_permission('contact', 'create', $check, FALSE), 'lacking permissions should not be enough');
74 $config->userPermissionClass
->permissions
= array('add contacts');
75 $this->assertFalse(_civicrm_api3_api_check_permission('contact', 'create', $check, FALSE), 'lacking permissions should not be enough');
77 $config->userPermissionClass
->permissions
= array('access CiviCRM', 'add contacts');
78 $this->assertTrue(_civicrm_api3_api_check_permission('contact', 'create', $check, FALSE), 'exact permissions should be enough');
80 $config->userPermissionClass
->permissions
= array('access CiviCRM', 'add contacts', 'import contacts');
81 $this->assertTrue(_civicrm_api3_api_check_permission('contact', 'create', $check, FALSE), 'overfluous permissions should be enough');
84 function testCheckPermissionThrow() {
85 $check = array('check_permissions' => TRUE);
86 $config = CRM_Core_Config
::singleton();
88 $config->userPermissionClass
->permissions
= array('access CiviCRM');
89 _civicrm_api3_api_check_permission('contact', 'create', $check);
92 $message = $e->getMessage();
94 $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');
96 $config->userPermissionClass
->permissions
= array('access CiviCRM', 'add contacts', 'import contacts');
97 $this->assertTrue(_civicrm_api3_api_check_permission('contact', 'create', $check), 'overfluous permissions should return true');
100 function testCheckPermissionSkip() {
101 $config = CRM_Core_Config
::singleton();
102 $config->userPermissionClass
->permissions
= array('access CiviCRM');
103 $params = array('check_permissions' => TRUE);
104 $this->assertFalse(_civicrm_api3_api_check_permission('contact', 'create', $params, FALSE), 'lacking permissions should not be enough');
105 $params = array('check_permissions' => FALSE);
106 $this->assertTrue(_civicrm_api3_api_check_permission('contact', 'create', $params, FALSE), 'permission check should be skippable');
110 * Test verify mandatory - includes DAO & passed as well as empty & NULL fields
112 function testVerifyMandatory() {
113 _civicrm_api3_initialize(TRUE);
115 'entity_table' => 'civicrm_contact',
117 'contact_id' => $this->_contactID
,
118 'modified_date' => '2011-01-31',
120 'version' => $this->_apiversion
123 $result = civicrm_api3_verify_mandatory($params, 'CRM_Core_BAO_Note', array('note', 'subject'));
125 catch(Exception
$expected) {
126 $this->assertEquals('Mandatory key(s) missing from params array: entity_id, note, subject', $expected->getMessage());
130 $this->fail('An expected exception has not been raised.');
134 * Test verify one mandatory - includes DAO & passed as well as empty & NULL fields
136 function testVerifyOneMandatory() {
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
,
148 $result = civicrm_api3_verify_one_mandatory($params, 'CRM_Core_BAO_Note', array('note', 'subject'));
150 catch(Exception
$expected) {
151 $this->assertEquals('Mandatory key(s) missing from params array: entity_id, one of (note, subject)', $expected->getMessage());
155 $this->fail('An expected exception has not been raised.');
159 * Test verify one mandatory - includes DAO & passed as well as empty & NULL fields
161 function testVerifyOneMandatoryOneSet() {
162 _civicrm_api3_initialize(TRUE);
163 $params = array('version' => 3, 'entity_table' => 'civicrm_contact', 'note' => 'note', 'contact_id' => $this->_contactID
, 'modified_date' => '2011-01-31', 'subject' => NULL);
166 civicrm_api3_verify_one_mandatory($params, NULL, array('note', 'subject'));
168 catch(Exception
$expected) {
169 $this->fail('Exception raised when it shouldn\'t have been in line ' . __LINE__
);
175 * Test GET DAO function returns DAO
177 function testGetDAO() {
179 'civicrm_api3_custom_group_get' => 'CRM_Core_DAO_CustomGroup',
180 'custom_group' => 'CRM_Core_DAO_CustomGroup',
181 'CustomGroup' => 'CRM_Core_DAO_CustomGroup',
182 'civicrm_api3_custom_field_get' => 'CRM_Core_DAO_CustomField',
183 'civicrm_api3_survey_get' => 'CRM_Campaign_DAO_Survey',
184 'civicrm_api3_pledge_payment_get' => 'CRM_Pledge_DAO_PledgePayment',
185 'civicrm_api3_website_get' => 'CRM_Core_DAO_Website',
186 'Membership' => 'CRM_Member_DAO_Membership',
188 foreach ($params as $input => $expected) {
189 $result = _civicrm_api3_get_DAO($input);
190 $this->assertEquals($expected, $result);
194 * Test GET BAO function returns BAO when it exists
196 function testGetBAO() {
198 'civicrm_api3_website_get' => 'CRM_Core_BAO_Website',
199 'civicrm_api3_survey_get' => 'CRM_Campaign_BAO_Survey',
200 'civicrm_api3_pledge_payment_get' => 'CRM_Pledge_BAO_PledgePayment',
201 'Household' => 'CRM_Contact_BAO_Contact',
202 // Note this one DOES NOT have a BAO so we expect to fall back on returning the DAO
203 'mailing_group' => 'CRM_Mailing_DAO_MailingGroup',
204 // Make sure we get null back with nonexistant entities
205 'civicrm_this_does_not_exist' => NULL,
207 foreach ($params as $input => $expected) {
208 $result = _civicrm_api3_get_BAO($input);
209 $this->assertEquals($expected, $result);
213 function test_civicrm_api3_validate_fields() {
214 $params = array('start_date' => '2010-12-20', 'end_date' => '');
215 $fields = civicrm_api3('relationship', 'getfields', array('action' => 'get'));
216 _civicrm_api3_validate_fields('relationship', 'get', $params, $fields['values']);
217 $this->assertEquals('20101220000000', $params['start_date']);
218 $this->assertEquals('', $params['end_date']);
221 function test_civicrm_api3_validate_fields_membership() {
222 $params = array('start_date' => '2010-12-20', 'end_date' => '', 'membership_end_date' => '0', 'join_date' => '2010-12-20', 'membership_start_date' => '2010-12-20');
223 $fields = civicrm_api3('Membership', 'getfields', array('action' => 'get'));
224 _civicrm_api3_validate_fields('Membership', 'get', $params, $fields['values']);
225 $this->assertEquals('20101220000000', $params['start_date'], 'in line ' . __LINE__
);
226 $this->assertEquals('', $params['end_date']);
227 $this->assertEquals('20101220000000', $params['join_date'], 'join_date not set in line ' . __LINE__
);
230 function test_civicrm_api3_validate_fields_event() {
233 'registration_start_date' => 20080601,
234 'registration_end_date' => '2008-10-15', 'start_date' => '2010-12-20', 'end_date' => '',
236 $fields = civicrm_api3('Event', 'getfields', array('action' => 'create'));
237 _civicrm_api3_validate_fields('event', 'create', $params, $fields['values']);
238 $this->assertEquals('20101220000000', $params['start_date'], 'in line ' . __LINE__
);
239 $this->assertEquals('20081015000000', $params['registration_end_date'], 'in line ' . __LINE__
);
240 $this->assertEquals('', $params['end_date'], 'in line ' . __LINE__
);
241 $this->assertEquals('20080601000000', $params['registration_start_date']);
244 function test_civicrm_api3_validate_fields_exception() {
246 'join_date' => 'abc',
249 $fields = civicrm_api3('Membership', 'getfields', array('action' => 'get'));
250 _civicrm_api3_validate_fields('Membership', 'get', $params, $fields['values']);
252 catch(Exception
$expected) {
253 $this->assertEquals('join_date is not a valid date: abc', $expected->getMessage());
257 function testGetFields() {
258 $result = $this->callAPISuccess('membership', 'getfields', array());
259 $this->assertArrayHasKey('values', $result);
260 $result = $this->callAPISuccess('relationship', 'getfields', array());
261 $this->assertArrayHasKey('values', $result);
262 $result = $this->callAPISuccess('event', 'getfields', array());
263 $this->assertArrayHasKey('values', $result);
266 function testGetFields_AllOptions() {
267 $result = $this->callAPISuccess('contact', 'getfields', array(
269 'get_options' => 'all',
272 $this->assertEquals('Household', $result['values']['contact_type']['options']['Household']);
273 $this->assertEquals('HTML', $result['values']['preferred_mail_format']['options']['HTML']);