INFRA-132 - Remove extra newlines from the bottom of docblocks
[civicrm-core.git] / tests / phpunit / api / v3 / PledgeTest.php
1 <?php
2 /*
3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.6 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2014 |
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 +--------------------------------------------------------------------+
26 */
27
28 require_once 'CiviTest/CiviUnitTestCase.php';
29
30 /**
31 * Test class for Pledge API - civicrm_pledge_*
32 *
33 * @package CiviCRM_APIv3
34 */
35 class api_v3_PledgeTest extends CiviUnitTestCase {
36
37 /**
38 * Assume empty database with just civicrm_data
39 */
40 protected $_individualId;
41 protected $_pledge;
42 protected $_apiversion;
43 protected $_params;
44 protected $_entity;
45 protected $scheduled_date;
46 public $DBResetRequired = TRUE;
47
48 public function setUp() {
49 $this->_apiversion = 3;
50 parent::setUp();
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,
62 'amount' => 100.00,
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,
69 'installments' => 5,
70 'sequential' => 1,
71 );
72 }
73
74 public function tearDown() {
75 $this->contactDelete($this->_individualId);
76 }
77
78 ///////////////// civicrm_pledge_get methods
79
80 /**
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
85 */
86 public function testCreateWithCustom() {
87 $ids = $this->entityCustomGroupWithSingleFieldCreate(__FUNCTION__, __FILE__);
88
89 $params = $this->_params;
90 $params['custom_' . $ids['custom_field_id']] = "custom string";
91
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__);
99
100 $this->customFieldDelete($ids['custom_field_id']);
101 $this->customGroupDelete($ids['custom_group_id']);
102 }
103
104 /*
105 */
106 public function testgetfieldspledge() {
107 $result = $this->callAPISuccess('pledge', 'getfields', array('action' => 'get'));
108 $this->assertEquals(1, $result['values']['next_pay_date']['api.return']);
109 }
110
111 public function testGetPledge() {
112
113 $this->_pledge = $this->callAPISuccess('pledge', 'create', $this->_params);
114 $params = array(
115 'pledge_id' => $this->_pledge['id'],
116 );
117 $result = $this->callAPIAndDocument('pledge', 'get', $params, __FUNCTION__, __FILE__);
118 $pledge = $result['values'][$this->_pledge['id']];
119 $this->assertEquals($this->_individualId, $pledge['contact_id'], 'in line' . __LINE__);
120 $this->assertEquals($this->_pledge['id'], $pledge['pledge_id'], 'in line' . __LINE__);
121 $this->assertEquals(date('Y-m-d') . ' 00:00:00', $pledge['pledge_create_date'], 'in line' . __LINE__);
122 $this->assertEquals(100.00, $pledge['pledge_amount'], 'in line' . __LINE__);
123 $this->assertEquals('Pending', $pledge['pledge_status'], 'in line' . __LINE__);
124 $this->assertEquals(5, $pledge['pledge_frequency_interval'], 'in line' . __LINE__);
125 $this->assertEquals('year', $pledge['pledge_frequency_unit'], 'in line' . __LINE__);
126 $this->assertEquals(date('Y-m-d', strtotime($this->scheduled_date)) . ' 00:00:00', $pledge['pledge_next_pay_date'], 'in line' . __LINE__);
127 $this->assertEquals($pledge['pledge_next_pay_amount'], 20.00, 'in line' . __LINE__);
128
129 $params2 = array(
130 'pledge_id' => $this->_pledge['id'],);
131 $pledge = $this->callAPISuccess('pledge', 'delete', $params2);
132 }
133 /**
134 * Test 'return.pledge_financial_type' => 1 works
135 */
136 public function testGetPledgewithReturn() {
137
138 $this->_pledge = $this->callAPISuccess('pledge', 'create', $this->_params);
139 $params = array(
140 'pledge_id' => $this->_pledge['id'],
141 'return.pledge_financial_type' => 1,
142 );
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']);
147 }
148 /**
149 * Test 'return.pledge_contribution_type' => 1 works
150 * This is for legacy compatibility
151 */
152 public function testGetPledgewithReturnLegacy() {
153
154 $this->_pledge = $this->callAPISuccess('pledge', 'create', $this->_params);
155 $params = array(
156 'pledge_id' => $this->_pledge['id'],
157 'return.pledge_financial_type' => 1,
158 );
159 $result = $this->callAPISuccess('pledge', 'get', $params);
160 $pledge = $result['values'][$this->_pledge['id']];
161 $this->callAPISuccess('pledge', 'delete', $pledge);
162 $this->assertEquals('Donation', $pledge['pledge_financial_type']);
163 }
164
165 public function testPledgeGetReturnFilters() {
166 $oldPledge = $this->callAPISuccess('pledge', 'create', $this->_params);
167
168 $overdueParams = array(
169 'scheduled_date' => 'first saturday of march last year',
170 'start_date' => 'first saturday of march last year',
171 );
172 $oldPledge = $this->callAPISuccess('pledge', 'create', array_merge($this->_params, $overdueParams));
173
174 $pledgeGetParams = array();
175 $allPledges = $this->callAPISuccess('pledge', 'getcount', $pledgeGetParams);
176
177 $this->assertEquals(2, $allPledges, 'Check we have 2 pledges to place with in line ' . __LINE__);
178 $pledgeGetParams['pledge_start_date_high'] = date('YmdHis', strtotime('2 days ago'));
179 $earlyPledge = $this->callAPIAndDocument('pledge', 'get', $pledgeGetParams, __FUNCTION__, __FILE__, "demonstrates high date filter", "GetFilterHighDate");
180 $this->assertEquals(1, $earlyPledge['count'], ' check only one returned with start date filter in line ' . __LINE__);
181 $this->assertEquals($oldPledge['id'], $earlyPledge['id'], ' check correct pledge returned ' . __LINE__);
182 }
183 /*
184 * create 2 pledges - see if we can get by status id
185 */
186 public function testGetOverduePledge() {
187 $overdueParams = array(
188 'scheduled_date' => 'first saturday of march last year',
189 'start_date' => 'first saturday of march last year',
190 );
191 $this->_pledge = $this->callAPISuccess('pledge', 'create', array_merge($this->_params, $overdueParams));
192 $params = array( 'pledge_status_id' => '6',
193 );
194 $result = $this->callAPISuccess('pledge', 'get', $params);
195 $emptyResult = $this->callAPISuccess('pledge', 'get', array( 'pledge_status_id' => '1',
196 ));
197 $pledge = $result['values'][$this->_pledge['id']];
198 $this->callAPISuccess('pledge', 'delete', $pledge);
199 $this->assertEquals(1, $result['count']);
200 $this->assertEquals(0, $emptyResult['count']);
201 }
202
203
204 /*
205 * create 2 pledges - see if we can get by status id
206 */
207 public function testSortParamPledge() {
208 $pledge1 = $this->callAPISuccess('pledge', 'create', $this->_params);
209 $overdueParams = array(
210 'scheduled_date' => 'first saturday of march last year',
211 'start_date' => 'first saturday of march last year',
212 'create_date' => 'first saturday of march last year',
213 );
214 $pledge2 = $this->callAPISuccess('pledge', 'create', array_merge($this->_params, $overdueParams));
215 $params = array(
216 'pledge_is_test' => 0,
217 'rowCount' => 1,
218 );
219 $result = $this->callAPISuccess('pledge', 'get', $params);
220
221 $resultSortedAsc = $this->callAPISuccess('pledge', 'get', array(
222 'rowCount' => 1,
223 'sort' => 'start_date ASC',
224 ));
225 $resultSortedDesc = $this->callAPISuccess('pledge', 'get', array(
226 'rowCount' => 1,
227 'sort' => 'start_date DESC',
228 ));
229
230 $this->assertEquals($pledge1['id'], $result['id'], 'pledge get gets first created pledge in line ' . __LINE__);
231 $this->assertEquals($pledge2['id'], $resultSortedAsc['id'], 'Ascending pledge sort works');
232 $this->assertEquals($pledge1['id'], $resultSortedDesc['id'], 'Decending pledge sort works');
233 $this->callAPISuccess('pledge', 'delete', array('id' => $pledge1['id']));
234 $this->callAPISuccess('pledge', 'delete', array('id' => $pledge2['id']));
235 }
236
237 public function testCreatePledge() {
238
239 $result = $this->callAPIAndDocument('pledge', 'create', $this->_params, __FUNCTION__, __FILE__);
240 $this->assertEquals($result['values'][0]['amount'], 100.00, 'In line ' . __LINE__);
241 $this->assertEquals($result['values'][0]['installments'], 5, 'In line ' . __LINE__);
242 $this->assertEquals($result['values'][0]['frequency_unit'], 'year', 'In line ' . __LINE__);
243 $this->assertEquals($result['values'][0]['frequency_interval'], 5, 'In line ' . __LINE__);
244 $this->assertEquals($result['values'][0]['frequency_day'], 15, 'In line ' . __LINE__);
245 $this->assertEquals($result['values'][0]['original_installment_amount'], 20, 'In line ' . __LINE__);
246 $this->assertEquals($result['values'][0]['status_id'], 2, 'In line ' . __LINE__);
247 $this->assertEquals($result['values'][0]['create_date'], date('Ymd') . '000000', 'In line ' . __LINE__);
248 $this->assertEquals($result['values'][0]['start_date'], date('Ymd') . '000000', 'In line ' . __LINE__);
249 $this->assertAPISuccess($result, 'In line ' . __LINE__);
250 $payments = $this->callAPISuccess('PledgePayment', 'Get', array('pledge_id' => $result['id'], 'sequential' => 1));
251 $this->assertAPISuccess($payments, 'In line ' . __LINE__);
252 $this->assertEquals($payments['count'], 5, 'In line ' . __LINE__);
253 require_once 'CRM/Utils/Date.php';
254 $shouldBeDate = CRM_Utils_Date::format(CRM_Utils_Date::intervalAdd('year', 5 * 4, $this->scheduled_date), "-");
255 $this->assertEquals(substr($shouldBeDate, 0, 10), substr($payments['values'][4]['scheduled_date'], 0, 10), 'In line ' . __LINE__);
256
257 $pledgeID = array('id' => $result['id']);
258 $pledge = $this->callAPISuccess('pledge', 'delete', $pledgeID);
259 }
260
261 /*
262 * Test that pledge with weekly schedule calculates dates correctly
263 */
264 public function testCreatePledgeWeeklySchedule() {
265 $params = array(
266 'scheduled_date' => '20110510',
267 'frequency_unit' => 'week',
268 'frequency_day' => 3,
269 'frequency_interval' => 2,
270 );
271 $params = array_merge($this->_params, $params);
272 $pledge = $this->callAPISuccess('Pledge', 'Create', $params);
273 //ensure that correct number of payments created & last payment has the right date
274 $payments = $this->callAPISuccess('PledgePayment', 'Get', array(
275 'pledge_id' => $pledge['id'],
276 'sequential' => 1));
277 $this->assertEquals($payments['count'], 5, 'In line ' . __LINE__);
278 $this->assertEquals('2011-07-06 00:00:00', $payments['values'][4]['scheduled_date'], 'In line ' . __LINE__);
279
280 $this->callAPISuccess('pledge', 'delete', array('pledge_id' => $pledge['id']));
281 }
282 /*
283 * Test that pledge with weekly schedule calculates dates correctly
284 */
285 public function testCreatePledgeMontlySchedule() {
286 $params = array(
287 'scheduled_date' => '20110510',
288 'frequency_unit' => 'Month',
289 'frequency_day' => 3,
290 'frequency_interval' => 2,
291 );
292 $params = array_merge($this->_params, $params);
293 $apiResult = $this->callAPISuccess('pledge', 'create', $params);
294 }
295
296
297 /**
298 * Test creation of pledge with only one payment.
299 *
300 * Pledge status id left empty as it is not a required field
301 * http://issues.civicrm.org/jira/browse/CRM-8551
302 */
303 public function testCreatePledgeSinglePayment() {
304 $params = array(
305 'scheduled_date' => '20110510',
306 'frequency_unit' => 'week',
307 'frequency_day' => 3,
308 'frequency_interval' => 2,
309 'installments' => 1,
310 );
311
312 $params = array_merge($this->_params, $params);
313 unset($params['pledge_status_id']);
314 $pledge = $this->callAPISuccess('Pledge', 'Create', $params);
315 //ensure that correct number of payments created & last payment has the right date
316 $payments = $this->callAPISuccess('PledgePayment', 'Get', array(
317 'pledge_id' => $pledge['id'],
318 'sequential' => 1,
319 ));
320 $this->assertEquals(1, $payments['count'], 'In line ' . __LINE__);
321 $this->assertEquals(2, $payments['values'][0]['status_id'], 'In line ' . __LINE__);
322 $pledgeID = array('id' => $pledge['id']);
323 $pledge = $this->callAPISuccess('pledge', 'delete', $pledgeID);
324 }
325
326 /*
327 * test that using original_installment_amount rather than pledge_original_installment_amount works
328 * Pledge field behaviour is a bit random & so pledge has come to try to handle both unique & non -unique fields
329 */
330 public function testCreatePledgeWithNonUnique() {
331 $params = $this->_params;
332 $params['original_installment_amount'] = $params['pledge_original_installment_amount'];
333
334 unset($params['pledge_original_installment_amount']);
335 $result = $this->callAPISuccess('pledge', 'create', $params);
336 $pledgeDetails = $this->callAPISuccess('Pledge', 'Get', array('id' => $result['id'], 'sequential' => 1));
337 $pledge = $pledgeDetails['values'][0];
338 $this->assertEquals(100.00, $pledge['pledge_amount'], 'In line ' . __LINE__);
339 $this->assertEquals('year', $pledge['pledge_frequency_unit'], 'In line ' . __LINE__);
340 $this->assertEquals(5, $pledge['pledge_frequency_interval'], 'In line ' . __LINE__);
341 $this->assertEquals(20, $pledge['pledge_next_pay_amount'], 'In line ' . __LINE__);
342
343 $pledgeID = array('id' => $result['id']);
344 $pledge = $this->callAPISuccess('pledge', 'delete', $pledgeID);
345 }
346
347 public function testCreateCancelPledge() {
348
349 $result = $this->callAPISuccess('pledge', 'create', $this->_params);
350 $this->assertEquals(2, $result['values'][0]['status_id'], "in line " . __LINE__);
351 $cancelparams = array('sequential' => 1, 'id' => $result['id'], 'pledge_status_id' => 3);
352 $result = $this->callAPISuccess('pledge', 'create', $cancelparams);
353 $this->assertEquals(3, $result['values'][0]['status_id'], "in line " . __LINE__);
354 $pledgeID = array('id' => $result['id']);
355 $pledge = $this->callAPISuccess('pledge', 'delete', $pledgeID);
356 }
357
358 /**
359 * Test that status is set to pending
360 */
361 public function testCreatePledgeNoStatus() {
362
363 $params = $this->_params;
364 unset($params['status_id']);
365 unset($params['pledge_status_id']);
366 $result = $this->callAPISuccess('pledge', 'create', $params);
367 $this->assertAPISuccess($result, "in line " . __LINE__);
368 $this->assertEquals(2, $result['values'][0]['status_id'], "in line " . __LINE__);
369 $pledgeID = array('pledge_id' => $result['id']);
370 $pledge = $this->callAPISuccess('pledge', 'delete', $pledgeID);
371 }
372
373 /**
374 * Update Pledge
375 */
376 public function testCreateUpdatePledge() {
377 // we test 'sequential' param here too
378 $pledgeID = $this->pledgeCreate($this->_individualId);
379 $old_params = array(
380 'id' => $pledgeID,
381 'sequential' => 1,);
382 $original = $this->callAPISuccess('pledge', 'get', $old_params);
383 //Make sure it came back
384 $this->assertEquals($original['values'][0]['pledge_id'], $pledgeID, 'In line ' . __LINE__);
385 //set up list of old params, verify
386 $old_contact_id = $original['values'][0]['contact_id'];
387 $old_frequency_unit = $original['values'][0]['pledge_frequency_unit'];
388 $old_frequency_interval = $original['values'][0]['pledge_frequency_interval'];
389 $old_status_id = $original['values'][0]['pledge_status'];
390
391 //check against values in CiviUnitTestCase::createPledge()
392 $this->assertEquals($old_contact_id, $this->_individualId, 'In line ' . __LINE__);
393 $this->assertEquals($old_frequency_unit, 'year', 'In line ' . __LINE__);
394 $this->assertEquals($old_frequency_interval, 5, 'In line ' . __LINE__);
395 $this->assertEquals($old_status_id, 'Pending', 'In line ' . __LINE__);
396 $params = array(
397 'id' => $pledgeID,
398 'contact_id' => $this->_individualId,
399 'pledge_status_id' => 3,
400 'amount' => 100,
401 'financial_type_id' => 1,
402 'start_date' => date('Ymd'),
403 'installments' => 10,);
404
405 $pledge = $this->callAPISuccess('pledge', 'create', $params);
406 $new_params = array(
407 'id' => $pledge['id'],
408 );
409 $pledge = $this->callAPISuccess('pledge', 'get', $new_params);
410 $this->assertEquals($pledge['values'][$pledgeID]['contact_id'], $this->_individualId, 'In line ' . __LINE__);
411 $this->assertEquals($pledge['values'][$pledgeID]['pledge_status'], 'Cancelled', 'In line ' . __LINE__);
412 $pledge = $this->callAPISuccess('pledge', 'delete', $new_params);
413 }
414
415 /**
416 * Here we ensure we are maintaining our 'contract' & supporting previously working syntax
417 * ie contribution_type_id
418 */
419 public function testCreateUpdatePledgeLegacy() {
420
421 // we test 'sequential' param here too
422 $pledgeID = $this->pledgeCreate($this->_individualId);
423 $old_params = array(
424 'id' => $pledgeID,
425 'sequential' => 1,);
426 $original = $this->callAPISuccess('pledge', 'get', $old_params);
427 //Make sure it came back
428 $this->assertEquals($original['values'][0]['pledge_id'], $pledgeID, 'In line ' . __LINE__);
429 //set up list of old params, verify
430 $old_contact_id = $original['values'][0]['contact_id'];
431 $old_frequency_unit = $original['values'][0]['pledge_frequency_unit'];
432 $old_frequency_interval = $original['values'][0]['pledge_frequency_interval'];
433 $old_status_id = $original['values'][0]['pledge_status'];
434
435 //check against values in CiviUnitTestCase::createPledge()
436 $this->assertEquals($old_contact_id, $this->_individualId, 'In line ' . __LINE__);
437 $this->assertEquals($old_frequency_unit, 'year', 'In line ' . __LINE__);
438 $this->assertEquals($old_frequency_interval, 5, 'In line ' . __LINE__);
439 $this->assertEquals($old_status_id, 'Pending', 'In line ' . __LINE__);
440 $params = array(
441 'id' => $pledgeID,
442 'contact_id' => $this->_individualId,
443 'pledge_status_id' => 3,
444 'amount' => 100,
445 'contribution_type_id' => 1,
446 'start_date' => date('Ymd'),
447 'installments' => 10,
448 );
449
450 $pledge = $this->callAPISuccess('pledge', 'create', $params);
451 $new_params = array(
452 'id' => $pledge['id'],
453 );
454 $pledge = $this->callAPISuccess('pledge', 'get', $new_params);
455 $this->assertEquals($pledge['values'][$pledgeID]['contact_id'], $this->_individualId, 'In line ' . __LINE__);
456 $this->assertEquals($pledge['values'][$pledgeID]['pledge_status'], 'Cancelled', 'In line ' . __LINE__);
457 $pledge = $this->callAPISuccess('pledge', 'delete', $new_params);
458 }
459
460 ///////////////// civicrm_pledge_delete methods
461 public function testDeleteEmptyParamsPledge() {
462 $pledge = $this->callAPIFailure('pledge', 'delete', array(), 'Mandatory key(s) missing from params array: id');
463 }
464
465
466 public function testDeleteWrongParamPledge() {
467 $params = array(
468 'pledge_source' => 'SSF',
469 );
470 $pledge = $this->callAPIFailure('pledge', 'delete', $params, 'Mandatory key(s) missing from params array: id');
471 }
472
473 /**
474 * Legacy support for pledge_id
475 */
476 public function testDeletePledge() {
477
478 $pledgeID = $this->pledgeCreate($this->_individualId);
479 $params = array(
480 'pledge_id' => $pledgeID,
481 );
482 $result = $this->callAPIAndDocument('pledge', 'delete', $params, __FUNCTION__, __FILE__);
483 }
484
485 /**
486 * Std is to accept id
487 */
488 public function testDeletePledgeUseID() {
489
490 $pledgeID = $this->pledgeCreate($this->_individualId);
491 $params = array(
492 'id' => $pledgeID,
493 );
494 $result = $this->callAPIAndDocument('pledge', 'delete', $params, __FUNCTION__, __FILE__);
495 }
496
497 /**
498 * Test to make sure empty get returns nothing
499 * Note that the function gives incorrect results if no pledges exist as it does a
500 * contact search instead - test only checks that the get finds the one existing
501 */
502 public function testGetEmpty() {
503 $result = $this->callAPISuccess('pledge', 'create', $this->_params);
504 $result = $this->callAPISuccess('pledge', 'get', array());
505 $this->assertAPISuccess($result, "This test is failing because it's acting like a contact get when no params set. Not sure the fix");
506 $this->assertEquals(1, $result['count'], 'in line ' . __LINE__);
507 $pledgeID = array('id' => $result['id']);
508 $pledge = $this->callAPISuccess('pledge', 'delete', $pledgeID);
509 }
510 }