3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.5 |
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 APIv3 civicrm_contribute_* functions
33 * @package CiviCRM_APIv3
34 * @subpackage API_ContributionSoft
37 class api_v3_ContributionSoftTest
extends CiviUnitTestCase
{
40 * Assume empty database with just civicrm_data
42 protected $_individualId; //the hard credit contact
43 protected $_softIndividual1Id; //the first soft credit contact
44 protected $_softIndividual2Id; //the second soft credit contact
45 protected $_contributionId;
46 protected $_financialTypeId = 1;
47 protected $_apiversion = 3;
48 protected $_entity = 'Contribution';
56 $this->_individualId
= $this->individualCreate();
57 $this->_softIndividual1Id
= $this->individualCreate();
58 $this->_softIndividual2Id
= $this->individualCreate();
59 $this->_contributionId
= $this->contributionCreate($this->_individualId
);
61 $paymentProcessor = $this->processorCreate();
62 $this->_params
= array(
63 'contact_id' => $this->_individualId
,
64 'receive_date' => '20120511',
65 'total_amount' => 100.00,
66 'financial_type_id' => $this->_financialTypeId
,
67 'non_deductible_amount' => 10.00,
69 'net_amount' => 95.00,
71 'contribution_status_id' => 1,
73 $this->_processorParams
= array(
76 'payment_processor_type_id' => 10,
77 'financial_account_id' => 12,
80 'url_site' => 'http://dummy.com',
81 'url_recur' => 'http://dummy.com',
87 $this->quickCleanup(array(
88 'civicrm_contribution',
90 'civicrm_contribution_page',
91 'civicrm_participant',
92 'civicrm_participant_payment',
94 'civicrm_financial_trxn',
95 'civicrm_financial_item',
96 'civicrm_entity_financial_trxn',
98 'civicrm_contribution_soft'
104 * @todo - this might be better broken down into more smaller tests
106 function testGetContributionSoft() {
107 //We don't test for PCP fields because there's no PCP API, so we can't create campaigns.
109 'contribution_id' => $this->_contributionId
,
110 'contact_id' => $this->_softIndividual1Id
,
113 'soft_credit_type_id' => 4,
116 $this->_softcontribution
= $this->callAPISuccess('contribution_soft', 'create', $p);
118 'id' => $this->_softcontribution
['id'],
120 $softcontribution = $this->callAPIAndDocument('contribution_soft', 'get', $params, __FUNCTION__
, __FILE__
);
121 $this->assertEquals(1, $softcontribution['count']);
122 $this->assertEquals($softcontribution['values'][$this->_softcontribution
['id']]['contribution_id'], $this->_contributionId
, 'In line ' . __LINE__
);
123 $this->assertEquals($softcontribution['values'][$this->_softcontribution
['id']]['contact_id'], $this->_softIndividual1Id
, 'In line ' . __LINE__
);
124 $this->assertEquals($softcontribution['values'][$this->_softcontribution
['id']]['amount'], '10.00', 'In line ' . __LINE__
);
125 $this->assertEquals($softcontribution['values'][$this->_softcontribution
['id']]['currency'], 'USD', 'In line ' . __LINE__
);
126 $this->assertEquals($softcontribution['values'][$this->_softcontribution
['id']]['soft_credit_type_id'], 4, 'In line ' . __LINE__
);
128 //create a second soft contribution on the same hard contribution - we are testing that 'id' gets the right soft contribution id (not the contribution id)
129 $p['contact_id'] = $this->_softIndividual2Id
;
130 $this->_softcontribution2
= $this->callAPISuccess('contribution_soft', 'create', $p);
132 // now we have 2 - test getcount
133 $softcontribution = $this->callAPISuccess('contribution_soft', 'getcount', array());
134 $this->assertEquals(2, $softcontribution);
136 //check first contribution
137 $result = $this->callAPISuccess('contribution_soft', 'get', array(
138 'id' => $this->_softcontribution
['id'],
140 $this->assertEquals(1, $result['count'], 'In line ' . __LINE__
);
141 $this->assertEquals($this->_softcontribution
['id'], $result['id']);
142 $this->assertEquals($this->_softcontribution
['id'], $result['id'], print_r($softcontribution,true));
144 //test id only format - second soft credit
145 $resultID2 = $this->callAPISuccess('contribution_soft', 'get', array(
146 'id' => $this->_softcontribution2
['id'],
147 'format.only_id' => 1,
149 $this->assertEquals($this->_softcontribution2
['id'], $resultID2);
151 //test get by contact id works
152 $result = $this->callAPISuccess('contribution_soft', 'get', array(
153 'contact_id' => $this->_softIndividual2Id
)
155 $this->assertEquals(1, $result['count'], 'In line ' . __LINE__
);
157 $this->callAPISuccess('contribution_soft', 'Delete', array(
158 'id' => $this->_softcontribution
['id'],
160 // check one soft credit remains
162 $this->callAPISuccess('contribution_soft', 'getcount', array(), $expectedCount);
164 //check id is same as 2
165 $this->assertEquals($this->_softcontribution2
['id'], $this->callAPISuccess('contribution_soft', 'getvalue', array('return' => 'id' )));
167 $this->callAPISuccess('ContributionSoft', 'Delete', array(
168 'id' => $this->_softcontribution2
['id'],
173 ///////////////// civicrm_contribution_soft
174 function testCreateEmptyParamsContributionSoft() {
175 $softcontribution = $this->callAPIFailure('contribution_soft', 'create', array(),
176 'Mandatory key(s) missing from params array: contribution_id, amount, contact_id'
180 function testCreateParamsWithoutRequiredKeysContributionSoft() {
181 $softcontribution = $this->callAPIFailure('contribution_soft', 'create', array(),
182 'Mandatory key(s) missing from params array: contribution_id, amount, contact_id'
186 function testCreateContributionSoftInvalidContact() {
190 'contribution_id' => $this->_contributionId
,
195 $softcontribution = $this->callAPIFailure('contribution_soft', 'create', $params,
196 'contact_id is not valid : 999'
200 function testCreateContributionSoftInvalidContributionId() {
203 'contribution_id' => 999999,
204 'contact_id' => $this->_softIndividual1Id
,
209 $softcontribution = $this->callAPIFailure('contribution_soft', 'create', $params,
210 'contribution_id is not valid : 999999'
215 * Function tests that additional financial records are created when fee amount is recorded
217 function testCreateContributionSoft() {
219 'contribution_id' => $this->_contributionId
,
220 'contact_id' => $this->_softIndividual1Id
,
223 'soft_credit_type_id' => 5,
226 $softcontribution = $this->callAPIAndDocument('contribution_soft', 'create', $params, __FUNCTION__
, __FILE__
);
227 $this->assertEquals($softcontribution['values'][$softcontribution['id']]['contribution_id'], $this->_contributionId
, 'In line ' . __LINE__
);
228 $this->assertEquals($softcontribution['values'][$softcontribution['id']]['contact_id'], $this->_softIndividual1Id
, 'In line ' . __LINE__
);
229 $this->assertEquals($softcontribution['values'][$softcontribution['id']]['amount'], '10.00', 'In line ' . __LINE__
);
230 $this->assertEquals($softcontribution['values'][$softcontribution['id']]['currency'], 'USD', 'In line ' . __LINE__
);
231 $this->assertEquals($softcontribution['values'][$softcontribution['id']]['soft_credit_type_id'], 5, 'In line ' . __LINE__
);
234 //To Update Soft Contribution
235 function testCreateUpdateContributionSoft() {
236 //create a soft credit
238 'contribution_id' => $this->_contributionId
,
239 'contact_id' => $this->_softIndividual1Id
,
242 'soft_credit_type_id' => 6,
245 $softcontribution = $this->callAPISuccess('contribution_soft', 'create', $params);
246 $softcontributionID = $softcontribution['id'];
249 'contribution_soft_id' => $softcontributionID,
251 $original = $this->callAPISuccess('contribution_soft', 'get', $old_params);
252 //Make sure it came back
253 $this->assertEquals($original['id'], $softcontributionID, 'In line ' . __LINE__
);
254 //set up list of old params, verify
255 $old_contribution_id = $original['values'][$softcontributionID]['contribution_id'];
256 $old_contact_id = $original['values'][$softcontributionID]['contact_id'];
257 $old_amount = $original['values'][$softcontributionID]['amount'];
258 $old_currency = $original['values'][$softcontributionID]['currency'];
259 $old_soft_credit_type_id = $original['values'][$softcontributionID]['soft_credit_type_id'];
261 //check against original values
262 $this->assertEquals($old_contribution_id, $this->_contributionId
, 'In line ' . __LINE__
);
263 $this->assertEquals($old_contact_id, $this->_softIndividual1Id
, 'In line ' . __LINE__
);
264 $this->assertEquals($old_amount, 10.00, 'In line ' . __LINE__
);
265 $this->assertEquals($old_currency, 'USD', 'In line ' . __LINE__
);
266 $this->assertEquals($old_soft_credit_type_id, 6 , 'In line ' . __LINE__
);
268 'id' => $softcontributionID,
269 'contribution_id' => $this->_contributionId
,
270 'contact_id' => $this->_softIndividual1Id
,
273 'soft_credit_type_id' => 7,
276 $softcontribution = $this->callAPISuccess('contribution_soft', 'create', $params);
279 'id' => $softcontribution['id'],
281 $softcontribution = $this->callAPISuccess('contribution_soft', 'get', $new_params);
282 //check against original values
283 $this->assertEquals($softcontribution['values'][$softcontributionID]['contribution_id'], $this->_contributionId
, 'In line ' . __LINE__
);
284 $this->assertEquals($softcontribution['values'][$softcontributionID]['contact_id'], $this->_softIndividual1Id
, 'In line ' . __LINE__
);
285 $this->assertEquals($softcontribution['values'][$softcontributionID]['amount'], 7.00, 'In line ' . __LINE__
);
286 $this->assertEquals($softcontribution['values'][$softcontributionID]['currency'], 'CAD', 'In line ' . __LINE__
);
287 $this->assertEquals($softcontribution['values'][$softcontributionID]['soft_credit_type_id'], 7, 'In line ' . __LINE__
);
290 'id' => $softcontributionID,
292 $result = $this->callAPISuccess('contribution_soft', 'delete', $params);
295 ///////////////// civicrm_contribution_soft_delete methods
296 function testDeleteEmptyParamsContributionSoft() {
298 $softcontribution = $this->callAPIFailure('contribution_soft', 'delete', $params);
301 function testDeleteWrongParamContributionSoft() {
303 'contribution_source' => 'SSF',
305 $softcontribution = $this->callAPIFailure('contribution_soft', 'delete', $params);
308 function testDeleteContributionSoft() {
309 //create a soft credit
311 'contribution_id' => $this->_contributionId
,
312 'contact_id' => $this->_softIndividual1Id
,
317 $softcontribution = $this->callAPISuccess('contribution_soft', 'create', $params);
318 $softcontributionID = $softcontribution['id'];
320 'id' => $softcontributionID,
322 $result = $this->callAPIAndDocument('contribution_soft', 'delete', $params, __FUNCTION__
, __FILE__
);
325 ///////////////// civicrm_contribution_search methods
328 * Test civicrm_contribution_search with empty params.
329 * All available contributions expected.
331 function testSearchEmptyParams() {
333 'contribution_id' => $this->_contributionId
,
334 'contact_id' => $this->_softIndividual1Id
,
338 $softcontribution = $this->callAPISuccess('contribution_soft', 'create', $p);
340 $result = $this->callAPISuccess('contribution_soft', 'get', array());
341 // We're taking the first element.
342 $res = $result['values'][$softcontribution['id']];
344 $this->assertEquals($p['contribution_id'], $res['contribution_id'], 'In line ' . __LINE__
);
345 $this->assertEquals($p['contact_id'], $res['contact_id'], 'In line ' . __LINE__
);
346 $this->assertEquals($p['amount'], $res['amount'], 'In line ' . __LINE__
);
347 $this->assertEquals($p['currency'], $res['currency'], 'In line ' . __LINE__
);
351 * Test civicrm_contribution_soft_search. Success expected.
353 function testSearch() {
355 'contribution_id' => $this->_contributionId
,
356 'contact_id' => $this->_softIndividual1Id
,
360 $softcontribution1 = $this->callAPISuccess('contribution_soft', 'create', $p1);
363 'contribution_id' => $this->_contributionId
,
364 'contact_id' => $this->_softIndividual2Id
,
368 $softcontribution2 = $this->callAPISuccess('contribution_soft', 'create', $p2);
371 'id' => $softcontribution2['id'],
373 $result = $this->callAPISuccess('contribution_soft', 'get', $params);
374 $res = $result['values'][$softcontribution2['id']];
376 $this->assertEquals($p2['contribution_id'], $res['contribution_id'], 'In line ' . __LINE__
);
377 $this->assertEquals($p2['contact_id'], $res['contact_id'], 'In line ' . __LINE__
);
378 $this->assertEquals($p2['amount'], $res['amount'], 'In line ' . __LINE__
);
379 $this->assertEquals($p2['currency'], $res['currency'], 'In line ' . __LINE__
);