tests/phpunit/api/v3/ContributionTest.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.3                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2013                                |
   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 require_once 'CiviTest/CiviMailUtils.php';
  30
  31
  32 /**
  33  *  Test APIv3 civicrm_contribute_* functions
  34  *
  35  *  @package CiviCRM_APIv3
  36  *  @subpackage API_Contribution
  37  */
  38
  39 class api_v3_ContributionTest extends CiviUnitTestCase {
  40
  41   /**
  42    * Assume empty database with just civicrm_data
  43    */
  44   protected $_individualId;
  45   protected $_contribution;
  46   protected $_contributionTypeId = 1;
  47   protected $_apiversion;
  48   protected $_entity = 'Contribution';
  49   public $debug = 0;
  50   protected $_params;
  51   public $_eNoticeCompliant = TRUE;
  52   function setUp() {
  53     parent::setUp();
  54
  55     $this->_apiversion = 3;
  56     $this->_individualId = $this->individualCreate();
  57     $paymentProcessor = $this->processorCreate();
  58     $this->_params = array(
  59       'contact_id' => $this->_individualId,
  60       'receive_date' => '20120511',
  61       'total_amount' => 100.00,
  62       'financial_type_id'   => $this->_contributionTypeId,
  63       'non_deductible_amount' => 10.00,
  64       'fee_amount' => 5.00,
  65       'net_amount' => 95.00,
  66       'source' => 'SSF',
  67       'contribution_status_id' => 1,
  68       'version' => $this->_apiversion,
  69     );
  70     $this->_processorParams = array(
  71       'domain_id' => 1,
  72       'name' => 'Dummy',
  73       'payment_processor_type_id' => 10,
  74       'financial_account_id' => 12,
  75       'is_active' => 1,
  76       'user_name' => '',
  77       'url_site' => 'http://dummy.com',
  78       'url_recur' => 'http://dummy.com',
  79       'billing_mode' => 1,
  80     );
  81     $this->_pageParams = array(
  82       'version' => 3,
  83       'title' => 'Test Contribution Page',
  84       'financial_type_id' => 1,
  85       'currency' => 'USD',
  86       'financial_account_id' => 1,
  87       'payment_processor' => $paymentProcessor->id,
  88       'is_active' => 1,
  89       'is_allow_other_amount' => 1,
  90       'min_amount' => 10,
  91       'max_amount' => 1000,
  92      );
  93   }
  94
  95   function tearDown() {
  96
  97     $this->contributionTypeDelete();
  98     $this->quickCleanup(array(
  99       'civicrm_contribution',
 100       'civicrm_contribution_soft',
 101       'civicrm_event',
 102       'civicrm_contribution_page',
 103       'civicrm_participant',
 104       'civicrm_participant_payment',
 105       'civicrm_line_item',
 106       'civicrm_financial_trxn',
 107       'civicrm_financial_item',
 108       'civicrm_entity_financial_trxn',
 109       'civicrm_contact',
 110     ));
 111   }
 112
 113   ///////////////// civicrm_contribution_get methods
 114   function testGetEmptyParamsContribution() {
 115     $params = array();
 116     $contribution = civicrm_api('contribution', 'get', $params);
 117     $this->assertEquals($contribution['is_error'], 1);
 118     $this->assertEquals($contribution['error_message'], 'Mandatory key(s) missing from params array: version');
 119   }
 120
 121   function testGetParamsNotArrayContribution() {
 122     $params = 'contact_id= 1';
 123     $contribution = civicrm_api('contribution', 'get', $params);
 124     $this->assertEquals($contribution['is_error'], 1);
 125     $this->assertEquals($contribution['error_message'], 'Input variable `params` is not an array');
 126   }
 127
 128   function testGetContribution() {
 129     $p = array(
 130       'contact_id' => $this->_individualId,
 131       'receive_date' => '2010-01-20',
 132       'total_amount' => 100.00,
 133       'financial_type_id' => $this->_contributionTypeId,
 134       'non_deductible_amount' => 10.00,
 135       'fee_amount' => 5.00,
 136       'net_amount' => 95.00,
 137       'trxn_id' => 23456,
 138       'invoice_id' => 78910,
 139       'source' => 'SSF',
 140       'contribution_status_id' => 1,
 141       'version' => $this->_apiversion,
 142     );
 143     $this->_contribution = civicrm_api('contribution', 'create', $p);
 144     $this->assertEquals($this->_contribution['is_error'], 0, 'In line ' . __LINE__);
 145
 146     $params = array(
 147       'contribution_id' => $this->_contribution['id'],
 148       'version' => $this->_apiversion,
 149     );
 150     $contribution = civicrm_api('contribution', 'get', $params);
 151     $financialParams['id'] = $this->_contributionTypeId;
 152     $default = null;
 153     $financialType  =  CRM_Financial_BAO_FinancialType::retrieve($financialParams,$default);
 154     $this->assertAPISuccess($contribution, 'In line ' . __LINE__);
 155     $this->assertEquals(1,$contribution['count']);
 156     $this->documentMe($params, $contribution, __FUNCTION__, __FILE__);
 157     $this->assertEquals($contribution['values'][$contribution['id']]['contact_id'], $this->_individualId, 'In line ' . __LINE__);
 158     // note there was an assertion converting financial_type_id to 'Donation' which wasn't working.
 159     // passing back a string rather than an id seems like an error / cruft - & if it is to be introduced we should discuss
 160     $this->assertEquals($contribution['values'][$contribution['id']]['financial_type_id'], 1);
 161     $this->assertEquals($contribution['values'][$contribution['id']]['total_amount'], 100.00, 'In line ' . __LINE__);
 162     $this->assertEquals($contribution['values'][$contribution['id']]['non_deductible_amount'], 10.00, 'In line ' . __LINE__);
 163     $this->assertEquals($contribution['values'][$contribution['id']]['fee_amount'], 5.00, 'In line ' . __LINE__);
 164     $this->assertEquals($contribution['values'][$contribution['id']]['net_amount'], 95.00, 'In line ' . __LINE__);
 165     $this->assertEquals($contribution['values'][$contribution['id']]['trxn_id'], 23456, 'In line ' . __LINE__);
 166     $this->assertEquals($contribution['values'][$contribution['id']]['invoice_id'], 78910, 'In line ' . __LINE__);
 167     $this->assertEquals($contribution['values'][$contribution['id']]['contribution_source'], 'SSF', 'In line ' . __LINE__);
 168     $this->assertEquals($contribution['values'][$contribution['id']]['contribution_status'], 'Completed', 'In line ' . __LINE__);
 169     //create a second contribution - we are testing that 'id' gets the right contribution id (not the contact id)
 170     $p['trxn_id'] = '3847';
 171     $p['invoice_id'] = '3847';
 172
 173     $contribution2 = civicrm_api('contribution', 'create', $p);
 174     $this->assertAPISuccess($contribution2, 'In line ' . __LINE__);
 175
 176     $params = array(
 177       'version' => $this->_apiversion,
 178     );
 179     // now we have 2 - test getcount
 180     $contribution = civicrm_api('contribution', 'getcount', array(
 181       'version' => $this->_apiversion,
 182       ));
 183     $this->assertEquals(2, $contribution);
 184     //test id only format
 185     $contribution = civicrm_api('contribution', 'get', array
 186       ('version' => $this->_apiversion,
 187         'id' => $this->_contribution['id'],
 188         'format.only_id' => 1,
 189       )
 190     );
 191     $this->assertEquals($this->_contribution['id'], $contribution, print_r($contribution,true) . " in line " . __LINE__);
 192     //test id only format
 193     $contribution = civicrm_api('contribution', 'get', array
 194       ('version' => $this->_apiversion,
 195         'id' => $contribution2['id'],
 196         'format.only_id' => 1,
 197       )
 198     );
 199     $this->assertEquals($contribution2['id'], $contribution);
 200     $contribution = civicrm_api('contribution', 'get', array(
 201       'version' => $this->_apiversion,
 202         'id' => $this->_contribution['id'],
 203       ));
 204     //test id as field
 205     $this->assertAPISuccess($contribution, 'In line ' . __LINE__);
 206     $this->assertEquals(1, $contribution['count'], 'In line ' . __LINE__);
 207     // $this->assertEquals($this->_contribution['id'], $contribution['id'] )  ;
 208     //test get by contact id works
 209     $contribution = civicrm_api('contribution', 'get', array('version' => $this->_apiversion, 'contact_id' => $this->_individualId));
 210     $this->assertAPISuccess($contribution, 'In line ' . __LINE__ . "get with contact_id" . print_r(array('version' => $this->_apiversion, 'contact_id' => $this->_individualId), TRUE));
 211
 212     $this->assertEquals(2, $contribution['count'], 'In line ' . __LINE__);
 213     civicrm_api('Contribution', 'Delete', array(
 214       'id' => $this->_contribution['id'],
 215         'version' => $this->_apiversion,
 216       ));
 217     civicrm_api('Contribution', 'Delete', array(
 218       'id' => $contribution2['id'],
 219         'version' => $this->_apiversion,
 220       ));
 221   }
 222
 223 /**
 224  * We need to ensure previous tested behaviour still works as part of the api contract
 225  */
 226   function testGetContributionLegacyBehaviour() {
 227     $p = array(
 228       'contact_id' => $this->_individualId,
 229       'receive_date' => '2010-01-20',
 230       'total_amount' => 100.00,
 231       'contribution_type_id' => $this->_contributionTypeId,
 232       'non_deductible_amount' => 10.00,
 233       'fee_amount' => 5.00,
 234       'net_amount' => 95.00,
 235       'trxn_id' => 23456,
 236       'invoice_id' => 78910,
 237       'source' => 'SSF',
 238       'contribution_status_id' => 1,
 239       'version' => $this->_apiversion,
 240     );
 241     $this->_contribution = civicrm_api('contribution', 'create', $p);
 242     $this->assertEquals($this->_contribution['is_error'], 0, 'In line ' . __LINE__);
 243
 244     $params = array(
 245       'contribution_id' => $this->_contribution['id'],
 246       'version' => $this->_apiversion,
 247     );
 248     $contribution = civicrm_api('contribution', 'get', $params);
 249     $financialParams['id'] = $this->_contributionTypeId;
 250     $default = null;
 251     $financialType  =  CRM_Financial_BAO_FinancialType::retrieve($financialParams,$default);
 252     $this->assertAPISuccess($contribution, 'In line ' . __LINE__);
 253     $this->assertEquals(1,$contribution['count']);
 254     $this->documentMe($params, $contribution, __FUNCTION__, __FILE__);
 255     $this->assertEquals($contribution['values'][$contribution['id']]['contact_id'], $this->_individualId, 'In line ' . __LINE__);
 256     $this->assertEquals($contribution['values'][$contribution['id']]['financial_type_id'], $this->_contributionTypeId);
 257     $this->assertEquals($contribution['values'][$contribution['id']]['contribution_type_id'], $this->_contributionTypeId);
 258     $this->assertEquals($contribution['values'][$contribution['id']]['total_amount'], 100.00, 'In line ' . __LINE__);
 259     $this->assertEquals($contribution['values'][$contribution['id']]['non_deductible_amount'], 10.00, 'In line ' . __LINE__);
 260     $this->assertEquals($contribution['values'][$contribution['id']]['fee_amount'], 5.00, 'In line ' . __LINE__);
 261     $this->assertEquals($contribution['values'][$contribution['id']]['net_amount'], 95.00, 'In line ' . __LINE__);
 262     $this->assertEquals($contribution['values'][$contribution['id']]['trxn_id'], 23456, 'In line ' . __LINE__);
 263     $this->assertEquals($contribution['values'][$contribution['id']]['invoice_id'], 78910, 'In line ' . __LINE__);
 264     $this->assertEquals($contribution['values'][$contribution['id']]['contribution_source'], 'SSF', 'In line ' . __LINE__);
 265     $this->assertEquals($contribution['values'][$contribution['id']]['contribution_status'], 'Completed', 'In line ' . __LINE__);
 266     //create a second contribution - we are testing that 'id' gets the right contribution id (not the contact id)
 267     $p['trxn_id'] = '3847';
 268     $p['invoice_id'] = '3847';
 269
 270     $contribution2 = civicrm_api('contribution', 'create', $p);
 271     $this->assertAPISuccess($contribution2, 'In line ' . __LINE__);
 272
 273     $params = array(
 274       'version' => $this->_apiversion,
 275     );
 276     // now we have 2 - test getcount
 277     $contribution = civicrm_api('contribution', 'getcount', array(
 278       'version' => $this->_apiversion,
 279     ));
 280     $this->assertEquals(2, $contribution);
 281     //test id only format
 282     $contribution = civicrm_api('contribution', 'get', array
 283       ('version' => $this->_apiversion,
 284         'id' => $this->_contribution['id'],
 285         'format.only_id' => 1,
 286       )
 287     );
 288     $this->assertEquals($this->_contribution['id'], $contribution, print_r($contribution,true) . " in line " . __LINE__);
 289     //test id only format
 290     $contribution = civicrm_api('contribution', 'get', array
 291       ('version' => $this->_apiversion,
 292         'id' => $contribution2['id'],
 293         'format.only_id' => 1,
 294       )
 295     );
 296     $this->assertEquals($contribution2['id'], $contribution);
 297     $contribution = civicrm_api('contribution', 'get', array(
 298       'version' => $this->_apiversion,
 299       'id' => $this->_contribution['id'],
 300     ));
 301     //test id as field
 302     $this->assertAPISuccess($contribution, 'In line ' . __LINE__);
 303     $this->assertEquals(1, $contribution['count'], 'In line ' . __LINE__);
 304     // $this->assertEquals($this->_contribution['id'], $contribution['id'] )  ;
 305     //test get by contact id works
 306     $contribution = civicrm_api('contribution', 'get', array('version' => $this->_apiversion, 'contact_id' => $this->_individualId));
 307     $this->assertAPISuccess($contribution, 'In line ' . __LINE__ . "get with contact_id" . print_r(array('version' => $this->_apiversion, 'contact_id' => $this->_individualId), TRUE));
 308
 309     $this->assertEquals(2, $contribution['count'], 'In line ' . __LINE__);
 310     civicrm_api('Contribution', 'Delete', array(
 311     'id' => $this->_contribution['id'],
 312     'version' => $this->_apiversion,
 313     ));
 314     civicrm_api('Contribution', 'Delete', array(
 315     'id' => $contribution2['id'],
 316     'version' => $this->_apiversion,
 317     ));
 318   }
 319   ///////////////// civicrm_contribution_
 320   function testCreateEmptyContributionIDUseDonation() {
 321     $params = array(
 322       'contribution_id' => FALSE,
 323       'contact_id' => 1,
 324       'total_amount' => 1,
 325       'version' => 3,
 326       'check_permissions' => false,
 327       'financial_type_id' => 'Donation',
 328     );
 329     $contribution = civicrm_api('contribution', 'create', $params);
 330     $this->assertEquals($contribution['is_error'], 0, 'In line ' . __LINE__);
 331   }
 332   /*
 333    * ensure we continue to support contribution_type_id as part of the api commitment to
 334    * stability
 335    *///////////////// civicrm_contribution_
 336
 337   function testCreateLegacyBehaviour() {
 338     $params = array(
 339       'contribution_id' => FALSE,
 340       'contact_id' => 1,
 341       'total_amount' => 1,
 342       'version' => 3,
 343       'check_permissions' => false,
 344       'contribution_type_id' => 3,
 345     );
 346     $contribution = civicrm_api('contribution', 'create', $params);
 347     $this->assertAPISuccess($contribution, 'In line ' . __LINE__);
 348     $contribution = civicrm_api('contribution', 'getsingle', array('version' => $this->_apiversion, 'id' => $contribution['id']));
 349     $this->assertEquals(3, $contribution['financial_type_id']);
 350   }
 351
 352   ///////////////// civicrm_contribution_
 353   function testCreateEmptyParamsContribution() {
 354
 355
 356     $params = array('version' => $this->_apiversion);
 357     $contribution = civicrm_api('contribution', 'create', $params);
 358     $this->assertEquals($contribution['is_error'], 1, 'In line ' . __LINE__);
 359     $this->assertEquals($contribution['error_message'], 'Mandatory key(s) missing from params array: financial_type_id, total_amount, contact_id', 'In line ' . __LINE__);
 360   }
 361
 362   function testCreateParamsNotArrayContribution() {
 363
 364     $params = 'contact_id= 1';
 365     $contribution = civicrm_api('contribution', 'create', $params);
 366     $this->assertEquals($contribution['is_error'], 1);
 367     $this->assertEquals($contribution['error_message'], 'Input variable `params` is not an array');
 368   }
 369
 370   function testCreateParamsWithoutRequiredKeys() {
 371     $params = array('version' => 3);
 372     $contribution = civicrm_api('contribution', 'create', $params);
 373     $this->assertEquals($contribution['is_error'], 1);
 374     $this->assertEquals($contribution['error_message'], 'Mandatory key(s) missing from params array: financial_type_id, total_amount, contact_id');
 375   }
 376
 377   /**
 378    * check with complete array + custom field
 379    * Note that the test is written on purpose without any
 380    * variables specific to participant so it can be replicated into other entities
 381    * and / or moved to the automated test suite
 382    */
 383   function testCreateWithCustom() {
 384     $ids = $this->entityCustomGroupWithSingleFieldCreate(__FUNCTION__, __FILE__);
 385
 386     $params = $this->_params;
 387     $params['custom_' . $ids['custom_field_id']] = "custom string";
 388
 389     $result = civicrm_api($this->_entity, 'create', $params);
 390     $this->assertEquals($result['id'], $result['values'][$result['id']]['id']);
 391     $this->documentMe($params, $result, __FUNCTION__, __FILE__);
 392     $this->assertAPISuccess($result, ' in line ' . __LINE__);
 393     $check = civicrm_api($this->_entity, 'get', array(
 394         'return.custom_' . $ids['custom_field_id'] => 1,
 395         'version' => 3,
 396         'id' => $result['id'],
 397       )
 398     );
 399     $this->customFieldDelete($ids['custom_field_id']);
 400     $this->customGroupDelete($ids['custom_group_id']);
 401     $this->assertEquals("custom string", $check['values'][$check['id']]['custom_' . $ids['custom_field_id']], ' in line ' . __LINE__);
 402   }
 403
 404   /**
 405    * check with complete array + custom field
 406    * Note that the test is written on purpose without any
 407    * variables specific to participant so it can be replicated into other entities
 408    * and / or moved to the automated test suite
 409    */
 410   function testCreateGetFieldsWithCustom() {
 411     $ids        = $this->entityCustomGroupWithSingleFieldCreate(__FUNCTION__, __FILE__);
 412     $idsContact = $this->entityCustomGroupWithSingleFieldCreate(__FUNCTION__, 'ContactTest.php');
 413     $result     = civicrm_api('Contribution', 'getfields', array('version' => 3));
 414     $this->assertArrayHasKey('custom_' . $ids['custom_field_id'], $result['values']);
 415     $this->assertArrayNotHasKey('custom_' . $idsContact['custom_field_id'], $result['values']);
 416     $this->customFieldDelete($ids['custom_field_id']);
 417     $this->customGroupDelete($ids['custom_group_id']);
 418     $this->customFieldDelete($idsContact['custom_field_id']);
 419     $this->customGroupDelete($idsContact['custom_group_id']);
 420   }
 421
 422   function testCreateContributionNoLineItems() {
 423
 424     $params = array(
 425       'contact_id' => $this->_individualId,
 426       'receive_date' => '20120511',
 427       'total_amount' => 100.00,
 428       'financial_type_id'      => $this->_contributionTypeId,
 429       'payment_instrument_id' => 1,
 430       'non_deductible_amount' => 10.00,
 431       'fee_amount' => 50.00,
 432       'net_amount' => 90.00,
 433       'trxn_id' => 12345,
 434       'invoice_id' => 67890,
 435       'source' => 'SSF',
 436       'contribution_status_id' => 1,
 437       'version' => $this->_apiversion,
 438       'skipLineItem' => 1,
 439     );
 440
 441     $contribution = civicrm_api('contribution', 'create', $params);
 442     $lineItems = civicrm_api('line_item','get',array(
 443       'version' => $this->_apiversion,
 444       'entity_id' => $contribution['id'],
 445       'entity_table' => 'civicrm_contribution',
 446       'sequential' => 1,
 447     ));
 448     $this->assertEquals(0, $lineItems['count']);
 449   }
 450   /*
 451    * Test checks that passing in line items suppresses the create mechanism
 452    */
 453   function testCreateContributionChainedLineItems() {
 454
 455     $params = array(
 456       'contact_id' => $this->_individualId,
 457       'receive_date' => '20120511',
 458       'total_amount' => 100.00,
 459       'financial_type_id' => $this->_contributionTypeId,
 460       'payment_instrument_id' => 1,
 461       'non_deductible_amount' => 10.00,
 462       'fee_amount' => 50.00,
 463       'net_amount' => 90.00,
 464       'trxn_id' => 12345,
 465       'invoice_id' => 67890,
 466       'source' => 'SSF',
 467       'contribution_status_id' => 1,
 468       'version' => $this->_apiversion,
 469       'skipLineItem' => 1,
 470       'api.line_item.create' => array(
 471         array(
 472           'price_field_id' => 1,
 473           'qty' => 2,
 474           'line_total' => '20',
 475           'unit_price' => '10',
 476         ),
 477         array(
 478           'price_field_id' => 1,
 479           'qty' => 1,
 480           'line_total' => '80',
 481           'unit_price' => '80',
 482         ),
 483       ),
 484     );
 485
 486     $contribution = civicrm_api('contribution', 'create', $params);
 487     $description = "Create Contribution with Nested Line Items";
 488     $subfile = "CreateWithNestedLineItems";
 489     $this->documentMe($params, $contribution, __FUNCTION__,__FILE__, $description, $subfile);
 490     $this->assertAPISuccess($contribution, 'In line ' . __LINE__);
 491     $lineItems = civicrm_api('line_item','get',array(
 492       'version' => $this->_apiversion,
 493       'entity_id' => $contribution['id'],
 494       'entity_table' => 'civicrm_contribution',
 495       'sequential' => 1,
 496     ));
 497     $this->assertEquals(2, $lineItems['count']);
 498   }
 499
 500   function testCreateContributionOffline() {
 501     $params = array(
 502       'contact_id' => $this->_individualId,
 503       'receive_date' => '20120511',
 504       'total_amount' => 100.00,
 505       'financial_type_id' => 1,
 506       'trxn_id' => 12345,
 507       'invoice_id' => 67890,
 508       'source' => 'SSF',
 509       'contribution_status_id' => 1,
 510       'version' => $this->_apiversion,
 511     );
 512
 513     $contribution = civicrm_api('contribution', 'create', $params);
 514     $this->documentMe($params, $contribution, __FUNCTION__, __FILE__);
 515     $this->assertEquals($contribution['values'][$contribution['id']]['contact_id'], $this->_individualId, 'In line ' . __LINE__);
 516     $this->assertEquals($contribution['values'][$contribution['id']]['total_amount'], 100.00, 'In line ' . __LINE__);
 517     $this->assertEquals($contribution['values'][$contribution['id']]['financial_type_id'],1, 'In line ' . __LINE__ );
 518     $this->assertEquals($contribution['values'][$contribution['id']]['trxn_id'], 12345, 'In line ' . __LINE__);
 519     $this->assertEquals($contribution['values'][$contribution['id']]['invoice_id'], 67890, 'In line ' . __LINE__);
 520     $this->assertEquals($contribution['values'][$contribution['id']]['source'], 'SSF', 'In line ' . __LINE__);
 521     $this->assertEquals($contribution['values'][$contribution['id']]['contribution_status_id'], 1, 'In line ' . __LINE__);
 522     $lineItems = civicrm_api('line_item','get',array(
 523       'version' => $this->_apiversion,
 524       'entity_id' => $contribution['id'],
 525       'entity_table' => 'civicrm_contribution',
 526       'sequential' => 1,
 527       ));
 528     $this->assertEquals(1, $lineItems['count']);
 529     $this->assertEquals($contribution['id'], $lineItems['values'][0]['entity_id']);
 530     $this->assertEquals($contribution['id'], $lineItems['values'][0]['entity_id']);
 531     $lineItems = civicrm_api('line_item','get',array(
 532         'version' => $this->_apiversion,
 533         'entity_id' => $contribution['id'],
 534         'entity_table' => 'civicrm_contribution',
 535         'sequential' => 1,
 536     ));
 537     $this->assertEquals(1, $lineItems['count']);
 538     $this->_checkFinancialRecords($contribution, 'offline');
 539     $this->contributionGetnCheck($params, $contribution['id']);
 540   }
 541   /*
 542    *
 543    */
 544   function testCreateContributionWithPaymentInstrument() {
 545     $params = $this->_params + array('payment_instrument' => 'EFT');
 546     $contribution =  civicrm_api('contribution','create',$params);
 547     $contribution = civicrm_api('contribution','get',array('version'=> 3, 'sequential' => 1, 'id' => $contribution['id']));
 548     $this->assertArrayHasKey('payment_instrument', $contribution['values'][0]);
 549     $eftTypeId = CRM_Core_OptionGroup::getValue('payment_instrument', 'EFT');
 550     $this->assertEquals('EFT',$contribution['values'][0]['payment_instrument']);
 551     $contribution = civicrm_api('contribution', 'update', array('id' => $contribution['id'], 'version' => $this->_apiversion, 'payment_instrument' => 'Credit Card'));
 552     $this->assertAPISuccess($contribution);
 553   }
 554
 555   function testGetContributionByPaymentInstrument() {
 556     $eftTypeId = CRM_Core_OptionGroup::getValue('payment_instrument', 'EFT');
 557     $cashTypeId = CRM_Core_OptionGroup::getValue('payment_instrument', 'Cash');
 558     $params = $this->_params + array('payment_instrument' => 'EFT');
 559     $params2 = $this->_params + array('payment_instrument' => 'Cash',);
 560     civicrm_api('contribution','create',$params);
 561     $contribution = civicrm_api('contribution','create',$params2);
 562     $this->assertAPISuccess($contribution);
 563     $contribution = civicrm_api('contribution','get',array('version'=> 3, 'sequential' => 1, 'contribution_payment_instrument_id' => 'Cash'));
 564     $this->assertArrayHasKey('payment_instrument', $contribution['values'][0]);
 565     $this->assertEquals('Cash',$contribution['values'][0]['payment_instrument']);
 566     $this->assertEquals(1,$contribution['count']);
 567     $contribution = civicrm_api('contribution','get',array('version'=> 3, 'sequential' => 1, 'payment_instrument_id' => 'EFT'));
 568     $this->assertArrayHasKey('payment_instrument', $contribution['values'][0]);
 569     $this->assertEquals('EFT',$contribution['values'][0]['payment_instrument']);
 570     $this->assertEquals(1, $contribution['count']);
 571     $contribution = civicrm_api('contribution','get',array('version'=> 3, 'sequential' => 1, 'payment_instrument_id' => 5));
 572     $this->assertArrayHasKey('payment_instrument', $contribution['values'][0]);
 573     $this->assertEquals('EFT',$contribution['values'][0]['payment_instrument']);
 574     $this->assertEquals(1,$contribution['count']);
 575     $contribution = civicrm_api('contribution','get',array('version'=> 3, 'sequential' => 1, 'payment_instrument' => 'EFT'));
 576     $this->assertArrayHasKey('payment_instrument', $contribution['values'][0]);
 577     $this->assertEquals('EFT',$contribution['values'][0]['payment_instrument']);
 578     $this->assertEquals(1,$contribution['count']);
 579     $contribution = civicrm_api('contribution', 'update', array('id' => $contribution['id'], 'version' => $this->_apiversion, 'payment_instrument' => 'Credit Card'));
 580     $this->assertAPISuccess($contribution);
 581     $contribution = civicrm_api('contribution','get',array('version'=> 3, 'sequential' => 1, 'id' => $contribution['id'], ));
 582     $this->assertArrayHasKey('payment_instrument', $contribution['values'][0]);
 583     $this->assertEquals('Credit Card',$contribution['values'][0]['payment_instrument']);
 584     $this->assertEquals(1,$contribution['count']);
 585   }
 586
 587   /*
 588      * Create test with unique field name on source
 589      */
 590   function testCreateContributionSource() {
 591
 592     $params = array(
 593       'contact_id' => $this->_individualId,
 594       'receive_date' => date('Ymd'),
 595       'total_amount' => 100.00,
 596       'financial_type_id' => $this->_contributionTypeId,
 597       'payment_instrument_id' => 1,
 598       'non_deductible_amount' => 10.00,
 599       'fee_amount' => 50.00,
 600       'net_amount' => 90.00,
 601       'trxn_id' => 12345,
 602       'invoice_id' => 67890,
 603       'contribution_source' => 'SSF',
 604       'contribution_status_id' => 1,
 605       'version' => $this->_apiversion,
 606     );
 607
 608     $contribution = civicrm_api('contribution', 'create', $params);
 609
 610     $this->assertAPISuccess($contribution, 'In line ' . __LINE__);
 611     $this->assertEquals($contribution['values'][$contribution['id']]['total_amount'], 100.00, 'In line ' . __LINE__);
 612     $this->assertEquals($contribution['values'][$contribution['id']]['source'], 'SSF', 'In line ' . __LINE__);
 613   }
 614   /*
 615      * Create test with unique field name on source
 616      */
 617   function testCreateContributionSourceInvalidContac() {
 618
 619     $params = array(
 620       'contact_id' => 999,
 621       'receive_date' => date('Ymd'),
 622       'total_amount' => 100.00,
 623       'financial_type_id' => $this->_contributionTypeId,
 624       'payment_instrument_id' => 1,
 625       'non_deductible_amount' => 10.00,
 626       'fee_amount' => 50.00,
 627       'net_amount' => 90.00,
 628       'trxn_id' => 12345,
 629       'invoice_id' => 67890,
 630       'contribution_source' => 'SSF',
 631       'contribution_status_id' => 1,
 632       'version' => $this->_apiversion,
 633     );
 634
 635     $contribution = civicrm_api('contribution', 'create', $params);
 636     $this->assertEquals($contribution['error_message'], 'contact_id is not valid : 999', 'In line ' . __LINE__);
 637   }
 638
 639   function testCreateContributionSourceInvalidContContac() {
 640
 641     $params = array(
 642       'contribution_contact_id' => 999,
 643       'receive_date' => date('Ymd'),
 644       'total_amount' => 100.00,
 645       'financial_type_id' => $this->_contributionTypeId,
 646       'payment_instrument_id' => 1,
 647       'non_deductible_amount' => 10.00,
 648       'fee_amount' => 50.00,
 649       'net_amount' => 90.00,
 650       'trxn_id' => 12345,
 651       'invoice_id' => 67890,
 652       'contribution_source' => 'SSF',
 653       'contribution_status_id' => 1,
 654       'version' => $this->_apiversion,
 655     );
 656
 657     $contribution = civicrm_api('contribution', 'create', $params);
 658     $this->assertEquals($contribution['error_message'], 'contact_id is not valid : 999', 'In line ' . __LINE__);
 659   }
 660
 661   function testCreateContributionWithNote() {
 662     $description = "Demonstrates creating contribution with Note Entity";
 663     $subfile     = "ContributionCreateWithNote";
 664     $params      = array(
 665       'contact_id' => $this->_individualId,
 666       'receive_date' => '2012-01-01',
 667       'total_amount' => 100.00,
 668       'financial_type_id' => $this->_contributionTypeId,
 669       'payment_instrument_id' => 1,
 670       'non_deductible_amount' => 10.00,
 671       'fee_amount' => 50.00,
 672       'net_amount' => 90.00,
 673       'trxn_id' => 12345,
 674       'invoice_id' => 67890,
 675       'source' => 'SSF',
 676       'contribution_status_id' => 1,
 677       'version' => $this->_apiversion,
 678       'note' => 'my contribution note',
 679     );
 680
 681     $contribution = civicrm_api('contribution', 'create', $params);
 682     $this->documentMe($params, $contribution, __FUNCTION__, __FILE__, $description, $subfile);
 683     $result = civicrm_api('note', 'get', array('version' => 3, 'entity_table' => 'civicrm_contribution', 'entity_id' => $contribution['id'], 'sequential' => 1));
 684     $this->assertAPISuccess($result);
 685     $this->assertEquals('my contribution note', $result['values'][0]['note']);
 686     civicrm_api('contribution', 'delete', array('version' => 3, 'id' => $contribution['id']));
 687   }
 688
 689   function testCreateContributionWithNoteUniqueNameAliases() {
 690     $params      = array(
 691       'contact_id' => $this->_individualId,
 692       'receive_date' => '2012-01-01',
 693       'total_amount' => 100.00,
 694       'financial_type_id' => $this->_contributionTypeId,
 695       'payment_instrument_id' => 1,
 696       'non_deductible_amount' => 10.00,
 697       'fee_amount' => 50.00,
 698       'net_amount' => 90.00,
 699       'trxn_id' => 12345,
 700       'invoice_id' => 67890,
 701       'source' => 'SSF',
 702       'contribution_status_id' => 1,
 703       'version' => $this->_apiversion,
 704       'contribution_note' => 'my contribution note',
 705     );
 706
 707     $contribution = civicrm_api('contribution', 'create', $params);
 708     $result = civicrm_api('note', 'get', array('version' => 3, 'entity_table' => 'civicrm_contribution', 'entity_id' => $contribution['id'], 'sequential' => 1));
 709     $this->assertAPISuccess($result);
 710     $this->assertEquals('my contribution note', $result['values'][0]['note']);
 711     civicrm_api('contribution', 'delete', array('version' => 3, 'id' => $contribution['id']));
 712   }
 713   /*
 714      * This is the test for creating soft credits - however a 'get' is not yet possible via API
 715      * as the current BAO functions are contact-centric (from what I can find)
 716      *
 717      */
 718   function testCreateContributionWithSoftCredt() {
 719     $description = "Demonstrates creating contribution with SoftCredit";
 720     $subfile     = "ContributionCreateWithSoftCredit";
 721     $contact2    = civicrm_api('Contact', 'create', array('version' => 3, 'display_name' => 'superman', 'version' => 3, 'contact_type' => 'Individual'));
 722     $params      = $this->_params + array(
 723       'soft_credit_to' => $contact2['id'],
 724
 725     );
 726
 727     $contribution = civicrm_api('contribution', 'create', $params);
 728     $this->assertAPISuccess($contribution);
 729     $this->documentMe($params, $contribution, __FUNCTION__, __FILE__, $description, $subfile);
 730     //     $result = civicrm_api('contribution','get', array('version' => 3,'return'=> 'soft_credit_to', 'sequential' => 1));
 731     //     $this->assertAPISuccess($result);
 732     //     $this->assertEquals($contact2['id'], $result['values'][$result['id']]['soft_credit_to']) ;
 733     //    well - the above doesn't work yet so lets do SQL
 734     $query = "SELECT count(*) FROM civicrm_contribution_soft WHERE contact_id = " . $contact2['id'];
 735
 736     $count = CRM_Core_DAO::singleValueQuery($query);
 737     $this->assertEquals(1, $count);
 738
 739     civicrm_api('contribution', 'delete', array('version' => 3, 'id' => $contribution['id']));
 740     civicrm_api('contact', 'delete', array('version' => 3, 'id' => $contact2['id']));
 741   }
 742
 743   /**
 744    *  Test  using example code
 745    */
 746   function testContributionCreateExample() {
 747     //make sure at least on page exists since there is a truncate in tear down
 748     $page = civicrm_api('contribution_page', 'create', $this->_pageParams);
 749     $this->assertAPISuccess($page);
 750     require_once 'api/v3/examples/ContributionCreate.php';
 751     $result         = contribution_create_example();
 752     $this->assertAPISuccess($result);
 753     $contributionId = $result['id'];
 754     $expectedResult = contribution_create_expectedresult();
 755     $this->checkArrayEquals($result, $expectedResult);
 756     $this->contributionDelete($contributionId);
 757   }
 758
 759   /*
 760    * Function tests that additional financial records are created when fee amount is recorded
 761    */
 762   function testCreateContributionWithFee() {
 763     $params = array(
 764       'contact_id' => $this->_individualId,
 765       'receive_date' => '20120511',
 766       'total_amount' => 100.00,
 767       'fee_amount' => 50,
 768       'financial_type_id' => 1,
 769       'trxn_id' => 12345,
 770       'invoice_id' => 67890,
 771       'source' => 'SSF',
 772       'contribution_status_id' => 1,
 773       'version' => $this->_apiversion,
 774     );
 775
 776     $contribution = civicrm_api('contribution', 'create', $params);
 777     $this->documentMe($params, $contribution, __FUNCTION__, __FILE__);
 778     $this->assertEquals($contribution['values'][$contribution['id']]['contact_id'], $this->_individualId, 'In line ' . __LINE__);
 779     $this->assertEquals($contribution['values'][$contribution['id']]['total_amount'], 100.00, 'In line ' . __LINE__);
 780     $this->assertEquals($contribution['values'][$contribution['id']]['financial_type_id'],1, 'In line ' . __LINE__ );
 781     $this->assertEquals($contribution['values'][$contribution['id']]['trxn_id'], 12345, 'In line ' . __LINE__);
 782     $this->assertEquals($contribution['values'][$contribution['id']]['invoice_id'], 67890, 'In line ' . __LINE__);
 783     $this->assertEquals($contribution['values'][$contribution['id']]['source'], 'SSF', 'In line ' . __LINE__);
 784     $this->assertEquals($contribution['values'][$contribution['id']]['contribution_status_id'], 1, 'In line ' . __LINE__);
 785     $lineItems = civicrm_api('line_item','get',array(
 786       'version' => $this->_apiversion,
 787       'entity_id' => $contribution['id'],
 788       'entity_table' => 'civicrm_contribution',
 789       'sequential' => 1,
 790       ));
 791     $this->assertEquals(1, $lineItems['count']);
 792     $this->assertEquals($contribution['id'], $lineItems['values'][0]['entity_id']);
 793     $this->assertEquals($contribution['id'], $lineItems['values'][0]['entity_id']);
 794     $lineItems = civicrm_api('line_item','get',array(
 795         'version' => $this->_apiversion,
 796         'entity_id' => $contribution['id'],
 797         'entity_table' => 'civicrm_contribution',
 798         'sequential' => 1,
 799     ));
 800     $this->assertEquals(1, $lineItems['count']);
 801     $this->_checkFinancialRecords($contribution, 'feeAmount');
 802   }
 803
 804
 805   /*
 806    * Function tests that additional financial records are created when online contribution is created
 807    */
 808   function testCreateContributionOnline() {
 809     $paymentProcessor = CRM_Financial_BAO_PaymentProcessor::create($this->_processorParams);
 810     $contributionPage = civicrm_api( 'contribution_page','create',  $this->_pageParams );
 811
 812     $params = array(
 813       'contact_id' => $this->_individualId,
 814       'receive_date' => '20120511',
 815       'total_amount' => 100.00,
 816       'financial_type_id' => 1,
 817       'contribution_page_id' => $contributionPage['id'],
 818       'payment_processor' => 1,
 819       'trxn_id' => 12345,
 820       'invoice_id' => 67890,
 821       'source' => 'SSF',
 822       'contribution_status_id' => 1,
 823       'version' => $this->_apiversion,
 824     );
 825
 826     $contribution = civicrm_api('contribution', 'create', $params);
 827     $this->documentMe($params, $contribution, __FUNCTION__, __FILE__);
 828     $this->assertEquals($contribution['values'][$contribution['id']]['contact_id'], $this->_individualId, 'In line ' . __LINE__);
 829     $this->assertEquals($contribution['values'][$contribution['id']]['total_amount'], 100.00, 'In line ' . __LINE__);
 830     $this->assertEquals($contribution['values'][$contribution['id']]['financial_type_id'],1, 'In line ' . __LINE__ );
 831     $this->assertEquals($contribution['values'][$contribution['id']]['trxn_id'], 12345, 'In line ' . __LINE__);
 832     $this->assertEquals($contribution['values'][$contribution['id']]['invoice_id'], 67890, 'In line ' . __LINE__);
 833     $this->assertEquals($contribution['values'][$contribution['id']]['source'], 'SSF', 'In line ' . __LINE__);
 834     $this->assertEquals($contribution['values'][$contribution['id']]['contribution_status_id'], 1, 'In line ' . __LINE__);
 835     $this->_checkFinancialRecords($contribution, 'online');
 836   }
 837
 838   /*
 839    * Function tests that additional financial records are created when online contribution with pay later option
 840    * is created
 841    */
 842   function testCreateContributionPayLaterOnline() {
 843     $paymentProcessor = CRM_Financial_BAO_PaymentProcessor::create($this->_processorParams);
 844     $this->_pageParams['is_pay_later'] = 1;
 845     $contributionPage = civicrm_api( 'contribution_page','create',$this->_pageParams );
 846
 847     $params = array(
 848       'contact_id' => $this->_individualId,
 849       'receive_date' => '20120511',
 850       'total_amount' => 100.00,
 851       'financial_type_id' => 1,
 852       'contribution_page_id' => $contributionPage['id'],
 853       'trxn_id' => 12345,
 854       'is_pay_later' => 1,
 855       'invoice_id' => 67890,
 856       'source' => 'SSF',
 857       'contribution_status_id' => 2,
 858       'version' => $this->_apiversion,
 859     );
 860
 861     $contribution = civicrm_api('contribution', 'create', $params);
 862     $this->documentMe($params, $contribution, __FUNCTION__, __FILE__);
 863     $this->assertEquals($contribution['values'][$contribution['id']]['contact_id'], $this->_individualId, 'In line ' . __LINE__);
 864     $this->assertEquals($contribution['values'][$contribution['id']]['total_amount'], 100.00, 'In line ' . __LINE__);
 865     $this->assertEquals($contribution['values'][$contribution['id']]['financial_type_id'],1, 'In line ' . __LINE__ );
 866     $this->assertEquals($contribution['values'][$contribution['id']]['trxn_id'], 12345, 'In line ' . __LINE__);
 867     $this->assertEquals($contribution['values'][$contribution['id']]['invoice_id'], 67890, 'In line ' . __LINE__);
 868     $this->assertEquals($contribution['values'][$contribution['id']]['source'], 'SSF', 'In line ' . __LINE__);
 869     $this->assertEquals($contribution['values'][$contribution['id']]['contribution_status_id'], 2, 'In line ' . __LINE__);
 870     $this->_checkFinancialRecords($contribution, 'payLater');
 871   }
 872
 873   /*
 874    * Function tests that additional financial records are created when online contribution with pending option
 875    * is created
 876    */
 877   function testCreateContributionPendingOnline() {
 878     $paymentProcessor = CRM_Financial_BAO_PaymentProcessor::create($this->_processorParams);
 879     $contributionPage = civicrm_api( 'contribution_page', 'create', $this->_pageParams );
 880
 881     $params = array(
 882       'contact_id' => $this->_individualId,
 883       'receive_date' => '20120511',
 884       'total_amount' => 100.00,
 885       'financial_type_id' => 1,
 886       'contribution_page_id' => $contributionPage['id'],
 887       'trxn_id' => 12345,
 888       'invoice_id' => 67890,
 889       'source' => 'SSF',
 890       'contribution_status_id' => 2,
 891       'version' => $this->_apiversion,
 892     );
 893
 894     $contribution = civicrm_api('contribution', 'create', $params);
 895     $this->documentMe($params, $contribution, __FUNCTION__, __FILE__);
 896     $this->assertEquals($contribution['values'][$contribution['id']]['contact_id'], $this->_individualId, 'In line ' . __LINE__);
 897     $this->assertEquals($contribution['values'][$contribution['id']]['total_amount'], 100.00, 'In line ' . __LINE__);
 898     $this->assertEquals($contribution['values'][$contribution['id']]['financial_type_id'],1, 'In line ' . __LINE__ );
 899     $this->assertEquals($contribution['values'][$contribution['id']]['trxn_id'], 12345, 'In line ' . __LINE__);
 900     $this->assertEquals($contribution['values'][$contribution['id']]['invoice_id'], 67890, 'In line ' . __LINE__);
 901     $this->assertEquals($contribution['values'][$contribution['id']]['source'], 'SSF', 'In line ' . __LINE__);
 902     $this->assertEquals($contribution['values'][$contribution['id']]['contribution_status_id'], 2, 'In line ' . __LINE__);
 903     $this->_checkFinancialRecords($contribution, 'pending');
 904   }
 905
 906   /*
 907    * Function tests that line items, financial records are updated when contribution amount is changed
 908    */
 909   function testCreateUpdateContributionChangeTotal() {
 910     $contribution = civicrm_api('contribution', 'create', $this->_params);
 911     $lineItems = civicrm_api('line_item','getvalue', array(
 912       'version' => $this->_apiversion,
 913       'entity_id' => $contribution['id'],
 914       'entity_table' => 'civicrm_contribution',
 915       'sequential' => 1,
 916       'return' => 'line_total',
 917     ));
 918     $this->assertEquals('100.00', $lineItems);
 919     $trxnAmount = $this->_getFinancialTrxnAmount($contribution['id']);
 920     // Financial trxn SUM = 100 + 5 (fee)
 921     $this->assertEquals('105.00', $trxnAmount);
 922     $newParams = array(
 923       'version' => $this->_apiversion,
 924       'id' => $contribution['id'],
 925       'total_amount' => '125');
 926     $contribution = civicrm_api('contribution', 'update', $newParams);
 927
 928     $lineItems = civicrm_api('line_item','getvalue',array(
 929         'version' => $this->_apiversion,
 930         'entity_id' => $contribution['id'],
 931         'entity_table' => 'civicrm_contribution',
 932         'sequential' => 1,
 933         'return' => 'line_total',
 934     ));
 935
 936     $this->assertEquals('125.00', $lineItems);
 937     $trxnAmount = $this->_getFinancialTrxnAmount($contribution['id']);
 938     $fitemAmount = $this->_getFinancialItemAmount($contribution['id']);
 939     // Financial trxn SUM = 125 + 5 (fee)
 940     $this->assertEquals('130.00', $trxnAmount);
 941     $this->assertEquals('125.00', $fitemAmount);
 942   }
 943
 944   /*
 945    * Function tests that line items, financial records are updated when pay later contribution is received
 946    */
 947   function testCreateUpdateContributionPayLater() {
 948     $contribParams = array(
 949       'contact_id' => $this->_individualId,
 950       'receive_date' => '2012-01-01',
 951       'total_amount' => 100.00,
 952       'financial_type_id' => $this->_contributionTypeId,
 953       'payment_instrument_id' => 1,
 954       'contribution_status_id' => 2,
 955       'is_pay_later' => 1,
 956       'version' => $this->_apiversion,
 957     );
 958     $contribution = civicrm_api('contribution', 'create', $contribParams);
 959
 960     $newParams = array_merge($contribParams, array(
 961       'id' => $contribution['id'],
 962       'contribution_status_id' => 1,)
 963     );
 964     $contribution = civicrm_api('contribution', 'update', $newParams);
 965     $contribution = $contribution['values'][$contribution['id']];
 966     $this->assertEquals($contribution['contribution_status_id'],'1');
 967     $this->_checkFinancialItem($contribution['id'], 'paylater');
 968     $this->_checkFinancialTrxn($contribution, 'payLater');
 969   }
 970
 971   /*
 972    * Function tests that financial records are updated when Payment Instrument is changed
 973    */
 974   function testCreateUpdateContributionPaymentInstrument() {
 975     $instrumentId = $this->_addPaymentInstrument();
 976     $contribParams = array(
 977       'contact_id' => $this->_individualId,
 978       'total_amount' => 100.00,
 979       'financial_type_id' => $this->_contributionTypeId,
 980       'payment_instrument_id' => 4,
 981       'contribution_status_id' => 1,
 982       'version' => $this->_apiversion,
 983     );
 984     $contribution = civicrm_api('contribution', 'create', $contribParams);
 985
 986     $newParams = array_merge($contribParams, array(
 987      'id' => $contribution['id'],
 988      'payment_instrument_id' => $instrumentId,)
 989     );
 990     $contribution = civicrm_api('contribution', 'update', $newParams);
 991     $this->assertAPISuccess($contribution);
 992     $this->_checkFinancialTrxn($contribution, 'paymentInstrument');
 993   }
 994
 995   /*
 996    * Function tests that financial records are added when Contribution is Refunded
 997    */
 998   function testCreateUpdateContributionRefund() {
 999     $contribParams = array(
1000       'contact_id' => $this->_individualId,
1001       'receive_date' => '2012-01-01',
1002       'total_amount' => 100.00,
1003       'financial_type_id' => $this->_contributionTypeId,
1004       'payment_instrument_id' => 4,
1005       'contribution_status_id' => 1,
1006       'version' => $this->_apiversion,
1007     );
1008     $contribution = civicrm_api('contribution', 'create', $contribParams);
1009     $newParams = array_merge($contribParams, array(
1010      'id' => $contribution['id'],
1011      'contribution_status_id' => 7,
1012       )
1013     );
1014
1015     $contribution = civicrm_api('contribution', 'update', $newParams);
1016     $this->_checkFinancialTrxn($contribution, 'refund');
1017     $this->_checkFinancialItem($contribution['id'], 'refund');
1018   }
1019
1020   /*
1021    * Function tests invalid contribution status change
1022    */
1023   function testCreateUpdateContributionInValidStatusChange() {
1024     $contribParams = array(
1025       'contact_id' => 1,
1026       'receive_date' => '2012-01-01',
1027       'total_amount' => 100.00,
1028       'financial_type_id' => 1,
1029       'payment_instrument_id' => 1,
1030       'contribution_status_id' => 1,
1031       'version' => 3,
1032     );
1033     $contribution = civicrm_api('contribution', 'create', $contribParams);
1034     $newParams = array_merge($contribParams, array(
1035      'id' => $contribution['id'],
1036      'contribution_status_id' => 2,
1037       )
1038     );
1039     $contribution = civicrm_api('contribution', 'update', $newParams);
1040     $this->assertTrue(!empty($contribution['is_error']), 'In line ' . __LINE__);
1041     $this->assertEquals($contribution['error_message'], ts('Cannot change contribution status from Completed to Pending.'), 'In line ' . __LINE__);
1042
1043   }
1044
1045   /*
1046    * Function tests that financial records are added when Pending Contribution is Canceled
1047    */
1048   function testCreateUpdateContributionCancelPending() {
1049     $contribParams = array(
1050       'contact_id' => $this->_individualId,
1051       'receive_date' => '2012-01-01',
1052       'total_amount' => 100.00,
1053       'financial_type_id' => $this->_contributionTypeId,
1054       'payment_instrument_id' => 1,
1055       'contribution_status_id' => 2,
1056       'is_pay_later' => 1,
1057       'version' => $this->_apiversion,
1058     );
1059     $contribution = civicrm_api('contribution', 'create', $contribParams);
1060     $newParams = array_merge($contribParams, array(
1061      'id' => $contribution['id'],
1062      'contribution_status_id' => 3,
1063       )
1064     );
1065     $contribution = civicrm_api('contribution', 'update', $newParams);
1066     $this->_checkFinancialTrxn($contribution, 'cancelPending');
1067     $this->_checkFinancialItem($contribution['id'], 'cancelPending');
1068   }
1069
1070   /*
1071    * Function tests that financial records are added when Financial Type is Changed
1072    */
1073   function testCreateUpdateContributionChangeFinancialType() {
1074     $contribParams = array(
1075       'contact_id' => $this->_individualId,
1076       'receive_date' => '2012-01-01',
1077       'total_amount' => 100.00,
1078       'financial_type_id' => 1,
1079       'payment_instrument_id' => 1,
1080       'contribution_status_id' => 1,
1081       'version' => $this->_apiversion,
1082     );
1083     $contribution = civicrm_api('contribution', 'create', $contribParams);
1084     $newParams = array_merge($contribParams, array(
1085      'id' => $contribution['id'],
1086      'financial_type_id' => 3,
1087       )
1088     );
1089     $contribution = civicrm_api('contribution', 'update', $newParams);
1090     $this->_checkFinancialTrxn($contribution, 'changeFinancial');
1091     $this->_checkFinancialItem($contribution['id'], 'changeFinancial');
1092   }
1093
1094   //To Update Contribution
1095   //CHANGE: we require the API to do an incremental update
1096   function testCreateUpdateContribution() {
1097
1098     $contributionID = $this->contributionCreate($this->_individualId, $this->_contributionTypeId, 'idofsh', 212355);
1099     $old_params = array(
1100       'contribution_id' => $contributionID,
1101       'version' => $this->_apiversion,
1102     );
1103     $original = civicrm_api('contribution', 'get', $old_params);
1104     //Make sure it came back
1105     $this->assertTrue(empty($original['is_error']), 'In line ' . __LINE__);
1106     $this->assertEquals($original['id'], $contributionID, 'In line ' . __LINE__);
1107     //set up list of old params, verify
1108
1109     //This should not be required on update:
1110     $old_contact_id = $original['values'][$contributionID]['contact_id'];
1111     $old_payment_instrument = $original['values'][$contributionID]['instrument_id'];
1112     $old_fee_amount = $original['values'][$contributionID]['fee_amount'];
1113     $old_source = $original['values'][$contributionID]['contribution_source'];
1114
1115     //note: current behavior is to return ISO.  Is this
1116     //documented behavior?  Is this correct
1117     $old_receive_date = date('Ymd', strtotime($original['values'][$contributionID]['receive_date']));
1118
1119     $old_trxn_id = $original['values'][$contributionID]['trxn_id'];
1120     $old_invoice_id = $original['values'][$contributionID]['invoice_id'];
1121
1122     //check against values in CiviUnitTestCase::createContribution()
1123     $this->assertEquals($old_contact_id, $this->_individualId, 'In line ' . __LINE__);
1124     $this->assertEquals($old_fee_amount, 5.00, 'In line ' . __LINE__);
1125     $this->assertEquals($old_source, 'SSF', 'In line ' . __LINE__);
1126     $this->assertEquals($old_trxn_id, 212355, 'In line ' . __LINE__);
1127     $this->assertEquals($old_invoice_id, 'idofsh', 'In line ' . __LINE__);
1128     $params = array(
1129       'id' => $contributionID,
1130       'contact_id' => $this->_individualId,
1131       'total_amount' => 110.00,
1132       'financial_type_id' => $this->_contributionTypeId,
1133       'non_deductible_amount' => 10.00,
1134       'net_amount' => 100.00,
1135       'contribution_status_id' => 1,
1136       'note' => 'Donating for Nobel Cause',
1137       'version' => $this->_apiversion,
1138     );
1139
1140     $contribution = civicrm_api('contribution', 'create', $params);
1141
1142     $new_params = array(
1143       'contribution_id' => $contribution['id'],
1144       'version' => $this->_apiversion,
1145     );
1146     $contribution = civicrm_api('contribution', 'get', $new_params);
1147
1148     $this->assertEquals($contribution['values'][$contributionID]['contact_id'], $this->_individualId, 'In line ' . __LINE__);
1149     $this->assertEquals($contribution['values'][$contributionID]['total_amount'], 110.00, 'In line ' . __LINE__);
1150         $this->assertEquals($contribution['values'][$contributionID]['financial_type_id'],$this->_contributionTypeId, 'In line ' . __LINE__ );
1151     $this->assertEquals($contribution['values'][$contributionID]['instrument_id'], $old_payment_instrument, 'In line ' . __LINE__);
1152     $this->assertEquals($contribution['values'][$contributionID]['non_deductible_amount'], 10.00, 'In line ' . __LINE__);
1153     $this->assertEquals($contribution['values'][$contributionID]['fee_amount'], $old_fee_amount, 'In line ' . __LINE__);
1154     $this->assertEquals($contribution['values'][$contributionID]['net_amount'], 100.00, 'In line ' . __LINE__);
1155     $this->assertEquals($contribution['values'][$contributionID]['trxn_id'], $old_trxn_id, 'In line ' . __LINE__);
1156     $this->assertEquals($contribution['values'][$contributionID]['invoice_id'], $old_invoice_id, 'In line ' . __LINE__);
1157     $this->assertEquals($contribution['values'][$contributionID]['contribution_source'], $old_source, 'In line ' . __LINE__);
1158     $this->assertEquals($contribution['values'][$contributionID]['contribution_status'], 'Completed', 'In line ' . __LINE__);
1159     $params = array(
1160       'contribution_id' => $contributionID,
1161       'version' => $this->_apiversion,
1162     );
1163     $result = civicrm_api('contribution', 'delete', $params);
1164     $this->assertEquals($result['is_error'], 0, 'in line' . __LINE__);
1165   }
1166
1167   ///////////////// civicrm_contribution_delete methods
1168   function testDeleteEmptyParamsContribution() {
1169     $params = array('version' => $this->_apiversion);
1170     $contribution = civicrm_api('contribution', 'delete', $params);
1171     $this->assertEquals($contribution['is_error'], 1);
1172   }
1173
1174   function testDeleteParamsNotArrayContribution() {
1175     $params = 'contribution_id= 1';
1176     $contribution = civicrm_api('contribution', 'delete', $params);
1177     $this->assertEquals($contribution['is_error'], 1);
1178     $this->assertEquals($contribution['error_message'], 'Input variable `params` is not an array');
1179   }
1180
1181   function testDeleteWrongParamContribution() {
1182     $params = array(
1183       'contribution_source' => 'SSF',
1184       'version' => $this->_apiversion,
1185     );
1186     $contribution = civicrm_api('contribution', 'delete', $params);
1187     $this->assertEquals($contribution['is_error'], 1);
1188   }
1189
1190   function testDeleteContribution() {
1191
1192     $contributionID = $this->contributionCreate($this->_individualId, $this->_contributionTypeId, 'dfsdf', 12389);
1193     $params = array(
1194       'id' => $contributionID,
1195       'version' => $this->_apiversion,
1196     );
1197     $result = civicrm_api('contribution', 'delete', $params);
1198     $this->documentMe($params, $result, __FUNCTION__, __FILE__);
1199     $this->assertEquals($result['is_error'], 0, 'In line ' . __LINE__);
1200   }
1201
1202   ///////////////// civicrm_contribution_search methods
1203
1204   /**
1205    *  Test civicrm_contribution_search with wrong params type
1206    */
1207   function testSearchWrongParamsType() {
1208     $params = 'a string';
1209     $result = civicrm_api('contribution', 'get', $params);
1210
1211     $this->assertEquals($result['is_error'], 1, 'In line ' . __LINE__);
1212     $this->assertEquals($result['error_message'], 'Input variable `params` is not an array', 'In line ' . __LINE__);
1213   }
1214
1215   /**
1216    *  Test civicrm_contribution_search with empty params.
1217    *  All available contributions expected.
1218    */
1219   function testSearchEmptyParams() {
1220     $params = array('version' => $this->_apiversion);
1221
1222     $p = array(
1223       'contact_id' => $this->_individualId,
1224       'receive_date' => date('Ymd'),
1225       'total_amount' => 100.00,
1226       'financial_type_id' => $this->_contributionTypeId,
1227       'non_deductible_amount' => 10.00,
1228       'fee_amount' => 5.00,
1229       'net_amount' => 95.00,
1230       'trxn_id' => 23456,
1231       'invoice_id' => 78910,
1232       'source' => 'SSF',
1233       'contribution_status_id' => 1,
1234       'version' => $this->_apiversion,
1235     );
1236     $contribution = civicrm_api('contribution', 'create', $p);
1237
1238     $result = civicrm_api('contribution', 'get', $params);
1239     // We're taking the first element.
1240     $res = $result['values'][$contribution['id']];
1241
1242     $this->assertEquals($p['contact_id'], $res['contact_id'], 'In line ' . __LINE__);
1243     $this->assertEquals($p['total_amount'], $res['total_amount'], 'In line ' . __LINE__);
1244     $this->assertEquals($p['financial_type_id'], $res['financial_type_id'], 'In line ' . __LINE__ );
1245     $this->assertEquals($p['net_amount'], $res['net_amount'], 'In line ' . __LINE__);
1246     $this->assertEquals($p['non_deductible_amount'], $res['non_deductible_amount'], 'In line ' . __LINE__);
1247     $this->assertEquals($p['fee_amount'], $res['fee_amount'], 'In line ' . __LINE__);
1248     $this->assertEquals($p['trxn_id'], $res['trxn_id'], 'In line ' . __LINE__);
1249     $this->assertEquals($p['invoice_id'], $res['invoice_id'], 'In line ' . __LINE__);
1250     $this->assertEquals($p['source'], $res['contribution_source'], 'In line ' . __LINE__);
1251     // contribution_status_id = 1 => Completed
1252     $this->assertEquals('Completed', $res['contribution_status'], 'In line ' . __LINE__);
1253
1254     $this->contributionDelete($contribution['id']);
1255   }
1256
1257   /**
1258    *  Test civicrm_contribution_search. Success expected.
1259    */
1260   function testSearch() {
1261     $p1 = array(
1262       'contact_id' => $this->_individualId,
1263       'receive_date' => date('Ymd'),
1264       'total_amount' => 100.00,
1265       'financial_type_id' => $this->_contributionTypeId,
1266       'non_deductible_amount' => 10.00,
1267       'contribution_status_id' => 1,
1268       'version' => $this->_apiversion,
1269     );
1270     $contribution1 = civicrm_api('contribution', 'create', $p1);
1271
1272     $p2 = array(
1273       'contact_id' => $this->_individualId,
1274       'receive_date' => date('Ymd'),
1275       'total_amount' => 200.00,
1276       'financial_type_id' => $this->_contributionTypeId,
1277       'non_deductible_amount' => 20.00,
1278       'trxn_id' => 5454565,
1279       'invoice_id' => 1212124,
1280       'fee_amount' => 50.00,
1281       'net_amount' => 60.00,
1282       'contribution_status_id' => 2,
1283       'version' => $this->_apiversion,
1284     );
1285     $contribution2 = civicrm_api('contribution', 'create', $p2);
1286
1287     $params = array(
1288       'contribution_id' => $contribution2['id'],
1289       'version' => $this->_apiversion,
1290     );
1291     $result = civicrm_api('contribution', 'get', $params);
1292     $res = $result['values'][$contribution2['id']];
1293
1294     $this->assertEquals($p2['contact_id'], $res['contact_id'], 'In line ' . __LINE__);
1295     $this->assertEquals($p2['total_amount'], $res['total_amount'], 'In line ' . __LINE__);
1296     $this->assertEquals($p2['financial_type_id'], $res['financial_type_id'], 'In line ' . __LINE__ );
1297     $this->assertEquals($p2['net_amount'], $res['net_amount'], 'In line ' . __LINE__);
1298     $this->assertEquals($p2['non_deductible_amount'], $res['non_deductible_amount'], 'In line ' . __LINE__);
1299     $this->assertEquals($p2['fee_amount'], $res['fee_amount'], 'In line ' . __LINE__);
1300     $this->assertEquals($p2['trxn_id'], $res['trxn_id'], 'In line ' . __LINE__);
1301     $this->assertEquals($p2['invoice_id'], $res['invoice_id'], 'In line ' . __LINE__);
1302     // contribution_status_id = 2 => Pending
1303     $this->assertEquals('Pending', $res['contribution_status'], 'In line ' . __LINE__);
1304
1305     $this->contributionDelete($contribution1['id']);
1306     $this->contributionDelete($contribution2['id']);
1307   }
1308   /*
1309    * Test sending a mail via the API
1310    */
1311   function testSendMail() {
1312     $mut = new CiviMailUtils( $this, true );
1313     $contribution = civicrm_api('contribution','create',$this->_params);
1314     $this->assertAPISuccess($contribution);
1315     $apiResult = civicrm_api('contribution', 'sendconfirmation', array(
1316       'version' => $this->_apiversion,
1317       'id' => $contribution['id'],
1318       'receipt_from_email' => 'api@civicrm.org',
1319       )
1320     );
1321     $this->assertAPISuccess($apiResult);
1322     $mut->checkMailLog(array(
1323         '$ 100.00',
1324         'Contribution Information',
1325         'Please print this confirmation for your records',
1326       ), array(
1327         'Event'
1328       )
1329     );
1330     $mut->stop();
1331   }
1332
1333   /*
1334    * Test sending a mail via the API
1335    */
1336   function testSendMailEvent() {
1337     $mut = new CiviMailUtils( $this, true );
1338     $contribution = civicrm_api('contribution','create',$this->_params);
1339     $event          = $this->eventCreate(array(
1340       'is_email_confirm' => 1,
1341       'confirm_from_email' => 'test@civicrm.org',
1342     ));
1343     $this->_eventID = $event['id'];
1344     $participantParams = array(
1345       'contact_id' => $this->_individualId,
1346       'event_id' => $this->_eventID,
1347       'status_id' => 1,
1348       'role_id' => 1,
1349       // to ensure it matches later on
1350       'register_date' => '2007-07-21 00:00:00',
1351       'source' => 'Online Event Registration: API Testing',
1352       'version' => $this->_apiversion,
1353     );
1354     $participant = civicrm_api('participant', 'create', $participantParams);
1355     $this->assertAPISuccess($participant, "participant created in line " . __LINE__);
1356     $this->assertAPISuccess(civicrm_api('participant_payment', 'create', array(
1357       'version' => 3,
1358       'participant_id' => $participant['id'],
1359       'contribution_id' => $contribution['id'],
1360     )), " in line " . __LINE__);
1361     $apiResult = civicrm_api('contribution', 'sendconfirmation', array(
1362       'version' => $this->_apiversion,
1363       'id' => $contribution['id'],
1364       'receipt_from_email' => 'api@civicrm.org',
1365       )
1366     );
1367
1368     $this->assertAPISuccess($apiResult);
1369     $mut->checkMailLog(array(
1370         'Annual CiviCRM meet',
1371         'Event',
1372         'To: "Mr. Anthony Anderson II" <anthony_anderson@civicrm.org>',
1373       ), array(
1374
1375       )
1376     );
1377     $mut->stop();
1378   }
1379
1380   ///////////////  _civicrm_contribute_format_params for $create
1381   function testFormatParams() {
1382     require_once 'CRM/Contribute/DAO/Contribution.php';
1383     $params = array(
1384       'contact_id' => $this->_individualId,
1385       'receive_date' => date('Ymd'),
1386       'total_amount' => 100.00,
1387       'financial_type_id' => $this->_contributionTypeId,
1388       'contribution_status_id' => 1,
1389       'financial_type' => null,
1390       'note' => 'note',
1391       'contribution_source' => 'test',
1392     );
1393
1394     $values = array();
1395     $result = _civicrm_api3_contribute_format_params($params, $values, TRUE);
1396     $this->assertEquals($values['total_amount'], 100.00, 'In line ' . __LINE__);
1397     $this->assertEquals($values['contribution_status_id'], 1, 'In line ' . __LINE__);
1398   }
1399   /*
1400      * This function does a GET & compares the result against the $params
1401      * Use as a double check on Creates
1402      */
1403   function contributionGetnCheck($params, $id, $delete = 1) {
1404
1405     $contribution = civicrm_api('Contribution', 'Get', array(
1406       'id' => $id,
1407         'version' => $this->_apiversion,
1408       ));
1409
1410     if ($delete) {
1411       civicrm_api('contribution', 'delete', array(
1412         'id' => $id,
1413           'version' => $this->_apiversion,
1414         ));
1415     }
1416     $this->assertEquals($contribution['is_error'], 0, 'In line ' . __LINE__);
1417     $values = $contribution['values'][$contribution['id']];
1418     $params['receive_date'] = date('Y-m-d H:i:s', strtotime($params['receive_date']));
1419     // this is not returned in id format
1420     unset($params['payment_instrument_id']);
1421     $params['contribution_source'] = $params['source'];
1422     unset($params['source']);
1423     foreach ($params as $key => $value) {
1424       if ($key == 'version') {
1425         continue;
1426       }
1427       $this->assertEquals($value, $values[$key], $key . " value: $value doesn't match " . print_r($values, TRUE) . 'in line' . __LINE__);
1428     }
1429   }
1430
1431  function _getFinancialTrxnAmount($contId) {
1432    $query = "SELECT
1433      SUM( ft.total_amount ) AS total
1434      FROM civicrm_financial_trxn AS ft
1435      LEFT JOIN civicrm_entity_financial_trxn AS ceft ON ft.id = ceft.financial_trxn_id
1436      WHERE ceft.entity_table = 'civicrm_contribution'
1437      AND ceft.entity_id = {$contId}";
1438
1439    $result = CRM_Core_DAO::singleValueQuery($query);
1440    return $result;
1441  }
1442
1443  function _getFinancialItemAmount($contId) {
1444    $lineItem = key(CRM_Price_BAO_LineItem::getLineItems($contId, 'contribution'));
1445    $query = "SELECT
1446      SUM(amount)
1447      FROM civicrm_financial_item
1448      WHERE entity_table = 'civicrm_line_item'
1449      AND entity_id = {$lineItem}";
1450    $result = CRM_Core_DAO::singleValueQuery($query);
1451    return $result;
1452  }
1453
1454  function _checkFinancialItem($contId, $context) {
1455    if ($context != 'paylater') {
1456      $params = array (
1457        'entity_id' =>   $contId,
1458        'entity_table' => 'civicrm_contribution',
1459      );
1460      $trxn = current(CRM_Financial_BAO_FinancialItem::retrieveEntityFinancialTrxn($params, TRUE));
1461      $entityParams = array(
1462         'financial_trxn_id' => $trxn['financial_trxn_id'],
1463         'entity_table' => 'civicrm_financial_item',
1464      );
1465      $entityTrxn = current(CRM_Financial_BAO_FinancialItem::retrieveEntityFinancialTrxn($entityParams));
1466      $params = array(
1467         'id' => $entityTrxn['entity_id'],
1468      );
1469    }
1470    if ($context == 'paylater') {
1471      $lineItems = CRM_Price_BAO_LineItem::getLineItems($contId, 'contribution');
1472      foreach ($lineItems as $key=>$item) {
1473        $params = array(
1474          'entity_id' => $key,
1475          'entity_table' => 'civicrm_line_item',
1476        );
1477        $compareParams = array ('status_id' => 1);
1478        $this->assertDBCompareValues('CRM_Financial_DAO_FinancialItem', $params, $compareParams);
1479      }
1480    }
1481    elseif ($context == 'refund') {
1482      $compareParams = array(
1483        'status_id' => 1,
1484        'financial_account_id' => 1,
1485        'amount' => -100,
1486      );
1487    }
1488    elseif ($context == 'cancelPending') {
1489      $compareParams = array(
1490        'status_id' => 3,
1491        'financial_account_id' => 1,
1492        'amount' => -100,
1493      );
1494    }
1495    elseif ($context == 'changeFinancial') {
1496      $lineKey = key(CRM_Price_BAO_LineItem::getLineItems($contId, 'contribution'));
1497      $params = array(
1498        'entity_id' => $lineKey,
1499        'amount' => -100,
1500      );
1501      $compareParams = array(
1502        'financial_account_id' => 1,
1503      );
1504      $this->assertDBCompareValues('CRM_Financial_DAO_FinancialItem', $params, $compareParams);
1505      $params = array(
1506        'financial_account_id' => 3,
1507        'entity_id' => $lineKey,
1508      );
1509      $compareParams = array(
1510        'amount' => 100,
1511      );
1512    }
1513    if ($context != 'paylater') {
1514      $this->assertDBCompareValues('CRM_Financial_DAO_FinancialItem', $params, $compareParams);
1515    }
1516  }
1517
1518  function _checkFinancialTrxn($contribution, $context) {
1519    $trxnParams = array(
1520      'entity_id' =>   $contribution['id'],
1521      'entity_table' => 'civicrm_contribution',
1522    );
1523    $trxn = current(CRM_Financial_BAO_FinancialItem::retrieveEntityFinancialTrxn($trxnParams, TRUE));
1524    $params = array(
1525      'id' => $trxn['financial_trxn_id'],
1526    );
1527    if ($context == 'payLater') {
1528      $relationTypeId = key(CRM_Core_PseudoConstant::accountOptionValues('account_relationship', NULL, " AND v.name LIKE 'Accounts Receivable Account is' "));
1529      $compareParams = array(
1530        'status_id' => 1,
1531        'from_financial_account_id' => CRM_Contribute_PseudoConstant::financialAccountType($contribution['financial_type_id'], $relationTypeId),
1532      );
1533    }
1534    elseif ($context == 'paymentInstrument') {
1535      $compareParams = array(
1536        'from_financial_account_id' => 6,
1537        'to_financial_account_id'  =>  7,
1538      );
1539    }
1540    elseif ($context == 'refund') {
1541      $compareParams = array(
1542        'to_financial_account_id' => 6,
1543        'total_amount' => -100,
1544        'status_id' => 7,
1545      );
1546    }
1547    elseif ($context == 'cancelPending') {
1548      $compareParams = array(
1549        'from_financial_account_id' => 7,
1550        'total_amount' => -100,
1551        'status_id' => 3,
1552      );
1553    }
1554    elseif ($context == 'changeFinancial') {
1555      $entityParams = array(
1556        'entity_id' =>   $contribution['id'],
1557        'entity_table' => 'civicrm_contribution',
1558        'amount' => -100,
1559      );
1560      $trxn = current(CRM_Financial_BAO_FinancialItem::retrieveEntityFinancialTrxn($entityParams));
1561      $trxnParams1 = array(
1562         'id' => $trxn['financial_trxn_id'],
1563      );
1564      $compareParams = array(
1565        'to_financial_account_id' => 12,
1566        'total_amount' => -100,
1567        'status_id' => 1,
1568      );
1569      $this->assertDBCompareValues('CRM_Financial_DAO_FinancialTrxn', $trxnParams1, $compareParams);
1570      $compareParams = array(
1571        'to_financial_account_id' => 12,
1572        'total_amount' => 100,
1573        'status_id' => 1,
1574      );
1575    }
1576
1577    $this->assertDBCompareValues('CRM_Financial_DAO_FinancialTrxn', $params, $compareParams);
1578  }
1579
1580  function _addPaymentInstrument () {
1581    $gId = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_OptionGroup', 'payment_instrument', 'id', 'name');
1582    $optionParams = array(
1583      'option_group_id' => $gId,
1584      'label' => 'Test Card',
1585      'name' => 'Test Card',
1586      'value' => '6',
1587      'weight' => '6',
1588      'is_active' => 1,
1589      'version' => 3,
1590 );
1591    $optionValue = civicrm_api('option_value', 'create', $optionParams);
1592    $relationTypeId = key(CRM_Core_PseudoConstant::accountOptionValues('account_relationship', NULL, " AND v.name LIKE 'Asset Account is' "));
1593    $financialParams = array(
1594      'entity_table' => 'civicrm_option_value',
1595      'entity_id' => $optionValue['id'],
1596      'account_relationship' => $relationTypeId,
1597      'financial_account_id' => 7,
1598    );
1599    $financialType = CRM_Financial_BAO_FinancialTypeAccount::add($financialParams, CRM_Core_DAO::$_nullArray);
1600    $this->assertNotEmpty($optionValue['values'][$optionValue['id']]['value']);
1601    return $optionValue['values'][$optionValue['id']]['value'];
1602  }
1603
1604  function _checkFinancialRecords($params,$context) {
1605    $entityParams = array(
1606      'entity_id' => $params['id'],
1607      'entity_table' => 'civicrm_contribution',
1608    );
1609    if ($context == 'pending') {
1610      $trxn = CRM_Financial_BAO_FinancialItem::retrieveEntityFinancialTrxn($entityParams);
1611      $this->assertNull($trxn, 'No Trxn to be created until IPN callback');
1612      return;
1613    }
1614    $trxn = current(CRM_Financial_BAO_FinancialItem::retrieveEntityFinancialTrxn($entityParams));
1615    $trxnParams = array(
1616      'id' => $trxn['financial_trxn_id'],
1617    );
1618    if ($context != 'online' && $context != 'payLater') {
1619      $compareParams = array(
1620        'to_financial_account_id' => 6,
1621        'total_amount' => 100,
1622        'status_id' => 1,
1623      );
1624    }
1625    if ($context == 'feeAmount') {
1626      $compareParams['fee_amount'] = 50;
1627    }
1628    elseif ($context == 'online') {
1629      $compareParams = array(
1630        'to_financial_account_id' => 12,
1631        'total_amount' => 100,
1632        'status_id' => 1,
1633      );
1634    }
1635    elseif ($context == 'payLater') {
1636      $compareParams = array(
1637        'to_financial_account_id' => 7,
1638        'total_amount' => 100,
1639        'status_id' => 2,
1640      );
1641    }
1642    $this->assertDBCompareValues('CRM_Financial_DAO_FinancialTrxn',$trxnParams,$compareParams);
1643    $entityParams = array(
1644      'financial_trxn_id' => $trxn['financial_trxn_id'],
1645      'entity_table' => 'civicrm_financial_item',
1646    );
1647    $entityTrxn = current(CRM_Financial_BAO_FinancialItem::retrieveEntityFinancialTrxn($entityParams));
1648    $fitemParams = array(
1649      'id' => $entityTrxn['entity_id'],
1650    );
1651    $compareParams = array(
1652      'amount' => 100,
1653      'status_id' => 1,
1654      'financial_account_id' => 1,
1655    );
1656    if ($context == 'payLater') {
1657      $compareParams = array(
1658        'amount' => 100,
1659        'status_id' => 3,
1660        'financial_account_id' => 1,
1661      );
1662    }
1663    $this->assertDBCompareValues('CRM_Financial_DAO_FinancialItem', $fitemParams, $compareParams);
1664    if ($context == 'feeAmount') {
1665      $maxParams = array(
1666        'entity_id' => $params['id'],
1667        'entity_table' => 'civicrm_contribution',
1668      );
1669      $maxTrxn = current(CRM_Financial_BAO_FinancialItem::retrieveEntityFinancialTrxn($maxParams, TRUE));
1670      $trxnParams = array(
1671        'id' => $maxTrxn['financial_trxn_id'],
1672      );
1673      $compareParams = array(
1674        'to_financial_account_id' => 5,
1675        'from_financial_account_id' => 6,
1676        'total_amount' => 50,
1677        'status_id' => 1,
1678      );
1679      $trxnId = CRM_Core_BAO_FinancialTrxn::getFinancialTrxnId($params['id'], 'DESC');
1680      $this->assertDBCompareValues('CRM_Financial_DAO_FinancialTrxn', $trxnParams, $compareParams);
1681      $fitemParams = array(
1682        'entity_id' => $trxnId['financialTrxnId'],
1683        'entity_table' => 'civicrm_financial_trxn',
1684      );
1685      $compareParams = array(
1686        'amount' => 50,
1687        'status_id' => 1,
1688        'financial_account_id' => 5,
1689      );
1690      $this->assertDBCompareValues('CRM_Financial_DAO_FinancialItem', $fitemParams, $compareParams);
1691    }
1692  }
1693 }
1694