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';
31 * Test class for Pledge API - civicrm_pledge_*
33 * @package CiviCRM_APIv3
35 class api_v3_PledgeTest
extends CiviUnitTestCase
{
38 * Assume empty database with just civicrm_data
40 protected $_individualId;
42 protected $_apiversion;
45 protected $scheduled_date;
46 public $DBResetRequired = TRUE;
48 public function setUp() {
49 $this->_apiversion
= 3;
51 $this->quickCleanup(array('civicrm_pledge', 'civicrm_pledge_payment'));
52 //need to set scheduled payment in advance we are running test @ midnight & it becomes unexpectedly overdue
53 //due to timezone issues
54 $this->scheduled_date
= date('Ymd', mktime(0, 0, 0, date("m"), date("d") +
2, date("y")));
55 $this->_entity
= 'Pledge';
56 $this->_individualId
= $this->individualCreate();
57 $this->_params
= array(
58 'contact_id' => $this->_individualId
,
59 'pledge_create_date' => date('Ymd'),
60 'start_date' => date('Ymd'),
61 'scheduled_date' => $this->scheduled_date
,
63 'pledge_status_id' => '2',
64 'pledge_financial_type_id' => '1',
65 'pledge_original_installment_amount' => 20,
66 'frequency_interval' => 5,
67 'frequency_unit' => 'year',
68 'frequency_day' => 15,
74 public function tearDown() {
75 $this->contactDelete($this->_individualId
);
78 ///////////////// civicrm_pledge_get methods
81 * Check with complete array + custom field
82 * Note that the test is written on purpose without any
83 * variables specific to participant so it can be replicated into other entities
84 * and / or moved to the automated test suite
86 public function testCreateWithCustom() {
87 $ids = $this->entityCustomGroupWithSingleFieldCreate(__FUNCTION__
, __FILE__
);
89 $params = $this->_params
;
90 $params['custom_' . $ids['custom_field_id']] = "custom string";
92 $result = $this->callAPISuccess($this->_entity
, 'create', $params);
93 $this->assertAPISuccess($result, " testCreateWithCustom ");
94 $this->assertAPISuccess($result, ' in line ' . __LINE__
);
95 $getparams = array('id' => $result['id'], 'return.custom_' . $ids['custom_field_id'] => 1);
96 $check = $this->callAPISuccess($this->_entity
, 'get', $getparams);
97 $this->callAPISuccess('pledge', 'delete', array('id' => $check['id']));
98 $this->assertEquals("custom string", $check['values'][$check['id']]['custom_' . $ids['custom_field_id']], ' in line ' . __LINE__
);
100 $this->customFieldDelete($ids['custom_field_id']);
101 $this->customGroupDelete($ids['custom_group_id']);
104 public function testgetfieldspledge() {
105 $result = $this->callAPISuccess('pledge', 'getfields', array('action' => 'get'));
106 $this->assertEquals(1, $result['values']['next_pay_date']['api.return']);
109 public function testGetPledge() {
111 $this->_pledge
= $this->callAPISuccess('pledge', 'create', $this->_params
);
113 'pledge_id' => $this->_pledge
['id'],
115 $result = $this->callAPIAndDocument('pledge', 'get', $params, __FUNCTION__
, __FILE__
);
116 $pledge = $result['values'][$this->_pledge
['id']];
117 $this->assertEquals($this->_individualId
, $pledge['contact_id'], 'in line' . __LINE__
);
118 $this->assertEquals($this->_pledge
['id'], $pledge['pledge_id'], 'in line' . __LINE__
);
119 $this->assertEquals(date('Y-m-d') . ' 00:00:00', $pledge['pledge_create_date'], 'in line' . __LINE__
);
120 $this->assertEquals(100.00, $pledge['pledge_amount'], 'in line' . __LINE__
);
121 $this->assertEquals('Pending', $pledge['pledge_status'], 'in line' . __LINE__
);
122 $this->assertEquals(5, $pledge['pledge_frequency_interval'], 'in line' . __LINE__
);
123 $this->assertEquals('year', $pledge['pledge_frequency_unit'], 'in line' . __LINE__
);
124 $this->assertEquals(date('Y-m-d', strtotime($this->scheduled_date
)) . ' 00:00:00', $pledge['pledge_next_pay_date'], 'in line' . __LINE__
);
125 $this->assertEquals($pledge['pledge_next_pay_amount'], 20.00, 'in line' . __LINE__
);
128 'pledge_id' => $this->_pledge
['id'],
130 $pledge = $this->callAPISuccess('pledge', 'delete', $params2);
134 * Test 'return.pledge_financial_type' => 1 works
136 public function testGetPledgewithReturn() {
138 $this->_pledge
= $this->callAPISuccess('pledge', 'create', $this->_params
);
140 'pledge_id' => $this->_pledge
['id'],
141 'return.pledge_financial_type' => 1,
143 $result = $this->callAPISuccess('pledge', 'get', $params);
144 $pledge = $result['values'][$this->_pledge
['id']];
145 $this->callAPISuccess('pledge', 'delete', $pledge);
146 $this->assertEquals('Donation', $pledge['pledge_financial_type']);
150 * Test 'return.pledge_contribution_type' => 1 works
151 * This is for legacy compatibility
153 public function testGetPledgewithReturnLegacy() {
155 $this->_pledge
= $this->callAPISuccess('pledge', 'create', $this->_params
);
157 'pledge_id' => $this->_pledge
['id'],
158 'return.pledge_financial_type' => 1,
160 $result = $this->callAPISuccess('pledge', 'get', $params);
161 $pledge = $result['values'][$this->_pledge
['id']];
162 $this->callAPISuccess('pledge', 'delete', $pledge);
163 $this->assertEquals('Donation', $pledge['pledge_financial_type']);
166 public function testPledgeGetReturnFilters() {
167 $oldPledge = $this->callAPISuccess('pledge', 'create', $this->_params
);
169 $overdueParams = array(
170 'scheduled_date' => 'first saturday of march last year',
171 'start_date' => 'first saturday of march last year',
173 $oldPledge = $this->callAPISuccess('pledge', 'create', array_merge($this->_params
, $overdueParams));
175 $pledgeGetParams = array();
176 $allPledges = $this->callAPISuccess('pledge', 'getcount', $pledgeGetParams);
178 $this->assertEquals(2, $allPledges, 'Check we have 2 pledges to place with in line ' . __LINE__
);
179 $pledgeGetParams['pledge_start_date_high'] = date('YmdHis', strtotime('2 days ago'));
180 $earlyPledge = $this->callAPIAndDocument('pledge', 'get', $pledgeGetParams, __FUNCTION__
, __FILE__
, "demonstrates high date filter", "GetFilterHighDate");
181 $this->assertEquals(1, $earlyPledge['count'], ' check only one returned with start date filter in line ' . __LINE__
);
182 $this->assertEquals($oldPledge['id'], $earlyPledge['id'], ' check correct pledge returned ' . __LINE__
);
186 * create 2 pledges - see if we can get by status id
188 public function testGetOverduePledge() {
189 $overdueParams = array(
190 'scheduled_date' => 'first saturday of march last year',
191 'start_date' => 'first saturday of march last year',
193 $this->_pledge
= $this->callAPISuccess('pledge', 'create', array_merge($this->_params
, $overdueParams));
195 'pledge_status_id' => '6',
197 $result = $this->callAPISuccess('pledge', 'get', $params);
198 $emptyResult = $this->callAPISuccess('pledge', 'get', array(
199 'pledge_status_id' => '1',
201 $pledge = $result['values'][$this->_pledge
['id']];
202 $this->callAPISuccess('pledge', 'delete', $pledge);
203 $this->assertEquals(1, $result['count']);
204 $this->assertEquals(0, $emptyResult['count']);
209 * create 2 pledges - see if we can get by status id
211 public function testSortParamPledge() {
212 $pledge1 = $this->callAPISuccess('pledge', 'create', $this->_params
);
213 $overdueParams = array(
214 'scheduled_date' => 'first saturday of march last year',
215 'start_date' => 'first saturday of march last year',
216 'create_date' => 'first saturday of march last year',
218 $pledge2 = $this->callAPISuccess('pledge', 'create', array_merge($this->_params
, $overdueParams));
220 'pledge_is_test' => 0,
223 $result = $this->callAPISuccess('pledge', 'get', $params);
225 $resultSortedAsc = $this->callAPISuccess('pledge', 'get', array(
227 'sort' => 'start_date ASC',
229 $resultSortedDesc = $this->callAPISuccess('pledge', 'get', array(
231 'sort' => 'start_date DESC',
234 $this->assertEquals($pledge1['id'], $result['id'], 'pledge get gets first created pledge in line ' . __LINE__
);
235 $this->assertEquals($pledge2['id'], $resultSortedAsc['id'], 'Ascending pledge sort works');
236 $this->assertEquals($pledge1['id'], $resultSortedDesc['id'], 'Decending pledge sort works');
237 $this->callAPISuccess('pledge', 'delete', array('id' => $pledge1['id']));
238 $this->callAPISuccess('pledge', 'delete', array('id' => $pledge2['id']));
241 public function testCreatePledge() {
243 $result = $this->callAPIAndDocument('pledge', 'create', $this->_params
, __FUNCTION__
, __FILE__
);
244 $this->assertEquals($result['values'][0]['amount'], 100.00, 'In line ' . __LINE__
);
245 $this->assertEquals($result['values'][0]['installments'], 5, 'In line ' . __LINE__
);
246 $this->assertEquals($result['values'][0]['frequency_unit'], 'year', 'In line ' . __LINE__
);
247 $this->assertEquals($result['values'][0]['frequency_interval'], 5, 'In line ' . __LINE__
);
248 $this->assertEquals($result['values'][0]['frequency_day'], 15, 'In line ' . __LINE__
);
249 $this->assertEquals($result['values'][0]['original_installment_amount'], 20, 'In line ' . __LINE__
);
250 $this->assertEquals($result['values'][0]['status_id'], 2, 'In line ' . __LINE__
);
251 $this->assertEquals($result['values'][0]['create_date'], date('Ymd') . '000000', 'In line ' . __LINE__
);
252 $this->assertEquals($result['values'][0]['start_date'], date('Ymd') . '000000', 'In line ' . __LINE__
);
253 $this->assertAPISuccess($result, 'In line ' . __LINE__
);
254 $payments = $this->callAPISuccess('PledgePayment', 'Get', array('pledge_id' => $result['id'], 'sequential' => 1));
255 $this->assertAPISuccess($payments, 'In line ' . __LINE__
);
256 $this->assertEquals($payments['count'], 5, 'In line ' . __LINE__
);
257 require_once 'CRM/Utils/Date.php';
258 $shouldBeDate = CRM_Utils_Date
::format(CRM_Utils_Date
::intervalAdd('year', 5 * 4, $this->scheduled_date
), "-");
259 $this->assertEquals(substr($shouldBeDate, 0, 10), substr($payments['values'][4]['scheduled_date'], 0, 10), 'In line ' . __LINE__
);
261 $pledgeID = array('id' => $result['id']);
262 $pledge = $this->callAPISuccess('pledge', 'delete', $pledgeID);
266 * Test that pledge with weekly schedule calculates dates correctly
268 public function testCreatePledgeWeeklySchedule() {
270 'scheduled_date' => '20110510',
271 'frequency_unit' => 'week',
272 'frequency_day' => 3,
273 'frequency_interval' => 2,
275 $params = array_merge($this->_params
, $params);
276 $pledge = $this->callAPISuccess('Pledge', 'Create', $params);
277 //ensure that correct number of payments created & last payment has the right date
278 $payments = $this->callAPISuccess('PledgePayment', 'Get', array(
279 'pledge_id' => $pledge['id'],
282 $this->assertEquals($payments['count'], 5, 'In line ' . __LINE__
);
283 $this->assertEquals('2011-07-06 00:00:00', $payments['values'][4]['scheduled_date'], 'In line ' . __LINE__
);
285 $this->callAPISuccess('pledge', 'delete', array('pledge_id' => $pledge['id']));
289 * Test that pledge with weekly schedule calculates dates correctly
291 public function testCreatePledgeMontlySchedule() {
293 'scheduled_date' => '20110510',
294 'frequency_unit' => 'Month',
295 'frequency_day' => 3,
296 'frequency_interval' => 2,
298 $params = array_merge($this->_params
, $params);
299 $apiResult = $this->callAPISuccess('pledge', 'create', $params);
304 * Test creation of pledge with only one payment.
306 * Pledge status id left empty as it is not a required field
307 * http://issues.civicrm.org/jira/browse/CRM-8551
309 public function testCreatePledgeSinglePayment() {
311 'scheduled_date' => '20110510',
312 'frequency_unit' => 'week',
313 'frequency_day' => 3,
314 'frequency_interval' => 2,
318 $params = array_merge($this->_params
, $params);
319 unset($params['pledge_status_id']);
320 $pledge = $this->callAPISuccess('Pledge', 'Create', $params);
321 //ensure that correct number of payments created & last payment has the right date
322 $payments = $this->callAPISuccess('PledgePayment', 'Get', array(
323 'pledge_id' => $pledge['id'],
326 $this->assertEquals(1, $payments['count'], 'In line ' . __LINE__
);
327 $this->assertEquals(2, $payments['values'][0]['status_id'], 'In line ' . __LINE__
);
328 $pledgeID = array('id' => $pledge['id']);
329 $pledge = $this->callAPISuccess('pledge', 'delete', $pledgeID);
333 * test that using original_installment_amount rather than pledge_original_installment_amount works
334 * Pledge field behaviour is a bit random & so pledge has come to try to handle both unique & non -unique fields
336 public function testCreatePledgeWithNonUnique() {
337 $params = $this->_params
;
338 $params['original_installment_amount'] = $params['pledge_original_installment_amount'];
340 unset($params['pledge_original_installment_amount']);
341 $result = $this->callAPISuccess('pledge', 'create', $params);
342 $pledgeDetails = $this->callAPISuccess('Pledge', 'Get', array('id' => $result['id'], 'sequential' => 1));
343 $pledge = $pledgeDetails['values'][0];
344 $this->assertEquals(100.00, $pledge['pledge_amount'], 'In line ' . __LINE__
);
345 $this->assertEquals('year', $pledge['pledge_frequency_unit'], 'In line ' . __LINE__
);
346 $this->assertEquals(5, $pledge['pledge_frequency_interval'], 'In line ' . __LINE__
);
347 $this->assertEquals(20, $pledge['pledge_next_pay_amount'], 'In line ' . __LINE__
);
349 $pledgeID = array('id' => $result['id']);
350 $pledge = $this->callAPISuccess('pledge', 'delete', $pledgeID);
353 public function testCreateCancelPledge() {
355 $result = $this->callAPISuccess('pledge', 'create', $this->_params
);
356 $this->assertEquals(2, $result['values'][0]['status_id'], "in line " . __LINE__
);
357 $cancelparams = array('sequential' => 1, 'id' => $result['id'], 'pledge_status_id' => 3);
358 $result = $this->callAPISuccess('pledge', 'create', $cancelparams);
359 $this->assertEquals(3, $result['values'][0]['status_id'], "in line " . __LINE__
);
360 $pledgeID = array('id' => $result['id']);
361 $pledge = $this->callAPISuccess('pledge', 'delete', $pledgeID);
365 * Test that status is set to pending
367 public function testCreatePledgeNoStatus() {
369 $params = $this->_params
;
370 unset($params['status_id']);
371 unset($params['pledge_status_id']);
372 $result = $this->callAPISuccess('pledge', 'create', $params);
373 $this->assertAPISuccess($result, "in line " . __LINE__
);
374 $this->assertEquals(2, $result['values'][0]['status_id'], "in line " . __LINE__
);
375 $pledgeID = array('pledge_id' => $result['id']);
376 $pledge = $this->callAPISuccess('pledge', 'delete', $pledgeID);
382 public function testCreateUpdatePledge() {
383 // we test 'sequential' param here too
384 $pledgeID = $this->pledgeCreate($this->_individualId
);
389 $original = $this->callAPISuccess('pledge', 'get', $old_params);
390 //Make sure it came back
391 $this->assertEquals($original['values'][0]['pledge_id'], $pledgeID, 'In line ' . __LINE__
);
392 //set up list of old params, verify
393 $old_contact_id = $original['values'][0]['contact_id'];
394 $old_frequency_unit = $original['values'][0]['pledge_frequency_unit'];
395 $old_frequency_interval = $original['values'][0]['pledge_frequency_interval'];
396 $old_status_id = $original['values'][0]['pledge_status'];
398 //check against values in CiviUnitTestCase::createPledge()
399 $this->assertEquals($old_contact_id, $this->_individualId
, 'In line ' . __LINE__
);
400 $this->assertEquals($old_frequency_unit, 'year', 'In line ' . __LINE__
);
401 $this->assertEquals($old_frequency_interval, 5, 'In line ' . __LINE__
);
402 $this->assertEquals($old_status_id, 'Pending', 'In line ' . __LINE__
);
405 'contact_id' => $this->_individualId
,
406 'pledge_status_id' => 3,
408 'financial_type_id' => 1,
409 'start_date' => date('Ymd'),
410 'installments' => 10,
413 $pledge = $this->callAPISuccess('pledge', 'create', $params);
415 'id' => $pledge['id'],
417 $pledge = $this->callAPISuccess('pledge', 'get', $new_params);
418 $this->assertEquals($pledge['values'][$pledgeID]['contact_id'], $this->_individualId
, 'In line ' . __LINE__
);
419 $this->assertEquals($pledge['values'][$pledgeID]['pledge_status'], 'Cancelled', 'In line ' . __LINE__
);
420 $pledge = $this->callAPISuccess('pledge', 'delete', $new_params);
424 * Here we ensure we are maintaining our 'contract' & supporting previously working syntax
425 * ie contribution_type_id
427 public function testCreateUpdatePledgeLegacy() {
429 // we test 'sequential' param here too
430 $pledgeID = $this->pledgeCreate($this->_individualId
);
435 $original = $this->callAPISuccess('pledge', 'get', $old_params);
436 //Make sure it came back
437 $this->assertEquals($original['values'][0]['pledge_id'], $pledgeID, 'In line ' . __LINE__
);
438 //set up list of old params, verify
439 $old_contact_id = $original['values'][0]['contact_id'];
440 $old_frequency_unit = $original['values'][0]['pledge_frequency_unit'];
441 $old_frequency_interval = $original['values'][0]['pledge_frequency_interval'];
442 $old_status_id = $original['values'][0]['pledge_status'];
444 //check against values in CiviUnitTestCase::createPledge()
445 $this->assertEquals($old_contact_id, $this->_individualId
, 'In line ' . __LINE__
);
446 $this->assertEquals($old_frequency_unit, 'year', 'In line ' . __LINE__
);
447 $this->assertEquals($old_frequency_interval, 5, 'In line ' . __LINE__
);
448 $this->assertEquals($old_status_id, 'Pending', 'In line ' . __LINE__
);
451 'contact_id' => $this->_individualId
,
452 'pledge_status_id' => 3,
454 'contribution_type_id' => 1,
455 'start_date' => date('Ymd'),
456 'installments' => 10,
459 $pledge = $this->callAPISuccess('pledge', 'create', $params);
461 'id' => $pledge['id'],
463 $pledge = $this->callAPISuccess('pledge', 'get', $new_params);
464 $this->assertEquals($pledge['values'][$pledgeID]['contact_id'], $this->_individualId
, 'In line ' . __LINE__
);
465 $this->assertEquals($pledge['values'][$pledgeID]['pledge_status'], 'Cancelled', 'In line ' . __LINE__
);
466 $pledge = $this->callAPISuccess('pledge', 'delete', $new_params);
469 public function testDeleteEmptyParamsPledge() {
470 $pledge = $this->callAPIFailure('pledge', 'delete', array(), 'Mandatory key(s) missing from params array: id');
474 public function testDeleteWrongParamPledge() {
476 'pledge_source' => 'SSF',
478 $pledge = $this->callAPIFailure('pledge', 'delete', $params, 'Mandatory key(s) missing from params array: id');
482 * Legacy support for pledge_id
484 public function testDeletePledge() {
486 $pledgeID = $this->pledgeCreate($this->_individualId
);
488 'pledge_id' => $pledgeID,
490 $result = $this->callAPIAndDocument('pledge', 'delete', $params, __FUNCTION__
, __FILE__
);
494 * Std is to accept id
496 public function testDeletePledgeUseID() {
498 $pledgeID = $this->pledgeCreate($this->_individualId
);
502 $result = $this->callAPIAndDocument('pledge', 'delete', $params, __FUNCTION__
, __FILE__
);
506 * Test to make sure empty get returns nothing
507 * Note that the function gives incorrect results if no pledges exist as it does a
508 * contact search instead - test only checks that the get finds the one existing
510 public function testGetEmpty() {
511 $result = $this->callAPISuccess('pledge', 'create', $this->_params
);
512 $result = $this->callAPISuccess('pledge', 'get', array());
513 $this->assertAPISuccess($result, "This test is failing because it's acting like a contact get when no params set. Not sure the fix");
514 $this->assertEquals(1, $result['count'], 'in line ' . __LINE__
);
515 $pledgeID = array('id' => $result['id']);
516 $pledge = $this->callAPISuccess('pledge', 'delete', $pledgeID);